@wix/auto_sdk_online-programs_participants 1.0.4 → 1.0.6

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 (37) hide show
  1. package/build/cjs/index.d.ts +71 -103
  2. package/build/cjs/index.js +490 -706
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +295 -914
  5. package/build/cjs/index.typings.js +370 -501
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +213 -757
  8. package/build/cjs/meta.js +277 -418
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +71 -103
  11. package/build/es/index.mjs +495 -695
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +295 -914
  14. package/build/es/index.typings.mjs +391 -511
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +213 -757
  17. package/build/es/meta.mjs +261 -390
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +71 -103
  20. package/build/internal/cjs/index.js +490 -706
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +295 -914
  23. package/build/internal/cjs/index.typings.js +370 -501
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +213 -757
  26. package/build/internal/cjs/meta.js +277 -418
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +71 -103
  29. package/build/internal/es/index.mjs +495 -695
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +295 -914
  32. package/build/internal/es/index.typings.mjs +391 -511
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +213 -757
  35. package/build/internal/es/meta.mjs +261 -390
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +3 -3
@@ -1,60 +1,80 @@
1
1
  import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
2
- import { JoinProgramResponse, Participant, ParticipantsQueryBuilder, GetAccessStatusResponse, ApplyCouponIdentifiers, ApplyCouponResponse, RevertCouponIdentifiers, RevertCouponResponse, BulkInviteToProgramOptions, BulkInviteToProgramResponse, BulkInviteAllToProgramOptions, BulkInviteAllToProgramResponse, BulkAddToProgramOptions, BulkAddToProgramResponse, BulkAddAllToProgramOptions, BulkAddAllToProgramResponse, BulkApproveParticipantOptions, BulkApproveParticipantResponse, BulkApproveAllParticipantOptions, BulkApproveAllParticipantResponse, IssueCertificateResponse, GetCompletionStatsResponse, GetPremiumStatsResponse, ParticipantJoinedEnvelope, ParticipantLeftEnvelope, ParticipantDeletedEnvelope, ParticipantAddedEnvelope, ParticipantApprovedEnvelope, ParticipantInvitedEnvelope, ParticipantRejectedEnvelope } from './index.typings.js';
3
- export { AccountInfo, ActionEvent, Address, AddressLocation, AddressStreetOneOf, ApplicationError, ApplyCouponRequest, AutoRemovedOptions, BaseEventMetadata, Behavior, BehaviorBehaviorOneOf, Benefit, BenefitNotification, BenefitType, BenefitTypeWithLiterals, BulkActionMetadata, BulkAddAllToProgramRequest, BulkAddToProgramRequest, BulkAddToProgramResult, BulkApproveAllParticipantRequest, BulkApproveParticipantRequest, BulkApproveParticipantResult, BulkInviteAllToProgramRequest, BulkInviteToProgramRequest, BulkInviteToProgramResult, Certificate, CompletedOptions, CreditCardPaymentMethodData, CurrencyAmount, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteParticipantRequest, DeleteParticipantResponse, Discount, DiscountDiscountOneOf, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntryPass, Event, EventMetadata, EventType, EventTypeWithLiterals, EventWithLiterals, ExportParticipantsStatsRequest, ExportParticipantsStatsResponse, ExtendedFields, FailedOptions, FreeCouponOptions, FullAddressContactDetails, GetAccessStatusRequest, GetCompletionStatsRequest, GetParticipantRequest, GetParticipantResponse, GetPremiumStatsRequest, IdentificationData, IdentificationDataIdOneOf, Initiator, InitiatorWithLiterals, IssueCertificateRequest, ItemMetadata, JoinPath, JoinPathWithLiterals, JoinProgramRequest, JoinedOptions, JoinedOptionsJoinPathOptionsOneOf, LeaveProgramRequest, LeaveProgramResponse, MessageEnvelope, OfflinePaymentSent, Order, OrderAdditionalCharges, OrderItem, OrderItemCategory, OrderItemCategoryWithLiterals, PaidPlanOptions, ParticipantAdded, ParticipantApproved, ParticipantExportsFinished, ParticipantInvited, ParticipantJoined, ParticipantLeft, ParticipantRejected, ParticipantStateOptionsOneOf, ParticipantsQueryResult, PaymentEvent, PaymentEventEventOneOf, PaymentFailed, PaymentPendingOptions, Progress, QueryParticipantsRequest, QueryParticipantsResponse, RecurringPaymentCancellationDetails, RecurringPaymentDetails, RecurringPaymentStatusChangedEvent, Refund, RefundStatus, RefundStatusChangedEvent, RefundStatusWithLiterals, RemovalReason, RemovalReasonWithLiterals, RestoreInfo, RevertCouponRequest, ScheduledAction, ScheduledActionType, ScheduledActionTypeWithLiterals, SinglePaymentConfirmed, SinglePaymentDeclined, SinglePaymentOptions, SortOrder, SortOrderWithLiterals, Sorting, StandardDetails, State, StateWithLiterals, Status, StatusWithLiterals, StreetAddress, Subdivision, SubdivisionType, SubdivisionTypeWithLiterals, SuspendedOptions, Transaction, TransactionCreatedEvent, TransactionPaymentMethodDataOneOf, TransactionStatus, TransactionStatusChangedEvent, TransactionStatusWithLiterals, TransactionUpdatedEvent, VatId, VatType, VatTypeWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
2
+ import { Participant, BulkCreateParticipantOptions, BulkCreateParticipantResponse, BulkAddAllToProgramOptions, BulkAddAllToProgramResponse, IssueCertificateResponse, GetCompletionStatsResponse, GetPremiumStatsResponse, GetAccessStatusResponse, BulkInviteToProgramOptions, BulkInviteToProgramResponse, BulkInviteAllToProgramOptions, BulkInviteAllToProgramResponse, BulkAddToProgramOptions, BulkAddToProgramResponse, BulkApproveParticipantOptions, BulkApproveParticipantResponse, BulkApproveAllParticipantOptions, BulkApproveAllParticipantResponse, ParticipantAddedEnvelope, ParticipantApprovedEnvelope, ParticipantInvitedEnvelope, ParticipantsQueryBuilder, CursorQuery, typedQueryParticipants } from './index.typings.js';
3
+ export { ActionEvent, ApplicationError, BaseEventMetadata, Behavior, BehaviorBehaviorOneOf, Benefit, BenefitNotification, BenefitType, BenefitTypeWithLiterals, BulkActionMetadata, BulkAddAllToProgramRequest, BulkAddToProgramRequest, BulkAddToProgramResult, BulkApproveAllParticipantRequest, BulkApproveParticipantRequest, BulkApproveParticipantResult, BulkCreateParticipantRequest, BulkInviteAllToProgramRequest, BulkInviteToProgramRequest, BulkInviteToProgramResult, BulkParticipantResult, Certificate, CommonBulkActionMetadata, CommonItemMetadata, CreateParticipantRequest, CreateParticipantResponse, CursorPaging, CursorPagingMetadata, CursorQueryPagingMethodOneOf, Cursors, DeleteParticipantRequest, DeleteParticipantResponse, Discount, DiscountDiscountOneOf, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EntryPass, Event, EventMetadata, EventWithLiterals, ExportParticipantsStatsRequest, ExportParticipantsStatsResponse, ExtendedFields, GetAccessStatusRequest, GetCompletionStatsRequest, GetParticipantRequest, GetParticipantResponse, GetPremiumStatsRequest, IdentificationData, IdentificationDataIdOneOf, IssueCertificateRequest, ItemMetadata, JoinPath, JoinPathWithLiterals, JoinedInfo, Member, MessageEnvelope, ParticipantAdded, ParticipantApproved, ParticipantExportsFinished, ParticipantInvited, ParticipantsQueryResult, PaymentInfo, Progress, QueryParticipantsRequest, QueryParticipantsResponse, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, State, StateWithLiterals, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
4
4
 
5
- declare function joinProgram$1(httpClient: HttpClient): JoinProgramSignature;
6
- interface JoinProgramSignature {
5
+ declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
6
+ interface CreateParticipantSignature {
7
7
  /**
8
- * Member joins the program. By the type of program, participant in corresponding
9
- * state will be created.
10
- * @param - Program to join
8
+ * @param - Participant to create
9
+ * @returns Created participant
11
10
  */
12
- (programId: string): Promise<NonNullablePaths<JoinProgramResponse, `participant.paymentPendingOptions.paidPlanIds` | `participant.joinedOptions.singlePaymentOptions.orderId` | `participant.joinedOptions.paidPlanOptions.planIds` | `participant.joinedOptions.freeCouponOptions.couponId` | `participant.joinedOptions.timeZone` | `participant.joinedOptions.startDate` | `participant.joinedOptions.joinPath` | `participant.completedOptions.startDate` | `participant.failedOptions.startDate` | `participant.suspendedOptions.startDate` | `participant.autoRemovedOptions.startDate` | `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.state`, 5>>;
11
+ (participant: Participant): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 3>>;
13
12
  }
14
- declare function getParticipant$1(httpClient: HttpClient): GetParticipantSignature;
15
- interface GetParticipantSignature {
13
+ declare function bulkCreateParticipant$1(httpClient: HttpClient): BulkCreateParticipantSignature;
14
+ interface BulkCreateParticipantSignature {
16
15
  /**
17
- * Returns participant.
18
- * @param - Participant id to fetch
19
- * @returns existing participant
16
+ * Creates participants in bulk.
17
+ * @param - List of participants you want to create
18
+ */
19
+ (participants: Participant[], options?: BulkCreateParticipantOptions): Promise<NonNullablePaths<BulkCreateParticipantResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.memberId` | `results.${number}.item.programId` | `results.${number}.item.progress.totalStepsCompleted` | `results.${number}.item.progress.totalStepsAvailable` | `results.${number}.item.progress.completionPercentage` | `results.${number}.item.state` | `results.${number}.item.joinedInfo.timeZone` | `results.${number}.item.joinedInfo.startDate` | `results.${number}.item.joinedInfo.joinPath` | `results.${number}.item.member.contactId` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
20
+ }
21
+ declare function bulkAddAllToProgram$1(httpClient: HttpClient): BulkAddAllToProgramSignature;
22
+ interface BulkAddAllToProgramSignature {
23
+ /**
24
+ * Bulk adds all site members to program, but not more then 1000.
25
+ * Participant will be either created in state Joined, or updated to that state
26
+ * from pending one.
27
+ * @param - Program to which bulk add participants.
20
28
  */
21
- (participantId: string): Promise<NonNullablePaths<Participant, `paymentPendingOptions.paidPlanIds` | `joinedOptions.singlePaymentOptions.orderId` | `joinedOptions.paidPlanOptions.planIds` | `joinedOptions.freeCouponOptions.couponId` | `joinedOptions.timeZone` | `joinedOptions.startDate` | `joinedOptions.joinPath` | `completedOptions.startDate` | `failedOptions.startDate` | `suspendedOptions.startDate` | `autoRemovedOptions.startDate` | `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state`, 4>>;
29
+ (programId: string, options?: BulkAddAllToProgramOptions): Promise<NonNullablePaths<BulkAddAllToProgramResponse, `jobId`, 2>>;
22
30
  }
23
- declare function leaveProgram$1(httpClient: HttpClient): LeaveProgramSignature;
24
- interface LeaveProgramSignature {
31
+ declare function deleteParticipant$1(httpClient: HttpClient): DeleteParticipantSignature;
32
+ interface DeleteParticipantSignature {
25
33
  /**
26
- * Participant leaves program. Entity will be deleted. Idempotent call.
27
- * @param - Participant id to leave program
34
+ * Delete participant from program. Removes participant from member
35
+ * group. Leaves him in Social Group.
36
+ * @param - Participants to delete
28
37
  */
29
38
  (participantId: string): Promise<void>;
30
39
  }
31
- declare function queryParticipants$1(httpClient: HttpClient): QueryParticipantsSignature;
32
- interface QueryParticipantsSignature {
40
+ declare function issueCertificate$1(httpClient: HttpClient): IssueCertificateSignature;
41
+ interface IssueCertificateSignature {
33
42
  /**
34
- * Query existing participants
43
+ * Issue certificate by site admin
44
+ * @param - Participant to get certificate
35
45
  */
36
- (): ParticipantsQueryBuilder;
46
+ (participantId: string): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.state` | `participant.joinedInfo.timeZone` | `participant.joinedInfo.startDate` | `participant.joinedInfo.joinPath` | `participant.member.contactId`, 4>>;
37
47
  }
38
- declare function getAccessStatus$1(httpClient: HttpClient): GetAccessStatusSignature;
39
- interface GetAccessStatusSignature {
48
+ declare function getCompletionStats$1(httpClient: HttpClient): GetCompletionStatsSignature;
49
+ interface GetCompletionStatsSignature {
40
50
  /**
41
- * Get access status
51
+ * Get program's completion stats
52
+ * @param - program id to get stats for
42
53
  */
43
- (): Promise<NonNullablePaths<GetAccessStatusResponse, `isBlocked`, 2>>;
54
+ (programId: string): Promise<NonNullablePaths<GetCompletionStatsResponse, `completedAll` | `completionRate`, 2>>;
44
55
  }
45
- declare function applyCoupon$1(httpClient: HttpClient): ApplyCouponSignature;
46
- interface ApplyCouponSignature {
56
+ declare function getPremiumStats$1(httpClient: HttpClient): GetPremiumStatsSignature;
57
+ interface GetPremiumStatsSignature {
47
58
  /**
48
- * Apply coupon to order
59
+ * Get premium stats
49
60
  */
50
- (identifiers: NonNullablePaths<ApplyCouponIdentifiers, `couponCode` | `participantId`, 2>, orderId: string): Promise<NonNullablePaths<ApplyCouponResponse, `couponId` | `subTotal` | `discount` | `total`, 2>>;
61
+ (): Promise<NonNullablePaths<GetPremiumStatsResponse, `hasPremium` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
51
62
  }
52
- declare function revertCoupon$1(httpClient: HttpClient): RevertCouponSignature;
53
- interface RevertCouponSignature {
63
+ declare function getParticipant$1(httpClient: HttpClient): GetParticipantSignature;
64
+ interface GetParticipantSignature {
54
65
  /**
55
- * Remove coupon from order
66
+ * Returns participant.
67
+ * @param - Participant id to fetch
68
+ * @returns existing participant
69
+ */
70
+ (participantId: string): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 3>>;
71
+ }
72
+ declare function getAccessStatus$1(httpClient: HttpClient): GetAccessStatusSignature;
73
+ interface GetAccessStatusSignature {
74
+ /**
75
+ * Get access status
56
76
  */
57
- (identifiers: NonNullablePaths<RevertCouponIdentifiers, `couponId` | `participantId`, 2>, orderId: string): Promise<NonNullablePaths<RevertCouponResponse, `total`, 2>>;
77
+ (): Promise<NonNullablePaths<GetAccessStatusResponse, `isBlocked`, 2>>;
58
78
  }
59
79
  declare function bulkInviteToProgram$1(httpClient: HttpClient): BulkInviteToProgramSignature;
60
80
  interface BulkInviteToProgramSignature {
@@ -63,7 +83,7 @@ interface BulkInviteToProgramSignature {
63
83
  * For each member participant in Invited state is created.
64
84
  * @param - Program to which bulk invite participants.
65
85
  */
66
- (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.joinedOptions.timeZone` | `results.${number}.item.joinedOptions.startDate` | `results.${number}.item.joinedOptions.joinPath` | `results.${number}.item.completedOptions.startDate` | `results.${number}.item.failedOptions.startDate` | `results.${number}.item.suspendedOptions.startDate` | `results.${number}.item.autoRemovedOptions.startDate` | `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` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
86
+ (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>>;
67
87
  }
68
88
  declare function bulkInviteAllToProgram$1(httpClient: HttpClient): BulkInviteAllToProgramSignature;
69
89
  interface BulkInviteAllToProgramSignature {
@@ -82,17 +102,7 @@ interface BulkAddToProgramSignature {
82
102
  * from pending one.
83
103
  * @param - Program to which bulk add participants.
84
104
  */
85
- (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.joinedOptions.timeZone` | `results.${number}.item.joinedOptions.startDate` | `results.${number}.item.joinedOptions.joinPath` | `results.${number}.item.completedOptions.startDate` | `results.${number}.item.failedOptions.startDate` | `results.${number}.item.suspendedOptions.startDate` | `results.${number}.item.autoRemovedOptions.startDate` | `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` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
86
- }
87
- declare function bulkAddAllToProgram$1(httpClient: HttpClient): BulkAddAllToProgramSignature;
88
- interface BulkAddAllToProgramSignature {
89
- /**
90
- * Bulk adds all site members to program, but not more then 1000.
91
- * Participant will be either created in state Joined, or updated to that state
92
- * from pending one.
93
- * @param - Program to which bulk add participants.
94
- */
95
- (programId: string, options?: BulkAddAllToProgramOptions): Promise<NonNullablePaths<BulkAddAllToProgramResponse, `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 3>>;
105
+ (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>>;
96
106
  }
97
107
  declare function bulkApproveParticipant$1(httpClient: HttpClient): BulkApproveParticipantSignature;
98
108
  interface BulkApproveParticipantSignature {
@@ -102,7 +112,7 @@ interface BulkApproveParticipantSignature {
102
112
  * error returned.
103
113
  * @param - Participants to add
104
114
  */
105
- (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.joinedOptions.timeZone` | `results.${number}.item.joinedOptions.startDate` | `results.${number}.item.joinedOptions.joinPath` | `results.${number}.item.completedOptions.startDate` | `results.${number}.item.failedOptions.startDate` | `results.${number}.item.suspendedOptions.startDate` | `results.${number}.item.autoRemovedOptions.startDate` | `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` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
115
+ (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>>;
106
116
  }
107
117
  declare function bulkApproveAllParticipant$1(httpClient: HttpClient): BulkApproveAllParticipantSignature;
108
118
  interface BulkApproveAllParticipantSignature {
@@ -112,76 +122,34 @@ interface BulkApproveAllParticipantSignature {
112
122
  */
113
123
  (options?: BulkApproveAllParticipantOptions): Promise<NonNullablePaths<BulkApproveAllParticipantResponse, `jobId`, 2>>;
114
124
  }
115
- declare function deleteParticipant$1(httpClient: HttpClient): DeleteParticipantSignature;
116
- interface DeleteParticipantSignature {
117
- /**
118
- * Delete participant from program by owner will. Removes participant from member
119
- * group. Leaves him in Social Group.
120
- * @param - Participants to delete
121
- */
122
- (participantId: string): Promise<void>;
123
- }
124
- declare function issueCertificate$1(httpClient: HttpClient): IssueCertificateSignature;
125
- interface IssueCertificateSignature {
126
- /**
127
- * Issue certificate by site admin
128
- * @param - Participant to get certificate
129
- */
130
- (participantId: string): Promise<NonNullablePaths<IssueCertificateResponse, `participant.paymentPendingOptions.paidPlanIds` | `participant.joinedOptions.singlePaymentOptions.orderId` | `participant.joinedOptions.paidPlanOptions.planIds` | `participant.joinedOptions.freeCouponOptions.couponId` | `participant.joinedOptions.timeZone` | `participant.joinedOptions.startDate` | `participant.joinedOptions.joinPath` | `participant.completedOptions.startDate` | `participant.failedOptions.startDate` | `participant.suspendedOptions.startDate` | `participant.autoRemovedOptions.startDate` | `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.state`, 5>>;
131
- }
132
- declare function getCompletionStats$1(httpClient: HttpClient): GetCompletionStatsSignature;
133
- interface GetCompletionStatsSignature {
134
- /**
135
- * Get program's completion stats
136
- * @param - program id to get stats for
137
- */
138
- (programId: string): Promise<NonNullablePaths<GetCompletionStatsResponse, `completedAll` | `completionRate`, 2>>;
139
- }
140
- declare function getPremiumStats$1(httpClient: HttpClient): GetPremiumStatsSignature;
141
- interface GetPremiumStatsSignature {
142
- /**
143
- * Get premium stats
144
- */
145
- (): Promise<NonNullablePaths<GetPremiumStatsResponse, `hasPremium` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
146
- }
147
- declare const onParticipantJoined$1: EventDefinition<ParticipantJoinedEnvelope, "wix.online_programs.v3.participant_participant_joined">;
148
- declare const onParticipantLeft$1: EventDefinition<ParticipantLeftEnvelope, "wix.online_programs.v3.participant_participant_left">;
149
- declare const onParticipantDeleted$1: EventDefinition<ParticipantDeletedEnvelope, "wix.online_programs.v3.participant_deleted">;
150
- declare const onParticipantAdded$1: EventDefinition<ParticipantAddedEnvelope, "wix.online_programs.v3.participant_participant_added">;
125
+ declare const onParticipantAdded$1: EventDefinition<ParticipantAddedEnvelope, "wix.online_programs.v3.participant_added">;
151
126
  declare const onParticipantApproved$1: EventDefinition<ParticipantApprovedEnvelope, "wix.online_programs.v3.participant_participant_approved">;
152
127
  declare const onParticipantInvited$1: EventDefinition<ParticipantInvitedEnvelope, "wix.online_programs.v3.participant_participant_invited">;
153
- declare const onParticipantRejected$1: EventDefinition<ParticipantRejectedEnvelope, "wix.online_programs.v3.participant_participant_rejected">;
154
128
 
155
- declare const joinProgram: MaybeContext<BuildRESTFunction<typeof joinProgram$1> & typeof joinProgram$1>;
129
+ declare function customQueryParticipants(httpClient: HttpClient): {
130
+ (): ParticipantsQueryBuilder;
131
+ (query: CursorQuery): ReturnType<typeof typedQueryParticipants>;
132
+ };
133
+ declare const createParticipant: MaybeContext<BuildRESTFunction<typeof createParticipant$1> & typeof createParticipant$1>;
134
+ declare const bulkCreateParticipant: MaybeContext<BuildRESTFunction<typeof bulkCreateParticipant$1> & typeof bulkCreateParticipant$1>;
135
+ declare const bulkAddAllToProgram: MaybeContext<BuildRESTFunction<typeof bulkAddAllToProgram$1> & typeof bulkAddAllToProgram$1>;
136
+ declare const deleteParticipant: MaybeContext<BuildRESTFunction<typeof deleteParticipant$1> & typeof deleteParticipant$1>;
137
+ declare const issueCertificate: MaybeContext<BuildRESTFunction<typeof issueCertificate$1> & typeof issueCertificate$1>;
138
+ declare const getCompletionStats: MaybeContext<BuildRESTFunction<typeof getCompletionStats$1> & typeof getCompletionStats$1>;
139
+ declare const getPremiumStats: MaybeContext<BuildRESTFunction<typeof getPremiumStats$1> & typeof getPremiumStats$1>;
156
140
  declare const getParticipant: MaybeContext<BuildRESTFunction<typeof getParticipant$1> & typeof getParticipant$1>;
157
- declare const leaveProgram: MaybeContext<BuildRESTFunction<typeof leaveProgram$1> & typeof leaveProgram$1>;
158
- declare const queryParticipants: MaybeContext<BuildRESTFunction<typeof queryParticipants$1> & typeof queryParticipants$1>;
159
141
  declare const getAccessStatus: MaybeContext<BuildRESTFunction<typeof getAccessStatus$1> & typeof getAccessStatus$1>;
160
- declare const applyCoupon: MaybeContext<BuildRESTFunction<typeof applyCoupon$1> & typeof applyCoupon$1>;
161
- declare const revertCoupon: MaybeContext<BuildRESTFunction<typeof revertCoupon$1> & typeof revertCoupon$1>;
162
142
  declare const bulkInviteToProgram: MaybeContext<BuildRESTFunction<typeof bulkInviteToProgram$1> & typeof bulkInviteToProgram$1>;
163
143
  declare const bulkInviteAllToProgram: MaybeContext<BuildRESTFunction<typeof bulkInviteAllToProgram$1> & typeof bulkInviteAllToProgram$1>;
164
144
  declare const bulkAddToProgram: MaybeContext<BuildRESTFunction<typeof bulkAddToProgram$1> & typeof bulkAddToProgram$1>;
165
- declare const bulkAddAllToProgram: MaybeContext<BuildRESTFunction<typeof bulkAddAllToProgram$1> & typeof bulkAddAllToProgram$1>;
166
145
  declare const bulkApproveParticipant: MaybeContext<BuildRESTFunction<typeof bulkApproveParticipant$1> & typeof bulkApproveParticipant$1>;
167
146
  declare const bulkApproveAllParticipant: MaybeContext<BuildRESTFunction<typeof bulkApproveAllParticipant$1> & typeof bulkApproveAllParticipant$1>;
168
- declare const deleteParticipant: MaybeContext<BuildRESTFunction<typeof deleteParticipant$1> & typeof deleteParticipant$1>;
169
- declare const issueCertificate: MaybeContext<BuildRESTFunction<typeof issueCertificate$1> & typeof issueCertificate$1>;
170
- declare const getCompletionStats: MaybeContext<BuildRESTFunction<typeof getCompletionStats$1> & typeof getCompletionStats$1>;
171
- declare const getPremiumStats: MaybeContext<BuildRESTFunction<typeof getPremiumStats$1> & typeof getPremiumStats$1>;
172
- /** */
173
- declare const onParticipantJoined: BuildEventDefinition<typeof onParticipantJoined$1> & typeof onParticipantJoined$1;
174
- /** */
175
- declare const onParticipantLeft: BuildEventDefinition<typeof onParticipantLeft$1> & typeof onParticipantLeft$1;
176
- /** */
177
- declare const onParticipantDeleted: BuildEventDefinition<typeof onParticipantDeleted$1> & typeof onParticipantDeleted$1;
147
+ declare const queryParticipants: MaybeContext<BuildRESTFunction<typeof customQueryParticipants> & typeof customQueryParticipants>;
178
148
  /** */
179
149
  declare const onParticipantAdded: BuildEventDefinition<typeof onParticipantAdded$1> & typeof onParticipantAdded$1;
180
150
  /** */
181
151
  declare const onParticipantApproved: BuildEventDefinition<typeof onParticipantApproved$1> & typeof onParticipantApproved$1;
182
152
  /** */
183
153
  declare const onParticipantInvited: BuildEventDefinition<typeof onParticipantInvited$1> & typeof onParticipantInvited$1;
184
- /** */
185
- declare const onParticipantRejected: BuildEventDefinition<typeof onParticipantRejected$1> & typeof onParticipantRejected$1;
186
154
 
187
- export { ApplyCouponIdentifiers, ApplyCouponResponse, BulkAddAllToProgramOptions, BulkAddAllToProgramResponse, BulkAddToProgramOptions, BulkAddToProgramResponse, BulkApproveAllParticipantOptions, BulkApproveAllParticipantResponse, BulkApproveParticipantOptions, BulkApproveParticipantResponse, BulkInviteAllToProgramOptions, BulkInviteAllToProgramResponse, BulkInviteToProgramOptions, BulkInviteToProgramResponse, GetAccessStatusResponse, GetCompletionStatsResponse, GetPremiumStatsResponse, IssueCertificateResponse, JoinProgramResponse, Participant, ParticipantAddedEnvelope, ParticipantApprovedEnvelope, ParticipantDeletedEnvelope, ParticipantInvitedEnvelope, ParticipantJoinedEnvelope, ParticipantLeftEnvelope, ParticipantRejectedEnvelope, ParticipantsQueryBuilder, RevertCouponIdentifiers, RevertCouponResponse, applyCoupon, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram, deleteParticipant, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, joinProgram, leaveProgram, onParticipantAdded, onParticipantApproved, onParticipantDeleted, onParticipantInvited, onParticipantJoined, onParticipantLeft, onParticipantRejected, queryParticipants, revertCoupon };
155
+ export { BulkAddAllToProgramOptions, BulkAddAllToProgramResponse, BulkAddToProgramOptions, BulkAddToProgramResponse, BulkApproveAllParticipantOptions, BulkApproveAllParticipantResponse, BulkApproveParticipantOptions, BulkApproveParticipantResponse, BulkCreateParticipantOptions, BulkCreateParticipantResponse, BulkInviteAllToProgramOptions, BulkInviteAllToProgramResponse, BulkInviteToProgramOptions, BulkInviteToProgramResponse, CursorQuery, GetAccessStatusResponse, GetCompletionStatsResponse, GetPremiumStatsResponse, IssueCertificateResponse, Participant, ParticipantAddedEnvelope, ParticipantApprovedEnvelope, ParticipantInvitedEnvelope, ParticipantsQueryBuilder, bulkAddAllToProgram, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkCreateParticipant, bulkInviteAllToProgram, bulkInviteToProgram, createParticipant, deleteParticipant, getAccessStatus, getCompletionStats, getParticipant, getPremiumStats, issueCertificate, onParticipantAdded, onParticipantApproved, onParticipantInvited, queryParticipants };