@wix/auto_sdk_online-programs_participants 1.0.10 → 1.0.12
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 +3 -93
- package/build/cjs/index.js +159 -1168
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +95 -652
- package/build/cjs/index.typings.js +11 -916
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +96 -487
- package/build/cjs/meta.js +11 -790
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +3 -93
- package/build/es/index.mjs +144 -1139
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +95 -652
- package/build/es/index.typings.mjs +2 -892
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +96 -487
- package/build/es/meta.mjs +2 -767
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +3 -104
- package/build/internal/cjs/index.js +159 -1168
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +95 -662
- package/build/internal/cjs/index.typings.js +11 -916
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +96 -487
- package/build/internal/cjs/meta.js +11 -790
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +3 -104
- package/build/internal/es/index.mjs +144 -1139
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +95 -662
- package/build/internal/es/index.typings.mjs +2 -892
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +96 -487
- package/build/internal/es/meta.mjs +2 -767
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,83 +1,7 @@
|
|
|
1
1
|
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import {
|
|
3
|
-
export { ActionEvent, ApplicationError, BaseEventMetadata,
|
|
2
|
+
import { BulkInviteToProgramOptions, BulkInviteToProgramResponse, BulkInviteAllToProgramOptions, BulkInviteAllToProgramResponse, BulkAddToProgramOptions, BulkAddToProgramResponse, BulkApproveParticipantOptions, BulkApproveParticipantResponse, BulkApproveAllParticipantOptions, BulkApproveAllParticipantResponse, ParticipantAddedEnvelope, ParticipantApprovedEnvelope, ParticipantInvitedEnvelope } from './index.typings.js';
|
|
3
|
+
export { 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';
|
|
4
4
|
|
|
5
|
-
declare function createParticipant$1(httpClient: HttpClient): CreateParticipantSignature;
|
|
6
|
-
interface CreateParticipantSignature {
|
|
7
|
-
/**
|
|
8
|
-
* @param - Participant to create
|
|
9
|
-
* @returns Created participant
|
|
10
|
-
*/
|
|
11
|
-
(participant: Participant): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state` | `joinedInfo.singlePaymentDetails.paymentOrderId` | `joinedInfo.paidPlanDetails.paidPlanId` | `joinedInfo.freeCouponDetails.freeCouponId` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 4> & {
|
|
12
|
-
__applicationErrorsType?: CreateParticipantApplicationErrors;
|
|
13
|
-
}>;
|
|
14
|
-
}
|
|
15
|
-
declare function bulkCreateParticipant$1(httpClient: HttpClient): BulkCreateParticipantSignature;
|
|
16
|
-
interface BulkCreateParticipantSignature {
|
|
17
|
-
/**
|
|
18
|
-
* Creates participants in bulk.
|
|
19
|
-
* @param - List of participants you want to create
|
|
20
|
-
*/
|
|
21
|
-
(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>>;
|
|
22
|
-
}
|
|
23
|
-
declare function bulkAddAllToProgram$1(httpClient: HttpClient): BulkAddAllToProgramSignature;
|
|
24
|
-
interface BulkAddAllToProgramSignature {
|
|
25
|
-
/**
|
|
26
|
-
* Bulk adds all site members to program, but not more then 1000.
|
|
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.
|
|
30
|
-
*/
|
|
31
|
-
(programId: string, options?: BulkAddAllToProgramOptions): Promise<NonNullablePaths<BulkAddAllToProgramResponse, `jobId`, 2>>;
|
|
32
|
-
}
|
|
33
|
-
declare function deleteParticipant$1(httpClient: HttpClient): DeleteParticipantSignature;
|
|
34
|
-
interface DeleteParticipantSignature {
|
|
35
|
-
/**
|
|
36
|
-
* Delete participant from program. Removes participant from member
|
|
37
|
-
* group. Leaves him in Social Group.
|
|
38
|
-
* @param - Participants to delete
|
|
39
|
-
*/
|
|
40
|
-
(participantId: string): Promise<void>;
|
|
41
|
-
}
|
|
42
|
-
declare function issueCertificate$1(httpClient: HttpClient): IssueCertificateSignature;
|
|
43
|
-
interface IssueCertificateSignature {
|
|
44
|
-
/**
|
|
45
|
-
* Issue certificate by site admin
|
|
46
|
-
* @param - Participant to get certificate
|
|
47
|
-
*/
|
|
48
|
-
(participantId: string): Promise<NonNullablePaths<IssueCertificateResponse, `participant.memberId` | `participant.programId` | `participant.progress.totalStepsCompleted` | `participant.progress.totalStepsAvailable` | `participant.progress.completionPercentage` | `participant.state` | `participant.joinedInfo.singlePaymentDetails.paymentOrderId` | `participant.joinedInfo.paidPlanDetails.paidPlanId` | `participant.joinedInfo.freeCouponDetails.freeCouponId` | `participant.joinedInfo.timeZone` | `participant.joinedInfo.startDate` | `participant.joinedInfo.joinPath` | `participant.member.contactId`, 5>>;
|
|
49
|
-
}
|
|
50
|
-
declare function getCompletionStats$1(httpClient: HttpClient): GetCompletionStatsSignature;
|
|
51
|
-
interface GetCompletionStatsSignature {
|
|
52
|
-
/**
|
|
53
|
-
* Get program's completion stats
|
|
54
|
-
* @param - program id to get stats for
|
|
55
|
-
*/
|
|
56
|
-
(programId: string): Promise<NonNullablePaths<GetCompletionStatsResponse, `completedAll` | `completionRate`, 2>>;
|
|
57
|
-
}
|
|
58
|
-
declare function getPremiumStats$1(httpClient: HttpClient): GetPremiumStatsSignature;
|
|
59
|
-
interface GetPremiumStatsSignature {
|
|
60
|
-
/**
|
|
61
|
-
* Get premium stats
|
|
62
|
-
*/
|
|
63
|
-
(): Promise<NonNullablePaths<GetPremiumStatsResponse, `hasPremium` | `activeParticipantsCount` | `activeParticipantsLimit`, 2>>;
|
|
64
|
-
}
|
|
65
|
-
declare function getParticipant$1(httpClient: HttpClient): GetParticipantSignature;
|
|
66
|
-
interface GetParticipantSignature {
|
|
67
|
-
/**
|
|
68
|
-
* Returns participant.
|
|
69
|
-
* @param - Participant id to fetch
|
|
70
|
-
* @returns existing participant
|
|
71
|
-
*/
|
|
72
|
-
(participantId: string): Promise<NonNullablePaths<Participant, `memberId` | `programId` | `progress.totalStepsCompleted` | `progress.totalStepsAvailable` | `progress.completionPercentage` | `state` | `joinedInfo.singlePaymentDetails.paymentOrderId` | `joinedInfo.paidPlanDetails.paidPlanId` | `joinedInfo.freeCouponDetails.freeCouponId` | `joinedInfo.timeZone` | `joinedInfo.startDate` | `joinedInfo.joinPath` | `member.contactId`, 4>>;
|
|
73
|
-
}
|
|
74
|
-
declare function getAccessStatus$1(httpClient: HttpClient): GetAccessStatusSignature;
|
|
75
|
-
interface GetAccessStatusSignature {
|
|
76
|
-
/**
|
|
77
|
-
* Get access status
|
|
78
|
-
*/
|
|
79
|
-
(): Promise<NonNullablePaths<GetAccessStatusResponse, `isBlocked`, 2>>;
|
|
80
|
-
}
|
|
81
5
|
declare function bulkInviteToProgram$1(httpClient: HttpClient): BulkInviteToProgramSignature;
|
|
82
6
|
interface BulkInviteToProgramSignature {
|
|
83
7
|
/**
|
|
@@ -128,25 +52,11 @@ declare const onParticipantAdded$1: EventDefinition<ParticipantAddedEnvelope, "w
|
|
|
128
52
|
declare const onParticipantApproved$1: EventDefinition<ParticipantApprovedEnvelope, "wix.online_programs.v3.participant_participant_approved">;
|
|
129
53
|
declare const onParticipantInvited$1: EventDefinition<ParticipantInvitedEnvelope, "wix.online_programs.v3.participant_participant_invited">;
|
|
130
54
|
|
|
131
|
-
declare function customQueryParticipants(httpClient: HttpClient): {
|
|
132
|
-
(): ParticipantsQueryBuilder;
|
|
133
|
-
(query: CursorQuery): ReturnType<typeof typedQueryParticipants>;
|
|
134
|
-
};
|
|
135
|
-
declare const createParticipant: MaybeContext<BuildRESTFunction<typeof createParticipant$1> & typeof createParticipant$1>;
|
|
136
|
-
declare const bulkCreateParticipant: MaybeContext<BuildRESTFunction<typeof bulkCreateParticipant$1> & typeof bulkCreateParticipant$1>;
|
|
137
|
-
declare const bulkAddAllToProgram: MaybeContext<BuildRESTFunction<typeof bulkAddAllToProgram$1> & typeof bulkAddAllToProgram$1>;
|
|
138
|
-
declare const deleteParticipant: MaybeContext<BuildRESTFunction<typeof deleteParticipant$1> & typeof deleteParticipant$1>;
|
|
139
|
-
declare const issueCertificate: MaybeContext<BuildRESTFunction<typeof issueCertificate$1> & typeof issueCertificate$1>;
|
|
140
|
-
declare const getCompletionStats: MaybeContext<BuildRESTFunction<typeof getCompletionStats$1> & typeof getCompletionStats$1>;
|
|
141
|
-
declare const getPremiumStats: MaybeContext<BuildRESTFunction<typeof getPremiumStats$1> & typeof getPremiumStats$1>;
|
|
142
|
-
declare const getParticipant: MaybeContext<BuildRESTFunction<typeof getParticipant$1> & typeof getParticipant$1>;
|
|
143
|
-
declare const getAccessStatus: MaybeContext<BuildRESTFunction<typeof getAccessStatus$1> & typeof getAccessStatus$1>;
|
|
144
55
|
declare const bulkInviteToProgram: MaybeContext<BuildRESTFunction<typeof bulkInviteToProgram$1> & typeof bulkInviteToProgram$1>;
|
|
145
56
|
declare const bulkInviteAllToProgram: MaybeContext<BuildRESTFunction<typeof bulkInviteAllToProgram$1> & typeof bulkInviteAllToProgram$1>;
|
|
146
57
|
declare const bulkAddToProgram: MaybeContext<BuildRESTFunction<typeof bulkAddToProgram$1> & typeof bulkAddToProgram$1>;
|
|
147
58
|
declare const bulkApproveParticipant: MaybeContext<BuildRESTFunction<typeof bulkApproveParticipant$1> & typeof bulkApproveParticipant$1>;
|
|
148
59
|
declare const bulkApproveAllParticipant: MaybeContext<BuildRESTFunction<typeof bulkApproveAllParticipant$1> & typeof bulkApproveAllParticipant$1>;
|
|
149
|
-
declare const queryParticipants: MaybeContext<BuildRESTFunction<typeof customQueryParticipants> & typeof customQueryParticipants>;
|
|
150
60
|
/** */
|
|
151
61
|
declare const onParticipantAdded: BuildEventDefinition<typeof onParticipantAdded$1> & typeof onParticipantAdded$1;
|
|
152
62
|
/** */
|
|
@@ -154,4 +64,4 @@ declare const onParticipantApproved: BuildEventDefinition<typeof onParticipantAp
|
|
|
154
64
|
/** */
|
|
155
65
|
declare const onParticipantInvited: BuildEventDefinition<typeof onParticipantInvited$1> & typeof onParticipantInvited$1;
|
|
156
66
|
|
|
157
|
-
export {
|
|
67
|
+
export { BulkAddToProgramOptions, BulkAddToProgramResponse, BulkApproveAllParticipantOptions, BulkApproveAllParticipantResponse, BulkApproveParticipantOptions, BulkApproveParticipantResponse, BulkInviteAllToProgramOptions, BulkInviteAllToProgramResponse, BulkInviteToProgramOptions, BulkInviteToProgramResponse, ParticipantAddedEnvelope, ParticipantApprovedEnvelope, ParticipantInvitedEnvelope, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram, onParticipantAdded, onParticipantApproved, onParticipantInvited };
|