@wix/auto_sdk_online-programs_participants 1.0.11 → 1.0.13

package/build/internal/cjs/online-programs-v3-participant-participants.universal-DUdmZP01.d.ts

@@ -1,2238 +0,0 @@
-import { QuerySpec, SearchSpec, Query, Search, NonNullablePaths } from '@wix/sdk-types';
-
-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;
-    /**
-     * Participant last update date
-     * @readonly
-     */
-    _updatedDate?: Date | null;
-    /**
-     * Member ID of participant on site
-     * @format GUID
-     * @readonly
-     */
-    memberId?: string;
-    /**
-     * Program ID which participant participates in
-     * @format GUID
-     * @readonly
-     */
-    programId?: string;
-    /**
-     * Program completion progress
-     * @readonly
-     */
-    progress?: Progress;
-    /**
-     * status of participation in the program
-     * @readonly
-     */
-    status?: StatusWithLiterals;
-    /**
-     * Certificate issued to participant
-     * @readonly
-     */
-    certificate?: Certificate;
-    /** Additional info about when and how participant joined the program and which timeframes participant has to complete program. */
-    joinedInfo?: JoinedInfo;
-    /**
-     * 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;
-    /** Extended fields for participant (can be used for storing custom data). */
-    extendedFields?: ExtendedFields;
-    /** Tags for categorizing and organizing participants. */
-    tags?: Tags;
-}
-declare enum JoinPath {
-    /** Default value. This value is unused. */
-    UNKNOWN_JOIN_PATH = "UNKNOWN_JOIN_PATH",
-    /** Member joined to the program for free. */
-    FREE = "FREE",
-    /** Member was added to the program by site owner. */
-    ADDED = "ADDED",
-    /** Member paid once to join the program. */
-    SINGLE_PAYMENT = "SINGLE_PAYMENT",
-    /** Member has Paid Plan to join. */
-    PAID_PLAN = "PAID_PLAN",
-    /** Member joined with the Free Coupon. */
-    FREE_COUPON = "FREE_COUPON"
-}
-/** @enumType */
-type JoinPathWithLiterals = JoinPath | 'UNKNOWN_JOIN_PATH' | 'FREE' | 'ADDED' | '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 offline payment flow from cashier 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;
-    /**
-     * Completion percentage.
-     * @max 100
-     */
-    completionPercentage?: number;
-}
-declare enum Status {
-    /** Default value. This value is unused. */
-    UNKNOWN_STATUS = "UNKNOWN_STATUS",
-    /** Member joined the program and became participant. */
-    JOINED = "JOINED",
-    /** Participant completed the program, and could join again. */
-    COMPLETED = "COMPLETED",
-    /** Participant failed to complete the program, and could join again. */
-    FAILED = "FAILED",
-    /** Participant with ended pricing plan (PP), will be joined as renew PP. */
-    SUSPENDED = "SUSPENDED",
-    /** Participant removed automatically after some program condition. */
-    AUTO_REMOVED = "AUTO_REMOVED",
-    /** Participant removed by site owner. */
-    REMOVED = "REMOVED",
-    /** Participant left the program by himself. */
-    LEFT = "LEFT"
-}
-/** @enumType */
-type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'JOINED' | 'COMPLETED' | 'FAILED' | 'SUSPENDED' | 'AUTO_REMOVED' | 'REMOVED' | 'LEFT';
-interface Certificate {
-    /**
-     * when certificate was issued, UTC.
-     * @readonly
-     */
-    issuedDate?: Date | null;
-}
-interface JoinedInfo extends JoinedInfoJoinPathDetailsOneOf {
-    /** Details about Single Payment join path. */
-    singlePaymentDetails?: SinglePaymentDetails;
-    /** Details about Paid Plan join path. */
-    paidPlanDetails?: PaidPlanDetails;
-    /** Details about Free Coupon join path. */
-    freeCouponDetails?: FreeCouponDetails;
-    /**
-     * Time zone for site on which member joined the program.
-     * @maxLength 50
-     * @readonly
-     */
-    timeZone?: string;
-    /**
-     * Date when participant starts the program (is the same as join date if program does not have start date, otherwise can be later).
-     * @format LOCAL_DATE
-     * @readonly
-     */
-    startDate?: string;
-    /**
-     * How participant joined the program.
-     * @immutable
-     */
-    joinPath?: JoinPathWithLiterals;
-    /**
-     * Date before which participant has to finish the program (is not empty only if program itself has finish date).
-     * @format LOCAL_DATE
-     * @readonly
-     */
-    finishDate?: string | null;
-}
-/** @oneof */
-interface JoinedInfoJoinPathDetailsOneOf {
-    /** Details about Single Payment join path. */
-    singlePaymentDetails?: SinglePaymentDetails;
-    /** Details about Paid Plan join path. */
-    paidPlanDetails?: PaidPlanDetails;
-    /** Details about Free Coupon join path. */
-    freeCouponDetails?: FreeCouponDetails;
-}
-interface Member {
-    /**
-     * First name of the site member.
-     * @readonly
-     * @maxLength 1000
-     */
-    firstName?: string | null;
-    /**
-     * Last name of the site member.
-     * @readonly
-     * @maxLength 1000
-     */
-    lastName?: string | null;
-    /**
-     * Email of the site member.
-     * @readonly
-     * @format EMAIL
-     */
-    email?: string | null;
-    /**
-     * Contact ID of the site member.
-     * @format GUID
-     * @readonly
-     */
-    contactId?: string;
-    /**
-     * Profile image URL of the site member.
-     * @readonly
-     * @format WEB_URL
-     */
-    profileImageUrl?: string | null;
-}
-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[];
-}
-interface ParticipantAdded {
-    /**
-     * Program ID which participant was added
-     * @format GUID
-     */
-    programId?: string;
-    /**
-     * Member ID of participant on site
-     * @format GUID
-     */
-    memberId?: string;
-}
-/** Domain event emitted when tags are modified */
-interface TagsModified {
-    /** The Participant with updated tags */
-    participant?: Participant;
-    /** Tags that were assigned */
-    assignedTags?: Tags;
-    /** Tags that were unassigned */
-    unassignedTags?: Tags;
-}
-interface CreateParticipantRequest {
-    /** Participant to create */
-    participant: Participant;
-}
-interface CreateParticipantResponse {
-    /** Created participant */
-    participant?: Participant;
-}
-interface BulkCreateParticipantRequest {
-    /**
-     * List of participants you want to create
-     * @minSize 1
-     * @maxSize 100
-     */
-    participants: Participant[];
-    /** Whether to return entities in response or not. */
-    returnEntity?: boolean;
-}
-interface BulkCreateParticipantResponse {
-    /**
-     * Results of bulk action.
-     * @minSize 1
-     * @maxSize 100
-     */
-    results?: BulkParticipantResult[];
-    /** Metadata about whole bulk action. */
-    bulkActionMetadata?: CommonBulkActionMetadata;
-}
-interface BulkParticipantResult {
-    /** Metadata of item. */
-    itemMetadata?: CommonItemMetadata;
-    /** Item itself (empty if return_entity in request is false). */
-    item?: Participant;
-}
-interface CommonItemMetadata {
-    /** 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 CommonBulkActionMetadata {
-    /** 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 BulkAddAllToProgramRequest {
-    /**
-     * Program to which bulk add participants.
-     * @format GUID
-     */
-    programId: string;
-    /**
-     * Exclude site members.
-     * @format GUID
-     * @maxSize 100
-     */
-    excludeMemberIds?: string[];
-}
-interface BulkAddAllToProgramResponse {
-    /**
-     * Async infra job id which will process the request.
-     * @format GUID
-     */
-    jobId?: string;
-}
-interface DeleteParticipantRequest {
-    /**
-     * Participants to delete
-     * @format GUID
-     */
-    participantId: string;
-}
-interface DeleteParticipantResponse {
-}
-interface IssueCertificateRequest {
-    /**
-     * Participant to get certificate
-     * @format GUID
-     */
-    participantId: string;
-}
-interface IssueCertificateResponse {
-    /** Updated participant */
-    participant?: Participant;
-}
-interface GetCompletionStatsRequest {
-    /**
-     * program id to get stats for
-     * @format GUID
-     */
-    programId: string;
-}
-interface GetCompletionStatsResponse {
-    /** Number of participants that completed the program */
-    completedAll?: number;
-    /** Percentage of participants that completed the program */
-    completionRate?: number;
-}
-interface GetPremiumStatsRequest {
-}
-interface GetPremiumStatsResponse {
-    /** True if site has Online Programs premium feature */
-    hasPremium?: boolean;
-    /** Count of active participants on the site */
-    activeParticipantsCount?: number;
-    /** Limit of active participants on a site without premium */
-    activeParticipantsLimit?: number;
-}
-interface GetParticipantRequest {
-    /**
-     * Participant id to fetch
-     * @format GUID
-     */
-    participantId: string;
-}
-interface GetParticipantResponse {
-    /** existing participant */
-    participant?: Participant;
-}
-interface QueryParticipantsRequest {
-    /** Platformized query */
-    query?: CursorQuery;
-}
-interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /**
-     * 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;
-    /**
-     * Sort object.
-     *
-     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
-     * @maxSize 5
-     */
-    sort?: Sorting[];
-}
-/** @oneof */
-interface CursorQueryPagingMethodOneOf {
-    /**
-     * 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 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 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 {
-    /** found participants */
-    participants?: Participant[];
-    /** paging metadata */
-    pagingMetadata?: CursorPagingMetadata;
-}
-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;
-}
-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 */
-    blocked?: 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?: CommonBulkActionMetadata;
-}
-interface BulkUpdateParticipantTagsResult {
-    /** Metadata for this specific item */
-    itemMetadata?: CommonItemMetadata;
-}
-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
-     * @format GUID
-     */
-    jobId?: string;
-}
-interface SearchParticipantsRequest {
-    /** Query to search programs */
-    search?: CursorSearch;
-}
-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 {
-    UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
-    /** Total number of distinct values. */
-    COUNT_DISTINCT = "COUNT_DISTINCT",
-    /** Minimum value. */
-    MIN = "MIN",
-    /** Maximum value. */
-    MAX = "MAX"
-}
-/** @enumType */
-type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | '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 {
-    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** 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 | 'UNKNOWN_AGGREGATION_TYPE' | '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 {
-    UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
-    YEAR = "YEAR",
-    MONTH = "MONTH",
-    WEEK = "WEEK",
-    DAY = "DAY",
-    HOUR = "HOUR",
-    MINUTE = "MINUTE",
-    SECOND = "SECOND"
-}
-/** @enumType */
-type IntervalWithLiterals = Interval | 'UNKNOWN_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 {
-    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** 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 | 'UNKNOWN_AGGREGATION_TYPE' | '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 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 BenefitNotification {
-    /**
-     * Plan unique ID
-     * @format GUID
-     */
-    planId?: string;
-    /**
-     * App def ID
-     * @format GUID
-     */
-    appDefId?: string;
-    /** Current benefit details */
-    benefit?: Benefit;
-    /** Previous benefit */
-    prevBenefit?: Benefit;
-    /** Notification event */
-    event?: EventWithLiterals;
-}
-interface Benefit {
-    /**
-     * Benefit unique ID
-     * @format GUID
-     * @readonly
-     */
-    _id?: string | null;
-    /** Benefit Type */
-    benefitType?: BenefitTypeWithLiterals;
-    /**
-     * Resource IDs that serves by this benefit
-     * @format GUID
-     */
-    resourceIds?: string[];
-    /** Amount of credits that provided by this benefit */
-    creditAmount?: number | null;
-    /**
-     * additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value
-     * @maxSize 20
-     */
-    customFields?: Record<string, string>;
-    /** return value only in case it required in the ListRequest, true means that benefit's type could be updated */
-    editable?: boolean | null;
-    /** Benefit behavior */
-    behavior?: Behavior;
-    /**
-     * Id of the app associated with this benefit
-     * @format GUID
-     * @readonly
-     */
-    appDefId?: string | null;
-}
-interface EntryPass {
-}
-interface Discount extends DiscountDiscountOneOf {
-    /**
-     * Fixed-rate percent off discount
-     * @decimalValue options { gt:0, lte:100, maxScale:2 }
-     */
-    percentOffRate?: string;
-    /**
-     * Absolute amount discount
-     * @decimalValue options { gt:0, maxScale:2 }
-     */
-    moneyOffAmount?: string;
-}
-/** @oneof */
-interface DiscountDiscountOneOf {
-    /**
-     * Fixed-rate percent off discount
-     * @decimalValue options { gt:0, lte:100, maxScale:2 }
-     */
-    percentOffRate?: string;
-    /**
-     * Absolute amount discount
-     * @decimalValue options { gt:0, maxScale:2 }
-     */
-    moneyOffAmount?: string;
-}
-declare enum BenefitType {
-    /** Should never be used */
-    UNDEFINED = "UNDEFINED",
-    /** Limited benefit type */
-    LIMITED = "LIMITED",
-    /** Unlimited benefit type */
-    UNLIMITED = "UNLIMITED"
-}
-/** @enumType */
-type BenefitTypeWithLiterals = BenefitType | 'UNDEFINED' | 'LIMITED' | 'UNLIMITED';
-interface Behavior extends BehaviorBehaviorOneOf {
-    /** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
-    defaultBehavior?: EntryPass;
-    /** Discount applied to paid resources */
-    discount?: Discount;
-}
-/** @oneof */
-interface BehaviorBehaviorOneOf {
-    /** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
-    defaultBehavior?: EntryPass;
-    /** Discount applied to paid resources */
-    discount?: Discount;
-}
-declare enum Event {
-    Updated = "Updated",
-    Deleted = "Deleted",
-    Created = "Created"
-}
-/** @enumType */
-type EventWithLiterals = Event | 'Updated' | 'Deleted' | 'Created';
-interface MessageEnvelope {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-}
-interface IdentificationData extends IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
-}
-/** @oneof */
-interface IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-}
-declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-/** @enumType */
-type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-declare enum State {
-    /** Unknown state */
-    UNKNOWN_STATE = "UNKNOWN_STATE",
-    /** Member joined the program and became participant */
-    JOINED = "JOINED",
-    /** Participant completed the program, and could join again */
-    COMPLETED = "COMPLETED",
-    /** Participant failed to complete the program, and could join again */
-    FAILED = "FAILED",
-    /** Participant with ended pricing plan (PP), will be joined as renew PP */
-    SUSPENDED = "SUSPENDED",
-    /** Participant removed automatically after some program condition */
-    AUTO_REMOVED = "AUTO_REMOVED",
-    /** Participant removed by site owner */
-    REMOVED = "REMOVED",
-    /** Participant left the program by himself */
-    LEFT = "LEFT"
-}
-/** @enumType */
-type StateWithLiterals = State | 'UNKNOWN_STATE' | 'JOINED' | 'COMPLETED' | 'FAILED' | 'SUSPENDED' | 'AUTO_REMOVED' | 'REMOVED' | 'LEFT';
-interface BulkInviteToProgramRequest {
-    /**
-     * Program to which bulk invite participants.
-     * @format GUID
-     */
-    programId: string;
-    /**
-     * Return added participants in the response or not.
-     * @format GUID
-     * @minSize 1
-     * @maxSize 100
-     */
-    memberIds?: string[];
-    /** Return invited participants in the response or not. */
-    returnEntity?: boolean;
-}
-interface BulkInviteToProgramResponse {
-    /** Participants created by bulk action */
-    results?: BulkInviteToProgramResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-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 BulkInviteToProgramResult {
-    /** Invited participant metadata. */
-    itemMetadata?: ItemMetadata;
-    /** Invited participant */
-    item?: Participant;
-}
-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 ParticipantInvited {
-    /**
-     * Program to which bulk invite participants.
-     * @format GUID
-     */
-    programId?: string;
-    /**
-     * Invited member to program
-     * @format GUID
-     */
-    memberId?: string;
-}
-interface BulkInviteAllToProgramRequest {
-    /**
-     * Program to which bulk add participants.
-     * @format GUID
-     */
-    programId: string;
-    /**
-     * Exclude site members.
-     * @format GUID
-     * @maxSize 100
-     */
-    excludeMemberIds?: string[];
-}
-interface BulkInviteAllToProgramResponse {
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface BulkAddToProgramRequest {
-    /**
-     * Program to which bulk add participants.
-     * @format GUID
-     */
-    programId: string;
-    /**
-     * Site members.
-     * @format GUID
-     * @minSize 1
-     * @maxSize 1000
-     */
-    memberIds?: string[];
-    /** Return added participants in the response or not. */
-    returnEntity?: boolean;
-}
-interface BulkAddToProgramResponse {
-    /** Participants created by bulk action */
-    results?: BulkAddToProgramResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface BulkAddToProgramResult {
-    /** Added participant metadata. */
-    itemMetadata?: ItemMetadata;
-    /** Added participant */
-    item?: Participant;
-}
-interface BulkApproveParticipantRequest {
-    /**
-     * Participants to add
-     * @format GUID
-     * @maxSize 100
-     */
-    participantIds: string[];
-    /**
-     * program to approve participant
-     * @format GUID
-     */
-    programId?: string;
-    /** Return approved participants in the response or not */
-    returnEntity?: boolean;
-}
-interface BulkApproveParticipantResponse {
-    /** Participants approved by bulk action */
-    results?: BulkApproveParticipantResult[];
-    /** Bulk action metadata */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface BulkApproveParticipantResult {
-    /** Approved participant metadata */
-    itemMetadata?: ItemMetadata;
-    /** Approved or existing participant */
-    item?: Participant;
-}
-interface ParticipantApproved {
-    /**
-     * Program ID which participant approved
-     * @format GUID
-     */
-    programId?: string;
-    /**
-     * Member ID of participant approved
-     * @format GUID
-     */
-    memberId?: string;
-}
-interface BulkApproveAllParticipantRequest {
-    /**
-     * Program to approve all participants.
-     * @format GUID
-     */
-    programId?: string;
-    /**
-     * Exclude site members.
-     * @format GUID
-     * @maxSize 100
-     */
-    excludeParticipantIds?: string[];
-}
-interface BulkApproveAllParticipantResponse {
-    /**
-     * Job id with async process
-     * @format GUID
-     */
-    jobId?: string;
-}
-interface ExportParticipantsStatsRequest {
-    /**
-     * program id to export data from
-     * @format GUID
-     */
-    programId: string;
-}
-interface ExportParticipantsStatsResponse {
-}
-interface ParticipantExportsFinished {
-    /**
-     * program id from which stats were exported
-     * @format GUID
-     */
-    programId?: string;
-    /**
-     * user id of program owner
-     * @format GUID
-     */
-    userId?: string;
-    /**
-     * url to download report
-     * @format WEB_URL
-     */
-    downloadUrl?: string;
-    /** days url will be downloadable */
-    downloadUrlTtlDays?: number;
-}
-/** @docsIgnore */
-type CreateParticipantApplicationErrors = {
-    code?: 'INVALID_PAYMENT_INFO';
-    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>;
-};
-interface BaseEventMetadata {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-}
-interface EventMetadata extends BaseEventMetadata {
-    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
-    _id?: string;
-    /**
-     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
-     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
-     */
-    entityFqdn?: string;
-    /**
-     * Event action name, placed at the top level to make it easier for users to dispatch messages.
-     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
-     */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
-    eventTime?: Date | null;
-    /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
-    /**
-     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
-     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
-     */
-    entityEventSequence?: string | null;
-}
-interface ParticipantAddedEnvelope {
-    data: ParticipantAdded;
-    metadata: EventMetadata;
-}
-/** @permissionScope Manage Challenges
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
- * @webhook
- * @eventType wix.online_programs.v3.participant_added
- * @slug added
- * @documentationMaturity preview
- */
-declare function onParticipantAdded(handler: (event: ParticipantAddedEnvelope) => void | Promise<void>): void;
-interface ParticipantApprovedEnvelope {
-    data: ParticipantApproved;
-    metadata: EventMetadata;
-}
-/** @permissionScope Manage Challenges
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
- * @webhook
- * @eventType wix.online_programs.v3.participant_participant_approved
- * @serviceIdentifier wix.onlineprograms.participants.v3.ManageParticipantsService
- * @slug participant_approved
- * @documentationMaturity preview
- */
-declare function onParticipantApproved(handler: (event: ParticipantApprovedEnvelope) => void | Promise<void>): void;
-interface ParticipantInvitedEnvelope {
-    data: ParticipantInvited;
-    metadata: EventMetadata;
-}
-/** @permissionScope Manage Challenges
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
- * @webhook
- * @eventType wix.online_programs.v3.participant_participant_invited
- * @serviceIdentifier wix.onlineprograms.participants.v3.ManageParticipantsService
- * @slug participant_invited
- * @documentationMaturity preview
- */
-declare function onParticipantInvited(handler: (event: ParticipantInvitedEnvelope) => void | Promise<void>): void;
-/**
- * Create one participant.
- * @param participant - Participant to create
- * @public
- * @documentationMaturity preview
- * @requiredField participant
- * @requiredField participant.joinedInfo.joinPath
- * @requiredField participant.memberId
- * @requiredField participant.programId
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_CREATE
- * @returns Created participant
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.CreateParticipant
- */
-declare function createParticipant(participant: NonNullablePaths<Participant, `joinedInfo.joinPath` | `memberId` | `programId`, 3>): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `status` | `joinedInfo.singlePaymentDetails.paymentOrderId` | `joinedInfo.paidPlanDetails.paidPlanId` | `joinedInfo.freeCouponDetails.freeCouponId` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId` | `tags.privateTags.tagIds`, 4> & {
-    __applicationErrorsType?: CreateParticipantApplicationErrors;
-}>;
-/**
- * Creates participants in bulk.
- * @param participants - List of participants you want to create
- * @public
- * @documentationMaturity preview
- * @requiredField participants
- * @requiredField participants.joinedInfo.joinPath
- * @requiredField participants.memberId
- * @requiredField participants.programId
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_CREATE
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkCreateParticipant
- */
-declare function bulkCreateParticipant(participants: NonNullablePaths<Participant, `joinedInfo.joinPath` | `memberId` | `programId`, 3>[], options?: BulkCreateParticipantOptions): Promise<NonNullablePaths<BulkCreateParticipantResponse, `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.status` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
-interface BulkCreateParticipantOptions {
-    /** Whether to return entities in response or not. */
-    returnEntity?: boolean;
-}
-/**
- * Bulk adds all site members to program, but not more then 1000.
- * Participant will be either created in state Joined, or updated to that state
- * from pending one.
- * @param programId - Program to which bulk add participants.
- * @public
- * @documentationMaturity preview
- * @requiredField programId
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
- * @applicableIdentity APP
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkAddAllToProgram
- */
-declare function bulkAddAllToProgram(programId: string, options?: BulkAddAllToProgramOptions): Promise<NonNullablePaths<BulkAddAllToProgramResponse, `jobId`, 2>>;
-interface BulkAddAllToProgramOptions {
-    /**
-     * Exclude site members.
-     * @format GUID
-     * @maxSize 100
-     */
-    excludeMemberIds?: string[];
-}
-/**
- * Delete participant from program. Removes participant from member
- * group. Leaves him in Social Group.
- * @param participantId - Participants to delete
- * @public
- * @documentationMaturity preview
- * @requiredField participantId
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_DELETE
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.DeleteParticipant
- */
-declare function deleteParticipant(participantId: string): Promise<void>;
-/**
- * Issue certificate by site admin
- * @param participantId - Participant to get certificate
- * @public
- * @documentationMaturity preview
- * @requiredField participantId
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ISSUE_CERTIFICATE
- * @applicableIdentity APP
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.IssueCertificate
- */
-declare function issueCertificate(participantId: string): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.status` | `participant.joinedInfo.singlePaymentDetails.paymentOrderId` | `participant.joinedInfo.paidPlanDetails.paidPlanId` | `participant.joinedInfo.freeCouponDetails.freeCouponId` | `participant.joinedInfo.timeZone` | `participant.joinedInfo.startDate` | `participant.joinedInfo.joinPath` | `participant.member.contactId` | `participant.tags.privateTags.tagIds`, 5>>;
-/**
- * Get program's completion stats
- * @param programId - program id to get stats for
- * @public
- * @documentationMaturity preview
- * @requiredField programId
- * @permissionId ONLINE_PROGRAMS.STATS_READ
- * @applicableIdentity APP
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetCompletionStats
- */
-declare function getCompletionStats(programId: string): Promise<NonNullablePaths<GetCompletionStatsResponse, `completedAll` | `completionRate`, 2>>;
-/**
- * Get premium stats
- * @public
- * @documentationMaturity preview
- * @permissionId ONLINE_PROGRAMS.STATS_READ
- * @applicableIdentity APP
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetPremiumStats
- */
-declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `hasPremium` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
-/**
- * Returns participant.
- * @param participantId - Participant id to fetch
- * @public
- * @documentationMaturity preview
- * @requiredField participantId
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @returns existing participant
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetParticipant
- */
-declare function getParticipant(participantId: string): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `status` | `joinedInfo.singlePaymentDetails.paymentOrderId` | `joinedInfo.paidPlanDetails.paidPlanId` | `joinedInfo.freeCouponDetails.freeCouponId` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId` | `tags.privateTags.tagIds`, 4>>;
-/**
- * Query existing participants
- * @public
- * @documentationMaturity preview
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.QueryParticipants
- */
-declare function queryParticipants(): ParticipantsQueryBuilder;
-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' | 'memberId' | 'programId' | 'status', value: any) => ParticipantsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    ge: (propertyName: 'joinedInfo.startDate', value: any) => ParticipantsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    gt: (propertyName: 'joinedInfo.startDate', value: any) => ParticipantsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    le: (propertyName: 'joinedInfo.startDate', value: any) => ParticipantsQueryBuilder;
-    /** @param propertyName - Property whose value is compared with `value`.
-     * @param value - Value to compare against.
-     * @documentationMaturity preview
-     */
-    lt: (propertyName: 'joinedInfo.startDate', value: any) => ParticipantsQueryBuilder;
-    /** @documentationMaturity preview */
-    in: (propertyName: '_id' | 'memberId' | 'status', value: any) => 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' | 'status' | 'joinedInfo.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' | 'status' | 'joinedInfo.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): Promise<NonNullablePaths<QueryParticipantsResponse, `participants` | `participants.${number}.memberId` | `participants.${number}.programId` | `participants.${number}.progress.totalStepsCompleted` | `participants.${number}.progress.totalStepsAvailable` | `participants.${number}.progress.completionPercentage` | `participants.${number}.status` | `participants.${number}.joinedInfo.singlePaymentDetails.paymentOrderId` | `participants.${number}.joinedInfo.paidPlanDetails.paidPlanId` | `participants.${number}.joinedInfo.freeCouponDetails.freeCouponId` | `participants.${number}.joinedInfo.timeZone` | `participants.${number}.joinedInfo.startDate` | `participants.${number}.joinedInfo.joinPath` | `participants.${number}.member.contactId`, 6>>;
-interface ParticipantQuerySpec extends QuerySpec {
-    paging: 'cursor';
-    wql: [
-        {
-            fields: ['_id', 'status'];
-            operators: ['$eq', '$in'];
-            sort: 'BOTH';
-        },
-        {
-            fields: ['memberId'];
-            operators: ['$eq', '$in'];
-            sort: 'NONE';
-        },
-        {
-            fields: ['programId'];
-            operators: ['$eq'];
-            sort: 'NONE';
-        },
-        {
-            fields: ['_createdDate'];
-            operators: [];
-            sort: 'BOTH';
-        },
-        {
-            fields: ['joinedInfo.startDate'];
-            operators: ['$gt', '$gte', '$lt', '$lte'];
-            sort: 'BOTH';
-        }
-    ];
-}
-type CommonQueryWithEntityContext = Query<Participant, ParticipantQuerySpec>;
-type ParticipantQuery = {
-    /**
-    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<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: 5
-    */
-    sort?: {
-        /**
-      Name of the field to sort by.
-      @maxLength: 512
-      */
-        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
-        /**
-      Sort order.
-      */
-        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
-    }[];
-};
-/**
- * Get access status
- * @public
- * @documentationMaturity preview
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetAccessStatus
- */
-declare function getAccessStatus(): Promise<NonNullablePaths<GetAccessStatusResponse, `blocked`, 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:v3:participant:bulk_update_participant_tags
- * @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:v3:participant:bulk_update_participant_tags_by_filter
- * @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 ParticipantSearchSpec extends SearchSpec {
-    searchable: ['member.email', 'member.firstName', 'member.lastName'];
-    aggregatable: [
-        '_id',
-        'joinedInfo.startDate',
-        'memberId',
-        'programId',
-        'status'
-    ];
-    paging: 'cursor';
-    wql: [
-        {
-            operators: ['$eq', '$in'];
-            fields: ['_id', 'status'];
-            sort: 'BOTH';
-        },
-        {
-            operators: ['$eq', '$in'];
-            fields: ['memberId'];
-            sort: 'NONE';
-        },
-        {
-            operators: ['$eq'];
-            fields: ['programId'];
-            sort: 'NONE';
-        },
-        {
-            operators: [];
-            fields: ['_createdDate'];
-            sort: 'BOTH';
-        },
-        {
-            operators: ['$gt', '$gte', '$lt', '$lte'];
-            fields: ['joinedInfo.startDate'];
-            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;
-};
-/**
- * Bulk invites participants to program.
- * For each member participant in Invited state is created.
- * @param programId - Program to which bulk invite participants.
- * @public
- * @documentationMaturity preview
- * @requiredField programId
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_INVITE
- * @applicableIdentity APP
- * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkInviteToProgram
- */
-declare function bulkInviteToProgram(programId: string, options?: BulkInviteToProgramOptions): Promise<NonNullablePaths<BulkInviteToProgramResponse, `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.status` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
-interface BulkInviteToProgramOptions {
-    /**
-     * Return added participants in the response or not.
-     * @format GUID
-     * @minSize 1
-     * @maxSize 100
-     */
-    memberIds?: string[];
-    /** Return invited participants in the response or not. */
-    returnEntity?: boolean;
-}
-/**
- * Bulk invites all participants to program, but not more then 1000.
- * For each member participant in Invited state is created.
- * @param programId - Program to which bulk add participants.
- * @public
- * @documentationMaturity preview
- * @requiredField programId
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_INVITE
- * @applicableIdentity APP
- * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkInviteAllToProgram
- */
-declare function bulkInviteAllToProgram(programId: string, options?: BulkInviteAllToProgramOptions): Promise<NonNullablePaths<BulkInviteAllToProgramResponse, `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 3>>;
-interface BulkInviteAllToProgramOptions {
-    /**
-     * Exclude site members.
-     * @format GUID
-     * @maxSize 100
-     */
-    excludeMemberIds?: string[];
-}
-/**
- * Bulk adds participants to program.
- * Participant will be either created in state Joined, or updated to that state
- * from pending one.
- * @param programId - Program to which bulk add participants.
- * @public
- * @documentationMaturity preview
- * @requiredField programId
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
- * @applicableIdentity APP
- * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkAddToProgram
- */
-declare function bulkAddToProgram(programId: string, options?: BulkAddToProgramOptions): Promise<NonNullablePaths<BulkAddToProgramResponse, `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.status` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
-interface BulkAddToProgramOptions {
-    /**
-     * Site members.
-     * @format GUID
-     * @minSize 1
-     * @maxSize 1000
-     */
-    memberIds?: string[];
-    /** Return added participants in the response or not. */
-    returnEntity?: boolean;
-}
-/**
- * Bulk approves participants, who asked to join private program (aka in
- * state `APPROVAL_PENDING`). If participant was in other state, no effect and
- * error returned.
- * @param participantIds - Participants to add
- * @public
- * @documentationMaturity preview
- * @requiredField participantIds
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_APPROVE
- * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkApproveParticipant
- */
-declare function bulkApproveParticipant(participantIds: string[], options?: BulkApproveParticipantOptions): Promise<NonNullablePaths<BulkApproveParticipantResponse, `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.status` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
-interface BulkApproveParticipantOptions {
-    /**
-     * program to approve participant
-     * @format GUID
-     */
-    programId?: string;
-    /** Return approved participants in the response or not */
-    returnEntity?: boolean;
-}
-/**
- * Bulk approves all pending participants, who asked to join private program (aka
- * in state `APPROVAL_PENDING`).
- * @public
- * @documentationMaturity preview
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_APPROVE
- * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkApproveAllParticipant
- */
-declare function bulkApproveAllParticipant(options?: BulkApproveAllParticipantOptions): Promise<NonNullablePaths<BulkApproveAllParticipantResponse, `jobId`, 2>>;
-interface BulkApproveAllParticipantOptions {
-    /**
-     * Program to approve all participants.
-     * @format GUID
-     */
-    programId?: string;
-    /**
-     * Exclude site members.
-     * @format GUID
-     * @maxSize 100
-     */
-    excludeParticipantIds?: string[];
-}
-/**
- * Exports data about participants as well as resolved steps in program.
- * @param programId - program id to export data from
- * @internal
- * @documentationMaturity preview
- * @requiredField programId
- * @permissionId ONLINE_PROGRAMS.EXPORT_PARTICIPANTS_STATS
- * @fqn wix.onlineprograms.participants.v3.ParticipantExportsService.ExportParticipantsStats
- */
-declare function exportParticipantsStats(programId: string): Promise<void>;
-
-export { type Certificate as $, type ParticipantQuery as A, type BulkCreateParticipantOptions as B, type CreateParticipantApplicationErrors as C, typedQueryParticipants as D, Status as E, SortOrder as F, type GetCompletionStatsResponse as G, SortType as H, type IssueCertificateResponse as I, JoinPath as J, SortDirection as K, ScalarType as L, MissingValues as M, NestedAggregationType as N, Interval as O, type Participant as P, AggregationType as Q, Mode as R, type SearchParticipantsResponse as S, BenefitType as T, Event as U, State as V, WebhookIdentityType as W, type SinglePaymentDetails as X, type PaidPlanDetails as Y, type FreeCouponDetails as Z, type Progress as _, type BulkCreateParticipantResponse as a, type RangeResult as a$, type JoinedInfo as a0, type JoinedInfoJoinPathDetailsOneOf as a1, type Member as a2, type ExtendedFields as a3, type Tags as a4, type TagList as a5, type ParticipantAdded as a6, type TagsModified as a7, type CreateParticipantRequest as a8, type CreateParticipantResponse as a9, type CursorSearch as aA, type CursorSearchPagingMethodOneOf as aB, type Aggregation as aC, type AggregationKindOneOf as aD, type RangeBucket as aE, type IncludeMissingValuesOptions as aF, type ValueAggregation as aG, type ValueAggregationOptionsOneOf as aH, type RangeAggregation as aI, type ScalarAggregation as aJ, type DateHistogramAggregation as aK, type NestedAggregationItem as aL, type NestedAggregationItemKindOneOf as aM, type NestedAggregation as aN, type GroupByAggregation as aO, type GroupByAggregationKindOneOf as aP, type SearchDetails as aQ, type AggregationData as aR, type ValueAggregationResult as aS, type RangeAggregationResult as aT, type NestedAggregationResults as aU, type NestedAggregationResultsResultOneOf as aV, type ValueResults as aW, type RangeResults as aX, type AggregationResultsScalarResult as aY, type NestedValueAggregationResult as aZ, type ValueResult as a_, type BulkCreateParticipantRequest as aa, type BulkParticipantResult as ab, type CommonItemMetadata as ac, type ApplicationError as ad, type CommonBulkActionMetadata as ae, type BulkAddAllToProgramRequest as af, type DeleteParticipantRequest as ag, type DeleteParticipantResponse as ah, type IssueCertificateRequest as ai, type GetCompletionStatsRequest as aj, type GetPremiumStatsRequest as ak, type GetParticipantRequest as al, type GetParticipantResponse as am, type QueryParticipantsRequest as an, type CursorQuery as ao, type CursorQueryPagingMethodOneOf as ap, type Sorting as aq, type CursorPaging as ar, type QueryParticipantsResponse as as, type CursorPagingMetadata as at, type Cursors as au, type GetAccessStatusRequest as av, type BulkUpdateParticipantTagsRequest as aw, type BulkUpdateParticipantTagsResult as ax, type BulkUpdateParticipantTagsByFilterRequest as ay, type SearchParticipantsRequest as az, type BulkAddAllToProgramOptions as b, type CommonQueryWithEntityContext as b$, type ScalarResult as b0, type NestedResultValue as b1, type NestedResultValueResultOneOf as b2, type Results as b3, type DateHistogramResult as b4, type GroupByValueResults as b5, type DateHistogramResults as b6, type NestedResults as b7, type AggregationResults as b8, type AggregationResultsResultOneOf as b9, type BulkApproveParticipantRequest as bA, type BulkApproveParticipantResult as bB, type ParticipantApproved as bC, type BulkApproveAllParticipantRequest as bD, type ExportParticipantsStatsRequest as bE, type ExportParticipantsStatsResponse as bF, type ParticipantExportsFinished as bG, type BaseEventMetadata as bH, type EventMetadata as bI, type ParticipantsQueryResult as bJ, type ParticipantQuerySpec as bK, type ParticipantSearchSpec as bL, type JoinPathWithLiterals as bM, type StatusWithLiterals as bN, type SortOrderWithLiterals as bO, type SortTypeWithLiterals as bP, type SortDirectionWithLiterals as bQ, type MissingValuesWithLiterals as bR, type ScalarTypeWithLiterals as bS, type NestedAggregationTypeWithLiterals as bT, type IntervalWithLiterals as bU, type AggregationTypeWithLiterals as bV, type ModeWithLiterals as bW, type BenefitTypeWithLiterals as bX, type EventWithLiterals as bY, type WebhookIdentityTypeWithLiterals as bZ, type StateWithLiterals as b_, type DomainEvent as ba, type DomainEventBodyOneOf as bb, type EntityCreatedEvent as bc, type RestoreInfo as bd, type EntityUpdatedEvent as be, type EntityDeletedEvent as bf, type ActionEvent as bg, type Empty as bh, type BenefitNotification as bi, type Benefit as bj, type EntryPass as bk, type Discount as bl, type DiscountDiscountOneOf as bm, type Behavior as bn, type BehaviorBehaviorOneOf as bo, type MessageEnvelope as bp, type IdentificationData as bq, type IdentificationDataIdOneOf as br, type BulkInviteToProgramRequest as bs, type ItemMetadata as bt, type BulkInviteToProgramResult as bu, type BulkActionMetadata as bv, type ParticipantInvited as bw, type BulkInviteAllToProgramRequest as bx, type BulkAddToProgramRequest as by, type BulkAddToProgramResult as bz, type BulkAddAllToProgramResponse as c, type CommonSearchWithEntityContext as c0, onParticipantAdded as c1, onParticipantApproved as c2, onParticipantInvited as c3, createParticipant as c4, bulkCreateParticipant as c5, bulkAddAllToProgram as c6, deleteParticipant as c7, issueCertificate as c8, getCompletionStats as c9, getPremiumStats as ca, getParticipant as cb, queryParticipants as cc, getAccessStatus as cd, bulkUpdateParticipantTags as ce, bulkUpdateParticipantTagsByFilter as cf, bulkInviteToProgram as cg, bulkInviteAllToProgram as ch, bulkAddToProgram as ci, bulkApproveParticipant as cj, bulkApproveAllParticipant as ck, exportParticipantsStats as cl, type GetPremiumStatsResponse as d, type GetAccessStatusResponse as e, type BulkUpdateParticipantTagsOptions as f, type BulkUpdateParticipantTagsResponse as g, type BulkUpdateParticipantTagsApplicationErrors as h, type BulkUpdateParticipantTagsByFilterOptions as i, type BulkUpdateParticipantTagsByFilterResponse as j, type BulkUpdateParticipantTagsByFilterApplicationErrors as k, type ParticipantSearch as l, type BulkInviteToProgramOptions as m, type BulkInviteToProgramResponse as n, type BulkInviteAllToProgramOptions as o, type BulkInviteAllToProgramResponse as p, type BulkAddToProgramOptions as q, type BulkAddToProgramResponse as r, type BulkApproveParticipantOptions as s, type BulkApproveParticipantResponse as t, type BulkApproveAllParticipantOptions as u, type BulkApproveAllParticipantResponse as v, type ParticipantAddedEnvelope as w, type ParticipantApprovedEnvelope as x, type ParticipantInvitedEnvelope as y, type ParticipantsQueryBuilder as z };