@wix/auto_sdk_online-programs_online-program-participants 1.0.4 → 1.0.6
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/build/cjs/index.d.ts +63 -3
- package/build/cjs/index.js +5364 -450
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +926 -1
- package/build/cjs/index.typings.js +5260 -476
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +648 -2
- package/build/cjs/meta.js +3881 -55
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +63 -3
- package/build/es/index.mjs +5304 -406
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +926 -1
- package/build/es/index.typings.mjs +5155 -386
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +648 -2
- package/build/es/meta.mjs +3838 -27
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +63 -3
- package/build/internal/cjs/index.js +5364 -450
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +926 -1
- package/build/internal/cjs/index.typings.js +5260 -476
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +648 -2
- package/build/internal/cjs/meta.js +3881 -55
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +63 -3
- package/build/internal/es/index.mjs +5304 -406
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +926 -1
- package/build/internal/es/index.typings.mjs +5155 -386
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +648 -2
- package/build/internal/es/meta.mjs +3838 -27
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -571,12 +571,603 @@ interface RemoveCouponFromOrderRequest {
|
|
|
571
571
|
interface RemoveCouponFromOrderResponse {
|
|
572
572
|
total?: string;
|
|
573
573
|
}
|
|
574
|
+
interface ListParticipantStepsRequest {
|
|
575
|
+
/**
|
|
576
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
577
|
+
* @format GUID
|
|
578
|
+
*/
|
|
579
|
+
challengeId: string;
|
|
580
|
+
/**
|
|
581
|
+
* Participant entity ID within the challenge. GUID.
|
|
582
|
+
* @format GUID
|
|
583
|
+
*/
|
|
584
|
+
participantId: string;
|
|
585
|
+
/** Optional parent step ID to scope to sub-steps. */
|
|
586
|
+
parentId?: string;
|
|
587
|
+
/** Optional absolute time window for time-based progress. */
|
|
588
|
+
timeInterval?: TimeInterval;
|
|
589
|
+
/** Optional local date window for date-based progress. */
|
|
590
|
+
dateInterval?: DateInterval;
|
|
591
|
+
/** Controls verbose description fields in response. */
|
|
592
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
593
|
+
}
|
|
594
|
+
declare enum DescriptionFieldSet {
|
|
595
|
+
/** title and detailed description. */
|
|
596
|
+
EXTENDED = "EXTENDED",
|
|
597
|
+
/** title only. */
|
|
598
|
+
STANDARD = "STANDARD"
|
|
599
|
+
}
|
|
600
|
+
/** @enumType */
|
|
601
|
+
type DescriptionFieldSetWithLiterals = DescriptionFieldSet | 'EXTENDED' | 'STANDARD';
|
|
602
|
+
interface ListParticipantStepsResponse {
|
|
603
|
+
/** Participant steps matching the query. */
|
|
604
|
+
steps?: ParticipantStep[];
|
|
605
|
+
}
|
|
606
|
+
interface ParticipantStep {
|
|
607
|
+
_id?: string;
|
|
608
|
+
source?: ChallengeStep;
|
|
609
|
+
timeFrame?: TimeInterval;
|
|
610
|
+
feedback?: Feedback;
|
|
611
|
+
transitions?: ParticipantStepStateTransition[];
|
|
612
|
+
dateFrame?: DateInterval;
|
|
613
|
+
quizSubmission?: QuizSubmission;
|
|
614
|
+
}
|
|
615
|
+
interface FeedbackItem extends FeedbackItemValueOneOf {
|
|
616
|
+
number?: number | null;
|
|
617
|
+
text?: string | null;
|
|
618
|
+
media?: MediaItems;
|
|
619
|
+
choice?: FeedbackItemChoice;
|
|
620
|
+
quantity?: Quantity;
|
|
621
|
+
multiSelect?: Choices;
|
|
622
|
+
/** @format GUID */
|
|
623
|
+
feedbackItemSettingsId?: string;
|
|
624
|
+
}
|
|
625
|
+
/** @oneof */
|
|
626
|
+
interface FeedbackItemValueOneOf {
|
|
627
|
+
number?: number | null;
|
|
628
|
+
text?: string | null;
|
|
629
|
+
media?: MediaItems;
|
|
630
|
+
choice?: FeedbackItemChoice;
|
|
631
|
+
quantity?: Quantity;
|
|
632
|
+
multiSelect?: Choices;
|
|
633
|
+
}
|
|
634
|
+
interface MediaItems {
|
|
635
|
+
mediaItems?: MediaItem[];
|
|
636
|
+
}
|
|
637
|
+
interface FeedbackItemChoice {
|
|
638
|
+
choiceId?: string;
|
|
639
|
+
}
|
|
640
|
+
interface Quantity {
|
|
641
|
+
unitName?: string;
|
|
642
|
+
amount?: number;
|
|
643
|
+
}
|
|
644
|
+
interface Choices {
|
|
645
|
+
choiceIds?: string[];
|
|
646
|
+
}
|
|
647
|
+
interface ChallengeStep {
|
|
648
|
+
_id?: string;
|
|
649
|
+
settings?: ChallengeStepSettings;
|
|
650
|
+
/**
|
|
651
|
+
* @format GUID
|
|
652
|
+
* @deprecated
|
|
653
|
+
*/
|
|
654
|
+
recurrenceSourceId?: string | null;
|
|
655
|
+
createdAt?: Date | null;
|
|
656
|
+
updatedAt?: Date | null;
|
|
657
|
+
/**
|
|
658
|
+
* @format GUID
|
|
659
|
+
* @readonly
|
|
660
|
+
*/
|
|
661
|
+
sectionId?: string | null;
|
|
662
|
+
}
|
|
663
|
+
interface GeneralSettings extends GeneralSettingsStepTypeOneOf {
|
|
664
|
+
individual?: IndividualSettings;
|
|
665
|
+
/** @deprecated */
|
|
666
|
+
group?: GroupSettings;
|
|
667
|
+
quiz?: QuizSettings;
|
|
668
|
+
video?: VideoStepSettings;
|
|
669
|
+
/** steps description: title, details, image and etc. */
|
|
670
|
+
description?: ObjectDescription;
|
|
671
|
+
duration?: TimeDuration;
|
|
672
|
+
/** @deprecated */
|
|
673
|
+
recurrenceSettings?: RecurrenceSettings;
|
|
674
|
+
}
|
|
675
|
+
/** @oneof */
|
|
676
|
+
interface GeneralSettingsStepTypeOneOf {
|
|
677
|
+
individual?: IndividualSettings;
|
|
678
|
+
/** @deprecated */
|
|
679
|
+
group?: GroupSettings;
|
|
680
|
+
quiz?: QuizSettings;
|
|
681
|
+
video?: VideoStepSettings;
|
|
682
|
+
}
|
|
683
|
+
interface ObjectDescription {
|
|
684
|
+
/** @maxLength 150 */
|
|
685
|
+
title?: string | null;
|
|
686
|
+
/** @maxLength 2000 */
|
|
687
|
+
details?: string | null;
|
|
688
|
+
media?: MediaItem;
|
|
689
|
+
}
|
|
690
|
+
interface IndividualSettings {
|
|
691
|
+
/** should be renamed, it's a flag whether the questionnaire section is enabled. */
|
|
692
|
+
confirmationRequired?: boolean;
|
|
693
|
+
/** feedback list settings. */
|
|
694
|
+
feedbackSettings?: FeedbackItemSettings[];
|
|
695
|
+
/** whether the quiz section in enabled. */
|
|
696
|
+
showQuiz?: boolean;
|
|
697
|
+
/** quiz list settings. */
|
|
698
|
+
quizSettings?: FeedbackItemSettings[];
|
|
699
|
+
}
|
|
700
|
+
interface FeedbackItemSettings {
|
|
701
|
+
_id?: string;
|
|
702
|
+
type?: FeedbackItemType;
|
|
703
|
+
question?: string;
|
|
704
|
+
isRequired?: boolean;
|
|
705
|
+
correctAnswerMessage?: string | null;
|
|
706
|
+
wrongAnswerMessage?: string | null;
|
|
707
|
+
}
|
|
708
|
+
interface NumericFeedbackItem {
|
|
709
|
+
/** @min 1 */
|
|
710
|
+
maxValue?: number;
|
|
711
|
+
}
|
|
712
|
+
interface TextFeedbackItem {
|
|
713
|
+
}
|
|
714
|
+
interface MediaFeedbackItem {
|
|
715
|
+
}
|
|
716
|
+
interface MultipleChoiceFeedbackItem {
|
|
717
|
+
choices?: Choice[];
|
|
718
|
+
}
|
|
719
|
+
declare enum ChoiceRightness {
|
|
720
|
+
NEUTRAL = "NEUTRAL",
|
|
721
|
+
RIGHT = "RIGHT",
|
|
722
|
+
WRONG = "WRONG"
|
|
723
|
+
}
|
|
724
|
+
/** @enumType */
|
|
725
|
+
type ChoiceRightnessWithLiterals = ChoiceRightness | 'NEUTRAL' | 'RIGHT' | 'WRONG';
|
|
726
|
+
interface Choice {
|
|
727
|
+
_id?: string;
|
|
728
|
+
description?: ObjectDescription;
|
|
729
|
+
rightness?: ChoiceRightnessWithLiterals;
|
|
730
|
+
}
|
|
731
|
+
interface QuantityFeedbackItem {
|
|
732
|
+
unitName?: string | null;
|
|
733
|
+
amount?: number;
|
|
734
|
+
}
|
|
735
|
+
interface FeedbackItemType extends FeedbackItemTypeTypeOneOf {
|
|
736
|
+
numeric?: NumericFeedbackItem;
|
|
737
|
+
text?: TextFeedbackItem;
|
|
738
|
+
media?: MediaFeedbackItem;
|
|
739
|
+
multipleChoice?: MultipleChoiceFeedbackItem;
|
|
740
|
+
quantity?: QuantityFeedbackItem;
|
|
741
|
+
multiSelect?: MultipleChoiceFeedbackItem;
|
|
742
|
+
}
|
|
743
|
+
/** @oneof */
|
|
744
|
+
interface FeedbackItemTypeTypeOneOf {
|
|
745
|
+
numeric?: NumericFeedbackItem;
|
|
746
|
+
text?: TextFeedbackItem;
|
|
747
|
+
media?: MediaFeedbackItem;
|
|
748
|
+
multipleChoice?: MultipleChoiceFeedbackItem;
|
|
749
|
+
quantity?: QuantityFeedbackItem;
|
|
750
|
+
multiSelect?: MultipleChoiceFeedbackItem;
|
|
751
|
+
}
|
|
752
|
+
interface GroupSettings {
|
|
753
|
+
completionCriteria?: CompletionCriteria;
|
|
754
|
+
}
|
|
755
|
+
interface CompletionCriteria {
|
|
756
|
+
completedSteps?: QuantityCriterion;
|
|
757
|
+
completedMilestones?: QuantityCriterion;
|
|
758
|
+
scoredPoints?: MinThreshold;
|
|
759
|
+
}
|
|
760
|
+
interface QuantityCriterion extends QuantityCriterionCriterionOneOf {
|
|
761
|
+
all?: All;
|
|
762
|
+
minThreshold?: MinThreshold;
|
|
763
|
+
}
|
|
764
|
+
/** @oneof */
|
|
765
|
+
interface QuantityCriterionCriterionOneOf {
|
|
766
|
+
all?: All;
|
|
767
|
+
minThreshold?: MinThreshold;
|
|
768
|
+
}
|
|
769
|
+
interface All {
|
|
770
|
+
}
|
|
771
|
+
interface MinThreshold {
|
|
772
|
+
/** @min 1 */
|
|
773
|
+
value?: number;
|
|
774
|
+
}
|
|
775
|
+
interface QuizSettings {
|
|
776
|
+
quizId?: string;
|
|
777
|
+
questionCount?: number;
|
|
778
|
+
passingGrade?: number | null;
|
|
779
|
+
migrationDetails?: QuizMigrationDetails;
|
|
780
|
+
}
|
|
781
|
+
declare enum QuizType {
|
|
782
|
+
QUIZ = "QUIZ",
|
|
783
|
+
QUESTIONNAIRE = "QUESTIONNAIRE"
|
|
784
|
+
}
|
|
785
|
+
/** @enumType */
|
|
786
|
+
type QuizTypeWithLiterals = QuizType | 'QUIZ' | 'QUESTIONNAIRE';
|
|
787
|
+
interface QuizMigrationDetails {
|
|
788
|
+
sourceStepId?: string;
|
|
789
|
+
show?: boolean;
|
|
790
|
+
quizType?: QuizTypeWithLiterals;
|
|
791
|
+
}
|
|
792
|
+
interface VideoStepSettings extends VideoStepSettingsVideoSourceOneOf {
|
|
793
|
+
wixVideo?: WixVideo;
|
|
794
|
+
video?: string;
|
|
795
|
+
requiredCompletionPercentage?: number;
|
|
796
|
+
coverImage?: string;
|
|
797
|
+
durationInMilliseconds?: number | null;
|
|
798
|
+
deleted?: boolean;
|
|
799
|
+
}
|
|
800
|
+
/** @oneof */
|
|
801
|
+
interface VideoStepSettingsVideoSourceOneOf {
|
|
802
|
+
wixVideo?: WixVideo;
|
|
803
|
+
video?: string;
|
|
804
|
+
}
|
|
805
|
+
interface WixVideo {
|
|
806
|
+
/** @format GUID */
|
|
807
|
+
_id?: string;
|
|
808
|
+
paid?: boolean;
|
|
809
|
+
}
|
|
810
|
+
interface VideoResolution {
|
|
811
|
+
/** Video URL. */
|
|
812
|
+
url?: string;
|
|
813
|
+
/** Video height. */
|
|
814
|
+
height?: number;
|
|
815
|
+
/** Video width. */
|
|
816
|
+
width?: number;
|
|
817
|
+
/** Video format for example, mp4, hls. */
|
|
818
|
+
format?: string;
|
|
819
|
+
}
|
|
820
|
+
interface TimeDuration {
|
|
821
|
+
unit?: DurationUnitWithLiterals;
|
|
822
|
+
value?: number;
|
|
823
|
+
}
|
|
824
|
+
declare enum DurationUnit {
|
|
825
|
+
WEEKS = "WEEKS",
|
|
826
|
+
DAYS = "DAYS",
|
|
827
|
+
HOURS = "HOURS",
|
|
828
|
+
MINUTES = "MINUTES"
|
|
829
|
+
}
|
|
830
|
+
/** @enumType */
|
|
831
|
+
type DurationUnitWithLiterals = DurationUnit | 'WEEKS' | 'DAYS' | 'HOURS' | 'MINUTES';
|
|
832
|
+
interface RecurrenceSettings {
|
|
833
|
+
schedules?: RecurrenceSchedule[];
|
|
834
|
+
/** @min 1 */
|
|
835
|
+
recurrencesCount?: number | null;
|
|
836
|
+
}
|
|
837
|
+
interface RecurrenceSchedule {
|
|
838
|
+
startDelay?: TimeDuration;
|
|
839
|
+
interval?: TimeDuration;
|
|
840
|
+
}
|
|
841
|
+
interface EmbeddingSettings {
|
|
842
|
+
/** step start delay. */
|
|
843
|
+
startConditions?: StartCondition[];
|
|
844
|
+
/** @deprecated */
|
|
845
|
+
isMilestone?: boolean;
|
|
846
|
+
/** @deprecated */
|
|
847
|
+
points?: number | null;
|
|
848
|
+
}
|
|
849
|
+
interface StartCondition {
|
|
850
|
+
/** whether the step should start on join. */
|
|
851
|
+
dependency?: StepDependency;
|
|
852
|
+
/** step delay regarding the challenge start. */
|
|
853
|
+
delay?: TimeDuration;
|
|
854
|
+
}
|
|
855
|
+
interface StepDependency extends StepDependencyDependencyTypeOneOf {
|
|
856
|
+
container?: Container;
|
|
857
|
+
/** @deprecated */
|
|
858
|
+
step?: Step;
|
|
859
|
+
}
|
|
860
|
+
/** @oneof */
|
|
861
|
+
interface StepDependencyDependencyTypeOneOf {
|
|
862
|
+
container?: Container;
|
|
863
|
+
/** @deprecated */
|
|
864
|
+
step?: Step;
|
|
865
|
+
}
|
|
866
|
+
interface Container {
|
|
867
|
+
}
|
|
868
|
+
interface Step {
|
|
869
|
+
stepId?: string;
|
|
870
|
+
}
|
|
871
|
+
interface ChallengeStepSettings {
|
|
872
|
+
general?: GeneralSettings;
|
|
873
|
+
embedding?: EmbeddingSettings;
|
|
874
|
+
}
|
|
875
|
+
interface Feedback {
|
|
876
|
+
items?: FeedbackItem[];
|
|
877
|
+
createdAt?: Date | null;
|
|
878
|
+
updatedAt?: Date | null;
|
|
879
|
+
quiz?: FeedbackItem[];
|
|
880
|
+
}
|
|
881
|
+
interface QuizSubmission {
|
|
882
|
+
quizSubmissionId?: string;
|
|
883
|
+
score?: number | null;
|
|
884
|
+
grade?: number | null;
|
|
885
|
+
rightAnswers?: number | null;
|
|
886
|
+
passingGrade?: number | null;
|
|
887
|
+
}
|
|
888
|
+
interface GetParticipantStepRequest {
|
|
889
|
+
/**
|
|
890
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
891
|
+
* @format GUID
|
|
892
|
+
*/
|
|
893
|
+
challengeId: string;
|
|
894
|
+
/**
|
|
895
|
+
* Participant entity ID. GUID.
|
|
896
|
+
* @format GUID
|
|
897
|
+
*/
|
|
898
|
+
participantId: string;
|
|
899
|
+
/** Step ID (program step or resolved instance). */
|
|
900
|
+
stepId: string;
|
|
901
|
+
/** Optional absolute time window for time-based progress. */
|
|
902
|
+
timeInterval?: TimeInterval;
|
|
903
|
+
/** Controls verbose description fields in response. */
|
|
904
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
905
|
+
}
|
|
906
|
+
interface GetParticipantStepResponse {
|
|
907
|
+
/** Requested participant step details. */
|
|
908
|
+
step?: ParticipantStep;
|
|
909
|
+
/** Immediate sub-steps for hierarchical steps (if any). */
|
|
910
|
+
subSteps?: ParticipantStep[];
|
|
911
|
+
}
|
|
912
|
+
interface ResolveParticipantStepRequest {
|
|
913
|
+
/**
|
|
914
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
915
|
+
* @format GUID
|
|
916
|
+
*/
|
|
917
|
+
challengeId: string;
|
|
918
|
+
/**
|
|
919
|
+
* Participant entity ID. GUID.
|
|
920
|
+
* @format GUID
|
|
921
|
+
*/
|
|
922
|
+
participantId: string;
|
|
923
|
+
/** Target step ID to resolve. */
|
|
924
|
+
stepId: string;
|
|
925
|
+
/** Resolution action to apply. */
|
|
926
|
+
status?: ResolutionStatusWithLiterals;
|
|
927
|
+
/** Optional instructor feedback payload. */
|
|
928
|
+
feedback?: Feedback;
|
|
929
|
+
/** Optional idempotency key for action tracking. */
|
|
930
|
+
actionId?: string;
|
|
931
|
+
/**
|
|
932
|
+
* Optional quiz submission to attach. GUID.
|
|
933
|
+
* @format GUID
|
|
934
|
+
*/
|
|
935
|
+
quizSubmissionId?: string | null;
|
|
936
|
+
}
|
|
937
|
+
declare enum ResolutionStatus {
|
|
938
|
+
COMPLETED = "COMPLETED",
|
|
939
|
+
SKIPPED = "SKIPPED",
|
|
940
|
+
UNDO = "UNDO",
|
|
941
|
+
QUIZ_SUBMIT = "QUIZ_SUBMIT"
|
|
942
|
+
}
|
|
943
|
+
/** @enumType */
|
|
944
|
+
type ResolutionStatusWithLiterals = ResolutionStatus | 'COMPLETED' | 'SKIPPED' | 'UNDO' | 'QUIZ_SUBMIT';
|
|
945
|
+
interface ResolveParticipantStepResponse {
|
|
946
|
+
/** Updated participant step after resolution. */
|
|
947
|
+
step?: ParticipantStep;
|
|
948
|
+
/**
|
|
949
|
+
* Server-generated action id. GUID.
|
|
950
|
+
* @format GUID
|
|
951
|
+
*/
|
|
952
|
+
actionId?: string;
|
|
953
|
+
}
|
|
954
|
+
/** Deprecated. */
|
|
955
|
+
interface StepResolved {
|
|
956
|
+
challengeId?: string;
|
|
957
|
+
participantId?: string;
|
|
958
|
+
memberId?: string;
|
|
959
|
+
stepTitle?: string;
|
|
960
|
+
participantStepId?: string;
|
|
961
|
+
challengeStepId?: string;
|
|
962
|
+
/** TODO why it is repeated? */
|
|
963
|
+
feedback?: Feedback[];
|
|
964
|
+
/** Title of the program. Used in Notifications */
|
|
965
|
+
programName?: string;
|
|
966
|
+
/**
|
|
967
|
+
* user id for program owner
|
|
968
|
+
* @format GUID
|
|
969
|
+
*/
|
|
970
|
+
ownerId?: string;
|
|
971
|
+
/**
|
|
972
|
+
* owner's contact id
|
|
973
|
+
* @format GUID
|
|
974
|
+
*/
|
|
975
|
+
ownerContactId?: string;
|
|
976
|
+
/**
|
|
977
|
+
* participants contact
|
|
978
|
+
* @format GUID
|
|
979
|
+
*/
|
|
980
|
+
participantContactId?: string;
|
|
981
|
+
/** info about quiz submission in that step */
|
|
982
|
+
quizSubmissionData?: QuizSubmissionData;
|
|
983
|
+
/** info about if participant completed step successfully or not */
|
|
984
|
+
status?: StatusWithLiterals;
|
|
985
|
+
}
|
|
986
|
+
interface QuizSubmissionData {
|
|
987
|
+
/** @format GUID */
|
|
988
|
+
submissionId?: string | null;
|
|
989
|
+
earnedScore?: number | null;
|
|
990
|
+
passingGrade?: number | null;
|
|
991
|
+
}
|
|
992
|
+
declare enum Status {
|
|
993
|
+
/** step completed */
|
|
994
|
+
COMPLETED = "COMPLETED",
|
|
995
|
+
/** participant failed to resolve step */
|
|
996
|
+
FAILED = "FAILED"
|
|
997
|
+
}
|
|
998
|
+
/** @enumType */
|
|
999
|
+
type StatusWithLiterals = Status | 'COMPLETED' | 'FAILED';
|
|
1000
|
+
interface UpdateStepFeedbackRequest {
|
|
1001
|
+
/**
|
|
1002
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
1003
|
+
* @format GUID
|
|
1004
|
+
*/
|
|
1005
|
+
challengeId: string;
|
|
1006
|
+
/**
|
|
1007
|
+
* Participant entity ID. GUID.
|
|
1008
|
+
* @format GUID
|
|
1009
|
+
*/
|
|
1010
|
+
participantId: string;
|
|
1011
|
+
/** Target step ID to update feedback for. */
|
|
1012
|
+
stepId: string;
|
|
1013
|
+
/** New feedback payload. */
|
|
1014
|
+
feedback?: Feedback;
|
|
1015
|
+
/**
|
|
1016
|
+
* Idempotency key for feedback update. GUID.
|
|
1017
|
+
* @format GUID
|
|
1018
|
+
*/
|
|
1019
|
+
actionId?: string;
|
|
1020
|
+
}
|
|
1021
|
+
interface UpdateStepFeedbackResponse {
|
|
1022
|
+
/** Participant step with updated feedback. */
|
|
1023
|
+
step?: ParticipantStep;
|
|
1024
|
+
/**
|
|
1025
|
+
* Server-generated action id. GUID.
|
|
1026
|
+
* @format GUID
|
|
1027
|
+
*/
|
|
1028
|
+
actionId?: string;
|
|
1029
|
+
}
|
|
1030
|
+
interface GetMediaUploadInfoRequest {
|
|
1031
|
+
/**
|
|
1032
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
1033
|
+
* @format GUID
|
|
1034
|
+
*/
|
|
1035
|
+
challengeId: string;
|
|
1036
|
+
/**
|
|
1037
|
+
* Participant entity ID. GUID.
|
|
1038
|
+
* @format GUID
|
|
1039
|
+
*/
|
|
1040
|
+
participantId: string;
|
|
1041
|
+
/** Original filename to derive content-type and path. */
|
|
1042
|
+
fileName?: string;
|
|
1043
|
+
}
|
|
1044
|
+
interface GetMediaUploadInfoResponse {
|
|
1045
|
+
/** Pre-signed URL to upload media. */
|
|
1046
|
+
uploadUrl?: string;
|
|
1047
|
+
/** Token required by media service for upload. */
|
|
1048
|
+
uploadToken?: string;
|
|
1049
|
+
}
|
|
1050
|
+
interface ListParticipantSectionsRequest {
|
|
1051
|
+
/**
|
|
1052
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
1053
|
+
* @format GUID
|
|
1054
|
+
*/
|
|
1055
|
+
challengeId: string;
|
|
1056
|
+
/**
|
|
1057
|
+
* Participant entity ID. GUID.
|
|
1058
|
+
* @format GUID
|
|
1059
|
+
*/
|
|
1060
|
+
participantId: string;
|
|
1061
|
+
/** Controls verbose description fields in response. */
|
|
1062
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1063
|
+
}
|
|
1064
|
+
interface ListParticipantSectionsResponse {
|
|
1065
|
+
/** Participant sections for the program. */
|
|
1066
|
+
sections?: ParticipantSection[];
|
|
1067
|
+
}
|
|
1068
|
+
interface ParticipantSection {
|
|
1069
|
+
_id?: string;
|
|
1070
|
+
source?: ChallengeSection;
|
|
1071
|
+
steps?: ParticipantStep[];
|
|
1072
|
+
transitions?: ParticipantSectionStateTransition[];
|
|
1073
|
+
progress?: Progress;
|
|
1074
|
+
}
|
|
1075
|
+
interface WaitingDate {
|
|
1076
|
+
startDate?: string;
|
|
1077
|
+
}
|
|
1078
|
+
interface WaitingDependency {
|
|
1079
|
+
sectionId?: string;
|
|
1080
|
+
}
|
|
1081
|
+
interface Running {
|
|
1082
|
+
dateInterval?: DateInterval;
|
|
1083
|
+
}
|
|
1084
|
+
interface Completed {
|
|
1085
|
+
}
|
|
1086
|
+
interface Overdue {
|
|
1087
|
+
}
|
|
1088
|
+
interface ChallengeSection {
|
|
1089
|
+
/** challenge section id. */
|
|
1090
|
+
_id?: string;
|
|
1091
|
+
/** challenge section settings. */
|
|
1092
|
+
settings?: Settings;
|
|
1093
|
+
createdAt?: Date | null;
|
|
1094
|
+
updatedAt?: Date | null;
|
|
1095
|
+
/** list of challenge steps laying inside the section. */
|
|
1096
|
+
steps?: ChallengeStep[];
|
|
1097
|
+
}
|
|
1098
|
+
interface Settings {
|
|
1099
|
+
/** section description(title, details, image...) */
|
|
1100
|
+
description?: ObjectDescription;
|
|
1101
|
+
/** condition for the section start. */
|
|
1102
|
+
startCondition?: StartCondition;
|
|
1103
|
+
}
|
|
1104
|
+
interface ParticipantSectionStateTransition extends ParticipantSectionStateTransitionStateOneOf {
|
|
1105
|
+
waitingDate?: WaitingDate;
|
|
1106
|
+
waitingDependency?: WaitingDependency;
|
|
1107
|
+
running?: Running;
|
|
1108
|
+
completed?: Completed;
|
|
1109
|
+
overdue?: Overdue;
|
|
1110
|
+
occurredAt?: Date | null;
|
|
1111
|
+
}
|
|
1112
|
+
/** @oneof */
|
|
1113
|
+
interface ParticipantSectionStateTransitionStateOneOf {
|
|
1114
|
+
waitingDate?: WaitingDate;
|
|
1115
|
+
waitingDependency?: WaitingDependency;
|
|
1116
|
+
running?: Running;
|
|
1117
|
+
completed?: Completed;
|
|
1118
|
+
overdue?: Overdue;
|
|
1119
|
+
}
|
|
1120
|
+
interface Progress {
|
|
1121
|
+
nTotalSteps?: string;
|
|
1122
|
+
nCompletedSteps?: string;
|
|
1123
|
+
}
|
|
1124
|
+
interface GetParticipantSectionRequest {
|
|
1125
|
+
/**
|
|
1126
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
1127
|
+
* @format GUID
|
|
1128
|
+
*/
|
|
1129
|
+
challengeId: string;
|
|
1130
|
+
/**
|
|
1131
|
+
* Participant entity ID. GUID.
|
|
1132
|
+
* @format GUID
|
|
1133
|
+
*/
|
|
1134
|
+
participantId: string;
|
|
1135
|
+
/**
|
|
1136
|
+
* Section ID to fetch. GUID.
|
|
1137
|
+
* @format GUID
|
|
1138
|
+
*/
|
|
1139
|
+
sectionId: string;
|
|
1140
|
+
/** Controls verbose description fields in response. */
|
|
1141
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1142
|
+
}
|
|
1143
|
+
interface GetParticipantSectionResponse {
|
|
1144
|
+
/** Requested participant section details. */
|
|
1145
|
+
section?: ParticipantSection;
|
|
1146
|
+
}
|
|
574
1147
|
interface MyProgramRequest {
|
|
575
1148
|
programId: string;
|
|
576
1149
|
}
|
|
577
1150
|
interface MyProgramResponse {
|
|
578
1151
|
participant?: Participant;
|
|
579
1152
|
}
|
|
1153
|
+
interface MyProgramStepRequest {
|
|
1154
|
+
programId: string;
|
|
1155
|
+
programStepId: string;
|
|
1156
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1157
|
+
}
|
|
1158
|
+
interface MyProgramStepResponse {
|
|
1159
|
+
/** Viewer's participant step derived for the program step. */
|
|
1160
|
+
participantStep?: ParticipantStep;
|
|
1161
|
+
}
|
|
1162
|
+
interface MyProgramSectionRequest {
|
|
1163
|
+
programId: string;
|
|
1164
|
+
programSectionId: string;
|
|
1165
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1166
|
+
}
|
|
1167
|
+
interface MyProgramSectionResponse {
|
|
1168
|
+
/** Viewer's participant section derived for the program section. */
|
|
1169
|
+
participantSection?: ParticipantSection;
|
|
1170
|
+
}
|
|
580
1171
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
581
1172
|
createdEvent?: EntityCreatedEvent;
|
|
582
1173
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -775,8 +1366,22 @@ interface ParticipantJoinedEnvelope {
|
|
|
775
1366
|
* @slug participant_joined
|
|
776
1367
|
*/
|
|
777
1368
|
declare function onParticipantJoined(handler: (event: ParticipantJoinedEnvelope) => void | Promise<void>): void;
|
|
1369
|
+
interface ParticipantStepResolvedEnvelope {
|
|
1370
|
+
data: StepResolved;
|
|
1371
|
+
metadata: EventMetadata;
|
|
1372
|
+
}
|
|
1373
|
+
/** @permissionId PARTICIPANTS.PARTICIPANT_READ
|
|
1374
|
+
* @webhook
|
|
1375
|
+
* @eventType wix.challenges.v1.participant_step_resolved
|
|
1376
|
+
* @serviceIdentifier com.wixpress.achievements.api.v1.ParticipantsService
|
|
1377
|
+
* @slug step_resolved
|
|
1378
|
+
*/
|
|
1379
|
+
declare function onParticipantStepResolved(handler: (event: ParticipantStepResolvedEnvelope) => void | Promise<void>): void;
|
|
778
1380
|
/** @public
|
|
779
1381
|
* @requiredField challengeId
|
|
1382
|
+
* @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
|
|
1383
|
+
* @applicableIdentity APP
|
|
1384
|
+
* @applicableIdentity MEMBER
|
|
780
1385
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.QueryParticipants
|
|
781
1386
|
*/
|
|
782
1387
|
declare function queryParticipants(challengeId: string, options?: QueryParticipantsOptions): Promise<NonNullablePaths<QueryParticipantsResponse, `totalCount` | `participants` | `participants.${number}._id` | `participants.${number}.member._id` | `participants.${number}.member.fullName` | `participants.${number}.challenge._id` | `participants.${number}.stepsSummary.stepsNumber` | `participants.${number}.stepsSummary.completedStepsNumber` | `participants.${number}.stepsSummary.failedStepsNumber` | `participants.${number}.stepsSummary.postedFeedbacksNumber` | `participants.${number}.stepsSummary.lastEvent.stepId` | `participants.${number}.timezone` | `participants.${number}.dateFrame.start` | `participants.${number}.performance` | `participants.${number}.joinPath.singlePayment.orderId` | `participants.${number}.joinPath.freeCoupon.couponId`, 6>>;
|
|
@@ -787,6 +1392,9 @@ interface QueryParticipantsOptions {
|
|
|
787
1392
|
}
|
|
788
1393
|
/** @public
|
|
789
1394
|
* @requiredField challengeId
|
|
1395
|
+
* @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
|
|
1396
|
+
* @applicableIdentity APP
|
|
1397
|
+
* @applicableIdentity MEMBER
|
|
790
1398
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListParticipants
|
|
791
1399
|
* @deprecated
|
|
792
1400
|
*/
|
|
@@ -808,6 +1416,9 @@ interface ListParticipantsOptions {
|
|
|
808
1416
|
}
|
|
809
1417
|
/** @public
|
|
810
1418
|
* @requiredField challengeId
|
|
1419
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_JOIN
|
|
1420
|
+
* @applicableIdentity APP
|
|
1421
|
+
* @applicableIdentity MEMBER
|
|
811
1422
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.JoinParticipant
|
|
812
1423
|
*/
|
|
813
1424
|
declare function joinParticipant(challengeId: string, options?: JoinParticipantOptions): Promise<NonNullablePaths<JoinParticipantResponse, `participantId` | `actionId` | `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
|
|
@@ -829,6 +1440,8 @@ interface JoinParticipantOptions {
|
|
|
829
1440
|
* @public
|
|
830
1441
|
* @documentationMaturity preview
|
|
831
1442
|
* @requiredField challengeId
|
|
1443
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
|
|
1444
|
+
* @applicableIdentity APP
|
|
832
1445
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.AddParticipant
|
|
833
1446
|
*/
|
|
834
1447
|
declare function addParticipant(challengeId: string, options?: AddParticipantOptions): Promise<NonNullablePaths<AddParticipantResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId` | `actionId`, 6>>;
|
|
@@ -843,6 +1456,8 @@ interface AddParticipantOptions {
|
|
|
843
1456
|
* @public
|
|
844
1457
|
* @documentationMaturity preview
|
|
845
1458
|
* @requiredField challengeId
|
|
1459
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
|
|
1460
|
+
* @applicableIdentity APP
|
|
846
1461
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.AddParticipants
|
|
847
1462
|
*/
|
|
848
1463
|
declare function addParticipants(challengeId: string, options?: AddParticipantsOptions): Promise<NonNullablePaths<AddParticipantsResponse, `participants` | `participants.${number}._id` | `participants.${number}.member._id` | `participants.${number}.member.fullName` | `participants.${number}.challenge._id` | `participants.${number}.stepsSummary.stepsNumber` | `participants.${number}.stepsSummary.completedStepsNumber` | `participants.${number}.stepsSummary.failedStepsNumber` | `participants.${number}.stepsSummary.postedFeedbacksNumber` | `participants.${number}.stepsSummary.lastEvent.stepId` | `participants.${number}.timezone` | `participants.${number}.dateFrame.start` | `participants.${number}.performance` | `participants.${number}.joinPath.singlePayment.orderId` | `participants.${number}.joinPath.freeCoupon.couponId` | `actionId`, 6>>;
|
|
@@ -858,6 +1473,8 @@ interface AddParticipantsOptions {
|
|
|
858
1473
|
/** @public
|
|
859
1474
|
* @documentationMaturity preview
|
|
860
1475
|
* @requiredField challengeId
|
|
1476
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
|
|
1477
|
+
* @applicableIdentity APP
|
|
861
1478
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.AddAllParticipant
|
|
862
1479
|
*/
|
|
863
1480
|
declare function addAllParticipant(challengeId: string, options?: AddAllParticipantOptions): Promise<void>;
|
|
@@ -867,6 +1484,9 @@ interface AddAllParticipantOptions {
|
|
|
867
1484
|
}
|
|
868
1485
|
/** @public
|
|
869
1486
|
* @requiredField challengeId
|
|
1487
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_JOIN
|
|
1488
|
+
* @applicableIdentity APP
|
|
1489
|
+
* @applicableIdentity MEMBER
|
|
870
1490
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.CreateJoinRequest
|
|
871
1491
|
*/
|
|
872
1492
|
declare function createJoinRequest(challengeId: string, options?: CreateJoinRequestOptions): Promise<NonNullablePaths<CreateJoinRequestResponse, `participantId` | `approvalRequestId` | `actionId` | `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
|
|
@@ -880,6 +1500,8 @@ interface CreateJoinRequestOptions {
|
|
|
880
1500
|
}
|
|
881
1501
|
/** @public
|
|
882
1502
|
* @requiredField challengeId
|
|
1503
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
|
|
1504
|
+
* @applicableIdentity APP
|
|
883
1505
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.InviteParticipants
|
|
884
1506
|
*/
|
|
885
1507
|
declare function inviteParticipants(challengeId: string, options?: InviteParticipantsOptions): Promise<NonNullablePaths<InviteParticipantsResponse, `invitations` | `invitations.${number}.participantId` | `invitations.${number}.approvalRequestId` | `actionId`, 4>>;
|
|
@@ -890,6 +1512,8 @@ interface InviteParticipantsOptions {
|
|
|
890
1512
|
}
|
|
891
1513
|
/** @public
|
|
892
1514
|
* @requiredField challengeId
|
|
1515
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
|
|
1516
|
+
* @applicableIdentity APP
|
|
893
1517
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.InviteAllParticipants
|
|
894
1518
|
*/
|
|
895
1519
|
declare function inviteAllParticipants(challengeId: string, options?: InviteAllParticipantsOptions): Promise<void>;
|
|
@@ -903,6 +1527,9 @@ interface InviteAllParticipantsOptions {
|
|
|
903
1527
|
* @requiredField identifiers
|
|
904
1528
|
* @requiredField identifiers.challengeId
|
|
905
1529
|
* @requiredField identifiers.participantId
|
|
1530
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
|
|
1531
|
+
* @applicableIdentity APP
|
|
1532
|
+
* @applicableIdentity MEMBER
|
|
906
1533
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetParticipant
|
|
907
1534
|
*/
|
|
908
1535
|
declare function getParticipant(identifiers: NonNullablePaths<GetParticipantIdentifiers, `challengeId` | `participantId`, 2>): Promise<NonNullablePaths<Participant, `_id` | `member._id` | `member.fullName` | `challenge._id` | `stepsSummary.stepsNumber` | `stepsSummary.completedStepsNumber` | `stepsSummary.failedStepsNumber` | `stepsSummary.postedFeedbacksNumber` | `stepsSummary.lastEvent.stepId` | `stepsSummary.lastEvent.transition.state` | `orderIds` | `transitions` | `transitions.${number}.state` | `timezone` | `dateFrame.start` | `performance` | `joinPath.singlePayment.orderId` | `joinPath.paidPlan.planIds` | `joinPath.freeCoupon.couponId`, 5>>;
|
|
@@ -916,6 +1543,7 @@ interface GetParticipantIdentifiers {
|
|
|
916
1543
|
* @requiredField identifiers
|
|
917
1544
|
* @requiredField identifiers.challengeId
|
|
918
1545
|
* @requiredField identifiers.participantId
|
|
1546
|
+
* @permissionId CHALLENGE-PARTICIPATE.UPDATE-PARTICIPANT
|
|
919
1547
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.UpdateParticipant
|
|
920
1548
|
*/
|
|
921
1549
|
declare function updateParticipant(identifiers: NonNullablePaths<UpdateParticipantIdentifiers, `challengeId` | `participantId`, 2>, options?: UpdateParticipantOptions): Promise<NonNullablePaths<UpdateParticipantResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId` | `actionId`, 6>>;
|
|
@@ -944,6 +1572,9 @@ interface UpdateParticipantOptionsUpdateOneOf {
|
|
|
944
1572
|
* @requiredField identifiers
|
|
945
1573
|
* @requiredField identifiers.challengeId
|
|
946
1574
|
* @requiredField identifiers.participantId
|
|
1575
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_REMOVE
|
|
1576
|
+
* @applicableIdentity APP
|
|
1577
|
+
* @applicableIdentity MEMBER
|
|
947
1578
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.DeleteParticipant
|
|
948
1579
|
*/
|
|
949
1580
|
declare function deleteParticipant(identifiers: NonNullablePaths<DeleteParticipantIdentifiers, `challengeId` | `participantId`, 2>, options?: DeleteParticipantOptions): Promise<NonNullablePaths<DeleteParticipantResponse, `actionId`, 2>>;
|
|
@@ -961,6 +1592,7 @@ interface DeleteParticipantOptions {
|
|
|
961
1592
|
* @requiredField identifiers
|
|
962
1593
|
* @requiredField identifiers.challengeId
|
|
963
1594
|
* @requiredField identifiers.participantId
|
|
1595
|
+
* @permissionId CHALLENGE-PARTICIPATE.UPDATE-PARTICIPANT
|
|
964
1596
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.ReviveParticipant
|
|
965
1597
|
*/
|
|
966
1598
|
declare function reviveParticipant(identifiers: NonNullablePaths<ReviveParticipantIdentifiers, `challengeId` | `participantId`, 2>, options?: ReviveParticipantOptions): Promise<NonNullablePaths<ReviveParticipantResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId` | `actionId`, 6>>;
|
|
@@ -978,6 +1610,7 @@ interface ReviveParticipantOptions {
|
|
|
978
1610
|
* @requiredField identifiers
|
|
979
1611
|
* @requiredField identifiers.challengeId
|
|
980
1612
|
* @requiredField identifiers.participantId
|
|
1613
|
+
* @permissionId CHALLENGE-PARTICIPATE.UPDATE-PARTICIPANT
|
|
981
1614
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.ResetParticipantProgress
|
|
982
1615
|
*/
|
|
983
1616
|
declare function resetParticipantProgress(identifiers: NonNullablePaths<ResetParticipantProgressIdentifiers, `challengeId` | `participantId`, 2>, options?: ResetParticipantProgressOptions): Promise<NonNullablePaths<ResetParticipantProgressResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId` | `actionId`, 6>>;
|
|
@@ -997,6 +1630,8 @@ interface ResetParticipantProgressOptions {
|
|
|
997
1630
|
* @requiredField identifiers
|
|
998
1631
|
* @requiredField identifiers.challengeId
|
|
999
1632
|
* @requiredField identifiers.participantId
|
|
1633
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_ISSUE_CERTIFICATE
|
|
1634
|
+
* @applicableIdentity APP
|
|
1000
1635
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.IssueParticipantCertificate
|
|
1001
1636
|
*/
|
|
1002
1637
|
declare function issueParticipantCertificate(identifiers: NonNullablePaths<IssueParticipantCertificateIdentifiers, `challengeId` | `participantId`, 2>): Promise<NonNullablePaths<IssueParticipantCertificateResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
|
|
@@ -1016,6 +1651,8 @@ interface IssueParticipantCertificateIdentifiers {
|
|
|
1016
1651
|
* @requiredField identifiers
|
|
1017
1652
|
* @requiredField identifiers.challengeId
|
|
1018
1653
|
* @requiredField identifiers.participantId
|
|
1654
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_ISSUE_CERTIFICATE
|
|
1655
|
+
* @applicableIdentity APP
|
|
1019
1656
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.IssueCertificate
|
|
1020
1657
|
*/
|
|
1021
1658
|
declare function issueCertificate(identifiers: NonNullablePaths<IssueCertificateIdentifiers, `challengeId` | `participantId`, 2>): Promise<NonNullablePaths<IssueCertificateResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
|
|
@@ -1035,6 +1672,9 @@ interface IssueCertificateIdentifiers {
|
|
|
1035
1672
|
* @requiredField identifiers
|
|
1036
1673
|
* @requiredField identifiers.challengeId
|
|
1037
1674
|
* @requiredField identifiers.participantId
|
|
1675
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
|
|
1676
|
+
* @applicableIdentity APP
|
|
1677
|
+
* @applicableIdentity MEMBER
|
|
1038
1678
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetCertificate
|
|
1039
1679
|
*/
|
|
1040
1680
|
declare function getCertificate(identifiers: NonNullablePaths<GetCertificateIdentifiers, `challengeId` | `participantId`, 2>): Promise<NonNullablePaths<GetCertificateResponse, `certificateUrl`, 2>>;
|
|
@@ -1054,6 +1694,9 @@ interface GetCertificateIdentifiers {
|
|
|
1054
1694
|
* @requiredField identifiers
|
|
1055
1695
|
* @requiredField identifiers.challengeId
|
|
1056
1696
|
* @requiredField identifiers.participantId
|
|
1697
|
+
* @permissionId CHALLENGE-PARTICIPATE.CREATE-ORDER
|
|
1698
|
+
* @applicableIdentity APP
|
|
1699
|
+
* @applicableIdentity MEMBER
|
|
1057
1700
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.CreatePaymentOrder
|
|
1058
1701
|
*/
|
|
1059
1702
|
declare function createPaymentOrder(identifiers: NonNullablePaths<CreatePaymentOrderIdentifiers, `challengeId` | `participantId`, 2>, options?: CreatePaymentOrderOptions): Promise<NonNullablePaths<CreatePaymentOrderResponse, `orderId` | `actionId` | `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
|
|
@@ -1078,6 +1721,9 @@ interface CreatePaymentOrderOptions {
|
|
|
1078
1721
|
* @requiredField identifiers.challengeId
|
|
1079
1722
|
* @requiredField identifiers.orderId
|
|
1080
1723
|
* @requiredField identifiers.participantId
|
|
1724
|
+
* @permissionId CHALLENGE-PARTICIPATE.CREATE-ORDER
|
|
1725
|
+
* @applicableIdentity APP
|
|
1726
|
+
* @applicableIdentity MEMBER
|
|
1081
1727
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.ApplyCouponToOrder
|
|
1082
1728
|
*/
|
|
1083
1729
|
declare function applyCouponToOrder(identifiers: NonNullablePaths<ApplyCouponToOrderIdentifiers, `challengeId` | `orderId` | `participantId`, 2>, couponCode: string, options?: ApplyCouponToOrderOptions): Promise<NonNullablePaths<ApplyCouponToOrderResponse, `couponId` | `subTotal` | `discount` | `total`, 2>>;
|
|
@@ -1099,6 +1745,9 @@ interface ApplyCouponToOrderOptions {
|
|
|
1099
1745
|
* @requiredField identifiers.couponId
|
|
1100
1746
|
* @requiredField identifiers.orderId
|
|
1101
1747
|
* @requiredField identifiers.participantId
|
|
1748
|
+
* @permissionId CHALLENGE-PARTICIPATE.CREATE-ORDER
|
|
1749
|
+
* @applicableIdentity APP
|
|
1750
|
+
* @applicableIdentity MEMBER
|
|
1102
1751
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.RemoveCouponFromOrder
|
|
1103
1752
|
*/
|
|
1104
1753
|
declare function removeCouponFromOrder(identifiers: NonNullablePaths<RemoveCouponFromOrderIdentifiers, `challengeId` | `couponId` | `orderId` | `participantId`, 2>, options?: RemoveCouponFromOrderOptions): Promise<NonNullablePaths<RemoveCouponFromOrderResponse, `total`, 2>>;
|
|
@@ -1116,10 +1765,286 @@ interface RemoveCouponFromOrderOptions {
|
|
|
1116
1765
|
/** @format GUID */
|
|
1117
1766
|
actionId?: string;
|
|
1118
1767
|
}
|
|
1768
|
+
/** @public
|
|
1769
|
+
* @requiredField identifiers
|
|
1770
|
+
* @requiredField identifiers.challengeId
|
|
1771
|
+
* @requiredField identifiers.participantId
|
|
1772
|
+
* @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
|
|
1773
|
+
* @applicableIdentity APP
|
|
1774
|
+
* @applicableIdentity MEMBER
|
|
1775
|
+
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListSteps
|
|
1776
|
+
* @deprecated
|
|
1777
|
+
* @replacedBy Program Steps service List
|
|
1778
|
+
* @targetRemovalDate 2026-06-30
|
|
1779
|
+
*/
|
|
1780
|
+
declare function listSteps(identifiers: NonNullablePaths<ListStepsIdentifiers, `challengeId` | `participantId`, 2>, options?: ListStepsOptions): Promise<NonNullablePaths<ListParticipantStepsResponse, `steps` | `steps.${number}._id` | `steps.${number}.source._id` | `steps.${number}.dateFrame.start` | `steps.${number}.quizSubmission.quizSubmissionId`, 5>>;
|
|
1781
|
+
interface ListStepsIdentifiers {
|
|
1782
|
+
/**
|
|
1783
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
1784
|
+
* @format GUID
|
|
1785
|
+
*/
|
|
1786
|
+
challengeId: string;
|
|
1787
|
+
/**
|
|
1788
|
+
* Participant entity ID within the challenge. GUID.
|
|
1789
|
+
* @format GUID
|
|
1790
|
+
*/
|
|
1791
|
+
participantId: string;
|
|
1792
|
+
}
|
|
1793
|
+
interface ListStepsOptions {
|
|
1794
|
+
/** Optional parent step ID to scope to sub-steps. */
|
|
1795
|
+
parentId?: string;
|
|
1796
|
+
/** Optional absolute time window for time-based progress. */
|
|
1797
|
+
timeInterval?: TimeInterval;
|
|
1798
|
+
/** Optional local date window for date-based progress. */
|
|
1799
|
+
dateInterval?: DateInterval;
|
|
1800
|
+
/** Controls verbose description fields in response. */
|
|
1801
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1802
|
+
}
|
|
1803
|
+
/** @public
|
|
1804
|
+
* @requiredField identifiers
|
|
1805
|
+
* @requiredField identifiers.challengeId
|
|
1806
|
+
* @requiredField identifiers.participantId
|
|
1807
|
+
* @requiredField identifiers.stepId
|
|
1808
|
+
* @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
|
|
1809
|
+
* @applicableIdentity APP
|
|
1810
|
+
* @applicableIdentity MEMBER
|
|
1811
|
+
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetStep
|
|
1812
|
+
* @deprecated
|
|
1813
|
+
* @replacedBy Program Steps service Get
|
|
1814
|
+
* @targetRemovalDate 2026-06-30
|
|
1815
|
+
*/
|
|
1816
|
+
declare function getStep(identifiers: NonNullablePaths<GetStepIdentifiers, `challengeId` | `participantId` | `stepId`, 2>, options?: GetStepOptions): Promise<NonNullablePaths<GetParticipantStepResponse, `step._id` | `step.source._id` | `step.source.settings.general.individual.confirmationRequired` | `step.source.settings.general.individual.feedbackSettings` | `step.source.settings.general.individual.feedbackSettings.${number}._id` | `step.source.settings.general.individual.feedbackSettings.${number}.type.numeric.maxValue` | `step.source.settings.general.individual.feedbackSettings.${number}.type.quantity.amount` | `step.source.settings.general.individual.feedbackSettings.${number}.question` | `step.source.settings.general.individual.feedbackSettings.${number}.isRequired` | `step.source.settings.general.individual.showQuiz` | `step.source.settings.general.individual.quizSettings` | `step.source.settings.general.group.completionCriteria.completedSteps.minThreshold.value` | `step.source.settings.general.quiz.quizId` | `step.source.settings.general.quiz.questionCount` | `step.source.settings.general.quiz.migrationDetails.sourceStepId` | `step.source.settings.general.quiz.migrationDetails.show` | `step.source.settings.general.quiz.migrationDetails.quizType` | `step.source.settings.general.video.wixVideo._id` | `step.source.settings.general.video.wixVideo.paid` | `step.source.settings.general.video.requiredCompletionPercentage` | `step.source.settings.general.video.deleted` | `step.source.settings.general.duration.unit` | `step.source.settings.general.duration.value` | `step.source.settings.general.recurrenceSettings.schedules` | `step.source.settings.embedding.startConditions` | `step.source.settings.embedding.startConditions.${number}.dependency.step.stepId` | `step.source.settings.embedding.isMilestone` | `step.feedback.items` | `step.feedback.items.${number}.choice.choiceId` | `step.feedback.items.${number}.quantity.unitName` | `step.feedback.items.${number}.quantity.amount` | `step.feedback.items.${number}.feedbackItemSettingsId` | `step.feedback.quiz` | `step.transitions` | `step.transitions.${number}.state` | `step.dateFrame.start` | `step.quizSubmission.quizSubmissionId` | `subSteps` | `subSteps.${number}._id` | `subSteps.${number}.source._id` | `subSteps.${number}.dateFrame.start` | `subSteps.${number}.quizSubmission.quizSubmissionId`, 11>>;
|
|
1817
|
+
interface GetStepIdentifiers {
|
|
1818
|
+
/**
|
|
1819
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
1820
|
+
* @format GUID
|
|
1821
|
+
*/
|
|
1822
|
+
challengeId: string;
|
|
1823
|
+
/**
|
|
1824
|
+
* Participant entity ID. GUID.
|
|
1825
|
+
* @format GUID
|
|
1826
|
+
*/
|
|
1827
|
+
participantId: string;
|
|
1828
|
+
/** Step ID (program step or resolved instance). */
|
|
1829
|
+
stepId: string;
|
|
1830
|
+
}
|
|
1831
|
+
interface GetStepOptions {
|
|
1832
|
+
/** Optional absolute time window for time-based progress. */
|
|
1833
|
+
timeInterval?: TimeInterval;
|
|
1834
|
+
/** Controls verbose description fields in response. */
|
|
1835
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1836
|
+
}
|
|
1837
|
+
/** @public
|
|
1838
|
+
* @requiredField identifiers
|
|
1839
|
+
* @requiredField identifiers.challengeId
|
|
1840
|
+
* @requiredField identifiers.participantId
|
|
1841
|
+
* @requiredField identifiers.stepId
|
|
1842
|
+
* @permissionId CHALLENGE-PARTICIPATE.COMPLETE-PARTICIPANT-STEP
|
|
1843
|
+
* @applicableIdentity APP
|
|
1844
|
+
* @applicableIdentity MEMBER
|
|
1845
|
+
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.ResolveStep
|
|
1846
|
+
* @deprecated
|
|
1847
|
+
* @targetRemovalDate 2026-06-30
|
|
1848
|
+
*/
|
|
1849
|
+
declare function resolveStep(identifiers: NonNullablePaths<ResolveStepIdentifiers, `challengeId` | `participantId` | `stepId`, 2>, options?: ResolveStepOptions): Promise<NonNullablePaths<ResolveParticipantStepResponse, `step._id` | `step.source._id` | `step.source.settings.general.individual.confirmationRequired` | `step.source.settings.general.individual.feedbackSettings` | `step.source.settings.general.individual.feedbackSettings.${number}._id` | `step.source.settings.general.individual.feedbackSettings.${number}.type.numeric.maxValue` | `step.source.settings.general.individual.feedbackSettings.${number}.type.quantity.amount` | `step.source.settings.general.individual.feedbackSettings.${number}.question` | `step.source.settings.general.individual.feedbackSettings.${number}.isRequired` | `step.source.settings.general.individual.showQuiz` | `step.source.settings.general.individual.quizSettings` | `step.source.settings.general.group.completionCriteria.completedSteps.minThreshold.value` | `step.source.settings.general.quiz.quizId` | `step.source.settings.general.quiz.questionCount` | `step.source.settings.general.quiz.migrationDetails.sourceStepId` | `step.source.settings.general.quiz.migrationDetails.show` | `step.source.settings.general.quiz.migrationDetails.quizType` | `step.source.settings.general.video.wixVideo._id` | `step.source.settings.general.video.wixVideo.paid` | `step.source.settings.general.video.requiredCompletionPercentage` | `step.source.settings.general.video.deleted` | `step.source.settings.general.duration.unit` | `step.source.settings.general.duration.value` | `step.source.settings.general.recurrenceSettings.schedules` | `step.source.settings.embedding.startConditions` | `step.source.settings.embedding.startConditions.${number}.dependency.step.stepId` | `step.source.settings.embedding.isMilestone` | `step.feedback.items` | `step.feedback.items.${number}.choice.choiceId` | `step.feedback.items.${number}.quantity.unitName` | `step.feedback.items.${number}.quantity.amount` | `step.feedback.items.${number}.feedbackItemSettingsId` | `step.feedback.quiz` | `step.transitions` | `step.transitions.${number}.state` | `step.dateFrame.start` | `step.quizSubmission.quizSubmissionId` | `actionId`, 11>>;
|
|
1850
|
+
interface ResolveStepIdentifiers {
|
|
1851
|
+
/**
|
|
1852
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
1853
|
+
* @format GUID
|
|
1854
|
+
*/
|
|
1855
|
+
challengeId: string;
|
|
1856
|
+
/**
|
|
1857
|
+
* Participant entity ID. GUID.
|
|
1858
|
+
* @format GUID
|
|
1859
|
+
*/
|
|
1860
|
+
participantId: string;
|
|
1861
|
+
/** Target step ID to resolve. */
|
|
1862
|
+
stepId: string;
|
|
1863
|
+
}
|
|
1864
|
+
interface ResolveStepOptions {
|
|
1865
|
+
/** Resolution action to apply. */
|
|
1866
|
+
status?: ResolutionStatusWithLiterals;
|
|
1867
|
+
/** Optional instructor feedback payload. */
|
|
1868
|
+
feedback?: Feedback;
|
|
1869
|
+
/** Optional idempotency key for action tracking. */
|
|
1870
|
+
actionId?: string;
|
|
1871
|
+
/**
|
|
1872
|
+
* Optional quiz submission to attach. GUID.
|
|
1873
|
+
* @format GUID
|
|
1874
|
+
*/
|
|
1875
|
+
quizSubmissionId?: string | null;
|
|
1876
|
+
}
|
|
1877
|
+
/** @public
|
|
1878
|
+
* @requiredField identifiers
|
|
1879
|
+
* @requiredField identifiers.challengeId
|
|
1880
|
+
* @requiredField identifiers.participantId
|
|
1881
|
+
* @requiredField identifiers.stepId
|
|
1882
|
+
* @permissionId CHALLENGE-PARTICIPATE.COMPLETE-PARTICIPANT-STEP
|
|
1883
|
+
* @applicableIdentity APP
|
|
1884
|
+
* @applicableIdentity MEMBER
|
|
1885
|
+
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.UpdateStepFeedback
|
|
1886
|
+
* @deprecated
|
|
1887
|
+
* @targetRemovalDate 2026-06-30
|
|
1888
|
+
*/
|
|
1889
|
+
declare function updateStepFeedback(identifiers: NonNullablePaths<UpdateStepFeedbackIdentifiers, `challengeId` | `participantId` | `stepId`, 2>, options?: UpdateStepFeedbackOptions): Promise<NonNullablePaths<UpdateStepFeedbackResponse, `step._id` | `step.source._id` | `step.source.settings.general.individual.confirmationRequired` | `step.source.settings.general.individual.feedbackSettings` | `step.source.settings.general.individual.feedbackSettings.${number}._id` | `step.source.settings.general.individual.feedbackSettings.${number}.type.numeric.maxValue` | `step.source.settings.general.individual.feedbackSettings.${number}.type.quantity.amount` | `step.source.settings.general.individual.feedbackSettings.${number}.question` | `step.source.settings.general.individual.feedbackSettings.${number}.isRequired` | `step.source.settings.general.individual.showQuiz` | `step.source.settings.general.individual.quizSettings` | `step.source.settings.general.group.completionCriteria.completedSteps.minThreshold.value` | `step.source.settings.general.quiz.quizId` | `step.source.settings.general.quiz.questionCount` | `step.source.settings.general.quiz.migrationDetails.sourceStepId` | `step.source.settings.general.quiz.migrationDetails.show` | `step.source.settings.general.quiz.migrationDetails.quizType` | `step.source.settings.general.video.wixVideo._id` | `step.source.settings.general.video.wixVideo.paid` | `step.source.settings.general.video.requiredCompletionPercentage` | `step.source.settings.general.video.deleted` | `step.source.settings.general.duration.unit` | `step.source.settings.general.duration.value` | `step.source.settings.general.recurrenceSettings.schedules` | `step.source.settings.embedding.startConditions` | `step.source.settings.embedding.startConditions.${number}.dependency.step.stepId` | `step.source.settings.embedding.isMilestone` | `step.feedback.items` | `step.feedback.items.${number}.choice.choiceId` | `step.feedback.items.${number}.quantity.unitName` | `step.feedback.items.${number}.quantity.amount` | `step.feedback.items.${number}.feedbackItemSettingsId` | `step.feedback.quiz` | `step.transitions` | `step.transitions.${number}.state` | `step.dateFrame.start` | `step.quizSubmission.quizSubmissionId` | `actionId`, 11>>;
|
|
1890
|
+
interface UpdateStepFeedbackIdentifiers {
|
|
1891
|
+
/**
|
|
1892
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
1893
|
+
* @format GUID
|
|
1894
|
+
*/
|
|
1895
|
+
challengeId: string;
|
|
1896
|
+
/**
|
|
1897
|
+
* Participant entity ID. GUID.
|
|
1898
|
+
* @format GUID
|
|
1899
|
+
*/
|
|
1900
|
+
participantId: string;
|
|
1901
|
+
/** Target step ID to update feedback for. */
|
|
1902
|
+
stepId: string;
|
|
1903
|
+
}
|
|
1904
|
+
interface UpdateStepFeedbackOptions {
|
|
1905
|
+
/** New feedback payload. */
|
|
1906
|
+
feedback?: Feedback;
|
|
1907
|
+
/**
|
|
1908
|
+
* Idempotency key for feedback update. GUID.
|
|
1909
|
+
* @format GUID
|
|
1910
|
+
*/
|
|
1911
|
+
actionId?: string;
|
|
1912
|
+
}
|
|
1913
|
+
/** @public
|
|
1914
|
+
* @requiredField identifiers
|
|
1915
|
+
* @requiredField identifiers.challengeId
|
|
1916
|
+
* @requiredField identifiers.participantId
|
|
1917
|
+
* @permissionId CHALLENGE-PARTICIPATE.UPLOAD-MEDIA
|
|
1918
|
+
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetMediaUploadInfo
|
|
1919
|
+
* @deprecated
|
|
1920
|
+
* @targetRemovalDate 2026-06-30
|
|
1921
|
+
*/
|
|
1922
|
+
declare function getMediaUploadInfo(identifiers: NonNullablePaths<GetMediaUploadInfoIdentifiers, `challengeId` | `participantId`, 2>, options?: GetMediaUploadInfoOptions): Promise<NonNullablePaths<GetMediaUploadInfoResponse, `uploadUrl` | `uploadToken`, 2>>;
|
|
1923
|
+
interface GetMediaUploadInfoIdentifiers {
|
|
1924
|
+
/**
|
|
1925
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
1926
|
+
* @format GUID
|
|
1927
|
+
*/
|
|
1928
|
+
challengeId: string;
|
|
1929
|
+
/**
|
|
1930
|
+
* Participant entity ID. GUID.
|
|
1931
|
+
* @format GUID
|
|
1932
|
+
*/
|
|
1933
|
+
participantId: string;
|
|
1934
|
+
}
|
|
1935
|
+
interface GetMediaUploadInfoOptions {
|
|
1936
|
+
/** Original filename to derive content-type and path. */
|
|
1937
|
+
fileName?: string;
|
|
1938
|
+
}
|
|
1939
|
+
/**
|
|
1940
|
+
* ---------------------------------------------------- Sections --------------------------------------------------------
|
|
1941
|
+
* @public
|
|
1942
|
+
* @requiredField identifiers
|
|
1943
|
+
* @requiredField identifiers.challengeId
|
|
1944
|
+
* @requiredField identifiers.participantId
|
|
1945
|
+
* @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
|
|
1946
|
+
* @applicableIdentity APP
|
|
1947
|
+
* @applicableIdentity MEMBER
|
|
1948
|
+
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListSections
|
|
1949
|
+
* @deprecated
|
|
1950
|
+
* @targetRemovalDate 2026-06-30
|
|
1951
|
+
*/
|
|
1952
|
+
declare function listSections(identifiers: NonNullablePaths<ListSectionsIdentifiers, `challengeId` | `participantId`, 2>, options?: ListSectionsOptions): Promise<NonNullablePaths<ListParticipantSectionsResponse, `sections` | `sections.${number}._id` | `sections.${number}.source._id` | `sections.${number}.progress.nTotalSteps` | `sections.${number}.progress.nCompletedSteps`, 5>>;
|
|
1953
|
+
interface ListSectionsIdentifiers {
|
|
1954
|
+
/**
|
|
1955
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
1956
|
+
* @format GUID
|
|
1957
|
+
*/
|
|
1958
|
+
challengeId: string;
|
|
1959
|
+
/**
|
|
1960
|
+
* Participant entity ID. GUID.
|
|
1961
|
+
* @format GUID
|
|
1962
|
+
*/
|
|
1963
|
+
participantId: string;
|
|
1964
|
+
}
|
|
1965
|
+
interface ListSectionsOptions {
|
|
1966
|
+
/** Controls verbose description fields in response. */
|
|
1967
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1968
|
+
}
|
|
1969
|
+
/** @public
|
|
1970
|
+
* @requiredField identifiers
|
|
1971
|
+
* @requiredField identifiers.challengeId
|
|
1972
|
+
* @requiredField identifiers.participantId
|
|
1973
|
+
* @requiredField identifiers.sectionId
|
|
1974
|
+
* @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
|
|
1975
|
+
* @applicableIdentity APP
|
|
1976
|
+
* @applicableIdentity MEMBER
|
|
1977
|
+
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetSection
|
|
1978
|
+
* @deprecated
|
|
1979
|
+
* @targetRemovalDate 2026-06-30
|
|
1980
|
+
*/
|
|
1981
|
+
declare function getSection(identifiers: NonNullablePaths<GetSectionIdentifiers, `challengeId` | `participantId` | `sectionId`, 2>, options?: GetSectionOptions): Promise<NonNullablePaths<GetParticipantSectionResponse, `section._id` | `section.source._id` | `section.source.settings.startCondition.dependency.step.stepId` | `section.source.settings.startCondition.delay.unit` | `section.source.settings.startCondition.delay.value` | `section.source.steps` | `section.source.steps.${number}._id` | `section.source.steps.${number}.settings.embedding.isMilestone` | `section.steps` | `section.steps.${number}._id` | `section.steps.${number}.dateFrame.start` | `section.steps.${number}.quizSubmission.quizSubmissionId` | `section.transitions` | `section.transitions.${number}.waitingDate.startDate` | `section.transitions.${number}.waitingDependency.sectionId` | `section.progress.nTotalSteps` | `section.progress.nCompletedSteps`, 8>>;
|
|
1982
|
+
interface GetSectionIdentifiers {
|
|
1983
|
+
/**
|
|
1984
|
+
* Challenge/Program (tenant) ID. GUID.
|
|
1985
|
+
* @format GUID
|
|
1986
|
+
*/
|
|
1987
|
+
challengeId: string;
|
|
1988
|
+
/**
|
|
1989
|
+
* Participant entity ID. GUID.
|
|
1990
|
+
* @format GUID
|
|
1991
|
+
*/
|
|
1992
|
+
participantId: string;
|
|
1993
|
+
/**
|
|
1994
|
+
* Section ID to fetch. GUID.
|
|
1995
|
+
* @format GUID
|
|
1996
|
+
*/
|
|
1997
|
+
sectionId: string;
|
|
1998
|
+
}
|
|
1999
|
+
interface GetSectionOptions {
|
|
2000
|
+
/** Controls verbose description fields in response. */
|
|
2001
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
2002
|
+
}
|
|
1119
2003
|
/** @public
|
|
1120
2004
|
* @requiredField programId
|
|
2005
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
|
|
2006
|
+
* @applicableIdentity APP
|
|
2007
|
+
* @applicableIdentity MEMBER
|
|
1121
2008
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgram
|
|
1122
2009
|
*/
|
|
1123
2010
|
declare function myProgram(programId: string): Promise<NonNullablePaths<MyProgramResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
|
|
2011
|
+
/** @public
|
|
2012
|
+
* @requiredField identifiers
|
|
2013
|
+
* @requiredField identifiers.programId
|
|
2014
|
+
* @requiredField identifiers.programStepId
|
|
2015
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
|
|
2016
|
+
* @applicableIdentity APP
|
|
2017
|
+
* @applicableIdentity MEMBER
|
|
2018
|
+
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgramStep
|
|
2019
|
+
* @deprecated
|
|
2020
|
+
* @targetRemovalDate 2026-06-30
|
|
2021
|
+
*/
|
|
2022
|
+
declare function myProgramStep(identifiers: NonNullablePaths<MyProgramStepIdentifiers, `programId` | `programStepId`, 2>, options?: MyProgramStepOptions): Promise<NonNullablePaths<MyProgramStepResponse, `participantStep._id` | `participantStep.source._id` | `participantStep.source.settings.general.individual.confirmationRequired` | `participantStep.source.settings.general.individual.feedbackSettings` | `participantStep.source.settings.general.individual.feedbackSettings.${number}._id` | `participantStep.source.settings.general.individual.feedbackSettings.${number}.type.numeric.maxValue` | `participantStep.source.settings.general.individual.feedbackSettings.${number}.type.quantity.amount` | `participantStep.source.settings.general.individual.feedbackSettings.${number}.question` | `participantStep.source.settings.general.individual.feedbackSettings.${number}.isRequired` | `participantStep.source.settings.general.individual.showQuiz` | `participantStep.source.settings.general.individual.quizSettings` | `participantStep.source.settings.general.group.completionCriteria.completedSteps.minThreshold.value` | `participantStep.source.settings.general.quiz.quizId` | `participantStep.source.settings.general.quiz.questionCount` | `participantStep.source.settings.general.quiz.migrationDetails.sourceStepId` | `participantStep.source.settings.general.quiz.migrationDetails.show` | `participantStep.source.settings.general.quiz.migrationDetails.quizType` | `participantStep.source.settings.general.video.wixVideo._id` | `participantStep.source.settings.general.video.wixVideo.paid` | `participantStep.source.settings.general.video.requiredCompletionPercentage` | `participantStep.source.settings.general.video.deleted` | `participantStep.source.settings.general.duration.unit` | `participantStep.source.settings.general.duration.value` | `participantStep.source.settings.general.recurrenceSettings.schedules` | `participantStep.source.settings.embedding.startConditions` | `participantStep.source.settings.embedding.startConditions.${number}.dependency.step.stepId` | `participantStep.source.settings.embedding.isMilestone` | `participantStep.feedback.items` | `participantStep.feedback.items.${number}.choice.choiceId` | `participantStep.feedback.items.${number}.quantity.unitName` | `participantStep.feedback.items.${number}.quantity.amount` | `participantStep.feedback.items.${number}.feedbackItemSettingsId` | `participantStep.feedback.quiz` | `participantStep.transitions` | `participantStep.transitions.${number}.state` | `participantStep.dateFrame.start` | `participantStep.quizSubmission.quizSubmissionId`, 11>>;
|
|
2023
|
+
interface MyProgramStepIdentifiers {
|
|
2024
|
+
programId: string;
|
|
2025
|
+
programStepId: string;
|
|
2026
|
+
}
|
|
2027
|
+
interface MyProgramStepOptions {
|
|
2028
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
2029
|
+
}
|
|
2030
|
+
/** @public
|
|
2031
|
+
* @requiredField identifiers
|
|
2032
|
+
* @requiredField identifiers.programId
|
|
2033
|
+
* @requiredField identifiers.programSectionId
|
|
2034
|
+
* @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
|
|
2035
|
+
* @applicableIdentity APP
|
|
2036
|
+
* @applicableIdentity MEMBER
|
|
2037
|
+
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgramSection
|
|
2038
|
+
* @deprecated
|
|
2039
|
+
* @targetRemovalDate 2026-06-30
|
|
2040
|
+
*/
|
|
2041
|
+
declare function myProgramSection(identifiers: NonNullablePaths<MyProgramSectionIdentifiers, `programId` | `programSectionId`, 2>, options?: MyProgramSectionOptions): Promise<NonNullablePaths<MyProgramSectionResponse, `participantSection._id` | `participantSection.source._id` | `participantSection.source.settings.startCondition.dependency.step.stepId` | `participantSection.source.settings.startCondition.delay.unit` | `participantSection.source.settings.startCondition.delay.value` | `participantSection.source.steps` | `participantSection.source.steps.${number}._id` | `participantSection.source.steps.${number}.settings.embedding.isMilestone` | `participantSection.steps` | `participantSection.steps.${number}._id` | `participantSection.steps.${number}.dateFrame.start` | `participantSection.steps.${number}.quizSubmission.quizSubmissionId` | `participantSection.transitions` | `participantSection.transitions.${number}.waitingDate.startDate` | `participantSection.transitions.${number}.waitingDependency.sectionId` | `participantSection.progress.nTotalSteps` | `participantSection.progress.nCompletedSteps`, 8>>;
|
|
2042
|
+
interface MyProgramSectionIdentifiers {
|
|
2043
|
+
programId: string;
|
|
2044
|
+
programSectionId: string;
|
|
2045
|
+
}
|
|
2046
|
+
interface MyProgramSectionOptions {
|
|
2047
|
+
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
2048
|
+
}
|
|
1124
2049
|
|
|
1125
|
-
export { type ActionEvent, type AddAllParticipantOptions, type AddAllParticipantRequest, type AddAllParticipantResponse, type AddParticipantOptions, type AddParticipantRequest, type AddParticipantResponse, type AddParticipantsOptions, type AddParticipantsRequest, type AddParticipantsResponse, type Added, type ApplyCouponToOrderIdentifiers, type ApplyCouponToOrderOptions, type ApplyCouponToOrderRequest, type ApplyCouponToOrderResponse, type BaseEventMetadata, type Certificate, type CreateJoinRequestOptions, type CreateJoinRequestRequest, type CreateJoinRequestResponse, type CreatePaymentOrderIdentifiers, type CreatePaymentOrderOptions, type CreatePaymentOrderRequest, type CreatePaymentOrderResponse, type DateInterval, type DeleteParticipantIdentifiers, type DeleteParticipantOptions, type DeleteParticipantRequest, type DeleteParticipantResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntitySummary, type EntityUpdatedEvent, type EventMetadata, type FocalPoint, type Free, type FreeCoupon, type GetCertificateIdentifiers, type GetCertificateRequest, type GetCertificateResponse, type GetParticipantIdentifiers, type GetParticipantRequest, type GetParticipantResponse, type IdentificationData, type IdentificationDataIdOneOf, type InvitationDetails, type InviteAllParticipantsOptions, type InviteAllParticipantsRequest, type InviteAllParticipantsResponse, type InviteParticipantsOptions, type InviteParticipantsRequest, type InviteParticipantsResponse, type IssueCertificateIdentifiers, type IssueCertificateRequest, type IssueCertificateResponse, type IssueParticipantCertificateIdentifiers, type IssueParticipantCertificateRequest, type IssueParticipantCertificateResponse, type JoinParticipantOptions, type JoinParticipantRequest, type JoinParticipantResponse, type JoinPath, type JoinPathPathOneOf, type ListParticipantsOptions, type ListParticipantsRequest, type ListParticipantsResponse, type MediaItem, type MediaItemMediaOneOf, type Member, type MessageEnvelope, type MyProgramRequest, type MyProgramResponse, type Paging, type PaidPlan, type Participant, type ParticipantDeletedEnvelope, type ParticipantJoinDate, type ParticipantJoined, type ParticipantJoinedEnvelope, type ParticipantPerformance, ParticipantStepState, type ParticipantStepStateTransition, type ParticipantStepStateWithLiterals, type ParticipantsFilter, ParticipationState, type ParticipationStateWithLiterals, PaymentType, type PaymentTypeWithLiterals, type Price, type QueryParticipantsOptions, type QueryParticipantsRequest, QueryParticipantsRequestJoinPath, type QueryParticipantsRequestJoinPathWithLiterals, type QueryParticipantsRequestSorting, QueryParticipantsRequestSortingCriterion, type QueryParticipantsRequestSortingCriterionWithLiterals, QueryParticipantsRequestSortingOrder, type QueryParticipantsRequestSortingOrderWithLiterals, type QueryParticipantsResponse, type RemoveCouponFromOrderIdentifiers, type RemoveCouponFromOrderOptions, type RemoveCouponFromOrderRequest, type RemoveCouponFromOrderResponse, type ResetParticipantProgressIdentifiers, type ResetParticipantProgressOptions, type ResetParticipantProgressRequest, type ResetParticipantProgressResponse, type RestoreInfo, type ReviveParticipantIdentifiers, type ReviveParticipantOptions, type ReviveParticipantRequest, type ReviveParticipantResponse, type SinglePayment, type Sorting, SortingCriterion, type SortingCriterionWithLiterals, SortingOrder, type SortingOrderWithLiterals, State, type StateTransition, type StateWithLiterals, type StepEvent, type StepsSummary, type TimeInterval, type UpdateParticipantIdentifiers, type UpdateParticipantIdentifiersUpdateOneOf, type UpdateParticipantOptions, type UpdateParticipantOptionsUpdateOneOf, type UpdateParticipantRequest, type UpdateParticipantRequestUpdateOneOf, type UpdateParticipantResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addAllParticipant, addParticipant, addParticipants, applyCouponToOrder, createJoinRequest, createPaymentOrder, deleteParticipant, getCertificate, getParticipant, inviteAllParticipants, inviteParticipants, issueCertificate, issueParticipantCertificate, joinParticipant, listParticipants, myProgram, onParticipantDeleted, onParticipantJoined, queryParticipants, removeCouponFromOrder, resetParticipantProgress, reviveParticipant, updateParticipant };
|
|
2050
|
+
export { type ActionEvent, type AddAllParticipantOptions, type AddAllParticipantRequest, type AddAllParticipantResponse, type AddParticipantOptions, type AddParticipantRequest, type AddParticipantResponse, type AddParticipantsOptions, type AddParticipantsRequest, type AddParticipantsResponse, type Added, type All, type ApplyCouponToOrderIdentifiers, type ApplyCouponToOrderOptions, type ApplyCouponToOrderRequest, type ApplyCouponToOrderResponse, type BaseEventMetadata, type Certificate, type ChallengeSection, type ChallengeStep, type ChallengeStepSettings, type Choice, ChoiceRightness, type ChoiceRightnessWithLiterals, type Choices, type Completed, type CompletionCriteria, type Container, type CreateJoinRequestOptions, type CreateJoinRequestRequest, type CreateJoinRequestResponse, type CreatePaymentOrderIdentifiers, type CreatePaymentOrderOptions, type CreatePaymentOrderRequest, type CreatePaymentOrderResponse, type DateInterval, type DeleteParticipantIdentifiers, type DeleteParticipantOptions, type DeleteParticipantRequest, type DeleteParticipantResponse, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type DomainEvent, type DomainEventBodyOneOf, DurationUnit, type DurationUnitWithLiterals, type EmbeddingSettings, type EntityCreatedEvent, type EntityDeletedEvent, type EntitySummary, type EntityUpdatedEvent, type EventMetadata, type Feedback, type FeedbackItem, type FeedbackItemChoice, type FeedbackItemSettings, type FeedbackItemType, type FeedbackItemTypeTypeOneOf, type FeedbackItemValueOneOf, type FocalPoint, type Free, type FreeCoupon, type GeneralSettings, type GeneralSettingsStepTypeOneOf, type GetCertificateIdentifiers, type GetCertificateRequest, type GetCertificateResponse, type GetMediaUploadInfoIdentifiers, type GetMediaUploadInfoOptions, type GetMediaUploadInfoRequest, type GetMediaUploadInfoResponse, type GetParticipantIdentifiers, type GetParticipantRequest, type GetParticipantResponse, type GetParticipantSectionRequest, type GetParticipantSectionResponse, type GetParticipantStepRequest, type GetParticipantStepResponse, type GetSectionIdentifiers, type GetSectionOptions, type GetStepIdentifiers, type GetStepOptions, type GroupSettings, type IdentificationData, type IdentificationDataIdOneOf, type IndividualSettings, type InvitationDetails, type InviteAllParticipantsOptions, type InviteAllParticipantsRequest, type InviteAllParticipantsResponse, type InviteParticipantsOptions, type InviteParticipantsRequest, type InviteParticipantsResponse, type IssueCertificateIdentifiers, type IssueCertificateRequest, type IssueCertificateResponse, type IssueParticipantCertificateIdentifiers, type IssueParticipantCertificateRequest, type IssueParticipantCertificateResponse, type JoinParticipantOptions, type JoinParticipantRequest, type JoinParticipantResponse, type JoinPath, type JoinPathPathOneOf, type ListParticipantSectionsRequest, type ListParticipantSectionsResponse, type ListParticipantStepsRequest, type ListParticipantStepsResponse, type ListParticipantsOptions, type ListParticipantsRequest, type ListParticipantsResponse, type ListSectionsIdentifiers, type ListSectionsOptions, type ListStepsIdentifiers, type ListStepsOptions, type MediaFeedbackItem, type MediaItem, type MediaItemMediaOneOf, type MediaItems, type Member, type MessageEnvelope, type MinThreshold, type MultipleChoiceFeedbackItem, type MyProgramRequest, type MyProgramResponse, type MyProgramSectionIdentifiers, type MyProgramSectionOptions, type MyProgramSectionRequest, type MyProgramSectionResponse, type MyProgramStepIdentifiers, type MyProgramStepOptions, type MyProgramStepRequest, type MyProgramStepResponse, type NumericFeedbackItem, type ObjectDescription, type Overdue, type Paging, type PaidPlan, type Participant, type ParticipantDeletedEnvelope, type ParticipantJoinDate, type ParticipantJoined, type ParticipantJoinedEnvelope, type ParticipantPerformance, type ParticipantSection, type ParticipantSectionStateTransition, type ParticipantSectionStateTransitionStateOneOf, type ParticipantStep, type ParticipantStepResolvedEnvelope, ParticipantStepState, type ParticipantStepStateTransition, type ParticipantStepStateWithLiterals, type ParticipantsFilter, ParticipationState, type ParticipationStateWithLiterals, PaymentType, type PaymentTypeWithLiterals, type Price, type Progress, type Quantity, type QuantityCriterion, type QuantityCriterionCriterionOneOf, type QuantityFeedbackItem, type QueryParticipantsOptions, type QueryParticipantsRequest, QueryParticipantsRequestJoinPath, type QueryParticipantsRequestJoinPathWithLiterals, type QueryParticipantsRequestSorting, QueryParticipantsRequestSortingCriterion, type QueryParticipantsRequestSortingCriterionWithLiterals, QueryParticipantsRequestSortingOrder, type QueryParticipantsRequestSortingOrderWithLiterals, type QueryParticipantsResponse, type QuizMigrationDetails, type QuizSettings, type QuizSubmission, type QuizSubmissionData, QuizType, type QuizTypeWithLiterals, type RecurrenceSchedule, type RecurrenceSettings, type RemoveCouponFromOrderIdentifiers, type RemoveCouponFromOrderOptions, type RemoveCouponFromOrderRequest, type RemoveCouponFromOrderResponse, type ResetParticipantProgressIdentifiers, type ResetParticipantProgressOptions, type ResetParticipantProgressRequest, type ResetParticipantProgressResponse, ResolutionStatus, type ResolutionStatusWithLiterals, type ResolveParticipantStepRequest, type ResolveParticipantStepResponse, type ResolveStepIdentifiers, type ResolveStepOptions, type RestoreInfo, type ReviveParticipantIdentifiers, type ReviveParticipantOptions, type ReviveParticipantRequest, type ReviveParticipantResponse, type Running, type Settings, type SinglePayment, type Sorting, SortingCriterion, type SortingCriterionWithLiterals, SortingOrder, type SortingOrderWithLiterals, type StartCondition, State, type StateTransition, type StateWithLiterals, Status, type StatusWithLiterals, type Step, type StepDependency, type StepDependencyDependencyTypeOneOf, type StepEvent, type StepResolved, type StepsSummary, type TextFeedbackItem, type TimeDuration, type TimeInterval, type UpdateParticipantIdentifiers, type UpdateParticipantIdentifiersUpdateOneOf, type UpdateParticipantOptions, type UpdateParticipantOptionsUpdateOneOf, type UpdateParticipantRequest, type UpdateParticipantRequestUpdateOneOf, type UpdateParticipantResponse, type UpdateStepFeedbackIdentifiers, type UpdateStepFeedbackOptions, type UpdateStepFeedbackRequest, type UpdateStepFeedbackResponse, type VideoResolution, type VideoStepSettings, type VideoStepSettingsVideoSourceOneOf, type WaitingDate, type WaitingDependency, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixVideo, addAllParticipant, addParticipant, addParticipants, applyCouponToOrder, createJoinRequest, createPaymentOrder, deleteParticipant, getCertificate, getMediaUploadInfo, getParticipant, getSection, getStep, inviteAllParticipants, inviteParticipants, issueCertificate, issueParticipantCertificate, joinParticipant, listParticipants, listSections, listSteps, myProgram, myProgramSection, myProgramStep, onParticipantDeleted, onParticipantJoined, onParticipantStepResolved, queryParticipants, removeCouponFromOrder, resetParticipantProgress, resolveStep, reviveParticipant, updateParticipant, updateStepFeedback };
|