@wix/online-programs 1.0.0

package/build/es/src/challenges-v1-participant.universal.d.ts

@@ -0,0 +1,714 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface Participant {
+    _id?: string;
+    member?: Member;
+    challenge?: EntitySummary;
+    timeFrame?: TimeInterval;
+    stepsSummary?: StepsSummary;
+    orderIds?: string[];
+    transitions?: StateTransition[];
+    timezone?: string;
+    dateFrame?: DateInterval;
+    socialGroupId?: string | null;
+    performance?: number;
+    joinPath?: JoinPath;
+}
+export interface StepEvent {
+    stepId?: string;
+    transition?: ParticipantStepStateTransition;
+}
+export interface ParticipantStepStateTransition {
+    state?: ParticipantStepState;
+    occurredAt?: Date;
+}
+export declare enum ParticipantStepState {
+    PENDING = "PENDING",
+    RUNNING = "RUNNING",
+    COMPLETED = "COMPLETED",
+    SKIPPED = "SKIPPED",
+    CONFIRMED = "CONFIRMED",
+    REJECTED = "REJECTED",
+    OVERDUE = "OVERDUE",
+    FAILED = "FAILED"
+}
+export declare enum State {
+    JOIN_REQUESTED = "JOIN_REQUESTED",
+    INVITED = "INVITED",
+    JOIN_REJECTED = "JOIN_REJECTED",
+    PAYMENT_REQUESTED = "PAYMENT_REQUESTED",
+    PAYMENT_STARTED = "PAYMENT_STARTED",
+    JOINED = "JOINED",
+    LEFT = "LEFT",
+    REMOVED = "REMOVED",
+    RUNNING = "RUNNING",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    PAYMENT_STARTED_OFFLINE = "PAYMENT_STARTED_OFFLINE",
+    SUSPENDED = "SUSPENDED"
+}
+export interface Free {
+}
+export interface Added {
+}
+export interface SinglePayment {
+    orderId?: string;
+}
+export interface PaidPlan {
+    planIds?: string[];
+}
+export interface Member {
+    _id?: string;
+    fullName?: string;
+    imageUrl?: string | null;
+    contactId?: string | null;
+    userId?: string | null;
+}
+export interface EntitySummary {
+    _id?: string;
+    title?: string | null;
+    media?: MediaItem;
+}
+/** Deprecated - Copy this message into your service, do not reference it */
+export interface MediaItem extends MediaItemMediaOneOf {
+    /** WixMedia image */
+    image?: string;
+    /** WixMedia video */
+    video?: string;
+    /** WixMedia document */
+    document?: string;
+}
+/** @oneof */
+export interface MediaItemMediaOneOf {
+    /** WixMedia image */
+    image?: string;
+    /** WixMedia video */
+    video?: string;
+    /** WixMedia document */
+    document?: string;
+}
+export interface TimeInterval {
+    start?: Date;
+    finish?: Date;
+}
+export interface StepsSummary {
+    stepsNumber?: number;
+    completedStepsNumber?: number;
+    failedStepsNumber?: number;
+    postedFeedbacksNumber?: number;
+    lastEvent?: StepEvent;
+}
+export interface StateTransition {
+    state?: State;
+    occurredAt?: Date;
+    offlineTrxId?: string | null;
+}
+export interface DateInterval {
+    start?: string;
+    finish?: string | null;
+}
+export interface JoinPath extends JoinPathPathOneOf {
+    free?: Free;
+    added?: Added;
+    singlePayment?: SinglePayment;
+    paidPlan?: PaidPlan;
+}
+/** @oneof */
+export interface JoinPathPathOneOf {
+    free?: Free;
+    added?: Added;
+    singlePayment?: SinglePayment;
+    paidPlan?: PaidPlan;
+}
+export interface QueryParticipantsRequest {
+    paging?: Paging;
+    challengeId?: string;
+    sorting?: QueryParticipantsRequestSorting;
+    filter?: ParticipantsFilter;
+}
+export interface ParticipantJoinDate {
+    start?: string | null;
+    end?: string | null;
+}
+export declare enum ParticipationState {
+    NotStarted = "NotStarted",
+    InProgress = "InProgress",
+    Finished = "Finished",
+    Suspended = "Suspended"
+}
+export interface ParticipantPerformance {
+    start?: number | null;
+    end?: number | null;
+}
+export declare enum QueryParticipantsRequestJoinPath {
+    UNKNOWN_JOIN_PATH = "UNKNOWN_JOIN_PATH",
+    FREE = "FREE",
+    ADDED = "ADDED",
+    SINGLE_PAYMENT = "SINGLE_PAYMENT",
+    PAID_PLAN = "PAID_PLAN"
+}
+export declare enum QueryParticipantsRequestSortingCriterion {
+    DEFAULT = "DEFAULT",
+    JOIN_DATE = "JOIN_DATE",
+    NAME = "NAME",
+    LAST_EVENT = "LAST_EVENT",
+    PERFORMANCE = "PERFORMANCE"
+}
+export declare enum QueryParticipantsRequestSortingOrder {
+    ORDER_DEFAULT = "ORDER_DEFAULT",
+    ORDER_ASC = "ORDER_ASC",
+    ORDER_DESC = "ORDER_DESC"
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface QueryParticipantsRequestSorting {
+    criterion?: QueryParticipantsRequestSortingCriterion;
+    order?: QueryParticipantsRequestSortingOrder;
+}
+export interface ParticipantsFilter {
+    memberIds?: string[] | null;
+    memberName?: string | null;
+    states?: State[];
+    joinedAt?: ParticipantJoinDate;
+    participationStates?: ParticipationState[];
+    performance?: ParticipantPerformance[];
+    joinPath?: QueryParticipantsRequestJoinPath;
+}
+export interface QueryParticipantsResponse {
+    totalCount?: number;
+    participants?: Participant[];
+}
+export interface ListParticipantsRequest {
+    paging?: Paging;
+    challengeId?: string;
+    memberId?: string | null;
+    states?: State[];
+    memberIds?: string[] | null;
+    sortingCriterion?: SortingCriterion;
+    memberName?: string | null;
+    sorting?: Sorting;
+}
+export declare enum SortingCriterion {
+    DEFAULT = "DEFAULT",
+    JOIN_DATE = "JOIN_DATE",
+    NAME = "NAME",
+    LAST_EVENT = "LAST_EVENT",
+    PERFORMANCE = "PERFORMANCE"
+}
+export declare enum SortingOrder {
+    ORDER_DEFAULT = "ORDER_DEFAULT",
+    ORDER_ASC = "ORDER_ASC",
+    ORDER_DESC = "ORDER_DESC"
+}
+export interface Sorting {
+    criterion?: SortingCriterion;
+    order?: SortingOrder;
+}
+export interface ListParticipantsResponse {
+    totalCount?: number;
+    participants?: Participant[];
+}
+export interface JoinParticipantRequest {
+    challengeId?: string;
+    memberId?: string;
+    timeZone?: string;
+    actionId?: string;
+    startDate?: string | null;
+}
+export interface JoinParticipantResponse {
+    participantId?: string;
+    actionId?: string;
+    participant?: Participant;
+}
+export interface ParticipantJoined {
+    participant?: Participant;
+}
+/** Add participant */
+export interface AddParticipantRequest {
+    challengeId: string;
+    memberId?: string;
+    actionId?: string;
+}
+export interface AddParticipantResponse {
+    participant?: Participant;
+    actionId?: string;
+}
+export interface CreateJoinRequestRequest {
+    challengeId?: string;
+    memberId?: string;
+    timeZone?: string;
+    actionId?: string;
+    startDate?: string | null;
+}
+export interface CreateJoinRequestResponse {
+    participantId?: string;
+    approvalRequestId?: string;
+    actionId?: string;
+    participant?: Participant;
+}
+export interface InviteParticipantsRequest {
+    challengeId?: string;
+    memberIds?: string[];
+    actionId?: string;
+}
+export interface InviteParticipantsResponse {
+    invitations?: InvitationDetails[];
+    actionId?: string;
+}
+export interface InvitationDetails {
+    participantId?: string;
+    approvalRequestId?: string;
+}
+export interface GetParticipantRequest {
+    challengeId?: string;
+    participantId?: string;
+}
+export interface GetParticipantResponse {
+    participant?: Participant;
+}
+export interface UpdateParticipantRequest extends UpdateParticipantRequestUpdateOneOf {
+    challengeId?: string;
+    participantId?: string;
+    actionId?: string;
+    startDate?: string;
+}
+/** @oneof */
+export interface UpdateParticipantRequestUpdateOneOf {
+    startDate?: string;
+}
+export interface UpdateParticipantResponse {
+    participant?: Participant;
+    actionId?: string;
+}
+export interface DeleteParticipantRequest {
+    challengeId?: string;
+    participantId?: string;
+    actionId?: string;
+}
+export interface DeleteParticipantResponse {
+    actionId?: string;
+}
+export interface ReviveParticipantRequest {
+    challengeId?: string;
+    participantId?: string;
+    actionId?: string;
+}
+export interface ReviveParticipantResponse {
+    participant?: Participant;
+    actionId?: string;
+}
+export interface ResetParticipantProgressRequest {
+    challengeId?: string;
+    participantId?: string;
+    timeZone?: string;
+    startDate?: string | null;
+    actionId?: string;
+}
+export interface ResetParticipantProgressResponse {
+    participant?: Participant;
+    actionId?: string;
+}
+export interface CreatePaymentOrderRequest {
+    challengeId?: string;
+    participantId?: string;
+    actionId?: string;
+    timeZone?: string | null;
+    startDate?: string | null;
+    paymentType?: PaymentType;
+}
+export declare enum PaymentType {
+    SINGLE_PAYMENT = "SINGLE_PAYMENT",
+    PAID_PLANS = "PAID_PLANS"
+}
+export interface CreatePaymentOrderResponse {
+    orderId?: string;
+    actionId?: string;
+    participant?: Participant;
+}
+export interface ListParticipantStepsRequest {
+    challengeId?: string;
+    participantId?: string;
+    parentId?: string;
+    timeInterval?: TimeInterval;
+    dateInterval?: DateInterval;
+}
+export interface ListParticipantStepsResponse {
+    steps?: ParticipantStep[];
+}
+export interface ParticipantStep {
+    _id?: string;
+    source?: ChallengeStep;
+    timeFrame?: TimeInterval;
+    feedback?: Feedback;
+    transitions?: ParticipantStepStateTransition[];
+    dateFrame?: DateInterval;
+    quizSubmission?: QuizSubmission;
+}
+export interface FeedbackItem extends FeedbackItemValueOneOf {
+    feedbackItemSettingsId?: string;
+    number?: number | null;
+    text?: string | null;
+    media?: MediaItems;
+    choice?: FeedbackItemChoice;
+    quantity?: Quantity;
+    multiSelect?: Choices;
+}
+/** @oneof */
+export interface FeedbackItemValueOneOf {
+    number?: number | null;
+    text?: string | null;
+    media?: MediaItems;
+    choice?: FeedbackItemChoice;
+    quantity?: Quantity;
+    multiSelect?: Choices;
+}
+export interface MediaItems {
+    mediaItems?: MediaItem[];
+}
+export interface FeedbackItemChoice {
+    choiceId?: string;
+}
+export interface Quantity {
+    unitName?: string;
+    amount?: number;
+}
+export interface Choices {
+    choiceIds?: string[];
+}
+export interface ChallengeStep {
+    _id?: string;
+    settings?: ChallengeStepSettings;
+    recurrenceSourceId?: string | null;
+    createdAt?: Date;
+    updatedAt?: Date;
+    /** @readonly */
+    sectionId?: string | null;
+}
+export interface GeneralSettings extends GeneralSettingsStepTypeOneOf {
+    /** steps description: title, details, image and etc. */
+    description?: ObjectDescription;
+    duration?: TimeDuration;
+    recurrenceSettings?: RecurrenceSettings;
+    individual?: IndividualSettings;
+    group?: GroupSettings;
+    quiz?: QuizSettings;
+}
+/** @oneof */
+export interface GeneralSettingsStepTypeOneOf {
+    individual?: IndividualSettings;
+    group?: GroupSettings;
+    quiz?: QuizSettings;
+}
+export interface ObjectDescription {
+    title?: string | null;
+    details?: string | null;
+    media?: MediaItem;
+}
+export interface IndividualSettings {
+    /** should be renamed, it's a flag whether the questionnaire section is enabled. */
+    confirmationRequired?: boolean;
+    /** feedback list settings. */
+    feedbackSettings?: FeedbackItemSettings[];
+    /** whether the quiz section in enabled. */
+    showQuiz?: boolean;
+    /** quiz list settings. */
+    quizSettings?: FeedbackItemSettings[];
+}
+export interface FeedbackItemSettings {
+    _id?: string;
+    type?: FeedbackItemType;
+    question?: string;
+    isRequired?: boolean;
+    correctAnswerMessage?: string | null;
+    wrongAnswerMessage?: string | null;
+}
+export interface NumericFeedbackItem {
+    maxValue?: number;
+}
+export interface TextFeedbackItem {
+}
+export interface MediaFeedbackItem {
+}
+export interface MultipleChoiceFeedbackItem {
+    choices?: Choice[];
+}
+export declare enum ChoiceRightness {
+    NEUTRAL = "NEUTRAL",
+    RIGHT = "RIGHT",
+    WRONG = "WRONG"
+}
+export interface Choice {
+    _id?: string;
+    description?: ObjectDescription;
+    rightness?: ChoiceRightness;
+}
+export interface QuantityFeedbackItem {
+    unitName?: string | null;
+    amount?: number;
+}
+export interface FeedbackItemType extends FeedbackItemTypeTypeOneOf {
+    numeric?: NumericFeedbackItem;
+    text?: TextFeedbackItem;
+    media?: MediaFeedbackItem;
+    multipleChoice?: MultipleChoiceFeedbackItem;
+    quantity?: QuantityFeedbackItem;
+    multiSelect?: MultipleChoiceFeedbackItem;
+}
+/** @oneof */
+export interface FeedbackItemTypeTypeOneOf {
+    numeric?: NumericFeedbackItem;
+    text?: TextFeedbackItem;
+    media?: MediaFeedbackItem;
+    multipleChoice?: MultipleChoiceFeedbackItem;
+    quantity?: QuantityFeedbackItem;
+    multiSelect?: MultipleChoiceFeedbackItem;
+}
+export interface GroupSettings {
+    completionCriteria?: CompletionCriteria;
+}
+export interface CompletionCriteria {
+    completedSteps?: QuantityCriterion;
+    completedMilestones?: QuantityCriterion;
+    scoredPoints?: MinThreshold;
+}
+export interface QuantityCriterion extends QuantityCriterionCriterionOneOf {
+    all?: All;
+    minThreshold?: MinThreshold;
+}
+/** @oneof */
+export interface QuantityCriterionCriterionOneOf {
+    all?: All;
+    minThreshold?: MinThreshold;
+}
+export interface All {
+}
+export interface MinThreshold {
+    value?: number;
+}
+export interface QuizSettings {
+    quizId?: string;
+}
+export interface TimeDuration {
+    unit?: DurationUnit;
+    value?: number;
+}
+export declare enum DurationUnit {
+    WEEKS = "WEEKS",
+    DAYS = "DAYS",
+    HOURS = "HOURS",
+    MINUTES = "MINUTES"
+}
+export interface RecurrenceSettings {
+    schedules?: RecurrenceSchedule[];
+    recurrencesCount?: number | null;
+}
+export interface RecurrenceSchedule {
+    startDelay?: TimeDuration;
+    interval?: TimeDuration;
+}
+export interface EmbeddingSettings {
+    /** step start delay. */
+    startConditions?: StartCondition[];
+    isMilestone?: boolean;
+    points?: number | null;
+}
+export interface StartCondition {
+    /** whether the step should start on join. */
+    dependency?: StepDependency;
+    /** step delay regarding the challenge start. */
+    delay?: TimeDuration;
+}
+export interface StepDependency extends StepDependencyDependencyTypeOneOf {
+    container?: Container;
+    step?: Step;
+}
+/** @oneof */
+export interface StepDependencyDependencyTypeOneOf {
+    container?: Container;
+    step?: Step;
+}
+export interface Container {
+}
+export interface Step {
+    stepId?: string;
+}
+export interface ChallengeStepSettings {
+    general?: GeneralSettings;
+    embedding?: EmbeddingSettings;
+}
+export interface Feedback {
+    items?: FeedbackItem[];
+    createdAt?: Date;
+    updatedAt?: Date;
+    quiz?: FeedbackItem[];
+}
+export interface QuizSubmission {
+    quizSubmissionId?: string;
+    score?: number | null;
+}
+export interface GetParticipantStepRequest {
+    challengeId?: string;
+    participantId?: string;
+    stepId?: string;
+    timeInterval?: TimeInterval;
+}
+export interface GetParticipantStepResponse {
+    step?: ParticipantStep;
+    subSteps?: ParticipantStep[];
+}
+export interface ResolveParticipantStepRequest {
+    challengeId?: string;
+    participantId?: string;
+    stepId?: string;
+    status?: ResolutionStatus;
+    feedback?: Feedback;
+    actionId?: string;
+    quizSubmissionId?: string | null;
+}
+export declare enum ResolutionStatus {
+    COMPLETED = "COMPLETED",
+    SKIPPED = "SKIPPED",
+    UNDO = "UNDO",
+    QUIZ_SUBMIT = "QUIZ_SUBMIT"
+}
+export interface ResolveParticipantStepResponse {
+    step?: ParticipantStep;
+    actionId?: string;
+}
+export interface StepResolved {
+    challengeId?: string;
+    participantId?: string;
+    memberId?: string;
+    stepTitle?: string;
+    participantStepId?: string;
+    challengeStepId?: string;
+    /** TODO why it is repeated? */
+    feedback?: Feedback[];
+}
+export interface UpdateStepFeedbackRequest {
+    challengeId?: string;
+    participantId?: string;
+    stepId?: string;
+    feedback?: Feedback;
+    actionId?: string;
+}
+export interface UpdateStepFeedbackResponse {
+    step?: ParticipantStep;
+    actionId?: string;
+}
+export interface GetMediaUploadInfoRequest {
+    challengeId?: string;
+    participantId?: string;
+    fileName?: string;
+}
+export interface GetMediaUploadInfoResponse {
+    uploadUrl?: string;
+    uploadToken?: string;
+}
+export interface ListParticipantSectionsRequest {
+    challengeId?: string;
+    participantId?: string;
+}
+export interface ListParticipantSectionsResponse {
+    sections?: ParticipantSection[];
+}
+export interface ParticipantSection {
+    _id?: string;
+    source?: ChallengeSection;
+    steps?: ParticipantStep[];
+    transitions?: ParticipantSectionStateTransition[];
+    progress?: Progress;
+}
+export interface WaitingDate {
+    startDate?: string;
+}
+export interface WaitingDependency {
+    sectionId?: string;
+}
+export interface Running {
+    dateInterval?: DateInterval;
+}
+export interface Completed {
+}
+export interface Overdue {
+}
+export interface ChallengeSection {
+    /** challenge section id. */
+    _id?: string;
+    /** challenge section settings. */
+    settings?: Settings;
+    createdAt?: Date;
+    updatedAt?: Date;
+    /** list of challenge steps laying inside the section. */
+    steps?: ChallengeStep[];
+}
+export interface Settings {
+    /** section description(title, details, image...) */
+    description?: ObjectDescription;
+    /** condition for the section start. */
+    startCondition?: StartCondition;
+}
+export interface ParticipantSectionStateTransition extends ParticipantSectionStateTransitionStateOneOf {
+    occurredAt?: Date;
+    waitingDate?: WaitingDate;
+    waitingDependency?: WaitingDependency;
+    running?: Running;
+    completed?: Completed;
+    overdue?: Overdue;
+}
+/** @oneof */
+export interface ParticipantSectionStateTransitionStateOneOf {
+    waitingDate?: WaitingDate;
+    waitingDependency?: WaitingDependency;
+    running?: Running;
+    completed?: Completed;
+    overdue?: Overdue;
+}
+export interface Progress {
+    nTotalSteps?: string;
+    nCompletedSteps?: string;
+}
+export interface GetParticipantSectionRequest {
+    challengeId?: string;
+    participantId?: string;
+    sectionId?: string;
+}
+export interface GetParticipantSectionResponse {
+    section?: ParticipantSection;
+}
+export interface MyProgramRequest {
+    programId?: string;
+}
+export interface MyProgramResponse {
+    participant?: Participant;
+}
+export interface MyProgramStepRequest {
+    programId?: string;
+    programStepId?: string;
+}
+export interface MyProgramStepResponse {
+    participantStep?: ParticipantStep;
+}
+export interface MyProgramSectionRequest {
+    programId?: string;
+    programSectionId?: string;
+}
+export interface MyProgramSectionResponse {
+    participantSection?: ParticipantSection;
+}
+/** @public
+ * @requiredField challengeId
+ */
+export declare function addParticipant(challengeId: string, options?: AddParticipantOptions): Promise<AddParticipantResponse>;
+export interface AddParticipantOptions {
+    memberId?: string;
+    actionId?: string;
+}