@wix/auto_sdk_online-programs_participants 1.0.19 → 1.0.21

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

@@ -692,7 +692,7 @@ interface ProgramParticipationStats {
      * @format GUID
      */
     programId?: string;
-    /** Number of participants who joined the program, including suspended and finished participants. */
+    /** Number of participants with a joined or suspended enrollment, including participants who completed or failed the program. */
     participantsCount?: number;
     /** Number of participants automatically removed when the program duration ended. */
     autoRemovedCount?: number;
@@ -2011,7 +2011,11 @@ interface BulkCreateParticipantsForAllMembersOptions {
  */
 declare function deleteParticipant(participantId: string): Promise<void>;
 /**
- * Issues a certificate to a participant who has completed the program.
+ * Manually issues a certificate to an active or finished participant.
+ *
+ * A finished participant has completed or failed the program, or was automatically removed.
+ * The program must have a connected certificate reward. When authenticated as a site member,
+ * the participant must have completed the program.
  * @param participantId - ID of the participant to issue the certificate to.
  * @public
  * @documentationMaturity preview
@@ -2041,12 +2045,15 @@ interface IssueCertificateOptions {
  */
 declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
 /**
- * Retrieves participant statistics for the requested programs.
+ * Retrieves site-wide participant statistics for the requested programs.
+ *
+ * The statistics aren't limited to the caller's own participation records.
  * @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
+ * @applicableIdentity APP
  * @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>>;

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 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';
+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-D4rclIQF.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-D4rclIQF.mjs';
 
 declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
 interface CreateParticipantSignature {
@@ -72,7 +72,11 @@ interface DeleteParticipantSignature {
 declare function issueCertificate$1(httpClient: HttpClient): IssueCertificateSignature;
 interface IssueCertificateSignature {
     /**
-     * Issues a certificate to a participant who has completed the program.
+     * Manually issues a certificate to an active or finished participant.
+     *
+     * A finished participant has completed or failed the program, or was automatically removed.
+     * The program must have a connected certificate reward. When authenticated as a site member,
+     * the participant must have completed the program.
      * @param - ID of the participant to issue the certificate to.
      */
     (participantId: string, options?: IssueCertificateOptions): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.enrollmentStatus` | `participant.progressStatus` | `participant.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participant.enrollmentInfo.paidPlanDetails.paidPlanId` | `participant.enrollmentInfo.freeCouponDetails.freeCouponId` | `participant.enrollmentInfo.timeZone` | `participant.enrollmentInfo.startDate` | `participant.enrollmentInfo.pricingType` | `participant.tags.privateTags.tagIds`, 5> & {
@@ -89,7 +93,9 @@ interface GetPremiumStatsSignature {
 declare function getParticipationStats$1(httpClient: HttpClient): GetParticipationStatsSignature;
 interface GetParticipationStatsSignature {
     /**
-     * Retrieves participant statistics for the requested programs.
+     * Retrieves site-wide participant statistics for the requested programs.
+     *
+     * The statistics aren't limited to the caller's own participation records.
      * @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>>;
@@ -141,6 +147,8 @@ declare function searchParticipants$1(httpClient: HttpClient): SearchParticipant
 interface SearchParticipantsSignature {
     /**
      * Retrieves a list of participants matching the search criteria.
+     *
+     * Results and aggregations include only the participant records that the caller is authorized to access.
      * @param - Query to search participants.
      */
     (search: ParticipantSearch, options?: SearchParticipantsOptions): Promise<NonNullablePaths<SearchParticipantsResponse, `participants` | `participants.${number}.memberId` | `participants.${number}.programId` | `participants.${number}.progress.totalStepsCompleted` | `participants.${number}.progress.totalStepsAvailable` | `participants.${number}.progress.completionPercentage` | `participants.${number}.enrollmentStatus` | `participants.${number}.progressStatus` | `participants.${number}.enrollmentInfo.singlePaymentDetails.paymentOrderId` | `participants.${number}.enrollmentInfo.paidPlanDetails.paidPlanId` | `participants.${number}.enrollmentInfo.freeCouponDetails.freeCouponId` | `participants.${number}.enrollmentInfo.timeZone` | `participants.${number}.enrollmentInfo.startDate` | `participants.${number}.enrollmentInfo.pricingType` | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`, 6>>;