@wix/auto_sdk_online-programs_participants 1.0.20 → 1.0.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +12 -4
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +4 -2
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +2 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/{online-programs-participants-v3-participant-participants.universal-CnN7sCBB.d.ts → online-programs-participants-v3-participant-participants.universal-D4rclIQF.d.ts} +9 -3
- package/build/es/index.d.mts +12 -4
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +4 -2
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +2 -2
- package/build/es/meta.mjs.map +1 -1
- package/build/es/{online-programs-participants-v3-participant-participants.universal-CnN7sCBB.d.mts → online-programs-participants-v3-participant-participants.universal-D4rclIQF.d.mts} +9 -3
- package/build/internal/cjs/index.d.ts +12 -4
- package/build/internal/cjs/index.typings.d.ts +4 -2
- package/build/internal/cjs/meta.d.ts +2 -2
- package/build/internal/cjs/{online-programs-participants-v3-participant-participants.universal-DtzHbtpE.d.ts → online-programs-participants-v3-participant-participants.universal-AG5j7ATZ.d.ts} +9 -3
- package/build/internal/es/index.d.mts +12 -4
- package/build/internal/es/index.typings.d.mts +4 -2
- package/build/internal/es/meta.d.mts +2 -2
- package/build/internal/es/{online-programs-participants-v3-participant-participants.universal-DtzHbtpE.d.mts → online-programs-participants-v3-participant-participants.universal-AG5j7ATZ.d.mts} +9 -3
- package/package.json +2 -2
|
@@ -692,7 +692,7 @@ interface ProgramParticipationStats {
|
|
|
692
692
|
* @format GUID
|
|
693
693
|
*/
|
|
694
694
|
programId?: string;
|
|
695
|
-
/** Number of participants
|
|
695
|
+
/** Number of participants with a joined or suspended enrollment, including participants who completed or failed the program. */
|
|
696
696
|
participantsCount?: number;
|
|
697
697
|
/** Number of participants automatically removed when the program duration ended. */
|
|
698
698
|
autoRemovedCount?: number;
|
|
@@ -2011,7 +2011,11 @@ interface BulkCreateParticipantsForAllMembersOptions {
|
|
|
2011
2011
|
*/
|
|
2012
2012
|
declare function deleteParticipant(participantId: string): Promise<void>;
|
|
2013
2013
|
/**
|
|
2014
|
-
*
|
|
2014
|
+
* Manually issues a certificate to an active or finished participant.
|
|
2015
|
+
*
|
|
2016
|
+
* A finished participant has completed or failed the program, or was automatically removed.
|
|
2017
|
+
* The program must have a connected certificate reward. When authenticated as a site member,
|
|
2018
|
+
* the participant must have completed the program.
|
|
2015
2019
|
* @param participantId - ID of the participant to issue the certificate to.
|
|
2016
2020
|
* @public
|
|
2017
2021
|
* @documentationMaturity preview
|
|
@@ -2041,7 +2045,9 @@ interface IssueCertificateOptions {
|
|
|
2041
2045
|
*/
|
|
2042
2046
|
declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
|
|
2043
2047
|
/**
|
|
2044
|
-
* Retrieves participant statistics for the requested programs.
|
|
2048
|
+
* Retrieves site-wide participant statistics for the requested programs.
|
|
2049
|
+
*
|
|
2050
|
+
* The statistics aren't limited to the caller's own participation records.
|
|
2045
2051
|
* @param programIds - IDs of the programs to retrieve participant statistics for.
|
|
2046
2052
|
* @public
|
|
2047
2053
|
* @documentationMaturity preview
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
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-
|
|
3
|
-
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-
|
|
2
|
+
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-AG5j7ATZ.js';
|
|
3
|
+
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-AG5j7ATZ.js';
|
|
4
4
|
|
|
5
5
|
declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
|
|
6
6
|
interface CreateParticipantSignature {
|
|
@@ -72,7 +72,11 @@ interface DeleteParticipantSignature {
|
|
|
72
72
|
declare function issueCertificate$1(httpClient: HttpClient): IssueCertificateSignature;
|
|
73
73
|
interface IssueCertificateSignature {
|
|
74
74
|
/**
|
|
75
|
-
*
|
|
75
|
+
* Manually issues a certificate to an active or finished participant.
|
|
76
|
+
*
|
|
77
|
+
* A finished participant has completed or failed the program, or was automatically removed.
|
|
78
|
+
* The program must have a connected certificate reward. When authenticated as a site member,
|
|
79
|
+
* the participant must have completed the program.
|
|
76
80
|
* @param - ID of the participant to issue the certificate to.
|
|
77
81
|
*/
|
|
78
82
|
(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 {
|
|
|
89
93
|
declare function getParticipationStats$1(httpClient: HttpClient): GetParticipationStatsSignature;
|
|
90
94
|
interface GetParticipationStatsSignature {
|
|
91
95
|
/**
|
|
92
|
-
* Retrieves participant statistics for the requested programs.
|
|
96
|
+
* Retrieves site-wide participant statistics for the requested programs.
|
|
97
|
+
*
|
|
98
|
+
* The statistics aren't limited to the caller's own participation records.
|
|
93
99
|
* @param - IDs of the programs to retrieve participant statistics for.
|
|
94
100
|
*/
|
|
95
101
|
(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
|
|
|
141
147
|
interface SearchParticipantsSignature {
|
|
142
148
|
/**
|
|
143
149
|
* Retrieves a list of participants matching the search criteria.
|
|
150
|
+
*
|
|
151
|
+
* Results and aggregations include only the participant records that the caller is authorized to access.
|
|
144
152
|
* @param - Query to search participants.
|
|
145
153
|
*/
|
|
146
154
|
(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>>;
|
|
@@ -1,11 +1,13 @@
|
|
|
1
|
-
import { b2 as CursorSearch, S as SearchParticipantsOptions, s as SearchParticipantsResponse } from './online-programs-participants-v3-participant-participants.universal-
|
|
2
|
-
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, d as BulkCreateParticipantsApplicationErrors, e as BulkCreateParticipantsForAllMembersOptions, aF as BulkCreateParticipantsForAllMembersRequest, f as BulkCreateParticipantsForAllMembersResponse, B as BulkCreateParticipantsOptions, aq as BulkCreateParticipantsRequest, c as BulkCreateParticipantsResponse, ay as BulkParticipantMigrationResult, ar as BulkParticipantResult, n as BulkUpdateParticipantTagsApplicationErrors, q as BulkUpdateParticipantTagsByFilterApplicationErrors, o as BulkUpdateParticipantTagsByFilterOptions, b0 as BulkUpdateParticipantTagsByFilterRequest, p as BulkUpdateParticipantTagsByFilterResponse, l as BulkUpdateParticipantTagsOptions, a_ as BulkUpdateParticipantTagsRequest, m as BulkUpdateParticipantTagsResponse, a$ as BulkUpdateParticipantTagsResult, av as BulkUpsertParticipantsMigrationRequest, ax as BulkUpsertParticipantsMigrationResponse, a4 as CertificateInfo, cd as CommonQueryWithEntityContext, ce as CommonSearchWithEntityContext, a as CreateParticipantApplicationErrors, C as CreateParticipantOptions, am as CreateParticipantRequest, an as CreateParticipantResponse, aV as CursorPaging, bj as CursorPagingMetadata, 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, k as GetAccessStatusResponse, aJ as GetCompletionStatsRequest, aK as GetCompletionStatsResponse, j as GetParticipantOptions, aO as GetParticipantRequest, aP as GetParticipantResponse, aM as GetParticipationStatsRequest, i as GetParticipationStatsResponse, aL as GetPremiumStatsRequest, G as GetPremiumStatsResponse, bg as GroupByAggregation, bh as GroupByAggregationKindOneOf, bA as GroupByValueResults, bO as IdentificationData, bP as IdentificationDataIdOneOf, b7 as IncludeMissingValuesOptions, Y as Interval, c9 as IntervalWithLiterals, h as IssueCertificateApplicationErrors, I as IssueCertificateOptions, aI as IssueCertificateRequest, g as IssueCertificateResponse, 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, P as Participant, ah as ParticipantCompletedProgram, t as ParticipantCompletedProgramEnvelope, u as ParticipantCreatedEnvelope, v as ParticipantDeletedEnvelope, al as ParticipantLeft, w as ParticipantLeftEnvelope, aw as ParticipantMigration, ai as ParticipantMissedProgramDeadline, x as ParticipantMissedProgramDeadlineEnvelope, aj as ParticipantProgramDurationEnded, y as ParticipantProgramDurationEndedEnvelope, E as ParticipantQuery, bX as ParticipantQuerySpec, ak as ParticipantRemoved, z as ParticipantRemovedEnvelope, bY as ParticipantSearchSpec, ag as ParticipantTagsModified, A as ParticipantTagsModifiedEnvelope, D as ParticipantUpdatedEnvelope, H as ParticipantsQueryBuilder, bW as ParticipantsQueryResult, J as PricingType, b_ as PricingTypeWithLiterals, aN as ProgramParticipationStats, a3 as Progress, L as ProgressStatus, c0 as ProgressStatusWithLiterals, Q as QueryParticipantsOptions, 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, U as UpdateParticipant, b as UpdateParticipantOptions, 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, cq as bulkCreateParticipants, cr as bulkCreateParticipantsForAllMembers, cz as bulkUpdateParticipantTags, cA as bulkUpdateParticipantTagsByFilter, co as createParticipant, cs as deleteParticipant, cB as exportParticipantsStats, cy as getAccessStatus, cw as getParticipant, cv as getParticipationStats, cu as getPremiumStats, ct as issueCertificate, cf as onParticipantCompletedProgram, cg as onParticipantCreated, ch as onParticipantDeleted, ci as onParticipantLeft, cj as onParticipantMissedProgramDeadline, ck as onParticipantProgramDurationEnded, cl as onParticipantRemoved, cm as onParticipantTagsModified, cn as onParticipantUpdated, cx as queryParticipants, F as typedQueryParticipants, cp as updateParticipant, bZ as utils } from './online-programs-participants-v3-participant-participants.universal-
|
|
1
|
+
import { b2 as CursorSearch, S as SearchParticipantsOptions, s as SearchParticipantsResponse } from './online-programs-participants-v3-participant-participants.universal-AG5j7ATZ.js';
|
|
2
|
+
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, d as BulkCreateParticipantsApplicationErrors, e as BulkCreateParticipantsForAllMembersOptions, aF as BulkCreateParticipantsForAllMembersRequest, f as BulkCreateParticipantsForAllMembersResponse, B as BulkCreateParticipantsOptions, aq as BulkCreateParticipantsRequest, c as BulkCreateParticipantsResponse, ay as BulkParticipantMigrationResult, ar as BulkParticipantResult, n as BulkUpdateParticipantTagsApplicationErrors, q as BulkUpdateParticipantTagsByFilterApplicationErrors, o as BulkUpdateParticipantTagsByFilterOptions, b0 as BulkUpdateParticipantTagsByFilterRequest, p as BulkUpdateParticipantTagsByFilterResponse, l as BulkUpdateParticipantTagsOptions, a_ as BulkUpdateParticipantTagsRequest, m as BulkUpdateParticipantTagsResponse, a$ as BulkUpdateParticipantTagsResult, av as BulkUpsertParticipantsMigrationRequest, ax as BulkUpsertParticipantsMigrationResponse, a4 as CertificateInfo, cd as CommonQueryWithEntityContext, ce as CommonSearchWithEntityContext, a as CreateParticipantApplicationErrors, C as CreateParticipantOptions, am as CreateParticipantRequest, an as CreateParticipantResponse, aV as CursorPaging, bj as CursorPagingMetadata, 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, k as GetAccessStatusResponse, aJ as GetCompletionStatsRequest, aK as GetCompletionStatsResponse, j as GetParticipantOptions, aO as GetParticipantRequest, aP as GetParticipantResponse, aM as GetParticipationStatsRequest, i as GetParticipationStatsResponse, aL as GetPremiumStatsRequest, G as GetPremiumStatsResponse, bg as GroupByAggregation, bh as GroupByAggregationKindOneOf, bA as GroupByValueResults, bO as IdentificationData, bP as IdentificationDataIdOneOf, b7 as IncludeMissingValuesOptions, Y as Interval, c9 as IntervalWithLiterals, h as IssueCertificateApplicationErrors, I as IssueCertificateOptions, aI as IssueCertificateRequest, g as IssueCertificateResponse, 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, P as Participant, ah as ParticipantCompletedProgram, t as ParticipantCompletedProgramEnvelope, u as ParticipantCreatedEnvelope, v as ParticipantDeletedEnvelope, al as ParticipantLeft, w as ParticipantLeftEnvelope, aw as ParticipantMigration, ai as ParticipantMissedProgramDeadline, x as ParticipantMissedProgramDeadlineEnvelope, aj as ParticipantProgramDurationEnded, y as ParticipantProgramDurationEndedEnvelope, E as ParticipantQuery, bX as ParticipantQuerySpec, ak as ParticipantRemoved, z as ParticipantRemovedEnvelope, bY as ParticipantSearchSpec, ag as ParticipantTagsModified, A as ParticipantTagsModifiedEnvelope, D as ParticipantUpdatedEnvelope, H as ParticipantsQueryBuilder, bW as ParticipantsQueryResult, J as PricingType, b_ as PricingTypeWithLiterals, aN as ProgramParticipationStats, a3 as Progress, L as ProgressStatus, c0 as ProgressStatusWithLiterals, Q as QueryParticipantsOptions, 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, U as UpdateParticipant, b as UpdateParticipantOptions, 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, cq as bulkCreateParticipants, cr as bulkCreateParticipantsForAllMembers, cz as bulkUpdateParticipantTags, cA as bulkUpdateParticipantTagsByFilter, co as createParticipant, cs as deleteParticipant, cB as exportParticipantsStats, cy as getAccessStatus, cw as getParticipant, cv as getParticipationStats, cu as getPremiumStats, ct as issueCertificate, cf as onParticipantCompletedProgram, cg as onParticipantCreated, ch as onParticipantDeleted, ci as onParticipantLeft, cj as onParticipantMissedProgramDeadline, ck as onParticipantProgramDurationEnded, cl as onParticipantRemoved, cm as onParticipantTagsModified, cn as onParticipantUpdated, cx as queryParticipants, F as typedQueryParticipants, cp as updateParticipant, bZ as utils } from './online-programs-participants-v3-participant-participants.universal-AG5j7ATZ.js';
|
|
3
3
|
import '@wix/sdk-types';
|
|
4
4
|
|
|
5
5
|
/** @hidden */
|
|
6
6
|
type ParticipantSearch = {};
|
|
7
7
|
/**
|
|
8
8
|
* Retrieves a list of participants matching the search criteria.
|
|
9
|
+
*
|
|
10
|
+
* Results and aggregations include only the participant records that the caller is authorized to access.
|
|
9
11
|
* @param search - Query to search participants.
|
|
10
12
|
* @public
|
|
11
13
|
* @documentationMaturity preview
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { am as CreateParticipantRequest$1, an as CreateParticipantResponse$1, ao as UpdateParticipantRequest$1, ap as UpdateParticipantResponse$1, aq as BulkCreateParticipantsRequest$1, c as BulkCreateParticipantsResponse$1, aF as BulkCreateParticipantsForAllMembersRequest$1, f as BulkCreateParticipantsForAllMembersResponse$1, aG as DeleteParticipantRequest$1, aH as DeleteParticipantResponse$1, aI as IssueCertificateRequest$1, g as IssueCertificateResponse$1, aL as GetPremiumStatsRequest$1, G as GetPremiumStatsResponse$1, aM as GetParticipationStatsRequest$1, i as GetParticipationStatsResponse$1, aO as GetParticipantRequest$1, aP as GetParticipantResponse$1, aQ as QueryParticipantsRequest$1, aW as QueryParticipantsResponse$1, aZ as GetAccessStatusRequest$1, k as GetAccessStatusResponse$1, a_ as BulkUpdateParticipantTagsRequest$1, m as BulkUpdateParticipantTagsResponse$1, b0 as BulkUpdateParticipantTagsByFilterRequest$1, p as BulkUpdateParticipantTagsByFilterResponse$1, b1 as SearchParticipantsRequest$1, s as SearchParticipantsResponse$1, bR as ExportParticipantsStatsRequest$1, bS as ExportParticipantsStatsResponse$1 } from './online-programs-participants-v3-participant-participants.universal-
|
|
1
|
+
import { am as CreateParticipantRequest$1, an as CreateParticipantResponse$1, ao as UpdateParticipantRequest$1, ap as UpdateParticipantResponse$1, aq as BulkCreateParticipantsRequest$1, c as BulkCreateParticipantsResponse$1, aF as BulkCreateParticipantsForAllMembersRequest$1, f as BulkCreateParticipantsForAllMembersResponse$1, aG as DeleteParticipantRequest$1, aH as DeleteParticipantResponse$1, aI as IssueCertificateRequest$1, g as IssueCertificateResponse$1, aL as GetPremiumStatsRequest$1, G as GetPremiumStatsResponse$1, aM as GetParticipationStatsRequest$1, i as GetParticipationStatsResponse$1, aO as GetParticipantRequest$1, aP as GetParticipantResponse$1, aQ as QueryParticipantsRequest$1, aW as QueryParticipantsResponse$1, aZ as GetAccessStatusRequest$1, k as GetAccessStatusResponse$1, a_ as BulkUpdateParticipantTagsRequest$1, m as BulkUpdateParticipantTagsResponse$1, b0 as BulkUpdateParticipantTagsByFilterRequest$1, p as BulkUpdateParticipantTagsByFilterResponse$1, b1 as SearchParticipantsRequest$1, s as SearchParticipantsResponse$1, bR as ExportParticipantsStatsRequest$1, bS as ExportParticipantsStatsResponse$1 } from './online-programs-participants-v3-participant-participants.universal-AG5j7ATZ.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -697,7 +697,7 @@ interface ProgramParticipationStats {
|
|
|
697
697
|
* @format GUID
|
|
698
698
|
*/
|
|
699
699
|
programId?: string;
|
|
700
|
-
/** Number of participants
|
|
700
|
+
/** Number of participants with a joined or suspended enrollment, including participants who completed or failed the program. */
|
|
701
701
|
participantsCount?: number;
|
|
702
702
|
/** Number of participants automatically removed when the program duration ended. */
|
|
703
703
|
autoRemovedCount?: number;
|
|
@@ -697,7 +697,7 @@ interface ProgramParticipationStats {
|
|
|
697
697
|
* @format GUID
|
|
698
698
|
*/
|
|
699
699
|
programId?: string;
|
|
700
|
-
/** Number of participants
|
|
700
|
+
/** Number of participants with a joined or suspended enrollment, including participants who completed or failed the program. */
|
|
701
701
|
participantsCount?: number;
|
|
702
702
|
/** Number of participants automatically removed when the program duration ended. */
|
|
703
703
|
autoRemovedCount?: number;
|
|
@@ -2040,7 +2040,11 @@ interface BulkCreateParticipantsForAllMembersOptions {
|
|
|
2040
2040
|
*/
|
|
2041
2041
|
declare function deleteParticipant(participantId: string): Promise<void>;
|
|
2042
2042
|
/**
|
|
2043
|
-
*
|
|
2043
|
+
* Manually issues a certificate to an active or finished participant.
|
|
2044
|
+
*
|
|
2045
|
+
* A finished participant has completed or failed the program, or was automatically removed.
|
|
2046
|
+
* The program must have a connected certificate reward. When authenticated as a site member,
|
|
2047
|
+
* the participant must have completed the program.
|
|
2044
2048
|
* @param participantId - ID of the participant to issue the certificate to.
|
|
2045
2049
|
* @public
|
|
2046
2050
|
* @documentationMaturity preview
|
|
@@ -2070,7 +2074,9 @@ interface IssueCertificateOptions {
|
|
|
2070
2074
|
*/
|
|
2071
2075
|
declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
|
|
2072
2076
|
/**
|
|
2073
|
-
* Retrieves participant statistics for the requested programs.
|
|
2077
|
+
* Retrieves site-wide participant statistics for the requested programs.
|
|
2078
|
+
*
|
|
2079
|
+
* The statistics aren't limited to the caller's own participation records.
|
|
2074
2080
|
* @param programIds - IDs of the programs to retrieve participant statistics for.
|
|
2075
2081
|
* @public
|
|
2076
2082
|
* @documentationMaturity preview
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
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-
|
|
3
|
-
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-
|
|
2
|
+
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-AG5j7ATZ.mjs';
|
|
3
|
+
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-AG5j7ATZ.mjs';
|
|
4
4
|
|
|
5
5
|
declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
|
|
6
6
|
interface CreateParticipantSignature {
|
|
@@ -72,7 +72,11 @@ interface DeleteParticipantSignature {
|
|
|
72
72
|
declare function issueCertificate$1(httpClient: HttpClient): IssueCertificateSignature;
|
|
73
73
|
interface IssueCertificateSignature {
|
|
74
74
|
/**
|
|
75
|
-
*
|
|
75
|
+
* Manually issues a certificate to an active or finished participant.
|
|
76
|
+
*
|
|
77
|
+
* A finished participant has completed or failed the program, or was automatically removed.
|
|
78
|
+
* The program must have a connected certificate reward. When authenticated as a site member,
|
|
79
|
+
* the participant must have completed the program.
|
|
76
80
|
* @param - ID of the participant to issue the certificate to.
|
|
77
81
|
*/
|
|
78
82
|
(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 {
|
|
|
89
93
|
declare function getParticipationStats$1(httpClient: HttpClient): GetParticipationStatsSignature;
|
|
90
94
|
interface GetParticipationStatsSignature {
|
|
91
95
|
/**
|
|
92
|
-
* Retrieves participant statistics for the requested programs.
|
|
96
|
+
* Retrieves site-wide participant statistics for the requested programs.
|
|
97
|
+
*
|
|
98
|
+
* The statistics aren't limited to the caller's own participation records.
|
|
93
99
|
* @param - IDs of the programs to retrieve participant statistics for.
|
|
94
100
|
*/
|
|
95
101
|
(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
|
|
|
141
147
|
interface SearchParticipantsSignature {
|
|
142
148
|
/**
|
|
143
149
|
* Retrieves a list of participants matching the search criteria.
|
|
150
|
+
*
|
|
151
|
+
* Results and aggregations include only the participant records that the caller is authorized to access.
|
|
144
152
|
* @param - Query to search participants.
|
|
145
153
|
*/
|
|
146
154
|
(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>>;
|
|
@@ -1,11 +1,13 @@
|
|
|
1
|
-
import { b2 as CursorSearch, S as SearchParticipantsOptions, s as SearchParticipantsResponse } from './online-programs-participants-v3-participant-participants.universal-
|
|
2
|
-
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, d as BulkCreateParticipantsApplicationErrors, e as BulkCreateParticipantsForAllMembersOptions, aF as BulkCreateParticipantsForAllMembersRequest, f as BulkCreateParticipantsForAllMembersResponse, B as BulkCreateParticipantsOptions, aq as BulkCreateParticipantsRequest, c as BulkCreateParticipantsResponse, ay as BulkParticipantMigrationResult, ar as BulkParticipantResult, n as BulkUpdateParticipantTagsApplicationErrors, q as BulkUpdateParticipantTagsByFilterApplicationErrors, o as BulkUpdateParticipantTagsByFilterOptions, b0 as BulkUpdateParticipantTagsByFilterRequest, p as BulkUpdateParticipantTagsByFilterResponse, l as BulkUpdateParticipantTagsOptions, a_ as BulkUpdateParticipantTagsRequest, m as BulkUpdateParticipantTagsResponse, a$ as BulkUpdateParticipantTagsResult, av as BulkUpsertParticipantsMigrationRequest, ax as BulkUpsertParticipantsMigrationResponse, a4 as CertificateInfo, cd as CommonQueryWithEntityContext, ce as CommonSearchWithEntityContext, a as CreateParticipantApplicationErrors, C as CreateParticipantOptions, am as CreateParticipantRequest, an as CreateParticipantResponse, aV as CursorPaging, bj as CursorPagingMetadata, 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, k as GetAccessStatusResponse, aJ as GetCompletionStatsRequest, aK as GetCompletionStatsResponse, j as GetParticipantOptions, aO as GetParticipantRequest, aP as GetParticipantResponse, aM as GetParticipationStatsRequest, i as GetParticipationStatsResponse, aL as GetPremiumStatsRequest, G as GetPremiumStatsResponse, bg as GroupByAggregation, bh as GroupByAggregationKindOneOf, bA as GroupByValueResults, bO as IdentificationData, bP as IdentificationDataIdOneOf, b7 as IncludeMissingValuesOptions, Y as Interval, c9 as IntervalWithLiterals, h as IssueCertificateApplicationErrors, I as IssueCertificateOptions, aI as IssueCertificateRequest, g as IssueCertificateResponse, 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, P as Participant, ah as ParticipantCompletedProgram, t as ParticipantCompletedProgramEnvelope, u as ParticipantCreatedEnvelope, v as ParticipantDeletedEnvelope, al as ParticipantLeft, w as ParticipantLeftEnvelope, aw as ParticipantMigration, ai as ParticipantMissedProgramDeadline, x as ParticipantMissedProgramDeadlineEnvelope, aj as ParticipantProgramDurationEnded, y as ParticipantProgramDurationEndedEnvelope, E as ParticipantQuery, bX as ParticipantQuerySpec, ak as ParticipantRemoved, z as ParticipantRemovedEnvelope, bY as ParticipantSearchSpec, ag as ParticipantTagsModified, A as ParticipantTagsModifiedEnvelope, D as ParticipantUpdatedEnvelope, H as ParticipantsQueryBuilder, bW as ParticipantsQueryResult, J as PricingType, b_ as PricingTypeWithLiterals, aN as ProgramParticipationStats, a3 as Progress, L as ProgressStatus, c0 as ProgressStatusWithLiterals, Q as QueryParticipantsOptions, 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, U as UpdateParticipant, b as UpdateParticipantOptions, 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, cq as bulkCreateParticipants, cr as bulkCreateParticipantsForAllMembers, cz as bulkUpdateParticipantTags, cA as bulkUpdateParticipantTagsByFilter, co as createParticipant, cs as deleteParticipant, cB as exportParticipantsStats, cy as getAccessStatus, cw as getParticipant, cv as getParticipationStats, cu as getPremiumStats, ct as issueCertificate, cf as onParticipantCompletedProgram, cg as onParticipantCreated, ch as onParticipantDeleted, ci as onParticipantLeft, cj as onParticipantMissedProgramDeadline, ck as onParticipantProgramDurationEnded, cl as onParticipantRemoved, cm as onParticipantTagsModified, cn as onParticipantUpdated, cx as queryParticipants, F as typedQueryParticipants, cp as updateParticipant, bZ as utils } from './online-programs-participants-v3-participant-participants.universal-
|
|
1
|
+
import { b2 as CursorSearch, S as SearchParticipantsOptions, s as SearchParticipantsResponse } from './online-programs-participants-v3-participant-participants.universal-AG5j7ATZ.mjs';
|
|
2
|
+
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, d as BulkCreateParticipantsApplicationErrors, e as BulkCreateParticipantsForAllMembersOptions, aF as BulkCreateParticipantsForAllMembersRequest, f as BulkCreateParticipantsForAllMembersResponse, B as BulkCreateParticipantsOptions, aq as BulkCreateParticipantsRequest, c as BulkCreateParticipantsResponse, ay as BulkParticipantMigrationResult, ar as BulkParticipantResult, n as BulkUpdateParticipantTagsApplicationErrors, q as BulkUpdateParticipantTagsByFilterApplicationErrors, o as BulkUpdateParticipantTagsByFilterOptions, b0 as BulkUpdateParticipantTagsByFilterRequest, p as BulkUpdateParticipantTagsByFilterResponse, l as BulkUpdateParticipantTagsOptions, a_ as BulkUpdateParticipantTagsRequest, m as BulkUpdateParticipantTagsResponse, a$ as BulkUpdateParticipantTagsResult, av as BulkUpsertParticipantsMigrationRequest, ax as BulkUpsertParticipantsMigrationResponse, a4 as CertificateInfo, cd as CommonQueryWithEntityContext, ce as CommonSearchWithEntityContext, a as CreateParticipantApplicationErrors, C as CreateParticipantOptions, am as CreateParticipantRequest, an as CreateParticipantResponse, aV as CursorPaging, bj as CursorPagingMetadata, 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, k as GetAccessStatusResponse, aJ as GetCompletionStatsRequest, aK as GetCompletionStatsResponse, j as GetParticipantOptions, aO as GetParticipantRequest, aP as GetParticipantResponse, aM as GetParticipationStatsRequest, i as GetParticipationStatsResponse, aL as GetPremiumStatsRequest, G as GetPremiumStatsResponse, bg as GroupByAggregation, bh as GroupByAggregationKindOneOf, bA as GroupByValueResults, bO as IdentificationData, bP as IdentificationDataIdOneOf, b7 as IncludeMissingValuesOptions, Y as Interval, c9 as IntervalWithLiterals, h as IssueCertificateApplicationErrors, I as IssueCertificateOptions, aI as IssueCertificateRequest, g as IssueCertificateResponse, 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, P as Participant, ah as ParticipantCompletedProgram, t as ParticipantCompletedProgramEnvelope, u as ParticipantCreatedEnvelope, v as ParticipantDeletedEnvelope, al as ParticipantLeft, w as ParticipantLeftEnvelope, aw as ParticipantMigration, ai as ParticipantMissedProgramDeadline, x as ParticipantMissedProgramDeadlineEnvelope, aj as ParticipantProgramDurationEnded, y as ParticipantProgramDurationEndedEnvelope, E as ParticipantQuery, bX as ParticipantQuerySpec, ak as ParticipantRemoved, z as ParticipantRemovedEnvelope, bY as ParticipantSearchSpec, ag as ParticipantTagsModified, A as ParticipantTagsModifiedEnvelope, D as ParticipantUpdatedEnvelope, H as ParticipantsQueryBuilder, bW as ParticipantsQueryResult, J as PricingType, b_ as PricingTypeWithLiterals, aN as ProgramParticipationStats, a3 as Progress, L as ProgressStatus, c0 as ProgressStatusWithLiterals, Q as QueryParticipantsOptions, 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, U as UpdateParticipant, b as UpdateParticipantOptions, 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, cq as bulkCreateParticipants, cr as bulkCreateParticipantsForAllMembers, cz as bulkUpdateParticipantTags, cA as bulkUpdateParticipantTagsByFilter, co as createParticipant, cs as deleteParticipant, cB as exportParticipantsStats, cy as getAccessStatus, cw as getParticipant, cv as getParticipationStats, cu as getPremiumStats, ct as issueCertificate, cf as onParticipantCompletedProgram, cg as onParticipantCreated, ch as onParticipantDeleted, ci as onParticipantLeft, cj as onParticipantMissedProgramDeadline, ck as onParticipantProgramDurationEnded, cl as onParticipantRemoved, cm as onParticipantTagsModified, cn as onParticipantUpdated, cx as queryParticipants, F as typedQueryParticipants, cp as updateParticipant, bZ as utils } from './online-programs-participants-v3-participant-participants.universal-AG5j7ATZ.mjs';
|
|
3
3
|
import '@wix/sdk-types';
|
|
4
4
|
|
|
5
5
|
/** @hidden */
|
|
6
6
|
type ParticipantSearch = {};
|
|
7
7
|
/**
|
|
8
8
|
* Retrieves a list of participants matching the search criteria.
|
|
9
|
+
*
|
|
10
|
+
* Results and aggregations include only the participant records that the caller is authorized to access.
|
|
9
11
|
* @param search - Query to search participants.
|
|
10
12
|
* @public
|
|
11
13
|
* @documentationMaturity preview
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { am as CreateParticipantRequest$1, an as CreateParticipantResponse$1, ao as UpdateParticipantRequest$1, ap as UpdateParticipantResponse$1, aq as BulkCreateParticipantsRequest$1, c as BulkCreateParticipantsResponse$1, aF as BulkCreateParticipantsForAllMembersRequest$1, f as BulkCreateParticipantsForAllMembersResponse$1, aG as DeleteParticipantRequest$1, aH as DeleteParticipantResponse$1, aI as IssueCertificateRequest$1, g as IssueCertificateResponse$1, aL as GetPremiumStatsRequest$1, G as GetPremiumStatsResponse$1, aM as GetParticipationStatsRequest$1, i as GetParticipationStatsResponse$1, aO as GetParticipantRequest$1, aP as GetParticipantResponse$1, aQ as QueryParticipantsRequest$1, aW as QueryParticipantsResponse$1, aZ as GetAccessStatusRequest$1, k as GetAccessStatusResponse$1, a_ as BulkUpdateParticipantTagsRequest$1, m as BulkUpdateParticipantTagsResponse$1, b0 as BulkUpdateParticipantTagsByFilterRequest$1, p as BulkUpdateParticipantTagsByFilterResponse$1, b1 as SearchParticipantsRequest$1, s as SearchParticipantsResponse$1, bR as ExportParticipantsStatsRequest$1, bS as ExportParticipantsStatsResponse$1 } from './online-programs-participants-v3-participant-participants.universal-
|
|
1
|
+
import { am as CreateParticipantRequest$1, an as CreateParticipantResponse$1, ao as UpdateParticipantRequest$1, ap as UpdateParticipantResponse$1, aq as BulkCreateParticipantsRequest$1, c as BulkCreateParticipantsResponse$1, aF as BulkCreateParticipantsForAllMembersRequest$1, f as BulkCreateParticipantsForAllMembersResponse$1, aG as DeleteParticipantRequest$1, aH as DeleteParticipantResponse$1, aI as IssueCertificateRequest$1, g as IssueCertificateResponse$1, aL as GetPremiumStatsRequest$1, G as GetPremiumStatsResponse$1, aM as GetParticipationStatsRequest$1, i as GetParticipationStatsResponse$1, aO as GetParticipantRequest$1, aP as GetParticipantResponse$1, aQ as QueryParticipantsRequest$1, aW as QueryParticipantsResponse$1, aZ as GetAccessStatusRequest$1, k as GetAccessStatusResponse$1, a_ as BulkUpdateParticipantTagsRequest$1, m as BulkUpdateParticipantTagsResponse$1, b0 as BulkUpdateParticipantTagsByFilterRequest$1, p as BulkUpdateParticipantTagsByFilterResponse$1, b1 as SearchParticipantsRequest$1, s as SearchParticipantsResponse$1, bR as ExportParticipantsStatsRequest$1, bS as ExportParticipantsStatsResponse$1 } from './online-programs-participants-v3-participant-participants.universal-AG5j7ATZ.mjs';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
/**
|
|
@@ -697,7 +697,7 @@ interface ProgramParticipationStats {
|
|
|
697
697
|
* @format GUID
|
|
698
698
|
*/
|
|
699
699
|
programId?: string;
|
|
700
|
-
/** Number of participants
|
|
700
|
+
/** Number of participants with a joined or suspended enrollment, including participants who completed or failed the program. */
|
|
701
701
|
participantsCount?: number;
|
|
702
702
|
/** Number of participants automatically removed when the program duration ended. */
|
|
703
703
|
autoRemovedCount?: number;
|
|
@@ -697,7 +697,7 @@ interface ProgramParticipationStats {
|
|
|
697
697
|
* @format GUID
|
|
698
698
|
*/
|
|
699
699
|
programId?: string;
|
|
700
|
-
/** Number of participants
|
|
700
|
+
/** Number of participants with a joined or suspended enrollment, including participants who completed or failed the program. */
|
|
701
701
|
participantsCount?: number;
|
|
702
702
|
/** Number of participants automatically removed when the program duration ended. */
|
|
703
703
|
autoRemovedCount?: number;
|
|
@@ -2040,7 +2040,11 @@ interface BulkCreateParticipantsForAllMembersOptions {
|
|
|
2040
2040
|
*/
|
|
2041
2041
|
declare function deleteParticipant(participantId: string): Promise<void>;
|
|
2042
2042
|
/**
|
|
2043
|
-
*
|
|
2043
|
+
* Manually issues a certificate to an active or finished participant.
|
|
2044
|
+
*
|
|
2045
|
+
* A finished participant has completed or failed the program, or was automatically removed.
|
|
2046
|
+
* The program must have a connected certificate reward. When authenticated as a site member,
|
|
2047
|
+
* the participant must have completed the program.
|
|
2044
2048
|
* @param participantId - ID of the participant to issue the certificate to.
|
|
2045
2049
|
* @public
|
|
2046
2050
|
* @documentationMaturity preview
|
|
@@ -2070,7 +2074,9 @@ interface IssueCertificateOptions {
|
|
|
2070
2074
|
*/
|
|
2071
2075
|
declare function getPremiumStats(): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
|
|
2072
2076
|
/**
|
|
2073
|
-
* Retrieves participant statistics for the requested programs.
|
|
2077
|
+
* Retrieves site-wide participant statistics for the requested programs.
|
|
2078
|
+
*
|
|
2079
|
+
* The statistics aren't limited to the caller's own participation records.
|
|
2074
2080
|
* @param programIds - IDs of the programs to retrieve participant statistics for.
|
|
2075
2081
|
* @public
|
|
2076
2082
|
* @documentationMaturity preview
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/auto_sdk_online-programs_participants",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.21",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/",
|
|
@@ -50,5 +50,5 @@
|
|
|
50
50
|
"fqdn": "wix.online_programs.participants.v3.participant"
|
|
51
51
|
}
|
|
52
52
|
},
|
|
53
|
-
"falconPackageHash": "
|
|
53
|
+
"falconPackageHash": "a2b6fa347f776d22b633f2c3862854dc9033f41d380ba6606ca92c2a"
|
|
54
54
|
}
|