@wix/auto_sdk_online-programs_participants 1.0.11 → 1.0.13

package/build/cjs/index.typings.d.ts

@@ -1,18 +1,697 @@
-import { aA as CursorSearch, S as SearchParticipantsResponse } from './online-programs-v3-participant-participants.universal-DRubTE1O.js';
-export { bg as ActionEvent, aC as Aggregation, aR as AggregationData, aD as AggregationKindOneOf, b8 as AggregationResults, b9 as AggregationResultsResultOneOf, aY as AggregationResultsScalarResult, Q as AggregationType, bV as AggregationTypeWithLiterals, ad as ApplicationError, bH as BaseEventMetadata, bn as Behavior, bo as BehaviorBehaviorOneOf, bj as Benefit, bi as BenefitNotification, T as BenefitType, bX as BenefitTypeWithLiterals, bv as BulkActionMetadata, b as BulkAddAllToProgramOptions, af as BulkAddAllToProgramRequest, c as BulkAddAllToProgramResponse, q as BulkAddToProgramOptions, by as BulkAddToProgramRequest, r as BulkAddToProgramResponse, bz as BulkAddToProgramResult, u as BulkApproveAllParticipantOptions, bD as BulkApproveAllParticipantRequest, v as BulkApproveAllParticipantResponse, s as BulkApproveParticipantOptions, bA as BulkApproveParticipantRequest, t as BulkApproveParticipantResponse, bB as BulkApproveParticipantResult, B as BulkCreateParticipantOptions, aa as BulkCreateParticipantRequest, a as BulkCreateParticipantResponse, o as BulkInviteAllToProgramOptions, bx as BulkInviteAllToProgramRequest, p as BulkInviteAllToProgramResponse, m as BulkInviteToProgramOptions, bs as BulkInviteToProgramRequest, n as BulkInviteToProgramResponse, bu as BulkInviteToProgramResult, ab as BulkParticipantResult, h as BulkUpdateParticipantTagsApplicationErrors, k as BulkUpdateParticipantTagsByFilterApplicationErrors, i as BulkUpdateParticipantTagsByFilterOptions, ay as BulkUpdateParticipantTagsByFilterRequest, j as BulkUpdateParticipantTagsByFilterResponse, f as BulkUpdateParticipantTagsOptions, aw as BulkUpdateParticipantTagsRequest, g as BulkUpdateParticipantTagsResponse, ax as BulkUpdateParticipantTagsResult, $ as Certificate, ae as CommonBulkActionMetadata, ac as CommonItemMetadata, b$ as CommonQueryWithEntityContext, c0 as CommonSearchWithEntityContext, C as CreateParticipantApplicationErrors, a8 as CreateParticipantRequest, a9 as CreateParticipantResponse, ar as CursorPaging, at as CursorPagingMetadata, ao as CursorQuery, ap as CursorQueryPagingMethodOneOf, aB as CursorSearchPagingMethodOneOf, au as Cursors, aK as DateHistogramAggregation, b4 as DateHistogramResult, b6 as DateHistogramResults, ag as DeleteParticipantRequest, ah as DeleteParticipantResponse, bl as Discount, bm as DiscountDiscountOneOf, ba as DomainEvent, bb as DomainEventBodyOneOf, bh as Empty, bc as EntityCreatedEvent, bf as EntityDeletedEvent, be as EntityUpdatedEvent, bk as EntryPass, U as Event, bI as EventMetadata, bY as EventWithLiterals, bE as ExportParticipantsStatsRequest, bF as ExportParticipantsStatsResponse, a3 as ExtendedFields, Z as FreeCouponDetails, av as GetAccessStatusRequest, e as GetAccessStatusResponse, aj as GetCompletionStatsRequest, G as GetCompletionStatsResponse, al as GetParticipantRequest, am as GetParticipantResponse, ak as GetPremiumStatsRequest, d as GetPremiumStatsResponse, aO as GroupByAggregation, aP as GroupByAggregationKindOneOf, b5 as GroupByValueResults, bq as IdentificationData, br as IdentificationDataIdOneOf, aF as IncludeMissingValuesOptions, O as Interval, bU as IntervalWithLiterals, ai as IssueCertificateRequest, I as IssueCertificateResponse, bt as ItemMetadata, J as JoinPath, bM as JoinPathWithLiterals, a0 as JoinedInfo, a1 as JoinedInfoJoinPathDetailsOneOf, a2 as Member, bp as MessageEnvelope, M as MissingValues, bR as MissingValuesWithLiterals, R as Mode, bW as ModeWithLiterals, aN as NestedAggregation, aL as NestedAggregationItem, aM as NestedAggregationItemKindOneOf, aU as NestedAggregationResults, aV as NestedAggregationResultsResultOneOf, N as NestedAggregationType, bT as NestedAggregationTypeWithLiterals, b1 as NestedResultValue, b2 as NestedResultValueResultOneOf, b7 as NestedResults, aZ as NestedValueAggregationResult, Y as PaidPlanDetails, P as Participant, a6 as ParticipantAdded, w as ParticipantAddedEnvelope, bC as ParticipantApproved, x as ParticipantApprovedEnvelope, bG as ParticipantExportsFinished, bw as ParticipantInvited, y as ParticipantInvitedEnvelope, A as ParticipantQuery, bK as ParticipantQuerySpec, bL as ParticipantSearchSpec, z as ParticipantsQueryBuilder, bJ as ParticipantsQueryResult, _ as Progress, an as QueryParticipantsRequest, as as QueryParticipantsResponse, aI as RangeAggregation, aT as RangeAggregationResult, aE as RangeBucket, a$ as RangeResult, aX as RangeResults, bd as RestoreInfo, b3 as Results, aJ as ScalarAggregation, b0 as ScalarResult, L as ScalarType, bS as ScalarTypeWithLiterals, aQ as SearchDetails, az as SearchParticipantsRequest, X as SinglePaymentDetails, K as SortDirection, bQ as SortDirectionWithLiterals, F as SortOrder, bO as SortOrderWithLiterals, H as SortType, bP as SortTypeWithLiterals, aq as Sorting, V as State, b_ as StateWithLiterals, E as Status, bN as StatusWithLiterals, a5 as TagList, a4 as Tags, a7 as TagsModified, aG as ValueAggregation, aH as ValueAggregationOptionsOneOf, aS as ValueAggregationResult, a_ as ValueResult, aW as ValueResults, W as WebhookIdentityType, bZ as WebhookIdentityTypeWithLiterals, c6 as bulkAddAllToProgram, ci as bulkAddToProgram, ck as bulkApproveAllParticipant, cj as bulkApproveParticipant, c5 as bulkCreateParticipant, ch as bulkInviteAllToProgram, cg as bulkInviteToProgram, ce as bulkUpdateParticipantTags, cf as bulkUpdateParticipantTagsByFilter, c4 as createParticipant, c7 as deleteParticipant, cd as getAccessStatus, c9 as getCompletionStats, cb as getParticipant, ca as getPremiumStats, c8 as issueCertificate, c1 as onParticipantAdded, c2 as onParticipantApproved, c3 as onParticipantInvited, cc as queryParticipants, D as typedQueryParticipants } from './online-programs-v3-participant-participants.universal-DRubTE1O.js';
-import '@wix/sdk-types';
+import { NonNullablePaths } from '@wix/sdk-types';
 
-/** @hidden */
-type ParticipantSearch = {};
+interface Participant {
+    /**
+     * Participant ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /** @readonly */
+    revision?: string | null;
+    /** @readonly */
+    _createdDate?: Date | null;
+    /** @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;
+    /** state of participation in the program */
+    state?: StateWithLiterals;
+    /**
+     * Certificate issued to participant
+     * @readonly
+     */
+    certificate?: Certificate;
+    joinedInfo?: JoinedInfo;
+    /** @readonly */
+    member?: Member;
+    /** @readonly */
+    lastActivityDate?: Date | null;
+    extendedFields?: ExtendedFields;
+}
+declare enum JoinPath {
+    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 {
+    /** @format GUID */
+    paymentOrderId?: string;
+    /** @format GUID */
+    offlineTransactionId?: string | null;
+}
+interface PaidPlanDetails {
+    /** @format GUID */
+    paidPlanId?: string;
+}
+interface FreeCouponDetails {
+    /** @format GUID */
+    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 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 Certificate {
+    /**
+     * when certificate was issued, UTC
+     * @readonly
+     */
+    issuedDate?: Date | null;
+}
+interface JoinedInfo extends JoinedInfoJoinPathDetailsOneOf {
+    singlePaymentDetails?: SinglePaymentDetails;
+    paidPlanDetails?: PaidPlanDetails;
+    freeCouponDetails?: FreeCouponDetails;
+    /**
+     * @maxLength 50
+     * @readonly
+     */
+    timeZone?: string;
+    /**
+     * @format LOCAL_DATE
+     * @readonly
+     */
+    startDate?: string;
+    joinPath?: JoinPathWithLiterals;
+    /**
+     * @format LOCAL_DATE
+     * @readonly
+     */
+    finishDate?: string | null;
+}
+/** @oneof */
+interface JoinedInfoJoinPathDetailsOneOf {
+    singlePaymentDetails?: SinglePaymentDetails;
+    paidPlanDetails?: PaidPlanDetails;
+    freeCouponDetails?: FreeCouponDetails;
+}
+interface Member {
+    /**
+     * @readonly
+     * @maxLength 100
+     */
+    firstName?: string | null;
+    /**
+     * @readonly
+     * @maxLength 100
+     */
+    lastName?: string | null;
+    /**
+     * @readonly
+     * @format EMAIL
+     */
+    email?: string | null;
+    /** @format GUID */
+    contactId?: string;
+    /**
+     * @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>>;
+}
+interface ParticipantAdded {
+    /**
+     * Program ID which participant was added
+     * @format GUID
+     */
+    programId?: string;
+    /**
+     * Member ID of participant on site
+     * @format GUID
+     */
+    memberId?: string;
+}
+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 ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+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 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 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';
+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;
+    accountInfo?: AccountInfoMetadata;
+}
+interface AccountInfoMetadata {
+    /** ID of the Wix account associated with the event */
+    accountId: string;
+    /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
+    siteId?: string;
+    /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
+    parentAccountId?: string;
+}
+interface 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;
+/**
+ * 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.state` | `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.state` | `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.state` | `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;
+}
 /**
- * Retrieves a list of programs according to search criteria
- * @param search - Query to search programs
+ * Bulk approves all pending participants, who asked to join private program (aka
+ * in state `APPROVAL_PENDING`).
  * @public
  * @documentationMaturity preview
- * @requiredField search
- * @permissionId online_programs:v3:participant:search_participants
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.SearchParticipants
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_APPROVE
+ * @fqn wix.onlineprograms.participants.v3.ManageParticipantsService.BulkApproveAllParticipant
  */
-declare function searchParticipants(search: CursorSearch): Promise<SearchParticipantsResponse>;
+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[];
+}
 
-export { CursorSearch, type ParticipantSearch, SearchParticipantsResponse, searchParticipants };
+export { type ActionEvent, type ApplicationError, type BaseEventMetadata, type BulkActionMetadata, type BulkAddToProgramOptions, type BulkAddToProgramRequest, type BulkAddToProgramResponse, type BulkAddToProgramResult, type BulkApproveAllParticipantOptions, type BulkApproveAllParticipantRequest, type BulkApproveAllParticipantResponse, type BulkApproveParticipantOptions, type BulkApproveParticipantRequest, type BulkApproveParticipantResponse, type BulkApproveParticipantResult, type BulkInviteAllToProgramOptions, type BulkInviteAllToProgramRequest, type BulkInviteAllToProgramResponse, type BulkInviteToProgramOptions, type BulkInviteToProgramRequest, type BulkInviteToProgramResponse, type BulkInviteToProgramResult, type Certificate, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type FreeCouponDetails, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, JoinPath, type JoinPathWithLiterals, type JoinedInfo, type JoinedInfoJoinPathDetailsOneOf, type Member, type MessageEnvelope, type PaidPlanDetails, type Participant, type ParticipantAdded, type ParticipantAddedEnvelope, type ParticipantApproved, type ParticipantApprovedEnvelope, type ParticipantInvited, type ParticipantInvitedEnvelope, type Progress, type RestoreInfo, type SinglePaymentDetails, State, type StateWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram, onParticipantAdded, onParticipantApproved, onParticipantInvited };