@wix/auto_sdk_online-programs_online-program-participants 1.0.0 → 1.0.2

package/build/internal/cjs/meta.d.ts

@@ -125,6 +125,16 @@ interface Image {
      */
     filename?: string | null;
 }
+interface FocalPoint {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+    /** crop by height */
+    height?: number | null;
+    /** crop by width */
+    width?: number | null;
+}
 /** Deprecated - use VideoV2 */
 interface Video {
     /** WixMedia ID */
@@ -332,6 +342,27 @@ interface JoinParticipantResponse {
     actionId?: string;
     participant?: Participant;
 }
+interface ParticipantJoined {
+    participant?: Participant;
+    /**
+     * user id for program owner
+     * @format GUID
+     */
+    ownerId?: string;
+    /**
+     * owner's contact id
+     * @format GUID
+     */
+    ownerContactId?: string;
+    /** paid price for the program. */
+    payment?: Price;
+}
+interface Price {
+    /** @format DECIMAL_VALUE */
+    amount?: string;
+    /** @format CURRENCY */
+    currency?: string;
+}
 /** Add participant */
 interface AddParticipantRequest {
     /** @format GUID */
@@ -947,6 +978,51 @@ interface ResolveParticipantStepResponse {
     /** @format GUID */
     actionId?: string;
 }
+interface StepResolved {
+    challengeId?: string;
+    participantId?: string;
+    memberId?: string;
+    stepTitle?: string;
+    participantStepId?: string;
+    challengeStepId?: string;
+    /** TODO why it is repeated? */
+    feedback?: Feedback[];
+    /** Title of the program. Used in Notifications */
+    programName?: string;
+    /**
+     * user id for program owner
+     * @format GUID
+     */
+    ownerId?: string;
+    /**
+     * owner's contact id
+     * @format GUID
+     */
+    ownerContactId?: string;
+    /**
+     * participants contact
+     * @format GUID
+     */
+    participantContactId?: string;
+    /** info about quiz submission in that step */
+    quizSubmissionData?: QuizSubmissionData;
+    /** info about if participant completed step successfully or not */
+    status?: StatusWithLiterals;
+}
+interface QuizSubmissionData {
+    /** @format GUID */
+    submissionId?: string | null;
+    earnedScore?: number | null;
+    passingGrade?: number | null;
+}
+declare enum Status {
+    /** step completed */
+    COMPLETED = "COMPLETED",
+    /** participant failed to resolve step */
+    FAILED = "FAILED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'COMPLETED' | 'FAILED';
 interface UpdateStepFeedbackRequest {
     /** @format GUID */
     challengeId: string;
@@ -1073,6 +1149,142 @@ interface MyProgramSectionRequest {
 interface MyProgramSectionResponse {
     participantSection?: ParticipantSection;
 }
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -1202,4 +1414,4 @@ declare function myProgramSection(): __PublicMethodMetaInfo<'GET', {
     programSectionId: string;
 }, MyProgramSectionRequest$1, MyProgramSectionRequest, MyProgramSectionResponse$1, MyProgramSectionResponse>;
 
-export { type __PublicMethodMetaInfo, addAllParticipant, addParticipant, addParticipants, applyCouponToOrder, createJoinRequest, createPaymentOrder, deleteParticipant, getCertificate, getMediaUploadInfo, getParticipant, getSection, getStep, inviteAllParticipants, inviteParticipants, issueCertificate, issueParticipantCertificate, joinParticipant, listParticipants, listSections, listSteps, myProgram, myProgramSection, myProgramStep, queryParticipants, removeCouponFromOrder, resetParticipantProgress, resolveStep, reviveParticipant, updateParticipant, updateStepFeedback };
+export { type ActionEvent as ActionEventOriginal, type AddAllParticipantRequest as AddAllParticipantRequestOriginal, type AddAllParticipantResponse as AddAllParticipantResponseOriginal, type AddParticipantRequest as AddParticipantRequestOriginal, type AddParticipantResponse as AddParticipantResponseOriginal, type AddParticipantsRequest as AddParticipantsRequestOriginal, type AddParticipantsResponse as AddParticipantsResponseOriginal, type Added as AddedOriginal, type All as AllOriginal, type ApplyCouponToOrderRequest as ApplyCouponToOrderRequestOriginal, type ApplyCouponToOrderResponse as ApplyCouponToOrderResponseOriginal, type Certificate as CertificateOriginal, type ChallengeSection as ChallengeSectionOriginal, type ChallengeStep as ChallengeStepOriginal, type ChallengeStepSettings as ChallengeStepSettingsOriginal, type Choice as ChoiceOriginal, ChoiceRightness as ChoiceRightnessOriginal, type ChoiceRightnessWithLiterals as ChoiceRightnessWithLiteralsOriginal, type Choices as ChoicesOriginal, type Completed as CompletedOriginal, type CompletionCriteria as CompletionCriteriaOriginal, type Container as ContainerOriginal, type CreateJoinRequestRequest as CreateJoinRequestRequestOriginal, type CreateJoinRequestResponse as CreateJoinRequestResponseOriginal, type CreatePaymentOrderRequest as CreatePaymentOrderRequestOriginal, type CreatePaymentOrderResponse as CreatePaymentOrderResponseOriginal, type DateInterval as DateIntervalOriginal, type DeleteParticipantRequest as DeleteParticipantRequestOriginal, type DeleteParticipantResponse as DeleteParticipantResponseOriginal, DescriptionFieldSet as DescriptionFieldSetOriginal, type DescriptionFieldSetWithLiterals as DescriptionFieldSetWithLiteralsOriginal, type Document as DocumentOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EmbeddingSettings as EmbeddingSettingsOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntitySummary as EntitySummaryOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FeedbackItemChoice as FeedbackItemChoiceOriginal, type FeedbackItem as FeedbackItemOriginal, type FeedbackItemSettings as FeedbackItemSettingsOriginal, type FeedbackItemType as FeedbackItemTypeOriginal, type FeedbackItemTypeTypeOneOf as FeedbackItemTypeTypeOneOfOriginal, type FeedbackItemValueOneOf as FeedbackItemValueOneOfOriginal, type Feedback as FeedbackOriginal, type FocalPoint as FocalPointOriginal, type FreeCoupon as FreeCouponOriginal, type Free as FreeOriginal, type GeneralSettings as GeneralSettingsOriginal, type GeneralSettingsStepTypeOneOf as GeneralSettingsStepTypeOneOfOriginal, type GetCertificateRequest as GetCertificateRequestOriginal, type GetCertificateResponse as GetCertificateResponseOriginal, type GetMediaUploadInfoRequest as GetMediaUploadInfoRequestOriginal, type GetMediaUploadInfoResponse as GetMediaUploadInfoResponseOriginal, type GetParticipantRequest as GetParticipantRequestOriginal, type GetParticipantResponse as GetParticipantResponseOriginal, type GetParticipantSectionRequest as GetParticipantSectionRequestOriginal, type GetParticipantSectionResponse as GetParticipantSectionResponseOriginal, type GetParticipantStepRequest as GetParticipantStepRequestOriginal, type GetParticipantStepResponse as GetParticipantStepResponseOriginal, type GroupSettings as GroupSettingsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type IndividualSettings as IndividualSettingsOriginal, type InvitationDetails as InvitationDetailsOriginal, type InviteAllParticipantsRequest as InviteAllParticipantsRequestOriginal, type InviteAllParticipantsResponse as InviteAllParticipantsResponseOriginal, type InviteParticipantsRequest as InviteParticipantsRequestOriginal, type InviteParticipantsResponse as InviteParticipantsResponseOriginal, type IssueCertificateRequest as IssueCertificateRequestOriginal, type IssueCertificateResponse as IssueCertificateResponseOriginal, type IssueParticipantCertificateRequest as IssueParticipantCertificateRequestOriginal, type IssueParticipantCertificateResponse as IssueParticipantCertificateResponseOriginal, type JoinParticipantRequest as JoinParticipantRequestOriginal, type JoinParticipantResponse as JoinParticipantResponseOriginal, type JoinPath as JoinPathOriginal, type JoinPathPathOneOf as JoinPathPathOneOfOriginal, type ListParticipantSectionsRequest as ListParticipantSectionsRequestOriginal, type ListParticipantSectionsResponse as ListParticipantSectionsResponseOriginal, type ListParticipantStepsRequest as ListParticipantStepsRequestOriginal, type ListParticipantStepsResponse as ListParticipantStepsResponseOriginal, type ListParticipantsRequest as ListParticipantsRequestOriginal, type ListParticipantsResponse as ListParticipantsResponseOriginal, type MediaFeedbackItem as MediaFeedbackItemOriginal, type MediaItemMediaOneOf as MediaItemMediaOneOfOriginal, type MediaItem as MediaItemOriginal, type MediaItems as MediaItemsOriginal, type Member as MemberOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MinThreshold as MinThresholdOriginal, type MultipleChoiceFeedbackItem as MultipleChoiceFeedbackItemOriginal, type MyProgramRequest as MyProgramRequestOriginal, type MyProgramResponse as MyProgramResponseOriginal, type MyProgramSectionRequest as MyProgramSectionRequestOriginal, type MyProgramSectionResponse as MyProgramSectionResponseOriginal, type MyProgramStepRequest as MyProgramStepRequestOriginal, type MyProgramStepResponse as MyProgramStepResponseOriginal, type NumericFeedbackItem as NumericFeedbackItemOriginal, type ObjectDescription as ObjectDescriptionOriginal, type Overdue as OverdueOriginal, type Paging as PagingOriginal, type PaidPlan as PaidPlanOriginal, type ParticipantJoinDate as ParticipantJoinDateOriginal, type ParticipantJoined as ParticipantJoinedOriginal, type Participant as ParticipantOriginal, type ParticipantPerformance as ParticipantPerformanceOriginal, type ParticipantSection as ParticipantSectionOriginal, type ParticipantSectionStateTransition as ParticipantSectionStateTransitionOriginal, type ParticipantSectionStateTransitionStateOneOf as ParticipantSectionStateTransitionStateOneOfOriginal, type ParticipantStep as ParticipantStepOriginal, ParticipantStepState as ParticipantStepStateOriginal, type ParticipantStepStateTransition as ParticipantStepStateTransitionOriginal, type ParticipantStepStateWithLiterals as ParticipantStepStateWithLiteralsOriginal, type ParticipantsFilter as ParticipantsFilterOriginal, ParticipationState as ParticipationStateOriginal, type ParticipationStateWithLiterals as ParticipationStateWithLiteralsOriginal, PaymentType as PaymentTypeOriginal, type PaymentTypeWithLiterals as PaymentTypeWithLiteralsOriginal, type Price as PriceOriginal, type Progress as ProgressOriginal, type QuantityCriterionCriterionOneOf as QuantityCriterionCriterionOneOfOriginal, type QuantityCriterion as QuantityCriterionOriginal, type QuantityFeedbackItem as QuantityFeedbackItemOriginal, type Quantity as QuantityOriginal, QueryParticipantsRequestJoinPath as QueryParticipantsRequestJoinPathOriginal, type QueryParticipantsRequestJoinPathWithLiterals as QueryParticipantsRequestJoinPathWithLiteralsOriginal, type QueryParticipantsRequest as QueryParticipantsRequestOriginal, QueryParticipantsRequestSortingCriterion as QueryParticipantsRequestSortingCriterionOriginal, type QueryParticipantsRequestSortingCriterionWithLiterals as QueryParticipantsRequestSortingCriterionWithLiteralsOriginal, QueryParticipantsRequestSortingOrder as QueryParticipantsRequestSortingOrderOriginal, type QueryParticipantsRequestSortingOrderWithLiterals as QueryParticipantsRequestSortingOrderWithLiteralsOriginal, type QueryParticipantsRequestSorting as QueryParticipantsRequestSortingOriginal, type QueryParticipantsResponse as QueryParticipantsResponseOriginal, type QuizMigrationDetails as QuizMigrationDetailsOriginal, type QuizSettings as QuizSettingsOriginal, type QuizSubmissionData as QuizSubmissionDataOriginal, type QuizSubmission as QuizSubmissionOriginal, QuizType as QuizTypeOriginal, type QuizTypeWithLiterals as QuizTypeWithLiteralsOriginal, type RecurrenceSchedule as RecurrenceScheduleOriginal, type RecurrenceSettings as RecurrenceSettingsOriginal, type RemoveCouponFromOrderRequest as RemoveCouponFromOrderRequestOriginal, type RemoveCouponFromOrderResponse as RemoveCouponFromOrderResponseOriginal, type ResetParticipantProgressRequest as ResetParticipantProgressRequestOriginal, type ResetParticipantProgressResponse as ResetParticipantProgressResponseOriginal, ResolutionStatus as ResolutionStatusOriginal, type ResolutionStatusWithLiterals as ResolutionStatusWithLiteralsOriginal, type ResolveParticipantStepRequest as ResolveParticipantStepRequestOriginal, type ResolveParticipantStepResponse as ResolveParticipantStepResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type ReviveParticipantRequest as ReviveParticipantRequestOriginal, type ReviveParticipantResponse as ReviveParticipantResponseOriginal, type Running as RunningOriginal, type Settings as SettingsOriginal, type SinglePayment as SinglePaymentOriginal, SortingCriterion as SortingCriterionOriginal, type SortingCriterionWithLiterals as SortingCriterionWithLiteralsOriginal, SortingOrder as SortingOrderOriginal, type SortingOrderWithLiterals as SortingOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type StartCondition as StartConditionOriginal, State as StateOriginal, type StateTransition as StateTransitionOriginal, type StateWithLiterals as StateWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StepDependencyDependencyTypeOneOf as StepDependencyDependencyTypeOneOfOriginal, type StepDependency as StepDependencyOriginal, type StepEvent as StepEventOriginal, type Step as StepOriginal, type StepResolved as StepResolvedOriginal, type StepsSummary as StepsSummaryOriginal, type TextFeedbackItem as TextFeedbackItemOriginal, type TimeDuration as TimeDurationOriginal, type TimeInterval as TimeIntervalOriginal, type UpdateParticipantRequest as UpdateParticipantRequestOriginal, type UpdateParticipantRequestUpdateOneOf as UpdateParticipantRequestUpdateOneOfOriginal, type UpdateParticipantResponse as UpdateParticipantResponseOriginal, type UpdateStepFeedbackRequest as UpdateStepFeedbackRequestOriginal, type UpdateStepFeedbackResponse as UpdateStepFeedbackResponseOriginal, type Video as VideoOriginal, type VideoResolution as VideoResolutionOriginal, type VideoStepSettings as VideoStepSettingsOriginal, type VideoStepSettingsVideoSourceOneOf as VideoStepSettingsVideoSourceOneOfOriginal, type VideoV2 as VideoV2Original, type WaitingDate as WaitingDateOriginal, type WaitingDependency as WaitingDependencyOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WixVideo as WixVideoOriginal, type __PublicMethodMetaInfo, addAllParticipant, addParticipant, addParticipants, applyCouponToOrder, createJoinRequest, createPaymentOrder, deleteParticipant, getCertificate, getMediaUploadInfo, getParticipant, getSection, getStep, inviteAllParticipants, inviteParticipants, issueCertificate, issueParticipantCertificate, joinParticipant, listParticipants, listSections, listSteps, myProgram, myProgramSection, myProgramStep, queryParticipants, removeCouponFromOrder, resetParticipantProgress, resolveStep, reviveParticipant, updateParticipant, updateStepFeedback };