@wix/auto_sdk_online-programs_participants 1.0.13 → 1.0.15

package/build/internal/es/online-programs-participants-v3-participant-participants.universal-Cicta6rs.d.mts

@@ -0,0 +1,2311 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, SearchSpec, Query, Search, NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * Participant entity represents a site member who takes part in a specific Online Program.
+ * Participants have access to the program's content and progress through the program by completing its steps.
+ * A participant can join through a join application flow or be manually added by the program owner.
+ * A participant's status depends on their progress and the program's settings (e.g., start and end dates). Participation may also be temporarily suspended.
+ */
+interface Participant {
+    /**
+     * Participant ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Participant revision (for optimistic concurrency control).
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Participant creation date.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date the participant was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Member ID of the participant on the site.
+     * @format GUID
+     * @readonly
+     */
+    memberId?: string;
+    /**
+     * ID of the program the participant is enrolled in.
+     * @format GUID
+     * @readonly
+     */
+    programId?: string;
+    /**
+     * Program completion progress. This field is conditional and must be explicitly requested via `fields` parameter.
+     * @readonly
+     */
+    progress?: Progress;
+    /**
+     * Certificate info for participant
+     * @readonly
+     */
+    certificateInfo?: CertificateInfo;
+    /**
+     * Site member info snapshot for the participant
+     * @readonly
+     */
+    member?: Member;
+    /**
+     * Last activity date of the participant in the program (can either be status change or step resolution).
+     * @readonly
+     */
+    lastActivityDate?: Date | null;
+    /**
+     * Participant's enrollment status in the program.
+     * @readonly
+     */
+    enrollmentStatus?: EnrollmentStatusWithLiterals;
+    /**
+     * Participant's progress status in the program.
+     * @readonly
+     */
+    progressStatus?: ProgressStatusWithLiterals;
+    /** Additional information about the participant's enrollment and completion timeframe in the program. */
+    enrollmentInfo?: EnrollmentInfo;
+    /** Extended fields for participant (can be used for storing custom data). */
+    extendedFields?: ExtendedFields;
+    /** Tags for categorizing and organizing participants. */
+    tags?: Tags;
+}
+declare enum PricingType {
+    /** Member joined a program that is configured as free to join, with no payment required. */
+    FREE = "FREE",
+    /** Member was added to the program by site owner. */
+    ADDED_MANUALLY = "ADDED_MANUALLY",
+    /** Member paid once to join the program. */
+    SINGLE_PAYMENT = "SINGLE_PAYMENT",
+    /** Member joined using a Pricing Plan. */
+    PAID_PLAN = "PAID_PLAN",
+    /** Member joined a paid program using a coupon that provided 100% discount. */
+    FREE_COUPON = "FREE_COUPON"
+}
+/** @enumType */
+type PricingTypeWithLiterals = PricingType | 'FREE' | 'ADDED_MANUALLY' | 'SINGLE_PAYMENT' | 'PAID_PLAN' | 'FREE_COUPON';
+interface SinglePaymentDetails {
+    /**
+     * ID of the cashier order which was used to pay for joining the program.
+     * @format GUID
+     * @immutable
+     */
+    paymentOrderId?: string;
+    /**
+     * ID of the offline transaction if the participant used an offline payment method (e.g., cash, check). Null if online payment was used.
+     * @format GUID
+     * @immutable
+     */
+    offlineTransactionId?: string | null;
+}
+interface PaidPlanDetails {
+    /**
+     * ID of the Paid Plan for which member has paid to join the program.
+     * @format GUID
+     * @immutable
+     */
+    paidPlanId?: string;
+}
+interface FreeCouponDetails {
+    /**
+     * ID of the coupon which was applied and gave 100% discount to join the program for free.
+     * @format GUID
+     * @immutable
+     */
+    freeCouponId?: string;
+}
+interface Progress {
+    /** Number of program steps completed by member. */
+    totalStepsCompleted?: number;
+    /** Total number of program steps available to resolve. */
+    totalStepsAvailable?: number;
+    /**
+     * Participant's completion percentage. For completed participants, this is 100.0. Otherwise, it is calculated as
+     * (total_steps_completed / total_steps_available) * 100, capped at 100, and rounded to 1 decimal place.
+     * @max 100
+     */
+    completionPercentage?: number;
+}
+interface CertificateInfo {
+    /**
+     * Date when the certificate was issued (UTC).
+     * @readonly
+     */
+    issueDate?: Date | null;
+}
+interface Member {
+    /**
+     * First name of the site member. Null if the member has not provided this information in their profile.
+     * @readonly
+     * @maxLength 1000
+     */
+    firstName?: string | null;
+    /**
+     * Last name of the site member. Null if the member has not provided this information in their profile.
+     * @readonly
+     * @maxLength 1000
+     */
+    lastName?: string | null;
+    /**
+     * Email of the site member. Null if the member has not provided this information in their profile.
+     * @readonly
+     * @format EMAIL
+     */
+    email?: string | null;
+    /**
+     * Contact ID for accessing additional member information via the Contacts API. Use this to retrieve extended contact details like phone numbers, addresses, and custom fields. Null if the member has not provided this information in their profile.
+     * @format GUID
+     * @readonly
+     */
+    contactId?: string | null;
+    /**
+     * Member nickname. Null if the member has not provided this information in their profile.
+     * @readonly
+     * @maxLength 1000
+     */
+    nickname?: string | null;
+    /**
+     * Profile image URL of the site member.
+     * @readonly
+     * @format WEB_URL
+     */
+    profileImageUrl?: string | null;
+}
+declare enum EnrollmentStatus {
+    /** Participant is actively enrolled in the program. */
+    JOINED = "JOINED",
+    /** Enrollment temporarily suspended due to payment issues. */
+    SUSPENDED = "SUSPENDED",
+    /** Automatically removed via a Wix Automations workflow. */
+    AUTO_REMOVED = "AUTO_REMOVED",
+    /** Removed from the program by the site owner. */
+    REMOVED = "REMOVED",
+    /** Participant voluntarily left the program. */
+    LEFT = "LEFT"
+}
+/** @enumType */
+type EnrollmentStatusWithLiterals = EnrollmentStatus | 'JOINED' | 'SUSPENDED' | 'AUTO_REMOVED' | 'REMOVED' | 'LEFT';
+declare enum ProgressStatus {
+    /** Enrolled but no steps completed yet. */
+    NOT_STARTED = "NOT_STARTED",
+    /** At least one step completed but program not yet finished. */
+    IN_PROGRESS = "IN_PROGRESS",
+    /** Participant successfully completed the program. */
+    COMPLETED = "COMPLETED",
+    /** Participant failed to complete the program within the deadline. */
+    FAILED = "FAILED",
+    /** Progress tracking is not applicable — participant left, was removed, or was auto-removed. */
+    NOT_APPLICABLE = "NOT_APPLICABLE"
+}
+/** @enumType */
+type ProgressStatusWithLiterals = ProgressStatus | 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'NOT_APPLICABLE';
+interface EnrollmentInfo extends EnrollmentInfoPricingTypeDetailsOneOf {
+    /** Details about a Single Payment enrollment. */
+    singlePaymentDetails?: SinglePaymentDetails;
+    /** Details about a Paid Plan enrollment. */
+    paidPlanDetails?: PaidPlanDetails;
+    /** Details about a Free Coupon enrollment. */
+    freeCouponDetails?: FreeCouponDetails;
+    /**
+     * Time zone of the site when the participant was enrolled in the program, in IANA timezone format (e.g., "America/New_York").
+     * @maxLength 50
+     * @readonly
+     */
+    timeZone?: string;
+    /**
+     * Date when the participant starts the program. Equals the participant's `created_date` if the program has no configured start date; otherwise, equals the program's start date if the participant enrolled before it began.
+     * @format LOCAL_DATE
+     * @readonly
+     */
+    startDate?: string;
+    /** Pricing type used for the participant's enrollment in the program. */
+    pricingType?: PricingTypeWithLiterals;
+    /**
+     * Date by which the participant must complete the program. Null if the program has no deadline. Set if the program has a fixed end date or a duration-based deadline calculated from the participant's start date.
+     * @format LOCAL_DATE
+     * @readonly
+     */
+    deadline?: string | null;
+}
+/** @oneof */
+interface EnrollmentInfoPricingTypeDetailsOneOf {
+    /** Details about a Single Payment enrollment. */
+    singlePaymentDetails?: SinglePaymentDetails;
+    /** Details about a Paid Plan enrollment. */
+    paidPlanDetails?: PaidPlanDetails;
+    /** Details about a Free Coupon enrollment. */
+    freeCouponDetails?: FreeCouponDetails;
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * public_tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+interface Tags {
+    /** Tags that require an additional permission in order to access them, typically restricted from site members and visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone with access to the entity, including site members and visitors. */
+    publicTags?: TagList;
+}
+interface TagList {
+    /**
+     * List of tag IDs.
+     * @maxSize 100
+     * @maxLength 5
+     */
+    tagIds?: string[];
+}
+/**
+ * Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
+ * performs context manipulation with adding tenant, provided in message to callscope.
+ */
+interface ReindexMessage extends ReindexMessageActionOneOf {
+    upsert?: Upsert;
+    delete?: Delete;
+    entityFqdn?: string;
+    tenantId?: string;
+    eventTime?: Date | null;
+    entityEventSequence?: string | null;
+    schema?: Schema;
+}
+/** @oneof */
+interface ReindexMessageActionOneOf {
+    upsert?: Upsert;
+    delete?: Delete;
+}
+interface Upsert {
+    entityId?: string;
+    entityAsJson?: string;
+}
+interface Delete {
+    entityId?: string;
+}
+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.
+ */
+interface ParticipantTagsModified {
+    /** The Participant with updated tags */
+    participant?: Participant;
+    /** Tags that were assigned */
+    assignedTags?: Tags;
+    /** Tags that were unassigned */
+    unassignedTags?: Tags;
+}
+interface ParticipantCompletedProgram {
+    /**
+     * ID of the participant who completed the program.
+     * @format GUID
+     */
+    participantId?: string;
+    /**
+     * ID of the program which was completed.
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Member ID of the participant who completed the program.
+     * @format GUID
+     */
+    memberId?: string;
+}
+interface ParticipantMissedProgramDeadline {
+    /**
+     * ID of the participant who missed the deadline.
+     * @format GUID
+     */
+    participantId?: string;
+    /**
+     * ID of the program for which the deadline was missed.
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Member ID of the participant who missed the deadline.
+     * @format GUID
+     */
+    memberId?: string;
+}
+interface ParticipantProgramDurationEnded {
+    /**
+     * ID of the participant whose program duration ended.
+     * @format GUID
+     */
+    participantId?: string;
+    /**
+     * ID of the program whose duration ended for the participant.
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Member ID of the participant whose program duration ended.
+     * @format GUID
+     */
+    memberId?: string;
+}
+/** Domain event emitted when a participant is removed from a program by an administrator. */
+interface ParticipantRemoved {
+    /**
+     * ID of the participant who was removed.
+     * @format GUID
+     */
+    participantId?: string;
+    /**
+     * ID of the program from which the participant was removed.
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Member ID of the participant who was removed.
+     * @format GUID
+     */
+    memberId?: string;
+}
+/** Domain event emitted when a participant voluntarily leaves a program. */
+interface ParticipantLeft {
+    /**
+     * ID of the participant who left the program.
+     * @format GUID
+     */
+    participantId?: string;
+    /**
+     * ID of the program the participant left.
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Member ID of the participant who left.
+     * @format GUID
+     */
+    memberId?: string;
+}
+interface ParticipantExportsFinished {
+    /**
+     * program id from which stats were exported
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * url to download report
+     * @format WEB_URL
+     */
+    downloadUrl?: string;
+    /** days url will be downloadable */
+    downloadUrlTtlDays?: number;
+}
+interface CreateParticipantRequest {
+    /** Participant to create */
+    participant: Participant;
+    /**
+     * Array of conditional fields to include in the response.
+     * Use `RequestedFields.PROGRESS` to include the progress field, which requires calculating completion statistics across all program steps. Only request this field when you need current progress data, as it impacts performance.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Enum for specifying which conditional fields to include in responses.
+ * Use these values in the `fields` parameter to request expensive or conditional fields.
+ */
+declare enum RequestedFields {
+    /** Request the progress field to be calculated and included in the response. */
+    PROGRESS = "PROGRESS"
+}
+/** @enumType */
+type RequestedFieldsWithLiterals = RequestedFields | 'PROGRESS';
+interface CreateParticipantResponse {
+    /** Created participant */
+    participant?: Participant;
+}
+interface UpdateParticipantRequest {
+    /** Participant to update. Must include the participant ID. */
+    participant: Participant;
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+    /**
+     * Optional explicit field mask. If omitted, the API infers it from writable fields in `participant`.
+     * @internal
+     */
+    fieldMask?: string[];
+}
+interface UpdateParticipantResponse {
+    /** Updated participant */
+    participant?: Participant;
+}
+interface BulkCreateParticipantsRequest {
+    /**
+     * List of participants to create.
+     * @minSize 1
+     * @maxSize 100
+     */
+    participants: Participant[];
+    /** Whether to return entities in response or not. */
+    returnEntity?: boolean;
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface BulkCreateParticipantsResponse {
+    /**
+     * Results of the bulk create operation.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkParticipantResult[];
+    /** Metadata about the bulk action. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkParticipantResult {
+    /** Metadata for the item. */
+    itemMetadata?: ItemMetadata;
+    /** The participant entity. Empty if `return_entity` is `false`. */
+    item?: Participant;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface BulkUpsertParticipantsMigrationRequest {
+    /**
+     * List of participants to create or update.
+     * @minSize 1
+     * @maxSize 100
+     */
+    participants?: ParticipantMigration[];
+}
+interface ParticipantMigration {
+    /** Participant to create or update. */
+    participant?: Participant;
+    /**
+     * Resolved step IDs to restore on participant.
+     * @maxSize 5000
+     * @format GUID
+     */
+    resolvedStepIds?: string[];
+}
+interface BulkUpsertParticipantsMigrationResponse {
+    /**
+     * Results of the bulk migration operation.
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkParticipantMigrationResult[];
+    /** Metadata about the bulk action. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkParticipantMigrationResult {
+    /** Metadata for the item. */
+    itemMetadata?: ItemMetadata;
+    /** Action type of bulk action (INSERT OR UPDATE) for that endpoint. */
+    action?: BulkActionTypeWithLiterals;
+}
+declare enum BulkActionType {
+    /** default action type, should never be used */
+    UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
+    /** Action type for inserting new items. */
+    INSERT = "INSERT",
+    /** Action type for updating existing items. */
+    UPDATE = "UPDATE"
+}
+/** @enumType */
+type BulkActionTypeWithLiterals = BulkActionType | 'UNKNOWN_ACTION_TYPE' | 'INSERT' | 'UPDATE';
+interface DeleteAllParticipantsMigrationRequest {
+}
+interface DeleteAllParticipantsMigrationResponse {
+}
+interface ReindexParticipantsSearchRequest {
+    /**
+     * @minSize 1
+     * @maxSize 1000
+     * @format GUID
+     */
+    participantIds?: string[];
+}
+interface ReindexParticipantsSearchResponse {
+}
+interface SynchronizeTimeCapsuleTasksRequest {
+    /**
+     * Metasite whose participant finish tasks should be synchronized.
+     * @format GUID
+     */
+    metaSiteId?: string;
+}
+interface SynchronizeTimeCapsuleTasksResponse {
+    /**
+     * ID of the asynchronous job that will process the request. Pass this ID to Get Async Job to track the operation status.
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface BulkCreateParticipantsForAllMembersRequest {
+    /**
+     * ID of the program for which to create participants for all site members in bulk.
+     * @format GUID
+     */
+    programId: string;
+    /**
+     * Site member IDs to exclude from bulk participant creation. Maximum 100 member IDs can be excluded.
+     * @format GUID
+     * @maxSize 100
+     */
+    excludeMemberIds?: string[];
+}
+interface BulkCreateParticipantsForAllMembersResponse {
+    /**
+     * ID of the asynchronous job that will process the request. Pass this ID to Get Async Job to track the operation status.
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface DeleteParticipantRequest {
+    /**
+     * ID of the participant to delete.
+     * @format GUID
+     */
+    participantId: string;
+}
+interface DeleteParticipantResponse {
+}
+interface IssueCertificateRequest {
+    /**
+     * ID of the participant to issue the certificate to.
+     * @format GUID
+     */
+    participantId: string;
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface IssueCertificateResponse {
+    /** Updated participant */
+    participant?: Participant;
+}
+interface GetCompletionStatsRequest {
+    /**
+     * ID of the program to retrieve completion statistics for.
+     * @format GUID
+     */
+    programId?: string;
+}
+interface GetCompletionStatsResponse {
+    /** Number of participants that completed the program */
+    completedParticipantsCount?: number;
+    /** Percentage of participants that completed the program */
+    completionRate?: number;
+}
+interface GetPremiumStatsRequest {
+}
+interface GetPremiumStatsResponse {
+    /** True if site has Online Programs premium feature */
+    premiumEnabled?: boolean;
+    /** Count of active participants on the site */
+    activeParticipantsCount?: number;
+    /** Limit of active participants on a site without premium */
+    activeParticipantsLimit?: number;
+}
+interface GetParticipantRequest {
+    /**
+     * ID of the participant to fetch.
+     * @format GUID
+     */
+    participantId: string;
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface GetParticipantResponse {
+    /** The retrieved participant. */
+    participant?: Participant;
+}
+interface QueryParticipantsRequest {
+    /** Platformized query */
+    query?: QueryV2;
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     * @maxSize 100
+     */
+    sort?: Sorting[];
+    /**
+     * Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
+     * @maxSize 100
+     * @maxLength 1000
+     */
+    fields?: string[];
+    /**
+     * Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
+     * @maxSize 100
+     * @maxLength 1000
+     */
+    fieldsets?: string[];
+}
+/** @oneof */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryParticipantsResponse {
+    /** List of participants matching the query. */
+    participants?: Participant[];
+    /** Paging metadata. */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     * @internal
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface GetAccessStatusRequest {
+}
+interface GetAccessStatusResponse {
+    /** True if participants cannot access online programs due to some limitations */
+    accessBlocked?: boolean;
+}
+interface BulkUpdateParticipantTagsRequest {
+    /**
+     * Participant IDs to update tags for (1-100 items)
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
+     */
+    participantIds: string[];
+    /** Tags to assign to the Participants */
+    assignTags?: Tags;
+    /** Tags to unassign from the Participants */
+    unassignTags?: Tags;
+}
+interface BulkUpdateParticipantTagsResponse {
+    /**
+     * Results for each Participant
+     * @minSize 1
+     * @maxSize 100
+     */
+    results?: BulkUpdateParticipantTagsResult[];
+    /** Metadata about the bulk operation */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkUpdateParticipantTagsResult {
+    /** Metadata for this specific item */
+    itemMetadata?: ItemMetadata;
+}
+interface BulkUpdateParticipantTagsByFilterRequest {
+    /** WQL filter to select Participants */
+    filter: Record<string, any> | null;
+    /** Tags to assign to matching Participants */
+    assignTags?: Tags;
+    /** Tags to unassign from matching Participants */
+    unassignTags?: Tags;
+}
+interface BulkUpdateParticipantTagsByFilterResponse {
+    /**
+     * Job ID for tracking the async operation. Pass this ID to Get Async Job to track the operation status.
+     * @format GUID
+     */
+    jobId?: string;
+}
+interface SearchParticipantsRequest {
+    /** Query to search participants. */
+    search?: CursorSearch;
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface CursorSearch extends CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * List of sort objects.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     * @maxSize 10
+     */
+    sort?: Sorting[];
+    /**
+     * Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories.
+     * @maxSize 10
+     */
+    aggregations?: Aggregation[];
+    /** Free text to match in searchable fields. */
+    search?: SearchDetails;
+    /**
+     * Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format.
+     * Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z".
+     * @maxLength 50
+     */
+    timeZone?: string | null;
+}
+/** @oneof */
+interface CursorSearchPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Aggregation extends AggregationKindOneOf {
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
+    dateHistogram?: DateHistogramAggregation;
+    /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
+    nested?: NestedAggregation;
+    /**
+     * Aggregation name, returned in `aggregations.results.name`.
+     * @maxLength 100
+     */
+    name?: string | null;
+    /** Type of aggregation to perform. Must align with the corresponding aggregation field. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+    /**
+     * Deprecated. Use `nested` instead.
+     * @deprecated Deprecated. Use `nested` instead.
+     * @replacedBy kind.nested
+     * @targetRemovalDate 2024-03-30
+     */
+    groupBy?: GroupByAggregation;
+}
+/** @oneof */
+interface AggregationKindOneOf {
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
+    dateHistogram?: DateHistogramAggregation;
+    /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
+    nested?: NestedAggregation;
+}
+interface RangeBucket {
+    /** Inclusive lower bound of the range. Required if `to` is not provided. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. Required if `from` is not provided. */
+    to?: number | null;
+}
+declare enum SortType {
+    /** Number of matches in the results. */
+    COUNT = "COUNT",
+    /** Alphabetically by the field value. */
+    VALUE = "VALUE"
+}
+/** @enumType */
+type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
+declare enum SortDirection {
+    /** Descending order. */
+    DESC = "DESC",
+    /** Ascending order. */
+    ASC = "ASC"
+}
+/** @enumType */
+type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
+declare enum MissingValues {
+    /** Exclude missing values from the aggregation results. */
+    EXCLUDE = "EXCLUDE",
+    /** Include missing values in the aggregation results. */
+    INCLUDE = "INCLUDE"
+}
+/** @enumType */
+type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
+interface IncludeMissingValuesOptions {
+    /**
+     * Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans.
+     * @maxLength 20
+     */
+    addToBucket?: string;
+}
+declare enum ScalarType {
+    /** Total number of distinct values. */
+    COUNT_DISTINCT = "COUNT_DISTINCT",
+    /** Minimum value. */
+    MIN = "MIN",
+    /** Maximum value. */
+    MAX = "MAX",
+    /**
+     * Sum of values.
+     * @internal
+     */
+    SUM = "SUM",
+    /**
+     * Average of values.
+     * @internal
+     */
+    AVG = "AVG"
+}
+/** @enumType */
+type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
+interface ValueAggregation extends ValueAggregationOptionsOneOf {
+    /** Options for including missing values in results. */
+    includeOptions?: IncludeMissingValuesOptions;
+    /** Sort type. */
+    sortType?: SortTypeWithLiterals;
+    /** Sort direction. */
+    sortDirection?: SortDirectionWithLiterals;
+    /**
+     * Number of aggregation results to return.
+     * Min: `1`
+     * Max: `250`
+     * Default: `10`
+     */
+    limit?: number | null;
+    /**
+     * Whether to include or exclude missing values in the aggregation results.
+     * Default: `EXCLUDE`.
+     */
+    missingValues?: MissingValuesWithLiterals;
+}
+/** @oneof */
+interface ValueAggregationOptionsOneOf {
+    /** Options for including missing values in results. */
+    includeOptions?: IncludeMissingValuesOptions;
+}
+declare enum NestedAggregationType {
+    /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
+    VALUE = "VALUE",
+    /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
+    RANGE = "RANGE",
+    /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    SCALAR = "SCALAR",
+    /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM"
+}
+/** @enumType */
+type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
+interface RangeAggregation {
+    /**
+     * List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds.
+     * @maxSize 50
+     */
+    buckets?: RangeBucket[];
+}
+interface ScalarAggregation {
+    /** Operator type for the scalar aggregation. */
+    type?: ScalarTypeWithLiterals;
+}
+interface DateHistogramAggregation {
+    /** Interval for date histogram aggregation. */
+    interval?: IntervalWithLiterals;
+}
+declare enum Interval {
+    YEAR = "YEAR",
+    MONTH = "MONTH",
+    WEEK = "WEEK",
+    DAY = "DAY",
+    HOUR = "HOUR",
+    MINUTE = "MINUTE",
+    SECOND = "SECOND"
+}
+/** @enumType */
+type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
+interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
+    /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
+    dateHistogram?: DateHistogramAggregation;
+    /**
+     * Unique, caller-defined aggregation name, returned in `aggregations.results`.
+     * @maxLength 100
+     */
+    name?: string | null;
+    /** Type of aggregation to perform. The matching aggregation field must be passed. */
+    type?: NestedAggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface NestedAggregationItemKindOneOf {
+    /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
+    value?: ValueAggregation;
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
+    range?: RangeAggregation;
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    scalar?: ScalarAggregation;
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
+    dateHistogram?: DateHistogramAggregation;
+}
+declare enum AggregationType {
+    /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
+    VALUE = "VALUE",
+    /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
+    RANGE = "RANGE",
+    /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
+    SCALAR = "SCALAR",
+    /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
+    DATE_HISTOGRAM = "DATE_HISTOGRAM",
+    /** Flattened list of aggregations, where each aggregation is nested within previous one. */
+    NESTED = "NESTED"
+}
+/** @enumType */
+type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
+/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
+interface NestedAggregation {
+    /**
+     * Flattened list of aggregations, where each aggregation is nested within previous one.
+     * @minSize 2
+     * @maxSize 3
+     */
+    nestedAggregations?: NestedAggregationItem[];
+}
+interface GroupByAggregation extends GroupByAggregationKindOneOf {
+    /** Value aggregation configuration. */
+    value?: ValueAggregation;
+    /**
+     * Unique, caller-defined aggregation name, returned in `aggregations.results`.
+     * @maxLength 100
+     */
+    name?: string | null;
+    /**
+     * Field to aggregate by.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface GroupByAggregationKindOneOf {
+    /** Value aggregation configuration. */
+    value?: ValueAggregation;
+}
+interface SearchDetails {
+    /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
+    mode?: ModeWithLiterals;
+    /**
+     * Search term or expression.
+     * @maxLength 100
+     */
+    expression?: string | null;
+    /**
+     * Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
+     * @maxLength 200
+     * @maxSize 20
+     */
+    fields?: string[];
+    /** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */
+    fuzzy?: boolean;
+}
+declare enum Mode {
+    /** At least one of the search terms must be present. */
+    OR = "OR",
+    /** All search terms must be present. */
+    AND = "AND"
+}
+/** @enumType */
+type ModeWithLiterals = Mode | 'OR' | 'AND';
+interface SearchParticipantsResponse {
+    /** Participants matching the search criteria. */
+    participants?: Participant[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+    /** Aggregation data in case aggregations were requested. */
+    aggregationData?: AggregationData;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+    /**
+     * Total number of items matching the filter.
+     * Available only on the first page of *Search* results, not included in *Query* or *List* results.
+     * If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.
+     * @internal
+     */
+    total?: number | null;
+}
+interface AggregationData {
+    /**
+     * key = aggregation name (as derived from search request).
+     * @maxSize 10000
+     */
+    results?: AggregationResults[];
+}
+interface ValueAggregationResult {
+    /**
+     * Value of the field.
+     * @maxLength 100
+     */
+    value?: string;
+    /** Count of entities with this value. */
+    count?: number;
+}
+interface RangeAggregationResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Count of entities in this range. */
+    count?: number;
+}
+interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /**
+     * User-defined name of aggregation, matches the one provided in request.
+     * @maxLength 100
+     */
+    name?: string;
+    /** Type of aggregation that matches result. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by, matches the one provided in request.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface NestedAggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+}
+interface ValueResults {
+    /**
+     * List of value aggregations.
+     * @maxSize 250
+     */
+    results?: ValueAggregationResult[];
+}
+interface RangeResults {
+    /**
+     * List of ranges returned in same order as requested.
+     * @maxSize 50
+     */
+    results?: RangeAggregationResult[];
+}
+interface AggregationResultsScalarResult {
+    /** Type of scalar aggregation. */
+    type?: ScalarTypeWithLiterals;
+    /** Value of the scalar aggregation. */
+    value?: number;
+}
+interface NestedValueAggregationResult {
+    /**
+     * Value of the field.
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Nested aggregations. */
+    nestedResults?: NestedAggregationResults;
+}
+interface ValueResult {
+    /**
+     * Value of the field.
+     * @maxLength 1000
+     */
+    value?: string;
+    /** Count of entities with this value. */
+    count?: number | null;
+}
+interface RangeResult {
+    /** Inclusive lower bound of the range. */
+    from?: number | null;
+    /** Exclusive upper bound of the range. */
+    to?: number | null;
+    /** Count of entities in this range. */
+    count?: number | null;
+}
+interface ScalarResult {
+    /** Value of the scalar aggregation. */
+    value?: number;
+}
+interface NestedResultValue extends NestedResultValueResultOneOf {
+    /** Value aggregation result. */
+    value?: ValueResult;
+    /** Range aggregation result. */
+    range?: RangeResult;
+    /** Scalar aggregation result. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result. */
+    dateHistogram?: ValueResult;
+}
+/** @oneof */
+interface NestedResultValueResultOneOf {
+    /** Value aggregation result. */
+    value?: ValueResult;
+    /** Range aggregation result. */
+    range?: RangeResult;
+    /** Scalar aggregation result. */
+    scalar?: ScalarResult;
+    /** Date histogram aggregation result. */
+    dateHistogram?: ValueResult;
+}
+interface Results {
+    /** List of nested aggregations. */
+    results?: Record<string, NestedResultValue>;
+}
+interface DateHistogramResult {
+    /**
+     * Date in ISO 8601 format.
+     * @maxLength 100
+     */
+    value?: string;
+    /** Count of documents in the bucket. */
+    count?: number;
+}
+interface GroupByValueResults {
+    /**
+     * List of value aggregations.
+     * @maxSize 1000
+     */
+    results?: NestedValueAggregationResult[];
+}
+interface DateHistogramResults {
+    /**
+     * List of date histogram aggregations.
+     * @maxSize 200
+     */
+    results?: DateHistogramResult[];
+}
+/**
+ * Results of `NESTED` aggregation type in a flattened form.
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
+ */
+interface NestedResults {
+    /**
+     * List of nested aggregations.
+     * @maxSize 1000
+     */
+    results?: Results[];
+}
+interface AggregationResults extends AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** Group by value aggregation results. */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+    /**
+     * User-defined name of aggregation as derived from search request.
+     * @maxLength 100
+     */
+    name?: string;
+    /** Type of aggregation that must match provided kind as derived from search request. */
+    type?: AggregationTypeWithLiterals;
+    /**
+     * Field to aggregate by as derived from search request.
+     * @maxLength 200
+     */
+    fieldPath?: string;
+}
+/** @oneof */
+interface AggregationResultsResultOneOf {
+    /** Value aggregation results. */
+    values?: ValueResults;
+    /** Range aggregation results. */
+    ranges?: RangeResults;
+    /** Scalar aggregation results. */
+    scalar?: AggregationResultsScalarResult;
+    /** Group by value aggregation results. */
+    groupedByValue?: GroupByValueResults;
+    /** Date histogram aggregation results. */
+    dateHistogram?: DateHistogramResults;
+    /** Nested aggregation results. */
+    nested?: NestedResults;
+}
+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 {
+    entity?: string;
+}
+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.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+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;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+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';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+interface ExportParticipantsStatsRequest {
+    /**
+     * program id to export data from
+     * @format GUID
+     */
+    programId: string;
+}
+interface ExportParticipantsStatsResponse {
+}
+/** @docsIgnore */
+type CreateParticipantApplicationErrors = {
+    code?: 'PREMIUM_PLAN_REQUIRED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PARTICIPANTS_LIMIT_EXCEEDED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkCreateParticipantsApplicationErrors = {
+    code?: 'MULTIPLE_PROGRAM_IDS_IN_BULK_CREATE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PREMIUM_PLAN_REQUIRED';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PARTICIPANTS_LIMIT_EXCEEDED';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type IssueCertificateApplicationErrors = {
+    code?: 'PARTICIPANT_NOT_ACTIVE';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'NO_CERTIFICATE_REWARD';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'PARTICIPANT_NOT_COMPLETED_PROGRAM';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdateParticipantTagsApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkUpdateParticipantTagsByFilterApplicationErrors = {
+    code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Creates a participant.
+ *
+ * Returns an error if the member is already a participant in the specified program.
+ * Use UpdateParticipant to modify existing participants.
+ * @param participant - Participant to create
+ * @public
+ * @documentationMaturity preview
+ * @requiredField participant
+ * @requiredField participant.enrollmentInfo
+ * @requiredField participant.enrollmentInfo.pricingType
+ * @requiredField participant.memberId
+ * @requiredField participant.programId
+ * @permissionId online_programs:participants:v3:participant:create_participant
+ * @applicableIdentity APP
+ * @returns Created participant
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.CreateParticipant
+ */
+declare function createParticipant(participant: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`, 3>, options?: CreateParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 4> & {
+    __applicationErrorsType?: CreateParticipantApplicationErrors;
+}>;
+interface CreateParticipantOptions {
+    /**
+     * Array of conditional fields to include in the response.
+     * Use `RequestedFields.PROGRESS` to include the progress field, which requires calculating completion statistics across all program steps. Only request this field when you need current progress data, as it impacts performance.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Updates a participant's enrollment status, progress status, or enrollment pricing details.
+ * @param _id - Participant ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField participant
+ * @requiredField participant.revision
+ * @permissionId online_programs:participants:v3:participant:update_participant
+ * @applicableIdentity APP
+ * @returns Updated participant
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.UpdateParticipant
+ */
+declare function updateParticipant(_id: string, participant: NonNullablePaths<UpdateParticipant, `revision`, 2>, options?: UpdateParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 4>>;
+interface UpdateParticipant {
+    /**
+     * Participant ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Participant revision (for optimistic concurrency control).
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Participant creation date.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date the participant was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Member ID of the participant on the site.
+     * @format GUID
+     * @readonly
+     */
+    memberId?: string;
+    /**
+     * ID of the program the participant is enrolled in.
+     * @format GUID
+     * @readonly
+     */
+    programId?: string;
+    /**
+     * Program completion progress. This field is conditional and must be explicitly requested via `fields` parameter.
+     * @readonly
+     */
+    progress?: Progress;
+    /**
+     * Certificate info for participant
+     * @readonly
+     */
+    certificateInfo?: CertificateInfo;
+    /**
+     * Site member info snapshot for the participant
+     * @readonly
+     */
+    member?: Member;
+    /**
+     * Last activity date of the participant in the program (can either be status change or step resolution).
+     * @readonly
+     */
+    lastActivityDate?: Date | null;
+    /**
+     * Participant's enrollment status in the program.
+     * @readonly
+     */
+    enrollmentStatus?: EnrollmentStatusWithLiterals;
+    /**
+     * Participant's progress status in the program.
+     * @readonly
+     */
+    progressStatus?: ProgressStatusWithLiterals;
+    /** Additional information about the participant's enrollment and completion timeframe in the program. */
+    enrollmentInfo?: EnrollmentInfo;
+    /** Extended fields for participant (can be used for storing custom data). */
+    extendedFields?: ExtendedFields;
+    /** Tags for categorizing and organizing participants. */
+    tags?: Tags;
+}
+interface UpdateParticipantOptions {
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Creates participants in bulk.
+ *
+ * All participants in a single bulk create request must belong to the same program.
+ * Returns an error if the member is already a participant in the specified program.
+ *
+ * When `pricing_type` is `SINGLE_PAYMENT`, provide `single_payment_details`.
+ * When `pricing_type` is `PAID_PLAN`, provide `paid_plan_details`.
+ * When `pricing_type` is `FREE_COUPON`, provide `free_coupon_details`.
+ * Other pricing types (`FREE`, `ADDED_MANUALLY`) do not require details.
+ * @param participants - List of participants to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField participants
+ * @requiredField participants.enrollmentInfo
+ * @requiredField participants.enrollmentInfo.pricingType
+ * @requiredField participants.memberId
+ * @requiredField participants.programId
+ * @permissionId online_programs:participants:v3:participant:bulk_create_participants
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkCreateParticipants
+ */
+declare function bulkCreateParticipants(participants: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`, 3>[], options?: BulkCreateParticipantsOptions): Promise<NonNullablePaths<BulkCreateParticipantsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.memberId` | `results.${number}.item.programId` | `results.${number}.item.progress.totalStepsCompleted` | `results.${number}.item.progress.totalStepsAvailable` | `results.${number}.item.progress.completionPercentage` | `results.${number}.item.enrollmentStatus` | `results.${number}.item.progressStatus` | `results.${number}.item.enrollmentInfo.timeZone` | `results.${number}.item.enrollmentInfo.startDate` | `results.${number}.item.enrollmentInfo.pricingType` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
+    __applicationErrorsType?: BulkCreateParticipantsApplicationErrors;
+}>;
+interface BulkCreateParticipantsOptions {
+    /** Whether to return entities in response or not. */
+    returnEntity?: boolean;
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Creates participants in bulk for all site members in a program, with an optional exclusion filter.
+ *
+ * Participants are created in the `JOINED` state with the join path set to `ADDED`.
+ * Members who are already participants in the program will be skipped.
+ * Only members who are not yet participants will be added.
+ * @param programId - ID of the program for which to create participants for all site members in bulk.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId online_programs:participants:v3:participant:bulk_create_participants_for_all_members
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkCreateParticipantsForAllMembers
+ */
+declare function bulkCreateParticipantsForAllMembers(programId: string, options?: BulkCreateParticipantsForAllMembersOptions): Promise<NonNullablePaths<BulkCreateParticipantsForAllMembersResponse, `jobId`, 2>>;
+interface BulkCreateParticipantsForAllMembersOptions {
+    /**
+     * Site member IDs to exclude from bulk participant creation. Maximum 100 member IDs can be excluded.
+     * @format GUID
+     * @maxSize 100
+     */
+    excludeMemberIds?: string[];
+}
+/**
+ * Removes a participant from the program.
+ *
+ * The member will lose access to program content but will remain in any associated social groups.
+ * @param participantId - ID of the participant to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField participantId
+ * @permissionId online_programs:participants:v3:participant:delete_participant
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.DeleteParticipant
+ */
+declare function deleteParticipant(participantId: string): Promise<void>;
+/**
+ * Issues a certificate to a participant who has completed the program.
+ * @param participantId - ID of the participant to issue the certificate to.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField participantId
+ * @permissionId online_programs:participants:v3:participant:issue_certificate
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.IssueCertificate
+ */
+declare function issueCertificate(participantId: string, options?: IssueCertificateOptions): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.enrollmentStatus` | `participant.progressStatus` | `participant.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participant.enrollmentInfo.paidPlanDetails.paidPlanId` | `participant.enrollmentInfo.freeCouponDetails.freeCouponId` | `participant.enrollmentInfo.timeZone` | `participant.enrollmentInfo.startDate` | `participant.enrollmentInfo.pricingType` | `participant.tags.privateTags.tagIds`, 5> & {
+    __applicationErrorsType?: IssueCertificateApplicationErrors;
+}>;
+interface IssueCertificateOptions {
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Retrieves premium plan statistics for the site.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId online_programs:participants:v3:participant:get_premium_stats
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetPremiumStats
+ */
+declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
+/**
+ * Returns a participant by ID.
+ * @param participantId - ID of the participant to fetch.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField participantId
+ * @permissionId online_programs:participants:v3:participant:get_participant
+ * @applicableIdentity APP
+ * @returns The retrieved participant.
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetParticipant
+ */
+declare function getParticipant(participantId: string, options?: GetParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 4>>;
+interface GetParticipantOptions {
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * Queries existing participants.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId online_programs:participants:v3:participant:query_participants
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.QueryParticipants
+ */
+declare function queryParticipants(options?: QueryParticipantsOptions): ParticipantsQueryBuilder;
+interface QueryParticipantsOptions {
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[] | undefined;
+}
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ParticipantsQueryResult extends QueryCursorResult {
+    items: Participant[];
+    query: ParticipantsQueryBuilder;
+    next: () => Promise<ParticipantsQueryResult>;
+    prev: () => Promise<ParticipantsQueryResult>;
+}
+interface ParticipantsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | 'memberId' | 'programId' | 'progress.totalStepsCompleted' | 'lastActivityDate' | 'enrollmentStatus' | 'progressStatus', value: any) => ParticipantsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_createdDate' | 'progress.totalStepsCompleted' | 'lastActivityDate', value: any) => ParticipantsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_createdDate' | 'progress.totalStepsCompleted' | 'lastActivityDate' | 'enrollmentInfo.startDate', value: any) => ParticipantsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_createdDate' | 'progress.totalStepsCompleted' | 'lastActivityDate' | 'enrollmentInfo.startDate', value: any) => ParticipantsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_createdDate' | 'progress.totalStepsCompleted' | 'lastActivityDate' | 'enrollmentInfo.startDate', value: any) => ParticipantsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_createdDate' | 'progress.totalStepsCompleted' | 'lastActivityDate' | 'enrollmentInfo.startDate', value: any) => ParticipantsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | 'memberId' | 'progress.totalStepsCompleted' | 'lastActivityDate' | 'enrollmentStatus' | 'progressStatus', value: any) => ParticipantsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_createdDate' | 'progress.totalStepsCompleted' | 'lastActivityDate', value: boolean) => ParticipantsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | 'progress.totalStepsCompleted' | 'lastActivityDate' | 'enrollmentStatus' | 'progressStatus' | 'enrollmentInfo.startDate'>) => ParticipantsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | 'progress.totalStepsCompleted' | 'lastActivityDate' | 'enrollmentStatus' | 'progressStatus' | 'enrollmentInfo.startDate'>) => ParticipantsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ParticipantsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ParticipantsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ParticipantsQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.QueryParticipants
+ * @requiredField query
+ */
+declare function typedQueryParticipants(query: ParticipantQuery, options?: QueryParticipantsOptions): Promise<NonNullablePaths<QueryParticipantsResponse, `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`, 6>>;
+interface ParticipantQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['_id'];
+            operators: ['$eq', '$in'];
+            sort: 'BOTH';
+        },
+        {
+            fields: ['enrollmentStatus', 'progressStatus'];
+            operators: ['$eq', '$in'];
+            sort: 'BOTH';
+        },
+        {
+            fields: ['memberId'];
+            operators: ['$eq', '$in'];
+            sort: 'NONE';
+        },
+        {
+            fields: ['programId'];
+            operators: ['$eq'];
+            sort: 'NONE';
+        },
+        {
+            fields: [
+                '_createdDate',
+                'lastActivityDate',
+                'progress.totalStepsCompleted'
+            ];
+            operators: '*';
+            sort: 'BOTH';
+        },
+        {
+            fields: ['enrollmentInfo.startDate'];
+            operators: ['$gt', '$gte', '$lt', '$lte'];
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Participant, ParticipantQuerySpec>;
+type ParticipantQuery = {
+    /**
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+    @maxSize: 100
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
+declare const utils: {
+    query: _wix_sdk_types.QueryHelpers<Participant, ParticipantQuerySpec, ParticipantQuery>;
+    search: _wix_sdk_types.SearchHelpers<Participant, ParticipantSearchSpec, ParticipantSearch>;
+};
+/**
+ * Retrieves the access status for the current site, indicating whether participants can access
+ * online programs or if access is blocked due to plan limitations or other restrictions.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId online_programs:participants:v3:participant:get_access_status
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetAccessStatus
+ */
+declare function getAccessStatus(): Promise<NonNullablePaths<GetAccessStatusResponse, `accessBlocked`, 2>>;
+/**
+ * Updates tags for multiple Participants by IDs.
+ *
+ * Allows assigning and/or unassigning tags in a single operation.
+ * At least one of assign_tags or unassign_tags must be provided.
+ * @param participantIds - Participant IDs to update tags for (1-100 items)
+ * @public
+ * @documentationMaturity preview
+ * @requiredField participantIds
+ * @permissionId online_programs:participants:v3:participant:bulk_update_participant_tags
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkUpdateParticipantTags
+ */
+declare function bulkUpdateParticipantTags(participantIds: string[], options?: BulkUpdateParticipantTagsOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
+    __applicationErrorsType?: BulkUpdateParticipantTagsApplicationErrors;
+}>;
+interface BulkUpdateParticipantTagsOptions {
+    /** Tags to assign to the Participants */
+    assignTags?: Tags;
+    /** Tags to unassign from the Participants */
+    unassignTags?: Tags;
+}
+/**
+ * Updates tags for Participants matching a filter.
+ *
+ * Allows assigning and/or unassigning tags for all Participants matching the filter.
+ * Returns a job ID for tracking the async operation.
+ * @param filter - WQL filter to select Participants
+ * @public
+ * @documentationMaturity preview
+ * @requiredField filter
+ * @permissionId online_programs:participants:v3:participant:bulk_update_participant_tags_by_filter
+ * @applicableIdentity APP
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkUpdateParticipantTagsByFilter
+ */
+declare function bulkUpdateParticipantTagsByFilter(filter: Record<string, any>, options?: BulkUpdateParticipantTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsByFilterResponse, `jobId`, 2> & {
+    __applicationErrorsType?: BulkUpdateParticipantTagsByFilterApplicationErrors;
+}>;
+interface BulkUpdateParticipantTagsByFilterOptions {
+    /** Tags to assign to matching Participants */
+    assignTags?: Tags;
+    /** Tags to unassign from matching Participants */
+    unassignTags?: Tags;
+}
+interface SearchParticipantsOptions {
+    /**
+     * Array of conditional fields to include in the response.
+     * Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface ParticipantSearchSpec extends SearchSpec {
+    searchable: [
+        'member.email',
+        'member.firstName',
+        'member.lastName',
+        'member.nickname'
+    ];
+    aggregatable: [
+        '_createdDate',
+        '_id',
+        '_updatedDate',
+        'enrollmentInfo.startDate',
+        'enrollmentStatus',
+        'lastActivityDate',
+        'member.contactId',
+        'memberId',
+        'programId',
+        'progress.completionPercentage',
+        'progress.totalStepsCompleted',
+        'progressStatus'
+    ];
+    paging: 'cursor';
+    wql: [
+        {
+            operators: '*';
+            fields: [
+                '_id',
+                'enrollmentInfo.startDate',
+                'member.contactId',
+                'member.email',
+                'member.firstName',
+                'member.lastName',
+                'member.nickname',
+                'memberId',
+                'programId',
+                'progress.completionPercentage',
+                'progress.totalStepsCompleted'
+            ];
+            sort: 'BOTH';
+        },
+        {
+            operators: ['$eq', '$in', '$nin'];
+            fields: ['enrollmentStatus', 'progressStatus'];
+            sort: 'BOTH';
+        },
+        {
+            operators: '*';
+            fields: ['_createdDate', '_updatedDate', 'lastActivityDate'];
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonSearchWithEntityContext = Search<Participant, ParticipantSearchSpec>;
+type ParticipantSearch = {
+    /**
+    Cursor paging options.
+  
+    Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+    */
+    filter?: CommonSearchWithEntityContext['filter'] | null;
+    /**
+    List of sort objects.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+    @maxSize: 10
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
+    }[];
+    /**
+    Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories.
+    @maxSize: 10
+    */
+    aggregations?: {
+        /**
+      A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store.
+      */
+        value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
+        /**
+      A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more.
+      */
+        range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
+        /**
+      A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`.
+      */
+        scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
+        /**
+      A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week.
+      */
+        dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
+        /**
+      A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`.
+      */
+        nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
+        /**
+      Aggregation name, returned in `aggregations.results.name`.
+      @maxLength: 100
+      */
+        name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
+        /**
+      Type of aggregation to perform. Must align with the corresponding aggregation field.
+      */
+        type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
+        /**
+      Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
+      @maxLength: 200
+      */
+        fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
+        /**
+      Deprecated. Use `nested` instead.
+      @deprecated: Deprecated. Use `nested` instead.,
+      @replacedBy: kind.nested,
+      @targetRemovalDate: 2024-03-30
+      */
+        groupBy?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['groupBy'];
+    }[];
+    /**
+    Free text to match in searchable fields.
+    */
+    search?: {
+        /**
+      Search mode. Defines the search logic for combining multiple terms in the `expression`.
+      */
+        mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
+        /**
+      Search term or expression.
+      @maxLength: 100
+      */
+        expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
+        /**
+      Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
+      @maxLength: 200,
+      @maxSize: 20
+      */
+        fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
+        /**
+      Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions.
+      */
+        fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
+    };
+    /**
+    Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format.
+    Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z".
+    @maxLength: 50
+    */
+    timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
+};
+/**
+ * Exports participant data and step completion statistics for a program as a CSV file.
+ * The export includes participant details, progress, status, and completion dates for each step.
+ *
+ * This method initiates an asynchronous export. Subscribe to the `ParticipantExportsFinished`
+ * event to receive the download URL when the export completes.
+ * @param programId - program id to export data from
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField programId
+ * @permissionId online_programs:participants:v3:participant:export_participants_stats
+ * @fqn wix.onlineprograms.participants.v3.ParticipantExportsService.ExportParticipantsStats
+ */
+declare function exportParticipantsStats(programId: string): Promise<void>;
+
+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, exportParticipantsStats as ce, 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 };