@wix/auto_sdk_online-programs_participants 1.0.15 → 1.0.16

package/build/cjs/{online-programs-participants-v3-participant-participants.universal-B-mpcshi.d.ts → online-programs-participants-v3-participant-participants.universal-CVjCdKBh.d.ts}

@@ -321,18 +321,6 @@ interface Schema {
     label?: string;
     clusterName?: string;
 }
-interface ParticipantAdded {
-    /**
-     * ID of the program to which the participant was added.
-     * @format GUID
-     */
-    programId?: string;
-    /**
-     * Member ID of the participant on the site.
-     * @format GUID
-     */
-    memberId?: string;
-}
 /**
  * Domain event emitted when a participant's tags are modified.
  * Pre-publication rename from TagsModified; no consumers of the legacy FQN are known.
@@ -345,6 +333,7 @@ interface ParticipantTagsModified {
     /** Tags that were unassigned */
     unassignedTags?: Tags;
 }
+/** Domain event emitted when a participant completes a program. */
 interface ParticipantCompletedProgram {
     /**
      * ID of the participant who completed the program.
@@ -361,7 +350,10 @@ interface ParticipantCompletedProgram {
      * @format GUID
      */
     memberId?: string;
+    /** Snapshot of the participant after completing the program. */
+    participant?: Participant;
 }
+/** Domain event emitted when a participant misses a program deadline. */
 interface ParticipantMissedProgramDeadline {
     /**
      * ID of the participant who missed the deadline.
@@ -378,7 +370,10 @@ interface ParticipantMissedProgramDeadline {
      * @format GUID
      */
     memberId?: string;
+    /** Snapshot of the participant after missing the deadline. */
+    participant?: Participant;
 }
+/** Domain event emitted when a participant's program duration ends. */
 interface ParticipantProgramDurationEnded {
     /**
      * ID of the participant whose program duration ended.
@@ -395,6 +390,8 @@ interface ParticipantProgramDurationEnded {
      * @format GUID
      */
     memberId?: string;
+    /** Snapshot of the participant when the program duration ended. */
+    participant?: Participant;
 }
 /** Domain event emitted when a participant is removed from a program by an administrator. */
 interface ParticipantRemoved {
@@ -413,6 +410,8 @@ interface ParticipantRemoved {
      * @format GUID
      */
     memberId?: string;
+    /** Snapshot of the participant after being removed from the program. */
+    participant?: Participant;
 }
 /** Domain event emitted when a participant voluntarily leaves a program. */
 interface ParticipantLeft {
@@ -431,6 +430,8 @@ interface ParticipantLeft {
      * @format GUID
      */
     memberId?: string;
+    /** Snapshot of the participant after leaving the program. */
+    participant?: Participant;
 }
 interface ParticipantExportsFinished {
     /**
@@ -1607,6 +1608,198 @@ type BulkUpdateParticipantTagsByFilterApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** 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;
+    accountInfo?: AccountInfoMetadata;
+}
+interface AccountInfoMetadata {
+    /** ID of the Wix account associated with the event */
+    accountId: string;
+    /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
+    siteId?: string;
+    /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
+    parentAccountId?: string;
+}
+interface ParticipantCompletedProgramEnvelope {
+    data: ParticipantCompletedProgram;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a participant completes a program.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId online_programs:participants:v3:participant:read_events
+ * @webhook
+ * @eventType wix.online_programs.participants.v3.participant_completed_program
+ * @slug completed_program
+ * @documentationMaturity preview
+ */
+declare function onParticipantCompletedProgram(handler: (event: ParticipantCompletedProgramEnvelope) => void | Promise<void>): void;
+interface ParticipantCreatedEnvelope {
+    entity: Participant;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a participant is created.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId online_programs:participants:v3:participant:read_events
+ * @webhook
+ * @eventType wix.online_programs.participants.v3.participant_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onParticipantCreated(handler: (event: ParticipantCreatedEnvelope) => void | Promise<void>): void;
+interface ParticipantDeletedEnvelope {
+    entity: Participant;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a participant is deleted.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId online_programs:participants:v3:participant:read_events
+ * @webhook
+ * @eventType wix.online_programs.participants.v3.participant_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onParticipantDeleted(handler: (event: ParticipantDeletedEnvelope) => void | Promise<void>): void;
+interface ParticipantLeftEnvelope {
+    data: ParticipantLeft;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a participant voluntarily leaves a program.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId online_programs:participants:v3:participant:read_events
+ * @webhook
+ * @eventType wix.online_programs.participants.v3.participant_left
+ * @slug left
+ * @documentationMaturity preview
+ */
+declare function onParticipantLeft(handler: (event: ParticipantLeftEnvelope) => void | Promise<void>): void;
+interface ParticipantMissedProgramDeadlineEnvelope {
+    data: ParticipantMissedProgramDeadline;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a participant misses a program deadline.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId online_programs:participants:v3:participant:read_events
+ * @webhook
+ * @eventType wix.online_programs.participants.v3.participant_missed_program_deadline
+ * @slug missed_program_deadline
+ * @documentationMaturity preview
+ */
+declare function onParticipantMissedProgramDeadline(handler: (event: ParticipantMissedProgramDeadlineEnvelope) => void | Promise<void>): void;
+interface ParticipantProgramDurationEndedEnvelope {
+    data: ParticipantProgramDurationEnded;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a participant's program duration ends.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId online_programs:participants:v3:participant:read_events
+ * @webhook
+ * @eventType wix.online_programs.participants.v3.participant_program_duration_ended
+ * @slug program_duration_ended
+ * @documentationMaturity preview
+ */
+declare function onParticipantProgramDurationEnded(handler: (event: ParticipantProgramDurationEndedEnvelope) => void | Promise<void>): void;
+interface ParticipantRemovedEnvelope {
+    data: ParticipantRemoved;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an administrator removes a participant from a program.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId online_programs:participants:v3:participant:read_events
+ * @webhook
+ * @eventType wix.online_programs.participants.v3.participant_removed
+ * @slug removed
+ * @documentationMaturity preview
+ */
+declare function onParticipantRemoved(handler: (event: ParticipantRemovedEnvelope) => void | Promise<void>): void;
+interface ParticipantTagsModifiedEnvelope {
+    data: ParticipantTagsModified;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a participant's tags are modified.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId online_programs:participants:v3:participant:read_events
+ * @webhook
+ * @eventType wix.online_programs.participants.v3.participant_tags_modified
+ * @slug tags_modified
+ * @documentationMaturity preview
+ */
+declare function onParticipantTagsModified(handler: (event: ParticipantTagsModifiedEnvelope) => void | Promise<void>): void;
+interface ParticipantUpdatedEnvelope {
+    entity: Participant;
+    metadata: EventMetadata;
+    /** @hidden */
+    modifiedFields: Record<string, any>;
+}
+/**
+ * Triggered when a participant is updated.
+ * @permissionScope Manage Online Programs
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId online_programs:participants:v3:participant:read_events
+ * @webhook
+ * @eventType wix.online_programs.participants.v3.participant_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onParticipantUpdated(handler: (event: ParticipantUpdatedEnvelope) => void | Promise<void>): void;
 /**
  * Creates a participant.
  *
@@ -2265,4 +2458,4 @@ type ParticipantSearch = {
     timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
 };
 
-export { type Tags as $, SortDirection as A, type BulkCreateParticipantsOptions as B, type CreateParticipantOptions as C, ScalarType as D, EnrollmentStatus as E, Interval as F, type GetPremiumStatsResponse as G, AggregationType as H, type IssueCertificateOptions as I, Mode as J, type SinglePaymentDetails as K, type PaidPlanDetails as L, MissingValues as M, NestedAggregationType as N, type FreeCouponDetails as O, type Participant as P, type QueryParticipantsOptions as Q, RequestedFields as R, type SearchParticipantsOptions as S, type Progress as T, type UpdateParticipant as U, type CertificateInfo as V, WebhookIdentityType as W, type Member as X, type EnrollmentInfo as Y, type EnrollmentInfoPricingTypeDetailsOneOf as Z, type ExtendedFields as _, type CreateParticipantApplicationErrors as a, type ValueAggregationOptionsOneOf as a$, type TagList as a0, type ReindexMessage as a1, type ReindexMessageActionOneOf as a2, type Upsert as a3, type Delete as a4, type Schema as a5, type ParticipantAdded as a6, type ParticipantTagsModified as a7, type ParticipantCompletedProgram as a8, type ParticipantMissedProgramDeadline as a9, type IssueCertificateRequest as aA, type GetCompletionStatsRequest as aB, type GetCompletionStatsResponse as aC, type GetPremiumStatsRequest as aD, type GetParticipantRequest as aE, type GetParticipantResponse as aF, type QueryParticipantsRequest as aG, type QueryV2 as aH, type QueryV2PagingMethodOneOf as aI, type Sorting as aJ, type Paging as aK, type CursorPaging as aL, type QueryParticipantsResponse as aM, type PagingMetadataV2 as aN, type Cursors as aO, type GetAccessStatusRequest as aP, type BulkUpdateParticipantTagsRequest as aQ, type BulkUpdateParticipantTagsResult as aR, type BulkUpdateParticipantTagsByFilterRequest as aS, type SearchParticipantsRequest as aT, type CursorSearch as aU, type CursorSearchPagingMethodOneOf as aV, type Aggregation as aW, type AggregationKindOneOf as aX, type RangeBucket as aY, type IncludeMissingValuesOptions as aZ, type ValueAggregation as a_, type ParticipantProgramDurationEnded as aa, type ParticipantRemoved as ab, type ParticipantLeft as ac, type ParticipantExportsFinished as ad, type CreateParticipantRequest as ae, type CreateParticipantResponse as af, type UpdateParticipantRequest as ag, type UpdateParticipantResponse as ah, type BulkCreateParticipantsRequest as ai, type BulkParticipantResult as aj, type ItemMetadata as ak, type ApplicationError as al, type BulkActionMetadata as am, type BulkUpsertParticipantsMigrationRequest as an, type ParticipantMigration as ao, type BulkUpsertParticipantsMigrationResponse as ap, type BulkParticipantMigrationResult as aq, type DeleteAllParticipantsMigrationRequest as ar, type DeleteAllParticipantsMigrationResponse as as, type ReindexParticipantsSearchRequest as at, type ReindexParticipantsSearchResponse as au, type SynchronizeTimeCapsuleTasksRequest as av, type SynchronizeTimeCapsuleTasksResponse as aw, type BulkCreateParticipantsForAllMembersRequest as ax, type DeleteParticipantRequest as ay, type DeleteParticipantResponse as az, type UpdateParticipantOptions as b, type WebhookIdentityTypeWithLiterals as b$, type RangeAggregation as b0, type ScalarAggregation as b1, type DateHistogramAggregation as b2, type NestedAggregationItem as b3, type NestedAggregationItemKindOneOf as b4, type NestedAggregation as b5, type GroupByAggregation as b6, type GroupByAggregationKindOneOf as b7, type SearchDetails as b8, type CursorPagingMetadata as b9, type EntityDeletedEvent as bA, type ActionEvent as bB, type Empty as bC, type MessageEnvelope as bD, type IdentificationData as bE, type IdentificationDataIdOneOf as bF, type AccountInfo as bG, type ExportParticipantsStatsRequest as bH, type ExportParticipantsStatsResponse as bI, type ParticipantsQueryResult as bJ, type ParticipantQuerySpec as bK, type ParticipantSearchSpec as bL, utils as bM, type PricingTypeWithLiterals as bN, type EnrollmentStatusWithLiterals as bO, type ProgressStatusWithLiterals as bP, type RequestedFieldsWithLiterals as bQ, type BulkActionTypeWithLiterals as bR, type SortOrderWithLiterals as bS, type SortTypeWithLiterals as bT, type SortDirectionWithLiterals as bU, type MissingValuesWithLiterals as bV, type ScalarTypeWithLiterals as bW, type NestedAggregationTypeWithLiterals as bX, type IntervalWithLiterals as bY, type AggregationTypeWithLiterals as bZ, type ModeWithLiterals as b_, type AggregationData as ba, type ValueAggregationResult as bb, type RangeAggregationResult as bc, type NestedAggregationResults as bd, type NestedAggregationResultsResultOneOf as be, type ValueResults as bf, type RangeResults as bg, type AggregationResultsScalarResult as bh, type NestedValueAggregationResult as bi, type ValueResult as bj, type RangeResult as bk, type ScalarResult as bl, type NestedResultValue as bm, type NestedResultValueResultOneOf as bn, type Results as bo, type DateHistogramResult as bp, type GroupByValueResults as bq, type DateHistogramResults as br, type NestedResults as bs, type AggregationResults as bt, type AggregationResultsResultOneOf as bu, type DomainEvent as bv, type DomainEventBodyOneOf as bw, type EntityCreatedEvent as bx, type RestoreInfo as by, type EntityUpdatedEvent as bz, type BulkCreateParticipantsResponse as c, type CommonQueryWithEntityContext as c0, type CommonSearchWithEntityContext as c1, createParticipant as c2, updateParticipant as c3, bulkCreateParticipants as c4, bulkCreateParticipantsForAllMembers as c5, deleteParticipant as c6, issueCertificate as c7, getPremiumStats as c8, getParticipant as c9, queryParticipants as ca, getAccessStatus as cb, bulkUpdateParticipantTags as cc, bulkUpdateParticipantTagsByFilter as cd, type BulkCreateParticipantsApplicationErrors as d, type BulkCreateParticipantsForAllMembersOptions as e, type BulkCreateParticipantsForAllMembersResponse as f, type IssueCertificateResponse as g, type IssueCertificateApplicationErrors as h, type GetParticipantOptions as i, type GetAccessStatusResponse as j, type BulkUpdateParticipantTagsOptions as k, type BulkUpdateParticipantTagsResponse as l, type BulkUpdateParticipantTagsApplicationErrors as m, type BulkUpdateParticipantTagsByFilterOptions as n, type BulkUpdateParticipantTagsByFilterResponse as o, type BulkUpdateParticipantTagsByFilterApplicationErrors as p, type ParticipantSearch as q, type SearchParticipantsResponse as r, type ParticipantQuery as s, typedQueryParticipants as t, type ParticipantsQueryBuilder as u, PricingType as v, ProgressStatus as w, BulkActionType as x, SortOrder as y, SortType as z };
+export { type SinglePaymentDetails as $, type ParticipantUpdatedEnvelope as A, type BulkCreateParticipantsOptions as B, type CreateParticipantOptions as C, type ParticipantQuery as D, typedQueryParticipants as E, type ParticipantsQueryBuilder as F, type GetPremiumStatsResponse as G, PricingType as H, type IssueCertificateOptions as I, EnrollmentStatus as J, ProgressStatus as K, BulkActionType as L, SortOrder as M, SortType as N, SortDirection as O, type Participant as P, type QueryParticipantsOptions as Q, RequestedFields as R, type SearchParticipantsOptions as S, MissingValues as T, type UpdateParticipant as U, ScalarType as V, NestedAggregationType as W, Interval as X, AggregationType as Y, Mode as Z, WebhookIdentityType as _, type CreateParticipantApplicationErrors as a, type SearchParticipantsRequest as a$, type PaidPlanDetails as a0, type FreeCouponDetails as a1, type Progress as a2, type CertificateInfo as a3, type Member as a4, type EnrollmentInfo as a5, type EnrollmentInfoPricingTypeDetailsOneOf as a6, type ExtendedFields as a7, type Tags as a8, type TagList as a9, type DeleteAllParticipantsMigrationResponse as aA, type ReindexParticipantsSearchRequest as aB, type ReindexParticipantsSearchResponse as aC, type SynchronizeTimeCapsuleTasksRequest as aD, type SynchronizeTimeCapsuleTasksResponse as aE, type BulkCreateParticipantsForAllMembersRequest as aF, type DeleteParticipantRequest as aG, type DeleteParticipantResponse as aH, type IssueCertificateRequest as aI, type GetCompletionStatsRequest as aJ, type GetCompletionStatsResponse as aK, type GetPremiumStatsRequest as aL, type GetParticipantRequest as aM, type GetParticipantResponse as aN, type QueryParticipantsRequest as aO, type QueryV2 as aP, type QueryV2PagingMethodOneOf as aQ, type Sorting as aR, type Paging as aS, type CursorPaging as aT, type QueryParticipantsResponse as aU, type PagingMetadataV2 as aV, type Cursors as aW, type GetAccessStatusRequest as aX, type BulkUpdateParticipantTagsRequest as aY, type BulkUpdateParticipantTagsResult as aZ, type BulkUpdateParticipantTagsByFilterRequest as a_, type ReindexMessage as aa, type ReindexMessageActionOneOf as ab, type Upsert as ac, type Delete as ad, type Schema as ae, type ParticipantTagsModified as af, type ParticipantCompletedProgram as ag, type ParticipantMissedProgramDeadline as ah, type ParticipantProgramDurationEnded as ai, type ParticipantRemoved as aj, type ParticipantLeft as ak, type ParticipantExportsFinished as al, type CreateParticipantRequest as am, type CreateParticipantResponse as an, type UpdateParticipantRequest as ao, type UpdateParticipantResponse as ap, type BulkCreateParticipantsRequest as aq, type BulkParticipantResult as ar, type ItemMetadata as as, type ApplicationError as at, type BulkActionMetadata as au, type BulkUpsertParticipantsMigrationRequest as av, type ParticipantMigration as aw, type BulkUpsertParticipantsMigrationResponse as ax, type BulkParticipantMigrationResult as ay, type DeleteAllParticipantsMigrationRequest as az, type UpdateParticipantOptions as b, type RequestedFieldsWithLiterals as b$, type CursorSearch as b0, type CursorSearchPagingMethodOneOf as b1, type Aggregation as b2, type AggregationKindOneOf as b3, type RangeBucket as b4, type IncludeMissingValuesOptions as b5, type ValueAggregation as b6, type ValueAggregationOptionsOneOf as b7, type RangeAggregation as b8, type ScalarAggregation as b9, type NestedResults as bA, type AggregationResults as bB, type AggregationResultsResultOneOf as bC, type DomainEvent as bD, type DomainEventBodyOneOf as bE, type EntityCreatedEvent as bF, type RestoreInfo as bG, type EntityUpdatedEvent as bH, type EntityDeletedEvent as bI, type ActionEvent as bJ, type Empty as bK, type MessageEnvelope as bL, type IdentificationData as bM, type IdentificationDataIdOneOf as bN, type AccountInfo as bO, type ExportParticipantsStatsRequest as bP, type ExportParticipantsStatsResponse as bQ, type BaseEventMetadata as bR, type EventMetadata as bS, type AccountInfoMetadata as bT, type ParticipantsQueryResult as bU, type ParticipantQuerySpec as bV, type ParticipantSearchSpec as bW, utils as bX, type PricingTypeWithLiterals as bY, type EnrollmentStatusWithLiterals as bZ, type ProgressStatusWithLiterals as b_, type DateHistogramAggregation as ba, type NestedAggregationItem as bb, type NestedAggregationItemKindOneOf as bc, type NestedAggregation as bd, type GroupByAggregation as be, type GroupByAggregationKindOneOf as bf, type SearchDetails as bg, type CursorPagingMetadata as bh, type AggregationData as bi, type ValueAggregationResult as bj, type RangeAggregationResult as bk, type NestedAggregationResults as bl, type NestedAggregationResultsResultOneOf as bm, type ValueResults as bn, type RangeResults as bo, type AggregationResultsScalarResult as bp, type NestedValueAggregationResult as bq, type ValueResult as br, type RangeResult as bs, type ScalarResult as bt, type NestedResultValue as bu, type NestedResultValueResultOneOf as bv, type Results as bw, type DateHistogramResult as bx, type GroupByValueResults as by, type DateHistogramResults as bz, type BulkCreateParticipantsResponse as c, type BulkActionTypeWithLiterals as c0, type SortOrderWithLiterals as c1, type SortTypeWithLiterals as c2, type SortDirectionWithLiterals as c3, type MissingValuesWithLiterals as c4, type ScalarTypeWithLiterals as c5, type NestedAggregationTypeWithLiterals as c6, type IntervalWithLiterals as c7, type AggregationTypeWithLiterals as c8, type ModeWithLiterals as c9, type WebhookIdentityTypeWithLiterals as ca, type CommonQueryWithEntityContext as cb, type CommonSearchWithEntityContext as cc, onParticipantCompletedProgram as cd, onParticipantCreated as ce, onParticipantDeleted as cf, onParticipantLeft as cg, onParticipantMissedProgramDeadline as ch, onParticipantProgramDurationEnded as ci, onParticipantRemoved as cj, onParticipantTagsModified as ck, onParticipantUpdated as cl, createParticipant as cm, updateParticipant as cn, bulkCreateParticipants as co, bulkCreateParticipantsForAllMembers as cp, deleteParticipant as cq, issueCertificate as cr, getPremiumStats as cs, getParticipant as ct, queryParticipants as cu, getAccessStatus as cv, bulkUpdateParticipantTags as cw, bulkUpdateParticipantTagsByFilter as cx, type BulkCreateParticipantsApplicationErrors as d, type BulkCreateParticipantsForAllMembersOptions as e, type BulkCreateParticipantsForAllMembersResponse as f, type IssueCertificateResponse as g, type IssueCertificateApplicationErrors as h, type GetParticipantOptions as i, type GetAccessStatusResponse as j, type BulkUpdateParticipantTagsOptions as k, type BulkUpdateParticipantTagsResponse as l, type BulkUpdateParticipantTagsApplicationErrors as m, type BulkUpdateParticipantTagsByFilterOptions as n, type BulkUpdateParticipantTagsByFilterResponse as o, type BulkUpdateParticipantTagsByFilterApplicationErrors as p, type ParticipantSearch as q, type SearchParticipantsResponse as r, type ParticipantCompletedProgramEnvelope as s, type ParticipantCreatedEnvelope as t, type ParticipantDeletedEnvelope as u, type ParticipantLeftEnvelope as v, type ParticipantMissedProgramDeadlineEnvelope as w, type ParticipantProgramDurationEndedEnvelope as x, type ParticipantRemovedEnvelope as y, type ParticipantTagsModifiedEnvelope as z };

package/build/es/index.d.mts

@@ -1,6 +1,6 @@
-import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
-import { P as Participant, C as CreateParticipantOptions, a as CreateParticipantApplicationErrors, U as UpdateParticipant, b as UpdateParticipantOptions, B as BulkCreateParticipantsOptions, c as BulkCreateParticipantsResponse, d as BulkCreateParticipantsApplicationErrors, e as BulkCreateParticipantsForAllMembersOptions, f as BulkCreateParticipantsForAllMembersResponse, I as IssueCertificateOptions, g as IssueCertificateResponse, h as IssueCertificateApplicationErrors, G as GetPremiumStatsResponse, i as GetParticipantOptions, j as GetAccessStatusResponse, k as BulkUpdateParticipantTagsOptions, l as BulkUpdateParticipantTagsResponse, m as BulkUpdateParticipantTagsApplicationErrors, n as BulkUpdateParticipantTagsByFilterOptions, o as BulkUpdateParticipantTagsByFilterResponse, p as BulkUpdateParticipantTagsByFilterApplicationErrors, q as ParticipantSearch, S as SearchParticipantsOptions, r as SearchParticipantsResponse, s as ParticipantQuery, Q as QueryParticipantsOptions, t as typedQueryParticipants, u as ParticipantsQueryBuilder } from './online-programs-participants-v3-participant-participants.universal-B-mpcshi.mjs';
-export { bG as AccountInfo, bB as ActionEvent, aW as Aggregation, ba as AggregationData, aX as AggregationKindOneOf, bt as AggregationResults, bu as AggregationResultsResultOneOf, bh as AggregationResultsScalarResult, H as AggregationType, bZ as AggregationTypeWithLiterals, al as ApplicationError, am as BulkActionMetadata, x as BulkActionType, bR as BulkActionTypeWithLiterals, ax as BulkCreateParticipantsForAllMembersRequest, ai as BulkCreateParticipantsRequest, aq as BulkParticipantMigrationResult, aj as BulkParticipantResult, aS as BulkUpdateParticipantTagsByFilterRequest, aQ as BulkUpdateParticipantTagsRequest, aR as BulkUpdateParticipantTagsResult, an as BulkUpsertParticipantsMigrationRequest, ap as BulkUpsertParticipantsMigrationResponse, V as CertificateInfo, c0 as CommonQueryWithEntityContext, c1 as CommonSearchWithEntityContext, ae as CreateParticipantRequest, af as CreateParticipantResponse, aL as CursorPaging, b9 as CursorPagingMetadata, aU as CursorSearch, aV as CursorSearchPagingMethodOneOf, aO as Cursors, b2 as DateHistogramAggregation, bp as DateHistogramResult, br as DateHistogramResults, a4 as Delete, ar as DeleteAllParticipantsMigrationRequest, as as DeleteAllParticipantsMigrationResponse, ay as DeleteParticipantRequest, az as DeleteParticipantResponse, bv as DomainEvent, bw as DomainEventBodyOneOf, bC as Empty, Y as EnrollmentInfo, Z as EnrollmentInfoPricingTypeDetailsOneOf, E as EnrollmentStatus, bO as EnrollmentStatusWithLiterals, bx as EntityCreatedEvent, bA as EntityDeletedEvent, bz as EntityUpdatedEvent, bH as ExportParticipantsStatsRequest, bI as ExportParticipantsStatsResponse, _ as ExtendedFields, O as FreeCouponDetails, aP as GetAccessStatusRequest, aB as GetCompletionStatsRequest, aC as GetCompletionStatsResponse, aE as GetParticipantRequest, aF as GetParticipantResponse, aD as GetPremiumStatsRequest, b6 as GroupByAggregation, b7 as GroupByAggregationKindOneOf, bq as GroupByValueResults, bE as IdentificationData, bF as IdentificationDataIdOneOf, aZ as IncludeMissingValuesOptions, F as Interval, bY as IntervalWithLiterals, aA as IssueCertificateRequest, ak as ItemMetadata, X as Member, bD as MessageEnvelope, M as MissingValues, bV as MissingValuesWithLiterals, J as Mode, b_ as ModeWithLiterals, b5 as NestedAggregation, b3 as NestedAggregationItem, b4 as NestedAggregationItemKindOneOf, bd as NestedAggregationResults, be as NestedAggregationResultsResultOneOf, N as NestedAggregationType, bX as NestedAggregationTypeWithLiterals, bm as NestedResultValue, bn as NestedResultValueResultOneOf, bs as NestedResults, bi as NestedValueAggregationResult, aK as Paging, aN as PagingMetadataV2, L as PaidPlanDetails, a6 as ParticipantAdded, a8 as ParticipantCompletedProgram, ad as ParticipantExportsFinished, ac as ParticipantLeft, ao as ParticipantMigration, a9 as ParticipantMissedProgramDeadline, aa as ParticipantProgramDurationEnded, bK as ParticipantQuerySpec, ab as ParticipantRemoved, bL as ParticipantSearchSpec, a7 as ParticipantTagsModified, bJ as ParticipantsQueryResult, v as PricingType, bN as PricingTypeWithLiterals, T as Progress, w as ProgressStatus, bP as ProgressStatusWithLiterals, aG as QueryParticipantsRequest, aM as QueryParticipantsResponse, aH as QueryV2, aI as QueryV2PagingMethodOneOf, b0 as RangeAggregation, bc as RangeAggregationResult, aY as RangeBucket, bk as RangeResult, bg as RangeResults, a1 as ReindexMessage, a2 as ReindexMessageActionOneOf, at as ReindexParticipantsSearchRequest, au as ReindexParticipantsSearchResponse, R as RequestedFields, bQ as RequestedFieldsWithLiterals, by as RestoreInfo, bo as Results, b1 as ScalarAggregation, bl as ScalarResult, D as ScalarType, bW as ScalarTypeWithLiterals, a5 as Schema, b8 as SearchDetails, aT as SearchParticipantsRequest, K as SinglePaymentDetails, A as SortDirection, bU as SortDirectionWithLiterals, y as SortOrder, bS as SortOrderWithLiterals, z as SortType, bT as SortTypeWithLiterals, aJ as Sorting, av as SynchronizeTimeCapsuleTasksRequest, aw as SynchronizeTimeCapsuleTasksResponse, a0 as TagList, $ as Tags, ag as UpdateParticipantRequest, ah as UpdateParticipantResponse, a3 as Upsert, a_ as ValueAggregation, a$ as ValueAggregationOptionsOneOf, bb as ValueAggregationResult, bj as ValueResult, bf as ValueResults, W as WebhookIdentityType, b$ as WebhookIdentityTypeWithLiterals, bM as utils } from './online-programs-participants-v3-participant-participants.universal-B-mpcshi.mjs';
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { P as Participant, C as CreateParticipantOptions, a as CreateParticipantApplicationErrors, U as UpdateParticipant, b as UpdateParticipantOptions, B as BulkCreateParticipantsOptions, c as BulkCreateParticipantsResponse, d as BulkCreateParticipantsApplicationErrors, e as BulkCreateParticipantsForAllMembersOptions, f as BulkCreateParticipantsForAllMembersResponse, I as IssueCertificateOptions, g as IssueCertificateResponse, h as IssueCertificateApplicationErrors, G as GetPremiumStatsResponse, i as GetParticipantOptions, j as GetAccessStatusResponse, k as BulkUpdateParticipantTagsOptions, l as BulkUpdateParticipantTagsResponse, m as BulkUpdateParticipantTagsApplicationErrors, n as BulkUpdateParticipantTagsByFilterOptions, o as BulkUpdateParticipantTagsByFilterResponse, p as BulkUpdateParticipantTagsByFilterApplicationErrors, q as ParticipantSearch, S as SearchParticipantsOptions, r as SearchParticipantsResponse, s as ParticipantCompletedProgramEnvelope, t as ParticipantCreatedEnvelope, u as ParticipantDeletedEnvelope, v as ParticipantLeftEnvelope, w as ParticipantMissedProgramDeadlineEnvelope, x as ParticipantProgramDurationEndedEnvelope, y as ParticipantRemovedEnvelope, z as ParticipantTagsModifiedEnvelope, A as ParticipantUpdatedEnvelope, D as ParticipantQuery, Q as QueryParticipantsOptions, E as typedQueryParticipants, F as ParticipantsQueryBuilder } from './online-programs-participants-v3-participant-participants.universal-CVjCdKBh.mjs';
+export { bO as AccountInfo, bT as AccountInfoMetadata, bJ as ActionEvent, b2 as Aggregation, bi as AggregationData, b3 as AggregationKindOneOf, bB as AggregationResults, bC as AggregationResultsResultOneOf, bp as AggregationResultsScalarResult, Y as AggregationType, c8 as AggregationTypeWithLiterals, at as ApplicationError, bR as BaseEventMetadata, au as BulkActionMetadata, L as BulkActionType, c0 as BulkActionTypeWithLiterals, aF as BulkCreateParticipantsForAllMembersRequest, aq as BulkCreateParticipantsRequest, ay as BulkParticipantMigrationResult, ar as BulkParticipantResult, a_ as BulkUpdateParticipantTagsByFilterRequest, aY as BulkUpdateParticipantTagsRequest, aZ as BulkUpdateParticipantTagsResult, av as BulkUpsertParticipantsMigrationRequest, ax as BulkUpsertParticipantsMigrationResponse, a3 as CertificateInfo, cb as CommonQueryWithEntityContext, cc as CommonSearchWithEntityContext, am as CreateParticipantRequest, an as CreateParticipantResponse, aT as CursorPaging, bh as CursorPagingMetadata, b0 as CursorSearch, b1 as CursorSearchPagingMethodOneOf, aW as Cursors, ba as DateHistogramAggregation, bx as DateHistogramResult, bz as DateHistogramResults, ad as Delete, az as DeleteAllParticipantsMigrationRequest, aA as DeleteAllParticipantsMigrationResponse, aG as DeleteParticipantRequest, aH as DeleteParticipantResponse, bD as DomainEvent, bE as DomainEventBodyOneOf, bK as Empty, a5 as EnrollmentInfo, a6 as EnrollmentInfoPricingTypeDetailsOneOf, J as EnrollmentStatus, bZ as EnrollmentStatusWithLiterals, bF as EntityCreatedEvent, bI as EntityDeletedEvent, bH as EntityUpdatedEvent, bS as EventMetadata, bP as ExportParticipantsStatsRequest, bQ as ExportParticipantsStatsResponse, a7 as ExtendedFields, a1 as FreeCouponDetails, aX as GetAccessStatusRequest, aJ as GetCompletionStatsRequest, aK as GetCompletionStatsResponse, aM as GetParticipantRequest, aN as GetParticipantResponse, aL as GetPremiumStatsRequest, be as GroupByAggregation, bf as GroupByAggregationKindOneOf, by as GroupByValueResults, bM as IdentificationData, bN as IdentificationDataIdOneOf, b5 as IncludeMissingValuesOptions, X as Interval, c7 as IntervalWithLiterals, aI as IssueCertificateRequest, as as ItemMetadata, a4 as Member, bL as MessageEnvelope, T as MissingValues, c4 as MissingValuesWithLiterals, Z as Mode, c9 as ModeWithLiterals, bd as NestedAggregation, bb as NestedAggregationItem, bc as NestedAggregationItemKindOneOf, bl as NestedAggregationResults, bm as NestedAggregationResultsResultOneOf, W as NestedAggregationType, c6 as NestedAggregationTypeWithLiterals, bu as NestedResultValue, bv as NestedResultValueResultOneOf, bA as NestedResults, bq as NestedValueAggregationResult, aS as Paging, aV as PagingMetadataV2, a0 as PaidPlanDetails, ag as ParticipantCompletedProgram, al as ParticipantExportsFinished, ak as ParticipantLeft, aw as ParticipantMigration, ah as ParticipantMissedProgramDeadline, ai as ParticipantProgramDurationEnded, bV as ParticipantQuerySpec, aj as ParticipantRemoved, bW as ParticipantSearchSpec, af as ParticipantTagsModified, bU as ParticipantsQueryResult, H as PricingType, bY as PricingTypeWithLiterals, a2 as Progress, K as ProgressStatus, b_ as ProgressStatusWithLiterals, aO as QueryParticipantsRequest, aU as QueryParticipantsResponse, aP as QueryV2, aQ as QueryV2PagingMethodOneOf, b8 as RangeAggregation, bk as RangeAggregationResult, b4 as RangeBucket, bs as RangeResult, bo as RangeResults, aa as ReindexMessage, ab as ReindexMessageActionOneOf, aB as ReindexParticipantsSearchRequest, aC as ReindexParticipantsSearchResponse, R as RequestedFields, b$ as RequestedFieldsWithLiterals, bG as RestoreInfo, bw as Results, b9 as ScalarAggregation, bt as ScalarResult, V as ScalarType, c5 as ScalarTypeWithLiterals, ae as Schema, bg as SearchDetails, a$ as SearchParticipantsRequest, $ as SinglePaymentDetails, O as SortDirection, c3 as SortDirectionWithLiterals, M as SortOrder, c1 as SortOrderWithLiterals, N as SortType, c2 as SortTypeWithLiterals, aR as Sorting, aD as SynchronizeTimeCapsuleTasksRequest, aE as SynchronizeTimeCapsuleTasksResponse, a9 as TagList, a8 as Tags, ao as UpdateParticipantRequest, ap as UpdateParticipantResponse, ac as Upsert, b6 as ValueAggregation, b7 as ValueAggregationOptionsOneOf, bj as ValueAggregationResult, br as ValueResult, bn as ValueResults, _ as WebhookIdentityType, ca as WebhookIdentityTypeWithLiterals, bX as utils } from './online-programs-participants-v3-participant-participants.universal-CVjCdKBh.mjs';
 
 declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
 interface CreateParticipantSignature {
@@ -133,6 +133,15 @@ interface SearchParticipantsSignature {
      */
     (search: ParticipantSearch, options?: SearchParticipantsOptions): Promise<NonNullablePaths<SearchParticipantsResponse, `participants` | `participants.${number}.memberId` | `participants.${number}.programId` | `participants.${number}.progress.totalStepsCompleted` | `participants.${number}.progress.totalStepsAvailable` | `participants.${number}.progress.completionPercentage` | `participants.${number}.enrollmentStatus` | `participants.${number}.progressStatus` | `participants.${number}.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participants.${number}.enrollmentInfo.paidPlanDetails.paidPlanId` | `participants.${number}.enrollmentInfo.freeCouponDetails.freeCouponId` | `participants.${number}.enrollmentInfo.timeZone` | `participants.${number}.enrollmentInfo.startDate` | `participants.${number}.enrollmentInfo.pricingType` | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`, 6>>;
 }
+declare const onParticipantCompletedProgram$1: EventDefinition<ParticipantCompletedProgramEnvelope, "wix.online_programs.participants.v3.participant_completed_program">;
+declare const onParticipantCreated$1: EventDefinition<ParticipantCreatedEnvelope, "wix.online_programs.participants.v3.participant_created">;
+declare const onParticipantDeleted$1: EventDefinition<ParticipantDeletedEnvelope, "wix.online_programs.participants.v3.participant_deleted">;
+declare const onParticipantLeft$1: EventDefinition<ParticipantLeftEnvelope, "wix.online_programs.participants.v3.participant_left">;
+declare const onParticipantMissedProgramDeadline$1: EventDefinition<ParticipantMissedProgramDeadlineEnvelope, "wix.online_programs.participants.v3.participant_missed_program_deadline">;
+declare const onParticipantProgramDurationEnded$1: EventDefinition<ParticipantProgramDurationEndedEnvelope, "wix.online_programs.participants.v3.participant_program_duration_ended">;
+declare const onParticipantRemoved$1: EventDefinition<ParticipantRemovedEnvelope, "wix.online_programs.participants.v3.participant_removed">;
+declare const onParticipantTagsModified$1: EventDefinition<ParticipantTagsModifiedEnvelope, "wix.online_programs.participants.v3.participant_tags_modified">;
+declare const onParticipantUpdated$1: EventDefinition<ParticipantUpdatedEnvelope, "wix.online_programs.participants.v3.participant_updated">;
 
 declare function customQueryParticipants(httpClient: HttpClient): {
     (query: ParticipantQuery, options?: QueryParticipantsOptions): ReturnType<typeof typedQueryParticipants>;
@@ -151,5 +160,41 @@ declare const bulkUpdateParticipantTags: MaybeContext<BuildRESTFunction<typeof b
 declare const bulkUpdateParticipantTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateParticipantTagsByFilter$1> & typeof bulkUpdateParticipantTagsByFilter$1>;
 declare const searchParticipants: MaybeContext<BuildRESTFunction<typeof searchParticipants$1> & typeof searchParticipants$1>;
 declare const queryParticipants: MaybeContext<BuildRESTFunction<typeof customQueryParticipants> & typeof customQueryParticipants>;
+/**
+ * Triggered when a participant completes a program.
+ */
+declare const onParticipantCompletedProgram: BuildEventDefinition<typeof onParticipantCompletedProgram$1> & typeof onParticipantCompletedProgram$1;
+/**
+ * Triggered when a participant is created.
+ */
+declare const onParticipantCreated: BuildEventDefinition<typeof onParticipantCreated$1> & typeof onParticipantCreated$1;
+/**
+ * Triggered when a participant is deleted.
+ */
+declare const onParticipantDeleted: BuildEventDefinition<typeof onParticipantDeleted$1> & typeof onParticipantDeleted$1;
+/**
+ * Triggered when a participant voluntarily leaves a program.
+ */
+declare const onParticipantLeft: BuildEventDefinition<typeof onParticipantLeft$1> & typeof onParticipantLeft$1;
+/**
+ * Triggered when a participant misses a program deadline.
+ */
+declare const onParticipantMissedProgramDeadline: BuildEventDefinition<typeof onParticipantMissedProgramDeadline$1> & typeof onParticipantMissedProgramDeadline$1;
+/**
+ * Triggered when a participant's program duration ends.
+ */
+declare const onParticipantProgramDurationEnded: BuildEventDefinition<typeof onParticipantProgramDurationEnded$1> & typeof onParticipantProgramDurationEnded$1;
+/**
+ * Triggered when an administrator removes a participant from a program.
+ */
+declare const onParticipantRemoved: BuildEventDefinition<typeof onParticipantRemoved$1> & typeof onParticipantRemoved$1;
+/**
+ * Triggered when a participant's tags are modified.
+ */
+declare const onParticipantTagsModified: BuildEventDefinition<typeof onParticipantTagsModified$1> & typeof onParticipantTagsModified$1;
+/**
+ * Triggered when a participant is updated.
+ */
+declare const onParticipantUpdated: BuildEventDefinition<typeof onParticipantUpdated$1> & typeof onParticipantUpdated$1;
 
-export { BulkCreateParticipantsApplicationErrors, BulkCreateParticipantsForAllMembersOptions, BulkCreateParticipantsForAllMembersResponse, BulkCreateParticipantsOptions, BulkCreateParticipantsResponse, BulkUpdateParticipantTagsApplicationErrors, BulkUpdateParticipantTagsByFilterApplicationErrors, BulkUpdateParticipantTagsByFilterOptions, BulkUpdateParticipantTagsByFilterResponse, BulkUpdateParticipantTagsOptions, BulkUpdateParticipantTagsResponse, CreateParticipantApplicationErrors, CreateParticipantOptions, GetAccessStatusResponse, GetParticipantOptions, GetPremiumStatsResponse, IssueCertificateApplicationErrors, IssueCertificateOptions, IssueCertificateResponse, Participant, ParticipantQuery, ParticipantSearch, ParticipantsQueryBuilder, QueryParticipantsOptions, SearchParticipantsOptions, SearchParticipantsResponse, UpdateParticipant, UpdateParticipantOptions, bulkCreateParticipants, bulkCreateParticipantsForAllMembers, bulkUpdateParticipantTags, bulkUpdateParticipantTagsByFilter, createParticipant, deleteParticipant, getAccessStatus, getParticipant, getPremiumStats, issueCertificate, queryParticipants, searchParticipants, updateParticipant };
+export { BulkCreateParticipantsApplicationErrors, BulkCreateParticipantsForAllMembersOptions, BulkCreateParticipantsForAllMembersResponse, BulkCreateParticipantsOptions, BulkCreateParticipantsResponse, BulkUpdateParticipantTagsApplicationErrors, BulkUpdateParticipantTagsByFilterApplicationErrors, BulkUpdateParticipantTagsByFilterOptions, BulkUpdateParticipantTagsByFilterResponse, BulkUpdateParticipantTagsOptions, BulkUpdateParticipantTagsResponse, CreateParticipantApplicationErrors, CreateParticipantOptions, GetAccessStatusResponse, GetParticipantOptions, GetPremiumStatsResponse, IssueCertificateApplicationErrors, IssueCertificateOptions, IssueCertificateResponse, Participant, ParticipantCompletedProgramEnvelope, ParticipantCreatedEnvelope, ParticipantDeletedEnvelope, ParticipantLeftEnvelope, ParticipantMissedProgramDeadlineEnvelope, ParticipantProgramDurationEndedEnvelope, ParticipantQuery, ParticipantRemovedEnvelope, ParticipantSearch, ParticipantTagsModifiedEnvelope, ParticipantUpdatedEnvelope, ParticipantsQueryBuilder, QueryParticipantsOptions, SearchParticipantsOptions, SearchParticipantsResponse, UpdateParticipant, UpdateParticipantOptions, bulkCreateParticipants, bulkCreateParticipantsForAllMembers, bulkUpdateParticipantTags, bulkUpdateParticipantTagsByFilter, createParticipant, deleteParticipant, getAccessStatus, getParticipant, getPremiumStats, issueCertificate, onParticipantCompletedProgram, onParticipantCreated, onParticipantDeleted, onParticipantLeft, onParticipantMissedProgramDeadline, onParticipantProgramDurationEnded, onParticipantRemoved, onParticipantTagsModified, onParticipantUpdated, queryParticipants, searchParticipants, updateParticipant };