@wix/auto_sdk_online-programs_participants 1.0.10 → 1.0.12

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

@@ -185,41 +185,29 @@ interface ParticipantAdded {
      */
     memberId?: string;
 }
-interface CreateParticipantRequest {
-    /** Participant to create */
-    participant: Participant;
-}
-interface CreateParticipantResponse {
-    /** Created participant */
-    participant?: Participant;
-}
-interface BulkCreateParticipantRequest {
+interface BulkInviteToProgramRequest {
     /**
-     * List of participants you want to create
-     * @minSize 1
-     * @maxSize 100
+     * Program to which bulk invite participants.
+     * @format GUID
      */
-    participants: Participant[];
-    /** Whether to return entities in response or not. */
-    returnEntity?: boolean;
-}
-interface BulkCreateParticipantResponse {
+    programId: string;
     /**
-     * Results of bulk action.
+     * Return added participants in the response or not.
+     * @format GUID
      * @minSize 1
      * @maxSize 100
      */
-    results?: BulkParticipantResult[];
-    /** Metadata about whole bulk action. */
-    bulkActionMetadata?: CommonBulkActionMetadata;
+    memberIds?: string[];
+    /** Return invited participants in the response or not. */
+    returnEntity?: boolean;
 }
-interface BulkParticipantResult {
-    /** Metadata of item. */
-    itemMetadata?: CommonItemMetadata;
-    /** Item itself (empty if return_entity in request is false). */
-    item?: Participant;
+interface BulkInviteToProgramResponse {
+    /** Participants created by bulk action */
+    results?: BulkInviteToProgramResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
 }
-interface CommonItemMetadata {
+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. */
@@ -237,7 +225,13 @@ interface ApplicationError {
     /** Data related to the error. */
     data?: Record<string, any> | null;
 }
-interface CommonBulkActionMetadata {
+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. */
@@ -245,180 +239,121 @@ interface CommonBulkActionMetadata {
     /** 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;
+interface ParticipantInvited {
     /**
-     * Exclude site members.
+     * Program to which bulk invite participants.
      * @format GUID
-     * @maxSize 100
      */
-    excludeMemberIds?: string[];
-}
-interface BulkAddAllToProgramResponse {
+    programId?: string;
     /**
-     * Async infra job id which will process the request.
+     * Invited member to program
      * @format GUID
      */
-    jobId?: string;
+    memberId?: string;
 }
-interface DeleteParticipantRequest {
+interface BulkInviteAllToProgramRequest {
     /**
-     * Participants to delete
+     * Program to which bulk add participants.
      * @format GUID
      */
-    participantId: string;
-}
-interface DeleteParticipantResponse {
-}
-interface IssueCertificateRequest {
+    programId: string;
     /**
-     * Participant to get certificate
+     * Exclude site members.
      * @format GUID
+     * @maxSize 100
      */
-    participantId: string;
+    excludeMemberIds?: string[];
 }
-interface IssueCertificateResponse {
-    /** Updated participant */
-    participant?: Participant;
+interface BulkInviteAllToProgramResponse {
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
 }
-interface GetCompletionStatsRequest {
+interface BulkAddToProgramRequest {
     /**
-     * program id to get stats for
+     * Program to which bulk add participants.
      * @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
+     * Site members.
      * @format GUID
+     * @minSize 1
+     * @maxSize 1000
      */
-    participantId: string;
+    memberIds?: string[];
+    /** Return added participants in the response or not. */
+    returnEntity?: boolean;
 }
-interface GetParticipantResponse {
-    /** existing participant */
-    participant?: Participant;
+interface BulkAddToProgramResponse {
+    /** Participants created by bulk action */
+    results?: BulkAddToProgramResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
 }
-interface QueryParticipantsRequest {
-    /** Platformized query */
-    query?: CursorQuery;
+interface BulkAddToProgramResult {
+    /** Added participant metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Added participant */
+    item?: Participant;
 }
-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;
+interface BulkApproveParticipantRequest {
     /**
-     * Sort object.
-     *
-     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
-     * @maxSize 5
+     * Participants to add
+     * @format GUID
+     * @maxSize 100
      */
-    sort?: Sorting[];
-}
-/** @oneof */
-interface CursorQueryPagingMethodOneOf {
+    participantIds: string[];
     /**
-     * Cursor paging options.
-     *
-     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     * program to approve participant
+     * @format GUID
      */
-    cursorPaging?: CursorPaging;
+    programId?: string;
+    /** Return approved participants in the response or not */
+    returnEntity?: boolean;
 }
-interface Sorting {
-    /**
-     * Name of the field to sort by.
-     * @maxLength 512
-     */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrderWithLiterals;
+interface BulkApproveParticipantResponse {
+    /** Participants approved by bulk action */
+    results?: BulkApproveParticipantResult[];
+    /** Bulk action metadata */
+    bulkActionMetadata?: BulkActionMetadata;
 }
-declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
+interface BulkApproveParticipantResult {
+    /** Approved participant metadata */
+    itemMetadata?: ItemMetadata;
+    /** Approved or existing participant */
+    item?: Participant;
 }
-/** @enumType */
-type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-interface CursorPaging {
+interface ParticipantApproved {
     /**
-     * Maximum number of items to return in the results.
-     * @max 100
+     * Program ID which participant approved
+     * @format GUID
      */
-    limit?: number | null;
+    programId?: string;
     /**
-     * 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
+     * Member ID of participant approved
+     * @format GUID
      */
-    cursor?: string | null;
-}
-interface QueryParticipantsResponse {
-    /** found participants */
-    participants?: Participant[];
-    /** paging metadata */
-    pagingMetadata?: CursorPagingMetadata;
+    memberId?: string;
 }
-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;
+interface BulkApproveAllParticipantRequest {
     /**
-     * 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.
+     * Program to approve all participants.
+     * @format GUID
      */
-    hasNext?: boolean | null;
-}
-interface Cursors {
+    programId?: string;
     /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
+     * Exclude site members.
+     * @format GUID
+     * @maxSize 100
      */
-    next?: string | null;
+    excludeParticipantIds?: string[];
+}
+interface BulkApproveAllParticipantResponse {
     /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
+     * Job id with async process
+     * @format GUID
      */
-    prev?: string | null;
-}
-interface GetAccessStatusRequest {
-}
-interface GetAccessStatusResponse {
-    /** True if participants cannot access online programs due to some limitations */
-    isBlocked?: boolean;
+    jobId?: string;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
@@ -482,115 +417,6 @@ interface EntityDeletedEvent {
 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.
@@ -663,202 +489,6 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-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>;
-};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -944,193 +574,6 @@ interface ParticipantInvitedEnvelope {
  * @documentationMaturity preview
  */
 declare function onParticipantInvited(handler: (event: ParticipantInvitedEnvelope) => void | Promise<void>): void;
-/** @param participant - Participant to create
- * @public
- * @documentationMaturity preview
- * @requiredField participant
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_CREATE
- * @returns Created participant
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.CreateParticipant
- */
-declare function createParticipant(participant: Participant): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state` | `joinedInfo.singlePaymentDetails.paymentOrderId` | `joinedInfo.paidPlanDetails.paidPlanId` | `joinedInfo.freeCouponDetails.freeCouponId` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 4> & {
-    __applicationErrorsType?: CreateParticipantApplicationErrors;
-}>;
-/**
- * Creates participants in bulk.
- * @param participants - List of participants you want to create
- * @public
- * @documentationMaturity preview
- * @requiredField participants
- * @permissionId ONLINE_PROGRAMS.PARTICIPANT_CREATE
- * @fqn wix.onlineprograms.participants.v3.ParticipantsService.BulkCreateParticipant
- */
-declare function bulkCreateParticipant(participants: Participant[], 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.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 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.state` | `participant.joinedInfo.singlePaymentDetails.paymentOrderId` | `participant.joinedInfo.paidPlanDetails.paidPlanId` | `participant.joinedInfo.freeCouponDetails.freeCouponId` | `participant.joinedInfo.timeZone` | `participant.joinedInfo.startDate` | `participant.joinedInfo.joinPath` | `participant.member.contactId`, 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` | `state` | `joinedInfo.singlePaymentDetails.paymentOrderId` | `joinedInfo.paidPlanDetails.paidPlanId` | `joinedInfo.freeCouponDetails.freeCouponId` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 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' | 'state', 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' | 'state', 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' | 'state' | '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' | 'state' | '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: CursorQuery): Promise<NonNullablePaths<QueryParticipantsResponse, `participants` | `participants.${number}.memberId` | `participants.${number}.programId` | `participants.${number}.progress.totalStepsCompleted` | `participants.${number}.progress.totalStepsAvailable` | `participants.${number}.progress.completionPercentage` | `participants.${number}.state` | `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>>;
-/**
- * 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, `isBlocked`, 2>>;
 /**
  * Bulk invites participants to program.
  * For each member participant in Invited state is created.
@@ -1242,4 +685,4 @@ interface BulkApproveAllParticipantOptions {
     excludeParticipantIds?: string[];
 }
 
-export { type ActionEvent, type ApplicationError, type BaseEventMetadata, type Behavior, type BehaviorBehaviorOneOf, type Benefit, type BenefitNotification, BenefitType, type BenefitTypeWithLiterals, type BulkActionMetadata, type BulkAddAllToProgramOptions, type BulkAddAllToProgramRequest, type BulkAddAllToProgramResponse, type BulkAddToProgramOptions, type BulkAddToProgramRequest, type BulkAddToProgramResponse, type BulkAddToProgramResult, type BulkApproveAllParticipantOptions, type BulkApproveAllParticipantRequest, type BulkApproveAllParticipantResponse, type BulkApproveParticipantOptions, type BulkApproveParticipantRequest, type BulkApproveParticipantResponse, type BulkApproveParticipantResult, type BulkCreateParticipantOptions, type BulkCreateParticipantRequest, type BulkCreateParticipantResponse, type BulkInviteAllToProgramOptions, type BulkInviteAllToProgramRequest, type BulkInviteAllToProgramResponse, type BulkInviteToProgramOptions, type BulkInviteToProgramRequest, type BulkInviteToProgramResponse, type BulkInviteToProgramResult, type BulkParticipantResult, type Certificate, type CommonBulkActionMetadata, type CommonItemMetadata, type CreateParticipantApplicationErrors, type CreateParticipantRequest, type CreateParticipantResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteParticipantRequest, type DeleteParticipantResponse, type Discount, type DiscountDiscountOneOf, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EntryPass, Event, type EventMetadata, type EventWithLiterals, type ExportParticipantsStatsRequest, type ExportParticipantsStatsResponse, type ExtendedFields, type FreeCouponDetails, type GetAccessStatusRequest, type GetAccessStatusResponse, type GetCompletionStatsRequest, type GetCompletionStatsResponse, type GetParticipantRequest, type GetParticipantResponse, type GetPremiumStatsRequest, type GetPremiumStatsResponse, type IdentificationData, type IdentificationDataIdOneOf, type IssueCertificateRequest, type IssueCertificateResponse, 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 ParticipantExportsFinished, type ParticipantInvited, type ParticipantInvitedEnvelope, type ParticipantsQueryBuilder, type ParticipantsQueryResult, type Progress, type QueryParticipantsRequest, type QueryParticipantsResponse, type RestoreInfo, type SinglePaymentDetails, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkCreateParticipant, bulkInviteAllToProgram, bulkInviteToProgram, createParticipant, deleteParticipant, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, onParticipantAdded, onParticipantApproved, onParticipantInvited, queryParticipants, typedQueryParticipants };
+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 };