@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/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.23.1
7
+ * The version of the OpenAPI document: 12.1.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -711,56 +711,342 @@ export interface Announcement {
711
711
  'push': boolean;
712
712
  'sms': boolean;
713
713
  'includePasses': boolean;
714
- 'accountId': string | null;
715
714
  'creatorId': string | null;
716
715
  'eventId': string | null;
717
716
  'groupId': string | null;
718
- 'tierId': string | null;
719
- 'channelId': string | null;
720
- 'ticketId': string | null;
717
+ 'audienceId': string | null;
721
718
  'userId': string | null;
722
719
  'schedule': BaseSchedule;
720
+ 'sentAt': string | null;
721
+ 'recipientCount': number | null;
723
722
  'createdAt': string;
724
- 'verifiedAccounts': boolean;
725
- 'account': BaseAccount | null;
726
723
  'creator': BaseAccount | null;
727
724
  'event': BaseEvent | null;
728
725
  'group': BaseGroup | null;
729
- 'tier': BaseTier | null;
730
- 'channel': BaseChannel | null;
731
- 'sponsorshipLevelId': string | null;
732
- 'sponsorshipLevel': BaseLevel | null;
733
- 'ticket': BaseEventPassType | null;
726
+ 'audience': AnnouncementAudienceReference | null;
727
+ 'audienceSnapshot': AnnouncementAudience | null;
734
728
  'user': BaseUser | null;
735
729
  'message': string | null;
736
- 'filters': EventAnnouncementFilters | null;
737
730
  'updatedAt': string;
738
731
  }
739
- export interface AnnouncementCreateInputs {
740
- 'title': string | null;
741
- 'html'?: string | null;
742
- 'slug'?: string | null;
743
- 'creatorId'?: string | null;
732
+ export interface AnnouncementAudience {
733
+ 'id': string;
734
+ 'name': string;
735
+ 'description': string | null;
736
+ 'eventId': string | null;
737
+ 'groupId': string | null;
738
+ 'channelId': string | null;
739
+ 'operator': AnnouncementAudienceOperator;
740
+ 'featured': boolean;
741
+ 'archived': boolean;
742
+ 'createdAt': string;
743
+ 'updatedAt': string;
744
+ 'event': AnnouncementAudienceConditionEvent | null;
745
+ 'group': AnnouncementAudienceConditionEvent | null;
746
+ 'channel': AnnouncementAudienceConditionEvent | null;
747
+ 'filters': Array<AnnouncementAudienceFilter>;
748
+ }
749
+
750
+
751
+ export interface AnnouncementAudienceCondition {
752
+ 'id': string;
753
+ 'filterId': string;
754
+ 'type': AnnouncementAudienceConditionType;
755
+ 'negate': boolean;
756
+ 'sortOrder': number;
757
+ 'eventId': string | null;
758
+ 'event': AnnouncementAudienceConditionEvent | null;
759
+ 'passTypeId': string | null;
760
+ 'passType': AnnouncementAudienceConditionReference | null;
761
+ 'addOnId': string | null;
762
+ 'addOn': AnnouncementAudienceConditionReference | null;
763
+ 'sessionId': string | null;
764
+ 'session': AnnouncementAudienceConditionReference | null;
765
+ 'roomTypeId': string | null;
766
+ 'roomType': AnnouncementAudienceConditionReference | null;
767
+ 'questionId': string | null;
768
+ 'question': AnnouncementAudienceConditionQuestion | null;
769
+ 'choiceId': string | null;
770
+ 'choice': AnnouncementAudienceConditionChoice | null;
771
+ 'passAttributeId': string | null;
772
+ 'passAttribute': AnnouncementAudienceConditionReference | null;
773
+ 'tierId': string | null;
774
+ 'tier': AnnouncementAudienceConditionReference | null;
775
+ 'groupId': string | null;
776
+ 'group': AnnouncementAudienceConditionReference | null;
777
+ 'groupRole': GroupMembershipRole | null;
778
+ 'channelId': string | null;
779
+ 'channel': AnnouncementAudienceConditionReference | null;
780
+ 'sponsorshipLevelId': string | null;
781
+ 'sponsorshipLevel': AnnouncementAudienceConditionReference | null;
782
+ 'seriesId': string | null;
783
+ 'series': AnnouncementAudienceConditionReference | null;
784
+ 'accountAttributeId': string | null;
785
+ 'accountAttribute': AnnouncementAudienceConditionAccountAttribute | null;
786
+ 'accountId': string | null;
787
+ 'account': BaseAccount | null;
788
+ 'comparator': AnnouncementAudienceConditionComparator | null;
789
+ 'value': string | null;
790
+ 'createdAt': string;
791
+ 'updatedAt': string;
792
+ }
793
+
794
+
795
+ export interface AnnouncementAudienceConditionAccountAttribute {
796
+ 'id': string;
797
+ 'name': string;
798
+ 'label': string;
799
+ 'type': AccountAttributeType;
800
+ }
801
+
802
+
803
+ export interface AnnouncementAudienceConditionChoice {
804
+ 'id': string;
805
+ 'value': string;
806
+ }
807
+
808
+ export enum AnnouncementAudienceConditionComparator {
809
+ Equals = 'equals',
810
+ Contains = 'contains',
811
+ IsSet = 'isSet',
812
+ NotSet = 'notSet'
813
+ }
814
+
815
+
816
+ export interface AnnouncementAudienceConditionCreateInputs {
817
+ 'negate'?: boolean;
818
+ 'sortOrder'?: number | null;
744
819
  'eventId'?: string | null;
820
+ 'passTypeId'?: string | null;
821
+ 'addOnId'?: string | null;
822
+ 'sessionId'?: string | null;
823
+ 'roomTypeId'?: string | null;
824
+ 'questionId'?: string | null;
825
+ 'choiceId'?: string | null;
826
+ 'passAttributeId'?: string | null;
827
+ 'tierId'?: string | null;
745
828
  'groupId'?: string | null;
829
+ 'groupRole'?: GroupMembershipRole | null;
830
+ 'channelId'?: string | null;
831
+ 'sponsorshipLevelId'?: string | null;
832
+ 'seriesId'?: string | null;
833
+ 'accountAttributeId'?: string | null;
834
+ 'accountId'?: string | null;
835
+ 'comparator'?: AnnouncementAudienceConditionComparator | null;
836
+ 'value'?: string | null;
837
+ 'type': AnnouncementAudienceConditionType;
838
+ }
839
+
840
+
841
+ export interface AnnouncementAudienceConditionEvent {
842
+ 'id': string;
843
+ 'slug': string;
844
+ 'name': string;
845
+ }
846
+ export interface AnnouncementAudienceConditionInputs {
847
+ 'negate'?: boolean;
848
+ 'sortOrder'?: number | null;
849
+ 'eventId'?: string | null;
850
+ 'passTypeId'?: string | null;
851
+ 'addOnId'?: string | null;
852
+ 'sessionId'?: string | null;
853
+ 'roomTypeId'?: string | null;
854
+ 'questionId'?: string | null;
855
+ 'choiceId'?: string | null;
856
+ 'passAttributeId'?: string | null;
746
857
  'tierId'?: string | null;
858
+ 'groupId'?: string | null;
859
+ 'groupRole'?: GroupMembershipRole | null;
747
860
  'channelId'?: string | null;
861
+ 'sponsorshipLevelId'?: string | null;
862
+ 'seriesId'?: string | null;
863
+ 'accountAttributeId'?: string | null;
748
864
  'accountId'?: string | null;
749
- 'verifiedAccounts'?: boolean | null;
865
+ 'comparator'?: AnnouncementAudienceConditionComparator | null;
866
+ 'value'?: string | null;
867
+ }
868
+
869
+
870
+ export interface AnnouncementAudienceConditionQuestion {
871
+ 'id': string;
872
+ 'name': string;
873
+ 'label': string | null;
874
+ }
875
+ export interface AnnouncementAudienceConditionReference {
876
+ 'id': string;
877
+ 'name': string;
878
+ }
879
+
880
+ export enum AnnouncementAudienceConditionType {
881
+ EventPass = 'eventPass',
882
+ EventPassType = 'eventPassType',
883
+ EventCheckedIn = 'eventCheckedIn',
884
+ EventAddOn = 'eventAddOn',
885
+ EventSessionAccess = 'eventSessionAccess',
886
+ EventSessionCheckedIn = 'eventSessionCheckedIn',
887
+ EventRoomType = 'eventRoomType',
888
+ EventQuestionChoice = 'eventQuestionChoice',
889
+ EventPassAttribute = 'eventPassAttribute',
890
+ Tier = 'tier',
891
+ Group = 'group',
892
+ Channel = 'channel',
893
+ SponsorshipLevel = 'sponsorshipLevel',
894
+ Series = 'series',
895
+ AccountAttribute = 'accountAttribute',
896
+ Verified = 'verified',
897
+ Account = 'account'
898
+ }
899
+
900
+
901
+ export interface AnnouncementAudienceConditionUpdateInputs {
902
+ 'negate'?: boolean;
903
+ 'sortOrder'?: number | null;
904
+ 'eventId'?: string | null;
905
+ 'passTypeId'?: string | null;
906
+ 'addOnId'?: string | null;
907
+ 'sessionId'?: string | null;
908
+ 'roomTypeId'?: string | null;
909
+ 'questionId'?: string | null;
910
+ 'choiceId'?: string | null;
911
+ 'passAttributeId'?: string | null;
912
+ 'tierId'?: string | null;
913
+ 'groupId'?: string | null;
914
+ 'groupRole'?: GroupMembershipRole | null;
915
+ 'channelId'?: string | null;
750
916
  'sponsorshipLevelId'?: string | null;
917
+ 'seriesId'?: string | null;
918
+ 'accountAttributeId'?: string | null;
919
+ 'accountId'?: string | null;
920
+ 'comparator'?: AnnouncementAudienceConditionComparator | null;
921
+ 'value'?: string | null;
922
+ 'type'?: AnnouncementAudienceConditionType;
923
+ }
924
+
925
+
926
+ export interface AnnouncementAudienceCreateInputs {
927
+ 'name': string;
928
+ 'description'?: string | null;
929
+ 'eventId'?: string | null;
930
+ 'groupId'?: string | null;
931
+ 'channelId'?: string | null;
932
+ 'operator'?: AnnouncementAudienceOperator;
933
+ }
934
+
935
+
936
+ export interface AnnouncementAudienceFilter {
937
+ 'id': string;
938
+ 'parentFilterId': string | null;
939
+ 'operator': AnnouncementAudienceOperator;
940
+ 'sortOrder': number;
941
+ 'conditions': Array<AnnouncementAudienceCondition>;
942
+ 'createdAt': string;
943
+ 'updatedAt': string;
944
+ }
945
+
946
+
947
+ export interface AnnouncementAudienceFilterCreateInputs {
948
+ 'parentFilterId'?: string | null;
949
+ 'operator'?: AnnouncementAudienceOperator;
950
+ 'sortOrder'?: number | null;
951
+ }
952
+
953
+
954
+ export interface AnnouncementAudienceFilterUpdateInputs {
955
+ 'operator'?: AnnouncementAudienceOperator;
956
+ 'sortOrder'?: number | null;
957
+ }
958
+
959
+
960
+
961
+ export enum AnnouncementAudienceOperator {
962
+ And = 'AND',
963
+ Or = 'OR'
964
+ }
965
+
966
+
967
+ export interface AnnouncementAudienceReference {
968
+ 'id': string;
969
+ 'name': string;
970
+ 'eventId': string | null;
971
+ 'groupId': string | null;
972
+ }
973
+ export interface AnnouncementAudienceScope {
974
+ 'eventId'?: string;
975
+ 'groupId'?: string;
976
+ 'channelId'?: string;
977
+ 'archived'?: boolean;
978
+ }
979
+ export interface AnnouncementAudienceUpdateInputs {
980
+ 'name'?: string;
981
+ 'description'?: string | null;
982
+ 'operator'?: AnnouncementAudienceOperator;
983
+ 'featured'?: boolean;
984
+ 'archived'?: boolean;
985
+ }
986
+
987
+
988
+ export interface AnnouncementCreateInputs {
989
+ 'title'?: string | null;
990
+ 'html'?: string | null;
991
+ 'templateId'?: string | null;
992
+ 'slug'?: string | null;
993
+ 'creatorId'?: string | null;
994
+ 'eventId'?: string | null;
995
+ 'groupId'?: string | null;
996
+ 'audienceId'?: string | null;
751
997
  'email'?: boolean;
752
998
  'push'?: boolean;
753
- 'filters'?: EventAnnouncementFilters | null;
754
999
  'includePasses'?: boolean;
755
1000
  }
756
1001
  export interface AnnouncementFilters {
757
- 'verifiedAccounts'?: boolean;
758
1002
  'eventId'?: string;
759
1003
  'groupId'?: string;
760
- 'tierId'?: string;
761
- 'channelId'?: string;
762
- 'accountId'?: string;
763
- 'sponsorshipLevelId'?: string;
1004
+ 'audienceId'?: string;
1005
+ 'community'?: boolean;
1006
+ }
1007
+ export interface AnnouncementMergeField {
1008
+ 'token': string;
1009
+ 'label': string;
1010
+ 'group': AnnouncementMergeFieldGroupEnum;
1011
+ }
1012
+
1013
+ export enum AnnouncementMergeFieldGroupEnum {
1014
+ Account = 'Account',
1015
+ Attributes = 'Attributes'
1016
+ }
1017
+
1018
+ export interface AnnouncementTemplate {
1019
+ 'id': string;
1020
+ 'name': string;
1021
+ 'description': string | null;
1022
+ 'title': string | null;
1023
+ 'html': string | null;
1024
+ 'createdAt': string;
1025
+ 'updatedAt': string;
1026
+ }
1027
+ export interface AnnouncementTemplateCreateInputs {
1028
+ 'name': string;
1029
+ 'description'?: string | null;
1030
+ 'title'?: string | null;
1031
+ 'html'?: string | null;
1032
+ }
1033
+ export interface AnnouncementTemplateTranslation {
1034
+ 'id': string;
1035
+ 'locale': string;
1036
+ 'title': string | null;
1037
+ 'html': string | null;
1038
+ 'createdAt': string;
1039
+ 'updatedAt': string;
1040
+ }
1041
+ export interface AnnouncementTemplateTranslationUpdateInputs {
1042
+ 'title'?: string | null;
1043
+ 'html'?: string | null;
1044
+ }
1045
+ export interface AnnouncementTemplateUpdateInputs {
1046
+ 'name'?: string;
1047
+ 'description'?: string | null;
1048
+ 'title'?: string | null;
1049
+ 'html'?: string | null;
764
1050
  }
765
1051
  export interface AnnouncementTranslation {
766
1052
  'id': number;
@@ -779,9 +1065,9 @@ export interface AnnouncementUpdateInputs {
779
1065
  'title'?: string | null;
780
1066
  'html'?: string | null;
781
1067
  'slug'?: string | null;
1068
+ 'audienceId'?: string | null;
782
1069
  'email'?: boolean;
783
1070
  'push'?: boolean;
784
- 'filters'?: EventAnnouncementFilters | null;
785
1071
  'includePasses'?: boolean;
786
1072
  }
787
1073
  export interface ApproveEventPassRequest {
@@ -1039,17 +1325,31 @@ export interface BaseAnnouncement {
1039
1325
  'push': boolean;
1040
1326
  'sms': boolean;
1041
1327
  'includePasses': boolean;
1042
- 'accountId': string | null;
1043
1328
  'creatorId': string | null;
1044
1329
  'eventId': string | null;
1045
1330
  'groupId': string | null;
1046
- 'tierId': string | null;
1047
- 'channelId': string | null;
1048
- 'ticketId': string | null;
1331
+ 'audienceId': string | null;
1049
1332
  'userId': string | null;
1050
1333
  'schedule': BaseSchedule;
1334
+ 'sentAt': string | null;
1335
+ 'recipientCount': number | null;
1336
+ 'createdAt': string;
1337
+ }
1338
+ export interface BaseAnnouncementAudience {
1339
+ 'id': string;
1340
+ 'name': string;
1341
+ 'description': string | null;
1342
+ 'eventId': string | null;
1343
+ 'groupId': string | null;
1344
+ 'channelId': string | null;
1345
+ 'operator': AnnouncementAudienceOperator;
1346
+ 'featured': boolean;
1347
+ 'archived': boolean;
1051
1348
  'createdAt': string;
1349
+ 'updatedAt': string;
1052
1350
  }
1351
+
1352
+
1053
1353
  export interface BaseBenefit {
1054
1354
  'id': string;
1055
1355
  'slug': string;
@@ -3947,6 +4247,46 @@ export enum CreateAnnouncement200ResponseStatusEnum {
3947
4247
  Ok = 'ok'
3948
4248
  }
3949
4249
 
4250
+ export interface CreateAnnouncementAudience200Response {
4251
+ 'status': CreateAnnouncementAudience200ResponseStatusEnum;
4252
+ 'message': string;
4253
+ 'data': AnnouncementAudience;
4254
+ }
4255
+
4256
+ export enum CreateAnnouncementAudience200ResponseStatusEnum {
4257
+ Ok = 'ok'
4258
+ }
4259
+
4260
+ export interface CreateAnnouncementAudienceCondition200Response {
4261
+ 'status': CreateAnnouncementAudienceCondition200ResponseStatusEnum;
4262
+ 'message': string;
4263
+ 'data': AnnouncementAudienceCondition;
4264
+ }
4265
+
4266
+ export enum CreateAnnouncementAudienceCondition200ResponseStatusEnum {
4267
+ Ok = 'ok'
4268
+ }
4269
+
4270
+ export interface CreateAnnouncementAudienceFilter200Response {
4271
+ 'status': CreateAnnouncementAudienceFilter200ResponseStatusEnum;
4272
+ 'message': string;
4273
+ 'data': AnnouncementAudienceFilter;
4274
+ }
4275
+
4276
+ export enum CreateAnnouncementAudienceFilter200ResponseStatusEnum {
4277
+ Ok = 'ok'
4278
+ }
4279
+
4280
+ export interface CreateAnnouncementTemplate200Response {
4281
+ 'status': CreateAnnouncementTemplate200ResponseStatusEnum;
4282
+ 'message': string;
4283
+ 'data': AnnouncementTemplate;
4284
+ }
4285
+
4286
+ export enum CreateAnnouncementTemplate200ResponseStatusEnum {
4287
+ Ok = 'ok'
4288
+ }
4289
+
3950
4290
  export interface CreateBenefit200Response {
3951
4291
  'status': CreateBenefit200ResponseStatusEnum;
3952
4292
  'message': string;
@@ -5336,19 +5676,6 @@ export enum EventAgendaVisibility {
5336
5676
  }
5337
5677
 
5338
5678
 
5339
- export interface EventAnnouncementFilters {
5340
- 'type': EventAnnouncementFiltersTypeEnum;
5341
- 'ticketId'?: string;
5342
- 'questionId'?: string;
5343
- 'choiceId'?: string;
5344
- 'eventRoomTypeId'?: string;
5345
- 'addOnId'?: string;
5346
- }
5347
-
5348
- export enum EventAnnouncementFiltersTypeEnum {
5349
- Event = 'event'
5350
- }
5351
-
5352
5679
  export interface EventAttribute {
5353
5680
  'id': string;
5354
5681
  'name': string;
@@ -7528,19 +7855,72 @@ export enum GetAllAccountMerges200ResponseStatusEnum {
7528
7855
  Ok = 'ok'
7529
7856
  }
7530
7857
 
7531
- export interface GetAnnouncementAudience200Response {
7532
- 'status': GetAnnouncementAudience200ResponseStatusEnum;
7858
+ export interface GetAnnouncementAudienceAccounts200Response {
7859
+ 'status': GetAnnouncementAudienceAccounts200ResponseStatusEnum;
7533
7860
  'message': string;
7534
7861
  'data': Array<BaseAccount>;
7535
7862
  'count'?: number;
7536
7863
  }
7537
7864
 
7538
- export enum GetAnnouncementAudience200ResponseStatusEnum {
7865
+ export enum GetAnnouncementAudienceAccounts200ResponseStatusEnum {
7539
7866
  Ok = 'ok'
7540
7867
  }
7541
7868
 
7542
- export interface GetAnnouncementTranslation200Response {
7543
- 'status': GetAnnouncementTranslation200ResponseStatusEnum;
7869
+ export interface GetAnnouncementAudiences200Response {
7870
+ 'status': GetAnnouncementAudiences200ResponseStatusEnum;
7871
+ 'message': string;
7872
+ 'data': Array<AnnouncementAudience>;
7873
+ 'count'?: number;
7874
+ }
7875
+
7876
+ export enum GetAnnouncementAudiences200ResponseStatusEnum {
7877
+ Ok = 'ok'
7878
+ }
7879
+
7880
+ export interface GetAnnouncementMergeFields200Response {
7881
+ 'status': GetAnnouncementMergeFields200ResponseStatusEnum;
7882
+ 'message': string;
7883
+ 'data': Array<AnnouncementMergeField>;
7884
+ }
7885
+
7886
+ export enum GetAnnouncementMergeFields200ResponseStatusEnum {
7887
+ Ok = 'ok'
7888
+ }
7889
+
7890
+ export interface GetAnnouncementTemplateTranslation200Response {
7891
+ 'status': GetAnnouncementTemplateTranslation200ResponseStatusEnum;
7892
+ 'message': string;
7893
+ 'data': AnnouncementTemplateTranslation | null;
7894
+ }
7895
+
7896
+ export enum GetAnnouncementTemplateTranslation200ResponseStatusEnum {
7897
+ Ok = 'ok'
7898
+ }
7899
+
7900
+ export interface GetAnnouncementTemplateTranslations200Response {
7901
+ 'status': GetAnnouncementTemplateTranslations200ResponseStatusEnum;
7902
+ 'message': string;
7903
+ 'data': Array<AnnouncementTemplateTranslation>;
7904
+ 'count'?: number;
7905
+ }
7906
+
7907
+ export enum GetAnnouncementTemplateTranslations200ResponseStatusEnum {
7908
+ Ok = 'ok'
7909
+ }
7910
+
7911
+ export interface GetAnnouncementTemplates200Response {
7912
+ 'status': GetAnnouncementTemplates200ResponseStatusEnum;
7913
+ 'message': string;
7914
+ 'data': Array<AnnouncementTemplate>;
7915
+ 'count'?: number;
7916
+ }
7917
+
7918
+ export enum GetAnnouncementTemplates200ResponseStatusEnum {
7919
+ Ok = 'ok'
7920
+ }
7921
+
7922
+ export interface GetAnnouncementTranslation200Response {
7923
+ 'status': GetAnnouncementTranslation200ResponseStatusEnum;
7544
7924
  'message': string;
7545
7925
  'data': AnnouncementTranslation | null;
7546
7926
  }
@@ -13797,6 +14177,9 @@ export interface Self {
13797
14177
  'createdAt': string;
13798
14178
  'updatedAt': string;
13799
14179
  }
14180
+ export interface SendAnnouncementPreviewRequest {
14181
+ 'accountId'?: string;
14182
+ }
13800
14183
  export interface Series {
13801
14184
  'id': string;
13802
14185
  'slug': string;
@@ -15297,6 +15680,16 @@ export interface TriggerUpdateInputs {
15297
15680
  'code'?: string | null;
15298
15681
  'enabled'?: boolean;
15299
15682
  }
15683
+ export interface UpdateAnnouncementTemplateTranslation200Response {
15684
+ 'status': UpdateAnnouncementTemplateTranslation200ResponseStatusEnum;
15685
+ 'message': string;
15686
+ 'data': AnnouncementTemplateTranslation;
15687
+ }
15688
+
15689
+ export enum UpdateAnnouncementTemplateTranslation200ResponseStatusEnum {
15690
+ Ok = 'ok'
15691
+ }
15692
+
15300
15693
  export interface UpdateBookingResponsesInputs {
15301
15694
  'questions': Array<Question>;
15302
15695
  }
@@ -23866,7 +24259,7 @@ export class AdvertisementsApi extends BaseAPI {
23866
24259
  export const AnnouncementsApiAxiosParamCreator = function (configuration?: Configuration) {
23867
24260
  return {
23868
24261
  /**
23869
- * 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.
24262
+ * 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.
23870
24263
  * @summary Create an announcement
23871
24264
  * @param {AnnouncementCreateInputs} announcementCreateInputs
23872
24265
  * @param {*} [options] Override http request option.
@@ -23987,9 +24380,10 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
23987
24380
  };
23988
24381
  },
23989
24382
  /**
23990
- * 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.
23991
- * @summary List an announcement\'s target audience
24383
+ * 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.
24384
+ * @summary List an announcement\'s email delivery receipts
23992
24385
  * @param {string} announcementId The announcement identifier
24386
+ * @param {EmailReceiptStatus} [status] Filter by status
23993
24387
  * @param {number} [page] Page number
23994
24388
  * @param {number} [pageSize] Number of items per page
23995
24389
  * @param {string} [orderBy] Field to order by
@@ -23997,10 +24391,10 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
23997
24391
  * @param {*} [options] Override http request option.
23998
24392
  * @throws {RequiredError}
23999
24393
  */
24000
- getAnnouncementAudience: async (announcementId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24394
+ getAnnouncementEmailReceipts: async (announcementId: string, status?: EmailReceiptStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24001
24395
  // verify required parameter 'announcementId' is not null or undefined
24002
- assertParamExists('getAnnouncementAudience', 'announcementId', announcementId)
24003
- const localVarPath = `/announcements/{announcementId}/audience`
24396
+ assertParamExists('getAnnouncementEmailReceipts', 'announcementId', announcementId)
24397
+ const localVarPath = `/announcements/{announcementId}/email-receipts`
24004
24398
  .replace('{announcementId}', encodeURIComponent(String(announcementId)));
24005
24399
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
24006
24400
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -24019,6 +24413,10 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
24019
24413
  // authentication OrganizationId required
24020
24414
  await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
24021
24415
 
24416
+ if (status !== undefined) {
24417
+ localVarQueryParameter['status'] = status;
24418
+ }
24419
+
24022
24420
  if (page !== undefined) {
24023
24421
  localVarQueryParameter['page'] = page;
24024
24422
  }
@@ -24047,10 +24445,45 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
24047
24445
  };
24048
24446
  },
24049
24447
  /**
24050
- * 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.
24051
- * @summary List an announcement\'s email delivery receipts
24448
+ * 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.
24449
+ * @summary List announcement merge fields
24450
+ * @param {*} [options] Override http request option.
24451
+ * @throws {RequiredError}
24452
+ */
24453
+ getAnnouncementMergeFields: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24454
+ const localVarPath = `/announcements/merge-fields`;
24455
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
24456
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24457
+ let baseOptions;
24458
+ if (configuration) {
24459
+ baseOptions = configuration.baseOptions;
24460
+ }
24461
+
24462
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
24463
+ const localVarHeaderParameter = {} as any;
24464
+ const localVarQueryParameter = {} as any;
24465
+
24466
+ // authentication ApiKeyAuth required
24467
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
24468
+
24469
+ // authentication OrganizationId required
24470
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
24471
+
24472
+ localVarHeaderParameter['Accept'] = 'application/json';
24473
+
24474
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
24475
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24476
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
24477
+
24478
+ return {
24479
+ url: toPathString(localVarUrlObj),
24480
+ options: localVarRequestOptions,
24481
+ };
24482
+ },
24483
+ /**
24484
+ * 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.
24485
+ * @summary List an announcement\'s recipients
24052
24486
  * @param {string} announcementId The announcement identifier
24053
- * @param {EmailReceiptStatus} [status] Filter by status
24054
24487
  * @param {number} [page] Page number
24055
24488
  * @param {number} [pageSize] Number of items per page
24056
24489
  * @param {string} [orderBy] Field to order by
@@ -24058,10 +24491,10 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
24058
24491
  * @param {*} [options] Override http request option.
24059
24492
  * @throws {RequiredError}
24060
24493
  */
24061
- getAnnouncementEmailReceipts: async (announcementId: string, status?: EmailReceiptStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24494
+ getAnnouncementRecipients: async (announcementId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24062
24495
  // verify required parameter 'announcementId' is not null or undefined
24063
- assertParamExists('getAnnouncementEmailReceipts', 'announcementId', announcementId)
24064
- const localVarPath = `/announcements/{announcementId}/email-receipts`
24496
+ assertParamExists('getAnnouncementRecipients', 'announcementId', announcementId)
24497
+ const localVarPath = `/announcements/{announcementId}/audience`
24065
24498
  .replace('{announcementId}', encodeURIComponent(String(announcementId)));
24066
24499
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
24067
24500
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -24080,10 +24513,6 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
24080
24513
  // authentication OrganizationId required
24081
24514
  await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
24082
24515
 
24083
- if (status !== undefined) {
24084
- localVarQueryParameter['status'] = status;
24085
- }
24086
-
24087
24516
  if (page !== undefined) {
24088
24517
  localVarQueryParameter['page'] = page;
24089
24518
  }
@@ -24112,7 +24541,7 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
24112
24541
  };
24113
24542
  },
24114
24543
  /**
24115
- * 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.
24544
+ * 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.
24116
24545
  * @summary List announcements
24117
24546
  * @param {AnnouncementFilters} [filters] Filter by filters
24118
24547
  * @param {number} [page] Page number
@@ -24175,13 +24604,14 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
24175
24604
  };
24176
24605
  },
24177
24606
  /**
24178
- * 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.
24607
+ * 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.
24179
24608
  * @summary Send a preview of an announcement
24180
24609
  * @param {string} announcementId The announcement identifier
24610
+ * @param {SendAnnouncementPreviewRequest} [sendAnnouncementPreviewRequest]
24181
24611
  * @param {*} [options] Override http request option.
24182
24612
  * @throws {RequiredError}
24183
24613
  */
24184
- sendAnnouncementPreview: async (announcementId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24614
+ sendAnnouncementPreview: async (announcementId: string, sendAnnouncementPreviewRequest?: SendAnnouncementPreviewRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24185
24615
  // verify required parameter 'announcementId' is not null or undefined
24186
24616
  assertParamExists('sendAnnouncementPreview', 'announcementId', announcementId)
24187
24617
  const localVarPath = `/announcements/{announcementId}/preview`
@@ -24203,11 +24633,13 @@ export const AnnouncementsApiAxiosParamCreator = function (configuration?: Confi
24203
24633
  // authentication OrganizationId required
24204
24634
  await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
24205
24635
 
24636
+ localVarHeaderParameter['Content-Type'] = 'application/json';
24206
24637
  localVarHeaderParameter['Accept'] = 'application/json';
24207
24638
 
24208
24639
  setSearchParams(localVarUrlObj, localVarQueryParameter);
24209
24640
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24210
24641
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
24642
+ localVarRequestOptions.data = serializeDataIfNeeded(sendAnnouncementPreviewRequest, localVarRequestOptions, configuration)
24211
24643
 
24212
24644
  return {
24213
24645
  url: toPathString(localVarUrlObj),
@@ -24269,7 +24701,7 @@ export const AnnouncementsApiFp = function(configuration?: Configuration) {
24269
24701
  const localVarAxiosParamCreator = AnnouncementsApiAxiosParamCreator(configuration)
24270
24702
  return {
24271
24703
  /**
24272
- * 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.
24704
+ * 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.
24273
24705
  * @summary Create an announcement
24274
24706
  * @param {AnnouncementCreateInputs} announcementCreateInputs
24275
24707
  * @param {*} [options] Override http request option.
@@ -24308,9 +24740,10 @@ export const AnnouncementsApiFp = function(configuration?: Configuration) {
24308
24740
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24309
24741
  },
24310
24742
  /**
24311
- * 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.
24312
- * @summary List an announcement\'s target audience
24743
+ * 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.
24744
+ * @summary List an announcement\'s email delivery receipts
24313
24745
  * @param {string} announcementId The announcement identifier
24746
+ * @param {EmailReceiptStatus} [status] Filter by status
24314
24747
  * @param {number} [page] Page number
24315
24748
  * @param {number} [pageSize] Number of items per page
24316
24749
  * @param {string} [orderBy] Field to order by
@@ -24318,17 +24751,28 @@ export const AnnouncementsApiFp = function(configuration?: Configuration) {
24318
24751
  * @param {*} [options] Override http request option.
24319
24752
  * @throws {RequiredError}
24320
24753
  */
24321
- async getAnnouncementAudience(announcementId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudience200Response>> {
24322
- const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementAudience(announcementId, page, pageSize, orderBy, search, options);
24754
+ async getAnnouncementEmailReceipts(announcementId: string, status?: EmailReceiptStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAcccountEmailReceipts200Response>> {
24755
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementEmailReceipts(announcementId, status, page, pageSize, orderBy, search, options);
24323
24756
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24324
- const localVarOperationServerBasePath = operationServerMap['AnnouncementsApi.getAnnouncementAudience']?.[localVarOperationServerIndex]?.url;
24757
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsApi.getAnnouncementEmailReceipts']?.[localVarOperationServerIndex]?.url;
24325
24758
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24326
24759
  },
24327
24760
  /**
24328
- * 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.
24329
- * @summary List an announcement\'s email delivery receipts
24761
+ * 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.
24762
+ * @summary List announcement merge fields
24763
+ * @param {*} [options] Override http request option.
24764
+ * @throws {RequiredError}
24765
+ */
24766
+ async getAnnouncementMergeFields(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementMergeFields200Response>> {
24767
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementMergeFields(options);
24768
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24769
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsApi.getAnnouncementMergeFields']?.[localVarOperationServerIndex]?.url;
24770
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24771
+ },
24772
+ /**
24773
+ * 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.
24774
+ * @summary List an announcement\'s recipients
24330
24775
  * @param {string} announcementId The announcement identifier
24331
- * @param {EmailReceiptStatus} [status] Filter by status
24332
24776
  * @param {number} [page] Page number
24333
24777
  * @param {number} [pageSize] Number of items per page
24334
24778
  * @param {string} [orderBy] Field to order by
@@ -24336,14 +24780,14 @@ export const AnnouncementsApiFp = function(configuration?: Configuration) {
24336
24780
  * @param {*} [options] Override http request option.
24337
24781
  * @throws {RequiredError}
24338
24782
  */
24339
- async getAnnouncementEmailReceipts(announcementId: string, status?: EmailReceiptStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAcccountEmailReceipts200Response>> {
24340
- const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementEmailReceipts(announcementId, status, page, pageSize, orderBy, search, options);
24783
+ async getAnnouncementRecipients(announcementId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudienceAccounts200Response>> {
24784
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementRecipients(announcementId, page, pageSize, orderBy, search, options);
24341
24785
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24342
- const localVarOperationServerBasePath = operationServerMap['AnnouncementsApi.getAnnouncementEmailReceipts']?.[localVarOperationServerIndex]?.url;
24786
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsApi.getAnnouncementRecipients']?.[localVarOperationServerIndex]?.url;
24343
24787
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24344
24788
  },
24345
24789
  /**
24346
- * 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.
24790
+ * 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.
24347
24791
  * @summary List announcements
24348
24792
  * @param {AnnouncementFilters} [filters] Filter by filters
24349
24793
  * @param {number} [page] Page number
@@ -24360,14 +24804,15 @@ export const AnnouncementsApiFp = function(configuration?: Configuration) {
24360
24804
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24361
24805
  },
24362
24806
  /**
24363
- * 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.
24807
+ * 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.
24364
24808
  * @summary Send a preview of an announcement
24365
24809
  * @param {string} announcementId The announcement identifier
24810
+ * @param {SendAnnouncementPreviewRequest} [sendAnnouncementPreviewRequest]
24366
24811
  * @param {*} [options] Override http request option.
24367
24812
  * @throws {RequiredError}
24368
24813
  */
24369
- async sendAnnouncementPreview(announcementId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
24370
- const localVarAxiosArgs = await localVarAxiosParamCreator.sendAnnouncementPreview(announcementId, options);
24814
+ async sendAnnouncementPreview(announcementId: string, sendAnnouncementPreviewRequest?: SendAnnouncementPreviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
24815
+ const localVarAxiosArgs = await localVarAxiosParamCreator.sendAnnouncementPreview(announcementId, sendAnnouncementPreviewRequest, options);
24371
24816
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24372
24817
  const localVarOperationServerBasePath = operationServerMap['AnnouncementsApi.sendAnnouncementPreview']?.[localVarOperationServerIndex]?.url;
24373
24818
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -24396,7 +24841,7 @@ export const AnnouncementsApiFactory = function (configuration?: Configuration,
24396
24841
  const localVarFp = AnnouncementsApiFp(configuration)
24397
24842
  return {
24398
24843
  /**
24399
- * 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.
24844
+ * 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.
24400
24845
  * @summary Create an announcement
24401
24846
  * @param {AnnouncementsApiCreateAnnouncementRequest} requestParameters Request parameters.
24402
24847
  * @param {*} [options] Override http request option.
@@ -24425,16 +24870,6 @@ export const AnnouncementsApiFactory = function (configuration?: Configuration,
24425
24870
  getAnnouncement(requestParameters: AnnouncementsApiGetAnnouncementRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncement200Response> {
24426
24871
  return localVarFp.getAnnouncement(requestParameters.announcementId, options).then((request) => request(axios, basePath));
24427
24872
  },
24428
- /**
24429
- * 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.
24430
- * @summary List an announcement\'s target audience
24431
- * @param {AnnouncementsApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
24432
- * @param {*} [options] Override http request option.
24433
- * @throws {RequiredError}
24434
- */
24435
- getAnnouncementAudience(requestParameters: AnnouncementsApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudience200Response> {
24436
- return localVarFp.getAnnouncementAudience(requestParameters.announcementId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
24437
- },
24438
24873
  /**
24439
24874
  * 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.
24440
24875
  * @summary List an announcement\'s email delivery receipts
@@ -24446,7 +24881,26 @@ export const AnnouncementsApiFactory = function (configuration?: Configuration,
24446
24881
  return localVarFp.getAnnouncementEmailReceipts(requestParameters.announcementId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
24447
24882
  },
24448
24883
  /**
24449
- * 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.
24884
+ * 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.
24885
+ * @summary List announcement merge fields
24886
+ * @param {*} [options] Override http request option.
24887
+ * @throws {RequiredError}
24888
+ */
24889
+ getAnnouncementMergeFields(options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementMergeFields200Response> {
24890
+ return localVarFp.getAnnouncementMergeFields(options).then((request) => request(axios, basePath));
24891
+ },
24892
+ /**
24893
+ * 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.
24894
+ * @summary List an announcement\'s recipients
24895
+ * @param {AnnouncementsApiGetAnnouncementRecipientsRequest} requestParameters Request parameters.
24896
+ * @param {*} [options] Override http request option.
24897
+ * @throws {RequiredError}
24898
+ */
24899
+ getAnnouncementRecipients(requestParameters: AnnouncementsApiGetAnnouncementRecipientsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudienceAccounts200Response> {
24900
+ return localVarFp.getAnnouncementRecipients(requestParameters.announcementId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
24901
+ },
24902
+ /**
24903
+ * 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.
24450
24904
  * @summary List announcements
24451
24905
  * @param {AnnouncementsApiGetAnnouncementsRequest} requestParameters Request parameters.
24452
24906
  * @param {*} [options] Override http request option.
@@ -24456,14 +24910,14 @@ export const AnnouncementsApiFactory = function (configuration?: Configuration,
24456
24910
  return localVarFp.getAnnouncements(requestParameters.filters, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
24457
24911
  },
24458
24912
  /**
24459
- * 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.
24913
+ * 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.
24460
24914
  * @summary Send a preview of an announcement
24461
24915
  * @param {AnnouncementsApiSendAnnouncementPreviewRequest} requestParameters Request parameters.
24462
24916
  * @param {*} [options] Override http request option.
24463
24917
  * @throws {RequiredError}
24464
24918
  */
24465
24919
  sendAnnouncementPreview(requestParameters: AnnouncementsApiSendAnnouncementPreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
24466
- return localVarFp.sendAnnouncementPreview(requestParameters.announcementId, options).then((request) => request(axios, basePath));
24920
+ return localVarFp.sendAnnouncementPreview(requestParameters.announcementId, requestParameters.sendAnnouncementPreviewRequest, options).then((request) => request(axios, basePath));
24467
24921
  },
24468
24922
  /**
24469
24923
  * Updates the fields (such as title, content, or audience targeting) of an existing announcement identified by ID or slug; requires update permission on announcements.
@@ -24506,14 +24960,19 @@ export interface AnnouncementsApiGetAnnouncementRequest {
24506
24960
  }
24507
24961
 
24508
24962
  /**
24509
- * Request parameters for getAnnouncementAudience operation in AnnouncementsApi.
24963
+ * Request parameters for getAnnouncementEmailReceipts operation in AnnouncementsApi.
24510
24964
  */
24511
- export interface AnnouncementsApiGetAnnouncementAudienceRequest {
24965
+ export interface AnnouncementsApiGetAnnouncementEmailReceiptsRequest {
24512
24966
  /**
24513
24967
  * The announcement identifier
24514
24968
  */
24515
24969
  readonly announcementId: string
24516
24970
 
24971
+ /**
24972
+ * Filter by status
24973
+ */
24974
+ readonly status?: EmailReceiptStatus
24975
+
24517
24976
  /**
24518
24977
  * Page number
24519
24978
  */
@@ -24536,19 +24995,14 @@ export interface AnnouncementsApiGetAnnouncementAudienceRequest {
24536
24995
  }
24537
24996
 
24538
24997
  /**
24539
- * Request parameters for getAnnouncementEmailReceipts operation in AnnouncementsApi.
24998
+ * Request parameters for getAnnouncementRecipients operation in AnnouncementsApi.
24540
24999
  */
24541
- export interface AnnouncementsApiGetAnnouncementEmailReceiptsRequest {
25000
+ export interface AnnouncementsApiGetAnnouncementRecipientsRequest {
24542
25001
  /**
24543
25002
  * The announcement identifier
24544
25003
  */
24545
25004
  readonly announcementId: string
24546
25005
 
24547
- /**
24548
- * Filter by status
24549
- */
24550
- readonly status?: EmailReceiptStatus
24551
-
24552
25006
  /**
24553
25007
  * Page number
24554
25008
  */
@@ -24608,6 +25062,8 @@ export interface AnnouncementsApiSendAnnouncementPreviewRequest {
24608
25062
  * The announcement identifier
24609
25063
  */
24610
25064
  readonly announcementId: string
25065
+
25066
+ readonly sendAnnouncementPreviewRequest?: SendAnnouncementPreviewRequest
24611
25067
  }
24612
25068
 
24613
25069
  /**
@@ -24627,7 +25083,7 @@ export interface AnnouncementsApiUpdateAnnouncementRequest {
24627
25083
  */
24628
25084
  export class AnnouncementsApi extends BaseAPI {
24629
25085
  /**
24630
- * 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.
25086
+ * 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.
24631
25087
  * @summary Create an announcement
24632
25088
  * @param {AnnouncementsApiCreateAnnouncementRequest} requestParameters Request parameters.
24633
25089
  * @param {*} [options] Override http request option.
@@ -24660,29 +25116,39 @@ export class AnnouncementsApi extends BaseAPI {
24660
25116
  }
24661
25117
 
24662
25118
  /**
24663
- * 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.
24664
- * @summary List an announcement\'s target audience
24665
- * @param {AnnouncementsApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
25119
+ * 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.
25120
+ * @summary List an announcement\'s email delivery receipts
25121
+ * @param {AnnouncementsApiGetAnnouncementEmailReceiptsRequest} requestParameters Request parameters.
24666
25122
  * @param {*} [options] Override http request option.
24667
25123
  * @throws {RequiredError}
24668
25124
  */
24669
- public getAnnouncementAudience(requestParameters: AnnouncementsApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig) {
24670
- return AnnouncementsApiFp(this.configuration).getAnnouncementAudience(requestParameters.announcementId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
25125
+ public getAnnouncementEmailReceipts(requestParameters: AnnouncementsApiGetAnnouncementEmailReceiptsRequest, options?: RawAxiosRequestConfig) {
25126
+ return AnnouncementsApiFp(this.configuration).getAnnouncementEmailReceipts(requestParameters.announcementId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
24671
25127
  }
24672
25128
 
24673
25129
  /**
24674
- * 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.
24675
- * @summary List an announcement\'s email delivery receipts
24676
- * @param {AnnouncementsApiGetAnnouncementEmailReceiptsRequest} requestParameters Request parameters.
25130
+ * 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.
25131
+ * @summary List announcement merge fields
24677
25132
  * @param {*} [options] Override http request option.
24678
25133
  * @throws {RequiredError}
24679
25134
  */
24680
- public getAnnouncementEmailReceipts(requestParameters: AnnouncementsApiGetAnnouncementEmailReceiptsRequest, options?: RawAxiosRequestConfig) {
24681
- return AnnouncementsApiFp(this.configuration).getAnnouncementEmailReceipts(requestParameters.announcementId, requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
25135
+ public getAnnouncementMergeFields(options?: RawAxiosRequestConfig) {
25136
+ return AnnouncementsApiFp(this.configuration).getAnnouncementMergeFields(options).then((request) => request(this.axios, this.basePath));
25137
+ }
25138
+
25139
+ /**
25140
+ * 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.
25141
+ * @summary List an announcement\'s recipients
25142
+ * @param {AnnouncementsApiGetAnnouncementRecipientsRequest} requestParameters Request parameters.
25143
+ * @param {*} [options] Override http request option.
25144
+ * @throws {RequiredError}
25145
+ */
25146
+ public getAnnouncementRecipients(requestParameters: AnnouncementsApiGetAnnouncementRecipientsRequest, options?: RawAxiosRequestConfig) {
25147
+ return AnnouncementsApiFp(this.configuration).getAnnouncementRecipients(requestParameters.announcementId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
24682
25148
  }
24683
25149
 
24684
25150
  /**
24685
- * 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.
25151
+ * 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.
24686
25152
  * @summary List announcements
24687
25153
  * @param {AnnouncementsApiGetAnnouncementsRequest} requestParameters Request parameters.
24688
25154
  * @param {*} [options] Override http request option.
@@ -24693,14 +25159,14 @@ export class AnnouncementsApi extends BaseAPI {
24693
25159
  }
24694
25160
 
24695
25161
  /**
24696
- * 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.
25162
+ * 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.
24697
25163
  * @summary Send a preview of an announcement
24698
25164
  * @param {AnnouncementsApiSendAnnouncementPreviewRequest} requestParameters Request parameters.
24699
25165
  * @param {*} [options] Override http request option.
24700
25166
  * @throws {RequiredError}
24701
25167
  */
24702
25168
  public sendAnnouncementPreview(requestParameters: AnnouncementsApiSendAnnouncementPreviewRequest, options?: RawAxiosRequestConfig) {
24703
- return AnnouncementsApiFp(this.configuration).sendAnnouncementPreview(requestParameters.announcementId, options).then((request) => request(this.axios, this.basePath));
25169
+ return AnnouncementsApiFp(this.configuration).sendAnnouncementPreview(requestParameters.announcementId, requestParameters.sendAnnouncementPreviewRequest, options).then((request) => request(this.axios, this.basePath));
24704
25170
  }
24705
25171
 
24706
25172
  /**
@@ -24718,22 +25184,21 @@ export class AnnouncementsApi extends BaseAPI {
24718
25184
 
24719
25185
 
24720
25186
  /**
24721
- * AnnouncementsScheduleApi - axios parameter creator
25187
+ * AnnouncementsAudiencesApi - axios parameter creator
24722
25188
  */
24723
- export const AnnouncementsScheduleApiAxiosParamCreator = function (configuration?: Configuration) {
25189
+ export const AnnouncementsAudiencesApiAxiosParamCreator = function (configuration?: Configuration) {
24724
25190
  return {
24725
25191
  /**
24726
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
24727
- * @summary Cancel an announcement\'s scheduled send
24728
- * @param {string} announcementId The announcement identifier
25192
+ * 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.
25193
+ * @summary Create an announcement audience
25194
+ * @param {AnnouncementAudienceCreateInputs} announcementAudienceCreateInputs
24729
25195
  * @param {*} [options] Override http request option.
24730
25196
  * @throws {RequiredError}
24731
25197
  */
24732
- cancelAnnouncementSchedule: async (announcementId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24733
- // verify required parameter 'announcementId' is not null or undefined
24734
- assertParamExists('cancelAnnouncementSchedule', 'announcementId', announcementId)
24735
- const localVarPath = `/announcements/{announcementId}/schedule`
24736
- .replace('{announcementId}', encodeURIComponent(String(announcementId)));
25198
+ createAnnouncementAudience: async (announcementAudienceCreateInputs: AnnouncementAudienceCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25199
+ // verify required parameter 'announcementAudienceCreateInputs' is not null or undefined
25200
+ assertParamExists('createAnnouncementAudience', 'announcementAudienceCreateInputs', announcementAudienceCreateInputs)
25201
+ const localVarPath = `/announcements/audiences`;
24737
25202
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
24738
25203
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24739
25204
  let baseOptions;
@@ -24741,7 +25206,7 @@ export const AnnouncementsScheduleApiAxiosParamCreator = function (configuration
24741
25206
  baseOptions = configuration.baseOptions;
24742
25207
  }
24743
25208
 
24744
- const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
25209
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
24745
25210
  const localVarHeaderParameter = {} as any;
24746
25211
  const localVarQueryParameter = {} as any;
24747
25212
 
@@ -24751,11 +25216,13 @@ export const AnnouncementsScheduleApiAxiosParamCreator = function (configuration
24751
25216
  // authentication OrganizationId required
24752
25217
  await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
24753
25218
 
25219
+ localVarHeaderParameter['Content-Type'] = 'application/json';
24754
25220
  localVarHeaderParameter['Accept'] = 'application/json';
24755
25221
 
24756
25222
  setSearchParams(localVarUrlObj, localVarQueryParameter);
24757
25223
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24758
25224
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25225
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceCreateInputs, localVarRequestOptions, configuration)
24759
25226
 
24760
25227
  return {
24761
25228
  url: toPathString(localVarUrlObj),
@@ -24763,20 +25230,24 @@ export const AnnouncementsScheduleApiAxiosParamCreator = function (configuration
24763
25230
  };
24764
25231
  },
24765
25232
  /**
24766
- * 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.
24767
- * @summary Schedule or reschedule an announcement send
24768
- * @param {string} announcementId The announcement identifier
24769
- * @param {object} body
25233
+ * 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.
25234
+ * @summary Create an audience condition
25235
+ * @param {string} audienceId The audience identifier
25236
+ * @param {string} filterId The filter identifier
25237
+ * @param {AnnouncementAudienceConditionCreateInputs} announcementAudienceConditionCreateInputs
24770
25238
  * @param {*} [options] Override http request option.
24771
25239
  * @throws {RequiredError}
24772
25240
  */
24773
- updateAnnouncementSchedule: async (announcementId: string, body: object, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
24774
- // verify required parameter 'announcementId' is not null or undefined
24775
- assertParamExists('updateAnnouncementSchedule', 'announcementId', announcementId)
24776
- // verify required parameter 'body' is not null or undefined
24777
- assertParamExists('updateAnnouncementSchedule', 'body', body)
24778
- const localVarPath = `/announcements/{announcementId}/schedule`
24779
- .replace('{announcementId}', encodeURIComponent(String(announcementId)));
25241
+ createAnnouncementAudienceCondition: async (audienceId: string, filterId: string, announcementAudienceConditionCreateInputs: AnnouncementAudienceConditionCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25242
+ // verify required parameter 'audienceId' is not null or undefined
25243
+ assertParamExists('createAnnouncementAudienceCondition', 'audienceId', audienceId)
25244
+ // verify required parameter 'filterId' is not null or undefined
25245
+ assertParamExists('createAnnouncementAudienceCondition', 'filterId', filterId)
25246
+ // verify required parameter 'announcementAudienceConditionCreateInputs' is not null or undefined
25247
+ assertParamExists('createAnnouncementAudienceCondition', 'announcementAudienceConditionCreateInputs', announcementAudienceConditionCreateInputs)
25248
+ const localVarPath = `/announcements/audiences/{audienceId}/filters/{filterId}/conditions`
25249
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)))
25250
+ .replace('{filterId}', encodeURIComponent(String(filterId)));
24780
25251
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
24781
25252
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
24782
25253
  let baseOptions;
@@ -24784,7 +25255,7 @@ export const AnnouncementsScheduleApiAxiosParamCreator = function (configuration
24784
25255
  baseOptions = configuration.baseOptions;
24785
25256
  }
24786
25257
 
24787
- const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
25258
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
24788
25259
  const localVarHeaderParameter = {} as any;
24789
25260
  const localVarQueryParameter = {} as any;
24790
25261
 
@@ -24800,127 +25271,2306 @@ export const AnnouncementsScheduleApiAxiosParamCreator = function (configuration
24800
25271
  setSearchParams(localVarUrlObj, localVarQueryParameter);
24801
25272
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
24802
25273
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
24803
- localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
25274
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceConditionCreateInputs, localVarRequestOptions, configuration)
24804
25275
 
24805
25276
  return {
24806
25277
  url: toPathString(localVarUrlObj),
24807
25278
  options: localVarRequestOptions,
24808
25279
  };
24809
25280
  },
24810
- }
24811
- };
24812
-
24813
- /**
24814
- * AnnouncementsScheduleApi - functional programming interface
24815
- */
24816
- export const AnnouncementsScheduleApiFp = function(configuration?: Configuration) {
24817
- const localVarAxiosParamCreator = AnnouncementsScheduleApiAxiosParamCreator(configuration)
24818
- return {
24819
25281
  /**
24820
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
24821
- * @summary Cancel an announcement\'s scheduled send
24822
- * @param {string} announcementId The announcement identifier
25282
+ * 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.
25283
+ * @summary Create an audience filter group
25284
+ * @param {string} audienceId The audience identifier
25285
+ * @param {AnnouncementAudienceFilterCreateInputs} announcementAudienceFilterCreateInputs
24823
25286
  * @param {*} [options] Override http request option.
24824
25287
  * @throws {RequiredError}
24825
25288
  */
24826
- async cancelAnnouncementSchedule(announcementId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncement200Response>> {
24827
- const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAnnouncementSchedule(announcementId, options);
24828
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24829
- const localVarOperationServerBasePath = operationServerMap['AnnouncementsScheduleApi.cancelAnnouncementSchedule']?.[localVarOperationServerIndex]?.url;
24830
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25289
+ createAnnouncementAudienceFilter: async (audienceId: string, announcementAudienceFilterCreateInputs: AnnouncementAudienceFilterCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25290
+ // verify required parameter 'audienceId' is not null or undefined
25291
+ assertParamExists('createAnnouncementAudienceFilter', 'audienceId', audienceId)
25292
+ // verify required parameter 'announcementAudienceFilterCreateInputs' is not null or undefined
25293
+ assertParamExists('createAnnouncementAudienceFilter', 'announcementAudienceFilterCreateInputs', announcementAudienceFilterCreateInputs)
25294
+ const localVarPath = `/announcements/audiences/{audienceId}/filters`
25295
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)));
25296
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
25297
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
25298
+ let baseOptions;
25299
+ if (configuration) {
25300
+ baseOptions = configuration.baseOptions;
25301
+ }
25302
+
25303
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
25304
+ const localVarHeaderParameter = {} as any;
25305
+ const localVarQueryParameter = {} as any;
25306
+
25307
+ // authentication ApiKeyAuth required
25308
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
25309
+
25310
+ // authentication OrganizationId required
25311
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
25312
+
25313
+ localVarHeaderParameter['Content-Type'] = 'application/json';
25314
+ localVarHeaderParameter['Accept'] = 'application/json';
25315
+
25316
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
25317
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25318
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25319
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceFilterCreateInputs, localVarRequestOptions, configuration)
25320
+
25321
+ return {
25322
+ url: toPathString(localVarUrlObj),
25323
+ options: localVarRequestOptions,
25324
+ };
24831
25325
  },
24832
25326
  /**
24833
- * 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.
24834
- * @summary Schedule or reschedule an announcement send
24835
- * @param {string} announcementId The announcement identifier
24836
- * @param {object} body
25327
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
25328
+ * @summary Delete an announcement audience
25329
+ * @param {string} audienceId The audience identifier
24837
25330
  * @param {*} [options] Override http request option.
24838
25331
  * @throws {RequiredError}
24839
25332
  */
24840
- async updateAnnouncementSchedule(announcementId: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncement200Response>> {
24841
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateAnnouncementSchedule(announcementId, body, options);
24842
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
24843
- const localVarOperationServerBasePath = operationServerMap['AnnouncementsScheduleApi.updateAnnouncementSchedule']?.[localVarOperationServerIndex]?.url;
24844
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24845
- },
24846
- }
24847
- };
25333
+ deleteAnnouncementAudience: async (audienceId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25334
+ // verify required parameter 'audienceId' is not null or undefined
25335
+ assertParamExists('deleteAnnouncementAudience', 'audienceId', audienceId)
25336
+ const localVarPath = `/announcements/audiences/{audienceId}`
25337
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)));
25338
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
25339
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
25340
+ let baseOptions;
25341
+ if (configuration) {
25342
+ baseOptions = configuration.baseOptions;
25343
+ }
24848
25344
 
24849
- /**
24850
- * AnnouncementsScheduleApi - factory interface
24851
- */
25345
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
25346
+ const localVarHeaderParameter = {} as any;
25347
+ const localVarQueryParameter = {} as any;
25348
+
25349
+ // authentication ApiKeyAuth required
25350
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
25351
+
25352
+ // authentication OrganizationId required
25353
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
25354
+
25355
+ localVarHeaderParameter['Accept'] = 'application/json';
25356
+
25357
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
25358
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25359
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25360
+
25361
+ return {
25362
+ url: toPathString(localVarUrlObj),
25363
+ options: localVarRequestOptions,
25364
+ };
25365
+ },
25366
+ /**
25367
+ * Removes a condition from its filter group; requires update permission on announcements.
25368
+ * @summary Delete an audience condition
25369
+ * @param {string} audienceId The audience identifier
25370
+ * @param {string} filterId The filter identifier
25371
+ * @param {string} conditionId The condition identifier
25372
+ * @param {*} [options] Override http request option.
25373
+ * @throws {RequiredError}
25374
+ */
25375
+ deleteAnnouncementAudienceCondition: async (audienceId: string, filterId: string, conditionId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25376
+ // verify required parameter 'audienceId' is not null or undefined
25377
+ assertParamExists('deleteAnnouncementAudienceCondition', 'audienceId', audienceId)
25378
+ // verify required parameter 'filterId' is not null or undefined
25379
+ assertParamExists('deleteAnnouncementAudienceCondition', 'filterId', filterId)
25380
+ // verify required parameter 'conditionId' is not null or undefined
25381
+ assertParamExists('deleteAnnouncementAudienceCondition', 'conditionId', conditionId)
25382
+ const localVarPath = `/announcements/audiences/{audienceId}/filters/{filterId}/conditions/{conditionId}`
25383
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)))
25384
+ .replace('{filterId}', encodeURIComponent(String(filterId)))
25385
+ .replace('{conditionId}', encodeURIComponent(String(conditionId)));
25386
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
25387
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
25388
+ let baseOptions;
25389
+ if (configuration) {
25390
+ baseOptions = configuration.baseOptions;
25391
+ }
25392
+
25393
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
25394
+ const localVarHeaderParameter = {} as any;
25395
+ const localVarQueryParameter = {} as any;
25396
+
25397
+ // authentication ApiKeyAuth required
25398
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
25399
+
25400
+ // authentication OrganizationId required
25401
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
25402
+
25403
+ localVarHeaderParameter['Accept'] = 'application/json';
25404
+
25405
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
25406
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25407
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25408
+
25409
+ return {
25410
+ url: toPathString(localVarUrlObj),
25411
+ options: localVarRequestOptions,
25412
+ };
25413
+ },
25414
+ /**
25415
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
25416
+ * @summary Delete an audience filter group
25417
+ * @param {string} audienceId The audience identifier
25418
+ * @param {string} filterId The filter identifier
25419
+ * @param {*} [options] Override http request option.
25420
+ * @throws {RequiredError}
25421
+ */
25422
+ deleteAnnouncementAudienceFilter: async (audienceId: string, filterId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25423
+ // verify required parameter 'audienceId' is not null or undefined
25424
+ assertParamExists('deleteAnnouncementAudienceFilter', 'audienceId', audienceId)
25425
+ // verify required parameter 'filterId' is not null or undefined
25426
+ assertParamExists('deleteAnnouncementAudienceFilter', 'filterId', filterId)
25427
+ const localVarPath = `/announcements/audiences/{audienceId}/filters/{filterId}`
25428
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)))
25429
+ .replace('{filterId}', encodeURIComponent(String(filterId)));
25430
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
25431
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
25432
+ let baseOptions;
25433
+ if (configuration) {
25434
+ baseOptions = configuration.baseOptions;
25435
+ }
25436
+
25437
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
25438
+ const localVarHeaderParameter = {} as any;
25439
+ const localVarQueryParameter = {} as any;
25440
+
25441
+ // authentication ApiKeyAuth required
25442
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
25443
+
25444
+ // authentication OrganizationId required
25445
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
25446
+
25447
+ localVarHeaderParameter['Accept'] = 'application/json';
25448
+
25449
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
25450
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25451
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25452
+
25453
+ return {
25454
+ url: toPathString(localVarUrlObj),
25455
+ options: localVarRequestOptions,
25456
+ };
25457
+ },
25458
+ /**
25459
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
25460
+ * @summary Get an announcement audience
25461
+ * @param {string} audienceId The audience identifier
25462
+ * @param {*} [options] Override http request option.
25463
+ * @throws {RequiredError}
25464
+ */
25465
+ getAnnouncementAudience: async (audienceId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25466
+ // verify required parameter 'audienceId' is not null or undefined
25467
+ assertParamExists('getAnnouncementAudience', 'audienceId', audienceId)
25468
+ const localVarPath = `/announcements/audiences/{audienceId}`
25469
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)));
25470
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
25471
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
25472
+ let baseOptions;
25473
+ if (configuration) {
25474
+ baseOptions = configuration.baseOptions;
25475
+ }
25476
+
25477
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
25478
+ const localVarHeaderParameter = {} as any;
25479
+ const localVarQueryParameter = {} as any;
25480
+
25481
+ // authentication ApiKeyAuth required
25482
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
25483
+
25484
+ // authentication OrganizationId required
25485
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
25486
+
25487
+ localVarHeaderParameter['Accept'] = 'application/json';
25488
+
25489
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
25490
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25491
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25492
+
25493
+ return {
25494
+ url: toPathString(localVarUrlObj),
25495
+ options: localVarRequestOptions,
25496
+ };
25497
+ },
25498
+ /**
25499
+ * 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.
25500
+ * @summary List the accounts in an announcement audience
25501
+ * @param {string} audienceId The audience identifier
25502
+ * @param {number} [page] Page number
25503
+ * @param {number} [pageSize] Number of items per page
25504
+ * @param {string} [orderBy] Field to order by
25505
+ * @param {string} [search] Search query
25506
+ * @param {*} [options] Override http request option.
25507
+ * @throws {RequiredError}
25508
+ */
25509
+ getAnnouncementAudienceAccounts: async (audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25510
+ // verify required parameter 'audienceId' is not null or undefined
25511
+ assertParamExists('getAnnouncementAudienceAccounts', 'audienceId', audienceId)
25512
+ const localVarPath = `/announcements/audiences/{audienceId}/accounts`
25513
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)));
25514
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
25515
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
25516
+ let baseOptions;
25517
+ if (configuration) {
25518
+ baseOptions = configuration.baseOptions;
25519
+ }
25520
+
25521
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
25522
+ const localVarHeaderParameter = {} as any;
25523
+ const localVarQueryParameter = {} as any;
25524
+
25525
+ // authentication ApiKeyAuth required
25526
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
25527
+
25528
+ // authentication OrganizationId required
25529
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
25530
+
25531
+ if (page !== undefined) {
25532
+ localVarQueryParameter['page'] = page;
25533
+ }
25534
+
25535
+ if (pageSize !== undefined) {
25536
+ localVarQueryParameter['pageSize'] = pageSize;
25537
+ }
25538
+
25539
+ if (orderBy !== undefined) {
25540
+ localVarQueryParameter['orderBy'] = orderBy;
25541
+ }
25542
+
25543
+ if (search !== undefined) {
25544
+ localVarQueryParameter['search'] = search;
25545
+ }
25546
+
25547
+ localVarHeaderParameter['Accept'] = 'application/json';
25548
+
25549
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
25550
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25551
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25552
+
25553
+ return {
25554
+ url: toPathString(localVarUrlObj),
25555
+ options: localVarRequestOptions,
25556
+ };
25557
+ },
25558
+ /**
25559
+ * 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.
25560
+ * @summary List announcement audiences
25561
+ * @param {AnnouncementAudienceScope} [scope] Filter by scope
25562
+ * @param {number} [page] Page number
25563
+ * @param {number} [pageSize] Number of items per page
25564
+ * @param {string} [orderBy] Field to order by
25565
+ * @param {string} [search] Search query
25566
+ * @param {*} [options] Override http request option.
25567
+ * @throws {RequiredError}
25568
+ */
25569
+ getAnnouncementAudiences: async (scope?: AnnouncementAudienceScope, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25570
+ const localVarPath = `/announcements/audiences`;
25571
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
25572
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
25573
+ let baseOptions;
25574
+ if (configuration) {
25575
+ baseOptions = configuration.baseOptions;
25576
+ }
25577
+
25578
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
25579
+ const localVarHeaderParameter = {} as any;
25580
+ const localVarQueryParameter = {} as any;
25581
+
25582
+ // authentication ApiKeyAuth required
25583
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
25584
+
25585
+ // authentication OrganizationId required
25586
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
25587
+
25588
+ if (scope !== undefined) {
25589
+ for (const [key, value] of Object.entries(scope)) {
25590
+ localVarQueryParameter[key] = value;
25591
+ }
25592
+ }
25593
+
25594
+ if (page !== undefined) {
25595
+ localVarQueryParameter['page'] = page;
25596
+ }
25597
+
25598
+ if (pageSize !== undefined) {
25599
+ localVarQueryParameter['pageSize'] = pageSize;
25600
+ }
25601
+
25602
+ if (orderBy !== undefined) {
25603
+ localVarQueryParameter['orderBy'] = orderBy;
25604
+ }
25605
+
25606
+ if (search !== undefined) {
25607
+ localVarQueryParameter['search'] = search;
25608
+ }
25609
+
25610
+ localVarHeaderParameter['Accept'] = 'application/json';
25611
+
25612
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
25613
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25614
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25615
+
25616
+ return {
25617
+ url: toPathString(localVarUrlObj),
25618
+ options: localVarRequestOptions,
25619
+ };
25620
+ },
25621
+ /**
25622
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
25623
+ * @summary Update an announcement audience
25624
+ * @param {string} audienceId The audience identifier
25625
+ * @param {AnnouncementAudienceUpdateInputs} announcementAudienceUpdateInputs
25626
+ * @param {*} [options] Override http request option.
25627
+ * @throws {RequiredError}
25628
+ */
25629
+ updateAnnouncementAudience: async (audienceId: string, announcementAudienceUpdateInputs: AnnouncementAudienceUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25630
+ // verify required parameter 'audienceId' is not null or undefined
25631
+ assertParamExists('updateAnnouncementAudience', 'audienceId', audienceId)
25632
+ // verify required parameter 'announcementAudienceUpdateInputs' is not null or undefined
25633
+ assertParamExists('updateAnnouncementAudience', 'announcementAudienceUpdateInputs', announcementAudienceUpdateInputs)
25634
+ const localVarPath = `/announcements/audiences/{audienceId}`
25635
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)));
25636
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
25637
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
25638
+ let baseOptions;
25639
+ if (configuration) {
25640
+ baseOptions = configuration.baseOptions;
25641
+ }
25642
+
25643
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
25644
+ const localVarHeaderParameter = {} as any;
25645
+ const localVarQueryParameter = {} as any;
25646
+
25647
+ // authentication ApiKeyAuth required
25648
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
25649
+
25650
+ // authentication OrganizationId required
25651
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
25652
+
25653
+ localVarHeaderParameter['Content-Type'] = 'application/json';
25654
+ localVarHeaderParameter['Accept'] = 'application/json';
25655
+
25656
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
25657
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25658
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25659
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceUpdateInputs, localVarRequestOptions, configuration)
25660
+
25661
+ return {
25662
+ url: toPathString(localVarUrlObj),
25663
+ options: localVarRequestOptions,
25664
+ };
25665
+ },
25666
+ /**
25667
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
25668
+ * @summary Update an audience condition
25669
+ * @param {string} audienceId The audience identifier
25670
+ * @param {string} filterId The filter identifier
25671
+ * @param {string} conditionId The condition identifier
25672
+ * @param {AnnouncementAudienceConditionUpdateInputs} announcementAudienceConditionUpdateInputs
25673
+ * @param {*} [options] Override http request option.
25674
+ * @throws {RequiredError}
25675
+ */
25676
+ updateAnnouncementAudienceCondition: async (audienceId: string, filterId: string, conditionId: string, announcementAudienceConditionUpdateInputs: AnnouncementAudienceConditionUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25677
+ // verify required parameter 'audienceId' is not null or undefined
25678
+ assertParamExists('updateAnnouncementAudienceCondition', 'audienceId', audienceId)
25679
+ // verify required parameter 'filterId' is not null or undefined
25680
+ assertParamExists('updateAnnouncementAudienceCondition', 'filterId', filterId)
25681
+ // verify required parameter 'conditionId' is not null or undefined
25682
+ assertParamExists('updateAnnouncementAudienceCondition', 'conditionId', conditionId)
25683
+ // verify required parameter 'announcementAudienceConditionUpdateInputs' is not null or undefined
25684
+ assertParamExists('updateAnnouncementAudienceCondition', 'announcementAudienceConditionUpdateInputs', announcementAudienceConditionUpdateInputs)
25685
+ const localVarPath = `/announcements/audiences/{audienceId}/filters/{filterId}/conditions/{conditionId}`
25686
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)))
25687
+ .replace('{filterId}', encodeURIComponent(String(filterId)))
25688
+ .replace('{conditionId}', encodeURIComponent(String(conditionId)));
25689
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
25690
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
25691
+ let baseOptions;
25692
+ if (configuration) {
25693
+ baseOptions = configuration.baseOptions;
25694
+ }
25695
+
25696
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
25697
+ const localVarHeaderParameter = {} as any;
25698
+ const localVarQueryParameter = {} as any;
25699
+
25700
+ // authentication ApiKeyAuth required
25701
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
25702
+
25703
+ // authentication OrganizationId required
25704
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
25705
+
25706
+ localVarHeaderParameter['Content-Type'] = 'application/json';
25707
+ localVarHeaderParameter['Accept'] = 'application/json';
25708
+
25709
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
25710
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25711
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25712
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceConditionUpdateInputs, localVarRequestOptions, configuration)
25713
+
25714
+ return {
25715
+ url: toPathString(localVarUrlObj),
25716
+ options: localVarRequestOptions,
25717
+ };
25718
+ },
25719
+ /**
25720
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
25721
+ * @summary Update an audience filter group
25722
+ * @param {string} audienceId The audience identifier
25723
+ * @param {string} filterId The filter identifier
25724
+ * @param {AnnouncementAudienceFilterUpdateInputs} announcementAudienceFilterUpdateInputs
25725
+ * @param {*} [options] Override http request option.
25726
+ * @throws {RequiredError}
25727
+ */
25728
+ updateAnnouncementAudienceFilter: async (audienceId: string, filterId: string, announcementAudienceFilterUpdateInputs: AnnouncementAudienceFilterUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
25729
+ // verify required parameter 'audienceId' is not null or undefined
25730
+ assertParamExists('updateAnnouncementAudienceFilter', 'audienceId', audienceId)
25731
+ // verify required parameter 'filterId' is not null or undefined
25732
+ assertParamExists('updateAnnouncementAudienceFilter', 'filterId', filterId)
25733
+ // verify required parameter 'announcementAudienceFilterUpdateInputs' is not null or undefined
25734
+ assertParamExists('updateAnnouncementAudienceFilter', 'announcementAudienceFilterUpdateInputs', announcementAudienceFilterUpdateInputs)
25735
+ const localVarPath = `/announcements/audiences/{audienceId}/filters/{filterId}`
25736
+ .replace('{audienceId}', encodeURIComponent(String(audienceId)))
25737
+ .replace('{filterId}', encodeURIComponent(String(filterId)));
25738
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
25739
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
25740
+ let baseOptions;
25741
+ if (configuration) {
25742
+ baseOptions = configuration.baseOptions;
25743
+ }
25744
+
25745
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
25746
+ const localVarHeaderParameter = {} as any;
25747
+ const localVarQueryParameter = {} as any;
25748
+
25749
+ // authentication ApiKeyAuth required
25750
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
25751
+
25752
+ // authentication OrganizationId required
25753
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
25754
+
25755
+ localVarHeaderParameter['Content-Type'] = 'application/json';
25756
+ localVarHeaderParameter['Accept'] = 'application/json';
25757
+
25758
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
25759
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
25760
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
25761
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementAudienceFilterUpdateInputs, localVarRequestOptions, configuration)
25762
+
25763
+ return {
25764
+ url: toPathString(localVarUrlObj),
25765
+ options: localVarRequestOptions,
25766
+ };
25767
+ },
25768
+ }
25769
+ };
25770
+
25771
+ /**
25772
+ * AnnouncementsAudiencesApi - functional programming interface
25773
+ */
25774
+ export const AnnouncementsAudiencesApiFp = function(configuration?: Configuration) {
25775
+ const localVarAxiosParamCreator = AnnouncementsAudiencesApiAxiosParamCreator(configuration)
25776
+ return {
25777
+ /**
25778
+ * 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.
25779
+ * @summary Create an announcement audience
25780
+ * @param {AnnouncementAudienceCreateInputs} announcementAudienceCreateInputs
25781
+ * @param {*} [options] Override http request option.
25782
+ * @throws {RequiredError}
25783
+ */
25784
+ async createAnnouncementAudience(announcementAudienceCreateInputs: AnnouncementAudienceCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudience200Response>> {
25785
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createAnnouncementAudience(announcementAudienceCreateInputs, options);
25786
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25787
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.createAnnouncementAudience']?.[localVarOperationServerIndex]?.url;
25788
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25789
+ },
25790
+ /**
25791
+ * 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.
25792
+ * @summary Create an audience condition
25793
+ * @param {string} audienceId The audience identifier
25794
+ * @param {string} filterId The filter identifier
25795
+ * @param {AnnouncementAudienceConditionCreateInputs} announcementAudienceConditionCreateInputs
25796
+ * @param {*} [options] Override http request option.
25797
+ * @throws {RequiredError}
25798
+ */
25799
+ async createAnnouncementAudienceCondition(audienceId: string, filterId: string, announcementAudienceConditionCreateInputs: AnnouncementAudienceConditionCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceCondition200Response>> {
25800
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createAnnouncementAudienceCondition(audienceId, filterId, announcementAudienceConditionCreateInputs, options);
25801
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25802
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.createAnnouncementAudienceCondition']?.[localVarOperationServerIndex]?.url;
25803
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25804
+ },
25805
+ /**
25806
+ * 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.
25807
+ * @summary Create an audience filter group
25808
+ * @param {string} audienceId The audience identifier
25809
+ * @param {AnnouncementAudienceFilterCreateInputs} announcementAudienceFilterCreateInputs
25810
+ * @param {*} [options] Override http request option.
25811
+ * @throws {RequiredError}
25812
+ */
25813
+ async createAnnouncementAudienceFilter(audienceId: string, announcementAudienceFilterCreateInputs: AnnouncementAudienceFilterCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceFilter200Response>> {
25814
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createAnnouncementAudienceFilter(audienceId, announcementAudienceFilterCreateInputs, options);
25815
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25816
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.createAnnouncementAudienceFilter']?.[localVarOperationServerIndex]?.url;
25817
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25818
+ },
25819
+ /**
25820
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
25821
+ * @summary Delete an announcement audience
25822
+ * @param {string} audienceId The audience identifier
25823
+ * @param {*} [options] Override http request option.
25824
+ * @throws {RequiredError}
25825
+ */
25826
+ async deleteAnnouncementAudience(audienceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
25827
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAnnouncementAudience(audienceId, options);
25828
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25829
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.deleteAnnouncementAudience']?.[localVarOperationServerIndex]?.url;
25830
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25831
+ },
25832
+ /**
25833
+ * Removes a condition from its filter group; requires update permission on announcements.
25834
+ * @summary Delete an audience condition
25835
+ * @param {string} audienceId The audience identifier
25836
+ * @param {string} filterId The filter identifier
25837
+ * @param {string} conditionId The condition identifier
25838
+ * @param {*} [options] Override http request option.
25839
+ * @throws {RequiredError}
25840
+ */
25841
+ async deleteAnnouncementAudienceCondition(audienceId: string, filterId: string, conditionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
25842
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAnnouncementAudienceCondition(audienceId, filterId, conditionId, options);
25843
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25844
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.deleteAnnouncementAudienceCondition']?.[localVarOperationServerIndex]?.url;
25845
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25846
+ },
25847
+ /**
25848
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
25849
+ * @summary Delete an audience filter group
25850
+ * @param {string} audienceId The audience identifier
25851
+ * @param {string} filterId The filter identifier
25852
+ * @param {*} [options] Override http request option.
25853
+ * @throws {RequiredError}
25854
+ */
25855
+ async deleteAnnouncementAudienceFilter(audienceId: string, filterId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
25856
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAnnouncementAudienceFilter(audienceId, filterId, options);
25857
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25858
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.deleteAnnouncementAudienceFilter']?.[localVarOperationServerIndex]?.url;
25859
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25860
+ },
25861
+ /**
25862
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
25863
+ * @summary Get an announcement audience
25864
+ * @param {string} audienceId The audience identifier
25865
+ * @param {*} [options] Override http request option.
25866
+ * @throws {RequiredError}
25867
+ */
25868
+ async getAnnouncementAudience(audienceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudience200Response>> {
25869
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementAudience(audienceId, options);
25870
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25871
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.getAnnouncementAudience']?.[localVarOperationServerIndex]?.url;
25872
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25873
+ },
25874
+ /**
25875
+ * 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.
25876
+ * @summary List the accounts in an announcement audience
25877
+ * @param {string} audienceId The audience identifier
25878
+ * @param {number} [page] Page number
25879
+ * @param {number} [pageSize] Number of items per page
25880
+ * @param {string} [orderBy] Field to order by
25881
+ * @param {string} [search] Search query
25882
+ * @param {*} [options] Override http request option.
25883
+ * @throws {RequiredError}
25884
+ */
25885
+ async getAnnouncementAudienceAccounts(audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudienceAccounts200Response>> {
25886
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementAudienceAccounts(audienceId, page, pageSize, orderBy, search, options);
25887
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25888
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.getAnnouncementAudienceAccounts']?.[localVarOperationServerIndex]?.url;
25889
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25890
+ },
25891
+ /**
25892
+ * 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.
25893
+ * @summary List announcement audiences
25894
+ * @param {AnnouncementAudienceScope} [scope] Filter by scope
25895
+ * @param {number} [page] Page number
25896
+ * @param {number} [pageSize] Number of items per page
25897
+ * @param {string} [orderBy] Field to order by
25898
+ * @param {string} [search] Search query
25899
+ * @param {*} [options] Override http request option.
25900
+ * @throws {RequiredError}
25901
+ */
25902
+ async getAnnouncementAudiences(scope?: AnnouncementAudienceScope, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudiences200Response>> {
25903
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementAudiences(scope, page, pageSize, orderBy, search, options);
25904
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25905
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.getAnnouncementAudiences']?.[localVarOperationServerIndex]?.url;
25906
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25907
+ },
25908
+ /**
25909
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
25910
+ * @summary Update an announcement audience
25911
+ * @param {string} audienceId The audience identifier
25912
+ * @param {AnnouncementAudienceUpdateInputs} announcementAudienceUpdateInputs
25913
+ * @param {*} [options] Override http request option.
25914
+ * @throws {RequiredError}
25915
+ */
25916
+ async updateAnnouncementAudience(audienceId: string, announcementAudienceUpdateInputs: AnnouncementAudienceUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudience200Response>> {
25917
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateAnnouncementAudience(audienceId, announcementAudienceUpdateInputs, options);
25918
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25919
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.updateAnnouncementAudience']?.[localVarOperationServerIndex]?.url;
25920
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25921
+ },
25922
+ /**
25923
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
25924
+ * @summary Update an audience condition
25925
+ * @param {string} audienceId The audience identifier
25926
+ * @param {string} filterId The filter identifier
25927
+ * @param {string} conditionId The condition identifier
25928
+ * @param {AnnouncementAudienceConditionUpdateInputs} announcementAudienceConditionUpdateInputs
25929
+ * @param {*} [options] Override http request option.
25930
+ * @throws {RequiredError}
25931
+ */
25932
+ async updateAnnouncementAudienceCondition(audienceId: string, filterId: string, conditionId: string, announcementAudienceConditionUpdateInputs: AnnouncementAudienceConditionUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceCondition200Response>> {
25933
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateAnnouncementAudienceCondition(audienceId, filterId, conditionId, announcementAudienceConditionUpdateInputs, options);
25934
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25935
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.updateAnnouncementAudienceCondition']?.[localVarOperationServerIndex]?.url;
25936
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25937
+ },
25938
+ /**
25939
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
25940
+ * @summary Update an audience filter group
25941
+ * @param {string} audienceId The audience identifier
25942
+ * @param {string} filterId The filter identifier
25943
+ * @param {AnnouncementAudienceFilterUpdateInputs} announcementAudienceFilterUpdateInputs
25944
+ * @param {*} [options] Override http request option.
25945
+ * @throws {RequiredError}
25946
+ */
25947
+ async updateAnnouncementAudienceFilter(audienceId: string, filterId: string, announcementAudienceFilterUpdateInputs: AnnouncementAudienceFilterUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceFilter200Response>> {
25948
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateAnnouncementAudienceFilter(audienceId, filterId, announcementAudienceFilterUpdateInputs, options);
25949
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
25950
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsAudiencesApi.updateAnnouncementAudienceFilter']?.[localVarOperationServerIndex]?.url;
25951
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
25952
+ },
25953
+ }
25954
+ };
25955
+
25956
+ /**
25957
+ * AnnouncementsAudiencesApi - factory interface
25958
+ */
25959
+ export const AnnouncementsAudiencesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
25960
+ const localVarFp = AnnouncementsAudiencesApiFp(configuration)
25961
+ return {
25962
+ /**
25963
+ * 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.
25964
+ * @summary Create an announcement audience
25965
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest} requestParameters Request parameters.
25966
+ * @param {*} [options] Override http request option.
25967
+ * @throws {RequiredError}
25968
+ */
25969
+ createAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudience200Response> {
25970
+ return localVarFp.createAnnouncementAudience(requestParameters.announcementAudienceCreateInputs, options).then((request) => request(axios, basePath));
25971
+ },
25972
+ /**
25973
+ * 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.
25974
+ * @summary Create an audience condition
25975
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
25976
+ * @param {*} [options] Override http request option.
25977
+ * @throws {RequiredError}
25978
+ */
25979
+ createAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceCondition200Response> {
25980
+ return localVarFp.createAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.announcementAudienceConditionCreateInputs, options).then((request) => request(axios, basePath));
25981
+ },
25982
+ /**
25983
+ * 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.
25984
+ * @summary Create an audience filter group
25985
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
25986
+ * @param {*} [options] Override http request option.
25987
+ * @throws {RequiredError}
25988
+ */
25989
+ createAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceFilter200Response> {
25990
+ return localVarFp.createAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.announcementAudienceFilterCreateInputs, options).then((request) => request(axios, basePath));
25991
+ },
25992
+ /**
25993
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
25994
+ * @summary Delete an announcement audience
25995
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest} requestParameters Request parameters.
25996
+ * @param {*} [options] Override http request option.
25997
+ * @throws {RequiredError}
25998
+ */
25999
+ deleteAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
26000
+ return localVarFp.deleteAnnouncementAudience(requestParameters.audienceId, options).then((request) => request(axios, basePath));
26001
+ },
26002
+ /**
26003
+ * Removes a condition from its filter group; requires update permission on announcements.
26004
+ * @summary Delete an audience condition
26005
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest} requestParameters Request parameters.
26006
+ * @param {*} [options] Override http request option.
26007
+ * @throws {RequiredError}
26008
+ */
26009
+ deleteAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
26010
+ return localVarFp.deleteAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.conditionId, options).then((request) => request(axios, basePath));
26011
+ },
26012
+ /**
26013
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
26014
+ * @summary Delete an audience filter group
26015
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest} requestParameters Request parameters.
26016
+ * @param {*} [options] Override http request option.
26017
+ * @throws {RequiredError}
26018
+ */
26019
+ deleteAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
26020
+ return localVarFp.deleteAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.filterId, options).then((request) => request(axios, basePath));
26021
+ },
26022
+ /**
26023
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
26024
+ * @summary Get an announcement audience
26025
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
26026
+ * @param {*} [options] Override http request option.
26027
+ * @throws {RequiredError}
26028
+ */
26029
+ getAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudience200Response> {
26030
+ return localVarFp.getAnnouncementAudience(requestParameters.audienceId, options).then((request) => request(axios, basePath));
26031
+ },
26032
+ /**
26033
+ * 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.
26034
+ * @summary List the accounts in an announcement audience
26035
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest} requestParameters Request parameters.
26036
+ * @param {*} [options] Override http request option.
26037
+ * @throws {RequiredError}
26038
+ */
26039
+ getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudienceAccounts200Response> {
26040
+ return localVarFp.getAnnouncementAudienceAccounts(requestParameters.audienceId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
26041
+ },
26042
+ /**
26043
+ * 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.
26044
+ * @summary List announcement audiences
26045
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
26046
+ * @param {*} [options] Override http request option.
26047
+ * @throws {RequiredError}
26048
+ */
26049
+ getAnnouncementAudiences(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudiences200Response> {
26050
+ return localVarFp.getAnnouncementAudiences(requestParameters.scope, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
26051
+ },
26052
+ /**
26053
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
26054
+ * @summary Update an announcement audience
26055
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest} requestParameters Request parameters.
26056
+ * @param {*} [options] Override http request option.
26057
+ * @throws {RequiredError}
26058
+ */
26059
+ updateAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudience200Response> {
26060
+ return localVarFp.updateAnnouncementAudience(requestParameters.audienceId, requestParameters.announcementAudienceUpdateInputs, options).then((request) => request(axios, basePath));
26061
+ },
26062
+ /**
26063
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
26064
+ * @summary Update an audience condition
26065
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
26066
+ * @param {*} [options] Override http request option.
26067
+ * @throws {RequiredError}
26068
+ */
26069
+ updateAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceCondition200Response> {
26070
+ return localVarFp.updateAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.conditionId, requestParameters.announcementAudienceConditionUpdateInputs, options).then((request) => request(axios, basePath));
26071
+ },
26072
+ /**
26073
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
26074
+ * @summary Update an audience filter group
26075
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
26076
+ * @param {*} [options] Override http request option.
26077
+ * @throws {RequiredError}
26078
+ */
26079
+ updateAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceFilter200Response> {
26080
+ return localVarFp.updateAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.filterId, requestParameters.announcementAudienceFilterUpdateInputs, options).then((request) => request(axios, basePath));
26081
+ },
26082
+ };
26083
+ };
26084
+
26085
+ /**
26086
+ * Request parameters for createAnnouncementAudience operation in AnnouncementsAudiencesApi.
26087
+ */
26088
+ export interface AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest {
26089
+ readonly announcementAudienceCreateInputs: AnnouncementAudienceCreateInputs
26090
+ }
26091
+
26092
+ /**
26093
+ * Request parameters for createAnnouncementAudienceCondition operation in AnnouncementsAudiencesApi.
26094
+ */
26095
+ export interface AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest {
26096
+ /**
26097
+ * The audience identifier
26098
+ */
26099
+ readonly audienceId: string
26100
+
26101
+ /**
26102
+ * The filter identifier
26103
+ */
26104
+ readonly filterId: string
26105
+
26106
+ readonly announcementAudienceConditionCreateInputs: AnnouncementAudienceConditionCreateInputs
26107
+ }
26108
+
26109
+ /**
26110
+ * Request parameters for createAnnouncementAudienceFilter operation in AnnouncementsAudiencesApi.
26111
+ */
26112
+ export interface AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest {
26113
+ /**
26114
+ * The audience identifier
26115
+ */
26116
+ readonly audienceId: string
26117
+
26118
+ readonly announcementAudienceFilterCreateInputs: AnnouncementAudienceFilterCreateInputs
26119
+ }
26120
+
26121
+ /**
26122
+ * Request parameters for deleteAnnouncementAudience operation in AnnouncementsAudiencesApi.
26123
+ */
26124
+ export interface AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest {
26125
+ /**
26126
+ * The audience identifier
26127
+ */
26128
+ readonly audienceId: string
26129
+ }
26130
+
26131
+ /**
26132
+ * Request parameters for deleteAnnouncementAudienceCondition operation in AnnouncementsAudiencesApi.
26133
+ */
26134
+ export interface AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest {
26135
+ /**
26136
+ * The audience identifier
26137
+ */
26138
+ readonly audienceId: string
26139
+
26140
+ /**
26141
+ * The filter identifier
26142
+ */
26143
+ readonly filterId: string
26144
+
26145
+ /**
26146
+ * The condition identifier
26147
+ */
26148
+ readonly conditionId: string
26149
+ }
26150
+
26151
+ /**
26152
+ * Request parameters for deleteAnnouncementAudienceFilter operation in AnnouncementsAudiencesApi.
26153
+ */
26154
+ export interface AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest {
26155
+ /**
26156
+ * The audience identifier
26157
+ */
26158
+ readonly audienceId: string
26159
+
26160
+ /**
26161
+ * The filter identifier
26162
+ */
26163
+ readonly filterId: string
26164
+ }
26165
+
26166
+ /**
26167
+ * Request parameters for getAnnouncementAudience operation in AnnouncementsAudiencesApi.
26168
+ */
26169
+ export interface AnnouncementsAudiencesApiGetAnnouncementAudienceRequest {
26170
+ /**
26171
+ * The audience identifier
26172
+ */
26173
+ readonly audienceId: string
26174
+ }
26175
+
26176
+ /**
26177
+ * Request parameters for getAnnouncementAudienceAccounts operation in AnnouncementsAudiencesApi.
26178
+ */
26179
+ export interface AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest {
26180
+ /**
26181
+ * The audience identifier
26182
+ */
26183
+ readonly audienceId: string
26184
+
26185
+ /**
26186
+ * Page number
26187
+ */
26188
+ readonly page?: number
26189
+
26190
+ /**
26191
+ * Number of items per page
26192
+ */
26193
+ readonly pageSize?: number
26194
+
26195
+ /**
26196
+ * Field to order by
26197
+ */
26198
+ readonly orderBy?: string
26199
+
26200
+ /**
26201
+ * Search query
26202
+ */
26203
+ readonly search?: string
26204
+ }
26205
+
26206
+ /**
26207
+ * Request parameters for getAnnouncementAudiences operation in AnnouncementsAudiencesApi.
26208
+ */
26209
+ export interface AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest {
26210
+ /**
26211
+ * Filter by scope
26212
+ */
26213
+ readonly scope?: AnnouncementAudienceScope
26214
+
26215
+ /**
26216
+ * Page number
26217
+ */
26218
+ readonly page?: number
26219
+
26220
+ /**
26221
+ * Number of items per page
26222
+ */
26223
+ readonly pageSize?: number
26224
+
26225
+ /**
26226
+ * Field to order by
26227
+ */
26228
+ readonly orderBy?: string
26229
+
26230
+ /**
26231
+ * Search query
26232
+ */
26233
+ readonly search?: string
26234
+ }
26235
+
26236
+ /**
26237
+ * Request parameters for updateAnnouncementAudience operation in AnnouncementsAudiencesApi.
26238
+ */
26239
+ export interface AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest {
26240
+ /**
26241
+ * The audience identifier
26242
+ */
26243
+ readonly audienceId: string
26244
+
26245
+ readonly announcementAudienceUpdateInputs: AnnouncementAudienceUpdateInputs
26246
+ }
26247
+
26248
+ /**
26249
+ * Request parameters for updateAnnouncementAudienceCondition operation in AnnouncementsAudiencesApi.
26250
+ */
26251
+ export interface AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest {
26252
+ /**
26253
+ * The audience identifier
26254
+ */
26255
+ readonly audienceId: string
26256
+
26257
+ /**
26258
+ * The filter identifier
26259
+ */
26260
+ readonly filterId: string
26261
+
26262
+ /**
26263
+ * The condition identifier
26264
+ */
26265
+ readonly conditionId: string
26266
+
26267
+ readonly announcementAudienceConditionUpdateInputs: AnnouncementAudienceConditionUpdateInputs
26268
+ }
26269
+
26270
+ /**
26271
+ * Request parameters for updateAnnouncementAudienceFilter operation in AnnouncementsAudiencesApi.
26272
+ */
26273
+ export interface AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest {
26274
+ /**
26275
+ * The audience identifier
26276
+ */
26277
+ readonly audienceId: string
26278
+
26279
+ /**
26280
+ * The filter identifier
26281
+ */
26282
+ readonly filterId: string
26283
+
26284
+ readonly announcementAudienceFilterUpdateInputs: AnnouncementAudienceFilterUpdateInputs
26285
+ }
26286
+
26287
+ /**
26288
+ * AnnouncementsAudiencesApi - object-oriented interface
26289
+ */
26290
+ export class AnnouncementsAudiencesApi extends BaseAPI {
26291
+ /**
26292
+ * 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.
26293
+ * @summary Create an announcement audience
26294
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest} requestParameters Request parameters.
26295
+ * @param {*} [options] Override http request option.
26296
+ * @throws {RequiredError}
26297
+ */
26298
+ public createAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig) {
26299
+ return AnnouncementsAudiencesApiFp(this.configuration).createAnnouncementAudience(requestParameters.announcementAudienceCreateInputs, options).then((request) => request(this.axios, this.basePath));
26300
+ }
26301
+
26302
+ /**
26303
+ * 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.
26304
+ * @summary Create an audience condition
26305
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
26306
+ * @param {*} [options] Override http request option.
26307
+ * @throws {RequiredError}
26308
+ */
26309
+ public createAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig) {
26310
+ return AnnouncementsAudiencesApiFp(this.configuration).createAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.announcementAudienceConditionCreateInputs, options).then((request) => request(this.axios, this.basePath));
26311
+ }
26312
+
26313
+ /**
26314
+ * 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.
26315
+ * @summary Create an audience filter group
26316
+ * @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
26317
+ * @param {*} [options] Override http request option.
26318
+ * @throws {RequiredError}
26319
+ */
26320
+ public createAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig) {
26321
+ return AnnouncementsAudiencesApiFp(this.configuration).createAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.announcementAudienceFilterCreateInputs, options).then((request) => request(this.axios, this.basePath));
26322
+ }
26323
+
26324
+ /**
26325
+ * Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
26326
+ * @summary Delete an announcement audience
26327
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest} requestParameters Request parameters.
26328
+ * @param {*} [options] Override http request option.
26329
+ * @throws {RequiredError}
26330
+ */
26331
+ public deleteAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest, options?: RawAxiosRequestConfig) {
26332
+ return AnnouncementsAudiencesApiFp(this.configuration).deleteAnnouncementAudience(requestParameters.audienceId, options).then((request) => request(this.axios, this.basePath));
26333
+ }
26334
+
26335
+ /**
26336
+ * Removes a condition from its filter group; requires update permission on announcements.
26337
+ * @summary Delete an audience condition
26338
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest} requestParameters Request parameters.
26339
+ * @param {*} [options] Override http request option.
26340
+ * @throws {RequiredError}
26341
+ */
26342
+ public deleteAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig) {
26343
+ return AnnouncementsAudiencesApiFp(this.configuration).deleteAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.conditionId, options).then((request) => request(this.axios, this.basePath));
26344
+ }
26345
+
26346
+ /**
26347
+ * Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
26348
+ * @summary Delete an audience filter group
26349
+ * @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest} requestParameters Request parameters.
26350
+ * @param {*} [options] Override http request option.
26351
+ * @throws {RequiredError}
26352
+ */
26353
+ public deleteAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig) {
26354
+ return AnnouncementsAudiencesApiFp(this.configuration).deleteAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.filterId, options).then((request) => request(this.axios, this.basePath));
26355
+ }
26356
+
26357
+ /**
26358
+ * Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
26359
+ * @summary Get an announcement audience
26360
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
26361
+ * @param {*} [options] Override http request option.
26362
+ * @throws {RequiredError}
26363
+ */
26364
+ public getAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig) {
26365
+ return AnnouncementsAudiencesApiFp(this.configuration).getAnnouncementAudience(requestParameters.audienceId, options).then((request) => request(this.axios, this.basePath));
26366
+ }
26367
+
26368
+ /**
26369
+ * 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.
26370
+ * @summary List the accounts in an announcement audience
26371
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest} requestParameters Request parameters.
26372
+ * @param {*} [options] Override http request option.
26373
+ * @throws {RequiredError}
26374
+ */
26375
+ public getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig) {
26376
+ return AnnouncementsAudiencesApiFp(this.configuration).getAnnouncementAudienceAccounts(requestParameters.audienceId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
26377
+ }
26378
+
26379
+ /**
26380
+ * 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.
26381
+ * @summary List announcement audiences
26382
+ * @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
26383
+ * @param {*} [options] Override http request option.
26384
+ * @throws {RequiredError}
26385
+ */
26386
+ public getAnnouncementAudiences(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest = {}, options?: RawAxiosRequestConfig) {
26387
+ return AnnouncementsAudiencesApiFp(this.configuration).getAnnouncementAudiences(requestParameters.scope, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
26388
+ }
26389
+
26390
+ /**
26391
+ * Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
26392
+ * @summary Update an announcement audience
26393
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest} requestParameters Request parameters.
26394
+ * @param {*} [options] Override http request option.
26395
+ * @throws {RequiredError}
26396
+ */
26397
+ public updateAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig) {
26398
+ return AnnouncementsAudiencesApiFp(this.configuration).updateAnnouncementAudience(requestParameters.audienceId, requestParameters.announcementAudienceUpdateInputs, options).then((request) => request(this.axios, this.basePath));
26399
+ }
26400
+
26401
+ /**
26402
+ * Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
26403
+ * @summary Update an audience condition
26404
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
26405
+ * @param {*} [options] Override http request option.
26406
+ * @throws {RequiredError}
26407
+ */
26408
+ public updateAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig) {
26409
+ return AnnouncementsAudiencesApiFp(this.configuration).updateAnnouncementAudienceCondition(requestParameters.audienceId, requestParameters.filterId, requestParameters.conditionId, requestParameters.announcementAudienceConditionUpdateInputs, options).then((request) => request(this.axios, this.basePath));
26410
+ }
26411
+
26412
+ /**
26413
+ * Changes a filter group\'s operator or sort order; requires update permission on announcements.
26414
+ * @summary Update an audience filter group
26415
+ * @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
26416
+ * @param {*} [options] Override http request option.
26417
+ * @throws {RequiredError}
26418
+ */
26419
+ public updateAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig) {
26420
+ return AnnouncementsAudiencesApiFp(this.configuration).updateAnnouncementAudienceFilter(requestParameters.audienceId, requestParameters.filterId, requestParameters.announcementAudienceFilterUpdateInputs, options).then((request) => request(this.axios, this.basePath));
26421
+ }
26422
+ }
26423
+
26424
+
26425
+
26426
+ /**
26427
+ * AnnouncementsScheduleApi - axios parameter creator
26428
+ */
26429
+ export const AnnouncementsScheduleApiAxiosParamCreator = function (configuration?: Configuration) {
26430
+ return {
26431
+ /**
26432
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
26433
+ * @summary Cancel an announcement\'s scheduled send
26434
+ * @param {string} announcementId The announcement identifier
26435
+ * @param {*} [options] Override http request option.
26436
+ * @throws {RequiredError}
26437
+ */
26438
+ cancelAnnouncementSchedule: async (announcementId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
26439
+ // verify required parameter 'announcementId' is not null or undefined
26440
+ assertParamExists('cancelAnnouncementSchedule', 'announcementId', announcementId)
26441
+ const localVarPath = `/announcements/{announcementId}/schedule`
26442
+ .replace('{announcementId}', encodeURIComponent(String(announcementId)));
26443
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
26444
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
26445
+ let baseOptions;
26446
+ if (configuration) {
26447
+ baseOptions = configuration.baseOptions;
26448
+ }
26449
+
26450
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
26451
+ const localVarHeaderParameter = {} as any;
26452
+ const localVarQueryParameter = {} as any;
26453
+
26454
+ // authentication ApiKeyAuth required
26455
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
26456
+
26457
+ // authentication OrganizationId required
26458
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
26459
+
26460
+ localVarHeaderParameter['Accept'] = 'application/json';
26461
+
26462
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
26463
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
26464
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
26465
+
26466
+ return {
26467
+ url: toPathString(localVarUrlObj),
26468
+ options: localVarRequestOptions,
26469
+ };
26470
+ },
26471
+ /**
26472
+ * 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.
26473
+ * @summary Schedule or reschedule an announcement send
26474
+ * @param {string} announcementId The announcement identifier
26475
+ * @param {object} body
26476
+ * @param {*} [options] Override http request option.
26477
+ * @throws {RequiredError}
26478
+ */
26479
+ updateAnnouncementSchedule: async (announcementId: string, body: object, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
26480
+ // verify required parameter 'announcementId' is not null or undefined
26481
+ assertParamExists('updateAnnouncementSchedule', 'announcementId', announcementId)
26482
+ // verify required parameter 'body' is not null or undefined
26483
+ assertParamExists('updateAnnouncementSchedule', 'body', body)
26484
+ const localVarPath = `/announcements/{announcementId}/schedule`
26485
+ .replace('{announcementId}', encodeURIComponent(String(announcementId)));
26486
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
26487
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
26488
+ let baseOptions;
26489
+ if (configuration) {
26490
+ baseOptions = configuration.baseOptions;
26491
+ }
26492
+
26493
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
26494
+ const localVarHeaderParameter = {} as any;
26495
+ const localVarQueryParameter = {} as any;
26496
+
26497
+ // authentication ApiKeyAuth required
26498
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
26499
+
26500
+ // authentication OrganizationId required
26501
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
26502
+
26503
+ localVarHeaderParameter['Content-Type'] = 'application/json';
26504
+ localVarHeaderParameter['Accept'] = 'application/json';
26505
+
26506
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
26507
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
26508
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
26509
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
26510
+
26511
+ return {
26512
+ url: toPathString(localVarUrlObj),
26513
+ options: localVarRequestOptions,
26514
+ };
26515
+ },
26516
+ }
26517
+ };
26518
+
26519
+ /**
26520
+ * AnnouncementsScheduleApi - functional programming interface
26521
+ */
26522
+ export const AnnouncementsScheduleApiFp = function(configuration?: Configuration) {
26523
+ const localVarAxiosParamCreator = AnnouncementsScheduleApiAxiosParamCreator(configuration)
26524
+ return {
26525
+ /**
26526
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
26527
+ * @summary Cancel an announcement\'s scheduled send
26528
+ * @param {string} announcementId The announcement identifier
26529
+ * @param {*} [options] Override http request option.
26530
+ * @throws {RequiredError}
26531
+ */
26532
+ async cancelAnnouncementSchedule(announcementId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncement200Response>> {
26533
+ const localVarAxiosArgs = await localVarAxiosParamCreator.cancelAnnouncementSchedule(announcementId, options);
26534
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
26535
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsScheduleApi.cancelAnnouncementSchedule']?.[localVarOperationServerIndex]?.url;
26536
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
26537
+ },
26538
+ /**
26539
+ * 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.
26540
+ * @summary Schedule or reschedule an announcement send
26541
+ * @param {string} announcementId The announcement identifier
26542
+ * @param {object} body
26543
+ * @param {*} [options] Override http request option.
26544
+ * @throws {RequiredError}
26545
+ */
26546
+ async updateAnnouncementSchedule(announcementId: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncement200Response>> {
26547
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateAnnouncementSchedule(announcementId, body, options);
26548
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
26549
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsScheduleApi.updateAnnouncementSchedule']?.[localVarOperationServerIndex]?.url;
26550
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
26551
+ },
26552
+ }
26553
+ };
26554
+
26555
+ /**
26556
+ * AnnouncementsScheduleApi - factory interface
26557
+ */
24852
26558
  export const AnnouncementsScheduleApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
24853
26559
  const localVarFp = AnnouncementsScheduleApiFp(configuration)
24854
26560
  return {
24855
26561
  /**
24856
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
24857
- * @summary Cancel an announcement\'s scheduled send
24858
- * @param {AnnouncementsScheduleApiCancelAnnouncementScheduleRequest} requestParameters Request parameters.
26562
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
26563
+ * @summary Cancel an announcement\'s scheduled send
26564
+ * @param {AnnouncementsScheduleApiCancelAnnouncementScheduleRequest} requestParameters Request parameters.
26565
+ * @param {*} [options] Override http request option.
26566
+ * @throws {RequiredError}
26567
+ */
26568
+ cancelAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiCancelAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncement200Response> {
26569
+ return localVarFp.cancelAnnouncementSchedule(requestParameters.announcementId, options).then((request) => request(axios, basePath));
26570
+ },
26571
+ /**
26572
+ * 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.
26573
+ * @summary Schedule or reschedule an announcement send
26574
+ * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
26575
+ * @param {*} [options] Override http request option.
26576
+ * @throws {RequiredError}
26577
+ */
26578
+ updateAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncement200Response> {
26579
+ return localVarFp.updateAnnouncementSchedule(requestParameters.announcementId, requestParameters.body, options).then((request) => request(axios, basePath));
26580
+ },
26581
+ };
26582
+ };
26583
+
26584
+ /**
26585
+ * Request parameters for cancelAnnouncementSchedule operation in AnnouncementsScheduleApi.
26586
+ */
26587
+ export interface AnnouncementsScheduleApiCancelAnnouncementScheduleRequest {
26588
+ /**
26589
+ * The announcement identifier
26590
+ */
26591
+ readonly announcementId: string
26592
+ }
26593
+
26594
+ /**
26595
+ * Request parameters for updateAnnouncementSchedule operation in AnnouncementsScheduleApi.
26596
+ */
26597
+ export interface AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest {
26598
+ /**
26599
+ * The announcement identifier
26600
+ */
26601
+ readonly announcementId: string
26602
+
26603
+ readonly body: object
26604
+ }
26605
+
26606
+ /**
26607
+ * AnnouncementsScheduleApi - object-oriented interface
26608
+ */
26609
+ export class AnnouncementsScheduleApi extends BaseAPI {
26610
+ /**
26611
+ * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
26612
+ * @summary Cancel an announcement\'s scheduled send
26613
+ * @param {AnnouncementsScheduleApiCancelAnnouncementScheduleRequest} requestParameters Request parameters.
26614
+ * @param {*} [options] Override http request option.
26615
+ * @throws {RequiredError}
26616
+ */
26617
+ public cancelAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiCancelAnnouncementScheduleRequest, options?: RawAxiosRequestConfig) {
26618
+ return AnnouncementsScheduleApiFp(this.configuration).cancelAnnouncementSchedule(requestParameters.announcementId, options).then((request) => request(this.axios, this.basePath));
26619
+ }
26620
+
26621
+ /**
26622
+ * 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.
26623
+ * @summary Schedule or reschedule an announcement send
26624
+ * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
26625
+ * @param {*} [options] Override http request option.
26626
+ * @throws {RequiredError}
26627
+ */
26628
+ public updateAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest, options?: RawAxiosRequestConfig) {
26629
+ return AnnouncementsScheduleApiFp(this.configuration).updateAnnouncementSchedule(requestParameters.announcementId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
26630
+ }
26631
+ }
26632
+
26633
+
26634
+
26635
+ /**
26636
+ * AnnouncementsTemplatesApi - axios parameter creator
26637
+ */
26638
+ export const AnnouncementsTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
26639
+ return {
26640
+ /**
26641
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
26642
+ * @summary Create an announcement template
26643
+ * @param {AnnouncementTemplateCreateInputs} announcementTemplateCreateInputs
26644
+ * @param {*} [options] Override http request option.
26645
+ * @throws {RequiredError}
26646
+ */
26647
+ createAnnouncementTemplate: async (announcementTemplateCreateInputs: AnnouncementTemplateCreateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
26648
+ // verify required parameter 'announcementTemplateCreateInputs' is not null or undefined
26649
+ assertParamExists('createAnnouncementTemplate', 'announcementTemplateCreateInputs', announcementTemplateCreateInputs)
26650
+ const localVarPath = `/announcements/templates`;
26651
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
26652
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
26653
+ let baseOptions;
26654
+ if (configuration) {
26655
+ baseOptions = configuration.baseOptions;
26656
+ }
26657
+
26658
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
26659
+ const localVarHeaderParameter = {} as any;
26660
+ const localVarQueryParameter = {} as any;
26661
+
26662
+ // authentication ApiKeyAuth required
26663
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
26664
+
26665
+ // authentication OrganizationId required
26666
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
26667
+
26668
+ localVarHeaderParameter['Content-Type'] = 'application/json';
26669
+ localVarHeaderParameter['Accept'] = 'application/json';
26670
+
26671
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
26672
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
26673
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
26674
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementTemplateCreateInputs, localVarRequestOptions, configuration)
26675
+
26676
+ return {
26677
+ url: toPathString(localVarUrlObj),
26678
+ options: localVarRequestOptions,
26679
+ };
26680
+ },
26681
+ /**
26682
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
26683
+ * @summary Delete an announcement template
26684
+ * @param {string} templateId The template identifier
26685
+ * @param {*} [options] Override http request option.
26686
+ * @throws {RequiredError}
26687
+ */
26688
+ deleteAnnouncementTemplate: async (templateId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
26689
+ // verify required parameter 'templateId' is not null or undefined
26690
+ assertParamExists('deleteAnnouncementTemplate', 'templateId', templateId)
26691
+ const localVarPath = `/announcements/templates/{templateId}`
26692
+ .replace('{templateId}', encodeURIComponent(String(templateId)));
26693
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
26694
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
26695
+ let baseOptions;
26696
+ if (configuration) {
26697
+ baseOptions = configuration.baseOptions;
26698
+ }
26699
+
26700
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
26701
+ const localVarHeaderParameter = {} as any;
26702
+ const localVarQueryParameter = {} as any;
26703
+
26704
+ // authentication ApiKeyAuth required
26705
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
26706
+
26707
+ // authentication OrganizationId required
26708
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
26709
+
26710
+ localVarHeaderParameter['Accept'] = 'application/json';
26711
+
26712
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
26713
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
26714
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
26715
+
26716
+ return {
26717
+ url: toPathString(localVarUrlObj),
26718
+ options: localVarRequestOptions,
26719
+ };
26720
+ },
26721
+ /**
26722
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
26723
+ * @summary Get an announcement template
26724
+ * @param {string} templateId The template identifier
26725
+ * @param {*} [options] Override http request option.
26726
+ * @throws {RequiredError}
26727
+ */
26728
+ getAnnouncementTemplate: async (templateId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
26729
+ // verify required parameter 'templateId' is not null or undefined
26730
+ assertParamExists('getAnnouncementTemplate', 'templateId', templateId)
26731
+ const localVarPath = `/announcements/templates/{templateId}`
26732
+ .replace('{templateId}', encodeURIComponent(String(templateId)));
26733
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
26734
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
26735
+ let baseOptions;
26736
+ if (configuration) {
26737
+ baseOptions = configuration.baseOptions;
26738
+ }
26739
+
26740
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
26741
+ const localVarHeaderParameter = {} as any;
26742
+ const localVarQueryParameter = {} as any;
26743
+
26744
+ // authentication ApiKeyAuth required
26745
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
26746
+
26747
+ // authentication OrganizationId required
26748
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
26749
+
26750
+ localVarHeaderParameter['Accept'] = 'application/json';
26751
+
26752
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
26753
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
26754
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
26755
+
26756
+ return {
26757
+ url: toPathString(localVarUrlObj),
26758
+ options: localVarRequestOptions,
26759
+ };
26760
+ },
26761
+ /**
26762
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
26763
+ * @summary List announcement templates
26764
+ * @param {number} [page] Page number
26765
+ * @param {number} [pageSize] Number of items per page
26766
+ * @param {string} [orderBy] Field to order by
26767
+ * @param {string} [search] Search query
26768
+ * @param {*} [options] Override http request option.
26769
+ * @throws {RequiredError}
26770
+ */
26771
+ getAnnouncementTemplates: async (page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
26772
+ const localVarPath = `/announcements/templates`;
26773
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
26774
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
26775
+ let baseOptions;
26776
+ if (configuration) {
26777
+ baseOptions = configuration.baseOptions;
26778
+ }
26779
+
26780
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
26781
+ const localVarHeaderParameter = {} as any;
26782
+ const localVarQueryParameter = {} as any;
26783
+
26784
+ // authentication ApiKeyAuth required
26785
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
26786
+
26787
+ // authentication OrganizationId required
26788
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
26789
+
26790
+ if (page !== undefined) {
26791
+ localVarQueryParameter['page'] = page;
26792
+ }
26793
+
26794
+ if (pageSize !== undefined) {
26795
+ localVarQueryParameter['pageSize'] = pageSize;
26796
+ }
26797
+
26798
+ if (orderBy !== undefined) {
26799
+ localVarQueryParameter['orderBy'] = orderBy;
26800
+ }
26801
+
26802
+ if (search !== undefined) {
26803
+ localVarQueryParameter['search'] = search;
26804
+ }
26805
+
26806
+ localVarHeaderParameter['Accept'] = 'application/json';
26807
+
26808
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
26809
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
26810
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
26811
+
26812
+ return {
26813
+ url: toPathString(localVarUrlObj),
26814
+ options: localVarRequestOptions,
26815
+ };
26816
+ },
26817
+ /**
26818
+ * 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.
26819
+ * @summary Update an announcement template
26820
+ * @param {string} templateId The template identifier
26821
+ * @param {AnnouncementTemplateUpdateInputs} announcementTemplateUpdateInputs
26822
+ * @param {*} [options] Override http request option.
26823
+ * @throws {RequiredError}
26824
+ */
26825
+ updateAnnouncementTemplate: async (templateId: string, announcementTemplateUpdateInputs: AnnouncementTemplateUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
26826
+ // verify required parameter 'templateId' is not null or undefined
26827
+ assertParamExists('updateAnnouncementTemplate', 'templateId', templateId)
26828
+ // verify required parameter 'announcementTemplateUpdateInputs' is not null or undefined
26829
+ assertParamExists('updateAnnouncementTemplate', 'announcementTemplateUpdateInputs', announcementTemplateUpdateInputs)
26830
+ const localVarPath = `/announcements/templates/{templateId}`
26831
+ .replace('{templateId}', encodeURIComponent(String(templateId)));
26832
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
26833
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
26834
+ let baseOptions;
26835
+ if (configuration) {
26836
+ baseOptions = configuration.baseOptions;
26837
+ }
26838
+
26839
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
26840
+ const localVarHeaderParameter = {} as any;
26841
+ const localVarQueryParameter = {} as any;
26842
+
26843
+ // authentication ApiKeyAuth required
26844
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
26845
+
26846
+ // authentication OrganizationId required
26847
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
26848
+
26849
+ localVarHeaderParameter['Content-Type'] = 'application/json';
26850
+ localVarHeaderParameter['Accept'] = 'application/json';
26851
+
26852
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
26853
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
26854
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
26855
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementTemplateUpdateInputs, localVarRequestOptions, configuration)
26856
+
26857
+ return {
26858
+ url: toPathString(localVarUrlObj),
26859
+ options: localVarRequestOptions,
26860
+ };
26861
+ },
26862
+ }
26863
+ };
26864
+
26865
+ /**
26866
+ * AnnouncementsTemplatesApi - functional programming interface
26867
+ */
26868
+ export const AnnouncementsTemplatesApiFp = function(configuration?: Configuration) {
26869
+ const localVarAxiosParamCreator = AnnouncementsTemplatesApiAxiosParamCreator(configuration)
26870
+ return {
26871
+ /**
26872
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
26873
+ * @summary Create an announcement template
26874
+ * @param {AnnouncementTemplateCreateInputs} announcementTemplateCreateInputs
26875
+ * @param {*} [options] Override http request option.
26876
+ * @throws {RequiredError}
26877
+ */
26878
+ async createAnnouncementTemplate(announcementTemplateCreateInputs: AnnouncementTemplateCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementTemplate200Response>> {
26879
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createAnnouncementTemplate(announcementTemplateCreateInputs, options);
26880
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
26881
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsTemplatesApi.createAnnouncementTemplate']?.[localVarOperationServerIndex]?.url;
26882
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
26883
+ },
26884
+ /**
26885
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
26886
+ * @summary Delete an announcement template
26887
+ * @param {string} templateId The template identifier
26888
+ * @param {*} [options] Override http request option.
26889
+ * @throws {RequiredError}
26890
+ */
26891
+ async deleteAnnouncementTemplate(templateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
26892
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAnnouncementTemplate(templateId, options);
26893
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
26894
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsTemplatesApi.deleteAnnouncementTemplate']?.[localVarOperationServerIndex]?.url;
26895
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
26896
+ },
26897
+ /**
26898
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
26899
+ * @summary Get an announcement template
26900
+ * @param {string} templateId The template identifier
26901
+ * @param {*} [options] Override http request option.
26902
+ * @throws {RequiredError}
26903
+ */
26904
+ async getAnnouncementTemplate(templateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementTemplate200Response>> {
26905
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementTemplate(templateId, options);
26906
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
26907
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsTemplatesApi.getAnnouncementTemplate']?.[localVarOperationServerIndex]?.url;
26908
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
26909
+ },
26910
+ /**
26911
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
26912
+ * @summary List announcement templates
26913
+ * @param {number} [page] Page number
26914
+ * @param {number} [pageSize] Number of items per page
26915
+ * @param {string} [orderBy] Field to order by
26916
+ * @param {string} [search] Search query
26917
+ * @param {*} [options] Override http request option.
26918
+ * @throws {RequiredError}
26919
+ */
26920
+ async getAnnouncementTemplates(page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementTemplates200Response>> {
26921
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementTemplates(page, pageSize, orderBy, search, options);
26922
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
26923
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsTemplatesApi.getAnnouncementTemplates']?.[localVarOperationServerIndex]?.url;
26924
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
26925
+ },
26926
+ /**
26927
+ * 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.
26928
+ * @summary Update an announcement template
26929
+ * @param {string} templateId The template identifier
26930
+ * @param {AnnouncementTemplateUpdateInputs} announcementTemplateUpdateInputs
26931
+ * @param {*} [options] Override http request option.
26932
+ * @throws {RequiredError}
26933
+ */
26934
+ async updateAnnouncementTemplate(templateId: string, announcementTemplateUpdateInputs: AnnouncementTemplateUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementTemplate200Response>> {
26935
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateAnnouncementTemplate(templateId, announcementTemplateUpdateInputs, options);
26936
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
26937
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsTemplatesApi.updateAnnouncementTemplate']?.[localVarOperationServerIndex]?.url;
26938
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
26939
+ },
26940
+ }
26941
+ };
26942
+
26943
+ /**
26944
+ * AnnouncementsTemplatesApi - factory interface
26945
+ */
26946
+ export const AnnouncementsTemplatesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
26947
+ const localVarFp = AnnouncementsTemplatesApiFp(configuration)
26948
+ return {
26949
+ /**
26950
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
26951
+ * @summary Create an announcement template
26952
+ * @param {AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest} requestParameters Request parameters.
26953
+ * @param {*} [options] Override http request option.
26954
+ * @throws {RequiredError}
26955
+ */
26956
+ createAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementTemplate200Response> {
26957
+ return localVarFp.createAnnouncementTemplate(requestParameters.announcementTemplateCreateInputs, options).then((request) => request(axios, basePath));
26958
+ },
26959
+ /**
26960
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
26961
+ * @summary Delete an announcement template
26962
+ * @param {AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest} requestParameters Request parameters.
26963
+ * @param {*} [options] Override http request option.
26964
+ * @throws {RequiredError}
26965
+ */
26966
+ deleteAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
26967
+ return localVarFp.deleteAnnouncementTemplate(requestParameters.templateId, options).then((request) => request(axios, basePath));
26968
+ },
26969
+ /**
26970
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
26971
+ * @summary Get an announcement template
26972
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplateRequest} requestParameters Request parameters.
26973
+ * @param {*} [options] Override http request option.
26974
+ * @throws {RequiredError}
26975
+ */
26976
+ getAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiGetAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementTemplate200Response> {
26977
+ return localVarFp.getAnnouncementTemplate(requestParameters.templateId, options).then((request) => request(axios, basePath));
26978
+ },
26979
+ /**
26980
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
26981
+ * @summary List announcement templates
26982
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest} requestParameters Request parameters.
26983
+ * @param {*} [options] Override http request option.
26984
+ * @throws {RequiredError}
26985
+ */
26986
+ getAnnouncementTemplates(requestParameters: AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementTemplates200Response> {
26987
+ return localVarFp.getAnnouncementTemplates(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
26988
+ },
26989
+ /**
26990
+ * 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.
26991
+ * @summary Update an announcement template
26992
+ * @param {AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest} requestParameters Request parameters.
26993
+ * @param {*} [options] Override http request option.
26994
+ * @throws {RequiredError}
26995
+ */
26996
+ updateAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementTemplate200Response> {
26997
+ return localVarFp.updateAnnouncementTemplate(requestParameters.templateId, requestParameters.announcementTemplateUpdateInputs, options).then((request) => request(axios, basePath));
26998
+ },
26999
+ };
27000
+ };
27001
+
27002
+ /**
27003
+ * Request parameters for createAnnouncementTemplate operation in AnnouncementsTemplatesApi.
27004
+ */
27005
+ export interface AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest {
27006
+ readonly announcementTemplateCreateInputs: AnnouncementTemplateCreateInputs
27007
+ }
27008
+
27009
+ /**
27010
+ * Request parameters for deleteAnnouncementTemplate operation in AnnouncementsTemplatesApi.
27011
+ */
27012
+ export interface AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest {
27013
+ /**
27014
+ * The template identifier
27015
+ */
27016
+ readonly templateId: string
27017
+ }
27018
+
27019
+ /**
27020
+ * Request parameters for getAnnouncementTemplate operation in AnnouncementsTemplatesApi.
27021
+ */
27022
+ export interface AnnouncementsTemplatesApiGetAnnouncementTemplateRequest {
27023
+ /**
27024
+ * The template identifier
27025
+ */
27026
+ readonly templateId: string
27027
+ }
27028
+
27029
+ /**
27030
+ * Request parameters for getAnnouncementTemplates operation in AnnouncementsTemplatesApi.
27031
+ */
27032
+ export interface AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest {
27033
+ /**
27034
+ * Page number
27035
+ */
27036
+ readonly page?: number
27037
+
27038
+ /**
27039
+ * Number of items per page
27040
+ */
27041
+ readonly pageSize?: number
27042
+
27043
+ /**
27044
+ * Field to order by
27045
+ */
27046
+ readonly orderBy?: string
27047
+
27048
+ /**
27049
+ * Search query
27050
+ */
27051
+ readonly search?: string
27052
+ }
27053
+
27054
+ /**
27055
+ * Request parameters for updateAnnouncementTemplate operation in AnnouncementsTemplatesApi.
27056
+ */
27057
+ export interface AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest {
27058
+ /**
27059
+ * The template identifier
27060
+ */
27061
+ readonly templateId: string
27062
+
27063
+ readonly announcementTemplateUpdateInputs: AnnouncementTemplateUpdateInputs
27064
+ }
27065
+
27066
+ /**
27067
+ * AnnouncementsTemplatesApi - object-oriented interface
27068
+ */
27069
+ export class AnnouncementsTemplatesApi extends BaseAPI {
27070
+ /**
27071
+ * Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
27072
+ * @summary Create an announcement template
27073
+ * @param {AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest} requestParameters Request parameters.
27074
+ * @param {*} [options] Override http request option.
27075
+ * @throws {RequiredError}
27076
+ */
27077
+ public createAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig) {
27078
+ return AnnouncementsTemplatesApiFp(this.configuration).createAnnouncementTemplate(requestParameters.announcementTemplateCreateInputs, options).then((request) => request(this.axios, this.basePath));
27079
+ }
27080
+
27081
+ /**
27082
+ * Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
27083
+ * @summary Delete an announcement template
27084
+ * @param {AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest} requestParameters Request parameters.
27085
+ * @param {*} [options] Override http request option.
27086
+ * @throws {RequiredError}
27087
+ */
27088
+ public deleteAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest, options?: RawAxiosRequestConfig) {
27089
+ return AnnouncementsTemplatesApiFp(this.configuration).deleteAnnouncementTemplate(requestParameters.templateId, options).then((request) => request(this.axios, this.basePath));
27090
+ }
27091
+
27092
+ /**
27093
+ * Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
27094
+ * @summary Get an announcement template
27095
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplateRequest} requestParameters Request parameters.
27096
+ * @param {*} [options] Override http request option.
27097
+ * @throws {RequiredError}
27098
+ */
27099
+ public getAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiGetAnnouncementTemplateRequest, options?: RawAxiosRequestConfig) {
27100
+ return AnnouncementsTemplatesApiFp(this.configuration).getAnnouncementTemplate(requestParameters.templateId, options).then((request) => request(this.axios, this.basePath));
27101
+ }
27102
+
27103
+ /**
27104
+ * Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
27105
+ * @summary List announcement templates
27106
+ * @param {AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest} requestParameters Request parameters.
27107
+ * @param {*} [options] Override http request option.
27108
+ * @throws {RequiredError}
27109
+ */
27110
+ public getAnnouncementTemplates(requestParameters: AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest = {}, options?: RawAxiosRequestConfig) {
27111
+ return AnnouncementsTemplatesApiFp(this.configuration).getAnnouncementTemplates(requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
27112
+ }
27113
+
27114
+ /**
27115
+ * 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.
27116
+ * @summary Update an announcement template
27117
+ * @param {AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest} requestParameters Request parameters.
27118
+ * @param {*} [options] Override http request option.
27119
+ * @throws {RequiredError}
27120
+ */
27121
+ public updateAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig) {
27122
+ return AnnouncementsTemplatesApiFp(this.configuration).updateAnnouncementTemplate(requestParameters.templateId, requestParameters.announcementTemplateUpdateInputs, options).then((request) => request(this.axios, this.basePath));
27123
+ }
27124
+ }
27125
+
27126
+
27127
+
27128
+ /**
27129
+ * AnnouncementsTemplatesTranslationsApi - axios parameter creator
27130
+ */
27131
+ export const AnnouncementsTemplatesTranslationsApiAxiosParamCreator = function (configuration?: Configuration) {
27132
+ return {
27133
+ /**
27134
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
27135
+ * @summary Delete an announcement template translation
27136
+ * @param {string} templateId The template identifier
27137
+ * @param {string} locale The locale identifier
27138
+ * @param {*} [options] Override http request option.
27139
+ * @throws {RequiredError}
27140
+ */
27141
+ deleteAnnouncementTemplateTranslation: async (templateId: string, locale: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
27142
+ // verify required parameter 'templateId' is not null or undefined
27143
+ assertParamExists('deleteAnnouncementTemplateTranslation', 'templateId', templateId)
27144
+ // verify required parameter 'locale' is not null or undefined
27145
+ assertParamExists('deleteAnnouncementTemplateTranslation', 'locale', locale)
27146
+ const localVarPath = `/announcements/templates/{templateId}/translations/{locale}`
27147
+ .replace('{templateId}', encodeURIComponent(String(templateId)))
27148
+ .replace('{locale}', encodeURIComponent(String(locale)));
27149
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
27150
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
27151
+ let baseOptions;
27152
+ if (configuration) {
27153
+ baseOptions = configuration.baseOptions;
27154
+ }
27155
+
27156
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
27157
+ const localVarHeaderParameter = {} as any;
27158
+ const localVarQueryParameter = {} as any;
27159
+
27160
+ // authentication ApiKeyAuth required
27161
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
27162
+
27163
+ // authentication OrganizationId required
27164
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
27165
+
27166
+ localVarHeaderParameter['Accept'] = 'application/json';
27167
+
27168
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
27169
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
27170
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
27171
+
27172
+ return {
27173
+ url: toPathString(localVarUrlObj),
27174
+ options: localVarRequestOptions,
27175
+ };
27176
+ },
27177
+ /**
27178
+ * 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.
27179
+ * @summary Get an announcement template\'s translation for a locale
27180
+ * @param {string} templateId The template identifier
27181
+ * @param {string} locale The locale identifier
27182
+ * @param {*} [options] Override http request option.
27183
+ * @throws {RequiredError}
27184
+ */
27185
+ getAnnouncementTemplateTranslation: async (templateId: string, locale: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
27186
+ // verify required parameter 'templateId' is not null or undefined
27187
+ assertParamExists('getAnnouncementTemplateTranslation', 'templateId', templateId)
27188
+ // verify required parameter 'locale' is not null or undefined
27189
+ assertParamExists('getAnnouncementTemplateTranslation', 'locale', locale)
27190
+ const localVarPath = `/announcements/templates/{templateId}/translations/{locale}`
27191
+ .replace('{templateId}', encodeURIComponent(String(templateId)))
27192
+ .replace('{locale}', encodeURIComponent(String(locale)));
27193
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
27194
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
27195
+ let baseOptions;
27196
+ if (configuration) {
27197
+ baseOptions = configuration.baseOptions;
27198
+ }
27199
+
27200
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
27201
+ const localVarHeaderParameter = {} as any;
27202
+ const localVarQueryParameter = {} as any;
27203
+
27204
+ // authentication ApiKeyAuth required
27205
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
27206
+
27207
+ // authentication OrganizationId required
27208
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
27209
+
27210
+ localVarHeaderParameter['Accept'] = 'application/json';
27211
+
27212
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
27213
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
27214
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
27215
+
27216
+ return {
27217
+ url: toPathString(localVarUrlObj),
27218
+ options: localVarRequestOptions,
27219
+ };
27220
+ },
27221
+ /**
27222
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
27223
+ * @summary List an announcement template\'s translations
27224
+ * @param {string} templateId The template identifier
27225
+ * @param {number} [page] Page number
27226
+ * @param {number} [pageSize] Number of items per page
27227
+ * @param {string} [orderBy] Field to order by
27228
+ * @param {string} [search] Search query
27229
+ * @param {*} [options] Override http request option.
27230
+ * @throws {RequiredError}
27231
+ */
27232
+ getAnnouncementTemplateTranslations: async (templateId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
27233
+ // verify required parameter 'templateId' is not null or undefined
27234
+ assertParamExists('getAnnouncementTemplateTranslations', 'templateId', templateId)
27235
+ const localVarPath = `/announcements/templates/{templateId}/translations`
27236
+ .replace('{templateId}', encodeURIComponent(String(templateId)));
27237
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
27238
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
27239
+ let baseOptions;
27240
+ if (configuration) {
27241
+ baseOptions = configuration.baseOptions;
27242
+ }
27243
+
27244
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
27245
+ const localVarHeaderParameter = {} as any;
27246
+ const localVarQueryParameter = {} as any;
27247
+
27248
+ // authentication ApiKeyAuth required
27249
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
27250
+
27251
+ // authentication OrganizationId required
27252
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
27253
+
27254
+ if (page !== undefined) {
27255
+ localVarQueryParameter['page'] = page;
27256
+ }
27257
+
27258
+ if (pageSize !== undefined) {
27259
+ localVarQueryParameter['pageSize'] = pageSize;
27260
+ }
27261
+
27262
+ if (orderBy !== undefined) {
27263
+ localVarQueryParameter['orderBy'] = orderBy;
27264
+ }
27265
+
27266
+ if (search !== undefined) {
27267
+ localVarQueryParameter['search'] = search;
27268
+ }
27269
+
27270
+ localVarHeaderParameter['Accept'] = 'application/json';
27271
+
27272
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
27273
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
27274
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
27275
+
27276
+ return {
27277
+ url: toPathString(localVarUrlObj),
27278
+ options: localVarRequestOptions,
27279
+ };
27280
+ },
27281
+ /**
27282
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
27283
+ * @summary Update an announcement template translation
27284
+ * @param {string} templateId The template identifier
27285
+ * @param {string} locale The locale identifier
27286
+ * @param {AnnouncementTemplateTranslationUpdateInputs} announcementTemplateTranslationUpdateInputs
27287
+ * @param {*} [options] Override http request option.
27288
+ * @throws {RequiredError}
27289
+ */
27290
+ updateAnnouncementTemplateTranslation: async (templateId: string, locale: string, announcementTemplateTranslationUpdateInputs: AnnouncementTemplateTranslationUpdateInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
27291
+ // verify required parameter 'templateId' is not null or undefined
27292
+ assertParamExists('updateAnnouncementTemplateTranslation', 'templateId', templateId)
27293
+ // verify required parameter 'locale' is not null or undefined
27294
+ assertParamExists('updateAnnouncementTemplateTranslation', 'locale', locale)
27295
+ // verify required parameter 'announcementTemplateTranslationUpdateInputs' is not null or undefined
27296
+ assertParamExists('updateAnnouncementTemplateTranslation', 'announcementTemplateTranslationUpdateInputs', announcementTemplateTranslationUpdateInputs)
27297
+ const localVarPath = `/announcements/templates/{templateId}/translations/{locale}`
27298
+ .replace('{templateId}', encodeURIComponent(String(templateId)))
27299
+ .replace('{locale}', encodeURIComponent(String(locale)));
27300
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
27301
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
27302
+ let baseOptions;
27303
+ if (configuration) {
27304
+ baseOptions = configuration.baseOptions;
27305
+ }
27306
+
27307
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
27308
+ const localVarHeaderParameter = {} as any;
27309
+ const localVarQueryParameter = {} as any;
27310
+
27311
+ // authentication ApiKeyAuth required
27312
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
27313
+
27314
+ // authentication OrganizationId required
27315
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
27316
+
27317
+ localVarHeaderParameter['Content-Type'] = 'application/json';
27318
+ localVarHeaderParameter['Accept'] = 'application/json';
27319
+
27320
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
27321
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
27322
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
27323
+ localVarRequestOptions.data = serializeDataIfNeeded(announcementTemplateTranslationUpdateInputs, localVarRequestOptions, configuration)
27324
+
27325
+ return {
27326
+ url: toPathString(localVarUrlObj),
27327
+ options: localVarRequestOptions,
27328
+ };
27329
+ },
27330
+ }
27331
+ };
27332
+
27333
+ /**
27334
+ * AnnouncementsTemplatesTranslationsApi - functional programming interface
27335
+ */
27336
+ export const AnnouncementsTemplatesTranslationsApiFp = function(configuration?: Configuration) {
27337
+ const localVarAxiosParamCreator = AnnouncementsTemplatesTranslationsApiAxiosParamCreator(configuration)
27338
+ return {
27339
+ /**
27340
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
27341
+ * @summary Delete an announcement template translation
27342
+ * @param {string} templateId The template identifier
27343
+ * @param {string} locale The locale identifier
24859
27344
  * @param {*} [options] Override http request option.
24860
27345
  * @throws {RequiredError}
24861
27346
  */
24862
- cancelAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiCancelAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncement200Response> {
24863
- return localVarFp.cancelAnnouncementSchedule(requestParameters.announcementId, options).then((request) => request(axios, basePath));
27347
+ async deleteAnnouncementTemplateTranslation(templateId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
27348
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteAnnouncementTemplateTranslation(templateId, locale, options);
27349
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
27350
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsTemplatesTranslationsApi.deleteAnnouncementTemplateTranslation']?.[localVarOperationServerIndex]?.url;
27351
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
24864
27352
  },
24865
27353
  /**
24866
- * 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.
24867
- * @summary Schedule or reschedule an announcement send
24868
- * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
27354
+ * 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.
27355
+ * @summary Get an announcement template\'s translation for a locale
27356
+ * @param {string} templateId The template identifier
27357
+ * @param {string} locale The locale identifier
24869
27358
  * @param {*} [options] Override http request option.
24870
27359
  * @throws {RequiredError}
24871
27360
  */
24872
- updateAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncement200Response> {
24873
- return localVarFp.updateAnnouncementSchedule(requestParameters.announcementId, requestParameters.body, options).then((request) => request(axios, basePath));
27361
+ async getAnnouncementTemplateTranslation(templateId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementTemplateTranslation200Response>> {
27362
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementTemplateTranslation(templateId, locale, options);
27363
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
27364
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsTemplatesTranslationsApi.getAnnouncementTemplateTranslation']?.[localVarOperationServerIndex]?.url;
27365
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
27366
+ },
27367
+ /**
27368
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
27369
+ * @summary List an announcement template\'s translations
27370
+ * @param {string} templateId The template identifier
27371
+ * @param {number} [page] Page number
27372
+ * @param {number} [pageSize] Number of items per page
27373
+ * @param {string} [orderBy] Field to order by
27374
+ * @param {string} [search] Search query
27375
+ * @param {*} [options] Override http request option.
27376
+ * @throws {RequiredError}
27377
+ */
27378
+ async getAnnouncementTemplateTranslations(templateId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementTemplateTranslations200Response>> {
27379
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAnnouncementTemplateTranslations(templateId, page, pageSize, orderBy, search, options);
27380
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
27381
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsTemplatesTranslationsApi.getAnnouncementTemplateTranslations']?.[localVarOperationServerIndex]?.url;
27382
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
27383
+ },
27384
+ /**
27385
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
27386
+ * @summary Update an announcement template translation
27387
+ * @param {string} templateId The template identifier
27388
+ * @param {string} locale The locale identifier
27389
+ * @param {AnnouncementTemplateTranslationUpdateInputs} announcementTemplateTranslationUpdateInputs
27390
+ * @param {*} [options] Override http request option.
27391
+ * @throws {RequiredError}
27392
+ */
27393
+ async updateAnnouncementTemplateTranslation(templateId: string, locale: string, announcementTemplateTranslationUpdateInputs: AnnouncementTemplateTranslationUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateAnnouncementTemplateTranslation200Response>> {
27394
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateAnnouncementTemplateTranslation(templateId, locale, announcementTemplateTranslationUpdateInputs, options);
27395
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
27396
+ const localVarOperationServerBasePath = operationServerMap['AnnouncementsTemplatesTranslationsApi.updateAnnouncementTemplateTranslation']?.[localVarOperationServerIndex]?.url;
27397
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
27398
+ },
27399
+ }
27400
+ };
27401
+
27402
+ /**
27403
+ * AnnouncementsTemplatesTranslationsApi - factory interface
27404
+ */
27405
+ export const AnnouncementsTemplatesTranslationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
27406
+ const localVarFp = AnnouncementsTemplatesTranslationsApiFp(configuration)
27407
+ return {
27408
+ /**
27409
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
27410
+ * @summary Delete an announcement template translation
27411
+ * @param {AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
27412
+ * @param {*} [options] Override http request option.
27413
+ * @throws {RequiredError}
27414
+ */
27415
+ deleteAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
27416
+ return localVarFp.deleteAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, options).then((request) => request(axios, basePath));
27417
+ },
27418
+ /**
27419
+ * 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.
27420
+ * @summary Get an announcement template\'s translation for a locale
27421
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
27422
+ * @param {*} [options] Override http request option.
27423
+ * @throws {RequiredError}
27424
+ */
27425
+ getAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementTemplateTranslation200Response> {
27426
+ return localVarFp.getAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, options).then((request) => request(axios, basePath));
27427
+ },
27428
+ /**
27429
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
27430
+ * @summary List an announcement template\'s translations
27431
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest} requestParameters Request parameters.
27432
+ * @param {*} [options] Override http request option.
27433
+ * @throws {RequiredError}
27434
+ */
27435
+ getAnnouncementTemplateTranslations(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementTemplateTranslations200Response> {
27436
+ return localVarFp.getAnnouncementTemplateTranslations(requestParameters.templateId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
27437
+ },
27438
+ /**
27439
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
27440
+ * @summary Update an announcement template translation
27441
+ * @param {AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
27442
+ * @param {*} [options] Override http request option.
27443
+ * @throws {RequiredError}
27444
+ */
27445
+ updateAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateAnnouncementTemplateTranslation200Response> {
27446
+ return localVarFp.updateAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, requestParameters.announcementTemplateTranslationUpdateInputs, options).then((request) => request(axios, basePath));
24874
27447
  },
24875
27448
  };
24876
27449
  };
24877
27450
 
24878
27451
  /**
24879
- * Request parameters for cancelAnnouncementSchedule operation in AnnouncementsScheduleApi.
27452
+ * Request parameters for deleteAnnouncementTemplateTranslation operation in AnnouncementsTemplatesTranslationsApi.
24880
27453
  */
24881
- export interface AnnouncementsScheduleApiCancelAnnouncementScheduleRequest {
27454
+ export interface AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest {
24882
27455
  /**
24883
- * The announcement identifier
27456
+ * The template identifier
24884
27457
  */
24885
- readonly announcementId: string
27458
+ readonly templateId: string
27459
+
27460
+ /**
27461
+ * The locale identifier
27462
+ */
27463
+ readonly locale: string
24886
27464
  }
24887
27465
 
24888
27466
  /**
24889
- * Request parameters for updateAnnouncementSchedule operation in AnnouncementsScheduleApi.
27467
+ * Request parameters for getAnnouncementTemplateTranslation operation in AnnouncementsTemplatesTranslationsApi.
24890
27468
  */
24891
- export interface AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest {
27469
+ export interface AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest {
24892
27470
  /**
24893
- * The announcement identifier
27471
+ * The template identifier
24894
27472
  */
24895
- readonly announcementId: string
27473
+ readonly templateId: string
24896
27474
 
24897
- readonly body: object
27475
+ /**
27476
+ * The locale identifier
27477
+ */
27478
+ readonly locale: string
24898
27479
  }
24899
27480
 
24900
27481
  /**
24901
- * AnnouncementsScheduleApi - object-oriented interface
27482
+ * Request parameters for getAnnouncementTemplateTranslations operation in AnnouncementsTemplatesTranslationsApi.
24902
27483
  */
24903
- export class AnnouncementsScheduleApi extends BaseAPI {
27484
+ export interface AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest {
24904
27485
  /**
24905
- * Cancels a previously scheduled send for the given announcement, removing its scheduled notification so it will not go out; requires update permission on announcements.
24906
- * @summary Cancel an announcement\'s scheduled send
24907
- * @param {AnnouncementsScheduleApiCancelAnnouncementScheduleRequest} requestParameters Request parameters.
27486
+ * The template identifier
27487
+ */
27488
+ readonly templateId: string
27489
+
27490
+ /**
27491
+ * Page number
27492
+ */
27493
+ readonly page?: number
27494
+
27495
+ /**
27496
+ * Number of items per page
27497
+ */
27498
+ readonly pageSize?: number
27499
+
27500
+ /**
27501
+ * Field to order by
27502
+ */
27503
+ readonly orderBy?: string
27504
+
27505
+ /**
27506
+ * Search query
27507
+ */
27508
+ readonly search?: string
27509
+ }
27510
+
27511
+ /**
27512
+ * Request parameters for updateAnnouncementTemplateTranslation operation in AnnouncementsTemplatesTranslationsApi.
27513
+ */
27514
+ export interface AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest {
27515
+ /**
27516
+ * The template identifier
27517
+ */
27518
+ readonly templateId: string
27519
+
27520
+ /**
27521
+ * The locale identifier
27522
+ */
27523
+ readonly locale: string
27524
+
27525
+ readonly announcementTemplateTranslationUpdateInputs: AnnouncementTemplateTranslationUpdateInputs
27526
+ }
27527
+
27528
+ /**
27529
+ * AnnouncementsTemplatesTranslationsApi - object-oriented interface
27530
+ */
27531
+ export class AnnouncementsTemplatesTranslationsApi extends BaseAPI {
27532
+ /**
27533
+ * Removes the translation of a template in the specified locale; requires update permission on announcements.
27534
+ * @summary Delete an announcement template translation
27535
+ * @param {AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
24908
27536
  * @param {*} [options] Override http request option.
24909
27537
  * @throws {RequiredError}
24910
27538
  */
24911
- public cancelAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiCancelAnnouncementScheduleRequest, options?: RawAxiosRequestConfig) {
24912
- return AnnouncementsScheduleApiFp(this.configuration).cancelAnnouncementSchedule(requestParameters.announcementId, options).then((request) => request(this.axios, this.basePath));
27539
+ public deleteAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig) {
27540
+ return AnnouncementsTemplatesTranslationsApiFp(this.configuration).deleteAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
24913
27541
  }
24914
27542
 
24915
27543
  /**
24916
- * 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.
24917
- * @summary Schedule or reschedule an announcement send
24918
- * @param {AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest} requestParameters Request parameters.
27544
+ * 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.
27545
+ * @summary Get an announcement template\'s translation for a locale
27546
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
24919
27547
  * @param {*} [options] Override http request option.
24920
27548
  * @throws {RequiredError}
24921
27549
  */
24922
- public updateAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest, options?: RawAxiosRequestConfig) {
24923
- return AnnouncementsScheduleApiFp(this.configuration).updateAnnouncementSchedule(requestParameters.announcementId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
27550
+ public getAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig) {
27551
+ return AnnouncementsTemplatesTranslationsApiFp(this.configuration).getAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
27552
+ }
27553
+
27554
+ /**
27555
+ * Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
27556
+ * @summary List an announcement template\'s translations
27557
+ * @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest} requestParameters Request parameters.
27558
+ * @param {*} [options] Override http request option.
27559
+ * @throws {RequiredError}
27560
+ */
27561
+ public getAnnouncementTemplateTranslations(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest, options?: RawAxiosRequestConfig) {
27562
+ return AnnouncementsTemplatesTranslationsApiFp(this.configuration).getAnnouncementTemplateTranslations(requestParameters.templateId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
27563
+ }
27564
+
27565
+ /**
27566
+ * Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
27567
+ * @summary Update an announcement template translation
27568
+ * @param {AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
27569
+ * @param {*} [options] Override http request option.
27570
+ * @throws {RequiredError}
27571
+ */
27572
+ public updateAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig) {
27573
+ return AnnouncementsTemplatesTranslationsApiFp(this.configuration).updateAnnouncementTemplateTranslation(requestParameters.templateId, requestParameters.locale, requestParameters.announcementTemplateTranslationUpdateInputs, options).then((request) => request(this.axios, this.basePath));
24924
27574
  }
24925
27575
  }
24926
27576