@wix/auto_sdk_online-programs_online-program-participants 1.0.3 → 1.0.5

package/build/cjs/meta.d.ts

@@ -623,13 +623,23 @@ interface RemoveCouponFromOrderResponse {
     total?: string;
 }
 interface ListParticipantStepsRequest {
-    /** @format GUID */
+    /**
+     * Challenge/Program (tenant) ID. GUID.
+     * @format GUID
+     */
     challengeId: string;
-    /** @format GUID */
+    /**
+     * Participant entity ID within the challenge. GUID.
+     * @format GUID
+     */
     participantId: string;
+    /** Optional parent step ID to scope to sub-steps. */
     parentId?: string;
+    /** Optional absolute time window for time-based progress. */
     timeInterval?: TimeInterval;
+    /** Optional local date window for date-based progress. */
     dateInterval?: DateInterval;
+    /** Controls verbose description fields in response. */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
 }
 declare enum DescriptionFieldSet {
@@ -641,6 +651,7 @@ declare enum DescriptionFieldSet {
 /** @enumType */
 type DescriptionFieldSetWithLiterals = DescriptionFieldSet | 'EXTENDED' | 'STANDARD';
 interface ListParticipantStepsResponse {
+    /** Participant steps matching the query. */
     steps?: ParticipantStep[];
 }
 interface ParticipantStep {
@@ -941,28 +952,52 @@ interface QuizSubmission {
     passingGrade?: number | null;
 }
 interface GetParticipantStepRequest {
-    /** @format GUID */
+    /**
+     * Challenge/Program (tenant) ID. GUID.
+     * @format GUID
+     */
     challengeId: string;
-    /** @format GUID */
+    /**
+     * Participant entity ID. GUID.
+     * @format GUID
+     */
     participantId: string;
+    /** Step ID (program step or resolved instance). */
     stepId: string;
+    /** Optional absolute time window for time-based progress. */
     timeInterval?: TimeInterval;
+    /** Controls verbose description fields in response. */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
 }
 interface GetParticipantStepResponse {
+    /** Requested participant step details. */
     step?: ParticipantStep;
+    /** Immediate sub-steps for hierarchical steps (if any). */
     subSteps?: ParticipantStep[];
 }
 interface ResolveParticipantStepRequest {
-    /** @format GUID */
+    /**
+     * Challenge/Program (tenant) ID. GUID.
+     * @format GUID
+     */
     challengeId: string;
-    /** @format GUID */
+    /**
+     * Participant entity ID. GUID.
+     * @format GUID
+     */
     participantId: string;
+    /** Target step ID to resolve. */
     stepId: string;
+    /** Resolution action to apply. */
     status?: ResolutionStatusWithLiterals;
+    /** Optional instructor feedback payload. */
     feedback?: Feedback;
+    /** Optional idempotency key for action tracking. */
     actionId?: string;
-    /** @format GUID */
+    /**
+     * Optional quiz submission to attach. GUID.
+     * @format GUID
+     */
     quizSubmissionId?: string | null;
 }
 declare enum ResolutionStatus {
@@ -974,8 +1009,12 @@ declare enum ResolutionStatus {
 /** @enumType */
 type ResolutionStatusWithLiterals = ResolutionStatus | 'COMPLETED' | 'SKIPPED' | 'UNDO' | 'QUIZ_SUBMIT';
 interface ResolveParticipantStepResponse {
+    /** Updated participant step after resolution. */
     step?: ParticipantStep;
-    /** @format GUID */
+    /**
+     * Server-generated action id. GUID.
+     * @format GUID
+     */
     actionId?: string;
 }
 interface StepResolved {
@@ -1024,39 +1063,71 @@ declare enum Status {
 /** @enumType */
 type StatusWithLiterals = Status | 'COMPLETED' | 'FAILED';
 interface UpdateStepFeedbackRequest {
-    /** @format GUID */
+    /**
+     * Challenge/Program (tenant) ID. GUID.
+     * @format GUID
+     */
     challengeId: string;
-    /** @format GUID */
+    /**
+     * Participant entity ID. GUID.
+     * @format GUID
+     */
     participantId: string;
+    /** Target step ID to update feedback for. */
     stepId: string;
+    /** New feedback payload. */
     feedback?: Feedback;
-    /** @format GUID */
+    /**
+     * Idempotency key for feedback update. GUID.
+     * @format GUID
+     */
     actionId?: string;
 }
 interface UpdateStepFeedbackResponse {
+    /** Participant step with updated feedback. */
     step?: ParticipantStep;
-    /** @format GUID */
+    /**
+     * Server-generated action id. GUID.
+     * @format GUID
+     */
     actionId?: string;
 }
 interface GetMediaUploadInfoRequest {
-    /** @format GUID */
+    /**
+     * Challenge/Program (tenant) ID. GUID.
+     * @format GUID
+     */
     challengeId: string;
-    /** @format GUID */
+    /**
+     * Participant entity ID. GUID.
+     * @format GUID
+     */
     participantId: string;
+    /** Original filename to derive content-type and path. */
     fileName?: string;
 }
 interface GetMediaUploadInfoResponse {
+    /** Pre-signed URL to upload media. */
     uploadUrl?: string;
+    /** Token required by media service for upload. */
     uploadToken?: string;
 }
 interface ListParticipantSectionsRequest {
-    /** @format GUID */
+    /**
+     * Challenge/Program (tenant) ID. GUID.
+     * @format GUID
+     */
     challengeId: string;
-    /** @format GUID */
+    /**
+     * Participant entity ID. GUID.
+     * @format GUID
+     */
     participantId: string;
+    /** Controls verbose description fields in response. */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
 }
 interface ListParticipantSectionsResponse {
+    /** Participant sections for the program. */
     sections?: ParticipantSection[];
 }
 interface ParticipantSection {
@@ -1116,15 +1187,26 @@ interface Progress {
     nCompletedSteps?: string;
 }
 interface GetParticipantSectionRequest {
-    /** @format GUID */
+    /**
+     * Challenge/Program (tenant) ID. GUID.
+     * @format GUID
+     */
     challengeId: string;
-    /** @format GUID */
+    /**
+     * Participant entity ID. GUID.
+     * @format GUID
+     */
     participantId: string;
-    /** @format GUID */
+    /**
+     * Section ID to fetch. GUID.
+     * @format GUID
+     */
     sectionId: string;
+    /** Controls verbose description fields in response. */
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
 }
 interface GetParticipantSectionResponse {
+    /** Requested participant section details. */
     section?: ParticipantSection;
 }
 interface MyProgramRequest {
@@ -1139,6 +1221,7 @@ interface MyProgramStepRequest {
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
 }
 interface MyProgramStepResponse {
+    /** Viewer's participant step derived for the program step. */
     participantStep?: ParticipantStep;
 }
 interface MyProgramSectionRequest {
@@ -1147,6 +1230,7 @@ interface MyProgramSectionRequest {
     descriptionFieldSet?: DescriptionFieldSetWithLiterals;
 }
 interface MyProgramSectionResponse {
+    /** Viewer's participant section derived for the program section. */
     participantSection?: ParticipantSection;
 }
 interface DomainEvent extends DomainEventBodyOneOf {