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

package/build/internal/cjs/index.typings.d.ts

@@ -1638,6 +1638,8 @@ interface RemoveCouponFromOrderOptions {
  * @requiredField identifiers.challengeId
  * @requiredField identifiers.participantId
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListSteps
+ * @deprecated
+ * @targetRemovalDate 2025-10-01
  */
 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>>;
 interface ListStepsIdentifiers {
@@ -1658,6 +1660,8 @@ interface ListStepsOptions {
  * @requiredField identifiers.participantId
  * @requiredField identifiers.stepId
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetStep
+ * @deprecated
+ * @targetRemovalDate 2025-10-01
  */
 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>>;
 interface GetStepIdentifiers {
@@ -1677,6 +1681,8 @@ interface GetStepOptions {
  * @requiredField identifiers.participantId
  * @requiredField identifiers.stepId
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ResolveStep
+ * @deprecated
+ * @targetRemovalDate 2025-10-01
  */
 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>>;
 interface ResolveStepIdentifiers {
@@ -1699,6 +1705,8 @@ interface ResolveStepOptions {
  * @requiredField identifiers.participantId
  * @requiredField identifiers.stepId
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.UpdateStepFeedback
+ * @deprecated
+ * @targetRemovalDate 2025-10-01
  */
 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>>;
 interface UpdateStepFeedbackIdentifiers {
@@ -1718,6 +1726,8 @@ interface UpdateStepFeedbackOptions {
  * @requiredField identifiers.challengeId
  * @requiredField identifiers.participantId
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetMediaUploadInfo
+ * @deprecated
+ * @targetRemovalDate 2025-10-01
  */
 declare function getMediaUploadInfo(identifiers: NonNullablePaths<GetMediaUploadInfoIdentifiers, `challengeId` | `participantId`, 2>, options?: GetMediaUploadInfoOptions): Promise<NonNullablePaths<GetMediaUploadInfoResponse, `uploadUrl` | `uploadToken`, 2>>;
 interface GetMediaUploadInfoIdentifiers {
@@ -1736,6 +1746,8 @@ interface GetMediaUploadInfoOptions {
  * @requiredField identifiers.challengeId
  * @requiredField identifiers.participantId
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListSections
+ * @deprecated
+ * @targetRemovalDate 2025-10-01
  */
 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>>;
 interface ListSectionsIdentifiers {
@@ -1753,6 +1765,8 @@ interface ListSectionsOptions {
  * @requiredField identifiers.participantId
  * @requiredField identifiers.sectionId
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetSection
+ * @deprecated
+ * @targetRemovalDate 2025-10-01
  */
 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>>;
 interface GetSectionIdentifiers {
@@ -1776,6 +1790,8 @@ declare function myProgram(programId: string): Promise<NonNullablePaths<MyProgra
  * @requiredField identifiers.programId
  * @requiredField identifiers.programStepId
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgramStep
+ * @deprecated
+ * @targetRemovalDate 2025-10-01
  */
 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>>;
 interface MyProgramStepIdentifiers {
@@ -1790,6 +1806,8 @@ interface MyProgramStepOptions {
  * @requiredField identifiers.programId
  * @requiredField identifiers.programSectionId
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgramSection
+ * @deprecated
+ * @targetRemovalDate 2025-10-01
  */
 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>>;
 interface MyProgramSectionIdentifiers {