@wix/auto_sdk_online-programs_participants 1.0.17 → 1.0.19

package/build/cjs/{online-programs-participants-v3-participant-participants.universal-CUPgynYg.d.ts → online-programs-participants-v3-participant-participants.universal-Cbh9oHrm.d.ts}

@@ -670,6 +670,33 @@ interface GetPremiumStatsResponse {
     /** Limit of active participants on a site without premium */
     activeParticipantsLimit?: number;
 }
+interface GetParticipationStatsRequest {
+    /**
+     * IDs of the programs to retrieve participant statistics for.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    programIds: string[];
+}
+interface GetParticipationStatsResponse {
+    /**
+     * Participant statistics for each distinct requested program ID.
+     * @maxSize 100
+     */
+    participationStats?: ProgramParticipationStats[];
+}
+interface ProgramParticipationStats {
+    /**
+     * Program ID.
+     * @format GUID
+     */
+    programId?: string;
+    /** Number of participants who joined the program, including suspended and finished participants. */
+    participantsCount?: number;
+    /** Number of participants automatically removed when the program duration ended. */
+    autoRemovedCount?: number;
+}
 interface GetParticipantRequest {
     /**
      * ID of the participant to fetch.
@@ -1816,7 +1843,11 @@ interface CreateParticipantOptions {
     fields?: RequestedFieldsWithLiterals[];
 }
 /**
- * Updates a participant's enrollment status, progress status, or enrollment pricing details.
+ * Updates a participant's enrollment status or enrollment pricing details.
+ *
+ * Use this method to suspend or resume a participant by setting `enrollment_status` to
+ * `SUSPENDED` or `JOINED`. To remove a participant, use `DeleteParticipant`.
+ * Progress status is calculated from the participant's resolved steps and can't be updated.
  * @param _id - Participant ID.
  * @public
  * @documentationMaturity preview
@@ -2009,6 +2040,16 @@ interface IssueCertificateOptions {
  * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetPremiumStats
  */
 declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
+/**
+ * Retrieves participant statistics for the requested programs.
+ * @param programIds - IDs of the programs to retrieve participant statistics for.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField programIds
+ * @permissionId online_programs:participants:v3:participant:get_participation_stats
+ * @fqn wix.onlineprograms.participants.v3.ParticipantsService.GetParticipationStats
+ */
+declare function getParticipationStats(programIds: string[]): Promise<NonNullablePaths<GetParticipationStatsResponse, `participationStats` | `participationStats.${number}.programId` | `participationStats.${number}.participantsCount` | `participationStats.${number}.autoRemovedCount`, 4>>;
 /**
  * Returns a participant by ID.
  * @param participantId - ID of the participant to fetch.
@@ -2444,4 +2485,4 @@ type ParticipantSearch = {
     timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
 };
 
-export { type SinglePaymentDetails as $, type ParticipantUpdatedEnvelope as A, type BulkCreateParticipantsOptions as B, type CreateParticipantOptions as C, type ParticipantQuery as D, typedQueryParticipants as E, type ParticipantsQueryBuilder as F, type GetPremiumStatsResponse as G, PricingType as H, type IssueCertificateOptions as I, EnrollmentStatus as J, ProgressStatus as K, BulkActionType as L, SortOrder as M, SortType as N, SortDirection as O, type Participant as P, type QueryParticipantsOptions as Q, RequestedFields as R, type SearchParticipantsOptions as S, MissingValues as T, type UpdateParticipant as U, ScalarType as V, NestedAggregationType as W, Interval as X, AggregationType as Y, Mode as Z, WebhookIdentityType as _, type CreateParticipantApplicationErrors as a, type CursorSearch as a$, type PaidPlanDetails as a0, type FreeCouponDetails as a1, type Progress as a2, type CertificateInfo as a3, type Member as a4, type EnrollmentInfo as a5, type EnrollmentInfoPricingTypeDetailsOneOf as a6, type ExtendedFields as a7, type Tags as a8, type TagList as a9, type ReindexParticipantsSearchRequest as aA, type ReindexParticipantsSearchResponse as aB, type SynchronizeTimeCapsuleTasksRequest as aC, type SynchronizeTimeCapsuleTasksResponse as aD, type BulkCreateParticipantsForAllMembersRequest as aE, type DeleteParticipantRequest as aF, type DeleteParticipantResponse as aG, type IssueCertificateRequest as aH, type GetCompletionStatsRequest as aI, type GetCompletionStatsResponse as aJ, type GetPremiumStatsRequest as aK, type GetParticipantRequest as aL, type GetParticipantResponse as aM, type QueryParticipantsRequest as aN, type QueryV2 as aO, type QueryV2PagingMethodOneOf as aP, type Sorting as aQ, type Paging as aR, type CursorPaging as aS, type QueryParticipantsResponse as aT, type PagingMetadataV2 as aU, type Cursors as aV, type GetAccessStatusRequest as aW, type BulkUpdateParticipantTagsRequest as aX, type BulkUpdateParticipantTagsResult as aY, type BulkUpdateParticipantTagsByFilterRequest as aZ, type SearchParticipantsRequest as a_, type ReindexMessage as aa, type ReindexMessageActionOneOf as ab, type Upsert as ac, type Delete as ad, type Schema as ae, type ParticipantTagsModified as af, type ParticipantCompletedProgram as ag, type ParticipantMissedProgramDeadline as ah, type ParticipantProgramDurationEnded as ai, type ParticipantRemoved as aj, type ParticipantLeft as ak, type CreateParticipantRequest as al, type CreateParticipantResponse as am, type UpdateParticipantRequest as an, type UpdateParticipantResponse as ao, type BulkCreateParticipantsRequest as ap, type BulkParticipantResult as aq, type ItemMetadata as ar, type ApplicationError as as, type BulkActionMetadata as at, type BulkUpsertParticipantsMigrationRequest as au, type ParticipantMigration as av, type BulkUpsertParticipantsMigrationResponse as aw, type BulkParticipantMigrationResult as ax, type DeleteAllParticipantsMigrationRequest as ay, type DeleteAllParticipantsMigrationResponse as az, type UpdateParticipantOptions as b, type BulkActionTypeWithLiterals as b$, type CursorSearchPagingMethodOneOf as b0, type Aggregation as b1, type AggregationKindOneOf as b2, type RangeBucket as b3, type IncludeMissingValuesOptions as b4, type ValueAggregation as b5, type ValueAggregationOptionsOneOf as b6, type RangeAggregation as b7, type ScalarAggregation as b8, type DateHistogramAggregation as b9, type AggregationResults as bA, type AggregationResultsResultOneOf as bB, type DomainEvent as bC, type DomainEventBodyOneOf as bD, type EntityCreatedEvent as bE, type RestoreInfo as bF, type EntityUpdatedEvent as bG, type EntityDeletedEvent as bH, type ActionEvent as bI, type Empty as bJ, type MessageEnvelope as bK, type IdentificationData as bL, type IdentificationDataIdOneOf as bM, type AccountInfo as bN, type ExportParticipantsStatsRequest as bO, type ExportParticipantsStatsResponse as bP, type BaseEventMetadata as bQ, type EventMetadata as bR, type AccountInfoMetadata as bS, type ParticipantsQueryResult as bT, type ParticipantQuerySpec as bU, type ParticipantSearchSpec as bV, utils as bW, type PricingTypeWithLiterals as bX, type EnrollmentStatusWithLiterals as bY, type ProgressStatusWithLiterals as bZ, type RequestedFieldsWithLiterals as b_, type NestedAggregationItem as ba, type NestedAggregationItemKindOneOf as bb, type NestedAggregation as bc, type GroupByAggregation as bd, type GroupByAggregationKindOneOf as be, type SearchDetails as bf, type CursorPagingMetadata as bg, type AggregationData as bh, type ValueAggregationResult as bi, type RangeAggregationResult as bj, type NestedAggregationResults as bk, type NestedAggregationResultsResultOneOf as bl, type ValueResults as bm, type RangeResults as bn, type AggregationResultsScalarResult as bo, type NestedValueAggregationResult as bp, type ValueResult as bq, type RangeResult as br, type ScalarResult as bs, type NestedResultValue as bt, type NestedResultValueResultOneOf as bu, type Results as bv, type DateHistogramResult as bw, type GroupByValueResults as bx, type DateHistogramResults as by, type NestedResults as bz, type BulkCreateParticipantsResponse as c, type SortOrderWithLiterals as c0, type SortTypeWithLiterals as c1, type SortDirectionWithLiterals as c2, type MissingValuesWithLiterals as c3, type ScalarTypeWithLiterals as c4, type NestedAggregationTypeWithLiterals as c5, type IntervalWithLiterals as c6, type AggregationTypeWithLiterals as c7, type ModeWithLiterals as c8, type WebhookIdentityTypeWithLiterals as c9, type CommonQueryWithEntityContext as ca, type CommonSearchWithEntityContext as cb, onParticipantCompletedProgram as cc, onParticipantCreated as cd, onParticipantDeleted as ce, onParticipantLeft as cf, onParticipantMissedProgramDeadline as cg, onParticipantProgramDurationEnded as ch, onParticipantRemoved as ci, onParticipantTagsModified as cj, onParticipantUpdated as ck, createParticipant as cl, updateParticipant as cm, bulkCreateParticipants as cn, bulkCreateParticipantsForAllMembers as co, deleteParticipant as cp, issueCertificate as cq, getPremiumStats as cr, getParticipant as cs, queryParticipants as ct, getAccessStatus as cu, bulkUpdateParticipantTags as cv, bulkUpdateParticipantTagsByFilter as cw, type BulkCreateParticipantsApplicationErrors as d, type BulkCreateParticipantsForAllMembersOptions as e, type BulkCreateParticipantsForAllMembersResponse as f, type IssueCertificateResponse as g, type IssueCertificateApplicationErrors as h, type GetParticipantOptions as i, type GetAccessStatusResponse as j, type BulkUpdateParticipantTagsOptions as k, type BulkUpdateParticipantTagsResponse as l, type BulkUpdateParticipantTagsApplicationErrors as m, type BulkUpdateParticipantTagsByFilterOptions as n, type BulkUpdateParticipantTagsByFilterResponse as o, type BulkUpdateParticipantTagsByFilterApplicationErrors as p, type ParticipantSearch as q, type SearchParticipantsResponse as r, type ParticipantCompletedProgramEnvelope as s, type ParticipantCreatedEnvelope as t, type ParticipantDeletedEnvelope as u, type ParticipantLeftEnvelope as v, type ParticipantMissedProgramDeadlineEnvelope as w, type ParticipantProgramDurationEndedEnvelope as x, type ParticipantRemovedEnvelope as y, type ParticipantTagsModifiedEnvelope as z };
+export { WebhookIdentityType as $, type ParticipantTagsModifiedEnvelope as A, type BulkCreateParticipantsOptions as B, type CreateParticipantOptions as C, type ParticipantUpdatedEnvelope as D, type ParticipantQuery as E, typedQueryParticipants as F, type GetPremiumStatsResponse as G, type ParticipantsQueryBuilder as H, type IssueCertificateOptions as I, PricingType as J, EnrollmentStatus as K, ProgressStatus as L, BulkActionType as M, SortOrder as N, SortType as O, type Participant as P, type QueryParticipantsOptions as Q, RequestedFields as R, type SearchParticipantsOptions as S, SortDirection as T, type UpdateParticipant as U, MissingValues as V, ScalarType as W, NestedAggregationType as X, Interval as Y, AggregationType as Z, Mode as _, type CreateParticipantApplicationErrors as a, type BulkUpdateParticipantTagsResult as a$, type SinglePaymentDetails as a0, type PaidPlanDetails as a1, type FreeCouponDetails as a2, type Progress as a3, type CertificateInfo as a4, type Member as a5, type EnrollmentInfo as a6, type EnrollmentInfoPricingTypeDetailsOneOf as a7, type ExtendedFields as a8, type Tags as a9, type DeleteAllParticipantsMigrationResponse as aA, type ReindexParticipantsSearchRequest as aB, type ReindexParticipantsSearchResponse as aC, type SynchronizeTimeCapsuleTasksRequest as aD, type SynchronizeTimeCapsuleTasksResponse as aE, type BulkCreateParticipantsForAllMembersRequest as aF, type DeleteParticipantRequest as aG, type DeleteParticipantResponse as aH, type IssueCertificateRequest as aI, type GetCompletionStatsRequest as aJ, type GetCompletionStatsResponse as aK, type GetPremiumStatsRequest as aL, type GetParticipationStatsRequest as aM, type ProgramParticipationStats as aN, type GetParticipantRequest as aO, type GetParticipantResponse as aP, type QueryParticipantsRequest as aQ, type QueryV2 as aR, type QueryV2PagingMethodOneOf as aS, type Sorting as aT, type Paging as aU, type CursorPaging as aV, type QueryParticipantsResponse as aW, type PagingMetadataV2 as aX, type Cursors as aY, type GetAccessStatusRequest as aZ, type BulkUpdateParticipantTagsRequest as a_, type TagList as aa, type ReindexMessage as ab, type ReindexMessageActionOneOf as ac, type Upsert as ad, type Delete as ae, type Schema as af, type ParticipantTagsModified as ag, type ParticipantCompletedProgram as ah, type ParticipantMissedProgramDeadline as ai, type ParticipantProgramDurationEnded as aj, type ParticipantRemoved as ak, type ParticipantLeft as al, type CreateParticipantRequest as am, type CreateParticipantResponse as an, type UpdateParticipantRequest as ao, type UpdateParticipantResponse as ap, type BulkCreateParticipantsRequest as aq, type BulkParticipantResult as ar, type ItemMetadata as as, type ApplicationError as at, type BulkActionMetadata as au, type BulkUpsertParticipantsMigrationRequest as av, type ParticipantMigration as aw, type BulkUpsertParticipantsMigrationResponse as ax, type BulkParticipantMigrationResult as ay, type DeleteAllParticipantsMigrationRequest as az, type UpdateParticipantOptions as b, type EnrollmentStatusWithLiterals as b$, type BulkUpdateParticipantTagsByFilterRequest as b0, type SearchParticipantsRequest as b1, type CursorSearch as b2, type CursorSearchPagingMethodOneOf as b3, type Aggregation as b4, type AggregationKindOneOf as b5, type RangeBucket as b6, type IncludeMissingValuesOptions as b7, type ValueAggregation as b8, type ValueAggregationOptionsOneOf as b9, type GroupByValueResults as bA, type DateHistogramResults as bB, type NestedResults as bC, type AggregationResults as bD, type AggregationResultsResultOneOf as bE, type DomainEvent as bF, type DomainEventBodyOneOf as bG, type EntityCreatedEvent as bH, type RestoreInfo as bI, type EntityUpdatedEvent as bJ, type EntityDeletedEvent as bK, type ActionEvent as bL, type Empty as bM, type MessageEnvelope as bN, type IdentificationData as bO, type IdentificationDataIdOneOf as bP, type AccountInfo as bQ, type ExportParticipantsStatsRequest as bR, type ExportParticipantsStatsResponse as bS, type BaseEventMetadata as bT, type EventMetadata as bU, type AccountInfoMetadata as bV, type ParticipantsQueryResult as bW, type ParticipantQuerySpec as bX, type ParticipantSearchSpec as bY, utils as bZ, type PricingTypeWithLiterals as b_, type RangeAggregation as ba, type ScalarAggregation as bb, type DateHistogramAggregation as bc, type NestedAggregationItem as bd, type NestedAggregationItemKindOneOf as be, type NestedAggregation as bf, type GroupByAggregation as bg, type GroupByAggregationKindOneOf as bh, type SearchDetails as bi, type CursorPagingMetadata as bj, type AggregationData as bk, type ValueAggregationResult as bl, type RangeAggregationResult as bm, type NestedAggregationResults as bn, type NestedAggregationResultsResultOneOf as bo, type ValueResults as bp, type RangeResults as bq, type AggregationResultsScalarResult as br, type NestedValueAggregationResult as bs, type ValueResult as bt, type RangeResult as bu, type ScalarResult as bv, type NestedResultValue as bw, type NestedResultValueResultOneOf as bx, type Results as by, type DateHistogramResult as bz, type BulkCreateParticipantsResponse as c, type ProgressStatusWithLiterals as c0, type RequestedFieldsWithLiterals as c1, type BulkActionTypeWithLiterals as c2, type SortOrderWithLiterals as c3, type SortTypeWithLiterals as c4, type SortDirectionWithLiterals as c5, type MissingValuesWithLiterals as c6, type ScalarTypeWithLiterals as c7, type NestedAggregationTypeWithLiterals as c8, type IntervalWithLiterals as c9, bulkUpdateParticipantTagsByFilter as cA, type AggregationTypeWithLiterals as ca, type ModeWithLiterals as cb, type WebhookIdentityTypeWithLiterals as cc, type CommonQueryWithEntityContext as cd, type CommonSearchWithEntityContext as ce, onParticipantCompletedProgram as cf, onParticipantCreated as cg, onParticipantDeleted as ch, onParticipantLeft as ci, onParticipantMissedProgramDeadline as cj, onParticipantProgramDurationEnded as ck, onParticipantRemoved as cl, onParticipantTagsModified as cm, onParticipantUpdated as cn, createParticipant as co, updateParticipant as cp, bulkCreateParticipants as cq, bulkCreateParticipantsForAllMembers as cr, deleteParticipant as cs, issueCertificate as ct, getPremiumStats as cu, getParticipationStats as cv, getParticipant as cw, queryParticipants as cx, getAccessStatus as cy, bulkUpdateParticipantTags as cz, type BulkCreateParticipantsApplicationErrors as d, type BulkCreateParticipantsForAllMembersOptions as e, type BulkCreateParticipantsForAllMembersResponse as f, type IssueCertificateResponse as g, type IssueCertificateApplicationErrors as h, type GetParticipationStatsResponse as i, type GetParticipantOptions as j, type GetAccessStatusResponse as k, type BulkUpdateParticipantTagsOptions as l, type BulkUpdateParticipantTagsResponse as m, type BulkUpdateParticipantTagsApplicationErrors as n, type BulkUpdateParticipantTagsByFilterOptions as o, type BulkUpdateParticipantTagsByFilterResponse as p, type BulkUpdateParticipantTagsByFilterApplicationErrors as q, type ParticipantSearch as r, type SearchParticipantsResponse as s, type ParticipantCompletedProgramEnvelope as t, type ParticipantCreatedEnvelope as u, type ParticipantDeletedEnvelope as v, type ParticipantLeftEnvelope as w, type ParticipantMissedProgramDeadlineEnvelope as x, type ParticipantProgramDurationEndedEnvelope as y, type ParticipantRemovedEnvelope as z };

package/build/es/index.d.mts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { P as Participant, C as CreateParticipantOptions, a as CreateParticipantApplicationErrors, U as UpdateParticipant, b as UpdateParticipantOptions, B as BulkCreateParticipantsOptions, c as BulkCreateParticipantsResponse, d as BulkCreateParticipantsApplicationErrors, e as BulkCreateParticipantsForAllMembersOptions, f as BulkCreateParticipantsForAllMembersResponse, I as IssueCertificateOptions, g as IssueCertificateResponse, h as IssueCertificateApplicationErrors, G as GetPremiumStatsResponse, i as GetParticipantOptions, j as GetAccessStatusResponse, k as BulkUpdateParticipantTagsOptions, l as BulkUpdateParticipantTagsResponse, m as BulkUpdateParticipantTagsApplicationErrors, n as BulkUpdateParticipantTagsByFilterOptions, o as BulkUpdateParticipantTagsByFilterResponse, p as BulkUpdateParticipantTagsByFilterApplicationErrors, q as ParticipantSearch, S as SearchParticipantsOptions, r as SearchParticipantsResponse, s as ParticipantCompletedProgramEnvelope, t as ParticipantCreatedEnvelope, u as ParticipantDeletedEnvelope, v as ParticipantLeftEnvelope, w as ParticipantMissedProgramDeadlineEnvelope, x as ParticipantProgramDurationEndedEnvelope, y as ParticipantRemovedEnvelope, z as ParticipantTagsModifiedEnvelope, A as ParticipantUpdatedEnvelope, D as ParticipantQuery, Q as QueryParticipantsOptions, E as typedQueryParticipants, F as ParticipantsQueryBuilder } from './online-programs-participants-v3-participant-participants.universal-CUPgynYg.mjs';
-export { bN as AccountInfo, bS as AccountInfoMetadata, bI as ActionEvent, b1 as Aggregation, bh as AggregationData, b2 as AggregationKindOneOf, bA as AggregationResults, bB as AggregationResultsResultOneOf, bo as AggregationResultsScalarResult, Y as AggregationType, c7 as AggregationTypeWithLiterals, as as ApplicationError, bQ as BaseEventMetadata, at as BulkActionMetadata, L as BulkActionType, b$ as BulkActionTypeWithLiterals, aE as BulkCreateParticipantsForAllMembersRequest, ap as BulkCreateParticipantsRequest, ax as BulkParticipantMigrationResult, aq as BulkParticipantResult, aZ as BulkUpdateParticipantTagsByFilterRequest, aX as BulkUpdateParticipantTagsRequest, aY as BulkUpdateParticipantTagsResult, au as BulkUpsertParticipantsMigrationRequest, aw as BulkUpsertParticipantsMigrationResponse, a3 as CertificateInfo, ca as CommonQueryWithEntityContext, cb as CommonSearchWithEntityContext, al as CreateParticipantRequest, am as CreateParticipantResponse, aS as CursorPaging, bg as CursorPagingMetadata, a$ as CursorSearch, b0 as CursorSearchPagingMethodOneOf, aV as Cursors, b9 as DateHistogramAggregation, bw as DateHistogramResult, by as DateHistogramResults, ad as Delete, ay as DeleteAllParticipantsMigrationRequest, az as DeleteAllParticipantsMigrationResponse, aF as DeleteParticipantRequest, aG as DeleteParticipantResponse, bC as DomainEvent, bD as DomainEventBodyOneOf, bJ as Empty, a5 as EnrollmentInfo, a6 as EnrollmentInfoPricingTypeDetailsOneOf, J as EnrollmentStatus, bY as EnrollmentStatusWithLiterals, bE as EntityCreatedEvent, bH as EntityDeletedEvent, bG as EntityUpdatedEvent, bR as EventMetadata, bO as ExportParticipantsStatsRequest, bP as ExportParticipantsStatsResponse, a7 as ExtendedFields, a1 as FreeCouponDetails, aW as GetAccessStatusRequest, aI as GetCompletionStatsRequest, aJ as GetCompletionStatsResponse, aL as GetParticipantRequest, aM as GetParticipantResponse, aK as GetPremiumStatsRequest, bd as GroupByAggregation, be as GroupByAggregationKindOneOf, bx as GroupByValueResults, bL as IdentificationData, bM as IdentificationDataIdOneOf, b4 as IncludeMissingValuesOptions, X as Interval, c6 as IntervalWithLiterals, aH as IssueCertificateRequest, ar as ItemMetadata, a4 as Member, bK as MessageEnvelope, T as MissingValues, c3 as MissingValuesWithLiterals, Z as Mode, c8 as ModeWithLiterals, bc as NestedAggregation, ba as NestedAggregationItem, bb as NestedAggregationItemKindOneOf, bk as NestedAggregationResults, bl as NestedAggregationResultsResultOneOf, W as NestedAggregationType, c5 as NestedAggregationTypeWithLiterals, bt as NestedResultValue, bu as NestedResultValueResultOneOf, bz as NestedResults, bp as NestedValueAggregationResult, aR as Paging, aU as PagingMetadataV2, a0 as PaidPlanDetails, ag as ParticipantCompletedProgram, ak as ParticipantLeft, av as ParticipantMigration, ah as ParticipantMissedProgramDeadline, ai as ParticipantProgramDurationEnded, bU as ParticipantQuerySpec, aj as ParticipantRemoved, bV as ParticipantSearchSpec, af as ParticipantTagsModified, bT as ParticipantsQueryResult, H as PricingType, bX as PricingTypeWithLiterals, a2 as Progress, K as ProgressStatus, bZ as ProgressStatusWithLiterals, aN as QueryParticipantsRequest, aT as QueryParticipantsResponse, aO as QueryV2, aP as QueryV2PagingMethodOneOf, b7 as RangeAggregation, bj as RangeAggregationResult, b3 as RangeBucket, br as RangeResult, bn as RangeResults, aa as ReindexMessage, ab as ReindexMessageActionOneOf, aA as ReindexParticipantsSearchRequest, aB as ReindexParticipantsSearchResponse, R as RequestedFields, b_ as RequestedFieldsWithLiterals, bF as RestoreInfo, bv as Results, b8 as ScalarAggregation, bs as ScalarResult, V as ScalarType, c4 as ScalarTypeWithLiterals, ae as Schema, bf as SearchDetails, a_ as SearchParticipantsRequest, $ as SinglePaymentDetails, O as SortDirection, c2 as SortDirectionWithLiterals, M as SortOrder, c0 as SortOrderWithLiterals, N as SortType, c1 as SortTypeWithLiterals, aQ as Sorting, aC as SynchronizeTimeCapsuleTasksRequest, aD as SynchronizeTimeCapsuleTasksResponse, a9 as TagList, a8 as Tags, an as UpdateParticipantRequest, ao as UpdateParticipantResponse, ac as Upsert, b5 as ValueAggregation, b6 as ValueAggregationOptionsOneOf, bi as ValueAggregationResult, bq as ValueResult, bm as ValueResults, _ as WebhookIdentityType, c9 as WebhookIdentityTypeWithLiterals, bW as utils } from './online-programs-participants-v3-participant-participants.universal-CUPgynYg.mjs';
+import { P as Participant, C as CreateParticipantOptions, a as CreateParticipantApplicationErrors, U as UpdateParticipant, b as UpdateParticipantOptions, B as BulkCreateParticipantsOptions, c as BulkCreateParticipantsResponse, d as BulkCreateParticipantsApplicationErrors, e as BulkCreateParticipantsForAllMembersOptions, f as BulkCreateParticipantsForAllMembersResponse, I as IssueCertificateOptions, g as IssueCertificateResponse, h as IssueCertificateApplicationErrors, G as GetPremiumStatsResponse, i as GetParticipationStatsResponse, j as GetParticipantOptions, k as GetAccessStatusResponse, l as BulkUpdateParticipantTagsOptions, m as BulkUpdateParticipantTagsResponse, n as BulkUpdateParticipantTagsApplicationErrors, o as BulkUpdateParticipantTagsByFilterOptions, p as BulkUpdateParticipantTagsByFilterResponse, q as BulkUpdateParticipantTagsByFilterApplicationErrors, r as ParticipantSearch, S as SearchParticipantsOptions, s as SearchParticipantsResponse, t as ParticipantCompletedProgramEnvelope, u as ParticipantCreatedEnvelope, v as ParticipantDeletedEnvelope, w as ParticipantLeftEnvelope, x as ParticipantMissedProgramDeadlineEnvelope, y as ParticipantProgramDurationEndedEnvelope, z as ParticipantRemovedEnvelope, A as ParticipantTagsModifiedEnvelope, D as ParticipantUpdatedEnvelope, E as ParticipantQuery, Q as QueryParticipantsOptions, F as typedQueryParticipants, H as ParticipantsQueryBuilder } from './online-programs-participants-v3-participant-participants.universal-Cbh9oHrm.mjs';
+export { bQ as AccountInfo, bV as AccountInfoMetadata, bL as ActionEvent, b4 as Aggregation, bk as AggregationData, b5 as AggregationKindOneOf, bD as AggregationResults, bE as AggregationResultsResultOneOf, br as AggregationResultsScalarResult, Z as AggregationType, ca as AggregationTypeWithLiterals, at as ApplicationError, bT as BaseEventMetadata, au as BulkActionMetadata, M as BulkActionType, c2 as BulkActionTypeWithLiterals, aF as BulkCreateParticipantsForAllMembersRequest, aq as BulkCreateParticipantsRequest, ay as BulkParticipantMigrationResult, ar as BulkParticipantResult, b0 as BulkUpdateParticipantTagsByFilterRequest, a_ as BulkUpdateParticipantTagsRequest, a$ as BulkUpdateParticipantTagsResult, av as BulkUpsertParticipantsMigrationRequest, ax as BulkUpsertParticipantsMigrationResponse, a4 as CertificateInfo, cd as CommonQueryWithEntityContext, ce as CommonSearchWithEntityContext, am as CreateParticipantRequest, an as CreateParticipantResponse, aV as CursorPaging, bj as CursorPagingMetadata, b2 as CursorSearch, b3 as CursorSearchPagingMethodOneOf, aY as Cursors, bc as DateHistogramAggregation, bz as DateHistogramResult, bB as DateHistogramResults, ae as Delete, az as DeleteAllParticipantsMigrationRequest, aA as DeleteAllParticipantsMigrationResponse, aG as DeleteParticipantRequest, aH as DeleteParticipantResponse, bF as DomainEvent, bG as DomainEventBodyOneOf, bM as Empty, a6 as EnrollmentInfo, a7 as EnrollmentInfoPricingTypeDetailsOneOf, K as EnrollmentStatus, b$ as EnrollmentStatusWithLiterals, bH as EntityCreatedEvent, bK as EntityDeletedEvent, bJ as EntityUpdatedEvent, bU as EventMetadata, bR as ExportParticipantsStatsRequest, bS as ExportParticipantsStatsResponse, a8 as ExtendedFields, a2 as FreeCouponDetails, aZ as GetAccessStatusRequest, aJ as GetCompletionStatsRequest, aK as GetCompletionStatsResponse, aO as GetParticipantRequest, aP as GetParticipantResponse, aM as GetParticipationStatsRequest, aL as GetPremiumStatsRequest, bg as GroupByAggregation, bh as GroupByAggregationKindOneOf, bA as GroupByValueResults, bO as IdentificationData, bP as IdentificationDataIdOneOf, b7 as IncludeMissingValuesOptions, Y as Interval, c9 as IntervalWithLiterals, aI as IssueCertificateRequest, as as ItemMetadata, a5 as Member, bN as MessageEnvelope, V as MissingValues, c6 as MissingValuesWithLiterals, _ as Mode, cb as ModeWithLiterals, bf as NestedAggregation, bd as NestedAggregationItem, be as NestedAggregationItemKindOneOf, bn as NestedAggregationResults, bo as NestedAggregationResultsResultOneOf, X as NestedAggregationType, c8 as NestedAggregationTypeWithLiterals, bw as NestedResultValue, bx as NestedResultValueResultOneOf, bC as NestedResults, bs as NestedValueAggregationResult, aU as Paging, aX as PagingMetadataV2, a1 as PaidPlanDetails, ah as ParticipantCompletedProgram, al as ParticipantLeft, aw as ParticipantMigration, ai as ParticipantMissedProgramDeadline, aj as ParticipantProgramDurationEnded, bX as ParticipantQuerySpec, ak as ParticipantRemoved, bY as ParticipantSearchSpec, ag as ParticipantTagsModified, bW as ParticipantsQueryResult, J as PricingType, b_ as PricingTypeWithLiterals, aN as ProgramParticipationStats, a3 as Progress, L as ProgressStatus, c0 as ProgressStatusWithLiterals, aQ as QueryParticipantsRequest, aW as QueryParticipantsResponse, aR as QueryV2, aS as QueryV2PagingMethodOneOf, ba as RangeAggregation, bm as RangeAggregationResult, b6 as RangeBucket, bu as RangeResult, bq as RangeResults, ab as ReindexMessage, ac as ReindexMessageActionOneOf, aB as ReindexParticipantsSearchRequest, aC as ReindexParticipantsSearchResponse, R as RequestedFields, c1 as RequestedFieldsWithLiterals, bI as RestoreInfo, by as Results, bb as ScalarAggregation, bv as ScalarResult, W as ScalarType, c7 as ScalarTypeWithLiterals, af as Schema, bi as SearchDetails, b1 as SearchParticipantsRequest, a0 as SinglePaymentDetails, T as SortDirection, c5 as SortDirectionWithLiterals, N as SortOrder, c3 as SortOrderWithLiterals, O as SortType, c4 as SortTypeWithLiterals, aT as Sorting, aD as SynchronizeTimeCapsuleTasksRequest, aE as SynchronizeTimeCapsuleTasksResponse, aa as TagList, a9 as Tags, ao as UpdateParticipantRequest, ap as UpdateParticipantResponse, ad as Upsert, b8 as ValueAggregation, b9 as ValueAggregationOptionsOneOf, bl as ValueAggregationResult, bt as ValueResult, bp as ValueResults, $ as WebhookIdentityType, cc as WebhookIdentityTypeWithLiterals, bZ as utils } from './online-programs-participants-v3-participant-participants.universal-Cbh9oHrm.mjs';
 
 declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
 interface CreateParticipantSignature {
@@ -19,7 +19,11 @@ interface CreateParticipantSignature {
 declare function updateParticipant$1(httpClient: HttpClient): UpdateParticipantSignature;
 interface UpdateParticipantSignature {
     /**
-     * Updates a participant's enrollment status, progress status, or enrollment pricing details.
+     * Updates a participant's enrollment status or enrollment pricing details.
+     *
+     * Use this method to suspend or resume a participant by setting `enrollment_status` to
+     * `SUSPENDED` or `JOINED`. To remove a participant, use `DeleteParticipant`.
+     * Progress status is calculated from the participant's resolved steps and can't be updated.
      * @param - Participant ID.
      * @returns Updated participant
      */
@@ -82,6 +86,14 @@ interface GetPremiumStatsSignature {
      */
     (): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
 }
+declare function getParticipationStats$1(httpClient: HttpClient): GetParticipationStatsSignature;
+interface GetParticipationStatsSignature {
+    /**
+     * Retrieves participant statistics for the requested programs.
+     * @param - IDs of the programs to retrieve participant statistics for.
+     */
+    (programIds: string[]): Promise<NonNullablePaths<GetParticipationStatsResponse, `participationStats` | `participationStats.${number}.programId` | `participationStats.${number}.participantsCount` | `participationStats.${number}.autoRemovedCount`, 4>>;
+}
 declare function getParticipant$1(httpClient: HttpClient): GetParticipantSignature;
 interface GetParticipantSignature {
     /**
@@ -154,6 +166,7 @@ declare const bulkCreateParticipantsForAllMembers: MaybeContext<BuildRESTFunctio
 declare const deleteParticipant: MaybeContext<BuildRESTFunction<typeof deleteParticipant$1> & typeof deleteParticipant$1>;
 declare const issueCertificate: MaybeContext<BuildRESTFunction<typeof issueCertificate$1> & typeof issueCertificate$1>;
 declare const getPremiumStats: MaybeContext<BuildRESTFunction<typeof getPremiumStats$1> & typeof getPremiumStats$1>;
+declare const getParticipationStats: MaybeContext<BuildRESTFunction<typeof getParticipationStats$1> & typeof getParticipationStats$1>;
 declare const getParticipant: MaybeContext<BuildRESTFunction<typeof getParticipant$1> & typeof getParticipant$1>;
 declare const getAccessStatus: MaybeContext<BuildRESTFunction<typeof getAccessStatus$1> & typeof getAccessStatus$1>;
 declare const bulkUpdateParticipantTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateParticipantTags$1> & typeof bulkUpdateParticipantTags$1>;
@@ -197,4 +210,4 @@ declare const onParticipantTagsModified: BuildEventDefinition<typeof onParticipa
  */
 declare const onParticipantUpdated: BuildEventDefinition<typeof onParticipantUpdated$1> & typeof onParticipantUpdated$1;
 
-export { BulkCreateParticipantsApplicationErrors, BulkCreateParticipantsForAllMembersOptions, BulkCreateParticipantsForAllMembersResponse, BulkCreateParticipantsOptions, BulkCreateParticipantsResponse, BulkUpdateParticipantTagsApplicationErrors, BulkUpdateParticipantTagsByFilterApplicationErrors, BulkUpdateParticipantTagsByFilterOptions, BulkUpdateParticipantTagsByFilterResponse, BulkUpdateParticipantTagsOptions, BulkUpdateParticipantTagsResponse, CreateParticipantApplicationErrors, CreateParticipantOptions, GetAccessStatusResponse, GetParticipantOptions, GetPremiumStatsResponse, IssueCertificateApplicationErrors, IssueCertificateOptions, IssueCertificateResponse, Participant, ParticipantCompletedProgramEnvelope, ParticipantCreatedEnvelope, ParticipantDeletedEnvelope, ParticipantLeftEnvelope, ParticipantMissedProgramDeadlineEnvelope, ParticipantProgramDurationEndedEnvelope, ParticipantQuery, ParticipantRemovedEnvelope, ParticipantSearch, ParticipantTagsModifiedEnvelope, ParticipantUpdatedEnvelope, ParticipantsQueryBuilder, QueryParticipantsOptions, SearchParticipantsOptions, SearchParticipantsResponse, UpdateParticipant, UpdateParticipantOptions, bulkCreateParticipants, bulkCreateParticipantsForAllMembers, bulkUpdateParticipantTags, bulkUpdateParticipantTagsByFilter, createParticipant, deleteParticipant, getAccessStatus, getParticipant, getPremiumStats, issueCertificate, onParticipantCompletedProgram, onParticipantCreated, onParticipantDeleted, onParticipantLeft, onParticipantMissedProgramDeadline, onParticipantProgramDurationEnded, onParticipantRemoved, onParticipantTagsModified, onParticipantUpdated, queryParticipants, searchParticipants, updateParticipant };
+export { BulkCreateParticipantsApplicationErrors, BulkCreateParticipantsForAllMembersOptions, BulkCreateParticipantsForAllMembersResponse, BulkCreateParticipantsOptions, BulkCreateParticipantsResponse, BulkUpdateParticipantTagsApplicationErrors, BulkUpdateParticipantTagsByFilterApplicationErrors, BulkUpdateParticipantTagsByFilterOptions, BulkUpdateParticipantTagsByFilterResponse, BulkUpdateParticipantTagsOptions, BulkUpdateParticipantTagsResponse, CreateParticipantApplicationErrors, CreateParticipantOptions, GetAccessStatusResponse, GetParticipantOptions, GetParticipationStatsResponse, GetPremiumStatsResponse, IssueCertificateApplicationErrors, IssueCertificateOptions, IssueCertificateResponse, Participant, ParticipantCompletedProgramEnvelope, ParticipantCreatedEnvelope, ParticipantDeletedEnvelope, ParticipantLeftEnvelope, ParticipantMissedProgramDeadlineEnvelope, ParticipantProgramDurationEndedEnvelope, ParticipantQuery, ParticipantRemovedEnvelope, ParticipantSearch, ParticipantTagsModifiedEnvelope, ParticipantUpdatedEnvelope, ParticipantsQueryBuilder, QueryParticipantsOptions, SearchParticipantsOptions, SearchParticipantsResponse, UpdateParticipant, UpdateParticipantOptions, bulkCreateParticipants, bulkCreateParticipantsForAllMembers, bulkUpdateParticipantTags, bulkUpdateParticipantTagsByFilter, createParticipant, deleteParticipant, getAccessStatus, getParticipant, getParticipationStats, getPremiumStats, issueCertificate, onParticipantCompletedProgram, onParticipantCreated, onParticipantDeleted, onParticipantLeft, onParticipantMissedProgramDeadline, onParticipantProgramDurationEnded, onParticipantRemoved, onParticipantTagsModified, onParticipantUpdated, queryParticipants, searchParticipants, updateParticipant };

package/build/es/index.mjs

@@ -453,6 +453,27 @@ function getPremiumStats(payload) {
   }
   return __getPremiumStats;
 }
+function getParticipationStats(payload) {
+  function __getParticipationStats({ host }) {
+    const metadata = {
+      entityFqdn: "wix.online_programs.participants.v3.participant",
+      method: "POST",
+      methodFqn: "wix.onlineprograms.participants.v3.ParticipantsService.GetParticipationStats",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixOnlineprogramsParticipantsV3ParticipantsServiceUrl({
+        protoPath: "/v3/participants/stats",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __getParticipationStats;
+}
 function getParticipant(payload) {
   function __getParticipant({ host }) {
     const metadata = {
@@ -996,6 +1017,33 @@ async function getPremiumStats2() {
     throw transformedError;
   }
 }
+async function getParticipationStats2(programIds) {
+  const { httpClient, sideEffects } = arguments[1];
+  const payload = renameKeysFromSDKRequestToRESTRequest({
+    programIds
+  });
+  const reqOpts = getParticipationStats(
+    payload
+  );
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return renameKeysFromRESTResponseToSDKResponse(result.data);
+  } catch (err) {
+    const transformedError = sdkTransformError(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: { programIds: "$[0]" },
+        singleArgumentUnchanged: false
+      },
+      ["programIds"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 async function getParticipant2(participantId, options) {
   const { httpClient, sideEffects } = arguments[2];
   const payload = renameKeysFromSDKRequestToRESTRequest({
@@ -1308,6 +1356,13 @@ function getPremiumStats3(httpClient) {
     { httpClient }
   );
 }
+function getParticipationStats3(httpClient) {
+  return (programIds) => getParticipationStats2(
+    programIds,
+    // @ts-ignore
+    { httpClient }
+  );
+}
 function getParticipant3(httpClient) {
   return (participantId, options) => getParticipant2(
     participantId,
@@ -1596,6 +1651,7 @@ var bulkCreateParticipantsForAllMembers4 = /* @__PURE__ */ createRESTModule(bulk
 var deleteParticipant4 = /* @__PURE__ */ createRESTModule(deleteParticipant3);
 var issueCertificate4 = /* @__PURE__ */ createRESTModule(issueCertificate3);
 var getPremiumStats4 = /* @__PURE__ */ createRESTModule(getPremiumStats3);
+var getParticipationStats4 = /* @__PURE__ */ createRESTModule(getParticipationStats3);
 var getParticipant4 = /* @__PURE__ */ createRESTModule(getParticipant3);
 var getAccessStatus4 = /* @__PURE__ */ createRESTModule(getAccessStatus3);
 var bulkUpdateParticipantTags4 = /* @__PURE__ */ createRESTModule(bulkUpdateParticipantTags3);
@@ -1651,6 +1707,7 @@ export {
   exportParticipantsStats4 as exportParticipantsStats,
   getAccessStatus4 as getAccessStatus,
   getParticipant4 as getParticipant,
+  getParticipationStats4 as getParticipationStats,
   getPremiumStats4 as getPremiumStats,
   issueCertificate4 as issueCertificate,
   onParticipantCompletedProgram2 as onParticipantCompletedProgram,