@connectedxm/admin-sdk 11.23.1 → 12.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (77) hide show
  1. package/.openapi-generator/FILES +42 -2
  2. package/AdminApi.ts +9 -0
  3. package/README.md +2 -2
  4. package/api.ts +2857 -207
  5. package/base.ts +1 -1
  6. package/common.ts +1 -1
  7. package/configuration.ts +1 -1
  8. package/dist/AdminApi.d.ts +4 -1
  9. package/dist/AdminApi.js +3 -0
  10. package/dist/api.d.ts +1608 -151
  11. package/dist/api.js +2074 -196
  12. package/dist/base.d.ts +1 -1
  13. package/dist/base.js +1 -1
  14. package/dist/common.d.ts +1 -1
  15. package/dist/common.js +1 -1
  16. package/dist/configuration.d.ts +1 -1
  17. package/dist/configuration.js +1 -1
  18. package/dist/esm/AdminApi.d.ts +4 -1
  19. package/dist/esm/AdminApi.js +4 -1
  20. package/dist/esm/api.d.ts +1608 -151
  21. package/dist/esm/api.js +2028 -163
  22. package/dist/esm/base.d.ts +1 -1
  23. package/dist/esm/base.js +1 -1
  24. package/dist/esm/common.d.ts +1 -1
  25. package/dist/esm/common.js +1 -1
  26. package/dist/esm/configuration.d.ts +1 -1
  27. package/dist/esm/configuration.js +1 -1
  28. package/docs/Announcement.md +10 -24
  29. package/docs/AnnouncementAudience.md +48 -0
  30. package/docs/AnnouncementAudienceCondition.md +98 -0
  31. package/docs/AnnouncementAudienceConditionAccountAttribute.md +26 -0
  32. package/docs/AnnouncementAudienceConditionChoice.md +22 -0
  33. package/docs/AnnouncementAudienceConditionComparator.md +14 -0
  34. package/docs/AnnouncementAudienceConditionCreateInputs.md +60 -0
  35. package/docs/AnnouncementAudienceConditionEvent.md +24 -0
  36. package/docs/AnnouncementAudienceConditionInputs.md +58 -0
  37. package/docs/AnnouncementAudienceConditionQuestion.md +24 -0
  38. package/docs/AnnouncementAudienceConditionReference.md +22 -0
  39. package/docs/AnnouncementAudienceConditionType.md +40 -0
  40. package/docs/AnnouncementAudienceConditionUpdateInputs.md +60 -0
  41. package/docs/AnnouncementAudienceCreateInputs.md +30 -0
  42. package/docs/AnnouncementAudienceFilter.md +32 -0
  43. package/docs/AnnouncementAudienceFilterCreateInputs.md +24 -0
  44. package/docs/AnnouncementAudienceFilterUpdateInputs.md +22 -0
  45. package/docs/AnnouncementAudienceOperator.md +10 -0
  46. package/docs/AnnouncementAudienceReference.md +26 -0
  47. package/docs/AnnouncementAudienceScope.md +26 -0
  48. package/docs/AnnouncementAudienceUpdateInputs.md +28 -0
  49. package/docs/AnnouncementCreateInputs.md +5 -13
  50. package/docs/AnnouncementFilters.md +4 -10
  51. package/docs/AnnouncementMergeField.md +24 -0
  52. package/docs/AnnouncementTemplate.md +32 -0
  53. package/docs/AnnouncementTemplateCreateInputs.md +26 -0
  54. package/docs/AnnouncementTemplateTranslation.md +30 -0
  55. package/docs/AnnouncementTemplateTranslationUpdateInputs.md +22 -0
  56. package/docs/AnnouncementTemplateUpdateInputs.md +26 -0
  57. package/docs/AnnouncementUpdateInputs.md +2 -2
  58. package/docs/AnnouncementsApi.md +69 -20
  59. package/docs/AnnouncementsAudiencesApi.md +698 -0
  60. package/docs/AnnouncementsTemplatesApi.md +281 -0
  61. package/docs/AnnouncementsTemplatesTranslationsApi.md +240 -0
  62. package/docs/BaseAnnouncement.md +6 -8
  63. package/docs/BaseAnnouncementAudience.md +40 -0
  64. package/docs/CreateAnnouncementAudience200Response.md +24 -0
  65. package/docs/CreateAnnouncementAudienceCondition200Response.md +24 -0
  66. package/docs/CreateAnnouncementAudienceFilter200Response.md +24 -0
  67. package/docs/CreateAnnouncementTemplate200Response.md +24 -0
  68. package/docs/{GetAnnouncementAudience200Response.md → GetAnnouncementAudienceAccounts200Response.md} +3 -3
  69. package/docs/GetAnnouncementAudiences200Response.md +26 -0
  70. package/docs/GetAnnouncementMergeFields200Response.md +24 -0
  71. package/docs/GetAnnouncementTemplateTranslation200Response.md +24 -0
  72. package/docs/GetAnnouncementTemplateTranslations200Response.md +26 -0
  73. package/docs/GetAnnouncementTemplates200Response.md +26 -0
  74. package/docs/SendAnnouncementPreviewRequest.md +20 -0
  75. package/docs/UpdateAnnouncementTemplateTranslation200Response.md +24 -0
  76. package/package.json +1 -1
  77. package/docs/EventAnnouncementFilters.md +0 -30
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 11.23.1
5
+ * The version of the OpenAPI document: 12.1.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -637,56 +637,309 @@ export interface Announcement {
637
637
  'push': boolean;
638
638
  'sms': boolean;
639
639
  'includePasses': boolean;
640
- 'accountId': string | null;
641
640
  'creatorId': string | null;
642
641
  'eventId': string | null;
643
642
  'groupId': string | null;
644
- 'tierId': string | null;
645
- 'channelId': string | null;
646
- 'ticketId': string | null;
643
+ 'audienceId': string | null;
647
644
  'userId': string | null;
648
645
  'schedule': BaseSchedule;
646
+ 'sentAt': string | null;
647
+ 'recipientCount': number | null;
649
648
  'createdAt': string;
650
- 'verifiedAccounts': boolean;
651
- 'account': BaseAccount | null;
652
649
  'creator': BaseAccount | null;
653
650
  'event': BaseEvent | null;
654
651
  'group': BaseGroup | null;
655
- 'tier': BaseTier | null;
656
- 'channel': BaseChannel | null;
657
- 'sponsorshipLevelId': string | null;
658
- 'sponsorshipLevel': BaseLevel | null;
659
- 'ticket': BaseEventPassType | null;
652
+ 'audience': AnnouncementAudienceReference | null;
653
+ 'audienceSnapshot': AnnouncementAudience | null;
660
654
  'user': BaseUser | null;
661
655
  'message': string | null;
662
- 'filters': EventAnnouncementFilters | null;
663
656
  'updatedAt': string;
664
657
  }
665
- export interface AnnouncementCreateInputs {
666
- 'title': string | null;
667
- 'html'?: string | null;
668
- 'slug'?: string | null;
669
- 'creatorId'?: string | null;
658
+ export interface AnnouncementAudience {
659
+ 'id': string;
660
+ 'name': string;
661
+ 'description': string | null;
662
+ 'eventId': string | null;
663
+ 'groupId': string | null;
664
+ 'channelId': string | null;
665
+ 'operator': AnnouncementAudienceOperator;
666
+ 'featured': boolean;
667
+ 'archived': boolean;
668
+ 'createdAt': string;
669
+ 'updatedAt': string;
670
+ 'event': AnnouncementAudienceConditionEvent | null;
671
+ 'group': AnnouncementAudienceConditionEvent | null;
672
+ 'channel': AnnouncementAudienceConditionEvent | null;
673
+ 'filters': Array<AnnouncementAudienceFilter>;
674
+ }
675
+ export interface AnnouncementAudienceCondition {
676
+ 'id': string;
677
+ 'filterId': string;
678
+ 'type': AnnouncementAudienceConditionType;
679
+ 'negate': boolean;
680
+ 'sortOrder': number;
681
+ 'eventId': string | null;
682
+ 'event': AnnouncementAudienceConditionEvent | null;
683
+ 'passTypeId': string | null;
684
+ 'passType': AnnouncementAudienceConditionReference | null;
685
+ 'addOnId': string | null;
686
+ 'addOn': AnnouncementAudienceConditionReference | null;
687
+ 'sessionId': string | null;
688
+ 'session': AnnouncementAudienceConditionReference | null;
689
+ 'roomTypeId': string | null;
690
+ 'roomType': AnnouncementAudienceConditionReference | null;
691
+ 'questionId': string | null;
692
+ 'question': AnnouncementAudienceConditionQuestion | null;
693
+ 'choiceId': string | null;
694
+ 'choice': AnnouncementAudienceConditionChoice | null;
695
+ 'passAttributeId': string | null;
696
+ 'passAttribute': AnnouncementAudienceConditionReference | null;
697
+ 'tierId': string | null;
698
+ 'tier': AnnouncementAudienceConditionReference | null;
699
+ 'groupId': string | null;
700
+ 'group': AnnouncementAudienceConditionReference | null;
701
+ 'groupRole': GroupMembershipRole | null;
702
+ 'channelId': string | null;
703
+ 'channel': AnnouncementAudienceConditionReference | null;
704
+ 'sponsorshipLevelId': string | null;
705
+ 'sponsorshipLevel': AnnouncementAudienceConditionReference | null;
706
+ 'seriesId': string | null;
707
+ 'series': AnnouncementAudienceConditionReference | null;
708
+ 'accountAttributeId': string | null;
709
+ 'accountAttribute': AnnouncementAudienceConditionAccountAttribute | null;
710
+ 'accountId': string | null;
711
+ 'account': BaseAccount | null;
712
+ 'comparator': AnnouncementAudienceConditionComparator | null;
713
+ 'value': string | null;
714
+ 'createdAt': string;
715
+ 'updatedAt': string;
716
+ }
717
+ export interface AnnouncementAudienceConditionAccountAttribute {
718
+ 'id': string;
719
+ 'name': string;
720
+ 'label': string;
721
+ 'type': AccountAttributeType;
722
+ }
723
+ export interface AnnouncementAudienceConditionChoice {
724
+ 'id': string;
725
+ 'value': string;
726
+ }
727
+ export declare enum AnnouncementAudienceConditionComparator {
728
+ Equals = "equals",
729
+ Contains = "contains",
730
+ IsSet = "isSet",
731
+ NotSet = "notSet"
732
+ }
733
+ export interface AnnouncementAudienceConditionCreateInputs {
734
+ 'negate'?: boolean;
735
+ 'sortOrder'?: number | null;
670
736
  'eventId'?: string | null;
737
+ 'passTypeId'?: string | null;
738
+ 'addOnId'?: string | null;
739
+ 'sessionId'?: string | null;
740
+ 'roomTypeId'?: string | null;
741
+ 'questionId'?: string | null;
742
+ 'choiceId'?: string | null;
743
+ 'passAttributeId'?: string | null;
744
+ 'tierId'?: string | null;
671
745
  'groupId'?: string | null;
746
+ 'groupRole'?: GroupMembershipRole | null;
747
+ 'channelId'?: string | null;
748
+ 'sponsorshipLevelId'?: string | null;
749
+ 'seriesId'?: string | null;
750
+ 'accountAttributeId'?: string | null;
751
+ 'accountId'?: string | null;
752
+ 'comparator'?: AnnouncementAudienceConditionComparator | null;
753
+ 'value'?: string | null;
754
+ 'type': AnnouncementAudienceConditionType;
755
+ }
756
+ export interface AnnouncementAudienceConditionEvent {
757
+ 'id': string;
758
+ 'slug': string;
759
+ 'name': string;
760
+ }
761
+ export interface AnnouncementAudienceConditionInputs {
762
+ 'negate'?: boolean;
763
+ 'sortOrder'?: number | null;
764
+ 'eventId'?: string | null;
765
+ 'passTypeId'?: string | null;
766
+ 'addOnId'?: string | null;
767
+ 'sessionId'?: string | null;
768
+ 'roomTypeId'?: string | null;
769
+ 'questionId'?: string | null;
770
+ 'choiceId'?: string | null;
771
+ 'passAttributeId'?: string | null;
672
772
  'tierId'?: string | null;
773
+ 'groupId'?: string | null;
774
+ 'groupRole'?: GroupMembershipRole | null;
673
775
  'channelId'?: string | null;
776
+ 'sponsorshipLevelId'?: string | null;
777
+ 'seriesId'?: string | null;
778
+ 'accountAttributeId'?: string | null;
674
779
  'accountId'?: string | null;
675
- 'verifiedAccounts'?: boolean | null;
780
+ 'comparator'?: AnnouncementAudienceConditionComparator | null;
781
+ 'value'?: string | null;
782
+ }
783
+ export interface AnnouncementAudienceConditionQuestion {
784
+ 'id': string;
785
+ 'name': string;
786
+ 'label': string | null;
787
+ }
788
+ export interface AnnouncementAudienceConditionReference {
789
+ 'id': string;
790
+ 'name': string;
791
+ }
792
+ export declare enum AnnouncementAudienceConditionType {
793
+ EventPass = "eventPass",
794
+ EventPassType = "eventPassType",
795
+ EventCheckedIn = "eventCheckedIn",
796
+ EventAddOn = "eventAddOn",
797
+ EventSessionAccess = "eventSessionAccess",
798
+ EventSessionCheckedIn = "eventSessionCheckedIn",
799
+ EventRoomType = "eventRoomType",
800
+ EventQuestionChoice = "eventQuestionChoice",
801
+ EventPassAttribute = "eventPassAttribute",
802
+ Tier = "tier",
803
+ Group = "group",
804
+ Channel = "channel",
805
+ SponsorshipLevel = "sponsorshipLevel",
806
+ Series = "series",
807
+ AccountAttribute = "accountAttribute",
808
+ Verified = "verified",
809
+ Account = "account"
810
+ }
811
+ export interface AnnouncementAudienceConditionUpdateInputs {
812
+ 'negate'?: boolean;
813
+ 'sortOrder'?: number | null;
814
+ 'eventId'?: string | null;
815
+ 'passTypeId'?: string | null;
816
+ 'addOnId'?: string | null;
817
+ 'sessionId'?: string | null;
818
+ 'roomTypeId'?: string | null;
819
+ 'questionId'?: string | null;
820
+ 'choiceId'?: string | null;
821
+ 'passAttributeId'?: string | null;
822
+ 'tierId'?: string | null;
823
+ 'groupId'?: string | null;
824
+ 'groupRole'?: GroupMembershipRole | null;
825
+ 'channelId'?: string | null;
676
826
  'sponsorshipLevelId'?: string | null;
827
+ 'seriesId'?: string | null;
828
+ 'accountAttributeId'?: string | null;
829
+ 'accountId'?: string | null;
830
+ 'comparator'?: AnnouncementAudienceConditionComparator | null;
831
+ 'value'?: string | null;
832
+ 'type'?: AnnouncementAudienceConditionType;
833
+ }
834
+ export interface AnnouncementAudienceCreateInputs {
835
+ 'name': string;
836
+ 'description'?: string | null;
837
+ 'eventId'?: string | null;
838
+ 'groupId'?: string | null;
839
+ 'channelId'?: string | null;
840
+ 'operator'?: AnnouncementAudienceOperator;
841
+ }
842
+ export interface AnnouncementAudienceFilter {
843
+ 'id': string;
844
+ 'parentFilterId': string | null;
845
+ 'operator': AnnouncementAudienceOperator;
846
+ 'sortOrder': number;
847
+ 'conditions': Array<AnnouncementAudienceCondition>;
848
+ 'createdAt': string;
849
+ 'updatedAt': string;
850
+ }
851
+ export interface AnnouncementAudienceFilterCreateInputs {
852
+ 'parentFilterId'?: string | null;
853
+ 'operator'?: AnnouncementAudienceOperator;
854
+ 'sortOrder'?: number | null;
855
+ }
856
+ export interface AnnouncementAudienceFilterUpdateInputs {
857
+ 'operator'?: AnnouncementAudienceOperator;
858
+ 'sortOrder'?: number | null;
859
+ }
860
+ export declare enum AnnouncementAudienceOperator {
861
+ And = "AND",
862
+ Or = "OR"
863
+ }
864
+ export interface AnnouncementAudienceReference {
865
+ 'id': string;
866
+ 'name': string;
867
+ 'eventId': string | null;
868
+ 'groupId': string | null;
869
+ }
870
+ export interface AnnouncementAudienceScope {
871
+ 'eventId'?: string;
872
+ 'groupId'?: string;
873
+ 'channelId'?: string;
874
+ 'archived'?: boolean;
875
+ }
876
+ export interface AnnouncementAudienceUpdateInputs {
877
+ 'name'?: string;
878
+ 'description'?: string | null;
879
+ 'operator'?: AnnouncementAudienceOperator;
880
+ 'featured'?: boolean;
881
+ 'archived'?: boolean;
882
+ }
883
+ export interface AnnouncementCreateInputs {
884
+ 'title'?: string | null;
885
+ 'html'?: string | null;
886
+ 'templateId'?: string | null;
887
+ 'slug'?: string | null;
888
+ 'creatorId'?: string | null;
889
+ 'eventId'?: string | null;
890
+ 'groupId'?: string | null;
891
+ 'audienceId'?: string | null;
677
892
  'email'?: boolean;
678
893
  'push'?: boolean;
679
- 'filters'?: EventAnnouncementFilters | null;
680
894
  'includePasses'?: boolean;
681
895
  }
682
896
  export interface AnnouncementFilters {
683
- 'verifiedAccounts'?: boolean;
684
897
  'eventId'?: string;
685
898
  'groupId'?: string;
686
- 'tierId'?: string;
687
- 'channelId'?: string;
688
- 'accountId'?: string;
689
- 'sponsorshipLevelId'?: string;
899
+ 'audienceId'?: string;
900
+ 'community'?: boolean;
901
+ }
902
+ export interface AnnouncementMergeField {
903
+ 'token': string;
904
+ 'label': string;
905
+ 'group': AnnouncementMergeFieldGroupEnum;
906
+ }
907
+ export declare enum AnnouncementMergeFieldGroupEnum {
908
+ Account = "Account",
909
+ Attributes = "Attributes"
910
+ }
911
+ export interface AnnouncementTemplate {
912
+ 'id': string;
913
+ 'name': string;
914
+ 'description': string | null;
915
+ 'title': string | null;
916
+ 'html': string | null;
917
+ 'createdAt': string;
918
+ 'updatedAt': string;
919
+ }
920
+ export interface AnnouncementTemplateCreateInputs {
921
+ 'name': string;
922
+ 'description'?: string | null;
923
+ 'title'?: string | null;
924
+ 'html'?: string | null;
925
+ }
926
+ export interface AnnouncementTemplateTranslation {
927
+ 'id': string;
928
+ 'locale': string;
929
+ 'title': string | null;
930
+ 'html': string | null;
931
+ 'createdAt': string;
932
+ 'updatedAt': string;
933
+ }
934
+ export interface AnnouncementTemplateTranslationUpdateInputs {
935
+ 'title'?: string | null;
936
+ 'html'?: string | null;
937
+ }
938
+ export interface AnnouncementTemplateUpdateInputs {
939
+ 'name'?: string;
940
+ 'description'?: string | null;
941
+ 'title'?: string | null;
942
+ 'html'?: string | null;
690
943
  }
691
944
  export interface AnnouncementTranslation {
692
945
  'id': number;
@@ -705,9 +958,9 @@ export interface AnnouncementUpdateInputs {
705
958
  'title'?: string | null;
706
959
  'html'?: string | null;
707
960
  'slug'?: string | null;
961
+ 'audienceId'?: string | null;
708
962
  'email'?: boolean;
709
963
  'push'?: boolean;
710
- 'filters'?: EventAnnouncementFilters | null;
711
964
  'includePasses'?: boolean;
712
965
  }
713
966
  export interface ApproveEventPassRequest {
@@ -941,17 +1194,29 @@ export interface BaseAnnouncement {
941
1194
  'push': boolean;
942
1195
  'sms': boolean;
943
1196
  'includePasses': boolean;
944
- 'accountId': string | null;
945
1197
  'creatorId': string | null;
946
1198
  'eventId': string | null;
947
1199
  'groupId': string | null;
948
- 'tierId': string | null;
949
- 'channelId': string | null;
950
- 'ticketId': string | null;
1200
+ 'audienceId': string | null;
951
1201
  'userId': string | null;
952
1202
  'schedule': BaseSchedule;
1203
+ 'sentAt': string | null;
1204
+ 'recipientCount': number | null;
953
1205
  'createdAt': string;
954
1206
  }
1207
+ export interface BaseAnnouncementAudience {
1208
+ 'id': string;
1209
+ 'name': string;
1210
+ 'description': string | null;
1211
+ 'eventId': string | null;
1212
+ 'groupId': string | null;
1213
+ 'channelId': string | null;
1214
+ 'operator': AnnouncementAudienceOperator;
1215
+ 'featured': boolean;
1216
+ 'archived': boolean;
1217
+ 'createdAt': string;
1218
+ 'updatedAt': string;
1219
+ }
955
1220
  export interface BaseBenefit {
956
1221
  'id': string;
957
1222
  'slug': string;
@@ -3683,6 +3948,38 @@ export interface CreateAnnouncement200Response {
3683
3948
  export declare enum CreateAnnouncement200ResponseStatusEnum {
3684
3949
  Ok = "ok"
3685
3950
  }
3951
+ export interface CreateAnnouncementAudience200Response {
3952
+ 'status': CreateAnnouncementAudience200ResponseStatusEnum;
3953
+ 'message': string;
3954
+ 'data': AnnouncementAudience;
3955
+ }
3956
+ export declare enum CreateAnnouncementAudience200ResponseStatusEnum {
3957
+ Ok = "ok"
3958
+ }
3959
+ export interface CreateAnnouncementAudienceCondition200Response {
3960
+ 'status': CreateAnnouncementAudienceCondition200ResponseStatusEnum;
3961
+ 'message': string;
3962
+ 'data': AnnouncementAudienceCondition;
3963
+ }
3964
+ export declare enum CreateAnnouncementAudienceCondition200ResponseStatusEnum {
3965
+ Ok = "ok"
3966
+ }
3967
+ export interface CreateAnnouncementAudienceFilter200Response {
3968
+ 'status': CreateAnnouncementAudienceFilter200ResponseStatusEnum;
3969
+ 'message': string;
3970
+ 'data': AnnouncementAudienceFilter;
3971
+ }
3972
+ export declare enum CreateAnnouncementAudienceFilter200ResponseStatusEnum {
3973
+ Ok = "ok"
3974
+ }
3975
+ export interface CreateAnnouncementTemplate200Response {
3976
+ 'status': CreateAnnouncementTemplate200ResponseStatusEnum;
3977
+ 'message': string;
3978
+ 'data': AnnouncementTemplate;
3979
+ }
3980
+ export declare enum CreateAnnouncementTemplate200ResponseStatusEnum {
3981
+ Ok = "ok"
3982
+ }
3686
3983
  export interface CreateBenefit200Response {
3687
3984
  'status': CreateBenefit200ResponseStatusEnum;
3688
3985
  'message': string;
@@ -4848,17 +5145,6 @@ export declare enum EventAgendaVisibility {
4848
5145
  Registered = "registered",
4849
5146
  Hidden = "hidden"
4850
5147
  }
4851
- export interface EventAnnouncementFilters {
4852
- 'type': EventAnnouncementFiltersTypeEnum;
4853
- 'ticketId'?: string;
4854
- 'questionId'?: string;
4855
- 'choiceId'?: string;
4856
- 'eventRoomTypeId'?: string;
4857
- 'addOnId'?: string;
4858
- }
4859
- export declare enum EventAnnouncementFiltersTypeEnum {
4860
- Event = "event"
4861
- }
4862
5148
  export interface EventAttribute {
4863
5149
  'id': string;
4864
5150
  'name': string;
@@ -6885,13 +7171,56 @@ export interface GetAllAccountMerges200Response {
6885
7171
  export declare enum GetAllAccountMerges200ResponseStatusEnum {
6886
7172
  Ok = "ok"
6887
7173
  }
6888
- export interface GetAnnouncementAudience200Response {
6889
- 'status': GetAnnouncementAudience200ResponseStatusEnum;
7174
+ export interface GetAnnouncementAudienceAccounts200Response {
7175
+ 'status': GetAnnouncementAudienceAccounts200ResponseStatusEnum;
6890
7176
  'message': string;
6891
7177
  'data': Array<BaseAccount>;
6892
7178
  'count'?: number;
6893
7179
  }
6894
- export declare enum GetAnnouncementAudience200ResponseStatusEnum {
7180
+ export declare enum GetAnnouncementAudienceAccounts200ResponseStatusEnum {
7181
+ Ok = "ok"
7182
+ }
7183
+ export interface GetAnnouncementAudiences200Response {
7184
+ 'status': GetAnnouncementAudiences200ResponseStatusEnum;
7185
+ 'message': string;
7186
+ 'data': Array<AnnouncementAudience>;
7187
+ 'count'?: number;
7188
+ }
7189
+ export declare enum GetAnnouncementAudiences200ResponseStatusEnum {
7190
+ Ok = "ok"
7191
+ }
7192
+ export interface GetAnnouncementMergeFields200Response {
7193
+ 'status': GetAnnouncementMergeFields200ResponseStatusEnum;
7194
+ 'message': string;
7195
+ 'data': Array<AnnouncementMergeField>;
7196
+ }
7197
+ export declare enum GetAnnouncementMergeFields200ResponseStatusEnum {
7198
+ Ok = "ok"
7199
+ }
7200
+ export interface GetAnnouncementTemplateTranslation200Response {
7201
+ 'status': GetAnnouncementTemplateTranslation200ResponseStatusEnum;
7202
+ 'message': string;
7203
+ 'data': AnnouncementTemplateTranslation | null;
7204
+ }
7205
+ export declare enum GetAnnouncementTemplateTranslation200ResponseStatusEnum {
7206
+ Ok = "ok"
7207
+ }
7208
+ export interface GetAnnouncementTemplateTranslations200Response {
7209
+ 'status': GetAnnouncementTemplateTranslations200ResponseStatusEnum;
7210
+ 'message': string;
7211
+ 'data': Array<AnnouncementTemplateTranslation>;
7212
+ 'count'?: number;
7213
+ }
7214
+ export declare enum GetAnnouncementTemplateTranslations200ResponseStatusEnum {
7215
+ Ok = "ok"
7216
+ }
7217
+ export interface GetAnnouncementTemplates200Response {
7218
+ 'status': GetAnnouncementTemplates200ResponseStatusEnum;
7219
+ 'message': string;
7220
+ 'data': Array<AnnouncementTemplate>;
7221
+ 'count'?: number;
7222
+ }
7223
+ export declare enum GetAnnouncementTemplates200ResponseStatusEnum {
6895
7224
  Ok = "ok"
6896
7225
  }
6897
7226
  export interface GetAnnouncementTranslation200Response {
@@ -12267,6 +12596,9 @@ export interface Self {
12267
12596
  'createdAt': string;
12268
12597
  'updatedAt': string;
12269
12598
  }
12599
+ export interface SendAnnouncementPreviewRequest {
12600
+ 'accountId'?: string;
12601
+ }
12270
12602
  export interface Series {
12271
12603
  'id': string;
12272
12604
  'slug': string;
@@ -13656,6 +13988,14 @@ export interface TriggerUpdateInputs {
13656
13988
  'code'?: string | null;
13657
13989
  'enabled'?: boolean;
13658
13990
  }
13991
+ export interface UpdateAnnouncementTemplateTranslation200Response {
13992
+ 'status': UpdateAnnouncementTemplateTranslation200ResponseStatusEnum;
13993
+ 'message': string;
13994
+ 'data': AnnouncementTemplateTranslation;
13995
+ }
13996
+ export declare enum UpdateAnnouncementTemplateTranslation200ResponseStatusEnum {
13997
+ Ok = "ok"
13998
+ }
13659
13999
  export interface UpdateBookingResponsesInputs {
13660
14000
  'questions': Array<Question>;
13661
14001
  }
@@ -18117,7 +18457,7 @@ export declare class AdvertisementsApi extends BaseAPI {
18117
18457
  */
18118
18458
  export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configuration) => {
18119
18459
  /**
18120
- * Creates a new announcement for the organization, requiring at least one audience target (event, group, tier, channel, account, or verified accounts) and requiring create permission on announcements; admins cannot assign the creator directly.
18460
+ * Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
18121
18461
  * @summary Create an announcement
18122
18462
  * @param {AnnouncementCreateInputs} announcementCreateInputs
18123
18463
  * @param {*} [options] Override http request option.
@@ -18141,9 +18481,10 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
18141
18481
  */
18142
18482
  getAnnouncement: (announcementId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18143
18483
  /**
18144
- * Returns a paginated list of the accounts that an announcement was or will be sent to, supporting search and ordering; requires read permission on announcements.
18145
- * @summary List an announcement\'s target audience
18484
+ * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
18485
+ * @summary List an announcement\'s email delivery receipts
18146
18486
  * @param {string} announcementId The announcement identifier
18487
+ * @param {EmailReceiptStatus} [status] Filter by status
18147
18488
  * @param {number} [page] Page number
18148
18489
  * @param {number} [pageSize] Number of items per page
18149
18490
  * @param {string} [orderBy] Field to order by
@@ -18151,12 +18492,18 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
18151
18492
  * @param {*} [options] Override http request option.
18152
18493
  * @throws {RequiredError}
18153
18494
  */
18154
- getAnnouncementAudience: (announcementId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18495
+ getAnnouncementEmailReceipts: (announcementId: string, status?: EmailReceiptStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18155
18496
  /**
18156
- * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
18157
- * @summary List an announcement\'s email delivery receipts
18497
+ * Returns the merge fields an announcement can use: the core account fields plus every account attribute that isn\'t admin-only, ordered by attribute sort order; requires read permission on announcements.
18498
+ * @summary List announcement merge fields
18499
+ * @param {*} [options] Override http request option.
18500
+ * @throws {RequiredError}
18501
+ */
18502
+ getAnnouncementMergeFields: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18503
+ /**
18504
+ * Returns a paginated list of the accounts an announcement reaches: its audience when it has one, otherwise everyone in its event, group or community, excluding banned accounts; supports search and ordering; requires read permission on announcements.
18505
+ * @summary List an announcement\'s recipients
18158
18506
  * @param {string} announcementId The announcement identifier
18159
- * @param {EmailReceiptStatus} [status] Filter by status
18160
18507
  * @param {number} [page] Page number
18161
18508
  * @param {number} [pageSize] Number of items per page
18162
18509
  * @param {string} [orderBy] Field to order by
@@ -18164,9 +18511,9 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
18164
18511
  * @param {*} [options] Override http request option.
18165
18512
  * @throws {RequiredError}
18166
18513
  */
18167
- getAnnouncementEmailReceipts: (announcementId: string, status?: EmailReceiptStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18514
+ getAnnouncementRecipients: (announcementId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18168
18515
  /**
18169
- * Returns a paginated list of announcements for the organization, optionally filtered by event, group, tier, channel, account, sponsorship level, or verified-account status, with search and ordering support; requires read permission on announcements.
18516
+ * Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
18170
18517
  * @summary List announcements
18171
18518
  * @param {AnnouncementFilters} [filters] Filter by filters
18172
18519
  * @param {number} [page] Page number
@@ -18178,13 +18525,14 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
18178
18525
  */
18179
18526
  getAnnouncements: (filters?: AnnouncementFilters, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18180
18527
  /**
18181
- * Queues a preview send of the announcement\'s current content to a test recipient (identified by userId or accountId in the announcement), failing if the announcement has no HTML content yet; requires create permission on announcements.
18528
+ * Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
18182
18529
  * @summary Send a preview of an announcement
18183
18530
  * @param {string} announcementId The announcement identifier
18531
+ * @param {SendAnnouncementPreviewRequest} [sendAnnouncementPreviewRequest]
18184
18532
  * @param {*} [options] Override http request option.
18185
18533
  * @throws {RequiredError}
18186
18534
  */
18187
- sendAnnouncementPreview: (announcementId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18535
+ sendAnnouncementPreview: (announcementId: string, sendAnnouncementPreviewRequest?: SendAnnouncementPreviewRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18188
18536
  /**
18189
18537
  * Updates the fields (such as title, content, or audience targeting) of an existing announcement identified by ID or slug; requires update permission on announcements.
18190
18538
  * @summary Update an announcement
@@ -18200,7 +18548,7 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
18200
18548
  */
18201
18549
  export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
18202
18550
  /**
18203
- * Creates a new announcement for the organization, requiring at least one audience target (event, group, tier, channel, account, or verified accounts) and requiring create permission on announcements; admins cannot assign the creator directly.
18551
+ * Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
18204
18552
  * @summary Create an announcement
18205
18553
  * @param {AnnouncementCreateInputs} announcementCreateInputs
18206
18554
  * @param {*} [options] Override http request option.
@@ -18224,9 +18572,10 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
18224
18572
  */
18225
18573
  getAnnouncement(announcementId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncement200Response>>;
18226
18574
  /**
18227
- * Returns a paginated list of the accounts that an announcement was or will be sent to, supporting search and ordering; requires read permission on announcements.
18228
- * @summary List an announcement\'s target audience
18575
+ * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
18576
+ * @summary List an announcement\'s email delivery receipts
18229
18577
  * @param {string} announcementId The announcement identifier
18578
+ * @param {EmailReceiptStatus} [status] Filter by status
18230
18579
  * @param {number} [page] Page number
18231
18580
  * @param {number} [pageSize] Number of items per page
18232
18581
  * @param {string} [orderBy] Field to order by
@@ -18234,12 +18583,18 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
18234
18583
  * @param {*} [options] Override http request option.
18235
18584
  * @throws {RequiredError}
18236
18585
  */
18237
- getAnnouncementAudience(announcementId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudience200Response>>;
18586
+ getAnnouncementEmailReceipts(announcementId: string, status?: EmailReceiptStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAcccountEmailReceipts200Response>>;
18238
18587
  /**
18239
- * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
18240
- * @summary List an announcement\'s email delivery receipts
18588
+ * Returns the merge fields an announcement can use: the core account fields plus every account attribute that isn\'t admin-only, ordered by attribute sort order; requires read permission on announcements.
18589
+ * @summary List announcement merge fields
18590
+ * @param {*} [options] Override http request option.
18591
+ * @throws {RequiredError}
18592
+ */
18593
+ getAnnouncementMergeFields(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementMergeFields200Response>>;
18594
+ /**
18595
+ * Returns a paginated list of the accounts an announcement reaches: its audience when it has one, otherwise everyone in its event, group or community, excluding banned accounts; supports search and ordering; requires read permission on announcements.
18596
+ * @summary List an announcement\'s recipients
18241
18597
  * @param {string} announcementId The announcement identifier
18242
- * @param {EmailReceiptStatus} [status] Filter by status
18243
18598
  * @param {number} [page] Page number
18244
18599
  * @param {number} [pageSize] Number of items per page
18245
18600
  * @param {string} [orderBy] Field to order by
@@ -18247,9 +18602,9 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
18247
18602
  * @param {*} [options] Override http request option.
18248
18603
  * @throws {RequiredError}
18249
18604
  */
18250
- getAnnouncementEmailReceipts(announcementId: string, status?: EmailReceiptStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAcccountEmailReceipts200Response>>;
18605
+ getAnnouncementRecipients(announcementId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudienceAccounts200Response>>;
18251
18606
  /**
18252
- * Returns a paginated list of announcements for the organization, optionally filtered by event, group, tier, channel, account, sponsorship level, or verified-account status, with search and ordering support; requires read permission on announcements.
18607
+ * Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
18253
18608
  * @summary List announcements
18254
18609
  * @param {AnnouncementFilters} [filters] Filter by filters
18255
18610
  * @param {number} [page] Page number
@@ -18261,13 +18616,14 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
18261
18616
  */
18262
18617
  getAnnouncements(filters?: AnnouncementFilters, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncements200Response>>;
18263
18618
  /**
18264
- * Queues a preview send of the announcement\'s current content to a test recipient (identified by userId or accountId in the announcement), failing if the announcement has no HTML content yet; requires create permission on announcements.
18619
+ * Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
18265
18620
  * @summary Send a preview of an announcement
18266
18621
  * @param {string} announcementId The announcement identifier
18622
+ * @param {SendAnnouncementPreviewRequest} [sendAnnouncementPreviewRequest]
18267
18623
  * @param {*} [options] Override http request option.
18268
18624
  * @throws {RequiredError}
18269
18625
  */
18270
- sendAnnouncementPreview(announcementId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
18626
+ sendAnnouncementPreview(announcementId: string, sendAnnouncementPreviewRequest?: SendAnnouncementPreviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
18271
18627
  /**
18272
18628
  * Updates the fields (such as title, content, or audience targeting) of an existing announcement identified by ID or slug; requires update permission on announcements.
18273
18629
  * @summary Update an announcement
@@ -18283,7 +18639,7 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
18283
18639
  */
18284
18640
  export declare const AnnouncementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
18285
18641
  /**
18286
- * Creates a new announcement for the organization, requiring at least one audience target (event, group, tier, channel, account, or verified accounts) and requiring create permission on announcements; admins cannot assign the creator directly.
18642
+ * Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
18287
18643
  * @summary Create an announcement
18288
18644
  * @param {AnnouncementsApiCreateAnnouncementRequest} requestParameters Request parameters.
18289
18645
  * @param {*} [options] Override http request option.
@@ -18306,14 +18662,6 @@ export declare const AnnouncementsApiFactory: (configuration?: Configuration, ba
18306
18662
  * @throws {RequiredError}
18307
18663
  */
18308
18664
  getAnnouncement(requestParameters: AnnouncementsApiGetAnnouncementRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncement200Response>;
18309
- /**
18310
- * Returns a paginated list of the accounts that an announcement was or will be sent to, supporting search and ordering; requires read permission on announcements.
18311
- * @summary List an announcement\'s target audience
18312
- * @param {AnnouncementsApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
18313
- * @param {*} [options] Override http request option.
18314
- * @throws {RequiredError}
18315
- */
18316
- getAnnouncementAudience(requestParameters: AnnouncementsApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudience200Response>;
18317
18665
  /**
18318
18666
  * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
18319
18667
  * @summary List an announcement\'s email delivery receipts
@@ -18323,7 +18671,22 @@ export declare const AnnouncementsApiFactory: (configuration?: Configuration, ba
18323
18671
  */
18324
18672
  getAnnouncementEmailReceipts(requestParameters: AnnouncementsApiGetAnnouncementEmailReceiptsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAcccountEmailReceipts200Response>;
18325
18673
  /**
18326
- * Returns a paginated list of announcements for the organization, optionally filtered by event, group, tier, channel, account, sponsorship level, or verified-account status, with search and ordering support; requires read permission on announcements.
18674
+ * Returns the merge fields an announcement can use: the core account fields plus every account attribute that isn\'t admin-only, ordered by attribute sort order; requires read permission on announcements.
18675
+ * @summary List announcement merge fields
18676
+ * @param {*} [options] Override http request option.
18677
+ * @throws {RequiredError}
18678
+ */
18679
+ getAnnouncementMergeFields(options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementMergeFields200Response>;
18680
+ /**
18681
+ * Returns a paginated list of the accounts an announcement reaches: its audience when it has one, otherwise everyone in its event, group or community, excluding banned accounts; supports search and ordering; requires read permission on announcements.
18682
+ * @summary List an announcement\'s recipients
18683
+ * @param {AnnouncementsApiGetAnnouncementRecipientsRequest} requestParameters Request parameters.
18684
+ * @param {*} [options] Override http request option.
18685
+ * @throws {RequiredError}
18686
+ */
18687
+ getAnnouncementRecipients(requestParameters: AnnouncementsApiGetAnnouncementRecipientsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudienceAccounts200Response>;
18688
+ /**
18689
+ * Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
18327
18690
  * @summary List announcements
18328
18691
  * @param {AnnouncementsApiGetAnnouncementsRequest} requestParameters Request parameters.
18329
18692
  * @param {*} [options] Override http request option.
@@ -18331,7 +18694,7 @@ export declare const AnnouncementsApiFactory: (configuration?: Configuration, ba
18331
18694
  */
18332
18695
  getAnnouncements(requestParameters?: AnnouncementsApiGetAnnouncementsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncements200Response>;
18333
18696
  /**
18334
- * Queues a preview send of the announcement\'s current content to a test recipient (identified by userId or accountId in the announcement), failing if the announcement has no HTML content yet; requires create permission on announcements.
18697
+ * Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
18335
18698
  * @summary Send a preview of an announcement
18336
18699
  * @param {AnnouncementsApiSendAnnouncementPreviewRequest} requestParameters Request parameters.
18337
18700
  * @param {*} [options] Override http request option.
@@ -18372,13 +18735,17 @@ export interface AnnouncementsApiGetAnnouncementRequest {
18372
18735
  readonly announcementId: string;
18373
18736
  }
18374
18737
  /**
18375
- * Request parameters for getAnnouncementAudience operation in AnnouncementsApi.
18738
+ * Request parameters for getAnnouncementEmailReceipts operation in AnnouncementsApi.
18376
18739
  */
18377
- export interface AnnouncementsApiGetAnnouncementAudienceRequest {
18740
+ export interface AnnouncementsApiGetAnnouncementEmailReceiptsRequest {
18378
18741
  /**
18379
18742
  * The announcement identifier
18380
18743
  */
18381
18744
  readonly announcementId: string;
18745
+ /**
18746
+ * Filter by status
18747
+ */
18748
+ readonly status?: EmailReceiptStatus;
18382
18749
  /**
18383
18750
  * Page number
18384
18751
  */
@@ -18397,17 +18764,13 @@ export interface AnnouncementsApiGetAnnouncementAudienceRequest {
18397
18764
  readonly search?: string;
18398
18765
  }
18399
18766
  /**
18400
- * Request parameters for getAnnouncementEmailReceipts operation in AnnouncementsApi.
18767
+ * Request parameters for getAnnouncementRecipients operation in AnnouncementsApi.
18401
18768
  */
18402
- export interface AnnouncementsApiGetAnnouncementEmailReceiptsRequest {
18769
+ export interface AnnouncementsApiGetAnnouncementRecipientsRequest {
18403
18770
  /**
18404
18771
  * The announcement identifier
18405
18772
  */
18406
18773
  readonly announcementId: string;
18407
- /**
18408
- * Filter by status
18409
- */
18410
- readonly status?: EmailReceiptStatus;
18411
18774
  /**
18412
18775
  * Page number
18413
18776
  */
@@ -18458,6 +18821,7 @@ export interface AnnouncementsApiSendAnnouncementPreviewRequest {
18458
18821
  * The announcement identifier
18459
18822
  */
18460
18823
  readonly announcementId: string;
18824
+ readonly sendAnnouncementPreviewRequest?: SendAnnouncementPreviewRequest;
18461
18825
  }
18462
18826
  /**
18463
18827
  * Request parameters for updateAnnouncement operation in AnnouncementsApi.
@@ -18474,7 +18838,7 @@ export interface AnnouncementsApiUpdateAnnouncementRequest {
18474
18838
  */
18475
18839
  export declare class AnnouncementsApi extends BaseAPI {
18476
18840
  /**
18477
- * Creates a new announcement for the organization, requiring at least one audience target (event, group, tier, channel, account, or verified accounts) and requiring create permission on announcements; admins cannot assign the creator directly.
18841
+ * Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
18478
18842
  * @summary Create an announcement
18479
18843
  * @param {AnnouncementsApiCreateAnnouncementRequest} requestParameters Request parameters.
18480
18844
  * @param {*} [options] Override http request option.
@@ -18497,14 +18861,6 @@ export declare class AnnouncementsApi extends BaseAPI {
18497
18861
  * @throws {RequiredError}
18498
18862
  */
18499
18863
  getAnnouncement(requestParameters: AnnouncementsApiGetAnnouncementRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncement200Response, any, {}, any>>;
18500
- /**
18501
- * Returns a paginated list of the accounts that an announcement was or will be sent to, supporting search and ordering; requires read permission on announcements.
18502
- * @summary List an announcement\'s target audience
18503
- * @param {AnnouncementsApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
18504
- * @param {*} [options] Override http request option.
18505
- * @throws {RequiredError}
18506
- */
18507
- getAnnouncementAudience(requestParameters: AnnouncementsApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementAudience200Response, any, {}, any>>;
18508
18864
  /**
18509
18865
  * Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
18510
18866
  * @summary List an announcement\'s email delivery receipts
@@ -18514,7 +18870,22 @@ export declare class AnnouncementsApi extends BaseAPI {
18514
18870
  */
18515
18871
  getAnnouncementEmailReceipts(requestParameters: AnnouncementsApiGetAnnouncementEmailReceiptsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAcccountEmailReceipts200Response, any, {}, any>>;
18516
18872
  /**
18517
- * Returns a paginated list of announcements for the organization, optionally filtered by event, group, tier, channel, account, sponsorship level, or verified-account status, with search and ordering support; requires read permission on announcements.
18873
+ * Returns the merge fields an announcement can use: the core account fields plus every account attribute that isn\'t admin-only, ordered by attribute sort order; requires read permission on announcements.
18874
+ * @summary List announcement merge fields
18875
+ * @param {*} [options] Override http request option.
18876
+ * @throws {RequiredError}
18877
+ */
18878
+ getAnnouncementMergeFields(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementMergeFields200Response, any, {}, any>>;
18879
+ /**
18880
+ * Returns a paginated list of the accounts an announcement reaches: its audience when it has one, otherwise everyone in its event, group or community, excluding banned accounts; supports search and ordering; requires read permission on announcements.
18881
+ * @summary List an announcement\'s recipients
18882
+ * @param {AnnouncementsApiGetAnnouncementRecipientsRequest} requestParameters Request parameters.
18883
+ * @param {*} [options] Override http request option.
18884
+ * @throws {RequiredError}
18885
+ */
18886
+ getAnnouncementRecipients(requestParameters: AnnouncementsApiGetAnnouncementRecipientsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementAudienceAccounts200Response, any, {}, any>>;
18887
+ /**
18888
+ * Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
18518
18889
  * @summary List announcements
18519
18890
  * @param {AnnouncementsApiGetAnnouncementsRequest} requestParameters Request parameters.
18520
18891
  * @param {*} [options] Override http request option.
@@ -18522,7 +18893,7 @@ export declare class AnnouncementsApi extends BaseAPI {
18522
18893
  */
18523
18894
  getAnnouncements(requestParameters?: AnnouncementsApiGetAnnouncementsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncements200Response, any, {}, any>>;
18524
18895
  /**
18525
- * Queues a preview send of the announcement\'s current content to a test recipient (identified by userId or accountId in the announcement), failing if the announcement has no HTML content yet; requires create permission on announcements.
18896
+ * Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
18526
18897
  * @summary Send a preview of an announcement
18527
18898
  * @param {AnnouncementsApiSendAnnouncementPreviewRequest} requestParameters Request parameters.
18528
18899
  * @param {*} [options] Override http request option.
@@ -18539,109 +18910,1195 @@ export declare class AnnouncementsApi extends BaseAPI {
18539
18910
  updateAnnouncement(requestParameters: AnnouncementsApiUpdateAnnouncementRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncement200Response, any, {}, any>>;
18540
18911
  }
18541
18912
  /**
18542
- * AnnouncementsScheduleApi - axios parameter creator
18913
+ * AnnouncementsAudiencesApi - axios parameter creator
18543
18914
  */
18544
- export declare const AnnouncementsScheduleApiAxiosParamCreator: (configuration?: Configuration) => {
18915
+ export declare const AnnouncementsAudiencesApiAxiosParamCreator: (configuration?: Configuration) => {
18545
18916
  /**
18546
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
18547
- * @summary Cancel an announcement\'s scheduled send
18548
- * @param {string} announcementId The announcement identifier
18917
+ * Creates an audience scoped to an event (eventId), a group (groupId), a channel (channelId), or the whole community (none); the scope cannot be changed afterwards; requires create permission on announcements.
18918
+ * @summary Create an announcement audience
18919
+ * @param {AnnouncementAudienceCreateInputs} announcementAudienceCreateInputs
18549
18920
  * @param {*} [options] Override http request option.
18550
18921
  * @throws {RequiredError}
18551
18922
  */
18552
- cancelAnnouncementSchedule: (announcementId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18923
+ createAnnouncementAudience: (announcementAudienceCreateInputs: AnnouncementAudienceCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18553
18924
  /**
18554
- * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
18555
- * @summary Schedule or reschedule an announcement send
18556
- * @param {string} announcementId The announcement identifier
18557
- * @param {object} body
18925
+ * Adds a condition to a filter group; each type requires its own reference (e.g. passTypeId for eventPassType), event conditions inside an event audience always use that event, and every reference must belong to the organization; requires update permission on announcements.
18926
+ * @summary Create an audience condition
18927
+ * @param {string} audienceId The audience identifier
18928
+ * @param {string} filterId The filter identifier
18929
+ * @param {AnnouncementAudienceConditionCreateInputs} announcementAudienceConditionCreateInputs
18558
18930
  * @param {*} [options] Override http request option.
18559
18931
  * @throws {RequiredError}
18560
18932
  */
18561
- updateAnnouncementSchedule: (announcementId: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18933
+ createAnnouncementAudienceCondition: (audienceId: string, filterId: string, announcementAudienceConditionCreateInputs: AnnouncementAudienceConditionCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18934
+ /**
18935
+ * Adds an AND/OR filter group to an audience, at the root or nested under parentFilterId (which must belong to the same audience); requires update permission on announcements.
18936
+ * @summary Create an audience filter group
18937
+ * @param {string} audienceId The audience identifier
18938
+ * @param {AnnouncementAudienceFilterCreateInputs} announcementAudienceFilterCreateInputs
18939
+ * @param {*} [options] Override http request option.
18940
+ * @throws {RequiredError}
18941
+ */
18942
+ createAnnouncementAudienceFilter: (audienceId: string, announcementAudienceFilterCreateInputs: AnnouncementAudienceFilterCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18943
+ /**
18944
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
18945
+ * @summary Delete an announcement audience
18946
+ * @param {string} audienceId The audience identifier
18947
+ * @param {*} [options] Override http request option.
18948
+ * @throws {RequiredError}
18949
+ */
18950
+ deleteAnnouncementAudience: (audienceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18951
+ /**
18952
+ * Removes a condition from its filter group; requires update permission on announcements.
18953
+ * @summary Delete an audience condition
18954
+ * @param {string} audienceId The audience identifier
18955
+ * @param {string} filterId The filter identifier
18956
+ * @param {string} conditionId The condition identifier
18957
+ * @param {*} [options] Override http request option.
18958
+ * @throws {RequiredError}
18959
+ */
18960
+ deleteAnnouncementAudienceCondition: (audienceId: string, filterId: string, conditionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18961
+ /**
18962
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
18963
+ * @summary Delete an audience filter group
18964
+ * @param {string} audienceId The audience identifier
18965
+ * @param {string} filterId The filter identifier
18966
+ * @param {*} [options] Override http request option.
18967
+ * @throws {RequiredError}
18968
+ */
18969
+ deleteAnnouncementAudienceFilter: (audienceId: string, filterId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18970
+ /**
18971
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
18972
+ * @summary Get an announcement audience
18973
+ * @param {string} audienceId The audience identifier
18974
+ * @param {*} [options] Override http request option.
18975
+ * @throws {RequiredError}
18976
+ */
18977
+ getAnnouncementAudience: (audienceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18978
+ /**
18979
+ * Returns a paginated preview of the accounts an audience currently matches, with the total in count; supports search and ordering; requires read permission on announcements.
18980
+ * @summary List the accounts in an announcement audience
18981
+ * @param {string} audienceId The audience identifier
18982
+ * @param {number} [page] Page number
18983
+ * @param {number} [pageSize] Number of items per page
18984
+ * @param {string} [orderBy] Field to order by
18985
+ * @param {string} [search] Search query
18986
+ * @param {*} [options] Override http request option.
18987
+ * @throws {RequiredError}
18988
+ */
18989
+ getAnnouncementAudienceAccounts: (audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18990
+ /**
18991
+ * Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
18992
+ * @summary List announcement audiences
18993
+ * @param {AnnouncementAudienceScope} [scope] Filter by scope
18994
+ * @param {number} [page] Page number
18995
+ * @param {number} [pageSize] Number of items per page
18996
+ * @param {string} [orderBy] Field to order by
18997
+ * @param {string} [search] Search query
18998
+ * @param {*} [options] Override http request option.
18999
+ * @throws {RequiredError}
19000
+ */
19001
+ getAnnouncementAudiences: (scope?: AnnouncementAudienceScope, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19002
+ /**
19003
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
19004
+ * @summary Update an announcement audience
19005
+ * @param {string} audienceId The audience identifier
19006
+ * @param {AnnouncementAudienceUpdateInputs} announcementAudienceUpdateInputs
19007
+ * @param {*} [options] Override http request option.
19008
+ * @throws {RequiredError}
19009
+ */
19010
+ updateAnnouncementAudience: (audienceId: string, announcementAudienceUpdateInputs: AnnouncementAudienceUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19011
+ /**
19012
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
19013
+ * @summary Update an audience condition
19014
+ * @param {string} audienceId The audience identifier
19015
+ * @param {string} filterId The filter identifier
19016
+ * @param {string} conditionId The condition identifier
19017
+ * @param {AnnouncementAudienceConditionUpdateInputs} announcementAudienceConditionUpdateInputs
19018
+ * @param {*} [options] Override http request option.
19019
+ * @throws {RequiredError}
19020
+ */
19021
+ updateAnnouncementAudienceCondition: (audienceId: string, filterId: string, conditionId: string, announcementAudienceConditionUpdateInputs: AnnouncementAudienceConditionUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19022
+ /**
19023
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
19024
+ * @summary Update an audience filter group
19025
+ * @param {string} audienceId The audience identifier
19026
+ * @param {string} filterId The filter identifier
19027
+ * @param {AnnouncementAudienceFilterUpdateInputs} announcementAudienceFilterUpdateInputs
19028
+ * @param {*} [options] Override http request option.
19029
+ * @throws {RequiredError}
19030
+ */
19031
+ updateAnnouncementAudienceFilter: (audienceId: string, filterId: string, announcementAudienceFilterUpdateInputs: AnnouncementAudienceFilterUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
18562
19032
  };
18563
19033
  /**
18564
- * AnnouncementsScheduleApi - functional programming interface
19034
+ * AnnouncementsAudiencesApi - functional programming interface
18565
19035
  */
18566
- export declare const AnnouncementsScheduleApiFp: (configuration?: Configuration) => {
19036
+ export declare const AnnouncementsAudiencesApiFp: (configuration?: Configuration) => {
18567
19037
  /**
18568
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
18569
- * @summary Cancel an announcement\'s scheduled send
18570
- * @param {string} announcementId The announcement identifier
19038
+ * Creates an audience scoped to an event (eventId), a group (groupId), a channel (channelId), or the whole community (none); the scope cannot be changed afterwards; requires create permission on announcements.
19039
+ * @summary Create an announcement audience
19040
+ * @param {AnnouncementAudienceCreateInputs} announcementAudienceCreateInputs
18571
19041
  * @param {*} [options] Override http request option.
18572
19042
  * @throws {RequiredError}
18573
19043
  */
18574
- cancelAnnouncementSchedule(announcementId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncement200Response>>;
19044
+ createAnnouncementAudience(announcementAudienceCreateInputs: AnnouncementAudienceCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudience200Response>>;
18575
19045
  /**
18576
- * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
18577
- * @summary Schedule or reschedule an announcement send
18578
- * @param {string} announcementId The announcement identifier
18579
- * @param {object} body
19046
+ * Adds a condition to a filter group; each type requires its own reference (e.g. passTypeId for eventPassType), event conditions inside an event audience always use that event, and every reference must belong to the organization; requires update permission on announcements.
19047
+ * @summary Create an audience condition
19048
+ * @param {string} audienceId The audience identifier
19049
+ * @param {string} filterId The filter identifier
19050
+ * @param {AnnouncementAudienceConditionCreateInputs} announcementAudienceConditionCreateInputs
18580
19051
  * @param {*} [options] Override http request option.
18581
19052
  * @throws {RequiredError}
18582
19053
  */
18583
- updateAnnouncementSchedule(announcementId: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncement200Response>>;
19054
+ createAnnouncementAudienceCondition(audienceId: string, filterId: string, announcementAudienceConditionCreateInputs: AnnouncementAudienceConditionCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceCondition200Response>>;
19055
+ /**
19056
+ * Adds an AND/OR filter group to an audience, at the root or nested under parentFilterId (which must belong to the same audience); requires update permission on announcements.
19057
+ * @summary Create an audience filter group
19058
+ * @param {string} audienceId The audience identifier
19059
+ * @param {AnnouncementAudienceFilterCreateInputs} announcementAudienceFilterCreateInputs
19060
+ * @param {*} [options] Override http request option.
19061
+ * @throws {RequiredError}
19062
+ */
19063
+ createAnnouncementAudienceFilter(audienceId: string, announcementAudienceFilterCreateInputs: AnnouncementAudienceFilterCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceFilter200Response>>;
19064
+ /**
19065
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
19066
+ * @summary Delete an announcement audience
19067
+ * @param {string} audienceId The audience identifier
19068
+ * @param {*} [options] Override http request option.
19069
+ * @throws {RequiredError}
19070
+ */
19071
+ deleteAnnouncementAudience(audienceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
19072
+ /**
19073
+ * Removes a condition from its filter group; requires update permission on announcements.
19074
+ * @summary Delete an audience condition
19075
+ * @param {string} audienceId The audience identifier
19076
+ * @param {string} filterId The filter identifier
19077
+ * @param {string} conditionId The condition identifier
19078
+ * @param {*} [options] Override http request option.
19079
+ * @throws {RequiredError}
19080
+ */
19081
+ deleteAnnouncementAudienceCondition(audienceId: string, filterId: string, conditionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
19082
+ /**
19083
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
19084
+ * @summary Delete an audience filter group
19085
+ * @param {string} audienceId The audience identifier
19086
+ * @param {string} filterId The filter identifier
19087
+ * @param {*} [options] Override http request option.
19088
+ * @throws {RequiredError}
19089
+ */
19090
+ deleteAnnouncementAudienceFilter(audienceId: string, filterId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
19091
+ /**
19092
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
19093
+ * @summary Get an announcement audience
19094
+ * @param {string} audienceId The audience identifier
19095
+ * @param {*} [options] Override http request option.
19096
+ * @throws {RequiredError}
19097
+ */
19098
+ getAnnouncementAudience(audienceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudience200Response>>;
19099
+ /**
19100
+ * Returns a paginated preview of the accounts an audience currently matches, with the total in count; supports search and ordering; requires read permission on announcements.
19101
+ * @summary List the accounts in an announcement audience
19102
+ * @param {string} audienceId The audience identifier
19103
+ * @param {number} [page] Page number
19104
+ * @param {number} [pageSize] Number of items per page
19105
+ * @param {string} [orderBy] Field to order by
19106
+ * @param {string} [search] Search query
19107
+ * @param {*} [options] Override http request option.
19108
+ * @throws {RequiredError}
19109
+ */
19110
+ getAnnouncementAudienceAccounts(audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudienceAccounts200Response>>;
19111
+ /**
19112
+ * Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
19113
+ * @summary List announcement audiences
19114
+ * @param {AnnouncementAudienceScope} [scope] Filter by scope
19115
+ * @param {number} [page] Page number
19116
+ * @param {number} [pageSize] Number of items per page
19117
+ * @param {string} [orderBy] Field to order by
19118
+ * @param {string} [search] Search query
19119
+ * @param {*} [options] Override http request option.
19120
+ * @throws {RequiredError}
19121
+ */
19122
+ getAnnouncementAudiences(scope?: AnnouncementAudienceScope, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudiences200Response>>;
19123
+ /**
19124
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
19125
+ * @summary Update an announcement audience
19126
+ * @param {string} audienceId The audience identifier
19127
+ * @param {AnnouncementAudienceUpdateInputs} announcementAudienceUpdateInputs
19128
+ * @param {*} [options] Override http request option.
19129
+ * @throws {RequiredError}
19130
+ */
19131
+ updateAnnouncementAudience(audienceId: string, announcementAudienceUpdateInputs: AnnouncementAudienceUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudience200Response>>;
19132
+ /**
19133
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
19134
+ * @summary Update an audience condition
19135
+ * @param {string} audienceId The audience identifier
19136
+ * @param {string} filterId The filter identifier
19137
+ * @param {string} conditionId The condition identifier
19138
+ * @param {AnnouncementAudienceConditionUpdateInputs} announcementAudienceConditionUpdateInputs
19139
+ * @param {*} [options] Override http request option.
19140
+ * @throws {RequiredError}
19141
+ */
19142
+ updateAnnouncementAudienceCondition(audienceId: string, filterId: string, conditionId: string, announcementAudienceConditionUpdateInputs: AnnouncementAudienceConditionUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceCondition200Response>>;
19143
+ /**
19144
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
19145
+ * @summary Update an audience filter group
19146
+ * @param {string} audienceId The audience identifier
19147
+ * @param {string} filterId The filter identifier
19148
+ * @param {AnnouncementAudienceFilterUpdateInputs} announcementAudienceFilterUpdateInputs
19149
+ * @param {*} [options] Override http request option.
19150
+ * @throws {RequiredError}
19151
+ */
19152
+ updateAnnouncementAudienceFilter(audienceId: string, filterId: string, announcementAudienceFilterUpdateInputs: AnnouncementAudienceFilterUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceFilter200Response>>;
18584
19153
  };
18585
19154
  /**
18586
- * AnnouncementsScheduleApi - factory interface
19155
+ * AnnouncementsAudiencesApi - factory interface
18587
19156
  */
18588
- export declare const AnnouncementsScheduleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
19157
+ export declare const AnnouncementsAudiencesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
18589
19158
  /**
18590
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
18591
- * @summary Cancel an announcement\'s scheduled send
18592
- * @param {AnnouncementsScheduleApiCancelAnnouncementScheduleRequest} requestParameters Request parameters.
19159
+ * Creates an audience scoped to an event (eventId), a group (groupId), a channel (channelId), or the whole community (none); the scope cannot be changed afterwards; requires create permission on announcements.
19160
+ * @summary Create an announcement audience
19161
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest} requestParameters Request parameters.
18593
19162
  * @param {*} [options] Override http request option.
18594
19163
  * @throws {RequiredError}
18595
19164
  */
18596
- cancelAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiCancelAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncement200Response>;
19165
+ createAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudience200Response>;
18597
19166
  /**
18598
- * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
18599
- * @summary Schedule or reschedule an announcement send
18600
- * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
19167
+ * Adds a condition to a filter group; each type requires its own reference (e.g. passTypeId for eventPassType), event conditions inside an event audience always use that event, and every reference must belong to the organization; requires update permission on announcements.
19168
+ * @summary Create an audience condition
19169
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
18601
19170
  * @param {*} [options] Override http request option.
18602
19171
  * @throws {RequiredError}
18603
19172
  */
18604
- updateAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncement200Response>;
19173
+ createAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceCondition200Response>;
19174
+ /**
19175
+ * Adds an AND/OR filter group to an audience, at the root or nested under parentFilterId (which must belong to the same audience); requires update permission on announcements.
19176
+ * @summary Create an audience filter group
19177
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
19178
+ * @param {*} [options] Override http request option.
19179
+ * @throws {RequiredError}
19180
+ */
19181
+ createAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceFilter200Response>;
19182
+ /**
19183
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
19184
+ * @summary Delete an announcement audience
19185
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest} requestParameters Request parameters.
19186
+ * @param {*} [options] Override http request option.
19187
+ * @throws {RequiredError}
19188
+ */
19189
+ deleteAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
19190
+ /**
19191
+ * Removes a condition from its filter group; requires update permission on announcements.
19192
+ * @summary Delete an audience condition
19193
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest} requestParameters Request parameters.
19194
+ * @param {*} [options] Override http request option.
19195
+ * @throws {RequiredError}
19196
+ */
19197
+ deleteAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
19198
+ /**
19199
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
19200
+ * @summary Delete an audience filter group
19201
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest} requestParameters Request parameters.
19202
+ * @param {*} [options] Override http request option.
19203
+ * @throws {RequiredError}
19204
+ */
19205
+ deleteAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
19206
+ /**
19207
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
19208
+ * @summary Get an announcement audience
19209
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
19210
+ * @param {*} [options] Override http request option.
19211
+ * @throws {RequiredError}
19212
+ */
19213
+ getAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudience200Response>;
19214
+ /**
19215
+ * Returns a paginated preview of the accounts an audience currently matches, with the total in count; supports search and ordering; requires read permission on announcements.
19216
+ * @summary List the accounts in an announcement audience
19217
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest} requestParameters Request parameters.
19218
+ * @param {*} [options] Override http request option.
19219
+ * @throws {RequiredError}
19220
+ */
19221
+ getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudienceAccounts200Response>;
19222
+ /**
19223
+ * Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
19224
+ * @summary List announcement audiences
19225
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
19226
+ * @param {*} [options] Override http request option.
19227
+ * @throws {RequiredError}
19228
+ */
19229
+ getAnnouncementAudiences(requestParameters?: AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudiences200Response>;
19230
+ /**
19231
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
19232
+ * @summary Update an announcement audience
19233
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest} requestParameters Request parameters.
19234
+ * @param {*} [options] Override http request option.
19235
+ * @throws {RequiredError}
19236
+ */
19237
+ updateAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudience200Response>;
19238
+ /**
19239
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
19240
+ * @summary Update an audience condition
19241
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
19242
+ * @param {*} [options] Override http request option.
19243
+ * @throws {RequiredError}
19244
+ */
19245
+ updateAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceCondition200Response>;
19246
+ /**
19247
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
19248
+ * @summary Update an audience filter group
19249
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
19250
+ * @param {*} [options] Override http request option.
19251
+ * @throws {RequiredError}
19252
+ */
19253
+ updateAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceFilter200Response>;
18605
19254
  };
18606
19255
  /**
18607
- * Request parameters for cancelAnnouncementSchedule operation in AnnouncementsScheduleApi.
19256
+ * Request parameters for createAnnouncementAudience operation in AnnouncementsAudiencesApi.
18608
19257
  */
18609
- export interface AnnouncementsScheduleApiCancelAnnouncementScheduleRequest {
19258
+ export interface AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest {
19259
+ readonly announcementAudienceCreateInputs: AnnouncementAudienceCreateInputs;
19260
+ }
19261
+ /**
19262
+ * Request parameters for createAnnouncementAudienceCondition operation in AnnouncementsAudiencesApi.
19263
+ */
19264
+ export interface AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest {
18610
19265
  /**
18611
- * The announcement identifier
19266
+ * The audience identifier
18612
19267
  */
18613
- readonly announcementId: string;
19268
+ readonly audienceId: string;
19269
+ /**
19270
+ * The filter identifier
19271
+ */
19272
+ readonly filterId: string;
19273
+ readonly announcementAudienceConditionCreateInputs: AnnouncementAudienceConditionCreateInputs;
18614
19274
  }
18615
19275
  /**
18616
- * Request parameters for updateAnnouncementSchedule operation in AnnouncementsScheduleApi.
19276
+ * Request parameters for createAnnouncementAudienceFilter operation in AnnouncementsAudiencesApi.
18617
19277
  */
18618
- export interface AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest {
19278
+ export interface AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest {
18619
19279
  /**
18620
- * The announcement identifier
19280
+ * The audience identifier
18621
19281
  */
18622
- readonly announcementId: string;
18623
- readonly body: object;
19282
+ readonly audienceId: string;
19283
+ readonly announcementAudienceFilterCreateInputs: AnnouncementAudienceFilterCreateInputs;
18624
19284
  }
18625
19285
  /**
18626
- * AnnouncementsScheduleApi - object-oriented interface
19286
+ * Request parameters for deleteAnnouncementAudience operation in AnnouncementsAudiencesApi.
18627
19287
  */
18628
- export declare class AnnouncementsScheduleApi extends BaseAPI {
19288
+ export interface AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest {
18629
19289
  /**
18630
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
18631
- * @summary Cancel an announcement\'s scheduled send
18632
- * @param {AnnouncementsScheduleApiCancelAnnouncementScheduleRequest} requestParameters Request parameters.
18633
- * @param {*} [options] Override http request option.
18634
- * @throws {RequiredError}
19290
+ * The audience identifier
18635
19291
  */
18636
- cancelAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiCancelAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncement200Response, any, {}, any>>;
19292
+ readonly audienceId: string;
19293
+ }
19294
+ /**
19295
+ * Request parameters for deleteAnnouncementAudienceCondition operation in AnnouncementsAudiencesApi.
19296
+ */
19297
+ export interface AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest {
18637
19298
  /**
18638
- * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
18639
- * @summary Schedule or reschedule an announcement send
18640
- * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
18641
- * @param {*} [options] Override http request option.
18642
- * @throws {RequiredError}
19299
+ * The audience identifier
18643
19300
  */
18644
- updateAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncement200Response, any, {}, any>>;
19301
+ readonly audienceId: string;
19302
+ /**
19303
+ * The filter identifier
19304
+ */
19305
+ readonly filterId: string;
19306
+ /**
19307
+ * The condition identifier
19308
+ */
19309
+ readonly conditionId: string;
19310
+ }
19311
+ /**
19312
+ * Request parameters for deleteAnnouncementAudienceFilter operation in AnnouncementsAudiencesApi.
19313
+ */
19314
+ export interface AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest {
19315
+ /**
19316
+ * The audience identifier
19317
+ */
19318
+ readonly audienceId: string;
19319
+ /**
19320
+ * The filter identifier
19321
+ */
19322
+ readonly filterId: string;
19323
+ }
19324
+ /**
19325
+ * Request parameters for getAnnouncementAudience operation in AnnouncementsAudiencesApi.
19326
+ */
19327
+ export interface AnnouncementsAudiencesApiGetAnnouncementAudienceRequest {
19328
+ /**
19329
+ * The audience identifier
19330
+ */
19331
+ readonly audienceId: string;
19332
+ }
19333
+ /**
19334
+ * Request parameters for getAnnouncementAudienceAccounts operation in AnnouncementsAudiencesApi.
19335
+ */
19336
+ export interface AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest {
19337
+ /**
19338
+ * The audience identifier
19339
+ */
19340
+ readonly audienceId: string;
19341
+ /**
19342
+ * Page number
19343
+ */
19344
+ readonly page?: number;
19345
+ /**
19346
+ * Number of items per page
19347
+ */
19348
+ readonly pageSize?: number;
19349
+ /**
19350
+ * Field to order by
19351
+ */
19352
+ readonly orderBy?: string;
19353
+ /**
19354
+ * Search query
19355
+ */
19356
+ readonly search?: string;
19357
+ }
19358
+ /**
19359
+ * Request parameters for getAnnouncementAudiences operation in AnnouncementsAudiencesApi.
19360
+ */
19361
+ export interface AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest {
19362
+ /**
19363
+ * Filter by scope
19364
+ */
19365
+ readonly scope?: AnnouncementAudienceScope;
19366
+ /**
19367
+ * Page number
19368
+ */
19369
+ readonly page?: number;
19370
+ /**
19371
+ * Number of items per page
19372
+ */
19373
+ readonly pageSize?: number;
19374
+ /**
19375
+ * Field to order by
19376
+ */
19377
+ readonly orderBy?: string;
19378
+ /**
19379
+ * Search query
19380
+ */
19381
+ readonly search?: string;
19382
+ }
19383
+ /**
19384
+ * Request parameters for updateAnnouncementAudience operation in AnnouncementsAudiencesApi.
19385
+ */
19386
+ export interface AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest {
19387
+ /**
19388
+ * The audience identifier
19389
+ */
19390
+ readonly audienceId: string;
19391
+ readonly announcementAudienceUpdateInputs: AnnouncementAudienceUpdateInputs;
19392
+ }
19393
+ /**
19394
+ * Request parameters for updateAnnouncementAudienceCondition operation in AnnouncementsAudiencesApi.
19395
+ */
19396
+ export interface AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest {
19397
+ /**
19398
+ * The audience identifier
19399
+ */
19400
+ readonly audienceId: string;
19401
+ /**
19402
+ * The filter identifier
19403
+ */
19404
+ readonly filterId: string;
19405
+ /**
19406
+ * The condition identifier
19407
+ */
19408
+ readonly conditionId: string;
19409
+ readonly announcementAudienceConditionUpdateInputs: AnnouncementAudienceConditionUpdateInputs;
19410
+ }
19411
+ /**
19412
+ * Request parameters for updateAnnouncementAudienceFilter operation in AnnouncementsAudiencesApi.
19413
+ */
19414
+ export interface AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest {
19415
+ /**
19416
+ * The audience identifier
19417
+ */
19418
+ readonly audienceId: string;
19419
+ /**
19420
+ * The filter identifier
19421
+ */
19422
+ readonly filterId: string;
19423
+ readonly announcementAudienceFilterUpdateInputs: AnnouncementAudienceFilterUpdateInputs;
19424
+ }
19425
+ /**
19426
+ * AnnouncementsAudiencesApi - object-oriented interface
19427
+ */
19428
+ export declare class AnnouncementsAudiencesApi extends BaseAPI {
19429
+ /**
19430
+ * Creates an audience scoped to an event (eventId), a group (groupId), a channel (channelId), or the whole community (none); the scope cannot be changed afterwards; requires create permission on announcements.
19431
+ * @summary Create an announcement audience
19432
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest} requestParameters Request parameters.
19433
+ * @param {*} [options] Override http request option.
19434
+ * @throws {RequiredError}
19435
+ */
19436
+ createAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudience200Response, any, {}, any>>;
19437
+ /**
19438
+ * Adds a condition to a filter group; each type requires its own reference (e.g. passTypeId for eventPassType), event conditions inside an event audience always use that event, and every reference must belong to the organization; requires update permission on announcements.
19439
+ * @summary Create an audience condition
19440
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
19441
+ * @param {*} [options] Override http request option.
19442
+ * @throws {RequiredError}
19443
+ */
19444
+ createAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudienceCondition200Response, any, {}, any>>;
19445
+ /**
19446
+ * Adds an AND/OR filter group to an audience, at the root or nested under parentFilterId (which must belong to the same audience); requires update permission on announcements.
19447
+ * @summary Create an audience filter group
19448
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
19449
+ * @param {*} [options] Override http request option.
19450
+ * @throws {RequiredError}
19451
+ */
19452
+ createAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudienceFilter200Response, any, {}, any>>;
19453
+ /**
19454
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
19455
+ * @summary Delete an announcement audience
19456
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest} requestParameters Request parameters.
19457
+ * @param {*} [options] Override http request option.
19458
+ * @throws {RequiredError}
19459
+ */
19460
+ deleteAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
19461
+ /**
19462
+ * Removes a condition from its filter group; requires update permission on announcements.
19463
+ * @summary Delete an audience condition
19464
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest} requestParameters Request parameters.
19465
+ * @param {*} [options] Override http request option.
19466
+ * @throws {RequiredError}
19467
+ */
19468
+ deleteAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
19469
+ /**
19470
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
19471
+ * @summary Delete an audience filter group
19472
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest} requestParameters Request parameters.
19473
+ * @param {*} [options] Override http request option.
19474
+ * @throws {RequiredError}
19475
+ */
19476
+ deleteAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
19477
+ /**
19478
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
19479
+ * @summary Get an announcement audience
19480
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
19481
+ * @param {*} [options] Override http request option.
19482
+ * @throws {RequiredError}
19483
+ */
19484
+ getAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudience200Response, any, {}, any>>;
19485
+ /**
19486
+ * Returns a paginated preview of the accounts an audience currently matches, with the total in count; supports search and ordering; requires read permission on announcements.
19487
+ * @summary List the accounts in an announcement audience
19488
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest} requestParameters Request parameters.
19489
+ * @param {*} [options] Override http request option.
19490
+ * @throws {RequiredError}
19491
+ */
19492
+ getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementAudienceAccounts200Response, any, {}, any>>;
19493
+ /**
19494
+ * Returns a paginated list of announcement audiences in one scope: pass an eventId, groupId or channelId for that scope\'s audiences, or none for community audiences. Active audiences by default, starred first; pass archived for the archived ones. requires read permission on announcements.
19495
+ * @summary List announcement audiences
19496
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
19497
+ * @param {*} [options] Override http request option.
19498
+ * @throws {RequiredError}
19499
+ */
19500
+ getAnnouncementAudiences(requestParameters?: AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementAudiences200Response, any, {}, any>>;
19501
+ /**
19502
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
19503
+ * @summary Update an announcement audience
19504
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest} requestParameters Request parameters.
19505
+ * @param {*} [options] Override http request option.
19506
+ * @throws {RequiredError}
19507
+ */
19508
+ updateAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudience200Response, any, {}, any>>;
19509
+ /**
19510
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
19511
+ * @summary Update an audience condition
19512
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
19513
+ * @param {*} [options] Override http request option.
19514
+ * @throws {RequiredError}
19515
+ */
19516
+ updateAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudienceCondition200Response, any, {}, any>>;
19517
+ /**
19518
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
19519
+ * @summary Update an audience filter group
19520
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
19521
+ * @param {*} [options] Override http request option.
19522
+ * @throws {RequiredError}
19523
+ */
19524
+ updateAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudienceFilter200Response, any, {}, any>>;
19525
+ }
19526
+ /**
19527
+ * AnnouncementsScheduleApi - axios parameter creator
19528
+ */
19529
+ export declare const AnnouncementsScheduleApiAxiosParamCreator: (configuration?: Configuration) => {
19530
+ /**
19531
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
19532
+ * @summary Cancel an announcement\'s scheduled send
19533
+ * @param {string} announcementId The announcement identifier
19534
+ * @param {*} [options] Override http request option.
19535
+ * @throws {RequiredError}
19536
+ */
19537
+ cancelAnnouncementSchedule: (announcementId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19538
+ /**
19539
+ * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
19540
+ * @summary Schedule or reschedule an announcement send
19541
+ * @param {string} announcementId The announcement identifier
19542
+ * @param {object} body
19543
+ * @param {*} [options] Override http request option.
19544
+ * @throws {RequiredError}
19545
+ */
19546
+ updateAnnouncementSchedule: (announcementId: string, body: object, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19547
+ };
19548
+ /**
19549
+ * AnnouncementsScheduleApi - functional programming interface
19550
+ */
19551
+ export declare const AnnouncementsScheduleApiFp: (configuration?: Configuration) => {
19552
+ /**
19553
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
19554
+ * @summary Cancel an announcement\'s scheduled send
19555
+ * @param {string} announcementId The announcement identifier
19556
+ * @param {*} [options] Override http request option.
19557
+ * @throws {RequiredError}
19558
+ */
19559
+ cancelAnnouncementSchedule(announcementId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncement200Response>>;
19560
+ /**
19561
+ * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
19562
+ * @summary Schedule or reschedule an announcement send
19563
+ * @param {string} announcementId The announcement identifier
19564
+ * @param {object} body
19565
+ * @param {*} [options] Override http request option.
19566
+ * @throws {RequiredError}
19567
+ */
19568
+ updateAnnouncementSchedule(announcementId: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncement200Response>>;
19569
+ };
19570
+ /**
19571
+ * AnnouncementsScheduleApi - factory interface
19572
+ */
19573
+ export declare const AnnouncementsScheduleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
19574
+ /**
19575
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
19576
+ * @summary Cancel an announcement\'s scheduled send
19577
+ * @param {AnnouncementsScheduleApiCancelAnnouncementScheduleRequest} requestParameters Request parameters.
19578
+ * @param {*} [options] Override http request option.
19579
+ * @throws {RequiredError}
19580
+ */
19581
+ cancelAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiCancelAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncement200Response>;
19582
+ /**
19583
+ * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
19584
+ * @summary Schedule or reschedule an announcement send
19585
+ * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
19586
+ * @param {*} [options] Override http request option.
19587
+ * @throws {RequiredError}
19588
+ */
19589
+ updateAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncement200Response>;
19590
+ };
19591
+ /**
19592
+ * Request parameters for cancelAnnouncementSchedule operation in AnnouncementsScheduleApi.
19593
+ */
19594
+ export interface AnnouncementsScheduleApiCancelAnnouncementScheduleRequest {
19595
+ /**
19596
+ * The announcement identifier
19597
+ */
19598
+ readonly announcementId: string;
19599
+ }
19600
+ /**
19601
+ * Request parameters for updateAnnouncementSchedule operation in AnnouncementsScheduleApi.
19602
+ */
19603
+ export interface AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest {
19604
+ /**
19605
+ * The announcement identifier
19606
+ */
19607
+ readonly announcementId: string;
19608
+ readonly body: object;
19609
+ }
19610
+ /**
19611
+ * AnnouncementsScheduleApi - object-oriented interface
19612
+ */
19613
+ export declare class AnnouncementsScheduleApi extends BaseAPI {
19614
+ /**
19615
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
19616
+ * @summary Cancel an announcement\'s scheduled send
19617
+ * @param {AnnouncementsScheduleApiCancelAnnouncementScheduleRequest} requestParameters Request parameters.
19618
+ * @param {*} [options] Override http request option.
19619
+ * @throws {RequiredError}
19620
+ */
19621
+ cancelAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiCancelAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncement200Response, any, {}, any>>;
19622
+ /**
19623
+ * Sets or updates the future send date/time for an announcement and whether it goes out via email and/or push notification; the announcement must already have HTML content, the date must be in the future, and update permission on announcements is required.
19624
+ * @summary Schedule or reschedule an announcement send
19625
+ * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
19626
+ * @param {*} [options] Override http request option.
19627
+ * @throws {RequiredError}
19628
+ */
19629
+ updateAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncement200Response, any, {}, any>>;
19630
+ }
19631
+ /**
19632
+ * AnnouncementsTemplatesApi - axios parameter creator
19633
+ */
19634
+ export declare const AnnouncementsTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
19635
+ /**
19636
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
19637
+ * @summary Create an announcement template
19638
+ * @param {AnnouncementTemplateCreateInputs} announcementTemplateCreateInputs
19639
+ * @param {*} [options] Override http request option.
19640
+ * @throws {RequiredError}
19641
+ */
19642
+ createAnnouncementTemplate: (announcementTemplateCreateInputs: AnnouncementTemplateCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19643
+ /**
19644
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
19645
+ * @summary Delete an announcement template
19646
+ * @param {string} templateId The template identifier
19647
+ * @param {*} [options] Override http request option.
19648
+ * @throws {RequiredError}
19649
+ */
19650
+ deleteAnnouncementTemplate: (templateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19651
+ /**
19652
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
19653
+ * @summary Get an announcement template
19654
+ * @param {string} templateId The template identifier
19655
+ * @param {*} [options] Override http request option.
19656
+ * @throws {RequiredError}
19657
+ */
19658
+ getAnnouncementTemplate: (templateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19659
+ /**
19660
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
19661
+ * @summary List announcement templates
19662
+ * @param {number} [page] Page number
19663
+ * @param {number} [pageSize] Number of items per page
19664
+ * @param {string} [orderBy] Field to order by
19665
+ * @param {string} [search] Search query
19666
+ * @param {*} [options] Override http request option.
19667
+ * @throws {RequiredError}
19668
+ */
19669
+ getAnnouncementTemplates: (page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19670
+ /**
19671
+ * Updates a template\'s name, description, default subject or HTML body. Announcements already created from the template keep their copied content; requires update permission on announcements.
19672
+ * @summary Update an announcement template
19673
+ * @param {string} templateId The template identifier
19674
+ * @param {AnnouncementTemplateUpdateInputs} announcementTemplateUpdateInputs
19675
+ * @param {*} [options] Override http request option.
19676
+ * @throws {RequiredError}
19677
+ */
19678
+ updateAnnouncementTemplate: (templateId: string, announcementTemplateUpdateInputs: AnnouncementTemplateUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19679
+ };
19680
+ /**
19681
+ * AnnouncementsTemplatesApi - functional programming interface
19682
+ */
19683
+ export declare const AnnouncementsTemplatesApiFp: (configuration?: Configuration) => {
19684
+ /**
19685
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
19686
+ * @summary Create an announcement template
19687
+ * @param {AnnouncementTemplateCreateInputs} announcementTemplateCreateInputs
19688
+ * @param {*} [options] Override http request option.
19689
+ * @throws {RequiredError}
19690
+ */
19691
+ createAnnouncementTemplate(announcementTemplateCreateInputs: AnnouncementTemplateCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementTemplate200Response>>;
19692
+ /**
19693
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
19694
+ * @summary Delete an announcement template
19695
+ * @param {string} templateId The template identifier
19696
+ * @param {*} [options] Override http request option.
19697
+ * @throws {RequiredError}
19698
+ */
19699
+ deleteAnnouncementTemplate(templateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
19700
+ /**
19701
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
19702
+ * @summary Get an announcement template
19703
+ * @param {string} templateId The template identifier
19704
+ * @param {*} [options] Override http request option.
19705
+ * @throws {RequiredError}
19706
+ */
19707
+ getAnnouncementTemplate(templateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementTemplate200Response>>;
19708
+ /**
19709
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
19710
+ * @summary List announcement templates
19711
+ * @param {number} [page] Page number
19712
+ * @param {number} [pageSize] Number of items per page
19713
+ * @param {string} [orderBy] Field to order by
19714
+ * @param {string} [search] Search query
19715
+ * @param {*} [options] Override http request option.
19716
+ * @throws {RequiredError}
19717
+ */
19718
+ getAnnouncementTemplates(page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementTemplates200Response>>;
19719
+ /**
19720
+ * Updates a template\'s name, description, default subject or HTML body. Announcements already created from the template keep their copied content; requires update permission on announcements.
19721
+ * @summary Update an announcement template
19722
+ * @param {string} templateId The template identifier
19723
+ * @param {AnnouncementTemplateUpdateInputs} announcementTemplateUpdateInputs
19724
+ * @param {*} [options] Override http request option.
19725
+ * @throws {RequiredError}
19726
+ */
19727
+ updateAnnouncementTemplate(templateId: string, announcementTemplateUpdateInputs: AnnouncementTemplateUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementTemplate200Response>>;
19728
+ };
19729
+ /**
19730
+ * AnnouncementsTemplatesApi - factory interface
19731
+ */
19732
+ export declare const AnnouncementsTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
19733
+ /**
19734
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
19735
+ * @summary Create an announcement template
19736
+ * @param {AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest} requestParameters Request parameters.
19737
+ * @param {*} [options] Override http request option.
19738
+ * @throws {RequiredError}
19739
+ */
19740
+ createAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementTemplate200Response>;
19741
+ /**
19742
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
19743
+ * @summary Delete an announcement template
19744
+ * @param {AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest} requestParameters Request parameters.
19745
+ * @param {*} [options] Override http request option.
19746
+ * @throws {RequiredError}
19747
+ */
19748
+ deleteAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
19749
+ /**
19750
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
19751
+ * @summary Get an announcement template
19752
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplateRequest} requestParameters Request parameters.
19753
+ * @param {*} [options] Override http request option.
19754
+ * @throws {RequiredError}
19755
+ */
19756
+ getAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiGetAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementTemplate200Response>;
19757
+ /**
19758
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
19759
+ * @summary List announcement templates
19760
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest} requestParameters Request parameters.
19761
+ * @param {*} [options] Override http request option.
19762
+ * @throws {RequiredError}
19763
+ */
19764
+ getAnnouncementTemplates(requestParameters?: AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementTemplates200Response>;
19765
+ /**
19766
+ * Updates a template\'s name, description, default subject or HTML body. Announcements already created from the template keep their copied content; requires update permission on announcements.
19767
+ * @summary Update an announcement template
19768
+ * @param {AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest} requestParameters Request parameters.
19769
+ * @param {*} [options] Override http request option.
19770
+ * @throws {RequiredError}
19771
+ */
19772
+ updateAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementTemplate200Response>;
19773
+ };
19774
+ /**
19775
+ * Request parameters for createAnnouncementTemplate operation in AnnouncementsTemplatesApi.
19776
+ */
19777
+ export interface AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest {
19778
+ readonly announcementTemplateCreateInputs: AnnouncementTemplateCreateInputs;
19779
+ }
19780
+ /**
19781
+ * Request parameters for deleteAnnouncementTemplate operation in AnnouncementsTemplatesApi.
19782
+ */
19783
+ export interface AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest {
19784
+ /**
19785
+ * The template identifier
19786
+ */
19787
+ readonly templateId: string;
19788
+ }
19789
+ /**
19790
+ * Request parameters for getAnnouncementTemplate operation in AnnouncementsTemplatesApi.
19791
+ */
19792
+ export interface AnnouncementsTemplatesApiGetAnnouncementTemplateRequest {
19793
+ /**
19794
+ * The template identifier
19795
+ */
19796
+ readonly templateId: string;
19797
+ }
19798
+ /**
19799
+ * Request parameters for getAnnouncementTemplates operation in AnnouncementsTemplatesApi.
19800
+ */
19801
+ export interface AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest {
19802
+ /**
19803
+ * Page number
19804
+ */
19805
+ readonly page?: number;
19806
+ /**
19807
+ * Number of items per page
19808
+ */
19809
+ readonly pageSize?: number;
19810
+ /**
19811
+ * Field to order by
19812
+ */
19813
+ readonly orderBy?: string;
19814
+ /**
19815
+ * Search query
19816
+ */
19817
+ readonly search?: string;
19818
+ }
19819
+ /**
19820
+ * Request parameters for updateAnnouncementTemplate operation in AnnouncementsTemplatesApi.
19821
+ */
19822
+ export interface AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest {
19823
+ /**
19824
+ * The template identifier
19825
+ */
19826
+ readonly templateId: string;
19827
+ readonly announcementTemplateUpdateInputs: AnnouncementTemplateUpdateInputs;
19828
+ }
19829
+ /**
19830
+ * AnnouncementsTemplatesApi - object-oriented interface
19831
+ */
19832
+ export declare class AnnouncementsTemplatesApi extends BaseAPI {
19833
+ /**
19834
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
19835
+ * @summary Create an announcement template
19836
+ * @param {AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest} requestParameters Request parameters.
19837
+ * @param {*} [options] Override http request option.
19838
+ * @throws {RequiredError}
19839
+ */
19840
+ createAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementTemplate200Response, any, {}, any>>;
19841
+ /**
19842
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
19843
+ * @summary Delete an announcement template
19844
+ * @param {AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest} requestParameters Request parameters.
19845
+ * @param {*} [options] Override http request option.
19846
+ * @throws {RequiredError}
19847
+ */
19848
+ deleteAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
19849
+ /**
19850
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
19851
+ * @summary Get an announcement template
19852
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplateRequest} requestParameters Request parameters.
19853
+ * @param {*} [options] Override http request option.
19854
+ * @throws {RequiredError}
19855
+ */
19856
+ getAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiGetAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementTemplate200Response, any, {}, any>>;
19857
+ /**
19858
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
19859
+ * @summary List announcement templates
19860
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest} requestParameters Request parameters.
19861
+ * @param {*} [options] Override http request option.
19862
+ * @throws {RequiredError}
19863
+ */
19864
+ getAnnouncementTemplates(requestParameters?: AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementTemplates200Response, any, {}, any>>;
19865
+ /**
19866
+ * Updates a template\'s name, description, default subject or HTML body. Announcements already created from the template keep their copied content; requires update permission on announcements.
19867
+ * @summary Update an announcement template
19868
+ * @param {AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest} requestParameters Request parameters.
19869
+ * @param {*} [options] Override http request option.
19870
+ * @throws {RequiredError}
19871
+ */
19872
+ updateAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementTemplate200Response, any, {}, any>>;
19873
+ }
19874
+ /**
19875
+ * AnnouncementsTemplatesTranslationsApi - axios parameter creator
19876
+ */
19877
+ export declare const AnnouncementsTemplatesTranslationsApiAxiosParamCreator: (configuration?: Configuration) => {
19878
+ /**
19879
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
19880
+ * @summary Delete an announcement template translation
19881
+ * @param {string} templateId The template identifier
19882
+ * @param {string} locale The locale identifier
19883
+ * @param {*} [options] Override http request option.
19884
+ * @throws {RequiredError}
19885
+ */
19886
+ deleteAnnouncementTemplateTranslation: (templateId: string, locale: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19887
+ /**
19888
+ * Returns the translated subject and HTML body of an announcement template for the specified locale, or null if no translation exists; requires read permission on announcements.
19889
+ * @summary Get an announcement template\'s translation for a locale
19890
+ * @param {string} templateId The template identifier
19891
+ * @param {string} locale The locale identifier
19892
+ * @param {*} [options] Override http request option.
19893
+ * @throws {RequiredError}
19894
+ */
19895
+ getAnnouncementTemplateTranslation: (templateId: string, locale: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19896
+ /**
19897
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
19898
+ * @summary List an announcement template\'s translations
19899
+ * @param {string} templateId The template identifier
19900
+ * @param {number} [page] Page number
19901
+ * @param {number} [pageSize] Number of items per page
19902
+ * @param {string} [orderBy] Field to order by
19903
+ * @param {string} [search] Search query
19904
+ * @param {*} [options] Override http request option.
19905
+ * @throws {RequiredError}
19906
+ */
19907
+ getAnnouncementTemplateTranslations: (templateId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19908
+ /**
19909
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
19910
+ * @summary Update an announcement template translation
19911
+ * @param {string} templateId The template identifier
19912
+ * @param {string} locale The locale identifier
19913
+ * @param {AnnouncementTemplateTranslationUpdateInputs} announcementTemplateTranslationUpdateInputs
19914
+ * @param {*} [options] Override http request option.
19915
+ * @throws {RequiredError}
19916
+ */
19917
+ updateAnnouncementTemplateTranslation: (templateId: string, locale: string, announcementTemplateTranslationUpdateInputs: AnnouncementTemplateTranslationUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
19918
+ };
19919
+ /**
19920
+ * AnnouncementsTemplatesTranslationsApi - functional programming interface
19921
+ */
19922
+ export declare const AnnouncementsTemplatesTranslationsApiFp: (configuration?: Configuration) => {
19923
+ /**
19924
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
19925
+ * @summary Delete an announcement template translation
19926
+ * @param {string} templateId The template identifier
19927
+ * @param {string} locale The locale identifier
19928
+ * @param {*} [options] Override http request option.
19929
+ * @throws {RequiredError}
19930
+ */
19931
+ deleteAnnouncementTemplateTranslation(templateId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
19932
+ /**
19933
+ * Returns the translated subject and HTML body of an announcement template for the specified locale, or null if no translation exists; requires read permission on announcements.
19934
+ * @summary Get an announcement template\'s translation for a locale
19935
+ * @param {string} templateId The template identifier
19936
+ * @param {string} locale The locale identifier
19937
+ * @param {*} [options] Override http request option.
19938
+ * @throws {RequiredError}
19939
+ */
19940
+ getAnnouncementTemplateTranslation(templateId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementTemplateTranslation200Response>>;
19941
+ /**
19942
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
19943
+ * @summary List an announcement template\'s translations
19944
+ * @param {string} templateId The template identifier
19945
+ * @param {number} [page] Page number
19946
+ * @param {number} [pageSize] Number of items per page
19947
+ * @param {string} [orderBy] Field to order by
19948
+ * @param {string} [search] Search query
19949
+ * @param {*} [options] Override http request option.
19950
+ * @throws {RequiredError}
19951
+ */
19952
+ getAnnouncementTemplateTranslations(templateId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementTemplateTranslations200Response>>;
19953
+ /**
19954
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
19955
+ * @summary Update an announcement template translation
19956
+ * @param {string} templateId The template identifier
19957
+ * @param {string} locale The locale identifier
19958
+ * @param {AnnouncementTemplateTranslationUpdateInputs} announcementTemplateTranslationUpdateInputs
19959
+ * @param {*} [options] Override http request option.
19960
+ * @throws {RequiredError}
19961
+ */
19962
+ updateAnnouncementTemplateTranslation(templateId: string, locale: string, announcementTemplateTranslationUpdateInputs: AnnouncementTemplateTranslationUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateAnnouncementTemplateTranslation200Response>>;
19963
+ };
19964
+ /**
19965
+ * AnnouncementsTemplatesTranslationsApi - factory interface
19966
+ */
19967
+ export declare const AnnouncementsTemplatesTranslationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
19968
+ /**
19969
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
19970
+ * @summary Delete an announcement template translation
19971
+ * @param {AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
19972
+ * @param {*} [options] Override http request option.
19973
+ * @throws {RequiredError}
19974
+ */
19975
+ deleteAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
19976
+ /**
19977
+ * Returns the translated subject and HTML body of an announcement template for the specified locale, or null if no translation exists; requires read permission on announcements.
19978
+ * @summary Get an announcement template\'s translation for a locale
19979
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
19980
+ * @param {*} [options] Override http request option.
19981
+ * @throws {RequiredError}
19982
+ */
19983
+ getAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementTemplateTranslation200Response>;
19984
+ /**
19985
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
19986
+ * @summary List an announcement template\'s translations
19987
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest} requestParameters Request parameters.
19988
+ * @param {*} [options] Override http request option.
19989
+ * @throws {RequiredError}
19990
+ */
19991
+ getAnnouncementTemplateTranslations(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementTemplateTranslations200Response>;
19992
+ /**
19993
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
19994
+ * @summary Update an announcement template translation
19995
+ * @param {AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
19996
+ * @param {*} [options] Override http request option.
19997
+ * @throws {RequiredError}
19998
+ */
19999
+ updateAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateAnnouncementTemplateTranslation200Response>;
20000
+ };
20001
+ /**
20002
+ * Request parameters for deleteAnnouncementTemplateTranslation operation in AnnouncementsTemplatesTranslationsApi.
20003
+ */
20004
+ export interface AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest {
20005
+ /**
20006
+ * The template identifier
20007
+ */
20008
+ readonly templateId: string;
20009
+ /**
20010
+ * The locale identifier
20011
+ */
20012
+ readonly locale: string;
20013
+ }
20014
+ /**
20015
+ * Request parameters for getAnnouncementTemplateTranslation operation in AnnouncementsTemplatesTranslationsApi.
20016
+ */
20017
+ export interface AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest {
20018
+ /**
20019
+ * The template identifier
20020
+ */
20021
+ readonly templateId: string;
20022
+ /**
20023
+ * The locale identifier
20024
+ */
20025
+ readonly locale: string;
20026
+ }
20027
+ /**
20028
+ * Request parameters for getAnnouncementTemplateTranslations operation in AnnouncementsTemplatesTranslationsApi.
20029
+ */
20030
+ export interface AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest {
20031
+ /**
20032
+ * The template identifier
20033
+ */
20034
+ readonly templateId: string;
20035
+ /**
20036
+ * Page number
20037
+ */
20038
+ readonly page?: number;
20039
+ /**
20040
+ * Number of items per page
20041
+ */
20042
+ readonly pageSize?: number;
20043
+ /**
20044
+ * Field to order by
20045
+ */
20046
+ readonly orderBy?: string;
20047
+ /**
20048
+ * Search query
20049
+ */
20050
+ readonly search?: string;
20051
+ }
20052
+ /**
20053
+ * Request parameters for updateAnnouncementTemplateTranslation operation in AnnouncementsTemplatesTranslationsApi.
20054
+ */
20055
+ export interface AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest {
20056
+ /**
20057
+ * The template identifier
20058
+ */
20059
+ readonly templateId: string;
20060
+ /**
20061
+ * The locale identifier
20062
+ */
20063
+ readonly locale: string;
20064
+ readonly announcementTemplateTranslationUpdateInputs: AnnouncementTemplateTranslationUpdateInputs;
20065
+ }
20066
+ /**
20067
+ * AnnouncementsTemplatesTranslationsApi - object-oriented interface
20068
+ */
20069
+ export declare class AnnouncementsTemplatesTranslationsApi extends BaseAPI {
20070
+ /**
20071
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
20072
+ * @summary Delete an announcement template translation
20073
+ * @param {AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
20074
+ * @param {*} [options] Override http request option.
20075
+ * @throws {RequiredError}
20076
+ */
20077
+ deleteAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
20078
+ /**
20079
+ * Returns the translated subject and HTML body of an announcement template for the specified locale, or null if no translation exists; requires read permission on announcements.
20080
+ * @summary Get an announcement template\'s translation for a locale
20081
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
20082
+ * @param {*} [options] Override http request option.
20083
+ * @throws {RequiredError}
20084
+ */
20085
+ getAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementTemplateTranslation200Response, any, {}, any>>;
20086
+ /**
20087
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
20088
+ * @summary List an announcement template\'s translations
20089
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest} requestParameters Request parameters.
20090
+ * @param {*} [options] Override http request option.
20091
+ * @throws {RequiredError}
20092
+ */
20093
+ getAnnouncementTemplateTranslations(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementTemplateTranslations200Response, any, {}, any>>;
20094
+ /**
20095
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
20096
+ * @summary Update an announcement template translation
20097
+ * @param {AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
20098
+ * @param {*} [options] Override http request option.
20099
+ * @throws {RequiredError}
20100
+ */
20101
+ updateAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAnnouncementTemplateTranslation200Response, any, {}, any>>;
18645
20102
  }
18646
20103
  /**
18647
20104
  * AnnouncementsTranslationsApi - axios parameter creator