@wix/auto_sdk_online-programs_online-program-participants 1.0.3 → 1.0.4
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 +3 -63
- package/build/cjs/index.js +477 -5391
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +1 -697
- package/build/cjs/index.typings.js +482 -5266
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +2 -563
- package/build/cjs/meta.js +72 -3898
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +3 -63
- package/build/es/index.mjs +565 -5463
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +1 -697
- package/build/es/index.typings.mjs +412 -5181
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +2 -563
- package/build/es/meta.mjs +45 -3856
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +3 -63
- package/build/internal/cjs/index.js +477 -5391
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +1 -697
- package/build/internal/cjs/index.typings.js +482 -5266
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +2 -563
- package/build/internal/cjs/meta.js +72 -3898
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +3 -63
- package/build/internal/es/index.mjs +565 -5463
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +1 -697
- package/build/internal/es/index.typings.mjs +412 -5181
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +2 -563
- package/build/internal/es/meta.mjs +45 -3856
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -571,518 +571,12 @@ interface RemoveCouponFromOrderRequest {
|
|
|
571
571
|
interface RemoveCouponFromOrderResponse {
|
|
572
572
|
total?: string;
|
|
573
573
|
}
|
|
574
|
-
interface ListParticipantStepsRequest {
|
|
575
|
-
/** @format GUID */
|
|
576
|
-
challengeId: string;
|
|
577
|
-
/** @format GUID */
|
|
578
|
-
participantId: string;
|
|
579
|
-
parentId?: string;
|
|
580
|
-
timeInterval?: TimeInterval;
|
|
581
|
-
dateInterval?: DateInterval;
|
|
582
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
583
|
-
}
|
|
584
|
-
declare enum DescriptionFieldSet {
|
|
585
|
-
/** title and detailed description. */
|
|
586
|
-
EXTENDED = "EXTENDED",
|
|
587
|
-
/** title only. */
|
|
588
|
-
STANDARD = "STANDARD"
|
|
589
|
-
}
|
|
590
|
-
/** @enumType */
|
|
591
|
-
type DescriptionFieldSetWithLiterals = DescriptionFieldSet | 'EXTENDED' | 'STANDARD';
|
|
592
|
-
interface ListParticipantStepsResponse {
|
|
593
|
-
steps?: ParticipantStep[];
|
|
594
|
-
}
|
|
595
|
-
interface ParticipantStep {
|
|
596
|
-
_id?: string;
|
|
597
|
-
source?: ChallengeStep;
|
|
598
|
-
timeFrame?: TimeInterval;
|
|
599
|
-
feedback?: Feedback;
|
|
600
|
-
transitions?: ParticipantStepStateTransition[];
|
|
601
|
-
dateFrame?: DateInterval;
|
|
602
|
-
quizSubmission?: QuizSubmission;
|
|
603
|
-
}
|
|
604
|
-
interface FeedbackItem extends FeedbackItemValueOneOf {
|
|
605
|
-
number?: number | null;
|
|
606
|
-
text?: string | null;
|
|
607
|
-
media?: MediaItems;
|
|
608
|
-
choice?: FeedbackItemChoice;
|
|
609
|
-
quantity?: Quantity;
|
|
610
|
-
multiSelect?: Choices;
|
|
611
|
-
/** @format GUID */
|
|
612
|
-
feedbackItemSettingsId?: string;
|
|
613
|
-
}
|
|
614
|
-
/** @oneof */
|
|
615
|
-
interface FeedbackItemValueOneOf {
|
|
616
|
-
number?: number | null;
|
|
617
|
-
text?: string | null;
|
|
618
|
-
media?: MediaItems;
|
|
619
|
-
choice?: FeedbackItemChoice;
|
|
620
|
-
quantity?: Quantity;
|
|
621
|
-
multiSelect?: Choices;
|
|
622
|
-
}
|
|
623
|
-
interface MediaItems {
|
|
624
|
-
mediaItems?: MediaItem[];
|
|
625
|
-
}
|
|
626
|
-
interface FeedbackItemChoice {
|
|
627
|
-
choiceId?: string;
|
|
628
|
-
}
|
|
629
|
-
interface Quantity {
|
|
630
|
-
unitName?: string;
|
|
631
|
-
amount?: number;
|
|
632
|
-
}
|
|
633
|
-
interface Choices {
|
|
634
|
-
choiceIds?: string[];
|
|
635
|
-
}
|
|
636
|
-
interface ChallengeStep {
|
|
637
|
-
_id?: string;
|
|
638
|
-
settings?: ChallengeStepSettings;
|
|
639
|
-
/**
|
|
640
|
-
* @format GUID
|
|
641
|
-
* @deprecated
|
|
642
|
-
*/
|
|
643
|
-
recurrenceSourceId?: string | null;
|
|
644
|
-
createdAt?: Date | null;
|
|
645
|
-
updatedAt?: Date | null;
|
|
646
|
-
/**
|
|
647
|
-
* @format GUID
|
|
648
|
-
* @readonly
|
|
649
|
-
*/
|
|
650
|
-
sectionId?: string | null;
|
|
651
|
-
}
|
|
652
|
-
interface GeneralSettings extends GeneralSettingsStepTypeOneOf {
|
|
653
|
-
individual?: IndividualSettings;
|
|
654
|
-
/** @deprecated */
|
|
655
|
-
group?: GroupSettings;
|
|
656
|
-
quiz?: QuizSettings;
|
|
657
|
-
video?: VideoStepSettings;
|
|
658
|
-
/** steps description: title, details, image and etc. */
|
|
659
|
-
description?: ObjectDescription;
|
|
660
|
-
duration?: TimeDuration;
|
|
661
|
-
/** @deprecated */
|
|
662
|
-
recurrenceSettings?: RecurrenceSettings;
|
|
663
|
-
}
|
|
664
|
-
/** @oneof */
|
|
665
|
-
interface GeneralSettingsStepTypeOneOf {
|
|
666
|
-
individual?: IndividualSettings;
|
|
667
|
-
/** @deprecated */
|
|
668
|
-
group?: GroupSettings;
|
|
669
|
-
quiz?: QuizSettings;
|
|
670
|
-
video?: VideoStepSettings;
|
|
671
|
-
}
|
|
672
|
-
interface ObjectDescription {
|
|
673
|
-
/** @maxLength 150 */
|
|
674
|
-
title?: string | null;
|
|
675
|
-
/** @maxLength 2000 */
|
|
676
|
-
details?: string | null;
|
|
677
|
-
media?: MediaItem;
|
|
678
|
-
}
|
|
679
|
-
interface IndividualSettings {
|
|
680
|
-
/** should be renamed, it's a flag whether the questionnaire section is enabled. */
|
|
681
|
-
confirmationRequired?: boolean;
|
|
682
|
-
/** feedback list settings. */
|
|
683
|
-
feedbackSettings?: FeedbackItemSettings[];
|
|
684
|
-
/** whether the quiz section in enabled. */
|
|
685
|
-
showQuiz?: boolean;
|
|
686
|
-
/** quiz list settings. */
|
|
687
|
-
quizSettings?: FeedbackItemSettings[];
|
|
688
|
-
}
|
|
689
|
-
interface FeedbackItemSettings {
|
|
690
|
-
_id?: string;
|
|
691
|
-
type?: FeedbackItemType;
|
|
692
|
-
question?: string;
|
|
693
|
-
isRequired?: boolean;
|
|
694
|
-
correctAnswerMessage?: string | null;
|
|
695
|
-
wrongAnswerMessage?: string | null;
|
|
696
|
-
}
|
|
697
|
-
interface NumericFeedbackItem {
|
|
698
|
-
/** @min 1 */
|
|
699
|
-
maxValue?: number;
|
|
700
|
-
}
|
|
701
|
-
interface TextFeedbackItem {
|
|
702
|
-
}
|
|
703
|
-
interface MediaFeedbackItem {
|
|
704
|
-
}
|
|
705
|
-
interface MultipleChoiceFeedbackItem {
|
|
706
|
-
choices?: Choice[];
|
|
707
|
-
}
|
|
708
|
-
declare enum ChoiceRightness {
|
|
709
|
-
NEUTRAL = "NEUTRAL",
|
|
710
|
-
RIGHT = "RIGHT",
|
|
711
|
-
WRONG = "WRONG"
|
|
712
|
-
}
|
|
713
|
-
/** @enumType */
|
|
714
|
-
type ChoiceRightnessWithLiterals = ChoiceRightness | 'NEUTRAL' | 'RIGHT' | 'WRONG';
|
|
715
|
-
interface Choice {
|
|
716
|
-
_id?: string;
|
|
717
|
-
description?: ObjectDescription;
|
|
718
|
-
rightness?: ChoiceRightnessWithLiterals;
|
|
719
|
-
}
|
|
720
|
-
interface QuantityFeedbackItem {
|
|
721
|
-
unitName?: string | null;
|
|
722
|
-
amount?: number;
|
|
723
|
-
}
|
|
724
|
-
interface FeedbackItemType extends FeedbackItemTypeTypeOneOf {
|
|
725
|
-
numeric?: NumericFeedbackItem;
|
|
726
|
-
text?: TextFeedbackItem;
|
|
727
|
-
media?: MediaFeedbackItem;
|
|
728
|
-
multipleChoice?: MultipleChoiceFeedbackItem;
|
|
729
|
-
quantity?: QuantityFeedbackItem;
|
|
730
|
-
multiSelect?: MultipleChoiceFeedbackItem;
|
|
731
|
-
}
|
|
732
|
-
/** @oneof */
|
|
733
|
-
interface FeedbackItemTypeTypeOneOf {
|
|
734
|
-
numeric?: NumericFeedbackItem;
|
|
735
|
-
text?: TextFeedbackItem;
|
|
736
|
-
media?: MediaFeedbackItem;
|
|
737
|
-
multipleChoice?: MultipleChoiceFeedbackItem;
|
|
738
|
-
quantity?: QuantityFeedbackItem;
|
|
739
|
-
multiSelect?: MultipleChoiceFeedbackItem;
|
|
740
|
-
}
|
|
741
|
-
interface GroupSettings {
|
|
742
|
-
completionCriteria?: CompletionCriteria;
|
|
743
|
-
}
|
|
744
|
-
interface CompletionCriteria {
|
|
745
|
-
completedSteps?: QuantityCriterion;
|
|
746
|
-
completedMilestones?: QuantityCriterion;
|
|
747
|
-
scoredPoints?: MinThreshold;
|
|
748
|
-
}
|
|
749
|
-
interface QuantityCriterion extends QuantityCriterionCriterionOneOf {
|
|
750
|
-
all?: All;
|
|
751
|
-
minThreshold?: MinThreshold;
|
|
752
|
-
}
|
|
753
|
-
/** @oneof */
|
|
754
|
-
interface QuantityCriterionCriterionOneOf {
|
|
755
|
-
all?: All;
|
|
756
|
-
minThreshold?: MinThreshold;
|
|
757
|
-
}
|
|
758
|
-
interface All {
|
|
759
|
-
}
|
|
760
|
-
interface MinThreshold {
|
|
761
|
-
/** @min 1 */
|
|
762
|
-
value?: number;
|
|
763
|
-
}
|
|
764
|
-
interface QuizSettings {
|
|
765
|
-
quizId?: string;
|
|
766
|
-
questionCount?: number;
|
|
767
|
-
passingGrade?: number | null;
|
|
768
|
-
migrationDetails?: QuizMigrationDetails;
|
|
769
|
-
}
|
|
770
|
-
declare enum QuizType {
|
|
771
|
-
QUIZ = "QUIZ",
|
|
772
|
-
QUESTIONNAIRE = "QUESTIONNAIRE"
|
|
773
|
-
}
|
|
774
|
-
/** @enumType */
|
|
775
|
-
type QuizTypeWithLiterals = QuizType | 'QUIZ' | 'QUESTIONNAIRE';
|
|
776
|
-
interface QuizMigrationDetails {
|
|
777
|
-
sourceStepId?: string;
|
|
778
|
-
show?: boolean;
|
|
779
|
-
quizType?: QuizTypeWithLiterals;
|
|
780
|
-
}
|
|
781
|
-
interface VideoStepSettings extends VideoStepSettingsVideoSourceOneOf {
|
|
782
|
-
wixVideo?: WixVideo;
|
|
783
|
-
video?: string;
|
|
784
|
-
requiredCompletionPercentage?: number;
|
|
785
|
-
coverImage?: string;
|
|
786
|
-
durationInMilliseconds?: number | null;
|
|
787
|
-
deleted?: boolean;
|
|
788
|
-
}
|
|
789
|
-
/** @oneof */
|
|
790
|
-
interface VideoStepSettingsVideoSourceOneOf {
|
|
791
|
-
wixVideo?: WixVideo;
|
|
792
|
-
video?: string;
|
|
793
|
-
}
|
|
794
|
-
interface WixVideo {
|
|
795
|
-
/** @format GUID */
|
|
796
|
-
_id?: string;
|
|
797
|
-
paid?: boolean;
|
|
798
|
-
}
|
|
799
|
-
interface VideoResolution {
|
|
800
|
-
/** Video URL. */
|
|
801
|
-
url?: string;
|
|
802
|
-
/** Video height. */
|
|
803
|
-
height?: number;
|
|
804
|
-
/** Video width. */
|
|
805
|
-
width?: number;
|
|
806
|
-
/** Video format for example, mp4, hls. */
|
|
807
|
-
format?: string;
|
|
808
|
-
}
|
|
809
|
-
interface TimeDuration {
|
|
810
|
-
unit?: DurationUnitWithLiterals;
|
|
811
|
-
value?: number;
|
|
812
|
-
}
|
|
813
|
-
declare enum DurationUnit {
|
|
814
|
-
WEEKS = "WEEKS",
|
|
815
|
-
DAYS = "DAYS",
|
|
816
|
-
HOURS = "HOURS",
|
|
817
|
-
MINUTES = "MINUTES"
|
|
818
|
-
}
|
|
819
|
-
/** @enumType */
|
|
820
|
-
type DurationUnitWithLiterals = DurationUnit | 'WEEKS' | 'DAYS' | 'HOURS' | 'MINUTES';
|
|
821
|
-
interface RecurrenceSettings {
|
|
822
|
-
schedules?: RecurrenceSchedule[];
|
|
823
|
-
/** @min 1 */
|
|
824
|
-
recurrencesCount?: number | null;
|
|
825
|
-
}
|
|
826
|
-
interface RecurrenceSchedule {
|
|
827
|
-
startDelay?: TimeDuration;
|
|
828
|
-
interval?: TimeDuration;
|
|
829
|
-
}
|
|
830
|
-
interface EmbeddingSettings {
|
|
831
|
-
/** step start delay. */
|
|
832
|
-
startConditions?: StartCondition[];
|
|
833
|
-
/** @deprecated */
|
|
834
|
-
isMilestone?: boolean;
|
|
835
|
-
/** @deprecated */
|
|
836
|
-
points?: number | null;
|
|
837
|
-
}
|
|
838
|
-
interface StartCondition {
|
|
839
|
-
/** whether the step should start on join. */
|
|
840
|
-
dependency?: StepDependency;
|
|
841
|
-
/** step delay regarding the challenge start. */
|
|
842
|
-
delay?: TimeDuration;
|
|
843
|
-
}
|
|
844
|
-
interface StepDependency extends StepDependencyDependencyTypeOneOf {
|
|
845
|
-
container?: Container;
|
|
846
|
-
/** @deprecated */
|
|
847
|
-
step?: Step;
|
|
848
|
-
}
|
|
849
|
-
/** @oneof */
|
|
850
|
-
interface StepDependencyDependencyTypeOneOf {
|
|
851
|
-
container?: Container;
|
|
852
|
-
/** @deprecated */
|
|
853
|
-
step?: Step;
|
|
854
|
-
}
|
|
855
|
-
interface Container {
|
|
856
|
-
}
|
|
857
|
-
interface Step {
|
|
858
|
-
stepId?: string;
|
|
859
|
-
}
|
|
860
|
-
interface ChallengeStepSettings {
|
|
861
|
-
general?: GeneralSettings;
|
|
862
|
-
embedding?: EmbeddingSettings;
|
|
863
|
-
}
|
|
864
|
-
interface Feedback {
|
|
865
|
-
items?: FeedbackItem[];
|
|
866
|
-
createdAt?: Date | null;
|
|
867
|
-
updatedAt?: Date | null;
|
|
868
|
-
quiz?: FeedbackItem[];
|
|
869
|
-
}
|
|
870
|
-
interface QuizSubmission {
|
|
871
|
-
quizSubmissionId?: string;
|
|
872
|
-
score?: number | null;
|
|
873
|
-
grade?: number | null;
|
|
874
|
-
rightAnswers?: number | null;
|
|
875
|
-
passingGrade?: number | null;
|
|
876
|
-
}
|
|
877
|
-
interface GetParticipantStepRequest {
|
|
878
|
-
/** @format GUID */
|
|
879
|
-
challengeId: string;
|
|
880
|
-
/** @format GUID */
|
|
881
|
-
participantId: string;
|
|
882
|
-
stepId: string;
|
|
883
|
-
timeInterval?: TimeInterval;
|
|
884
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
885
|
-
}
|
|
886
|
-
interface GetParticipantStepResponse {
|
|
887
|
-
step?: ParticipantStep;
|
|
888
|
-
subSteps?: ParticipantStep[];
|
|
889
|
-
}
|
|
890
|
-
interface ResolveParticipantStepRequest {
|
|
891
|
-
/** @format GUID */
|
|
892
|
-
challengeId: string;
|
|
893
|
-
/** @format GUID */
|
|
894
|
-
participantId: string;
|
|
895
|
-
stepId: string;
|
|
896
|
-
status?: ResolutionStatusWithLiterals;
|
|
897
|
-
feedback?: Feedback;
|
|
898
|
-
actionId?: string;
|
|
899
|
-
/** @format GUID */
|
|
900
|
-
quizSubmissionId?: string | null;
|
|
901
|
-
}
|
|
902
|
-
declare enum ResolutionStatus {
|
|
903
|
-
COMPLETED = "COMPLETED",
|
|
904
|
-
SKIPPED = "SKIPPED",
|
|
905
|
-
UNDO = "UNDO",
|
|
906
|
-
QUIZ_SUBMIT = "QUIZ_SUBMIT"
|
|
907
|
-
}
|
|
908
|
-
/** @enumType */
|
|
909
|
-
type ResolutionStatusWithLiterals = ResolutionStatus | 'COMPLETED' | 'SKIPPED' | 'UNDO' | 'QUIZ_SUBMIT';
|
|
910
|
-
interface ResolveParticipantStepResponse {
|
|
911
|
-
step?: ParticipantStep;
|
|
912
|
-
/** @format GUID */
|
|
913
|
-
actionId?: string;
|
|
914
|
-
}
|
|
915
|
-
interface StepResolved {
|
|
916
|
-
challengeId?: string;
|
|
917
|
-
participantId?: string;
|
|
918
|
-
memberId?: string;
|
|
919
|
-
stepTitle?: string;
|
|
920
|
-
participantStepId?: string;
|
|
921
|
-
challengeStepId?: string;
|
|
922
|
-
/** TODO why it is repeated? */
|
|
923
|
-
feedback?: Feedback[];
|
|
924
|
-
/** Title of the program. Used in Notifications */
|
|
925
|
-
programName?: string;
|
|
926
|
-
/**
|
|
927
|
-
* user id for program owner
|
|
928
|
-
* @format GUID
|
|
929
|
-
*/
|
|
930
|
-
ownerId?: string;
|
|
931
|
-
/**
|
|
932
|
-
* owner's contact id
|
|
933
|
-
* @format GUID
|
|
934
|
-
*/
|
|
935
|
-
ownerContactId?: string;
|
|
936
|
-
/**
|
|
937
|
-
* participants contact
|
|
938
|
-
* @format GUID
|
|
939
|
-
*/
|
|
940
|
-
participantContactId?: string;
|
|
941
|
-
/** info about quiz submission in that step */
|
|
942
|
-
quizSubmissionData?: QuizSubmissionData;
|
|
943
|
-
/** info about if participant completed step successfully or not */
|
|
944
|
-
status?: StatusWithLiterals;
|
|
945
|
-
}
|
|
946
|
-
interface QuizSubmissionData {
|
|
947
|
-
/** @format GUID */
|
|
948
|
-
submissionId?: string | null;
|
|
949
|
-
earnedScore?: number | null;
|
|
950
|
-
passingGrade?: number | null;
|
|
951
|
-
}
|
|
952
|
-
declare enum Status {
|
|
953
|
-
/** step completed */
|
|
954
|
-
COMPLETED = "COMPLETED",
|
|
955
|
-
/** participant failed to resolve step */
|
|
956
|
-
FAILED = "FAILED"
|
|
957
|
-
}
|
|
958
|
-
/** @enumType */
|
|
959
|
-
type StatusWithLiterals = Status | 'COMPLETED' | 'FAILED';
|
|
960
|
-
interface UpdateStepFeedbackRequest {
|
|
961
|
-
/** @format GUID */
|
|
962
|
-
challengeId: string;
|
|
963
|
-
/** @format GUID */
|
|
964
|
-
participantId: string;
|
|
965
|
-
stepId: string;
|
|
966
|
-
feedback?: Feedback;
|
|
967
|
-
/** @format GUID */
|
|
968
|
-
actionId?: string;
|
|
969
|
-
}
|
|
970
|
-
interface UpdateStepFeedbackResponse {
|
|
971
|
-
step?: ParticipantStep;
|
|
972
|
-
/** @format GUID */
|
|
973
|
-
actionId?: string;
|
|
974
|
-
}
|
|
975
|
-
interface GetMediaUploadInfoRequest {
|
|
976
|
-
/** @format GUID */
|
|
977
|
-
challengeId: string;
|
|
978
|
-
/** @format GUID */
|
|
979
|
-
participantId: string;
|
|
980
|
-
fileName?: string;
|
|
981
|
-
}
|
|
982
|
-
interface GetMediaUploadInfoResponse {
|
|
983
|
-
uploadUrl?: string;
|
|
984
|
-
uploadToken?: string;
|
|
985
|
-
}
|
|
986
|
-
interface ListParticipantSectionsRequest {
|
|
987
|
-
/** @format GUID */
|
|
988
|
-
challengeId: string;
|
|
989
|
-
/** @format GUID */
|
|
990
|
-
participantId: string;
|
|
991
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
992
|
-
}
|
|
993
|
-
interface ListParticipantSectionsResponse {
|
|
994
|
-
sections?: ParticipantSection[];
|
|
995
|
-
}
|
|
996
|
-
interface ParticipantSection {
|
|
997
|
-
_id?: string;
|
|
998
|
-
source?: ChallengeSection;
|
|
999
|
-
steps?: ParticipantStep[];
|
|
1000
|
-
transitions?: ParticipantSectionStateTransition[];
|
|
1001
|
-
progress?: Progress;
|
|
1002
|
-
}
|
|
1003
|
-
interface WaitingDate {
|
|
1004
|
-
startDate?: string;
|
|
1005
|
-
}
|
|
1006
|
-
interface WaitingDependency {
|
|
1007
|
-
sectionId?: string;
|
|
1008
|
-
}
|
|
1009
|
-
interface Running {
|
|
1010
|
-
dateInterval?: DateInterval;
|
|
1011
|
-
}
|
|
1012
|
-
interface Completed {
|
|
1013
|
-
}
|
|
1014
|
-
interface Overdue {
|
|
1015
|
-
}
|
|
1016
|
-
interface ChallengeSection {
|
|
1017
|
-
/** challenge section id. */
|
|
1018
|
-
_id?: string;
|
|
1019
|
-
/** challenge section settings. */
|
|
1020
|
-
settings?: Settings;
|
|
1021
|
-
createdAt?: Date | null;
|
|
1022
|
-
updatedAt?: Date | null;
|
|
1023
|
-
/** list of challenge steps laying inside the section. */
|
|
1024
|
-
steps?: ChallengeStep[];
|
|
1025
|
-
}
|
|
1026
|
-
interface Settings {
|
|
1027
|
-
/** section description(title, details, image...) */
|
|
1028
|
-
description?: ObjectDescription;
|
|
1029
|
-
/** condition for the section start. */
|
|
1030
|
-
startCondition?: StartCondition;
|
|
1031
|
-
}
|
|
1032
|
-
interface ParticipantSectionStateTransition extends ParticipantSectionStateTransitionStateOneOf {
|
|
1033
|
-
waitingDate?: WaitingDate;
|
|
1034
|
-
waitingDependency?: WaitingDependency;
|
|
1035
|
-
running?: Running;
|
|
1036
|
-
completed?: Completed;
|
|
1037
|
-
overdue?: Overdue;
|
|
1038
|
-
occurredAt?: Date | null;
|
|
1039
|
-
}
|
|
1040
|
-
/** @oneof */
|
|
1041
|
-
interface ParticipantSectionStateTransitionStateOneOf {
|
|
1042
|
-
waitingDate?: WaitingDate;
|
|
1043
|
-
waitingDependency?: WaitingDependency;
|
|
1044
|
-
running?: Running;
|
|
1045
|
-
completed?: Completed;
|
|
1046
|
-
overdue?: Overdue;
|
|
1047
|
-
}
|
|
1048
|
-
interface Progress {
|
|
1049
|
-
nTotalSteps?: string;
|
|
1050
|
-
nCompletedSteps?: string;
|
|
1051
|
-
}
|
|
1052
|
-
interface GetParticipantSectionRequest {
|
|
1053
|
-
/** @format GUID */
|
|
1054
|
-
challengeId: string;
|
|
1055
|
-
/** @format GUID */
|
|
1056
|
-
participantId: string;
|
|
1057
|
-
/** @format GUID */
|
|
1058
|
-
sectionId: string;
|
|
1059
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1060
|
-
}
|
|
1061
|
-
interface GetParticipantSectionResponse {
|
|
1062
|
-
section?: ParticipantSection;
|
|
1063
|
-
}
|
|
1064
574
|
interface MyProgramRequest {
|
|
1065
575
|
programId: string;
|
|
1066
576
|
}
|
|
1067
577
|
interface MyProgramResponse {
|
|
1068
578
|
participant?: Participant;
|
|
1069
579
|
}
|
|
1070
|
-
interface MyProgramStepRequest {
|
|
1071
|
-
programId: string;
|
|
1072
|
-
programStepId: string;
|
|
1073
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1074
|
-
}
|
|
1075
|
-
interface MyProgramStepResponse {
|
|
1076
|
-
participantStep?: ParticipantStep;
|
|
1077
|
-
}
|
|
1078
|
-
interface MyProgramSectionRequest {
|
|
1079
|
-
programId: string;
|
|
1080
|
-
programSectionId: string;
|
|
1081
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1082
|
-
}
|
|
1083
|
-
interface MyProgramSectionResponse {
|
|
1084
|
-
participantSection?: ParticipantSection;
|
|
1085
|
-
}
|
|
1086
580
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1087
581
|
createdEvent?: EntityCreatedEvent;
|
|
1088
582
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -1281,17 +775,6 @@ interface ParticipantJoinedEnvelope {
|
|
|
1281
775
|
* @slug participant_joined
|
|
1282
776
|
*/
|
|
1283
777
|
declare function onParticipantJoined(handler: (event: ParticipantJoinedEnvelope) => void | Promise<void>): void;
|
|
1284
|
-
interface ParticipantStepResolvedEnvelope {
|
|
1285
|
-
data: StepResolved;
|
|
1286
|
-
metadata: EventMetadata;
|
|
1287
|
-
}
|
|
1288
|
-
/** @permissionId PARTICIPANTS.PARTICIPANT_READ
|
|
1289
|
-
* @webhook
|
|
1290
|
-
* @eventType wix.challenges.v1.participant_step_resolved
|
|
1291
|
-
* @serviceIdentifier com.wixpress.achievements.api.v1.ParticipantsService
|
|
1292
|
-
* @slug step_resolved
|
|
1293
|
-
*/
|
|
1294
|
-
declare function onParticipantStepResolved(handler: (event: ParticipantStepResolvedEnvelope) => void | Promise<void>): void;
|
|
1295
778
|
/** @public
|
|
1296
779
|
* @requiredField challengeId
|
|
1297
780
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.QueryParticipants
|
|
@@ -1633,189 +1116,10 @@ interface RemoveCouponFromOrderOptions {
|
|
|
1633
1116
|
/** @format GUID */
|
|
1634
1117
|
actionId?: string;
|
|
1635
1118
|
}
|
|
1636
|
-
/** @public
|
|
1637
|
-
* @requiredField identifiers
|
|
1638
|
-
* @requiredField identifiers.challengeId
|
|
1639
|
-
* @requiredField identifiers.participantId
|
|
1640
|
-
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListSteps
|
|
1641
|
-
* @deprecated
|
|
1642
|
-
* @targetRemovalDate 2025-10-01
|
|
1643
|
-
*/
|
|
1644
|
-
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>>;
|
|
1645
|
-
interface ListStepsIdentifiers {
|
|
1646
|
-
/** @format GUID */
|
|
1647
|
-
challengeId: string;
|
|
1648
|
-
/** @format GUID */
|
|
1649
|
-
participantId: string;
|
|
1650
|
-
}
|
|
1651
|
-
interface ListStepsOptions {
|
|
1652
|
-
parentId?: string;
|
|
1653
|
-
timeInterval?: TimeInterval;
|
|
1654
|
-
dateInterval?: DateInterval;
|
|
1655
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1656
|
-
}
|
|
1657
|
-
/** @public
|
|
1658
|
-
* @requiredField identifiers
|
|
1659
|
-
* @requiredField identifiers.challengeId
|
|
1660
|
-
* @requiredField identifiers.participantId
|
|
1661
|
-
* @requiredField identifiers.stepId
|
|
1662
|
-
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetStep
|
|
1663
|
-
* @deprecated
|
|
1664
|
-
* @targetRemovalDate 2025-10-01
|
|
1665
|
-
*/
|
|
1666
|
-
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>>;
|
|
1667
|
-
interface GetStepIdentifiers {
|
|
1668
|
-
/** @format GUID */
|
|
1669
|
-
challengeId: string;
|
|
1670
|
-
/** @format GUID */
|
|
1671
|
-
participantId: string;
|
|
1672
|
-
stepId: string;
|
|
1673
|
-
}
|
|
1674
|
-
interface GetStepOptions {
|
|
1675
|
-
timeInterval?: TimeInterval;
|
|
1676
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1677
|
-
}
|
|
1678
|
-
/** @public
|
|
1679
|
-
* @requiredField identifiers
|
|
1680
|
-
* @requiredField identifiers.challengeId
|
|
1681
|
-
* @requiredField identifiers.participantId
|
|
1682
|
-
* @requiredField identifiers.stepId
|
|
1683
|
-
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.ResolveStep
|
|
1684
|
-
* @deprecated
|
|
1685
|
-
* @targetRemovalDate 2025-10-01
|
|
1686
|
-
*/
|
|
1687
|
-
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>>;
|
|
1688
|
-
interface ResolveStepIdentifiers {
|
|
1689
|
-
/** @format GUID */
|
|
1690
|
-
challengeId: string;
|
|
1691
|
-
/** @format GUID */
|
|
1692
|
-
participantId: string;
|
|
1693
|
-
stepId: string;
|
|
1694
|
-
}
|
|
1695
|
-
interface ResolveStepOptions {
|
|
1696
|
-
status?: ResolutionStatusWithLiterals;
|
|
1697
|
-
feedback?: Feedback;
|
|
1698
|
-
actionId?: string;
|
|
1699
|
-
/** @format GUID */
|
|
1700
|
-
quizSubmissionId?: string | null;
|
|
1701
|
-
}
|
|
1702
|
-
/** @public
|
|
1703
|
-
* @requiredField identifiers
|
|
1704
|
-
* @requiredField identifiers.challengeId
|
|
1705
|
-
* @requiredField identifiers.participantId
|
|
1706
|
-
* @requiredField identifiers.stepId
|
|
1707
|
-
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.UpdateStepFeedback
|
|
1708
|
-
* @deprecated
|
|
1709
|
-
* @targetRemovalDate 2025-10-01
|
|
1710
|
-
*/
|
|
1711
|
-
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>>;
|
|
1712
|
-
interface UpdateStepFeedbackIdentifiers {
|
|
1713
|
-
/** @format GUID */
|
|
1714
|
-
challengeId: string;
|
|
1715
|
-
/** @format GUID */
|
|
1716
|
-
participantId: string;
|
|
1717
|
-
stepId: string;
|
|
1718
|
-
}
|
|
1719
|
-
interface UpdateStepFeedbackOptions {
|
|
1720
|
-
feedback?: Feedback;
|
|
1721
|
-
/** @format GUID */
|
|
1722
|
-
actionId?: string;
|
|
1723
|
-
}
|
|
1724
|
-
/** @public
|
|
1725
|
-
* @requiredField identifiers
|
|
1726
|
-
* @requiredField identifiers.challengeId
|
|
1727
|
-
* @requiredField identifiers.participantId
|
|
1728
|
-
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetMediaUploadInfo
|
|
1729
|
-
* @deprecated
|
|
1730
|
-
* @targetRemovalDate 2025-10-01
|
|
1731
|
-
*/
|
|
1732
|
-
declare function getMediaUploadInfo(identifiers: NonNullablePaths<GetMediaUploadInfoIdentifiers, `challengeId` | `participantId`, 2>, options?: GetMediaUploadInfoOptions): Promise<NonNullablePaths<GetMediaUploadInfoResponse, `uploadUrl` | `uploadToken`, 2>>;
|
|
1733
|
-
interface GetMediaUploadInfoIdentifiers {
|
|
1734
|
-
/** @format GUID */
|
|
1735
|
-
challengeId: string;
|
|
1736
|
-
/** @format GUID */
|
|
1737
|
-
participantId: string;
|
|
1738
|
-
}
|
|
1739
|
-
interface GetMediaUploadInfoOptions {
|
|
1740
|
-
fileName?: string;
|
|
1741
|
-
}
|
|
1742
|
-
/**
|
|
1743
|
-
* ---------------------------------------------------- Sections --------------------------------------------------------
|
|
1744
|
-
* @public
|
|
1745
|
-
* @requiredField identifiers
|
|
1746
|
-
* @requiredField identifiers.challengeId
|
|
1747
|
-
* @requiredField identifiers.participantId
|
|
1748
|
-
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListSections
|
|
1749
|
-
* @deprecated
|
|
1750
|
-
* @targetRemovalDate 2025-10-01
|
|
1751
|
-
*/
|
|
1752
|
-
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>>;
|
|
1753
|
-
interface ListSectionsIdentifiers {
|
|
1754
|
-
/** @format GUID */
|
|
1755
|
-
challengeId: string;
|
|
1756
|
-
/** @format GUID */
|
|
1757
|
-
participantId: string;
|
|
1758
|
-
}
|
|
1759
|
-
interface ListSectionsOptions {
|
|
1760
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1761
|
-
}
|
|
1762
|
-
/** @public
|
|
1763
|
-
* @requiredField identifiers
|
|
1764
|
-
* @requiredField identifiers.challengeId
|
|
1765
|
-
* @requiredField identifiers.participantId
|
|
1766
|
-
* @requiredField identifiers.sectionId
|
|
1767
|
-
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetSection
|
|
1768
|
-
* @deprecated
|
|
1769
|
-
* @targetRemovalDate 2025-10-01
|
|
1770
|
-
*/
|
|
1771
|
-
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>>;
|
|
1772
|
-
interface GetSectionIdentifiers {
|
|
1773
|
-
/** @format GUID */
|
|
1774
|
-
challengeId: string;
|
|
1775
|
-
/** @format GUID */
|
|
1776
|
-
participantId: string;
|
|
1777
|
-
/** @format GUID */
|
|
1778
|
-
sectionId: string;
|
|
1779
|
-
}
|
|
1780
|
-
interface GetSectionOptions {
|
|
1781
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1782
|
-
}
|
|
1783
1119
|
/** @public
|
|
1784
1120
|
* @requiredField programId
|
|
1785
1121
|
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgram
|
|
1786
1122
|
*/
|
|
1787
1123
|
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>>;
|
|
1788
|
-
/** @public
|
|
1789
|
-
* @requiredField identifiers
|
|
1790
|
-
* @requiredField identifiers.programId
|
|
1791
|
-
* @requiredField identifiers.programStepId
|
|
1792
|
-
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgramStep
|
|
1793
|
-
* @deprecated
|
|
1794
|
-
* @targetRemovalDate 2025-10-01
|
|
1795
|
-
*/
|
|
1796
|
-
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>>;
|
|
1797
|
-
interface MyProgramStepIdentifiers {
|
|
1798
|
-
programId: string;
|
|
1799
|
-
programStepId: string;
|
|
1800
|
-
}
|
|
1801
|
-
interface MyProgramStepOptions {
|
|
1802
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1803
|
-
}
|
|
1804
|
-
/** @public
|
|
1805
|
-
* @requiredField identifiers
|
|
1806
|
-
* @requiredField identifiers.programId
|
|
1807
|
-
* @requiredField identifiers.programSectionId
|
|
1808
|
-
* @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgramSection
|
|
1809
|
-
* @deprecated
|
|
1810
|
-
* @targetRemovalDate 2025-10-01
|
|
1811
|
-
*/
|
|
1812
|
-
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>>;
|
|
1813
|
-
interface MyProgramSectionIdentifiers {
|
|
1814
|
-
programId: string;
|
|
1815
|
-
programSectionId: string;
|
|
1816
|
-
}
|
|
1817
|
-
interface MyProgramSectionOptions {
|
|
1818
|
-
descriptionFieldSet?: DescriptionFieldSetWithLiterals;
|
|
1819
|
-
}
|
|
1820
1124
|
|
|
1821
|
-
export { type ActionEvent, type AddAllParticipantOptions, type AddAllParticipantRequest, type AddAllParticipantResponse, type AddParticipantOptions, type AddParticipantRequest, type AddParticipantResponse, type AddParticipantsOptions, type AddParticipantsRequest, type AddParticipantsResponse, type Added, type
|
|
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 };
|