@connectedxm/admin-sdk 11.23.0 → 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 +2923 -374
- 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 +1558 -155
- package/dist/api.js +2127 -324
- 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 +1558 -155
- package/dist/esm/api.js +2081 -291
- 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/LoginsApi.md +3 -58
- package/docs/SendAnnouncementPreviewRequest.md +20 -0
- package/docs/UpdateAnnouncementTemplateTranslation200Response.md +24 -0
- package/package.json +1 -1
- package/docs/EventAnnouncementFilters.md +0 -30
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 12.0.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -637,56 +637,304 @@ export interface Announcement {
|
|
|
637
637
|
'push': boolean;
|
|
638
638
|
'sms': boolean;
|
|
639
639
|
'includePasses': boolean;
|
|
640
|
-
'accountId': string | null;
|
|
641
640
|
'creatorId': string | null;
|
|
642
641
|
'eventId': string | null;
|
|
643
642
|
'groupId': string | null;
|
|
644
|
-
'
|
|
645
|
-
'channelId': string | null;
|
|
646
|
-
'ticketId': string | null;
|
|
643
|
+
'audienceId': string | null;
|
|
647
644
|
'userId': string | null;
|
|
648
645
|
'schedule': BaseSchedule;
|
|
646
|
+
'sentAt': string | null;
|
|
647
|
+
'recipientCount': number | null;
|
|
649
648
|
'createdAt': string;
|
|
650
|
-
'verifiedAccounts': boolean;
|
|
651
|
-
'account': BaseAccount | null;
|
|
652
649
|
'creator': BaseAccount | null;
|
|
653
650
|
'event': BaseEvent | null;
|
|
654
651
|
'group': BaseGroup | null;
|
|
655
|
-
'
|
|
656
|
-
'
|
|
657
|
-
'sponsorshipLevelId': string | null;
|
|
658
|
-
'sponsorshipLevel': BaseLevel | null;
|
|
659
|
-
'ticket': BaseEventPassType | null;
|
|
652
|
+
'audience': AnnouncementAudienceReference | null;
|
|
653
|
+
'audienceSnapshot': AnnouncementAudience | null;
|
|
660
654
|
'user': BaseUser | null;
|
|
661
655
|
'message': string | null;
|
|
662
|
-
'filters': EventAnnouncementFilters | null;
|
|
663
656
|
'updatedAt': string;
|
|
664
657
|
}
|
|
665
|
-
export interface
|
|
666
|
-
'
|
|
667
|
-
'
|
|
668
|
-
'
|
|
669
|
-
'
|
|
658
|
+
export interface AnnouncementAudience {
|
|
659
|
+
'id': string;
|
|
660
|
+
'name': string;
|
|
661
|
+
'description': string | null;
|
|
662
|
+
'eventId': string | null;
|
|
663
|
+
'groupId': string | null;
|
|
664
|
+
'channelId': string | null;
|
|
665
|
+
'operator': AnnouncementAudienceOperator;
|
|
666
|
+
'createdAt': string;
|
|
667
|
+
'updatedAt': string;
|
|
668
|
+
'event': AnnouncementAudienceConditionEvent | null;
|
|
669
|
+
'group': AnnouncementAudienceConditionEvent | null;
|
|
670
|
+
'channel': AnnouncementAudienceConditionEvent | null;
|
|
671
|
+
'filters': Array<AnnouncementAudienceFilter>;
|
|
672
|
+
}
|
|
673
|
+
export interface AnnouncementAudienceCondition {
|
|
674
|
+
'id': string;
|
|
675
|
+
'filterId': string;
|
|
676
|
+
'type': AnnouncementAudienceConditionType;
|
|
677
|
+
'negate': boolean;
|
|
678
|
+
'sortOrder': number;
|
|
679
|
+
'eventId': string | null;
|
|
680
|
+
'event': AnnouncementAudienceConditionEvent | null;
|
|
681
|
+
'passTypeId': string | null;
|
|
682
|
+
'passType': AnnouncementAudienceConditionReference | null;
|
|
683
|
+
'addOnId': string | null;
|
|
684
|
+
'addOn': AnnouncementAudienceConditionReference | null;
|
|
685
|
+
'sessionId': string | null;
|
|
686
|
+
'session': AnnouncementAudienceConditionReference | null;
|
|
687
|
+
'roomTypeId': string | null;
|
|
688
|
+
'roomType': AnnouncementAudienceConditionReference | null;
|
|
689
|
+
'questionId': string | null;
|
|
690
|
+
'question': AnnouncementAudienceConditionQuestion | null;
|
|
691
|
+
'choiceId': string | null;
|
|
692
|
+
'choice': AnnouncementAudienceConditionChoice | null;
|
|
693
|
+
'passAttributeId': string | null;
|
|
694
|
+
'passAttribute': AnnouncementAudienceConditionReference | null;
|
|
695
|
+
'tierId': string | null;
|
|
696
|
+
'tier': AnnouncementAudienceConditionReference | null;
|
|
697
|
+
'groupId': string | null;
|
|
698
|
+
'group': AnnouncementAudienceConditionReference | null;
|
|
699
|
+
'groupRole': GroupMembershipRole | null;
|
|
700
|
+
'channelId': string | null;
|
|
701
|
+
'channel': AnnouncementAudienceConditionReference | null;
|
|
702
|
+
'sponsorshipLevelId': string | null;
|
|
703
|
+
'sponsorshipLevel': AnnouncementAudienceConditionReference | null;
|
|
704
|
+
'seriesId': string | null;
|
|
705
|
+
'series': AnnouncementAudienceConditionReference | null;
|
|
706
|
+
'accountAttributeId': string | null;
|
|
707
|
+
'accountAttribute': AnnouncementAudienceConditionAccountAttribute | null;
|
|
708
|
+
'accountId': string | null;
|
|
709
|
+
'account': BaseAccount | null;
|
|
710
|
+
'comparator': AnnouncementAudienceConditionComparator | null;
|
|
711
|
+
'value': string | null;
|
|
712
|
+
'createdAt': string;
|
|
713
|
+
'updatedAt': string;
|
|
714
|
+
}
|
|
715
|
+
export interface AnnouncementAudienceConditionAccountAttribute {
|
|
716
|
+
'id': string;
|
|
717
|
+
'name': string;
|
|
718
|
+
'label': string;
|
|
719
|
+
'type': AccountAttributeType;
|
|
720
|
+
}
|
|
721
|
+
export interface AnnouncementAudienceConditionChoice {
|
|
722
|
+
'id': string;
|
|
723
|
+
'value': string;
|
|
724
|
+
}
|
|
725
|
+
export declare enum AnnouncementAudienceConditionComparator {
|
|
726
|
+
Equals = "equals",
|
|
727
|
+
Contains = "contains",
|
|
728
|
+
IsSet = "isSet",
|
|
729
|
+
NotSet = "notSet"
|
|
730
|
+
}
|
|
731
|
+
export interface AnnouncementAudienceConditionCreateInputs {
|
|
732
|
+
'negate'?: boolean;
|
|
733
|
+
'sortOrder'?: number | null;
|
|
670
734
|
'eventId'?: string | null;
|
|
735
|
+
'passTypeId'?: string | null;
|
|
736
|
+
'addOnId'?: string | null;
|
|
737
|
+
'sessionId'?: string | null;
|
|
738
|
+
'roomTypeId'?: string | null;
|
|
739
|
+
'questionId'?: string | null;
|
|
740
|
+
'choiceId'?: string | null;
|
|
741
|
+
'passAttributeId'?: string | null;
|
|
742
|
+
'tierId'?: string | null;
|
|
671
743
|
'groupId'?: string | null;
|
|
744
|
+
'groupRole'?: GroupMembershipRole | null;
|
|
745
|
+
'channelId'?: string | null;
|
|
746
|
+
'sponsorshipLevelId'?: string | null;
|
|
747
|
+
'seriesId'?: string | null;
|
|
748
|
+
'accountAttributeId'?: string | null;
|
|
749
|
+
'accountId'?: string | null;
|
|
750
|
+
'comparator'?: AnnouncementAudienceConditionComparator | null;
|
|
751
|
+
'value'?: string | null;
|
|
752
|
+
'type': AnnouncementAudienceConditionType;
|
|
753
|
+
}
|
|
754
|
+
export interface AnnouncementAudienceConditionEvent {
|
|
755
|
+
'id': string;
|
|
756
|
+
'slug': string;
|
|
757
|
+
'name': string;
|
|
758
|
+
}
|
|
759
|
+
export interface AnnouncementAudienceConditionInputs {
|
|
760
|
+
'negate'?: boolean;
|
|
761
|
+
'sortOrder'?: number | null;
|
|
762
|
+
'eventId'?: string | null;
|
|
763
|
+
'passTypeId'?: string | null;
|
|
764
|
+
'addOnId'?: string | null;
|
|
765
|
+
'sessionId'?: string | null;
|
|
766
|
+
'roomTypeId'?: string | null;
|
|
767
|
+
'questionId'?: string | null;
|
|
768
|
+
'choiceId'?: string | null;
|
|
769
|
+
'passAttributeId'?: string | null;
|
|
672
770
|
'tierId'?: string | null;
|
|
771
|
+
'groupId'?: string | null;
|
|
772
|
+
'groupRole'?: GroupMembershipRole | null;
|
|
673
773
|
'channelId'?: string | null;
|
|
774
|
+
'sponsorshipLevelId'?: string | null;
|
|
775
|
+
'seriesId'?: string | null;
|
|
776
|
+
'accountAttributeId'?: string | null;
|
|
674
777
|
'accountId'?: string | null;
|
|
675
|
-
'
|
|
778
|
+
'comparator'?: AnnouncementAudienceConditionComparator | null;
|
|
779
|
+
'value'?: string | null;
|
|
780
|
+
}
|
|
781
|
+
export interface AnnouncementAudienceConditionQuestion {
|
|
782
|
+
'id': string;
|
|
783
|
+
'name': string;
|
|
784
|
+
'label': string | null;
|
|
785
|
+
}
|
|
786
|
+
export interface AnnouncementAudienceConditionReference {
|
|
787
|
+
'id': string;
|
|
788
|
+
'name': string;
|
|
789
|
+
}
|
|
790
|
+
export declare enum AnnouncementAudienceConditionType {
|
|
791
|
+
EventPass = "eventPass",
|
|
792
|
+
EventPassType = "eventPassType",
|
|
793
|
+
EventCheckedIn = "eventCheckedIn",
|
|
794
|
+
EventAddOn = "eventAddOn",
|
|
795
|
+
EventSessionAccess = "eventSessionAccess",
|
|
796
|
+
EventSessionCheckedIn = "eventSessionCheckedIn",
|
|
797
|
+
EventRoomType = "eventRoomType",
|
|
798
|
+
EventQuestionChoice = "eventQuestionChoice",
|
|
799
|
+
EventPassAttribute = "eventPassAttribute",
|
|
800
|
+
Tier = "tier",
|
|
801
|
+
Group = "group",
|
|
802
|
+
Channel = "channel",
|
|
803
|
+
SponsorshipLevel = "sponsorshipLevel",
|
|
804
|
+
Series = "series",
|
|
805
|
+
AccountAttribute = "accountAttribute",
|
|
806
|
+
Verified = "verified",
|
|
807
|
+
Account = "account"
|
|
808
|
+
}
|
|
809
|
+
export interface AnnouncementAudienceConditionUpdateInputs {
|
|
810
|
+
'negate'?: boolean;
|
|
811
|
+
'sortOrder'?: number | null;
|
|
812
|
+
'eventId'?: string | null;
|
|
813
|
+
'passTypeId'?: string | null;
|
|
814
|
+
'addOnId'?: string | null;
|
|
815
|
+
'sessionId'?: string | null;
|
|
816
|
+
'roomTypeId'?: string | null;
|
|
817
|
+
'questionId'?: string | null;
|
|
818
|
+
'choiceId'?: string | null;
|
|
819
|
+
'passAttributeId'?: string | null;
|
|
820
|
+
'tierId'?: string | null;
|
|
821
|
+
'groupId'?: string | null;
|
|
822
|
+
'groupRole'?: GroupMembershipRole | null;
|
|
823
|
+
'channelId'?: string | null;
|
|
676
824
|
'sponsorshipLevelId'?: string | null;
|
|
825
|
+
'seriesId'?: string | null;
|
|
826
|
+
'accountAttributeId'?: string | null;
|
|
827
|
+
'accountId'?: string | null;
|
|
828
|
+
'comparator'?: AnnouncementAudienceConditionComparator | null;
|
|
829
|
+
'value'?: string | null;
|
|
830
|
+
'type'?: AnnouncementAudienceConditionType;
|
|
831
|
+
}
|
|
832
|
+
export interface AnnouncementAudienceCreateInputs {
|
|
833
|
+
'name': string;
|
|
834
|
+
'description'?: string | null;
|
|
835
|
+
'eventId'?: string | null;
|
|
836
|
+
'groupId'?: string | null;
|
|
837
|
+
'channelId'?: string | null;
|
|
838
|
+
'operator'?: AnnouncementAudienceOperator;
|
|
839
|
+
}
|
|
840
|
+
export interface AnnouncementAudienceFilter {
|
|
841
|
+
'id': string;
|
|
842
|
+
'parentFilterId': string | null;
|
|
843
|
+
'operator': AnnouncementAudienceOperator;
|
|
844
|
+
'sortOrder': number;
|
|
845
|
+
'conditions': Array<AnnouncementAudienceCondition>;
|
|
846
|
+
'createdAt': string;
|
|
847
|
+
'updatedAt': string;
|
|
848
|
+
}
|
|
849
|
+
export interface AnnouncementAudienceFilterCreateInputs {
|
|
850
|
+
'parentFilterId'?: string | null;
|
|
851
|
+
'operator'?: AnnouncementAudienceOperator;
|
|
852
|
+
'sortOrder'?: number | null;
|
|
853
|
+
}
|
|
854
|
+
export interface AnnouncementAudienceFilterUpdateInputs {
|
|
855
|
+
'operator'?: AnnouncementAudienceOperator;
|
|
856
|
+
'sortOrder'?: number | null;
|
|
857
|
+
}
|
|
858
|
+
export declare enum AnnouncementAudienceOperator {
|
|
859
|
+
And = "AND",
|
|
860
|
+
Or = "OR"
|
|
861
|
+
}
|
|
862
|
+
export interface AnnouncementAudienceReference {
|
|
863
|
+
'id': string;
|
|
864
|
+
'name': string;
|
|
865
|
+
'eventId': string | null;
|
|
866
|
+
'groupId': string | null;
|
|
867
|
+
}
|
|
868
|
+
export interface AnnouncementAudienceScope {
|
|
869
|
+
'eventId'?: string;
|
|
870
|
+
'groupId'?: string;
|
|
871
|
+
'channelId'?: string;
|
|
872
|
+
}
|
|
873
|
+
export interface AnnouncementAudienceUpdateInputs {
|
|
874
|
+
'name'?: string;
|
|
875
|
+
'description'?: string | null;
|
|
876
|
+
'operator'?: AnnouncementAudienceOperator;
|
|
877
|
+
}
|
|
878
|
+
export interface AnnouncementCreateInputs {
|
|
879
|
+
'title'?: string | null;
|
|
880
|
+
'html'?: string | null;
|
|
881
|
+
'templateId'?: string | null;
|
|
882
|
+
'slug'?: string | null;
|
|
883
|
+
'creatorId'?: string | null;
|
|
884
|
+
'eventId'?: string | null;
|
|
885
|
+
'groupId'?: string | null;
|
|
886
|
+
'audienceId'?: string | null;
|
|
677
887
|
'email'?: boolean;
|
|
678
888
|
'push'?: boolean;
|
|
679
|
-
'filters'?: EventAnnouncementFilters | null;
|
|
680
889
|
'includePasses'?: boolean;
|
|
681
890
|
}
|
|
682
891
|
export interface AnnouncementFilters {
|
|
683
|
-
'verifiedAccounts'?: boolean;
|
|
684
892
|
'eventId'?: string;
|
|
685
893
|
'groupId'?: string;
|
|
686
|
-
'
|
|
687
|
-
'
|
|
688
|
-
|
|
689
|
-
|
|
894
|
+
'audienceId'?: string;
|
|
895
|
+
'community'?: boolean;
|
|
896
|
+
}
|
|
897
|
+
export interface AnnouncementMergeField {
|
|
898
|
+
'token': string;
|
|
899
|
+
'label': string;
|
|
900
|
+
'group': AnnouncementMergeFieldGroupEnum;
|
|
901
|
+
}
|
|
902
|
+
export declare enum AnnouncementMergeFieldGroupEnum {
|
|
903
|
+
Account = "Account",
|
|
904
|
+
Attributes = "Attributes"
|
|
905
|
+
}
|
|
906
|
+
export interface AnnouncementTemplate {
|
|
907
|
+
'id': string;
|
|
908
|
+
'name': string;
|
|
909
|
+
'description': string | null;
|
|
910
|
+
'title': string | null;
|
|
911
|
+
'html': string | null;
|
|
912
|
+
'createdAt': string;
|
|
913
|
+
'updatedAt': string;
|
|
914
|
+
}
|
|
915
|
+
export interface AnnouncementTemplateCreateInputs {
|
|
916
|
+
'name': string;
|
|
917
|
+
'description'?: string | null;
|
|
918
|
+
'title'?: string | null;
|
|
919
|
+
'html'?: string | null;
|
|
920
|
+
}
|
|
921
|
+
export interface AnnouncementTemplateTranslation {
|
|
922
|
+
'id': string;
|
|
923
|
+
'locale': string;
|
|
924
|
+
'title': string | null;
|
|
925
|
+
'html': string | null;
|
|
926
|
+
'createdAt': string;
|
|
927
|
+
'updatedAt': string;
|
|
928
|
+
}
|
|
929
|
+
export interface AnnouncementTemplateTranslationUpdateInputs {
|
|
930
|
+
'title'?: string | null;
|
|
931
|
+
'html'?: string | null;
|
|
932
|
+
}
|
|
933
|
+
export interface AnnouncementTemplateUpdateInputs {
|
|
934
|
+
'name'?: string;
|
|
935
|
+
'description'?: string | null;
|
|
936
|
+
'title'?: string | null;
|
|
937
|
+
'html'?: string | null;
|
|
690
938
|
}
|
|
691
939
|
export interface AnnouncementTranslation {
|
|
692
940
|
'id': number;
|
|
@@ -705,9 +953,9 @@ export interface AnnouncementUpdateInputs {
|
|
|
705
953
|
'title'?: string | null;
|
|
706
954
|
'html'?: string | null;
|
|
707
955
|
'slug'?: string | null;
|
|
956
|
+
'audienceId'?: string | null;
|
|
708
957
|
'email'?: boolean;
|
|
709
958
|
'push'?: boolean;
|
|
710
|
-
'filters'?: EventAnnouncementFilters | null;
|
|
711
959
|
'includePasses'?: boolean;
|
|
712
960
|
}
|
|
713
961
|
export interface ApproveEventPassRequest {
|
|
@@ -941,17 +1189,27 @@ export interface BaseAnnouncement {
|
|
|
941
1189
|
'push': boolean;
|
|
942
1190
|
'sms': boolean;
|
|
943
1191
|
'includePasses': boolean;
|
|
944
|
-
'accountId': string | null;
|
|
945
1192
|
'creatorId': string | null;
|
|
946
1193
|
'eventId': string | null;
|
|
947
1194
|
'groupId': string | null;
|
|
948
|
-
'
|
|
949
|
-
'channelId': string | null;
|
|
950
|
-
'ticketId': string | null;
|
|
1195
|
+
'audienceId': string | null;
|
|
951
1196
|
'userId': string | null;
|
|
952
1197
|
'schedule': BaseSchedule;
|
|
1198
|
+
'sentAt': string | null;
|
|
1199
|
+
'recipientCount': number | null;
|
|
953
1200
|
'createdAt': string;
|
|
954
1201
|
}
|
|
1202
|
+
export interface BaseAnnouncementAudience {
|
|
1203
|
+
'id': string;
|
|
1204
|
+
'name': string;
|
|
1205
|
+
'description': string | null;
|
|
1206
|
+
'eventId': string | null;
|
|
1207
|
+
'groupId': string | null;
|
|
1208
|
+
'channelId': string | null;
|
|
1209
|
+
'operator': AnnouncementAudienceOperator;
|
|
1210
|
+
'createdAt': string;
|
|
1211
|
+
'updatedAt': string;
|
|
1212
|
+
}
|
|
955
1213
|
export interface BaseBenefit {
|
|
956
1214
|
'id': string;
|
|
957
1215
|
'slug': string;
|
|
@@ -3683,6 +3941,38 @@ export interface CreateAnnouncement200Response {
|
|
|
3683
3941
|
export declare enum CreateAnnouncement200ResponseStatusEnum {
|
|
3684
3942
|
Ok = "ok"
|
|
3685
3943
|
}
|
|
3944
|
+
export interface CreateAnnouncementAudience200Response {
|
|
3945
|
+
'status': CreateAnnouncementAudience200ResponseStatusEnum;
|
|
3946
|
+
'message': string;
|
|
3947
|
+
'data': AnnouncementAudience;
|
|
3948
|
+
}
|
|
3949
|
+
export declare enum CreateAnnouncementAudience200ResponseStatusEnum {
|
|
3950
|
+
Ok = "ok"
|
|
3951
|
+
}
|
|
3952
|
+
export interface CreateAnnouncementAudienceCondition200Response {
|
|
3953
|
+
'status': CreateAnnouncementAudienceCondition200ResponseStatusEnum;
|
|
3954
|
+
'message': string;
|
|
3955
|
+
'data': AnnouncementAudienceCondition;
|
|
3956
|
+
}
|
|
3957
|
+
export declare enum CreateAnnouncementAudienceCondition200ResponseStatusEnum {
|
|
3958
|
+
Ok = "ok"
|
|
3959
|
+
}
|
|
3960
|
+
export interface CreateAnnouncementAudienceFilter200Response {
|
|
3961
|
+
'status': CreateAnnouncementAudienceFilter200ResponseStatusEnum;
|
|
3962
|
+
'message': string;
|
|
3963
|
+
'data': AnnouncementAudienceFilter;
|
|
3964
|
+
}
|
|
3965
|
+
export declare enum CreateAnnouncementAudienceFilter200ResponseStatusEnum {
|
|
3966
|
+
Ok = "ok"
|
|
3967
|
+
}
|
|
3968
|
+
export interface CreateAnnouncementTemplate200Response {
|
|
3969
|
+
'status': CreateAnnouncementTemplate200ResponseStatusEnum;
|
|
3970
|
+
'message': string;
|
|
3971
|
+
'data': AnnouncementTemplate;
|
|
3972
|
+
}
|
|
3973
|
+
export declare enum CreateAnnouncementTemplate200ResponseStatusEnum {
|
|
3974
|
+
Ok = "ok"
|
|
3975
|
+
}
|
|
3686
3976
|
export interface CreateBenefit200Response {
|
|
3687
3977
|
'status': CreateBenefit200ResponseStatusEnum;
|
|
3688
3978
|
'message': string;
|
|
@@ -4848,17 +5138,6 @@ export declare enum EventAgendaVisibility {
|
|
|
4848
5138
|
Registered = "registered",
|
|
4849
5139
|
Hidden = "hidden"
|
|
4850
5140
|
}
|
|
4851
|
-
export interface EventAnnouncementFilters {
|
|
4852
|
-
'type': EventAnnouncementFiltersTypeEnum;
|
|
4853
|
-
'ticketId'?: string;
|
|
4854
|
-
'questionId'?: string;
|
|
4855
|
-
'choiceId'?: string;
|
|
4856
|
-
'eventRoomTypeId'?: string;
|
|
4857
|
-
'addOnId'?: string;
|
|
4858
|
-
}
|
|
4859
|
-
export declare enum EventAnnouncementFiltersTypeEnum {
|
|
4860
|
-
Event = "event"
|
|
4861
|
-
}
|
|
4862
5141
|
export interface EventAttribute {
|
|
4863
5142
|
'id': string;
|
|
4864
5143
|
'name': string;
|
|
@@ -6885,13 +7164,56 @@ export interface GetAllAccountMerges200Response {
|
|
|
6885
7164
|
export declare enum GetAllAccountMerges200ResponseStatusEnum {
|
|
6886
7165
|
Ok = "ok"
|
|
6887
7166
|
}
|
|
6888
|
-
export interface
|
|
6889
|
-
'status':
|
|
7167
|
+
export interface GetAnnouncementAudienceAccounts200Response {
|
|
7168
|
+
'status': GetAnnouncementAudienceAccounts200ResponseStatusEnum;
|
|
6890
7169
|
'message': string;
|
|
6891
7170
|
'data': Array<BaseAccount>;
|
|
6892
7171
|
'count'?: number;
|
|
6893
7172
|
}
|
|
6894
|
-
export declare enum
|
|
7173
|
+
export declare enum GetAnnouncementAudienceAccounts200ResponseStatusEnum {
|
|
7174
|
+
Ok = "ok"
|
|
7175
|
+
}
|
|
7176
|
+
export interface GetAnnouncementAudiences200Response {
|
|
7177
|
+
'status': GetAnnouncementAudiences200ResponseStatusEnum;
|
|
7178
|
+
'message': string;
|
|
7179
|
+
'data': Array<AnnouncementAudience>;
|
|
7180
|
+
'count'?: number;
|
|
7181
|
+
}
|
|
7182
|
+
export declare enum GetAnnouncementAudiences200ResponseStatusEnum {
|
|
7183
|
+
Ok = "ok"
|
|
7184
|
+
}
|
|
7185
|
+
export interface GetAnnouncementMergeFields200Response {
|
|
7186
|
+
'status': GetAnnouncementMergeFields200ResponseStatusEnum;
|
|
7187
|
+
'message': string;
|
|
7188
|
+
'data': Array<AnnouncementMergeField>;
|
|
7189
|
+
}
|
|
7190
|
+
export declare enum GetAnnouncementMergeFields200ResponseStatusEnum {
|
|
7191
|
+
Ok = "ok"
|
|
7192
|
+
}
|
|
7193
|
+
export interface GetAnnouncementTemplateTranslation200Response {
|
|
7194
|
+
'status': GetAnnouncementTemplateTranslation200ResponseStatusEnum;
|
|
7195
|
+
'message': string;
|
|
7196
|
+
'data': AnnouncementTemplateTranslation | null;
|
|
7197
|
+
}
|
|
7198
|
+
export declare enum GetAnnouncementTemplateTranslation200ResponseStatusEnum {
|
|
7199
|
+
Ok = "ok"
|
|
7200
|
+
}
|
|
7201
|
+
export interface GetAnnouncementTemplateTranslations200Response {
|
|
7202
|
+
'status': GetAnnouncementTemplateTranslations200ResponseStatusEnum;
|
|
7203
|
+
'message': string;
|
|
7204
|
+
'data': Array<AnnouncementTemplateTranslation>;
|
|
7205
|
+
'count'?: number;
|
|
7206
|
+
}
|
|
7207
|
+
export declare enum GetAnnouncementTemplateTranslations200ResponseStatusEnum {
|
|
7208
|
+
Ok = "ok"
|
|
7209
|
+
}
|
|
7210
|
+
export interface GetAnnouncementTemplates200Response {
|
|
7211
|
+
'status': GetAnnouncementTemplates200ResponseStatusEnum;
|
|
7212
|
+
'message': string;
|
|
7213
|
+
'data': Array<AnnouncementTemplate>;
|
|
7214
|
+
'count'?: number;
|
|
7215
|
+
}
|
|
7216
|
+
export declare enum GetAnnouncementTemplates200ResponseStatusEnum {
|
|
6895
7217
|
Ok = "ok"
|
|
6896
7218
|
}
|
|
6897
7219
|
export interface GetAnnouncementTranslation200Response {
|
|
@@ -12267,6 +12589,9 @@ export interface Self {
|
|
|
12267
12589
|
'createdAt': string;
|
|
12268
12590
|
'updatedAt': string;
|
|
12269
12591
|
}
|
|
12592
|
+
export interface SendAnnouncementPreviewRequest {
|
|
12593
|
+
'accountId'?: string;
|
|
12594
|
+
}
|
|
12270
12595
|
export interface Series {
|
|
12271
12596
|
'id': string;
|
|
12272
12597
|
'slug': string;
|
|
@@ -13656,6 +13981,14 @@ export interface TriggerUpdateInputs {
|
|
|
13656
13981
|
'code'?: string | null;
|
|
13657
13982
|
'enabled'?: boolean;
|
|
13658
13983
|
}
|
|
13984
|
+
export interface UpdateAnnouncementTemplateTranslation200Response {
|
|
13985
|
+
'status': UpdateAnnouncementTemplateTranslation200ResponseStatusEnum;
|
|
13986
|
+
'message': string;
|
|
13987
|
+
'data': AnnouncementTemplateTranslation;
|
|
13988
|
+
}
|
|
13989
|
+
export declare enum UpdateAnnouncementTemplateTranslation200ResponseStatusEnum {
|
|
13990
|
+
Ok = "ok"
|
|
13991
|
+
}
|
|
13659
13992
|
export interface UpdateBookingResponsesInputs {
|
|
13660
13993
|
'questions': Array<Question>;
|
|
13661
13994
|
}
|
|
@@ -18117,7 +18450,7 @@ export declare class AdvertisementsApi extends BaseAPI {
|
|
|
18117
18450
|
*/
|
|
18118
18451
|
export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
18119
18452
|
/**
|
|
18120
|
-
* Creates
|
|
18453
|
+
* Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
|
|
18121
18454
|
* @summary Create an announcement
|
|
18122
18455
|
* @param {AnnouncementCreateInputs} announcementCreateInputs
|
|
18123
18456
|
* @param {*} [options] Override http request option.
|
|
@@ -18141,9 +18474,10 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
|
|
|
18141
18474
|
*/
|
|
18142
18475
|
getAnnouncement: (announcementId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18143
18476
|
/**
|
|
18144
|
-
* Returns a paginated list of
|
|
18145
|
-
* @summary List an announcement\'s
|
|
18477
|
+
* 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.
|
|
18478
|
+
* @summary List an announcement\'s email delivery receipts
|
|
18146
18479
|
* @param {string} announcementId The announcement identifier
|
|
18480
|
+
* @param {EmailReceiptStatus} [status] Filter by status
|
|
18147
18481
|
* @param {number} [page] Page number
|
|
18148
18482
|
* @param {number} [pageSize] Number of items per page
|
|
18149
18483
|
* @param {string} [orderBy] Field to order by
|
|
@@ -18151,12 +18485,18 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
|
|
|
18151
18485
|
* @param {*} [options] Override http request option.
|
|
18152
18486
|
* @throws {RequiredError}
|
|
18153
18487
|
*/
|
|
18154
|
-
|
|
18488
|
+
getAnnouncementEmailReceipts: (announcementId: string, status?: EmailReceiptStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18155
18489
|
/**
|
|
18156
|
-
* Returns
|
|
18157
|
-
* @summary List
|
|
18490
|
+
* 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.
|
|
18491
|
+
* @summary List announcement merge fields
|
|
18492
|
+
* @param {*} [options] Override http request option.
|
|
18493
|
+
* @throws {RequiredError}
|
|
18494
|
+
*/
|
|
18495
|
+
getAnnouncementMergeFields: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18496
|
+
/**
|
|
18497
|
+
* 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.
|
|
18498
|
+
* @summary List an announcement\'s recipients
|
|
18158
18499
|
* @param {string} announcementId The announcement identifier
|
|
18159
|
-
* @param {EmailReceiptStatus} [status] Filter by status
|
|
18160
18500
|
* @param {number} [page] Page number
|
|
18161
18501
|
* @param {number} [pageSize] Number of items per page
|
|
18162
18502
|
* @param {string} [orderBy] Field to order by
|
|
@@ -18164,9 +18504,9 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
|
|
|
18164
18504
|
* @param {*} [options] Override http request option.
|
|
18165
18505
|
* @throws {RequiredError}
|
|
18166
18506
|
*/
|
|
18167
|
-
|
|
18507
|
+
getAnnouncementRecipients: (announcementId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18168
18508
|
/**
|
|
18169
|
-
* Returns a paginated list of announcements for the organization, optionally filtered
|
|
18509
|
+
* Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
|
|
18170
18510
|
* @summary List announcements
|
|
18171
18511
|
* @param {AnnouncementFilters} [filters] Filter by filters
|
|
18172
18512
|
* @param {number} [page] Page number
|
|
@@ -18178,13 +18518,14 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
|
|
|
18178
18518
|
*/
|
|
18179
18519
|
getAnnouncements: (filters?: AnnouncementFilters, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18180
18520
|
/**
|
|
18181
|
-
*
|
|
18521
|
+
* Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
|
|
18182
18522
|
* @summary Send a preview of an announcement
|
|
18183
18523
|
* @param {string} announcementId The announcement identifier
|
|
18524
|
+
* @param {SendAnnouncementPreviewRequest} [sendAnnouncementPreviewRequest]
|
|
18184
18525
|
* @param {*} [options] Override http request option.
|
|
18185
18526
|
* @throws {RequiredError}
|
|
18186
18527
|
*/
|
|
18187
|
-
sendAnnouncementPreview: (announcementId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18528
|
+
sendAnnouncementPreview: (announcementId: string, sendAnnouncementPreviewRequest?: SendAnnouncementPreviewRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18188
18529
|
/**
|
|
18189
18530
|
* Updates the fields (such as title, content, or audience targeting) of an existing announcement identified by ID or slug; requires update permission on announcements.
|
|
18190
18531
|
* @summary Update an announcement
|
|
@@ -18200,7 +18541,7 @@ export declare const AnnouncementsApiAxiosParamCreator: (configuration?: Configu
|
|
|
18200
18541
|
*/
|
|
18201
18542
|
export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
|
|
18202
18543
|
/**
|
|
18203
|
-
* Creates
|
|
18544
|
+
* Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
|
|
18204
18545
|
* @summary Create an announcement
|
|
18205
18546
|
* @param {AnnouncementCreateInputs} announcementCreateInputs
|
|
18206
18547
|
* @param {*} [options] Override http request option.
|
|
@@ -18224,9 +18565,10 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
|
|
|
18224
18565
|
*/
|
|
18225
18566
|
getAnnouncement(announcementId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncement200Response>>;
|
|
18226
18567
|
/**
|
|
18227
|
-
* Returns a paginated list of
|
|
18228
|
-
* @summary List an announcement\'s
|
|
18568
|
+
* 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.
|
|
18569
|
+
* @summary List an announcement\'s email delivery receipts
|
|
18229
18570
|
* @param {string} announcementId The announcement identifier
|
|
18571
|
+
* @param {EmailReceiptStatus} [status] Filter by status
|
|
18230
18572
|
* @param {number} [page] Page number
|
|
18231
18573
|
* @param {number} [pageSize] Number of items per page
|
|
18232
18574
|
* @param {string} [orderBy] Field to order by
|
|
@@ -18234,12 +18576,18 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
|
|
|
18234
18576
|
* @param {*} [options] Override http request option.
|
|
18235
18577
|
* @throws {RequiredError}
|
|
18236
18578
|
*/
|
|
18237
|
-
|
|
18579
|
+
getAnnouncementEmailReceipts(announcementId: string, status?: EmailReceiptStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAcccountEmailReceipts200Response>>;
|
|
18238
18580
|
/**
|
|
18239
|
-
* Returns
|
|
18240
|
-
* @summary List
|
|
18581
|
+
* 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.
|
|
18582
|
+
* @summary List announcement merge fields
|
|
18583
|
+
* @param {*} [options] Override http request option.
|
|
18584
|
+
* @throws {RequiredError}
|
|
18585
|
+
*/
|
|
18586
|
+
getAnnouncementMergeFields(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementMergeFields200Response>>;
|
|
18587
|
+
/**
|
|
18588
|
+
* 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.
|
|
18589
|
+
* @summary List an announcement\'s recipients
|
|
18241
18590
|
* @param {string} announcementId The announcement identifier
|
|
18242
|
-
* @param {EmailReceiptStatus} [status] Filter by status
|
|
18243
18591
|
* @param {number} [page] Page number
|
|
18244
18592
|
* @param {number} [pageSize] Number of items per page
|
|
18245
18593
|
* @param {string} [orderBy] Field to order by
|
|
@@ -18247,9 +18595,9 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
|
|
|
18247
18595
|
* @param {*} [options] Override http request option.
|
|
18248
18596
|
* @throws {RequiredError}
|
|
18249
18597
|
*/
|
|
18250
|
-
|
|
18598
|
+
getAnnouncementRecipients(announcementId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudienceAccounts200Response>>;
|
|
18251
18599
|
/**
|
|
18252
|
-
* Returns a paginated list of announcements for the organization, optionally filtered
|
|
18600
|
+
* Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
|
|
18253
18601
|
* @summary List announcements
|
|
18254
18602
|
* @param {AnnouncementFilters} [filters] Filter by filters
|
|
18255
18603
|
* @param {number} [page] Page number
|
|
@@ -18261,13 +18609,14 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
|
|
|
18261
18609
|
*/
|
|
18262
18610
|
getAnnouncements(filters?: AnnouncementFilters, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncements200Response>>;
|
|
18263
18611
|
/**
|
|
18264
|
-
*
|
|
18612
|
+
* Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
|
|
18265
18613
|
* @summary Send a preview of an announcement
|
|
18266
18614
|
* @param {string} announcementId The announcement identifier
|
|
18615
|
+
* @param {SendAnnouncementPreviewRequest} [sendAnnouncementPreviewRequest]
|
|
18267
18616
|
* @param {*} [options] Override http request option.
|
|
18268
18617
|
* @throws {RequiredError}
|
|
18269
18618
|
*/
|
|
18270
|
-
sendAnnouncementPreview(announcementId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
18619
|
+
sendAnnouncementPreview(announcementId: string, sendAnnouncementPreviewRequest?: SendAnnouncementPreviewRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
18271
18620
|
/**
|
|
18272
18621
|
* Updates the fields (such as title, content, or audience targeting) of an existing announcement identified by ID or slug; requires update permission on announcements.
|
|
18273
18622
|
* @summary Update an announcement
|
|
@@ -18283,7 +18632,7 @@ export declare const AnnouncementsApiFp: (configuration?: Configuration) => {
|
|
|
18283
18632
|
*/
|
|
18284
18633
|
export declare const AnnouncementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
18285
18634
|
/**
|
|
18286
|
-
* Creates
|
|
18635
|
+
* Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
|
|
18287
18636
|
* @summary Create an announcement
|
|
18288
18637
|
* @param {AnnouncementsApiCreateAnnouncementRequest} requestParameters Request parameters.
|
|
18289
18638
|
* @param {*} [options] Override http request option.
|
|
@@ -18306,14 +18655,6 @@ export declare const AnnouncementsApiFactory: (configuration?: Configuration, ba
|
|
|
18306
18655
|
* @throws {RequiredError}
|
|
18307
18656
|
*/
|
|
18308
18657
|
getAnnouncement(requestParameters: AnnouncementsApiGetAnnouncementRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncement200Response>;
|
|
18309
|
-
/**
|
|
18310
|
-
* Returns a paginated list of the accounts that an announcement was or will be sent to, supporting search and ordering; requires read permission on announcements.
|
|
18311
|
-
* @summary List an announcement\'s target audience
|
|
18312
|
-
* @param {AnnouncementsApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
|
|
18313
|
-
* @param {*} [options] Override http request option.
|
|
18314
|
-
* @throws {RequiredError}
|
|
18315
|
-
*/
|
|
18316
|
-
getAnnouncementAudience(requestParameters: AnnouncementsApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudience200Response>;
|
|
18317
18658
|
/**
|
|
18318
18659
|
* Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
|
|
18319
18660
|
* @summary List an announcement\'s email delivery receipts
|
|
@@ -18323,7 +18664,22 @@ export declare const AnnouncementsApiFactory: (configuration?: Configuration, ba
|
|
|
18323
18664
|
*/
|
|
18324
18665
|
getAnnouncementEmailReceipts(requestParameters: AnnouncementsApiGetAnnouncementEmailReceiptsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAcccountEmailReceipts200Response>;
|
|
18325
18666
|
/**
|
|
18326
|
-
* Returns
|
|
18667
|
+
* 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.
|
|
18668
|
+
* @summary List announcement merge fields
|
|
18669
|
+
* @param {*} [options] Override http request option.
|
|
18670
|
+
* @throws {RequiredError}
|
|
18671
|
+
*/
|
|
18672
|
+
getAnnouncementMergeFields(options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementMergeFields200Response>;
|
|
18673
|
+
/**
|
|
18674
|
+
* 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.
|
|
18675
|
+
* @summary List an announcement\'s recipients
|
|
18676
|
+
* @param {AnnouncementsApiGetAnnouncementRecipientsRequest} requestParameters Request parameters.
|
|
18677
|
+
* @param {*} [options] Override http request option.
|
|
18678
|
+
* @throws {RequiredError}
|
|
18679
|
+
*/
|
|
18680
|
+
getAnnouncementRecipients(requestParameters: AnnouncementsApiGetAnnouncementRecipientsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudienceAccounts200Response>;
|
|
18681
|
+
/**
|
|
18682
|
+
* Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
|
|
18327
18683
|
* @summary List announcements
|
|
18328
18684
|
* @param {AnnouncementsApiGetAnnouncementsRequest} requestParameters Request parameters.
|
|
18329
18685
|
* @param {*} [options] Override http request option.
|
|
@@ -18331,7 +18687,7 @@ export declare const AnnouncementsApiFactory: (configuration?: Configuration, ba
|
|
|
18331
18687
|
*/
|
|
18332
18688
|
getAnnouncements(requestParameters?: AnnouncementsApiGetAnnouncementsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncements200Response>;
|
|
18333
18689
|
/**
|
|
18334
|
-
*
|
|
18690
|
+
* Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
|
|
18335
18691
|
* @summary Send a preview of an announcement
|
|
18336
18692
|
* @param {AnnouncementsApiSendAnnouncementPreviewRequest} requestParameters Request parameters.
|
|
18337
18693
|
* @param {*} [options] Override http request option.
|
|
@@ -18372,13 +18728,17 @@ export interface AnnouncementsApiGetAnnouncementRequest {
|
|
|
18372
18728
|
readonly announcementId: string;
|
|
18373
18729
|
}
|
|
18374
18730
|
/**
|
|
18375
|
-
* Request parameters for
|
|
18731
|
+
* Request parameters for getAnnouncementEmailReceipts operation in AnnouncementsApi.
|
|
18376
18732
|
*/
|
|
18377
|
-
export interface
|
|
18733
|
+
export interface AnnouncementsApiGetAnnouncementEmailReceiptsRequest {
|
|
18378
18734
|
/**
|
|
18379
18735
|
* The announcement identifier
|
|
18380
18736
|
*/
|
|
18381
18737
|
readonly announcementId: string;
|
|
18738
|
+
/**
|
|
18739
|
+
* Filter by status
|
|
18740
|
+
*/
|
|
18741
|
+
readonly status?: EmailReceiptStatus;
|
|
18382
18742
|
/**
|
|
18383
18743
|
* Page number
|
|
18384
18744
|
*/
|
|
@@ -18397,17 +18757,13 @@ export interface AnnouncementsApiGetAnnouncementAudienceRequest {
|
|
|
18397
18757
|
readonly search?: string;
|
|
18398
18758
|
}
|
|
18399
18759
|
/**
|
|
18400
|
-
* Request parameters for
|
|
18760
|
+
* Request parameters for getAnnouncementRecipients operation in AnnouncementsApi.
|
|
18401
18761
|
*/
|
|
18402
|
-
export interface
|
|
18762
|
+
export interface AnnouncementsApiGetAnnouncementRecipientsRequest {
|
|
18403
18763
|
/**
|
|
18404
18764
|
* The announcement identifier
|
|
18405
18765
|
*/
|
|
18406
18766
|
readonly announcementId: string;
|
|
18407
|
-
/**
|
|
18408
|
-
* Filter by status
|
|
18409
|
-
*/
|
|
18410
|
-
readonly status?: EmailReceiptStatus;
|
|
18411
18767
|
/**
|
|
18412
18768
|
* Page number
|
|
18413
18769
|
*/
|
|
@@ -18458,6 +18814,7 @@ export interface AnnouncementsApiSendAnnouncementPreviewRequest {
|
|
|
18458
18814
|
* The announcement identifier
|
|
18459
18815
|
*/
|
|
18460
18816
|
readonly announcementId: string;
|
|
18817
|
+
readonly sendAnnouncementPreviewRequest?: SendAnnouncementPreviewRequest;
|
|
18461
18818
|
}
|
|
18462
18819
|
/**
|
|
18463
18820
|
* Request parameters for updateAnnouncement operation in AnnouncementsApi.
|
|
@@ -18474,7 +18831,7 @@ export interface AnnouncementsApiUpdateAnnouncementRequest {
|
|
|
18474
18831
|
*/
|
|
18475
18832
|
export declare class AnnouncementsApi extends BaseAPI {
|
|
18476
18833
|
/**
|
|
18477
|
-
* Creates
|
|
18834
|
+
* Creates an announcement in the community, an event (eventId) or a group (groupId), optionally narrowed by an audience in the same scope. Pass templateId to start from a template: its subject, HTML body and translations are copied in once, filling anything the request leaves out, and later template edits don\'t affect the announcement. Requires create permission on announcements.
|
|
18478
18835
|
* @summary Create an announcement
|
|
18479
18836
|
* @param {AnnouncementsApiCreateAnnouncementRequest} requestParameters Request parameters.
|
|
18480
18837
|
* @param {*} [options] Override http request option.
|
|
@@ -18497,14 +18854,6 @@ export declare class AnnouncementsApi extends BaseAPI {
|
|
|
18497
18854
|
* @throws {RequiredError}
|
|
18498
18855
|
*/
|
|
18499
18856
|
getAnnouncement(requestParameters: AnnouncementsApiGetAnnouncementRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncement200Response, any, {}, any>>;
|
|
18500
|
-
/**
|
|
18501
|
-
* Returns a paginated list of the accounts that an announcement was or will be sent to, supporting search and ordering; requires read permission on announcements.
|
|
18502
|
-
* @summary List an announcement\'s target audience
|
|
18503
|
-
* @param {AnnouncementsApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
|
|
18504
|
-
* @param {*} [options] Override http request option.
|
|
18505
|
-
* @throws {RequiredError}
|
|
18506
|
-
*/
|
|
18507
|
-
getAnnouncementAudience(requestParameters: AnnouncementsApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementAudience200Response, any, {}, any>>;
|
|
18508
18857
|
/**
|
|
18509
18858
|
* Returns a paginated list of email receipts recording delivery status for the given announcement, optionally filtered by delivery status, with search and ordering support; requires read permission on both announcements and logs.
|
|
18510
18859
|
* @summary List an announcement\'s email delivery receipts
|
|
@@ -18514,7 +18863,22 @@ export declare class AnnouncementsApi extends BaseAPI {
|
|
|
18514
18863
|
*/
|
|
18515
18864
|
getAnnouncementEmailReceipts(requestParameters: AnnouncementsApiGetAnnouncementEmailReceiptsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAcccountEmailReceipts200Response, any, {}, any>>;
|
|
18516
18865
|
/**
|
|
18517
|
-
* Returns
|
|
18866
|
+
* 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.
|
|
18867
|
+
* @summary List announcement merge fields
|
|
18868
|
+
* @param {*} [options] Override http request option.
|
|
18869
|
+
* @throws {RequiredError}
|
|
18870
|
+
*/
|
|
18871
|
+
getAnnouncementMergeFields(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementMergeFields200Response, any, {}, any>>;
|
|
18872
|
+
/**
|
|
18873
|
+
* 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.
|
|
18874
|
+
* @summary List an announcement\'s recipients
|
|
18875
|
+
* @param {AnnouncementsApiGetAnnouncementRecipientsRequest} requestParameters Request parameters.
|
|
18876
|
+
* @param {*} [options] Override http request option.
|
|
18877
|
+
* @throws {RequiredError}
|
|
18878
|
+
*/
|
|
18879
|
+
getAnnouncementRecipients(requestParameters: AnnouncementsApiGetAnnouncementRecipientsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementAudienceAccounts200Response, any, {}, any>>;
|
|
18880
|
+
/**
|
|
18881
|
+
* Returns a paginated list of announcements for the organization, optionally filtered to one event, one group, community announcements only, or those using one audience, with search and ordering support; requires read permission on announcements.
|
|
18518
18882
|
* @summary List announcements
|
|
18519
18883
|
* @param {AnnouncementsApiGetAnnouncementsRequest} requestParameters Request parameters.
|
|
18520
18884
|
* @param {*} [options] Override http request option.
|
|
@@ -18522,7 +18886,7 @@ export declare class AnnouncementsApi extends BaseAPI {
|
|
|
18522
18886
|
*/
|
|
18523
18887
|
getAnnouncements(requestParameters?: AnnouncementsApiGetAnnouncementsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncements200Response, any, {}, any>>;
|
|
18524
18888
|
/**
|
|
18525
|
-
*
|
|
18889
|
+
* Emails a preview of the announcement to the signed-in admin. Pass accountId to fill in merge fields as that account would see them; the preview still goes to the admin, never to the account. Fails if the announcement has no HTML content yet; requires create permission on announcements.
|
|
18526
18890
|
* @summary Send a preview of an announcement
|
|
18527
18891
|
* @param {AnnouncementsApiSendAnnouncementPreviewRequest} requestParameters Request parameters.
|
|
18528
18892
|
* @param {*} [options] Override http request option.
|
|
@@ -18538,6 +18902,620 @@ export declare class AnnouncementsApi extends BaseAPI {
|
|
|
18538
18902
|
*/
|
|
18539
18903
|
updateAnnouncement(requestParameters: AnnouncementsApiUpdateAnnouncementRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncement200Response, any, {}, any>>;
|
|
18540
18904
|
}
|
|
18905
|
+
/**
|
|
18906
|
+
* AnnouncementsAudiencesApi - axios parameter creator
|
|
18907
|
+
*/
|
|
18908
|
+
export declare const AnnouncementsAudiencesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
18909
|
+
/**
|
|
18910
|
+
* 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.
|
|
18911
|
+
* @summary Create an announcement audience
|
|
18912
|
+
* @param {AnnouncementAudienceCreateInputs} announcementAudienceCreateInputs
|
|
18913
|
+
* @param {*} [options] Override http request option.
|
|
18914
|
+
* @throws {RequiredError}
|
|
18915
|
+
*/
|
|
18916
|
+
createAnnouncementAudience: (announcementAudienceCreateInputs: AnnouncementAudienceCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18917
|
+
/**
|
|
18918
|
+
* 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.
|
|
18919
|
+
* @summary Create an audience condition
|
|
18920
|
+
* @param {string} audienceId The audience identifier
|
|
18921
|
+
* @param {string} filterId The filter identifier
|
|
18922
|
+
* @param {AnnouncementAudienceConditionCreateInputs} announcementAudienceConditionCreateInputs
|
|
18923
|
+
* @param {*} [options] Override http request option.
|
|
18924
|
+
* @throws {RequiredError}
|
|
18925
|
+
*/
|
|
18926
|
+
createAnnouncementAudienceCondition: (audienceId: string, filterId: string, announcementAudienceConditionCreateInputs: AnnouncementAudienceConditionCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18927
|
+
/**
|
|
18928
|
+
* 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.
|
|
18929
|
+
* @summary Create an audience filter group
|
|
18930
|
+
* @param {string} audienceId The audience identifier
|
|
18931
|
+
* @param {AnnouncementAudienceFilterCreateInputs} announcementAudienceFilterCreateInputs
|
|
18932
|
+
* @param {*} [options] Override http request option.
|
|
18933
|
+
* @throws {RequiredError}
|
|
18934
|
+
*/
|
|
18935
|
+
createAnnouncementAudienceFilter: (audienceId: string, announcementAudienceFilterCreateInputs: AnnouncementAudienceFilterCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18936
|
+
/**
|
|
18937
|
+
* Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
|
|
18938
|
+
* @summary Delete an announcement audience
|
|
18939
|
+
* @param {string} audienceId The audience identifier
|
|
18940
|
+
* @param {*} [options] Override http request option.
|
|
18941
|
+
* @throws {RequiredError}
|
|
18942
|
+
*/
|
|
18943
|
+
deleteAnnouncementAudience: (audienceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18944
|
+
/**
|
|
18945
|
+
* Removes a condition from its filter group; requires update permission on announcements.
|
|
18946
|
+
* @summary Delete an audience condition
|
|
18947
|
+
* @param {string} audienceId The audience identifier
|
|
18948
|
+
* @param {string} filterId The filter identifier
|
|
18949
|
+
* @param {string} conditionId The condition identifier
|
|
18950
|
+
* @param {*} [options] Override http request option.
|
|
18951
|
+
* @throws {RequiredError}
|
|
18952
|
+
*/
|
|
18953
|
+
deleteAnnouncementAudienceCondition: (audienceId: string, filterId: string, conditionId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18954
|
+
/**
|
|
18955
|
+
* Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
|
|
18956
|
+
* @summary Delete an audience filter group
|
|
18957
|
+
* @param {string} audienceId The audience identifier
|
|
18958
|
+
* @param {string} filterId The filter identifier
|
|
18959
|
+
* @param {*} [options] Override http request option.
|
|
18960
|
+
* @throws {RequiredError}
|
|
18961
|
+
*/
|
|
18962
|
+
deleteAnnouncementAudienceFilter: (audienceId: string, filterId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18963
|
+
/**
|
|
18964
|
+
* Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
|
|
18965
|
+
* @summary Get an announcement audience
|
|
18966
|
+
* @param {string} audienceId The audience identifier
|
|
18967
|
+
* @param {*} [options] Override http request option.
|
|
18968
|
+
* @throws {RequiredError}
|
|
18969
|
+
*/
|
|
18970
|
+
getAnnouncementAudience: (audienceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18971
|
+
/**
|
|
18972
|
+
* 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.
|
|
18973
|
+
* @summary List the accounts in an announcement audience
|
|
18974
|
+
* @param {string} audienceId The audience identifier
|
|
18975
|
+
* @param {number} [page] Page number
|
|
18976
|
+
* @param {number} [pageSize] Number of items per page
|
|
18977
|
+
* @param {string} [orderBy] Field to order by
|
|
18978
|
+
* @param {string} [search] Search query
|
|
18979
|
+
* @param {*} [options] Override http request option.
|
|
18980
|
+
* @throws {RequiredError}
|
|
18981
|
+
*/
|
|
18982
|
+
getAnnouncementAudienceAccounts: (audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18983
|
+
/**
|
|
18984
|
+
* 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.
|
|
18985
|
+
* @summary List announcement audiences
|
|
18986
|
+
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
18987
|
+
* @param {number} [page] Page number
|
|
18988
|
+
* @param {number} [pageSize] Number of items per page
|
|
18989
|
+
* @param {string} [orderBy] Field to order by
|
|
18990
|
+
* @param {string} [search] Search query
|
|
18991
|
+
* @param {*} [options] Override http request option.
|
|
18992
|
+
* @throws {RequiredError}
|
|
18993
|
+
*/
|
|
18994
|
+
getAnnouncementAudiences: (scope?: AnnouncementAudienceScope, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
18995
|
+
/**
|
|
18996
|
+
* Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
|
|
18997
|
+
* @summary Update an announcement audience
|
|
18998
|
+
* @param {string} audienceId The audience identifier
|
|
18999
|
+
* @param {AnnouncementAudienceUpdateInputs} announcementAudienceUpdateInputs
|
|
19000
|
+
* @param {*} [options] Override http request option.
|
|
19001
|
+
* @throws {RequiredError}
|
|
19002
|
+
*/
|
|
19003
|
+
updateAnnouncementAudience: (audienceId: string, announcementAudienceUpdateInputs: AnnouncementAudienceUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19004
|
+
/**
|
|
19005
|
+
* Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
|
|
19006
|
+
* @summary Update an audience condition
|
|
19007
|
+
* @param {string} audienceId The audience identifier
|
|
19008
|
+
* @param {string} filterId The filter identifier
|
|
19009
|
+
* @param {string} conditionId The condition identifier
|
|
19010
|
+
* @param {AnnouncementAudienceConditionUpdateInputs} announcementAudienceConditionUpdateInputs
|
|
19011
|
+
* @param {*} [options] Override http request option.
|
|
19012
|
+
* @throws {RequiredError}
|
|
19013
|
+
*/
|
|
19014
|
+
updateAnnouncementAudienceCondition: (audienceId: string, filterId: string, conditionId: string, announcementAudienceConditionUpdateInputs: AnnouncementAudienceConditionUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19015
|
+
/**
|
|
19016
|
+
* Changes a filter group\'s operator or sort order; requires update permission on announcements.
|
|
19017
|
+
* @summary Update an audience filter group
|
|
19018
|
+
* @param {string} audienceId The audience identifier
|
|
19019
|
+
* @param {string} filterId The filter identifier
|
|
19020
|
+
* @param {AnnouncementAudienceFilterUpdateInputs} announcementAudienceFilterUpdateInputs
|
|
19021
|
+
* @param {*} [options] Override http request option.
|
|
19022
|
+
* @throws {RequiredError}
|
|
19023
|
+
*/
|
|
19024
|
+
updateAnnouncementAudienceFilter: (audienceId: string, filterId: string, announcementAudienceFilterUpdateInputs: AnnouncementAudienceFilterUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19025
|
+
};
|
|
19026
|
+
/**
|
|
19027
|
+
* AnnouncementsAudiencesApi - functional programming interface
|
|
19028
|
+
*/
|
|
19029
|
+
export declare const AnnouncementsAudiencesApiFp: (configuration?: Configuration) => {
|
|
19030
|
+
/**
|
|
19031
|
+
* 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.
|
|
19032
|
+
* @summary Create an announcement audience
|
|
19033
|
+
* @param {AnnouncementAudienceCreateInputs} announcementAudienceCreateInputs
|
|
19034
|
+
* @param {*} [options] Override http request option.
|
|
19035
|
+
* @throws {RequiredError}
|
|
19036
|
+
*/
|
|
19037
|
+
createAnnouncementAudience(announcementAudienceCreateInputs: AnnouncementAudienceCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudience200Response>>;
|
|
19038
|
+
/**
|
|
19039
|
+
* 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.
|
|
19040
|
+
* @summary Create an audience condition
|
|
19041
|
+
* @param {string} audienceId The audience identifier
|
|
19042
|
+
* @param {string} filterId The filter identifier
|
|
19043
|
+
* @param {AnnouncementAudienceConditionCreateInputs} announcementAudienceConditionCreateInputs
|
|
19044
|
+
* @param {*} [options] Override http request option.
|
|
19045
|
+
* @throws {RequiredError}
|
|
19046
|
+
*/
|
|
19047
|
+
createAnnouncementAudienceCondition(audienceId: string, filterId: string, announcementAudienceConditionCreateInputs: AnnouncementAudienceConditionCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceCondition200Response>>;
|
|
19048
|
+
/**
|
|
19049
|
+
* 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.
|
|
19050
|
+
* @summary Create an audience filter group
|
|
19051
|
+
* @param {string} audienceId The audience identifier
|
|
19052
|
+
* @param {AnnouncementAudienceFilterCreateInputs} announcementAudienceFilterCreateInputs
|
|
19053
|
+
* @param {*} [options] Override http request option.
|
|
19054
|
+
* @throws {RequiredError}
|
|
19055
|
+
*/
|
|
19056
|
+
createAnnouncementAudienceFilter(audienceId: string, announcementAudienceFilterCreateInputs: AnnouncementAudienceFilterCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceFilter200Response>>;
|
|
19057
|
+
/**
|
|
19058
|
+
* Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
|
|
19059
|
+
* @summary Delete an announcement audience
|
|
19060
|
+
* @param {string} audienceId The audience identifier
|
|
19061
|
+
* @param {*} [options] Override http request option.
|
|
19062
|
+
* @throws {RequiredError}
|
|
19063
|
+
*/
|
|
19064
|
+
deleteAnnouncementAudience(audienceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
19065
|
+
/**
|
|
19066
|
+
* Removes a condition from its filter group; requires update permission on announcements.
|
|
19067
|
+
* @summary Delete an audience condition
|
|
19068
|
+
* @param {string} audienceId The audience identifier
|
|
19069
|
+
* @param {string} filterId The filter identifier
|
|
19070
|
+
* @param {string} conditionId The condition identifier
|
|
19071
|
+
* @param {*} [options] Override http request option.
|
|
19072
|
+
* @throws {RequiredError}
|
|
19073
|
+
*/
|
|
19074
|
+
deleteAnnouncementAudienceCondition(audienceId: string, filterId: string, conditionId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
19075
|
+
/**
|
|
19076
|
+
* Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
|
|
19077
|
+
* @summary Delete an audience filter group
|
|
19078
|
+
* @param {string} audienceId The audience identifier
|
|
19079
|
+
* @param {string} filterId The filter identifier
|
|
19080
|
+
* @param {*} [options] Override http request option.
|
|
19081
|
+
* @throws {RequiredError}
|
|
19082
|
+
*/
|
|
19083
|
+
deleteAnnouncementAudienceFilter(audienceId: string, filterId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
19084
|
+
/**
|
|
19085
|
+
* Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
|
|
19086
|
+
* @summary Get an announcement audience
|
|
19087
|
+
* @param {string} audienceId The audience identifier
|
|
19088
|
+
* @param {*} [options] Override http request option.
|
|
19089
|
+
* @throws {RequiredError}
|
|
19090
|
+
*/
|
|
19091
|
+
getAnnouncementAudience(audienceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudience200Response>>;
|
|
19092
|
+
/**
|
|
19093
|
+
* 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.
|
|
19094
|
+
* @summary List the accounts in an announcement audience
|
|
19095
|
+
* @param {string} audienceId The audience identifier
|
|
19096
|
+
* @param {number} [page] Page number
|
|
19097
|
+
* @param {number} [pageSize] Number of items per page
|
|
19098
|
+
* @param {string} [orderBy] Field to order by
|
|
19099
|
+
* @param {string} [search] Search query
|
|
19100
|
+
* @param {*} [options] Override http request option.
|
|
19101
|
+
* @throws {RequiredError}
|
|
19102
|
+
*/
|
|
19103
|
+
getAnnouncementAudienceAccounts(audienceId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudienceAccounts200Response>>;
|
|
19104
|
+
/**
|
|
19105
|
+
* 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.
|
|
19106
|
+
* @summary List announcement audiences
|
|
19107
|
+
* @param {AnnouncementAudienceScope} [scope] Filter by scope
|
|
19108
|
+
* @param {number} [page] Page number
|
|
19109
|
+
* @param {number} [pageSize] Number of items per page
|
|
19110
|
+
* @param {string} [orderBy] Field to order by
|
|
19111
|
+
* @param {string} [search] Search query
|
|
19112
|
+
* @param {*} [options] Override http request option.
|
|
19113
|
+
* @throws {RequiredError}
|
|
19114
|
+
*/
|
|
19115
|
+
getAnnouncementAudiences(scope?: AnnouncementAudienceScope, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementAudiences200Response>>;
|
|
19116
|
+
/**
|
|
19117
|
+
* Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
|
|
19118
|
+
* @summary Update an announcement audience
|
|
19119
|
+
* @param {string} audienceId The audience identifier
|
|
19120
|
+
* @param {AnnouncementAudienceUpdateInputs} announcementAudienceUpdateInputs
|
|
19121
|
+
* @param {*} [options] Override http request option.
|
|
19122
|
+
* @throws {RequiredError}
|
|
19123
|
+
*/
|
|
19124
|
+
updateAnnouncementAudience(audienceId: string, announcementAudienceUpdateInputs: AnnouncementAudienceUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudience200Response>>;
|
|
19125
|
+
/**
|
|
19126
|
+
* Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
|
|
19127
|
+
* @summary Update an audience condition
|
|
19128
|
+
* @param {string} audienceId The audience identifier
|
|
19129
|
+
* @param {string} filterId The filter identifier
|
|
19130
|
+
* @param {string} conditionId The condition identifier
|
|
19131
|
+
* @param {AnnouncementAudienceConditionUpdateInputs} announcementAudienceConditionUpdateInputs
|
|
19132
|
+
* @param {*} [options] Override http request option.
|
|
19133
|
+
* @throws {RequiredError}
|
|
19134
|
+
*/
|
|
19135
|
+
updateAnnouncementAudienceCondition(audienceId: string, filterId: string, conditionId: string, announcementAudienceConditionUpdateInputs: AnnouncementAudienceConditionUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceCondition200Response>>;
|
|
19136
|
+
/**
|
|
19137
|
+
* Changes a filter group\'s operator or sort order; requires update permission on announcements.
|
|
19138
|
+
* @summary Update an audience filter group
|
|
19139
|
+
* @param {string} audienceId The audience identifier
|
|
19140
|
+
* @param {string} filterId The filter identifier
|
|
19141
|
+
* @param {AnnouncementAudienceFilterUpdateInputs} announcementAudienceFilterUpdateInputs
|
|
19142
|
+
* @param {*} [options] Override http request option.
|
|
19143
|
+
* @throws {RequiredError}
|
|
19144
|
+
*/
|
|
19145
|
+
updateAnnouncementAudienceFilter(audienceId: string, filterId: string, announcementAudienceFilterUpdateInputs: AnnouncementAudienceFilterUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementAudienceFilter200Response>>;
|
|
19146
|
+
};
|
|
19147
|
+
/**
|
|
19148
|
+
* AnnouncementsAudiencesApi - factory interface
|
|
19149
|
+
*/
|
|
19150
|
+
export declare const AnnouncementsAudiencesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
19151
|
+
/**
|
|
19152
|
+
* 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.
|
|
19153
|
+
* @summary Create an announcement audience
|
|
19154
|
+
* @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest} requestParameters Request parameters.
|
|
19155
|
+
* @param {*} [options] Override http request option.
|
|
19156
|
+
* @throws {RequiredError}
|
|
19157
|
+
*/
|
|
19158
|
+
createAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudience200Response>;
|
|
19159
|
+
/**
|
|
19160
|
+
* 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.
|
|
19161
|
+
* @summary Create an audience condition
|
|
19162
|
+
* @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
|
|
19163
|
+
* @param {*} [options] Override http request option.
|
|
19164
|
+
* @throws {RequiredError}
|
|
19165
|
+
*/
|
|
19166
|
+
createAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceCondition200Response>;
|
|
19167
|
+
/**
|
|
19168
|
+
* 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.
|
|
19169
|
+
* @summary Create an audience filter group
|
|
19170
|
+
* @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
|
|
19171
|
+
* @param {*} [options] Override http request option.
|
|
19172
|
+
* @throws {RequiredError}
|
|
19173
|
+
*/
|
|
19174
|
+
createAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceFilter200Response>;
|
|
19175
|
+
/**
|
|
19176
|
+
* Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
|
|
19177
|
+
* @summary Delete an announcement audience
|
|
19178
|
+
* @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest} requestParameters Request parameters.
|
|
19179
|
+
* @param {*} [options] Override http request option.
|
|
19180
|
+
* @throws {RequiredError}
|
|
19181
|
+
*/
|
|
19182
|
+
deleteAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
19183
|
+
/**
|
|
19184
|
+
* Removes a condition from its filter group; requires update permission on announcements.
|
|
19185
|
+
* @summary Delete an audience condition
|
|
19186
|
+
* @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest} requestParameters Request parameters.
|
|
19187
|
+
* @param {*} [options] Override http request option.
|
|
19188
|
+
* @throws {RequiredError}
|
|
19189
|
+
*/
|
|
19190
|
+
deleteAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
19191
|
+
/**
|
|
19192
|
+
* Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
|
|
19193
|
+
* @summary Delete an audience filter group
|
|
19194
|
+
* @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest} requestParameters Request parameters.
|
|
19195
|
+
* @param {*} [options] Override http request option.
|
|
19196
|
+
* @throws {RequiredError}
|
|
19197
|
+
*/
|
|
19198
|
+
deleteAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
19199
|
+
/**
|
|
19200
|
+
* Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
|
|
19201
|
+
* @summary Get an announcement audience
|
|
19202
|
+
* @param {AnnouncementsAudiencesApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
|
|
19203
|
+
* @param {*} [options] Override http request option.
|
|
19204
|
+
* @throws {RequiredError}
|
|
19205
|
+
*/
|
|
19206
|
+
getAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudience200Response>;
|
|
19207
|
+
/**
|
|
19208
|
+
* 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.
|
|
19209
|
+
* @summary List the accounts in an announcement audience
|
|
19210
|
+
* @param {AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest} requestParameters Request parameters.
|
|
19211
|
+
* @param {*} [options] Override http request option.
|
|
19212
|
+
* @throws {RequiredError}
|
|
19213
|
+
*/
|
|
19214
|
+
getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudienceAccounts200Response>;
|
|
19215
|
+
/**
|
|
19216
|
+
* 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.
|
|
19217
|
+
* @summary List announcement audiences
|
|
19218
|
+
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
19219
|
+
* @param {*} [options] Override http request option.
|
|
19220
|
+
* @throws {RequiredError}
|
|
19221
|
+
*/
|
|
19222
|
+
getAnnouncementAudiences(requestParameters?: AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementAudiences200Response>;
|
|
19223
|
+
/**
|
|
19224
|
+
* Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
|
|
19225
|
+
* @summary Update an announcement audience
|
|
19226
|
+
* @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest} requestParameters Request parameters.
|
|
19227
|
+
* @param {*} [options] Override http request option.
|
|
19228
|
+
* @throws {RequiredError}
|
|
19229
|
+
*/
|
|
19230
|
+
updateAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudience200Response>;
|
|
19231
|
+
/**
|
|
19232
|
+
* Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
|
|
19233
|
+
* @summary Update an audience condition
|
|
19234
|
+
* @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
|
|
19235
|
+
* @param {*} [options] Override http request option.
|
|
19236
|
+
* @throws {RequiredError}
|
|
19237
|
+
*/
|
|
19238
|
+
updateAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceCondition200Response>;
|
|
19239
|
+
/**
|
|
19240
|
+
* Changes a filter group\'s operator or sort order; requires update permission on announcements.
|
|
19241
|
+
* @summary Update an audience filter group
|
|
19242
|
+
* @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
|
|
19243
|
+
* @param {*} [options] Override http request option.
|
|
19244
|
+
* @throws {RequiredError}
|
|
19245
|
+
*/
|
|
19246
|
+
updateAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementAudienceFilter200Response>;
|
|
19247
|
+
};
|
|
19248
|
+
/**
|
|
19249
|
+
* Request parameters for createAnnouncementAudience operation in AnnouncementsAudiencesApi.
|
|
19250
|
+
*/
|
|
19251
|
+
export interface AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest {
|
|
19252
|
+
readonly announcementAudienceCreateInputs: AnnouncementAudienceCreateInputs;
|
|
19253
|
+
}
|
|
19254
|
+
/**
|
|
19255
|
+
* Request parameters for createAnnouncementAudienceCondition operation in AnnouncementsAudiencesApi.
|
|
19256
|
+
*/
|
|
19257
|
+
export interface AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest {
|
|
19258
|
+
/**
|
|
19259
|
+
* The audience identifier
|
|
19260
|
+
*/
|
|
19261
|
+
readonly audienceId: string;
|
|
19262
|
+
/**
|
|
19263
|
+
* The filter identifier
|
|
19264
|
+
*/
|
|
19265
|
+
readonly filterId: string;
|
|
19266
|
+
readonly announcementAudienceConditionCreateInputs: AnnouncementAudienceConditionCreateInputs;
|
|
19267
|
+
}
|
|
19268
|
+
/**
|
|
19269
|
+
* Request parameters for createAnnouncementAudienceFilter operation in AnnouncementsAudiencesApi.
|
|
19270
|
+
*/
|
|
19271
|
+
export interface AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest {
|
|
19272
|
+
/**
|
|
19273
|
+
* The audience identifier
|
|
19274
|
+
*/
|
|
19275
|
+
readonly audienceId: string;
|
|
19276
|
+
readonly announcementAudienceFilterCreateInputs: AnnouncementAudienceFilterCreateInputs;
|
|
19277
|
+
}
|
|
19278
|
+
/**
|
|
19279
|
+
* Request parameters for deleteAnnouncementAudience operation in AnnouncementsAudiencesApi.
|
|
19280
|
+
*/
|
|
19281
|
+
export interface AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest {
|
|
19282
|
+
/**
|
|
19283
|
+
* The audience identifier
|
|
19284
|
+
*/
|
|
19285
|
+
readonly audienceId: string;
|
|
19286
|
+
}
|
|
19287
|
+
/**
|
|
19288
|
+
* Request parameters for deleteAnnouncementAudienceCondition operation in AnnouncementsAudiencesApi.
|
|
19289
|
+
*/
|
|
19290
|
+
export interface AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest {
|
|
19291
|
+
/**
|
|
19292
|
+
* The audience identifier
|
|
19293
|
+
*/
|
|
19294
|
+
readonly audienceId: string;
|
|
19295
|
+
/**
|
|
19296
|
+
* The filter identifier
|
|
19297
|
+
*/
|
|
19298
|
+
readonly filterId: string;
|
|
19299
|
+
/**
|
|
19300
|
+
* The condition identifier
|
|
19301
|
+
*/
|
|
19302
|
+
readonly conditionId: string;
|
|
19303
|
+
}
|
|
19304
|
+
/**
|
|
19305
|
+
* Request parameters for deleteAnnouncementAudienceFilter operation in AnnouncementsAudiencesApi.
|
|
19306
|
+
*/
|
|
19307
|
+
export interface AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest {
|
|
19308
|
+
/**
|
|
19309
|
+
* The audience identifier
|
|
19310
|
+
*/
|
|
19311
|
+
readonly audienceId: string;
|
|
19312
|
+
/**
|
|
19313
|
+
* The filter identifier
|
|
19314
|
+
*/
|
|
19315
|
+
readonly filterId: string;
|
|
19316
|
+
}
|
|
19317
|
+
/**
|
|
19318
|
+
* Request parameters for getAnnouncementAudience operation in AnnouncementsAudiencesApi.
|
|
19319
|
+
*/
|
|
19320
|
+
export interface AnnouncementsAudiencesApiGetAnnouncementAudienceRequest {
|
|
19321
|
+
/**
|
|
19322
|
+
* The audience identifier
|
|
19323
|
+
*/
|
|
19324
|
+
readonly audienceId: string;
|
|
19325
|
+
}
|
|
19326
|
+
/**
|
|
19327
|
+
* Request parameters for getAnnouncementAudienceAccounts operation in AnnouncementsAudiencesApi.
|
|
19328
|
+
*/
|
|
19329
|
+
export interface AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest {
|
|
19330
|
+
/**
|
|
19331
|
+
* The audience identifier
|
|
19332
|
+
*/
|
|
19333
|
+
readonly audienceId: string;
|
|
19334
|
+
/**
|
|
19335
|
+
* Page number
|
|
19336
|
+
*/
|
|
19337
|
+
readonly page?: number;
|
|
19338
|
+
/**
|
|
19339
|
+
* Number of items per page
|
|
19340
|
+
*/
|
|
19341
|
+
readonly pageSize?: number;
|
|
19342
|
+
/**
|
|
19343
|
+
* Field to order by
|
|
19344
|
+
*/
|
|
19345
|
+
readonly orderBy?: string;
|
|
19346
|
+
/**
|
|
19347
|
+
* Search query
|
|
19348
|
+
*/
|
|
19349
|
+
readonly search?: string;
|
|
19350
|
+
}
|
|
19351
|
+
/**
|
|
19352
|
+
* Request parameters for getAnnouncementAudiences operation in AnnouncementsAudiencesApi.
|
|
19353
|
+
*/
|
|
19354
|
+
export interface AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest {
|
|
19355
|
+
/**
|
|
19356
|
+
* Filter by scope
|
|
19357
|
+
*/
|
|
19358
|
+
readonly scope?: AnnouncementAudienceScope;
|
|
19359
|
+
/**
|
|
19360
|
+
* Page number
|
|
19361
|
+
*/
|
|
19362
|
+
readonly page?: number;
|
|
19363
|
+
/**
|
|
19364
|
+
* Number of items per page
|
|
19365
|
+
*/
|
|
19366
|
+
readonly pageSize?: number;
|
|
19367
|
+
/**
|
|
19368
|
+
* Field to order by
|
|
19369
|
+
*/
|
|
19370
|
+
readonly orderBy?: string;
|
|
19371
|
+
/**
|
|
19372
|
+
* Search query
|
|
19373
|
+
*/
|
|
19374
|
+
readonly search?: string;
|
|
19375
|
+
}
|
|
19376
|
+
/**
|
|
19377
|
+
* Request parameters for updateAnnouncementAudience operation in AnnouncementsAudiencesApi.
|
|
19378
|
+
*/
|
|
19379
|
+
export interface AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest {
|
|
19380
|
+
/**
|
|
19381
|
+
* The audience identifier
|
|
19382
|
+
*/
|
|
19383
|
+
readonly audienceId: string;
|
|
19384
|
+
readonly announcementAudienceUpdateInputs: AnnouncementAudienceUpdateInputs;
|
|
19385
|
+
}
|
|
19386
|
+
/**
|
|
19387
|
+
* Request parameters for updateAnnouncementAudienceCondition operation in AnnouncementsAudiencesApi.
|
|
19388
|
+
*/
|
|
19389
|
+
export interface AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest {
|
|
19390
|
+
/**
|
|
19391
|
+
* The audience identifier
|
|
19392
|
+
*/
|
|
19393
|
+
readonly audienceId: string;
|
|
19394
|
+
/**
|
|
19395
|
+
* The filter identifier
|
|
19396
|
+
*/
|
|
19397
|
+
readonly filterId: string;
|
|
19398
|
+
/**
|
|
19399
|
+
* The condition identifier
|
|
19400
|
+
*/
|
|
19401
|
+
readonly conditionId: string;
|
|
19402
|
+
readonly announcementAudienceConditionUpdateInputs: AnnouncementAudienceConditionUpdateInputs;
|
|
19403
|
+
}
|
|
19404
|
+
/**
|
|
19405
|
+
* Request parameters for updateAnnouncementAudienceFilter operation in AnnouncementsAudiencesApi.
|
|
19406
|
+
*/
|
|
19407
|
+
export interface AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest {
|
|
19408
|
+
/**
|
|
19409
|
+
* The audience identifier
|
|
19410
|
+
*/
|
|
19411
|
+
readonly audienceId: string;
|
|
19412
|
+
/**
|
|
19413
|
+
* The filter identifier
|
|
19414
|
+
*/
|
|
19415
|
+
readonly filterId: string;
|
|
19416
|
+
readonly announcementAudienceFilterUpdateInputs: AnnouncementAudienceFilterUpdateInputs;
|
|
19417
|
+
}
|
|
19418
|
+
/**
|
|
19419
|
+
* AnnouncementsAudiencesApi - object-oriented interface
|
|
19420
|
+
*/
|
|
19421
|
+
export declare class AnnouncementsAudiencesApi extends BaseAPI {
|
|
19422
|
+
/**
|
|
19423
|
+
* 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.
|
|
19424
|
+
* @summary Create an announcement audience
|
|
19425
|
+
* @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest} requestParameters Request parameters.
|
|
19426
|
+
* @param {*} [options] Override http request option.
|
|
19427
|
+
* @throws {RequiredError}
|
|
19428
|
+
*/
|
|
19429
|
+
createAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudience200Response, any, {}, any>>;
|
|
19430
|
+
/**
|
|
19431
|
+
* 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.
|
|
19432
|
+
* @summary Create an audience condition
|
|
19433
|
+
* @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
|
|
19434
|
+
* @param {*} [options] Override http request option.
|
|
19435
|
+
* @throws {RequiredError}
|
|
19436
|
+
*/
|
|
19437
|
+
createAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudienceCondition200Response, any, {}, any>>;
|
|
19438
|
+
/**
|
|
19439
|
+
* 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.
|
|
19440
|
+
* @summary Create an audience filter group
|
|
19441
|
+
* @param {AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
|
|
19442
|
+
* @param {*} [options] Override http request option.
|
|
19443
|
+
* @throws {RequiredError}
|
|
19444
|
+
*/
|
|
19445
|
+
createAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiCreateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudienceFilter200Response, any, {}, any>>;
|
|
19446
|
+
/**
|
|
19447
|
+
* Permanently deletes an audience along with its filter groups and conditions; requires delete permission on announcements.
|
|
19448
|
+
* @summary Delete an announcement audience
|
|
19449
|
+
* @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest} requestParameters Request parameters.
|
|
19450
|
+
* @param {*} [options] Override http request option.
|
|
19451
|
+
* @throws {RequiredError}
|
|
19452
|
+
*/
|
|
19453
|
+
deleteAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
19454
|
+
/**
|
|
19455
|
+
* Removes a condition from its filter group; requires update permission on announcements.
|
|
19456
|
+
* @summary Delete an audience condition
|
|
19457
|
+
* @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest} requestParameters Request parameters.
|
|
19458
|
+
* @param {*} [options] Override http request option.
|
|
19459
|
+
* @throws {RequiredError}
|
|
19460
|
+
*/
|
|
19461
|
+
deleteAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
19462
|
+
/**
|
|
19463
|
+
* Deletes a filter group together with its nested groups and conditions; requires update permission on announcements.
|
|
19464
|
+
* @summary Delete an audience filter group
|
|
19465
|
+
* @param {AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest} requestParameters Request parameters.
|
|
19466
|
+
* @param {*} [options] Override http request option.
|
|
19467
|
+
* @throws {RequiredError}
|
|
19468
|
+
*/
|
|
19469
|
+
deleteAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiDeleteAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
19470
|
+
/**
|
|
19471
|
+
* Returns one announcement audience with all of its filter groups and conditions, flat, ordered by sortOrder; requires read permission on announcements.
|
|
19472
|
+
* @summary Get an announcement audience
|
|
19473
|
+
* @param {AnnouncementsAudiencesApiGetAnnouncementAudienceRequest} requestParameters Request parameters.
|
|
19474
|
+
* @param {*} [options] Override http request option.
|
|
19475
|
+
* @throws {RequiredError}
|
|
19476
|
+
*/
|
|
19477
|
+
getAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudience200Response, any, {}, any>>;
|
|
19478
|
+
/**
|
|
19479
|
+
* 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.
|
|
19480
|
+
* @summary List the accounts in an announcement audience
|
|
19481
|
+
* @param {AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest} requestParameters Request parameters.
|
|
19482
|
+
* @param {*} [options] Override http request option.
|
|
19483
|
+
* @throws {RequiredError}
|
|
19484
|
+
*/
|
|
19485
|
+
getAnnouncementAudienceAccounts(requestParameters: AnnouncementsAudiencesApiGetAnnouncementAudienceAccountsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementAudienceAccounts200Response, any, {}, any>>;
|
|
19486
|
+
/**
|
|
19487
|
+
* 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.
|
|
19488
|
+
* @summary List announcement audiences
|
|
19489
|
+
* @param {AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest} requestParameters Request parameters.
|
|
19490
|
+
* @param {*} [options] Override http request option.
|
|
19491
|
+
* @throws {RequiredError}
|
|
19492
|
+
*/
|
|
19493
|
+
getAnnouncementAudiences(requestParameters?: AnnouncementsAudiencesApiGetAnnouncementAudiencesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementAudiences200Response, any, {}, any>>;
|
|
19494
|
+
/**
|
|
19495
|
+
* Updates an audience\'s name, description, or root operator (how its top-level filter groups combine); requires update permission on announcements.
|
|
19496
|
+
* @summary Update an announcement audience
|
|
19497
|
+
* @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest} requestParameters Request parameters.
|
|
19498
|
+
* @param {*} [options] Override http request option.
|
|
19499
|
+
* @throws {RequiredError}
|
|
19500
|
+
*/
|
|
19501
|
+
updateAnnouncementAudience(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudience200Response, any, {}, any>>;
|
|
19502
|
+
/**
|
|
19503
|
+
* Updates a condition; changing its type clears the references the new type does not use; requires update permission on announcements.
|
|
19504
|
+
* @summary Update an audience condition
|
|
19505
|
+
* @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest} requestParameters Request parameters.
|
|
19506
|
+
* @param {*} [options] Override http request option.
|
|
19507
|
+
* @throws {RequiredError}
|
|
19508
|
+
*/
|
|
19509
|
+
updateAnnouncementAudienceCondition(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceConditionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudienceCondition200Response, any, {}, any>>;
|
|
19510
|
+
/**
|
|
19511
|
+
* Changes a filter group\'s operator or sort order; requires update permission on announcements.
|
|
19512
|
+
* @summary Update an audience filter group
|
|
19513
|
+
* @param {AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest} requestParameters Request parameters.
|
|
19514
|
+
* @param {*} [options] Override http request option.
|
|
19515
|
+
* @throws {RequiredError}
|
|
19516
|
+
*/
|
|
19517
|
+
updateAnnouncementAudienceFilter(requestParameters: AnnouncementsAudiencesApiUpdateAnnouncementAudienceFilterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementAudienceFilter200Response, any, {}, any>>;
|
|
19518
|
+
}
|
|
18541
19519
|
/**
|
|
18542
19520
|
* AnnouncementsScheduleApi - axios parameter creator
|
|
18543
19521
|
*/
|
|
@@ -18643,6 +19621,478 @@ export declare class AnnouncementsScheduleApi extends BaseAPI {
|
|
|
18643
19621
|
*/
|
|
18644
19622
|
updateAnnouncementSchedule(requestParameters: AnnouncementsScheduleApiUpdateAnnouncementScheduleRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncement200Response, any, {}, any>>;
|
|
18645
19623
|
}
|
|
19624
|
+
/**
|
|
19625
|
+
* AnnouncementsTemplatesApi - axios parameter creator
|
|
19626
|
+
*/
|
|
19627
|
+
export declare const AnnouncementsTemplatesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
19628
|
+
/**
|
|
19629
|
+
* Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
|
|
19630
|
+
* @summary Create an announcement template
|
|
19631
|
+
* @param {AnnouncementTemplateCreateInputs} announcementTemplateCreateInputs
|
|
19632
|
+
* @param {*} [options] Override http request option.
|
|
19633
|
+
* @throws {RequiredError}
|
|
19634
|
+
*/
|
|
19635
|
+
createAnnouncementTemplate: (announcementTemplateCreateInputs: AnnouncementTemplateCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19636
|
+
/**
|
|
19637
|
+
* Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
|
|
19638
|
+
* @summary Delete an announcement template
|
|
19639
|
+
* @param {string} templateId The template identifier
|
|
19640
|
+
* @param {*} [options] Override http request option.
|
|
19641
|
+
* @throws {RequiredError}
|
|
19642
|
+
*/
|
|
19643
|
+
deleteAnnouncementTemplate: (templateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19644
|
+
/**
|
|
19645
|
+
* Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
|
|
19646
|
+
* @summary Get an announcement template
|
|
19647
|
+
* @param {string} templateId The template identifier
|
|
19648
|
+
* @param {*} [options] Override http request option.
|
|
19649
|
+
* @throws {RequiredError}
|
|
19650
|
+
*/
|
|
19651
|
+
getAnnouncementTemplate: (templateId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19652
|
+
/**
|
|
19653
|
+
* Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
|
|
19654
|
+
* @summary List announcement templates
|
|
19655
|
+
* @param {number} [page] Page number
|
|
19656
|
+
* @param {number} [pageSize] Number of items per page
|
|
19657
|
+
* @param {string} [orderBy] Field to order by
|
|
19658
|
+
* @param {string} [search] Search query
|
|
19659
|
+
* @param {*} [options] Override http request option.
|
|
19660
|
+
* @throws {RequiredError}
|
|
19661
|
+
*/
|
|
19662
|
+
getAnnouncementTemplates: (page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19663
|
+
/**
|
|
19664
|
+
* 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.
|
|
19665
|
+
* @summary Update an announcement template
|
|
19666
|
+
* @param {string} templateId The template identifier
|
|
19667
|
+
* @param {AnnouncementTemplateUpdateInputs} announcementTemplateUpdateInputs
|
|
19668
|
+
* @param {*} [options] Override http request option.
|
|
19669
|
+
* @throws {RequiredError}
|
|
19670
|
+
*/
|
|
19671
|
+
updateAnnouncementTemplate: (templateId: string, announcementTemplateUpdateInputs: AnnouncementTemplateUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19672
|
+
};
|
|
19673
|
+
/**
|
|
19674
|
+
* AnnouncementsTemplatesApi - functional programming interface
|
|
19675
|
+
*/
|
|
19676
|
+
export declare const AnnouncementsTemplatesApiFp: (configuration?: Configuration) => {
|
|
19677
|
+
/**
|
|
19678
|
+
* Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
|
|
19679
|
+
* @summary Create an announcement template
|
|
19680
|
+
* @param {AnnouncementTemplateCreateInputs} announcementTemplateCreateInputs
|
|
19681
|
+
* @param {*} [options] Override http request option.
|
|
19682
|
+
* @throws {RequiredError}
|
|
19683
|
+
*/
|
|
19684
|
+
createAnnouncementTemplate(announcementTemplateCreateInputs: AnnouncementTemplateCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementTemplate200Response>>;
|
|
19685
|
+
/**
|
|
19686
|
+
* Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
|
|
19687
|
+
* @summary Delete an announcement template
|
|
19688
|
+
* @param {string} templateId The template identifier
|
|
19689
|
+
* @param {*} [options] Override http request option.
|
|
19690
|
+
* @throws {RequiredError}
|
|
19691
|
+
*/
|
|
19692
|
+
deleteAnnouncementTemplate(templateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
19693
|
+
/**
|
|
19694
|
+
* Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
|
|
19695
|
+
* @summary Get an announcement template
|
|
19696
|
+
* @param {string} templateId The template identifier
|
|
19697
|
+
* @param {*} [options] Override http request option.
|
|
19698
|
+
* @throws {RequiredError}
|
|
19699
|
+
*/
|
|
19700
|
+
getAnnouncementTemplate(templateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementTemplate200Response>>;
|
|
19701
|
+
/**
|
|
19702
|
+
* Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
|
|
19703
|
+
* @summary List announcement templates
|
|
19704
|
+
* @param {number} [page] Page number
|
|
19705
|
+
* @param {number} [pageSize] Number of items per page
|
|
19706
|
+
* @param {string} [orderBy] Field to order by
|
|
19707
|
+
* @param {string} [search] Search query
|
|
19708
|
+
* @param {*} [options] Override http request option.
|
|
19709
|
+
* @throws {RequiredError}
|
|
19710
|
+
*/
|
|
19711
|
+
getAnnouncementTemplates(page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementTemplates200Response>>;
|
|
19712
|
+
/**
|
|
19713
|
+
* 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.
|
|
19714
|
+
* @summary Update an announcement template
|
|
19715
|
+
* @param {string} templateId The template identifier
|
|
19716
|
+
* @param {AnnouncementTemplateUpdateInputs} announcementTemplateUpdateInputs
|
|
19717
|
+
* @param {*} [options] Override http request option.
|
|
19718
|
+
* @throws {RequiredError}
|
|
19719
|
+
*/
|
|
19720
|
+
updateAnnouncementTemplate(templateId: string, announcementTemplateUpdateInputs: AnnouncementTemplateUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAnnouncementTemplate200Response>>;
|
|
19721
|
+
};
|
|
19722
|
+
/**
|
|
19723
|
+
* AnnouncementsTemplatesApi - factory interface
|
|
19724
|
+
*/
|
|
19725
|
+
export declare const AnnouncementsTemplatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
19726
|
+
/**
|
|
19727
|
+
* Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
|
|
19728
|
+
* @summary Create an announcement template
|
|
19729
|
+
* @param {AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest} requestParameters Request parameters.
|
|
19730
|
+
* @param {*} [options] Override http request option.
|
|
19731
|
+
* @throws {RequiredError}
|
|
19732
|
+
*/
|
|
19733
|
+
createAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementTemplate200Response>;
|
|
19734
|
+
/**
|
|
19735
|
+
* Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
|
|
19736
|
+
* @summary Delete an announcement template
|
|
19737
|
+
* @param {AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest} requestParameters Request parameters.
|
|
19738
|
+
* @param {*} [options] Override http request option.
|
|
19739
|
+
* @throws {RequiredError}
|
|
19740
|
+
*/
|
|
19741
|
+
deleteAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
19742
|
+
/**
|
|
19743
|
+
* Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
|
|
19744
|
+
* @summary Get an announcement template
|
|
19745
|
+
* @param {AnnouncementsTemplatesApiGetAnnouncementTemplateRequest} requestParameters Request parameters.
|
|
19746
|
+
* @param {*} [options] Override http request option.
|
|
19747
|
+
* @throws {RequiredError}
|
|
19748
|
+
*/
|
|
19749
|
+
getAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiGetAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementTemplate200Response>;
|
|
19750
|
+
/**
|
|
19751
|
+
* Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
|
|
19752
|
+
* @summary List announcement templates
|
|
19753
|
+
* @param {AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest} requestParameters Request parameters.
|
|
19754
|
+
* @param {*} [options] Override http request option.
|
|
19755
|
+
* @throws {RequiredError}
|
|
19756
|
+
*/
|
|
19757
|
+
getAnnouncementTemplates(requestParameters?: AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementTemplates200Response>;
|
|
19758
|
+
/**
|
|
19759
|
+
* 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.
|
|
19760
|
+
* @summary Update an announcement template
|
|
19761
|
+
* @param {AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest} requestParameters Request parameters.
|
|
19762
|
+
* @param {*} [options] Override http request option.
|
|
19763
|
+
* @throws {RequiredError}
|
|
19764
|
+
*/
|
|
19765
|
+
updateAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAnnouncementTemplate200Response>;
|
|
19766
|
+
};
|
|
19767
|
+
/**
|
|
19768
|
+
* Request parameters for createAnnouncementTemplate operation in AnnouncementsTemplatesApi.
|
|
19769
|
+
*/
|
|
19770
|
+
export interface AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest {
|
|
19771
|
+
readonly announcementTemplateCreateInputs: AnnouncementTemplateCreateInputs;
|
|
19772
|
+
}
|
|
19773
|
+
/**
|
|
19774
|
+
* Request parameters for deleteAnnouncementTemplate operation in AnnouncementsTemplatesApi.
|
|
19775
|
+
*/
|
|
19776
|
+
export interface AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest {
|
|
19777
|
+
/**
|
|
19778
|
+
* The template identifier
|
|
19779
|
+
*/
|
|
19780
|
+
readonly templateId: string;
|
|
19781
|
+
}
|
|
19782
|
+
/**
|
|
19783
|
+
* Request parameters for getAnnouncementTemplate operation in AnnouncementsTemplatesApi.
|
|
19784
|
+
*/
|
|
19785
|
+
export interface AnnouncementsTemplatesApiGetAnnouncementTemplateRequest {
|
|
19786
|
+
/**
|
|
19787
|
+
* The template identifier
|
|
19788
|
+
*/
|
|
19789
|
+
readonly templateId: string;
|
|
19790
|
+
}
|
|
19791
|
+
/**
|
|
19792
|
+
* Request parameters for getAnnouncementTemplates operation in AnnouncementsTemplatesApi.
|
|
19793
|
+
*/
|
|
19794
|
+
export interface AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest {
|
|
19795
|
+
/**
|
|
19796
|
+
* Page number
|
|
19797
|
+
*/
|
|
19798
|
+
readonly page?: number;
|
|
19799
|
+
/**
|
|
19800
|
+
* Number of items per page
|
|
19801
|
+
*/
|
|
19802
|
+
readonly pageSize?: number;
|
|
19803
|
+
/**
|
|
19804
|
+
* Field to order by
|
|
19805
|
+
*/
|
|
19806
|
+
readonly orderBy?: string;
|
|
19807
|
+
/**
|
|
19808
|
+
* Search query
|
|
19809
|
+
*/
|
|
19810
|
+
readonly search?: string;
|
|
19811
|
+
}
|
|
19812
|
+
/**
|
|
19813
|
+
* Request parameters for updateAnnouncementTemplate operation in AnnouncementsTemplatesApi.
|
|
19814
|
+
*/
|
|
19815
|
+
export interface AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest {
|
|
19816
|
+
/**
|
|
19817
|
+
* The template identifier
|
|
19818
|
+
*/
|
|
19819
|
+
readonly templateId: string;
|
|
19820
|
+
readonly announcementTemplateUpdateInputs: AnnouncementTemplateUpdateInputs;
|
|
19821
|
+
}
|
|
19822
|
+
/**
|
|
19823
|
+
* AnnouncementsTemplatesApi - object-oriented interface
|
|
19824
|
+
*/
|
|
19825
|
+
export declare class AnnouncementsTemplatesApi extends BaseAPI {
|
|
19826
|
+
/**
|
|
19827
|
+
* Creates a reusable announcement template with a name and optional default subject and HTML body; requires create permission on announcements.
|
|
19828
|
+
* @summary Create an announcement template
|
|
19829
|
+
* @param {AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest} requestParameters Request parameters.
|
|
19830
|
+
* @param {*} [options] Override http request option.
|
|
19831
|
+
* @throws {RequiredError}
|
|
19832
|
+
*/
|
|
19833
|
+
createAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiCreateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementTemplate200Response, any, {}, any>>;
|
|
19834
|
+
/**
|
|
19835
|
+
* Permanently deletes a template and its translations. Announcements created from it are unaffected; requires delete permission on announcements.
|
|
19836
|
+
* @summary Delete an announcement template
|
|
19837
|
+
* @param {AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest} requestParameters Request parameters.
|
|
19838
|
+
* @param {*} [options] Override http request option.
|
|
19839
|
+
* @throws {RequiredError}
|
|
19840
|
+
*/
|
|
19841
|
+
deleteAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiDeleteAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
19842
|
+
/**
|
|
19843
|
+
* Returns one announcement template with its name, description, default subject and HTML body; requires read permission on announcements.
|
|
19844
|
+
* @summary Get an announcement template
|
|
19845
|
+
* @param {AnnouncementsTemplatesApiGetAnnouncementTemplateRequest} requestParameters Request parameters.
|
|
19846
|
+
* @param {*} [options] Override http request option.
|
|
19847
|
+
* @throws {RequiredError}
|
|
19848
|
+
*/
|
|
19849
|
+
getAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiGetAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementTemplate200Response, any, {}, any>>;
|
|
19850
|
+
/**
|
|
19851
|
+
* Returns a paginated list of the organization\'s announcement templates, searchable by name; requires read permission on announcements.
|
|
19852
|
+
* @summary List announcement templates
|
|
19853
|
+
* @param {AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest} requestParameters Request parameters.
|
|
19854
|
+
* @param {*} [options] Override http request option.
|
|
19855
|
+
* @throws {RequiredError}
|
|
19856
|
+
*/
|
|
19857
|
+
getAnnouncementTemplates(requestParameters?: AnnouncementsTemplatesApiGetAnnouncementTemplatesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementTemplates200Response, any, {}, any>>;
|
|
19858
|
+
/**
|
|
19859
|
+
* 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.
|
|
19860
|
+
* @summary Update an announcement template
|
|
19861
|
+
* @param {AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest} requestParameters Request parameters.
|
|
19862
|
+
* @param {*} [options] Override http request option.
|
|
19863
|
+
* @throws {RequiredError}
|
|
19864
|
+
*/
|
|
19865
|
+
updateAnnouncementTemplate(requestParameters: AnnouncementsTemplatesApiUpdateAnnouncementTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAnnouncementTemplate200Response, any, {}, any>>;
|
|
19866
|
+
}
|
|
19867
|
+
/**
|
|
19868
|
+
* AnnouncementsTemplatesTranslationsApi - axios parameter creator
|
|
19869
|
+
*/
|
|
19870
|
+
export declare const AnnouncementsTemplatesTranslationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
19871
|
+
/**
|
|
19872
|
+
* Removes the translation of a template in the specified locale; requires update permission on announcements.
|
|
19873
|
+
* @summary Delete an announcement template translation
|
|
19874
|
+
* @param {string} templateId The template identifier
|
|
19875
|
+
* @param {string} locale The locale identifier
|
|
19876
|
+
* @param {*} [options] Override http request option.
|
|
19877
|
+
* @throws {RequiredError}
|
|
19878
|
+
*/
|
|
19879
|
+
deleteAnnouncementTemplateTranslation: (templateId: string, locale: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19880
|
+
/**
|
|
19881
|
+
* 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.
|
|
19882
|
+
* @summary Get an announcement template\'s translation for a locale
|
|
19883
|
+
* @param {string} templateId The template identifier
|
|
19884
|
+
* @param {string} locale The locale identifier
|
|
19885
|
+
* @param {*} [options] Override http request option.
|
|
19886
|
+
* @throws {RequiredError}
|
|
19887
|
+
*/
|
|
19888
|
+
getAnnouncementTemplateTranslation: (templateId: string, locale: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19889
|
+
/**
|
|
19890
|
+
* Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
|
|
19891
|
+
* @summary List an announcement template\'s translations
|
|
19892
|
+
* @param {string} templateId The template identifier
|
|
19893
|
+
* @param {number} [page] Page number
|
|
19894
|
+
* @param {number} [pageSize] Number of items per page
|
|
19895
|
+
* @param {string} [orderBy] Field to order by
|
|
19896
|
+
* @param {string} [search] Search query
|
|
19897
|
+
* @param {*} [options] Override http request option.
|
|
19898
|
+
* @throws {RequiredError}
|
|
19899
|
+
*/
|
|
19900
|
+
getAnnouncementTemplateTranslations: (templateId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19901
|
+
/**
|
|
19902
|
+
* Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
|
|
19903
|
+
* @summary Update an announcement template translation
|
|
19904
|
+
* @param {string} templateId The template identifier
|
|
19905
|
+
* @param {string} locale The locale identifier
|
|
19906
|
+
* @param {AnnouncementTemplateTranslationUpdateInputs} announcementTemplateTranslationUpdateInputs
|
|
19907
|
+
* @param {*} [options] Override http request option.
|
|
19908
|
+
* @throws {RequiredError}
|
|
19909
|
+
*/
|
|
19910
|
+
updateAnnouncementTemplateTranslation: (templateId: string, locale: string, announcementTemplateTranslationUpdateInputs: AnnouncementTemplateTranslationUpdateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
19911
|
+
};
|
|
19912
|
+
/**
|
|
19913
|
+
* AnnouncementsTemplatesTranslationsApi - functional programming interface
|
|
19914
|
+
*/
|
|
19915
|
+
export declare const AnnouncementsTemplatesTranslationsApiFp: (configuration?: Configuration) => {
|
|
19916
|
+
/**
|
|
19917
|
+
* Removes the translation of a template in the specified locale; requires update permission on announcements.
|
|
19918
|
+
* @summary Delete an announcement template translation
|
|
19919
|
+
* @param {string} templateId The template identifier
|
|
19920
|
+
* @param {string} locale The locale identifier
|
|
19921
|
+
* @param {*} [options] Override http request option.
|
|
19922
|
+
* @throws {RequiredError}
|
|
19923
|
+
*/
|
|
19924
|
+
deleteAnnouncementTemplateTranslation(templateId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
19925
|
+
/**
|
|
19926
|
+
* 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.
|
|
19927
|
+
* @summary Get an announcement template\'s translation for a locale
|
|
19928
|
+
* @param {string} templateId The template identifier
|
|
19929
|
+
* @param {string} locale The locale identifier
|
|
19930
|
+
* @param {*} [options] Override http request option.
|
|
19931
|
+
* @throws {RequiredError}
|
|
19932
|
+
*/
|
|
19933
|
+
getAnnouncementTemplateTranslation(templateId: string, locale: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementTemplateTranslation200Response>>;
|
|
19934
|
+
/**
|
|
19935
|
+
* Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
|
|
19936
|
+
* @summary List an announcement template\'s translations
|
|
19937
|
+
* @param {string} templateId The template identifier
|
|
19938
|
+
* @param {number} [page] Page number
|
|
19939
|
+
* @param {number} [pageSize] Number of items per page
|
|
19940
|
+
* @param {string} [orderBy] Field to order by
|
|
19941
|
+
* @param {string} [search] Search query
|
|
19942
|
+
* @param {*} [options] Override http request option.
|
|
19943
|
+
* @throws {RequiredError}
|
|
19944
|
+
*/
|
|
19945
|
+
getAnnouncementTemplateTranslations(templateId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAnnouncementTemplateTranslations200Response>>;
|
|
19946
|
+
/**
|
|
19947
|
+
* Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
|
|
19948
|
+
* @summary Update an announcement template translation
|
|
19949
|
+
* @param {string} templateId The template identifier
|
|
19950
|
+
* @param {string} locale The locale identifier
|
|
19951
|
+
* @param {AnnouncementTemplateTranslationUpdateInputs} announcementTemplateTranslationUpdateInputs
|
|
19952
|
+
* @param {*} [options] Override http request option.
|
|
19953
|
+
* @throws {RequiredError}
|
|
19954
|
+
*/
|
|
19955
|
+
updateAnnouncementTemplateTranslation(templateId: string, locale: string, announcementTemplateTranslationUpdateInputs: AnnouncementTemplateTranslationUpdateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateAnnouncementTemplateTranslation200Response>>;
|
|
19956
|
+
};
|
|
19957
|
+
/**
|
|
19958
|
+
* AnnouncementsTemplatesTranslationsApi - factory interface
|
|
19959
|
+
*/
|
|
19960
|
+
export declare const AnnouncementsTemplatesTranslationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
19961
|
+
/**
|
|
19962
|
+
* Removes the translation of a template in the specified locale; requires update permission on announcements.
|
|
19963
|
+
* @summary Delete an announcement template translation
|
|
19964
|
+
* @param {AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
|
|
19965
|
+
* @param {*} [options] Override http request option.
|
|
19966
|
+
* @throws {RequiredError}
|
|
19967
|
+
*/
|
|
19968
|
+
deleteAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
19969
|
+
/**
|
|
19970
|
+
* 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.
|
|
19971
|
+
* @summary Get an announcement template\'s translation for a locale
|
|
19972
|
+
* @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
|
|
19973
|
+
* @param {*} [options] Override http request option.
|
|
19974
|
+
* @throws {RequiredError}
|
|
19975
|
+
*/
|
|
19976
|
+
getAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementTemplateTranslation200Response>;
|
|
19977
|
+
/**
|
|
19978
|
+
* Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
|
|
19979
|
+
* @summary List an announcement template\'s translations
|
|
19980
|
+
* @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest} requestParameters Request parameters.
|
|
19981
|
+
* @param {*} [options] Override http request option.
|
|
19982
|
+
* @throws {RequiredError}
|
|
19983
|
+
*/
|
|
19984
|
+
getAnnouncementTemplateTranslations(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAnnouncementTemplateTranslations200Response>;
|
|
19985
|
+
/**
|
|
19986
|
+
* Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
|
|
19987
|
+
* @summary Update an announcement template translation
|
|
19988
|
+
* @param {AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
|
|
19989
|
+
* @param {*} [options] Override http request option.
|
|
19990
|
+
* @throws {RequiredError}
|
|
19991
|
+
*/
|
|
19992
|
+
updateAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateAnnouncementTemplateTranslation200Response>;
|
|
19993
|
+
};
|
|
19994
|
+
/**
|
|
19995
|
+
* Request parameters for deleteAnnouncementTemplateTranslation operation in AnnouncementsTemplatesTranslationsApi.
|
|
19996
|
+
*/
|
|
19997
|
+
export interface AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest {
|
|
19998
|
+
/**
|
|
19999
|
+
* The template identifier
|
|
20000
|
+
*/
|
|
20001
|
+
readonly templateId: string;
|
|
20002
|
+
/**
|
|
20003
|
+
* The locale identifier
|
|
20004
|
+
*/
|
|
20005
|
+
readonly locale: string;
|
|
20006
|
+
}
|
|
20007
|
+
/**
|
|
20008
|
+
* Request parameters for getAnnouncementTemplateTranslation operation in AnnouncementsTemplatesTranslationsApi.
|
|
20009
|
+
*/
|
|
20010
|
+
export interface AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest {
|
|
20011
|
+
/**
|
|
20012
|
+
* The template identifier
|
|
20013
|
+
*/
|
|
20014
|
+
readonly templateId: string;
|
|
20015
|
+
/**
|
|
20016
|
+
* The locale identifier
|
|
20017
|
+
*/
|
|
20018
|
+
readonly locale: string;
|
|
20019
|
+
}
|
|
20020
|
+
/**
|
|
20021
|
+
* Request parameters for getAnnouncementTemplateTranslations operation in AnnouncementsTemplatesTranslationsApi.
|
|
20022
|
+
*/
|
|
20023
|
+
export interface AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest {
|
|
20024
|
+
/**
|
|
20025
|
+
* The template identifier
|
|
20026
|
+
*/
|
|
20027
|
+
readonly templateId: string;
|
|
20028
|
+
/**
|
|
20029
|
+
* Page number
|
|
20030
|
+
*/
|
|
20031
|
+
readonly page?: number;
|
|
20032
|
+
/**
|
|
20033
|
+
* Number of items per page
|
|
20034
|
+
*/
|
|
20035
|
+
readonly pageSize?: number;
|
|
20036
|
+
/**
|
|
20037
|
+
* Field to order by
|
|
20038
|
+
*/
|
|
20039
|
+
readonly orderBy?: string;
|
|
20040
|
+
/**
|
|
20041
|
+
* Search query
|
|
20042
|
+
*/
|
|
20043
|
+
readonly search?: string;
|
|
20044
|
+
}
|
|
20045
|
+
/**
|
|
20046
|
+
* Request parameters for updateAnnouncementTemplateTranslation operation in AnnouncementsTemplatesTranslationsApi.
|
|
20047
|
+
*/
|
|
20048
|
+
export interface AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest {
|
|
20049
|
+
/**
|
|
20050
|
+
* The template identifier
|
|
20051
|
+
*/
|
|
20052
|
+
readonly templateId: string;
|
|
20053
|
+
/**
|
|
20054
|
+
* The locale identifier
|
|
20055
|
+
*/
|
|
20056
|
+
readonly locale: string;
|
|
20057
|
+
readonly announcementTemplateTranslationUpdateInputs: AnnouncementTemplateTranslationUpdateInputs;
|
|
20058
|
+
}
|
|
20059
|
+
/**
|
|
20060
|
+
* AnnouncementsTemplatesTranslationsApi - object-oriented interface
|
|
20061
|
+
*/
|
|
20062
|
+
export declare class AnnouncementsTemplatesTranslationsApi extends BaseAPI {
|
|
20063
|
+
/**
|
|
20064
|
+
* Removes the translation of a template in the specified locale; requires update permission on announcements.
|
|
20065
|
+
* @summary Delete an announcement template translation
|
|
20066
|
+
* @param {AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
|
|
20067
|
+
* @param {*} [options] Override http request option.
|
|
20068
|
+
* @throws {RequiredError}
|
|
20069
|
+
*/
|
|
20070
|
+
deleteAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiDeleteAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
20071
|
+
/**
|
|
20072
|
+
* 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.
|
|
20073
|
+
* @summary Get an announcement template\'s translation for a locale
|
|
20074
|
+
* @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
|
|
20075
|
+
* @param {*} [options] Override http request option.
|
|
20076
|
+
* @throws {RequiredError}
|
|
20077
|
+
*/
|
|
20078
|
+
getAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementTemplateTranslation200Response, any, {}, any>>;
|
|
20079
|
+
/**
|
|
20080
|
+
* Returns a paginated list of locale translations for the given announcement template; requires read permission on announcements.
|
|
20081
|
+
* @summary List an announcement template\'s translations
|
|
20082
|
+
* @param {AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest} requestParameters Request parameters.
|
|
20083
|
+
* @param {*} [options] Override http request option.
|
|
20084
|
+
* @throws {RequiredError}
|
|
20085
|
+
*/
|
|
20086
|
+
getAnnouncementTemplateTranslations(requestParameters: AnnouncementsTemplatesTranslationsApiGetAnnouncementTemplateTranslationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAnnouncementTemplateTranslations200Response, any, {}, any>>;
|
|
20087
|
+
/**
|
|
20088
|
+
* Creates or updates the translated subject and HTML body of a template for the specified locale; requires update permission on announcements.
|
|
20089
|
+
* @summary Update an announcement template translation
|
|
20090
|
+
* @param {AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest} requestParameters Request parameters.
|
|
20091
|
+
* @param {*} [options] Override http request option.
|
|
20092
|
+
* @throws {RequiredError}
|
|
20093
|
+
*/
|
|
20094
|
+
updateAnnouncementTemplateTranslation(requestParameters: AnnouncementsTemplatesTranslationsApiUpdateAnnouncementTemplateTranslationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateAnnouncementTemplateTranslation200Response, any, {}, any>>;
|
|
20095
|
+
}
|
|
18646
20096
|
/**
|
|
18647
20097
|
* AnnouncementsTranslationsApi - axios parameter creator
|
|
18648
20098
|
*/
|
|
@@ -65208,22 +66658,13 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
65208
66658
|
*/
|
|
65209
66659
|
deleteLogin: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65210
66660
|
/**
|
|
65211
|
-
*
|
|
65212
|
-
* @summary
|
|
66661
|
+
* Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
|
|
66662
|
+
* @summary Remove a login\'s two-factor authentication
|
|
65213
66663
|
* @param {string} username The username identifier
|
|
65214
66664
|
* @param {*} [options] Override http request option.
|
|
65215
66665
|
* @throws {RequiredError}
|
|
65216
66666
|
*/
|
|
65217
66667
|
deleteLoginMfaToken: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65218
|
-
/**
|
|
65219
|
-
* Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
|
|
65220
|
-
* @summary Turn off one of a login\'s MFA methods
|
|
65221
|
-
* @param {string} username The username identifier
|
|
65222
|
-
* @param {string} method The method identifier
|
|
65223
|
-
* @param {*} [options] Override http request option.
|
|
65224
|
-
* @throws {RequiredError}
|
|
65225
|
-
*/
|
|
65226
|
-
disableLoginMfa: (username: string, method: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65227
66668
|
/**
|
|
65228
66669
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
65229
66670
|
* @summary Get a single login
|
|
@@ -65277,7 +66718,7 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
65277
66718
|
*/
|
|
65278
66719
|
getLogins: (accountId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65279
66720
|
/**
|
|
65280
|
-
*
|
|
66721
|
+
* Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. Requires read and update permissions on accounts.
|
|
65281
66722
|
* @summary Set a login\'s preferred MFA method
|
|
65282
66723
|
* @param {string} username The username identifier
|
|
65283
66724
|
* @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
|
|
@@ -65325,22 +66766,13 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
|
|
|
65325
66766
|
*/
|
|
65326
66767
|
deleteLogin(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLogin200Response>>;
|
|
65327
66768
|
/**
|
|
65328
|
-
*
|
|
65329
|
-
* @summary
|
|
66769
|
+
* Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
|
|
66770
|
+
* @summary Remove a login\'s two-factor authentication
|
|
65330
66771
|
* @param {string} username The username identifier
|
|
65331
66772
|
* @param {*} [options] Override http request option.
|
|
65332
66773
|
* @throws {RequiredError}
|
|
65333
66774
|
*/
|
|
65334
66775
|
deleteLoginMfaToken(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
|
|
65335
|
-
/**
|
|
65336
|
-
* Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
|
|
65337
|
-
* @summary Turn off one of a login\'s MFA methods
|
|
65338
|
-
* @param {string} username The username identifier
|
|
65339
|
-
* @param {string} method The method identifier
|
|
65340
|
-
* @param {*} [options] Override http request option.
|
|
65341
|
-
* @throws {RequiredError}
|
|
65342
|
-
*/
|
|
65343
|
-
disableLoginMfa(username: string, method: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
|
|
65344
66776
|
/**
|
|
65345
66777
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
65346
66778
|
* @summary Get a single login
|
|
@@ -65394,7 +66826,7 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
|
|
|
65394
66826
|
*/
|
|
65395
66827
|
getLogins(accountId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLogins200Response>>;
|
|
65396
66828
|
/**
|
|
65397
|
-
*
|
|
66829
|
+
* Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. Requires read and update permissions on accounts.
|
|
65398
66830
|
* @summary Set a login\'s preferred MFA method
|
|
65399
66831
|
* @param {string} username The username identifier
|
|
65400
66832
|
* @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
|
|
@@ -65442,21 +66874,13 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
|
|
|
65442
66874
|
*/
|
|
65443
66875
|
deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogin200Response>;
|
|
65444
66876
|
/**
|
|
65445
|
-
*
|
|
65446
|
-
* @summary
|
|
66877
|
+
* Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
|
|
66878
|
+
* @summary Remove a login\'s two-factor authentication
|
|
65447
66879
|
* @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
|
|
65448
66880
|
* @param {*} [options] Override http request option.
|
|
65449
66881
|
* @throws {RequiredError}
|
|
65450
66882
|
*/
|
|
65451
66883
|
deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
|
|
65452
|
-
/**
|
|
65453
|
-
* Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
|
|
65454
|
-
* @summary Turn off one of a login\'s MFA methods
|
|
65455
|
-
* @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
|
|
65456
|
-
* @param {*} [options] Override http request option.
|
|
65457
|
-
* @throws {RequiredError}
|
|
65458
|
-
*/
|
|
65459
|
-
disableLoginMfa(requestParameters: LoginsApiDisableLoginMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
|
|
65460
66884
|
/**
|
|
65461
66885
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
65462
66886
|
* @summary Get a single login
|
|
@@ -65498,7 +66922,7 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
|
|
|
65498
66922
|
*/
|
|
65499
66923
|
getLogins(requestParameters?: LoginsApiGetLoginsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogins200Response>;
|
|
65500
66924
|
/**
|
|
65501
|
-
*
|
|
66925
|
+
* Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. Requires read and update permissions on accounts.
|
|
65502
66926
|
* @summary Set a login\'s preferred MFA method
|
|
65503
66927
|
* @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
|
|
65504
66928
|
* @param {*} [options] Override http request option.
|
|
@@ -65549,19 +66973,6 @@ export interface LoginsApiDeleteLoginMfaTokenRequest {
|
|
|
65549
66973
|
*/
|
|
65550
66974
|
readonly username: string;
|
|
65551
66975
|
}
|
|
65552
|
-
/**
|
|
65553
|
-
* Request parameters for disableLoginMfa operation in LoginsApi.
|
|
65554
|
-
*/
|
|
65555
|
-
export interface LoginsApiDisableLoginMfaRequest {
|
|
65556
|
-
/**
|
|
65557
|
-
* The username identifier
|
|
65558
|
-
*/
|
|
65559
|
-
readonly username: string;
|
|
65560
|
-
/**
|
|
65561
|
-
* The method identifier
|
|
65562
|
-
*/
|
|
65563
|
-
readonly method: string;
|
|
65564
|
-
}
|
|
65565
66976
|
/**
|
|
65566
66977
|
* Request parameters for getLogin operation in LoginsApi.
|
|
65567
66978
|
*/
|
|
@@ -65706,21 +67117,13 @@ export declare class LoginsApi extends BaseAPI {
|
|
|
65706
67117
|
*/
|
|
65707
67118
|
deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLogin200Response, any, {}, any>>;
|
|
65708
67119
|
/**
|
|
65709
|
-
*
|
|
65710
|
-
* @summary
|
|
67120
|
+
* Removes two-factor authentication from the email login with the given username and returns its updated MFA settings. It turns TOTP off and deletes it, so nothing is left to turn back on. The user can then sign in with their password and set up two-factor authentication again. Removing when none is set up succeeds. Requires read and update permissions on accounts.
|
|
67121
|
+
* @summary Remove a login\'s two-factor authentication
|
|
65711
67122
|
* @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
|
|
65712
67123
|
* @param {*} [options] Override http request option.
|
|
65713
67124
|
* @throws {RequiredError}
|
|
65714
67125
|
*/
|
|
65715
67126
|
deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
|
|
65716
|
-
/**
|
|
65717
|
-
* Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
|
|
65718
|
-
* @summary Turn off one of a login\'s MFA methods
|
|
65719
|
-
* @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
|
|
65720
|
-
* @param {*} [options] Override http request option.
|
|
65721
|
-
* @throws {RequiredError}
|
|
65722
|
-
*/
|
|
65723
|
-
disableLoginMfa(requestParameters: LoginsApiDisableLoginMfaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
|
|
65724
67127
|
/**
|
|
65725
67128
|
* Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
|
|
65726
67129
|
* @summary Get a single login
|
|
@@ -65762,7 +67165,7 @@ export declare class LoginsApi extends BaseAPI {
|
|
|
65762
67165
|
*/
|
|
65763
67166
|
getLogins(requestParameters?: LoginsApiGetLoginsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLogins200Response, any, {}, any>>;
|
|
65764
67167
|
/**
|
|
65765
|
-
*
|
|
67168
|
+
* Makes the given MFA method the preferred one for the email login with the given username, and returns its updated MFA settings. The method must already be turned on for the login; any other method returns a 400, so this can\'t revive a method the user turned off. Requires read and update permissions on accounts.
|
|
65766
67169
|
* @summary Set a login\'s preferred MFA method
|
|
65767
67170
|
* @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
|
|
65768
67171
|
* @param {*} [options] Override http request option.
|