@wix/auto_sdk_online-programs_participants 1.0.14 → 1.0.16

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.
Files changed (41) hide show
  1. package/build/cjs/index.d.ts +181 -48
  2. package/build/cjs/index.js +1425 -188
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +12 -690
  5. package/build/cjs/index.typings.js +1074 -129
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +1302 -165
  8. package/build/cjs/meta.js +924 -110
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/cjs/online-programs-participants-v3-participant-participants.universal-CVjCdKBh.d.ts +2461 -0
  11. package/build/es/index.d.mts +181 -48
  12. package/build/es/index.mjs +1371 -162
  13. package/build/es/index.mjs.map +1 -1
  14. package/build/es/index.typings.d.mts +12 -690
  15. package/build/es/index.typings.mjs +1036 -114
  16. package/build/es/index.typings.mjs.map +1 -1
  17. package/build/es/meta.d.mts +1302 -165
  18. package/build/es/meta.mjs +888 -95
  19. package/build/es/meta.mjs.map +1 -1
  20. package/build/es/online-programs-participants-v3-participant-participants.universal-CVjCdKBh.d.mts +2461 -0
  21. package/build/internal/cjs/index.d.ts +196 -48
  22. package/build/internal/cjs/index.typings.d.ts +12 -690
  23. package/build/internal/cjs/meta.d.ts +1473 -265
  24. package/build/internal/cjs/online-programs-participants-v3-participant-participants.universal-B1sw-MEh.d.ts +2504 -0
  25. package/build/internal/es/index.d.mts +196 -48
  26. package/build/internal/es/index.typings.d.mts +12 -690
  27. package/build/internal/es/meta.d.mts +1473 -265
  28. package/build/internal/es/online-programs-participants-v3-participant-participants.universal-B1sw-MEh.d.mts +2504 -0
  29. package/package.json +5 -5
  30. package/build/internal/cjs/index.js +0 -495
  31. package/build/internal/cjs/index.js.map +0 -1
  32. package/build/internal/cjs/index.typings.js +0 -390
  33. package/build/internal/cjs/index.typings.js.map +0 -1
  34. package/build/internal/cjs/meta.js +0 -327
  35. package/build/internal/cjs/meta.js.map +0 -1
  36. package/build/internal/es/index.mjs +0 -461
  37. package/build/internal/es/index.mjs.map +0 -1
  38. package/build/internal/es/index.typings.mjs +0 -359
  39. package/build/internal/es/index.typings.mjs.map +0 -1
  40. package/build/internal/es/meta.mjs +0 -293
  41. package/build/internal/es/meta.mjs.map +0 -1
@@ -1,67 +1,200 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
- import { BulkInviteToProgramOptions, BulkInviteToProgramResponse, BulkInviteAllToProgramOptions, BulkInviteAllToProgramResponse, BulkAddToProgramOptions, BulkAddToProgramResponse, BulkApproveParticipantOptions, BulkApproveParticipantResponse, BulkApproveAllParticipantOptions, BulkApproveAllParticipantResponse, ParticipantAddedEnvelope, ParticipantApprovedEnvelope, ParticipantInvitedEnvelope } from './index.typings.js';
3
- export { AccountInfoMetadata, ActionEvent, ApplicationError, BaseEventMetadata, BulkActionMetadata, BulkAddToProgramRequest, BulkAddToProgramResult, BulkApproveAllParticipantRequest, BulkApproveParticipantRequest, BulkApproveParticipantResult, BulkInviteAllToProgramRequest, BulkInviteToProgramRequest, BulkInviteToProgramResult, Certificate, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, FreeCouponDetails, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, JoinPath, JoinPathWithLiterals, JoinedInfo, JoinedInfoJoinPathDetailsOneOf, Member, MessageEnvelope, PaidPlanDetails, Participant, ParticipantAdded, ParticipantApproved, ParticipantInvited, Progress, RestoreInfo, SinglePaymentDetails, State, StateWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
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 GetParticipantOptions, j as GetAccessStatusResponse, k as BulkUpdateParticipantTagsOptions, l as BulkUpdateParticipantTagsResponse, m as BulkUpdateParticipantTagsApplicationErrors, n as BulkUpdateParticipantTagsByFilterOptions, o as BulkUpdateParticipantTagsByFilterResponse, p as BulkUpdateParticipantTagsByFilterApplicationErrors, q as ParticipantSearch, S as SearchParticipantsOptions, r as SearchParticipantsResponse, s as ParticipantCompletedProgramEnvelope, t as ParticipantCreatedEnvelope, u as ParticipantDeletedEnvelope, v as ParticipantLeftEnvelope, w as ParticipantMissedProgramDeadlineEnvelope, x as ParticipantProgramDurationEndedEnvelope, y as ParticipantRemovedEnvelope, z as ParticipantTagsModifiedEnvelope, A as ParticipantUpdatedEnvelope, D as ParticipantQuery, Q as QueryParticipantsOptions, E as typedQueryParticipants, F as ParticipantsQueryBuilder } from './online-programs-participants-v3-participant-participants.universal-CVjCdKBh.js';
3
+ export { bO as AccountInfo, bT as AccountInfoMetadata, bJ as ActionEvent, b2 as Aggregation, bi as AggregationData, b3 as AggregationKindOneOf, bB as AggregationResults, bC as AggregationResultsResultOneOf, bp as AggregationResultsScalarResult, Y as AggregationType, c8 as AggregationTypeWithLiterals, at as ApplicationError, bR as BaseEventMetadata, au as BulkActionMetadata, L as BulkActionType, c0 as BulkActionTypeWithLiterals, aF as BulkCreateParticipantsForAllMembersRequest, aq as BulkCreateParticipantsRequest, ay as BulkParticipantMigrationResult, ar as BulkParticipantResult, a_ as BulkUpdateParticipantTagsByFilterRequest, aY as BulkUpdateParticipantTagsRequest, aZ as BulkUpdateParticipantTagsResult, av as BulkUpsertParticipantsMigrationRequest, ax as BulkUpsertParticipantsMigrationResponse, a3 as CertificateInfo, cb as CommonQueryWithEntityContext, cc as CommonSearchWithEntityContext, am as CreateParticipantRequest, an as CreateParticipantResponse, aT as CursorPaging, bh as CursorPagingMetadata, b0 as CursorSearch, b1 as CursorSearchPagingMethodOneOf, aW as Cursors, ba as DateHistogramAggregation, bx as DateHistogramResult, bz as DateHistogramResults, ad as Delete, az as DeleteAllParticipantsMigrationRequest, aA as DeleteAllParticipantsMigrationResponse, aG as DeleteParticipantRequest, aH as DeleteParticipantResponse, bD as DomainEvent, bE as DomainEventBodyOneOf, bK as Empty, a5 as EnrollmentInfo, a6 as EnrollmentInfoPricingTypeDetailsOneOf, J as EnrollmentStatus, bZ as EnrollmentStatusWithLiterals, bF as EntityCreatedEvent, bI as EntityDeletedEvent, bH as EntityUpdatedEvent, bS as EventMetadata, bP as ExportParticipantsStatsRequest, bQ as ExportParticipantsStatsResponse, a7 as ExtendedFields, a1 as FreeCouponDetails, aX as GetAccessStatusRequest, aJ as GetCompletionStatsRequest, aK as GetCompletionStatsResponse, aM as GetParticipantRequest, aN as GetParticipantResponse, aL as GetPremiumStatsRequest, be as GroupByAggregation, bf as GroupByAggregationKindOneOf, by as GroupByValueResults, bM as IdentificationData, bN as IdentificationDataIdOneOf, b5 as IncludeMissingValuesOptions, X as Interval, c7 as IntervalWithLiterals, aI as IssueCertificateRequest, as as ItemMetadata, a4 as Member, bL as MessageEnvelope, T as MissingValues, c4 as MissingValuesWithLiterals, Z as Mode, c9 as ModeWithLiterals, bd as NestedAggregation, bb as NestedAggregationItem, bc as NestedAggregationItemKindOneOf, bl as NestedAggregationResults, bm as NestedAggregationResultsResultOneOf, W as NestedAggregationType, c6 as NestedAggregationTypeWithLiterals, bu as NestedResultValue, bv as NestedResultValueResultOneOf, bA as NestedResults, bq as NestedValueAggregationResult, aS as Paging, aV as PagingMetadataV2, a0 as PaidPlanDetails, ag as ParticipantCompletedProgram, al as ParticipantExportsFinished, ak as ParticipantLeft, aw as ParticipantMigration, ah as ParticipantMissedProgramDeadline, ai as ParticipantProgramDurationEnded, bV as ParticipantQuerySpec, aj as ParticipantRemoved, bW as ParticipantSearchSpec, af as ParticipantTagsModified, bU as ParticipantsQueryResult, H as PricingType, bY as PricingTypeWithLiterals, a2 as Progress, K as ProgressStatus, b_ as ProgressStatusWithLiterals, aO as QueryParticipantsRequest, aU as QueryParticipantsResponse, aP as QueryV2, aQ as QueryV2PagingMethodOneOf, b8 as RangeAggregation, bk as RangeAggregationResult, b4 as RangeBucket, bs as RangeResult, bo as RangeResults, aa as ReindexMessage, ab as ReindexMessageActionOneOf, aB as ReindexParticipantsSearchRequest, aC as ReindexParticipantsSearchResponse, R as RequestedFields, b$ as RequestedFieldsWithLiterals, bG as RestoreInfo, bw as Results, b9 as ScalarAggregation, bt as ScalarResult, V as ScalarType, c5 as ScalarTypeWithLiterals, ae as Schema, bg as SearchDetails, a$ as SearchParticipantsRequest, $ as SinglePaymentDetails, O as SortDirection, c3 as SortDirectionWithLiterals, M as SortOrder, c1 as SortOrderWithLiterals, N as SortType, c2 as SortTypeWithLiterals, aR as Sorting, aD as SynchronizeTimeCapsuleTasksRequest, aE as SynchronizeTimeCapsuleTasksResponse, a9 as TagList, a8 as Tags, ao as UpdateParticipantRequest, ap as UpdateParticipantResponse, ac as Upsert, b6 as ValueAggregation, b7 as ValueAggregationOptionsOneOf, bj as ValueAggregationResult, br as ValueResult, bn as ValueResults, _ as WebhookIdentityType, ca as WebhookIdentityTypeWithLiterals, bX as utils } from './online-programs-participants-v3-participant-participants.universal-CVjCdKBh.js';
4
4
 
5
- declare function bulkInviteToProgram$1(httpClient: HttpClient): BulkInviteToProgramSignature;
6
- interface BulkInviteToProgramSignature {
5
+ declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
6
+ interface CreateParticipantSignature {
7
7
  /**
8
- * Bulk invites participants to program.
9
- * For each member participant in Invited state is created.
10
- * @param - Program to which bulk invite participants.
8
+ * Creates a participant.
9
+ *
10
+ * Returns an error if the member is already a participant in the specified program.
11
+ * Use UpdateParticipant to modify existing participants.
12
+ * @param - Participant to create
13
+ * @returns Created participant
11
14
  */
12
- (programId: string, options?: BulkInviteToProgramOptions): Promise<NonNullablePaths<BulkInviteToProgramResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.memberId` | `results.${number}.item.programId` | `results.${number}.item.progress.totalStepsCompleted` | `results.${number}.item.progress.totalStepsAvailable` | `results.${number}.item.progress.completionPercentage` | `results.${number}.item.state` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
15
+ (participant: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`, 3>, options?: CreateParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 4> & {
16
+ __applicationErrorsType?: CreateParticipantApplicationErrors;
17
+ }>;
13
18
  }
14
- declare function bulkInviteAllToProgram$1(httpClient: HttpClient): BulkInviteAllToProgramSignature;
15
- interface BulkInviteAllToProgramSignature {
19
+ declare function updateParticipant$1(httpClient: HttpClient): UpdateParticipantSignature;
20
+ interface UpdateParticipantSignature {
16
21
  /**
17
- * Bulk invites all participants to program, but not more then 1000.
18
- * For each member participant in Invited state is created.
19
- * @param - Program to which bulk add participants.
22
+ * Updates a participant's enrollment status, progress status, or enrollment pricing details.
23
+ * @param - Participant ID.
24
+ * @returns Updated participant
20
25
  */
21
- (programId: string, options?: BulkInviteAllToProgramOptions): Promise<NonNullablePaths<BulkInviteAllToProgramResponse, `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 3>>;
26
+ (_id: string, participant: NonNullablePaths<UpdateParticipant, `revision`, 2>, options?: UpdateParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 4>>;
22
27
  }
23
- declare function bulkAddToProgram$1(httpClient: HttpClient): BulkAddToProgramSignature;
24
- interface BulkAddToProgramSignature {
28
+ declare function bulkCreateParticipants$1(httpClient: HttpClient): BulkCreateParticipantsSignature;
29
+ interface BulkCreateParticipantsSignature {
25
30
  /**
26
- * Bulk adds participants to program.
27
- * Participant will be either created in state Joined, or updated to that state
28
- * from pending one.
29
- * @param - Program to which bulk add participants.
31
+ * Creates participants in bulk.
32
+ *
33
+ * All participants in a single bulk create request must belong to the same program.
34
+ * Returns an error if the member is already a participant in the specified program.
35
+ *
36
+ * When `pricing_type` is `SINGLE_PAYMENT`, provide `single_payment_details`.
37
+ * When `pricing_type` is `PAID_PLAN`, provide `paid_plan_details`.
38
+ * When `pricing_type` is `FREE_COUPON`, provide `free_coupon_details`.
39
+ * Other pricing types (`FREE`, `ADDED_MANUALLY`) do not require details.
40
+ * @param - List of participants to create.
30
41
  */
31
- (programId: string, options?: BulkAddToProgramOptions): Promise<NonNullablePaths<BulkAddToProgramResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.memberId` | `results.${number}.item.programId` | `results.${number}.item.progress.totalStepsCompleted` | `results.${number}.item.progress.totalStepsAvailable` | `results.${number}.item.progress.completionPercentage` | `results.${number}.item.state` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
42
+ (participants: NonNullablePaths<Participant, `enrollmentInfo` | `enrollmentInfo.pricingType` | `memberId` | `programId`, 3>[], options?: BulkCreateParticipantsOptions): Promise<NonNullablePaths<BulkCreateParticipantsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.memberId` | `results.${number}.item.programId` | `results.${number}.item.progress.totalStepsCompleted` | `results.${number}.item.progress.totalStepsAvailable` | `results.${number}.item.progress.completionPercentage` | `results.${number}.item.enrollmentStatus` | `results.${number}.item.progressStatus` | `results.${number}.item.enrollmentInfo.timeZone` | `results.${number}.item.enrollmentInfo.startDate` | `results.${number}.item.enrollmentInfo.pricingType` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
43
+ __applicationErrorsType?: BulkCreateParticipantsApplicationErrors;
44
+ }>;
32
45
  }
33
- declare function bulkApproveParticipant$1(httpClient: HttpClient): BulkApproveParticipantSignature;
34
- interface BulkApproveParticipantSignature {
46
+ declare function bulkCreateParticipantsForAllMembers$1(httpClient: HttpClient): BulkCreateParticipantsForAllMembersSignature;
47
+ interface BulkCreateParticipantsForAllMembersSignature {
35
48
  /**
36
- * Bulk approves participants, who asked to join private program (aka in
37
- * state `APPROVAL_PENDING`). If participant was in other state, no effect and
38
- * error returned.
39
- * @param - Participants to add
49
+ * Creates participants in bulk for all site members in a program, with an optional exclusion filter.
50
+ *
51
+ * Participants are created in the `JOINED` state with the join path set to `ADDED`.
52
+ * Members who are already participants in the program will be skipped.
53
+ * Only members who are not yet participants will be added.
54
+ * @param - ID of the program for which to create participants for all site members in bulk.
40
55
  */
41
- (participantIds: string[], options?: BulkApproveParticipantOptions): Promise<NonNullablePaths<BulkApproveParticipantResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.memberId` | `results.${number}.item.programId` | `results.${number}.item.progress.totalStepsCompleted` | `results.${number}.item.progress.totalStepsAvailable` | `results.${number}.item.progress.completionPercentage` | `results.${number}.item.state` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
56
+ (programId: string, options?: BulkCreateParticipantsForAllMembersOptions): Promise<NonNullablePaths<BulkCreateParticipantsForAllMembersResponse, `jobId`, 2>>;
42
57
  }
43
- declare function bulkApproveAllParticipant$1(httpClient: HttpClient): BulkApproveAllParticipantSignature;
44
- interface BulkApproveAllParticipantSignature {
58
+ declare function deleteParticipant$1(httpClient: HttpClient): DeleteParticipantSignature;
59
+ interface DeleteParticipantSignature {
45
60
  /**
46
- * Bulk approves all pending participants, who asked to join private program (aka
47
- * in state `APPROVAL_PENDING`).
61
+ * Removes a participant from the program.
62
+ *
63
+ * The member will lose access to program content but will remain in any associated social groups.
64
+ * @param - ID of the participant to delete.
48
65
  */
49
- (options?: BulkApproveAllParticipantOptions): Promise<NonNullablePaths<BulkApproveAllParticipantResponse, `jobId`, 2>>;
66
+ (participantId: string): Promise<void>;
50
67
  }
51
- declare const onParticipantAdded$1: EventDefinition<ParticipantAddedEnvelope, "wix.online_programs.v3.participant_added">;
52
- declare const onParticipantApproved$1: EventDefinition<ParticipantApprovedEnvelope, "wix.online_programs.v3.participant_participant_approved">;
53
- declare const onParticipantInvited$1: EventDefinition<ParticipantInvitedEnvelope, "wix.online_programs.v3.participant_participant_invited">;
68
+ declare function issueCertificate$1(httpClient: HttpClient): IssueCertificateSignature;
69
+ interface IssueCertificateSignature {
70
+ /**
71
+ * Issues a certificate to a participant who has completed the program.
72
+ * @param - ID of the participant to issue the certificate to.
73
+ */
74
+ (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> & {
75
+ __applicationErrorsType?: IssueCertificateApplicationErrors;
76
+ }>;
77
+ }
78
+ declare function getPremiumStats$1(httpClient: HttpClient): GetPremiumStatsSignature;
79
+ interface GetPremiumStatsSignature {
80
+ /**
81
+ * Retrieves premium plan statistics for the site.
82
+ */
83
+ (): Promise<NonNullablePaths<GetPremiumStatsResponse, `premiumEnabled` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
84
+ }
85
+ declare function getParticipant$1(httpClient: HttpClient): GetParticipantSignature;
86
+ interface GetParticipantSignature {
87
+ /**
88
+ * Returns a participant by ID.
89
+ * @param - ID of the participant to fetch.
90
+ * @returns The retrieved participant.
91
+ */
92
+ (participantId: string, options?: GetParticipantOptions): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `enrollmentStatus` | `progressStatus` | `enrollmentInfo.singlePaymentDetails.paymentOrderId` | `enrollmentInfo.paidPlanDetails.paidPlanId` | `enrollmentInfo.freeCouponDetails.freeCouponId` | `enrollmentInfo.timeZone` | `enrollmentInfo.startDate` | `enrollmentInfo.pricingType` | `tags.privateTags.tagIds`, 4>>;
93
+ }
94
+ declare function getAccessStatus$1(httpClient: HttpClient): GetAccessStatusSignature;
95
+ interface GetAccessStatusSignature {
96
+ /**
97
+ * Retrieves the access status for the current site, indicating whether participants can access
98
+ * online programs or if access is blocked due to plan limitations or other restrictions.
99
+ */
100
+ (): Promise<NonNullablePaths<GetAccessStatusResponse, `accessBlocked`, 2>>;
101
+ }
102
+ declare function bulkUpdateParticipantTags$1(httpClient: HttpClient): BulkUpdateParticipantTagsSignature;
103
+ interface BulkUpdateParticipantTagsSignature {
104
+ /**
105
+ * Updates tags for multiple Participants by IDs.
106
+ *
107
+ * Allows assigning and/or unassigning tags in a single operation.
108
+ * At least one of assign_tags or unassign_tags must be provided.
109
+ * @param - Participant IDs to update tags for (1-100 items)
110
+ */
111
+ (participantIds: string[], options?: BulkUpdateParticipantTagsOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6> & {
112
+ __applicationErrorsType?: BulkUpdateParticipantTagsApplicationErrors;
113
+ }>;
114
+ }
115
+ declare function bulkUpdateParticipantTagsByFilter$1(httpClient: HttpClient): BulkUpdateParticipantTagsByFilterSignature;
116
+ interface BulkUpdateParticipantTagsByFilterSignature {
117
+ /**
118
+ * Updates tags for Participants matching a filter.
119
+ *
120
+ * Allows assigning and/or unassigning tags for all Participants matching the filter.
121
+ * Returns a job ID for tracking the async operation.
122
+ * @param - WQL filter to select Participants
123
+ */
124
+ (filter: Record<string, any>, options?: BulkUpdateParticipantTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateParticipantTagsByFilterResponse, `jobId`, 2> & {
125
+ __applicationErrorsType?: BulkUpdateParticipantTagsByFilterApplicationErrors;
126
+ }>;
127
+ }
128
+ declare function searchParticipants$1(httpClient: HttpClient): SearchParticipantsSignature;
129
+ interface SearchParticipantsSignature {
130
+ /**
131
+ * Retrieves a list of participants matching the search criteria.
132
+ * @param - Query to search participants.
133
+ */
134
+ (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>>;
135
+ }
136
+ declare const onParticipantCompletedProgram$1: EventDefinition<ParticipantCompletedProgramEnvelope, "wix.online_programs.participants.v3.participant_completed_program">;
137
+ declare const onParticipantCreated$1: EventDefinition<ParticipantCreatedEnvelope, "wix.online_programs.participants.v3.participant_created">;
138
+ declare const onParticipantDeleted$1: EventDefinition<ParticipantDeletedEnvelope, "wix.online_programs.participants.v3.participant_deleted">;
139
+ declare const onParticipantLeft$1: EventDefinition<ParticipantLeftEnvelope, "wix.online_programs.participants.v3.participant_left">;
140
+ declare const onParticipantMissedProgramDeadline$1: EventDefinition<ParticipantMissedProgramDeadlineEnvelope, "wix.online_programs.participants.v3.participant_missed_program_deadline">;
141
+ declare const onParticipantProgramDurationEnded$1: EventDefinition<ParticipantProgramDurationEndedEnvelope, "wix.online_programs.participants.v3.participant_program_duration_ended">;
142
+ declare const onParticipantRemoved$1: EventDefinition<ParticipantRemovedEnvelope, "wix.online_programs.participants.v3.participant_removed">;
143
+ declare const onParticipantTagsModified$1: EventDefinition<ParticipantTagsModifiedEnvelope, "wix.online_programs.participants.v3.participant_tags_modified">;
144
+ declare const onParticipantUpdated$1: EventDefinition<ParticipantUpdatedEnvelope, "wix.online_programs.participants.v3.participant_updated">;
54
145
 
55
- declare const bulkInviteToProgram: MaybeContext<BuildRESTFunction<typeof bulkInviteToProgram$1> & typeof bulkInviteToProgram$1>;
56
- declare const bulkInviteAllToProgram: MaybeContext<BuildRESTFunction<typeof bulkInviteAllToProgram$1> & typeof bulkInviteAllToProgram$1>;
57
- declare const bulkAddToProgram: MaybeContext<BuildRESTFunction<typeof bulkAddToProgram$1> & typeof bulkAddToProgram$1>;
58
- declare const bulkApproveParticipant: MaybeContext<BuildRESTFunction<typeof bulkApproveParticipant$1> & typeof bulkApproveParticipant$1>;
59
- declare const bulkApproveAllParticipant: MaybeContext<BuildRESTFunction<typeof bulkApproveAllParticipant$1> & typeof bulkApproveAllParticipant$1>;
60
- /** */
61
- declare const onParticipantAdded: BuildEventDefinition<typeof onParticipantAdded$1> & typeof onParticipantAdded$1;
62
- /** */
63
- declare const onParticipantApproved: BuildEventDefinition<typeof onParticipantApproved$1> & typeof onParticipantApproved$1;
64
- /** */
65
- declare const onParticipantInvited: BuildEventDefinition<typeof onParticipantInvited$1> & typeof onParticipantInvited$1;
146
+ declare function customQueryParticipants(httpClient: HttpClient): {
147
+ (query: ParticipantQuery, options?: QueryParticipantsOptions): ReturnType<typeof typedQueryParticipants>;
148
+ (options?: QueryParticipantsOptions): ParticipantsQueryBuilder;
149
+ };
150
+ declare const createParticipant: MaybeContext<BuildRESTFunction<typeof createParticipant$1> & typeof createParticipant$1>;
151
+ declare const updateParticipant: MaybeContext<BuildRESTFunction<typeof updateParticipant$1> & typeof updateParticipant$1>;
152
+ declare const bulkCreateParticipants: MaybeContext<BuildRESTFunction<typeof bulkCreateParticipants$1> & typeof bulkCreateParticipants$1>;
153
+ declare const bulkCreateParticipantsForAllMembers: MaybeContext<BuildRESTFunction<typeof bulkCreateParticipantsForAllMembers$1> & typeof bulkCreateParticipantsForAllMembers$1>;
154
+ declare const deleteParticipant: MaybeContext<BuildRESTFunction<typeof deleteParticipant$1> & typeof deleteParticipant$1>;
155
+ declare const issueCertificate: MaybeContext<BuildRESTFunction<typeof issueCertificate$1> & typeof issueCertificate$1>;
156
+ declare const getPremiumStats: MaybeContext<BuildRESTFunction<typeof getPremiumStats$1> & typeof getPremiumStats$1>;
157
+ declare const getParticipant: MaybeContext<BuildRESTFunction<typeof getParticipant$1> & typeof getParticipant$1>;
158
+ declare const getAccessStatus: MaybeContext<BuildRESTFunction<typeof getAccessStatus$1> & typeof getAccessStatus$1>;
159
+ declare const bulkUpdateParticipantTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateParticipantTags$1> & typeof bulkUpdateParticipantTags$1>;
160
+ declare const bulkUpdateParticipantTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateParticipantTagsByFilter$1> & typeof bulkUpdateParticipantTagsByFilter$1>;
161
+ declare const searchParticipants: MaybeContext<BuildRESTFunction<typeof searchParticipants$1> & typeof searchParticipants$1>;
162
+ declare const queryParticipants: MaybeContext<BuildRESTFunction<typeof customQueryParticipants> & typeof customQueryParticipants>;
163
+ /**
164
+ * Triggered when a participant completes a program.
165
+ */
166
+ declare const onParticipantCompletedProgram: BuildEventDefinition<typeof onParticipantCompletedProgram$1> & typeof onParticipantCompletedProgram$1;
167
+ /**
168
+ * Triggered when a participant is created.
169
+ */
170
+ declare const onParticipantCreated: BuildEventDefinition<typeof onParticipantCreated$1> & typeof onParticipantCreated$1;
171
+ /**
172
+ * Triggered when a participant is deleted.
173
+ */
174
+ declare const onParticipantDeleted: BuildEventDefinition<typeof onParticipantDeleted$1> & typeof onParticipantDeleted$1;
175
+ /**
176
+ * Triggered when a participant voluntarily leaves a program.
177
+ */
178
+ declare const onParticipantLeft: BuildEventDefinition<typeof onParticipantLeft$1> & typeof onParticipantLeft$1;
179
+ /**
180
+ * Triggered when a participant misses a program deadline.
181
+ */
182
+ declare const onParticipantMissedProgramDeadline: BuildEventDefinition<typeof onParticipantMissedProgramDeadline$1> & typeof onParticipantMissedProgramDeadline$1;
183
+ /**
184
+ * Triggered when a participant's program duration ends.
185
+ */
186
+ declare const onParticipantProgramDurationEnded: BuildEventDefinition<typeof onParticipantProgramDurationEnded$1> & typeof onParticipantProgramDurationEnded$1;
187
+ /**
188
+ * Triggered when an administrator removes a participant from a program.
189
+ */
190
+ declare const onParticipantRemoved: BuildEventDefinition<typeof onParticipantRemoved$1> & typeof onParticipantRemoved$1;
191
+ /**
192
+ * Triggered when a participant's tags are modified.
193
+ */
194
+ declare const onParticipantTagsModified: BuildEventDefinition<typeof onParticipantTagsModified$1> & typeof onParticipantTagsModified$1;
195
+ /**
196
+ * Triggered when a participant is updated.
197
+ */
198
+ declare const onParticipantUpdated: BuildEventDefinition<typeof onParticipantUpdated$1> & typeof onParticipantUpdated$1;
66
199
 
67
- export { BulkAddToProgramOptions, BulkAddToProgramResponse, BulkApproveAllParticipantOptions, BulkApproveAllParticipantResponse, BulkApproveParticipantOptions, BulkApproveParticipantResponse, BulkInviteAllToProgramOptions, BulkInviteAllToProgramResponse, BulkInviteToProgramOptions, BulkInviteToProgramResponse, ParticipantAddedEnvelope, ParticipantApprovedEnvelope, ParticipantInvitedEnvelope, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram, onParticipantAdded, onParticipantApproved, onParticipantInvited };
200
+ export { BulkCreateParticipantsApplicationErrors, BulkCreateParticipantsForAllMembersOptions, BulkCreateParticipantsForAllMembersResponse, BulkCreateParticipantsOptions, BulkCreateParticipantsResponse, BulkUpdateParticipantTagsApplicationErrors, BulkUpdateParticipantTagsByFilterApplicationErrors, BulkUpdateParticipantTagsByFilterOptions, BulkUpdateParticipantTagsByFilterResponse, BulkUpdateParticipantTagsOptions, BulkUpdateParticipantTagsResponse, CreateParticipantApplicationErrors, CreateParticipantOptions, GetAccessStatusResponse, GetParticipantOptions, GetPremiumStatsResponse, IssueCertificateApplicationErrors, IssueCertificateOptions, IssueCertificateResponse, Participant, ParticipantCompletedProgramEnvelope, ParticipantCreatedEnvelope, ParticipantDeletedEnvelope, ParticipantLeftEnvelope, ParticipantMissedProgramDeadlineEnvelope, ParticipantProgramDurationEndedEnvelope, ParticipantQuery, ParticipantRemovedEnvelope, ParticipantSearch, ParticipantTagsModifiedEnvelope, ParticipantUpdatedEnvelope, ParticipantsQueryBuilder, QueryParticipantsOptions, SearchParticipantsOptions, SearchParticipantsResponse, UpdateParticipant, UpdateParticipantOptions, bulkCreateParticipants, bulkCreateParticipantsForAllMembers, bulkUpdateParticipantTags, bulkUpdateParticipantTagsByFilter, createParticipant, deleteParticipant, getAccessStatus, getParticipant, getPremiumStats, issueCertificate, onParticipantCompletedProgram, onParticipantCreated, onParticipantDeleted, onParticipantLeft, onParticipantMissedProgramDeadline, onParticipantProgramDurationEnded, onParticipantRemoved, onParticipantTagsModified, onParticipantUpdated, queryParticipants, searchParticipants, updateParticipant };