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