@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.
- package/build/cjs/index.d.ts +181 -48
- package/build/cjs/index.js +1425 -188
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +12 -690
- package/build/cjs/index.typings.js +1074 -129
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +1302 -165
- package/build/cjs/meta.js +924 -110
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/online-programs-participants-v3-participant-participants.universal-CVjCdKBh.d.ts +2461 -0
- package/build/es/index.d.mts +181 -48
- package/build/es/index.mjs +1371 -162
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +12 -690
- package/build/es/index.typings.mjs +1036 -114
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +1302 -165
- package/build/es/meta.mjs +888 -95
- package/build/es/meta.mjs.map +1 -1
- package/build/es/online-programs-participants-v3-participant-participants.universal-CVjCdKBh.d.mts +2461 -0
- package/build/internal/cjs/index.d.ts +196 -48
- package/build/internal/cjs/index.typings.d.ts +12 -690
- package/build/internal/cjs/meta.d.ts +1473 -265
- package/build/internal/cjs/online-programs-participants-v3-participant-participants.universal-B1sw-MEh.d.ts +2504 -0
- package/build/internal/es/index.d.mts +196 -48
- package/build/internal/es/index.typings.d.mts +12 -690
- package/build/internal/es/meta.d.mts +1473 -265
- package/build/internal/es/online-programs-participants-v3-participant-participants.universal-B1sw-MEh.d.mts +2504 -0
- package/package.json +5 -5
- package/build/internal/cjs/index.js +0 -495
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.js +0 -390
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.js +0 -327
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/es/index.mjs +0 -461
- package/build/internal/es/index.mjs.map +0 -1
- package/build/internal/es/index.typings.mjs +0 -359
- package/build/internal/es/index.typings.mjs.map +0 -1
- package/build/internal/es/meta.mjs +0 -293
- package/build/internal/es/meta.mjs.map +0 -1
package/build/cjs/meta.d.ts
CHANGED
|
@@ -1,6 +1,12 @@
|
|
|
1
|
-
import {
|
|
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 GetParticipantRequest$1, aN as GetParticipantResponse$1, aO as QueryParticipantsRequest$1, aU as QueryParticipantsResponse$1, aX as GetAccessStatusRequest$1, j as GetAccessStatusResponse$1, aY as BulkUpdateParticipantTagsRequest$1, l as BulkUpdateParticipantTagsResponse$1, a_ as BulkUpdateParticipantTagsByFilterRequest$1, o as BulkUpdateParticipantTagsByFilterResponse$1, a$ as SearchParticipantsRequest$1, r as SearchParticipantsResponse$1, bP as ExportParticipantsStatsRequest$1, bQ as ExportParticipantsStatsResponse$1 } from './online-programs-participants-v3-participant-participants.universal-CVjCdKBh.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
|
+
/**
|
|
5
|
+
* Participant entity represents a site member who takes part in a specific Online Program.
|
|
6
|
+
* Participants have access to the program's content and progress through the program by completing its steps.
|
|
7
|
+
* A participant can join through a join application flow or be manually added by the program owner.
|
|
8
|
+
* A participant's status depends on their progress and the program's settings (e.g., start and end dates). Participation may also be temporarily suspended.
|
|
9
|
+
*/
|
|
4
10
|
interface Participant {
|
|
5
11
|
/**
|
|
6
12
|
* Participant ID.
|
|
@@ -8,206 +14,509 @@ interface Participant {
|
|
|
8
14
|
* @readonly
|
|
9
15
|
*/
|
|
10
16
|
id?: string | null;
|
|
11
|
-
/**
|
|
17
|
+
/**
|
|
18
|
+
* Participant revision (for optimistic concurrency control).
|
|
19
|
+
* @readonly
|
|
20
|
+
*/
|
|
12
21
|
revision?: string | null;
|
|
13
|
-
/**
|
|
22
|
+
/**
|
|
23
|
+
* Participant creation date.
|
|
24
|
+
* @readonly
|
|
25
|
+
*/
|
|
14
26
|
createdDate?: Date | null;
|
|
15
|
-
/**
|
|
27
|
+
/**
|
|
28
|
+
* Date the participant was last updated.
|
|
29
|
+
* @readonly
|
|
30
|
+
*/
|
|
16
31
|
updatedDate?: Date | null;
|
|
17
32
|
/**
|
|
18
|
-
* Member ID of participant on site
|
|
33
|
+
* Member ID of the participant on the site.
|
|
19
34
|
* @format GUID
|
|
20
35
|
* @readonly
|
|
21
36
|
*/
|
|
22
37
|
memberId?: string;
|
|
23
38
|
/**
|
|
24
|
-
*
|
|
39
|
+
* ID of the program the participant is enrolled in.
|
|
25
40
|
* @format GUID
|
|
26
41
|
* @readonly
|
|
27
42
|
*/
|
|
28
43
|
programId?: string;
|
|
29
44
|
/**
|
|
30
|
-
* Program completion progress
|
|
45
|
+
* Program completion progress. This field is conditional and must be explicitly requested via `fields` parameter.
|
|
31
46
|
* @readonly
|
|
32
47
|
*/
|
|
33
48
|
progress?: Progress;
|
|
34
|
-
/** state of participation in the program */
|
|
35
|
-
state?: StateWithLiterals;
|
|
36
49
|
/**
|
|
37
|
-
* Certificate
|
|
50
|
+
* Certificate info for participant
|
|
51
|
+
* @readonly
|
|
52
|
+
*/
|
|
53
|
+
certificateInfo?: CertificateInfo;
|
|
54
|
+
/**
|
|
55
|
+
* Site member info snapshot for the participant
|
|
38
56
|
* @readonly
|
|
39
57
|
*/
|
|
40
|
-
certificate?: Certificate;
|
|
41
|
-
joinedInfo?: JoinedInfo;
|
|
42
|
-
/** @readonly */
|
|
43
58
|
member?: Member;
|
|
44
|
-
/**
|
|
59
|
+
/**
|
|
60
|
+
* Last activity date of the participant in the program (can either be status change or step resolution).
|
|
61
|
+
* @readonly
|
|
62
|
+
*/
|
|
45
63
|
lastActivityDate?: Date | null;
|
|
64
|
+
/**
|
|
65
|
+
* Participant's enrollment status in the program.
|
|
66
|
+
* @readonly
|
|
67
|
+
*/
|
|
68
|
+
enrollmentStatus?: EnrollmentStatusWithLiterals;
|
|
69
|
+
/**
|
|
70
|
+
* Participant's progress status in the program.
|
|
71
|
+
* @readonly
|
|
72
|
+
*/
|
|
73
|
+
progressStatus?: ProgressStatusWithLiterals;
|
|
74
|
+
/** Additional information about the participant's enrollment and completion timeframe in the program. */
|
|
75
|
+
enrollmentInfo?: EnrollmentInfo;
|
|
76
|
+
/** Extended fields for participant (can be used for storing custom data). */
|
|
46
77
|
extendedFields?: ExtendedFields;
|
|
78
|
+
/** Tags for categorizing and organizing participants. */
|
|
79
|
+
tags?: Tags;
|
|
47
80
|
}
|
|
48
|
-
declare enum
|
|
49
|
-
|
|
50
|
-
/** Member joined to the program for free */
|
|
81
|
+
declare enum PricingType {
|
|
82
|
+
/** Member joined a program that is configured as free to join, with no payment required. */
|
|
51
83
|
FREE = "FREE",
|
|
52
|
-
/** Member was added to the program by site owner */
|
|
53
|
-
|
|
54
|
-
/** Member paid once to join the program */
|
|
84
|
+
/** Member was added to the program by site owner. */
|
|
85
|
+
ADDED_MANUALLY = "ADDED_MANUALLY",
|
|
86
|
+
/** Member paid once to join the program. */
|
|
55
87
|
SINGLE_PAYMENT = "SINGLE_PAYMENT",
|
|
56
|
-
/** Member
|
|
88
|
+
/** Member joined using a Pricing Plan. */
|
|
57
89
|
PAID_PLAN = "PAID_PLAN",
|
|
58
|
-
/** Member joined
|
|
90
|
+
/** Member joined a paid program using a coupon that provided 100% discount. */
|
|
59
91
|
FREE_COUPON = "FREE_COUPON"
|
|
60
92
|
}
|
|
61
93
|
/** @enumType */
|
|
62
|
-
type
|
|
94
|
+
type PricingTypeWithLiterals = PricingType | 'FREE' | 'ADDED_MANUALLY' | 'SINGLE_PAYMENT' | 'PAID_PLAN' | 'FREE_COUPON';
|
|
63
95
|
interface SinglePaymentDetails {
|
|
64
|
-
/**
|
|
96
|
+
/**
|
|
97
|
+
* ID of the cashier order which was used to pay for joining the program.
|
|
98
|
+
* @format GUID
|
|
99
|
+
* @immutable
|
|
100
|
+
*/
|
|
65
101
|
paymentOrderId?: string;
|
|
66
|
-
/**
|
|
102
|
+
/**
|
|
103
|
+
* ID of the offline transaction if the participant used an offline payment method (e.g., cash, check). Null if online payment was used.
|
|
104
|
+
* @format GUID
|
|
105
|
+
* @immutable
|
|
106
|
+
*/
|
|
67
107
|
offlineTransactionId?: string | null;
|
|
68
108
|
}
|
|
69
109
|
interface PaidPlanDetails {
|
|
70
|
-
/**
|
|
110
|
+
/**
|
|
111
|
+
* ID of the Paid Plan for which member has paid to join the program.
|
|
112
|
+
* @format GUID
|
|
113
|
+
* @immutable
|
|
114
|
+
*/
|
|
71
115
|
paidPlanId?: string;
|
|
72
116
|
}
|
|
73
117
|
interface FreeCouponDetails {
|
|
74
|
-
/**
|
|
118
|
+
/**
|
|
119
|
+
* ID of the coupon which was applied and gave 100% discount to join the program for free.
|
|
120
|
+
* @format GUID
|
|
121
|
+
* @immutable
|
|
122
|
+
*/
|
|
75
123
|
freeCouponId?: string;
|
|
76
124
|
}
|
|
77
125
|
interface Progress {
|
|
78
|
-
/** Number of program steps completed by member */
|
|
126
|
+
/** Number of program steps completed by member. */
|
|
79
127
|
totalStepsCompleted?: number;
|
|
80
|
-
/** Total number of program steps available to resolve */
|
|
128
|
+
/** Total number of program steps available to resolve. */
|
|
81
129
|
totalStepsAvailable?: number;
|
|
82
130
|
/**
|
|
83
|
-
*
|
|
131
|
+
* Participant's completion percentage. For completed participants, this is 100.0. Otherwise, it is calculated as
|
|
132
|
+
* (total_steps_completed / total_steps_available) * 100, capped at 100, and rounded to 1 decimal place.
|
|
84
133
|
* @max 100
|
|
85
134
|
*/
|
|
86
135
|
completionPercentage?: number;
|
|
87
136
|
}
|
|
88
|
-
|
|
89
|
-
/**
|
|
90
|
-
|
|
91
|
-
|
|
137
|
+
interface CertificateInfo {
|
|
138
|
+
/**
|
|
139
|
+
* Date when the certificate was issued (UTC).
|
|
140
|
+
* @readonly
|
|
141
|
+
*/
|
|
142
|
+
issueDate?: Date | null;
|
|
143
|
+
}
|
|
144
|
+
interface Member {
|
|
145
|
+
/**
|
|
146
|
+
* First name of the site member. Null if the member has not provided this information in their profile.
|
|
147
|
+
* @readonly
|
|
148
|
+
* @maxLength 1000
|
|
149
|
+
*/
|
|
150
|
+
firstName?: string | null;
|
|
151
|
+
/**
|
|
152
|
+
* Last name of the site member. Null if the member has not provided this information in their profile.
|
|
153
|
+
* @readonly
|
|
154
|
+
* @maxLength 1000
|
|
155
|
+
*/
|
|
156
|
+
lastName?: string | null;
|
|
157
|
+
/**
|
|
158
|
+
* Email of the site member. Null if the member has not provided this information in their profile.
|
|
159
|
+
* @readonly
|
|
160
|
+
* @format EMAIL
|
|
161
|
+
*/
|
|
162
|
+
email?: string | null;
|
|
163
|
+
/**
|
|
164
|
+
* Contact ID for accessing additional member information via the Contacts API. Use this to retrieve extended contact details like phone numbers, addresses, and custom fields. Null if the member has not provided this information in their profile.
|
|
165
|
+
* @format GUID
|
|
166
|
+
* @readonly
|
|
167
|
+
*/
|
|
168
|
+
contactId?: string | null;
|
|
169
|
+
/**
|
|
170
|
+
* Member nickname. Null if the member has not provided this information in their profile.
|
|
171
|
+
* @readonly
|
|
172
|
+
* @maxLength 1000
|
|
173
|
+
*/
|
|
174
|
+
nickname?: string | null;
|
|
175
|
+
/**
|
|
176
|
+
* Profile image URL of the site member.
|
|
177
|
+
* @readonly
|
|
178
|
+
* @format WEB_URL
|
|
179
|
+
*/
|
|
180
|
+
profileImageUrl?: string | null;
|
|
181
|
+
}
|
|
182
|
+
declare enum EnrollmentStatus {
|
|
183
|
+
/** Participant is actively enrolled in the program. */
|
|
92
184
|
JOINED = "JOINED",
|
|
93
|
-
/**
|
|
94
|
-
COMPLETED = "COMPLETED",
|
|
95
|
-
/** Participant failed to complete the program, and could join again */
|
|
96
|
-
FAILED = "FAILED",
|
|
97
|
-
/** Participant with ended pricing plan (PP), will be joined as renew PP */
|
|
185
|
+
/** Enrollment temporarily suspended due to payment issues. */
|
|
98
186
|
SUSPENDED = "SUSPENDED",
|
|
99
|
-
/**
|
|
187
|
+
/** Automatically removed via a Wix Automations workflow. */
|
|
100
188
|
AUTO_REMOVED = "AUTO_REMOVED",
|
|
101
|
-
/**
|
|
189
|
+
/** Removed from the program by the site owner. */
|
|
102
190
|
REMOVED = "REMOVED",
|
|
103
|
-
/** Participant left the program
|
|
191
|
+
/** Participant voluntarily left the program. */
|
|
104
192
|
LEFT = "LEFT"
|
|
105
193
|
}
|
|
106
194
|
/** @enumType */
|
|
107
|
-
type
|
|
108
|
-
|
|
109
|
-
/**
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
195
|
+
type EnrollmentStatusWithLiterals = EnrollmentStatus | 'JOINED' | 'SUSPENDED' | 'AUTO_REMOVED' | 'REMOVED' | 'LEFT';
|
|
196
|
+
declare enum ProgressStatus {
|
|
197
|
+
/** Enrolled but no steps completed yet. */
|
|
198
|
+
NOT_STARTED = "NOT_STARTED",
|
|
199
|
+
/** At least one step completed but program not yet finished. */
|
|
200
|
+
IN_PROGRESS = "IN_PROGRESS",
|
|
201
|
+
/** Participant successfully completed the program. */
|
|
202
|
+
COMPLETED = "COMPLETED",
|
|
203
|
+
/** Participant failed to complete the program within the deadline. */
|
|
204
|
+
FAILED = "FAILED",
|
|
205
|
+
/** Progress tracking is not applicable — participant left, was removed, or was auto-removed. */
|
|
206
|
+
NOT_APPLICABLE = "NOT_APPLICABLE"
|
|
114
207
|
}
|
|
115
|
-
|
|
208
|
+
/** @enumType */
|
|
209
|
+
type ProgressStatusWithLiterals = ProgressStatus | 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'NOT_APPLICABLE';
|
|
210
|
+
interface EnrollmentInfo extends EnrollmentInfoPricingTypeDetailsOneOf {
|
|
211
|
+
/** Details about a Single Payment enrollment. */
|
|
116
212
|
singlePaymentDetails?: SinglePaymentDetails;
|
|
213
|
+
/** Details about a Paid Plan enrollment. */
|
|
117
214
|
paidPlanDetails?: PaidPlanDetails;
|
|
215
|
+
/** Details about a Free Coupon enrollment. */
|
|
118
216
|
freeCouponDetails?: FreeCouponDetails;
|
|
119
217
|
/**
|
|
218
|
+
* Time zone of the site when the participant was enrolled in the program, in IANA timezone format (e.g., "America/New_York").
|
|
120
219
|
* @maxLength 50
|
|
121
220
|
* @readonly
|
|
122
221
|
*/
|
|
123
222
|
timeZone?: string;
|
|
124
223
|
/**
|
|
224
|
+
* Date when the participant starts the program. Equals the participant's `created_date` if the program has no configured start date; otherwise, equals the program's start date if the participant enrolled before it began.
|
|
125
225
|
* @format LOCAL_DATE
|
|
126
226
|
* @readonly
|
|
127
227
|
*/
|
|
128
228
|
startDate?: string;
|
|
129
|
-
|
|
229
|
+
/** Pricing type used for the participant's enrollment in the program. */
|
|
230
|
+
pricingType?: PricingTypeWithLiterals;
|
|
130
231
|
/**
|
|
232
|
+
* Date by which the participant must complete the program. Null if the program has no deadline. Set if the program has a fixed end date or a duration-based deadline calculated from the participant's start date.
|
|
131
233
|
* @format LOCAL_DATE
|
|
132
234
|
* @readonly
|
|
133
235
|
*/
|
|
134
|
-
|
|
236
|
+
deadline?: string | null;
|
|
135
237
|
}
|
|
136
238
|
/** @oneof */
|
|
137
|
-
interface
|
|
239
|
+
interface EnrollmentInfoPricingTypeDetailsOneOf {
|
|
240
|
+
/** Details about a Single Payment enrollment. */
|
|
138
241
|
singlePaymentDetails?: SinglePaymentDetails;
|
|
242
|
+
/** Details about a Paid Plan enrollment. */
|
|
139
243
|
paidPlanDetails?: PaidPlanDetails;
|
|
244
|
+
/** Details about a Free Coupon enrollment. */
|
|
140
245
|
freeCouponDetails?: FreeCouponDetails;
|
|
141
246
|
}
|
|
142
|
-
interface
|
|
247
|
+
interface ExtendedFields {
|
|
143
248
|
/**
|
|
144
|
-
*
|
|
145
|
-
*
|
|
249
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
250
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
251
|
+
*
|
|
252
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
253
|
+
*
|
|
254
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
146
255
|
*/
|
|
147
|
-
|
|
256
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* Common object for tags.
|
|
260
|
+
* Should be use as in this example:
|
|
261
|
+
* message Foo {
|
|
262
|
+
* option (.wix.api.decomposite_of) = "wix.commons.v2.tags.Foo";
|
|
263
|
+
* string id = 1;
|
|
264
|
+
* ...
|
|
265
|
+
* Tags tags = 5
|
|
266
|
+
* }
|
|
267
|
+
*
|
|
268
|
+
* example of taggable entity
|
|
269
|
+
* {
|
|
270
|
+
* id: "123"
|
|
271
|
+
* tags: {
|
|
272
|
+
* public_tags: {
|
|
273
|
+
* tag_ids:["11","22"]
|
|
274
|
+
* },
|
|
275
|
+
* private_tags: {
|
|
276
|
+
* tag_ids: ["33", "44"]
|
|
277
|
+
* }
|
|
278
|
+
* }
|
|
279
|
+
* }
|
|
280
|
+
*/
|
|
281
|
+
interface Tags {
|
|
282
|
+
/** Tags that require an additional permission in order to access them, typically restricted from site members and visitors. */
|
|
283
|
+
privateTags?: TagList;
|
|
284
|
+
/** Tags that are exposed to anyone with access to the entity, including site members and visitors. */
|
|
285
|
+
publicTags?: TagList;
|
|
286
|
+
}
|
|
287
|
+
interface TagList {
|
|
148
288
|
/**
|
|
149
|
-
*
|
|
150
|
-
* @
|
|
289
|
+
* List of tag IDs.
|
|
290
|
+
* @maxSize 100
|
|
291
|
+
* @maxLength 5
|
|
151
292
|
*/
|
|
152
|
-
|
|
293
|
+
tagIds?: string[];
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
|
|
297
|
+
* performs context manipulation with adding tenant, provided in message to callscope.
|
|
298
|
+
*/
|
|
299
|
+
interface ReindexMessage extends ReindexMessageActionOneOf {
|
|
300
|
+
upsert?: Upsert;
|
|
301
|
+
delete?: Delete;
|
|
302
|
+
entityFqdn?: string;
|
|
303
|
+
tenantId?: string;
|
|
304
|
+
eventTime?: Date | null;
|
|
305
|
+
entityEventSequence?: string | null;
|
|
306
|
+
schema?: Schema;
|
|
307
|
+
}
|
|
308
|
+
/** @oneof */
|
|
309
|
+
interface ReindexMessageActionOneOf {
|
|
310
|
+
upsert?: Upsert;
|
|
311
|
+
delete?: Delete;
|
|
312
|
+
}
|
|
313
|
+
interface Upsert {
|
|
314
|
+
entityId?: string;
|
|
315
|
+
entityAsJson?: string;
|
|
316
|
+
}
|
|
317
|
+
interface Delete {
|
|
318
|
+
entityId?: string;
|
|
319
|
+
}
|
|
320
|
+
interface Schema {
|
|
321
|
+
label?: string;
|
|
322
|
+
clusterName?: string;
|
|
323
|
+
}
|
|
324
|
+
/**
|
|
325
|
+
* Domain event emitted when a participant's tags are modified.
|
|
326
|
+
* Pre-publication rename from TagsModified; no consumers of the legacy FQN are known.
|
|
327
|
+
*/
|
|
328
|
+
interface ParticipantTagsModified {
|
|
329
|
+
/** The Participant with updated tags */
|
|
330
|
+
participant?: Participant;
|
|
331
|
+
/** Tags that were assigned */
|
|
332
|
+
assignedTags?: Tags;
|
|
333
|
+
/** Tags that were unassigned */
|
|
334
|
+
unassignedTags?: Tags;
|
|
335
|
+
}
|
|
336
|
+
/** Domain event emitted when a participant completes a program. */
|
|
337
|
+
interface ParticipantCompletedProgram {
|
|
153
338
|
/**
|
|
154
|
-
*
|
|
155
|
-
* @format
|
|
339
|
+
* ID of the participant who completed the program.
|
|
340
|
+
* @format GUID
|
|
156
341
|
*/
|
|
157
|
-
|
|
158
|
-
/** @format GUID */
|
|
159
|
-
contactId?: string;
|
|
342
|
+
participantId?: string;
|
|
160
343
|
/**
|
|
161
|
-
*
|
|
162
|
-
* @format
|
|
344
|
+
* ID of the program which was completed.
|
|
345
|
+
* @format GUID
|
|
163
346
|
*/
|
|
164
|
-
|
|
347
|
+
programId?: string;
|
|
348
|
+
/**
|
|
349
|
+
* Member ID of the participant who completed the program.
|
|
350
|
+
* @format GUID
|
|
351
|
+
*/
|
|
352
|
+
memberId?: string;
|
|
353
|
+
/** Snapshot of the participant after completing the program. */
|
|
354
|
+
participant?: Participant;
|
|
165
355
|
}
|
|
166
|
-
|
|
356
|
+
/** Domain event emitted when a participant misses a program deadline. */
|
|
357
|
+
interface ParticipantMissedProgramDeadline {
|
|
167
358
|
/**
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
171
|
-
* You can only access fields for which you have the appropriate permissions.
|
|
172
|
-
*
|
|
173
|
-
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
359
|
+
* ID of the participant who missed the deadline.
|
|
360
|
+
* @format GUID
|
|
174
361
|
*/
|
|
175
|
-
|
|
362
|
+
participantId?: string;
|
|
363
|
+
/**
|
|
364
|
+
* ID of the program for which the deadline was missed.
|
|
365
|
+
* @format GUID
|
|
366
|
+
*/
|
|
367
|
+
programId?: string;
|
|
368
|
+
/**
|
|
369
|
+
* Member ID of the participant who missed the deadline.
|
|
370
|
+
* @format GUID
|
|
371
|
+
*/
|
|
372
|
+
memberId?: string;
|
|
373
|
+
/** Snapshot of the participant after missing the deadline. */
|
|
374
|
+
participant?: Participant;
|
|
176
375
|
}
|
|
177
|
-
|
|
376
|
+
/** Domain event emitted when a participant's program duration ends. */
|
|
377
|
+
interface ParticipantProgramDurationEnded {
|
|
178
378
|
/**
|
|
179
|
-
*
|
|
379
|
+
* ID of the participant whose program duration ended.
|
|
380
|
+
* @format GUID
|
|
381
|
+
*/
|
|
382
|
+
participantId?: string;
|
|
383
|
+
/**
|
|
384
|
+
* ID of the program whose duration ended for the participant.
|
|
180
385
|
* @format GUID
|
|
181
386
|
*/
|
|
182
387
|
programId?: string;
|
|
183
388
|
/**
|
|
184
|
-
* Member ID of participant
|
|
389
|
+
* Member ID of the participant whose program duration ended.
|
|
185
390
|
* @format GUID
|
|
186
391
|
*/
|
|
187
392
|
memberId?: string;
|
|
393
|
+
/** Snapshot of the participant when the program duration ended. */
|
|
394
|
+
participant?: Participant;
|
|
188
395
|
}
|
|
189
|
-
|
|
396
|
+
/** Domain event emitted when a participant is removed from a program by an administrator. */
|
|
397
|
+
interface ParticipantRemoved {
|
|
190
398
|
/**
|
|
191
|
-
*
|
|
399
|
+
* ID of the participant who was removed.
|
|
192
400
|
* @format GUID
|
|
193
401
|
*/
|
|
194
|
-
|
|
402
|
+
participantId?: string;
|
|
403
|
+
/**
|
|
404
|
+
* ID of the program from which the participant was removed.
|
|
405
|
+
* @format GUID
|
|
406
|
+
*/
|
|
407
|
+
programId?: string;
|
|
195
408
|
/**
|
|
196
|
-
*
|
|
409
|
+
* Member ID of the participant who was removed.
|
|
197
410
|
* @format GUID
|
|
411
|
+
*/
|
|
412
|
+
memberId?: string;
|
|
413
|
+
/** Snapshot of the participant after being removed from the program. */
|
|
414
|
+
participant?: Participant;
|
|
415
|
+
}
|
|
416
|
+
/** Domain event emitted when a participant voluntarily leaves a program. */
|
|
417
|
+
interface ParticipantLeft {
|
|
418
|
+
/**
|
|
419
|
+
* ID of the participant who left the program.
|
|
420
|
+
* @format GUID
|
|
421
|
+
*/
|
|
422
|
+
participantId?: string;
|
|
423
|
+
/**
|
|
424
|
+
* ID of the program the participant left.
|
|
425
|
+
* @format GUID
|
|
426
|
+
*/
|
|
427
|
+
programId?: string;
|
|
428
|
+
/**
|
|
429
|
+
* Member ID of the participant who left.
|
|
430
|
+
* @format GUID
|
|
431
|
+
*/
|
|
432
|
+
memberId?: string;
|
|
433
|
+
/** Snapshot of the participant after leaving the program. */
|
|
434
|
+
participant?: Participant;
|
|
435
|
+
}
|
|
436
|
+
interface ParticipantExportsFinished {
|
|
437
|
+
/**
|
|
438
|
+
* program id from which stats were exported
|
|
439
|
+
* @format GUID
|
|
440
|
+
*/
|
|
441
|
+
programId?: string;
|
|
442
|
+
/**
|
|
443
|
+
* url to download report
|
|
444
|
+
* @format WEB_URL
|
|
445
|
+
*/
|
|
446
|
+
downloadUrl?: string;
|
|
447
|
+
/** days url will be downloadable */
|
|
448
|
+
downloadUrlTtlDays?: number;
|
|
449
|
+
}
|
|
450
|
+
interface CreateParticipantRequest {
|
|
451
|
+
/** Participant to create */
|
|
452
|
+
participant: Participant;
|
|
453
|
+
/**
|
|
454
|
+
* Array of conditional fields to include in the response.
|
|
455
|
+
* Use `RequestedFields.PROGRESS` to include the progress field, which requires calculating completion statistics across all program steps. Only request this field when you need current progress data, as it impacts performance.
|
|
456
|
+
* @maxSize 1
|
|
457
|
+
*/
|
|
458
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
459
|
+
}
|
|
460
|
+
/**
|
|
461
|
+
* Enum for specifying which conditional fields to include in responses.
|
|
462
|
+
* Use these values in the `fields` parameter to request expensive or conditional fields.
|
|
463
|
+
*/
|
|
464
|
+
declare enum RequestedFields {
|
|
465
|
+
/** Request the progress field to be calculated and included in the response. */
|
|
466
|
+
PROGRESS = "PROGRESS"
|
|
467
|
+
}
|
|
468
|
+
/** @enumType */
|
|
469
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'PROGRESS';
|
|
470
|
+
interface CreateParticipantResponse {
|
|
471
|
+
/** Created participant */
|
|
472
|
+
participant?: Participant;
|
|
473
|
+
}
|
|
474
|
+
interface UpdateParticipantRequest {
|
|
475
|
+
/** Participant to update. Must include the participant ID. */
|
|
476
|
+
participant: Participant;
|
|
477
|
+
/**
|
|
478
|
+
* Array of conditional fields to include in the response.
|
|
479
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
480
|
+
* @maxSize 1
|
|
481
|
+
*/
|
|
482
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
483
|
+
}
|
|
484
|
+
interface UpdateParticipantResponse {
|
|
485
|
+
/** Updated participant */
|
|
486
|
+
participant?: Participant;
|
|
487
|
+
}
|
|
488
|
+
interface BulkCreateParticipantsRequest {
|
|
489
|
+
/**
|
|
490
|
+
* List of participants to create.
|
|
198
491
|
* @minSize 1
|
|
199
492
|
* @maxSize 100
|
|
200
493
|
*/
|
|
201
|
-
|
|
202
|
-
/**
|
|
494
|
+
participants: Participant[];
|
|
495
|
+
/** Whether to return entities in response or not. */
|
|
203
496
|
returnEntity?: boolean;
|
|
497
|
+
/**
|
|
498
|
+
* Array of conditional fields to include in the response.
|
|
499
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
500
|
+
* @maxSize 1
|
|
501
|
+
*/
|
|
502
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
204
503
|
}
|
|
205
|
-
interface
|
|
206
|
-
/**
|
|
207
|
-
|
|
208
|
-
|
|
504
|
+
interface BulkCreateParticipantsResponse {
|
|
505
|
+
/**
|
|
506
|
+
* Results of the bulk create operation.
|
|
507
|
+
* @minSize 1
|
|
508
|
+
* @maxSize 100
|
|
509
|
+
*/
|
|
510
|
+
results?: BulkParticipantResult[];
|
|
511
|
+
/** Metadata about the bulk action. */
|
|
209
512
|
bulkActionMetadata?: BulkActionMetadata;
|
|
210
513
|
}
|
|
514
|
+
interface BulkParticipantResult {
|
|
515
|
+
/** Metadata for the item. */
|
|
516
|
+
itemMetadata?: ItemMetadata;
|
|
517
|
+
/** The participant entity. Empty if `return_entity` is `false`. */
|
|
518
|
+
item?: Participant;
|
|
519
|
+
}
|
|
211
520
|
interface ItemMetadata {
|
|
212
521
|
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
213
522
|
id?: string | null;
|
|
@@ -226,12 +535,6 @@ interface ApplicationError {
|
|
|
226
535
|
/** Data related to the error. */
|
|
227
536
|
data?: Record<string, any> | null;
|
|
228
537
|
}
|
|
229
|
-
interface BulkInviteToProgramResult {
|
|
230
|
-
/** Invited participant metadata. */
|
|
231
|
-
itemMetadata?: ItemMetadata;
|
|
232
|
-
/** Invited participant */
|
|
233
|
-
item?: Participant;
|
|
234
|
-
}
|
|
235
538
|
interface BulkActionMetadata {
|
|
236
539
|
/** Number of items that were successfully processed. */
|
|
237
540
|
totalSuccesses?: number;
|
|
@@ -240,122 +543,857 @@ interface BulkActionMetadata {
|
|
|
240
543
|
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
241
544
|
undetailedFailures?: number;
|
|
242
545
|
}
|
|
243
|
-
interface
|
|
546
|
+
interface BulkUpsertParticipantsMigrationRequest {
|
|
547
|
+
/**
|
|
548
|
+
* List of participants to create or update.
|
|
549
|
+
* @minSize 1
|
|
550
|
+
* @maxSize 100
|
|
551
|
+
*/
|
|
552
|
+
participants?: ParticipantMigration[];
|
|
553
|
+
}
|
|
554
|
+
interface ParticipantMigration {
|
|
555
|
+
/** Participant to create or update. */
|
|
556
|
+
participant?: Participant;
|
|
244
557
|
/**
|
|
245
|
-
*
|
|
558
|
+
* Resolved step IDs to restore on participant.
|
|
559
|
+
* @maxSize 5000
|
|
246
560
|
* @format GUID
|
|
247
561
|
*/
|
|
248
|
-
|
|
562
|
+
resolvedStepIds?: string[];
|
|
563
|
+
}
|
|
564
|
+
interface BulkUpsertParticipantsMigrationResponse {
|
|
249
565
|
/**
|
|
250
|
-
*
|
|
566
|
+
* Results of the bulk migration operation.
|
|
567
|
+
* @minSize 1
|
|
568
|
+
* @maxSize 100
|
|
569
|
+
*/
|
|
570
|
+
results?: BulkParticipantMigrationResult[];
|
|
571
|
+
/** Metadata about the bulk action. */
|
|
572
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
573
|
+
}
|
|
574
|
+
interface BulkParticipantMigrationResult {
|
|
575
|
+
/** Metadata for the item. */
|
|
576
|
+
itemMetadata?: ItemMetadata;
|
|
577
|
+
/** Action type of bulk action (INSERT OR UPDATE) for that endpoint. */
|
|
578
|
+
action?: BulkActionTypeWithLiterals;
|
|
579
|
+
}
|
|
580
|
+
declare enum BulkActionType {
|
|
581
|
+
/** default action type, should never be used */
|
|
582
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
583
|
+
/** Action type for inserting new items. */
|
|
584
|
+
INSERT = "INSERT",
|
|
585
|
+
/** Action type for updating existing items. */
|
|
586
|
+
UPDATE = "UPDATE"
|
|
587
|
+
}
|
|
588
|
+
/** @enumType */
|
|
589
|
+
type BulkActionTypeWithLiterals = BulkActionType | 'UNKNOWN_ACTION_TYPE' | 'INSERT' | 'UPDATE';
|
|
590
|
+
interface DeleteAllParticipantsMigrationRequest {
|
|
591
|
+
}
|
|
592
|
+
interface DeleteAllParticipantsMigrationResponse {
|
|
593
|
+
}
|
|
594
|
+
interface ReindexParticipantsSearchRequest {
|
|
595
|
+
/**
|
|
596
|
+
* @minSize 1
|
|
597
|
+
* @maxSize 1000
|
|
251
598
|
* @format GUID
|
|
252
599
|
*/
|
|
253
|
-
|
|
600
|
+
participantIds?: string[];
|
|
254
601
|
}
|
|
255
|
-
interface
|
|
602
|
+
interface ReindexParticipantsSearchResponse {
|
|
603
|
+
}
|
|
604
|
+
interface SynchronizeTimeCapsuleTasksRequest {
|
|
605
|
+
/**
|
|
606
|
+
* Metasite whose participant finish tasks should be synchronized.
|
|
607
|
+
* @format GUID
|
|
608
|
+
*/
|
|
609
|
+
metaSiteId?: string;
|
|
610
|
+
}
|
|
611
|
+
interface SynchronizeTimeCapsuleTasksResponse {
|
|
256
612
|
/**
|
|
257
|
-
*
|
|
613
|
+
* ID of the asynchronous job that will process the request. Pass this ID to Get Async Job to track the operation status.
|
|
614
|
+
* @format GUID
|
|
615
|
+
*/
|
|
616
|
+
jobId?: string;
|
|
617
|
+
}
|
|
618
|
+
interface BulkCreateParticipantsForAllMembersRequest {
|
|
619
|
+
/**
|
|
620
|
+
* ID of the program for which to create participants for all site members in bulk.
|
|
258
621
|
* @format GUID
|
|
259
622
|
*/
|
|
260
623
|
programId: string;
|
|
261
624
|
/**
|
|
262
|
-
*
|
|
625
|
+
* Site member IDs to exclude from bulk participant creation. Maximum 100 member IDs can be excluded.
|
|
263
626
|
* @format GUID
|
|
264
627
|
* @maxSize 100
|
|
265
628
|
*/
|
|
266
629
|
excludeMemberIds?: string[];
|
|
267
630
|
}
|
|
268
|
-
interface
|
|
269
|
-
/** Bulk action metadata. */
|
|
270
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
271
|
-
}
|
|
272
|
-
interface BulkAddToProgramRequest {
|
|
631
|
+
interface BulkCreateParticipantsForAllMembersResponse {
|
|
273
632
|
/**
|
|
274
|
-
*
|
|
633
|
+
* ID of the asynchronous job that will process the request. Pass this ID to Get Async Job to track the operation status.
|
|
275
634
|
* @format GUID
|
|
276
635
|
*/
|
|
277
|
-
|
|
636
|
+
jobId?: string;
|
|
637
|
+
}
|
|
638
|
+
interface DeleteParticipantRequest {
|
|
278
639
|
/**
|
|
279
|
-
*
|
|
640
|
+
* ID of the participant to delete.
|
|
280
641
|
* @format GUID
|
|
281
|
-
* @minSize 1
|
|
282
|
-
* @maxSize 1000
|
|
283
642
|
*/
|
|
284
|
-
|
|
285
|
-
/** Return added participants in the response or not. */
|
|
286
|
-
returnEntity?: boolean;
|
|
287
|
-
}
|
|
288
|
-
interface BulkAddToProgramResponse {
|
|
289
|
-
/** Participants created by bulk action */
|
|
290
|
-
results?: BulkAddToProgramResult[];
|
|
291
|
-
/** Bulk action metadata. */
|
|
292
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
643
|
+
participantId: string;
|
|
293
644
|
}
|
|
294
|
-
interface
|
|
295
|
-
/** Added participant metadata. */
|
|
296
|
-
itemMetadata?: ItemMetadata;
|
|
297
|
-
/** Added participant */
|
|
298
|
-
item?: Participant;
|
|
645
|
+
interface DeleteParticipantResponse {
|
|
299
646
|
}
|
|
300
|
-
interface
|
|
647
|
+
interface IssueCertificateRequest {
|
|
301
648
|
/**
|
|
302
|
-
*
|
|
649
|
+
* ID of the participant to issue the certificate to.
|
|
303
650
|
* @format GUID
|
|
304
|
-
* @maxSize 100
|
|
305
651
|
*/
|
|
306
|
-
|
|
652
|
+
participantId: string;
|
|
307
653
|
/**
|
|
308
|
-
*
|
|
654
|
+
* Array of conditional fields to include in the response.
|
|
655
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
656
|
+
* @maxSize 1
|
|
657
|
+
*/
|
|
658
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
659
|
+
}
|
|
660
|
+
interface IssueCertificateResponse {
|
|
661
|
+
/** Updated participant */
|
|
662
|
+
participant?: Participant;
|
|
663
|
+
}
|
|
664
|
+
interface GetCompletionStatsRequest {
|
|
665
|
+
/**
|
|
666
|
+
* ID of the program to retrieve completion statistics for.
|
|
309
667
|
* @format GUID
|
|
310
668
|
*/
|
|
311
669
|
programId?: string;
|
|
312
|
-
/** Return approved participants in the response or not */
|
|
313
|
-
returnEntity?: boolean;
|
|
314
670
|
}
|
|
315
|
-
interface
|
|
316
|
-
/**
|
|
317
|
-
|
|
318
|
-
/**
|
|
319
|
-
|
|
671
|
+
interface GetCompletionStatsResponse {
|
|
672
|
+
/** Number of participants that completed the program */
|
|
673
|
+
completedParticipantsCount?: number;
|
|
674
|
+
/** Percentage of participants that completed the program */
|
|
675
|
+
completionRate?: number;
|
|
320
676
|
}
|
|
321
|
-
interface
|
|
322
|
-
/** Approved participant metadata */
|
|
323
|
-
itemMetadata?: ItemMetadata;
|
|
324
|
-
/** Approved or existing participant */
|
|
325
|
-
item?: Participant;
|
|
677
|
+
interface GetPremiumStatsRequest {
|
|
326
678
|
}
|
|
327
|
-
interface
|
|
679
|
+
interface GetPremiumStatsResponse {
|
|
680
|
+
/** True if site has Online Programs premium feature */
|
|
681
|
+
premiumEnabled?: boolean;
|
|
682
|
+
/** Count of active participants on the site */
|
|
683
|
+
activeParticipantsCount?: number;
|
|
684
|
+
/** Limit of active participants on a site without premium */
|
|
685
|
+
activeParticipantsLimit?: number;
|
|
686
|
+
}
|
|
687
|
+
interface GetParticipantRequest {
|
|
328
688
|
/**
|
|
329
|
-
*
|
|
689
|
+
* ID of the participant to fetch.
|
|
330
690
|
* @format GUID
|
|
331
691
|
*/
|
|
332
|
-
|
|
692
|
+
participantId: string;
|
|
333
693
|
/**
|
|
334
|
-
*
|
|
335
|
-
*
|
|
694
|
+
* Array of conditional fields to include in the response.
|
|
695
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
696
|
+
* @maxSize 1
|
|
336
697
|
*/
|
|
337
|
-
|
|
698
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
338
699
|
}
|
|
339
|
-
interface
|
|
700
|
+
interface GetParticipantResponse {
|
|
701
|
+
/** The retrieved participant. */
|
|
702
|
+
participant?: Participant;
|
|
703
|
+
}
|
|
704
|
+
interface QueryParticipantsRequest {
|
|
705
|
+
/** Platformized query */
|
|
706
|
+
query?: QueryV2;
|
|
340
707
|
/**
|
|
341
|
-
*
|
|
342
|
-
*
|
|
708
|
+
* Array of conditional fields to include in the response.
|
|
709
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
710
|
+
* @maxSize 1
|
|
343
711
|
*/
|
|
344
|
-
|
|
712
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
713
|
+
}
|
|
714
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
715
|
+
/** Paging options to limit and offset the number of items. */
|
|
716
|
+
paging?: Paging;
|
|
717
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
718
|
+
cursorPaging?: CursorPaging;
|
|
719
|
+
/**
|
|
720
|
+
* Filter object.
|
|
721
|
+
*
|
|
722
|
+
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
723
|
+
*/
|
|
724
|
+
filter?: Record<string, any> | null;
|
|
725
|
+
/**
|
|
726
|
+
* Sort object.
|
|
727
|
+
*
|
|
728
|
+
* Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
729
|
+
* @maxSize 100
|
|
730
|
+
*/
|
|
731
|
+
sort?: Sorting[];
|
|
732
|
+
/**
|
|
733
|
+
* Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned.
|
|
734
|
+
* @maxSize 100
|
|
735
|
+
* @maxLength 1000
|
|
736
|
+
*/
|
|
737
|
+
fields?: string[];
|
|
738
|
+
/**
|
|
739
|
+
* Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned.
|
|
740
|
+
* @maxSize 100
|
|
741
|
+
* @maxLength 1000
|
|
742
|
+
*/
|
|
743
|
+
fieldsets?: string[];
|
|
744
|
+
}
|
|
745
|
+
/** @oneof */
|
|
746
|
+
interface QueryV2PagingMethodOneOf {
|
|
747
|
+
/** Paging options to limit and offset the number of items. */
|
|
748
|
+
paging?: Paging;
|
|
749
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
750
|
+
cursorPaging?: CursorPaging;
|
|
751
|
+
}
|
|
752
|
+
interface Sorting {
|
|
753
|
+
/**
|
|
754
|
+
* Name of the field to sort by.
|
|
755
|
+
* @maxLength 512
|
|
756
|
+
*/
|
|
757
|
+
fieldName?: string;
|
|
758
|
+
/** Sort order. */
|
|
759
|
+
order?: SortOrderWithLiterals;
|
|
760
|
+
}
|
|
761
|
+
declare enum SortOrder {
|
|
762
|
+
ASC = "ASC",
|
|
763
|
+
DESC = "DESC"
|
|
764
|
+
}
|
|
765
|
+
/** @enumType */
|
|
766
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
767
|
+
interface Paging {
|
|
768
|
+
/** Number of items to load. */
|
|
769
|
+
limit?: number | null;
|
|
770
|
+
/** Number of items to skip in the current sort order. */
|
|
771
|
+
offset?: number | null;
|
|
772
|
+
}
|
|
773
|
+
interface CursorPaging {
|
|
774
|
+
/**
|
|
775
|
+
* Maximum number of items to return in the results.
|
|
776
|
+
* @max 100
|
|
777
|
+
*/
|
|
778
|
+
limit?: number | null;
|
|
779
|
+
/**
|
|
780
|
+
* Pointer to the next or previous page in the list of results.
|
|
781
|
+
*
|
|
782
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
783
|
+
* Not relevant for the first request.
|
|
784
|
+
* @maxLength 16000
|
|
785
|
+
*/
|
|
786
|
+
cursor?: string | null;
|
|
787
|
+
}
|
|
788
|
+
interface QueryParticipantsResponse {
|
|
789
|
+
/** List of participants matching the query. */
|
|
790
|
+
participants?: Participant[];
|
|
791
|
+
/** Paging metadata. */
|
|
792
|
+
pagingMetadata?: PagingMetadataV2;
|
|
793
|
+
}
|
|
794
|
+
interface PagingMetadataV2 {
|
|
795
|
+
/** Number of items returned in the response. */
|
|
796
|
+
count?: number | null;
|
|
797
|
+
/** Offset that was requested. */
|
|
798
|
+
offset?: number | null;
|
|
799
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
800
|
+
total?: number | null;
|
|
801
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
802
|
+
tooManyToCount?: boolean | null;
|
|
803
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
804
|
+
cursors?: Cursors;
|
|
805
|
+
}
|
|
806
|
+
interface Cursors {
|
|
807
|
+
/**
|
|
808
|
+
* Cursor string pointing to the next page in the list of results.
|
|
809
|
+
* @maxLength 16000
|
|
810
|
+
*/
|
|
811
|
+
next?: string | null;
|
|
345
812
|
/**
|
|
346
|
-
*
|
|
813
|
+
* Cursor pointing to the previous page in the list of results.
|
|
814
|
+
* @maxLength 16000
|
|
815
|
+
*/
|
|
816
|
+
prev?: string | null;
|
|
817
|
+
}
|
|
818
|
+
interface GetAccessStatusRequest {
|
|
819
|
+
}
|
|
820
|
+
interface GetAccessStatusResponse {
|
|
821
|
+
/** True if participants cannot access online programs due to some limitations */
|
|
822
|
+
accessBlocked?: boolean;
|
|
823
|
+
}
|
|
824
|
+
interface BulkUpdateParticipantTagsRequest {
|
|
825
|
+
/**
|
|
826
|
+
* Participant IDs to update tags for (1-100 items)
|
|
827
|
+
* @minSize 1
|
|
828
|
+
* @maxSize 100
|
|
347
829
|
* @format GUID
|
|
830
|
+
*/
|
|
831
|
+
participantIds: string[];
|
|
832
|
+
/** Tags to assign to the Participants */
|
|
833
|
+
assignTags?: Tags;
|
|
834
|
+
/** Tags to unassign from the Participants */
|
|
835
|
+
unassignTags?: Tags;
|
|
836
|
+
}
|
|
837
|
+
interface BulkUpdateParticipantTagsResponse {
|
|
838
|
+
/**
|
|
839
|
+
* Results for each Participant
|
|
840
|
+
* @minSize 1
|
|
348
841
|
* @maxSize 100
|
|
349
842
|
*/
|
|
350
|
-
|
|
843
|
+
results?: BulkUpdateParticipantTagsResult[];
|
|
844
|
+
/** Metadata about the bulk operation */
|
|
845
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
846
|
+
}
|
|
847
|
+
interface BulkUpdateParticipantTagsResult {
|
|
848
|
+
/** Metadata for this specific item */
|
|
849
|
+
itemMetadata?: ItemMetadata;
|
|
850
|
+
}
|
|
851
|
+
interface BulkUpdateParticipantTagsByFilterRequest {
|
|
852
|
+
/** WQL filter to select Participants */
|
|
853
|
+
filter: Record<string, any> | null;
|
|
854
|
+
/** Tags to assign to matching Participants */
|
|
855
|
+
assignTags?: Tags;
|
|
856
|
+
/** Tags to unassign from matching Participants */
|
|
857
|
+
unassignTags?: Tags;
|
|
351
858
|
}
|
|
352
|
-
interface
|
|
859
|
+
interface BulkUpdateParticipantTagsByFilterResponse {
|
|
353
860
|
/**
|
|
354
|
-
* Job
|
|
861
|
+
* Job ID for tracking the async operation. Pass this ID to Get Async Job to track the operation status.
|
|
355
862
|
* @format GUID
|
|
356
863
|
*/
|
|
357
864
|
jobId?: string;
|
|
358
865
|
}
|
|
866
|
+
interface SearchParticipantsRequest {
|
|
867
|
+
/** Query to search participants. */
|
|
868
|
+
search?: CursorSearch;
|
|
869
|
+
/**
|
|
870
|
+
* Array of conditional fields to include in the response.
|
|
871
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
872
|
+
* @maxSize 1
|
|
873
|
+
*/
|
|
874
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
875
|
+
}
|
|
876
|
+
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
877
|
+
/**
|
|
878
|
+
* Cursor paging options.
|
|
879
|
+
*
|
|
880
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
881
|
+
*/
|
|
882
|
+
cursorPaging?: CursorPaging;
|
|
883
|
+
/**
|
|
884
|
+
* Filter object.
|
|
885
|
+
*
|
|
886
|
+
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
887
|
+
*/
|
|
888
|
+
filter?: Record<string, any> | null;
|
|
889
|
+
/**
|
|
890
|
+
* List of sort objects.
|
|
891
|
+
*
|
|
892
|
+
* Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
893
|
+
* @maxSize 10
|
|
894
|
+
*/
|
|
895
|
+
sort?: Sorting[];
|
|
896
|
+
/**
|
|
897
|
+
* Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories.
|
|
898
|
+
* @maxSize 10
|
|
899
|
+
*/
|
|
900
|
+
aggregations?: Aggregation[];
|
|
901
|
+
/** Free text to match in searchable fields. */
|
|
902
|
+
search?: SearchDetails;
|
|
903
|
+
/**
|
|
904
|
+
* Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format.
|
|
905
|
+
* Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z".
|
|
906
|
+
* @maxLength 50
|
|
907
|
+
*/
|
|
908
|
+
timeZone?: string | null;
|
|
909
|
+
}
|
|
910
|
+
/** @oneof */
|
|
911
|
+
interface CursorSearchPagingMethodOneOf {
|
|
912
|
+
/**
|
|
913
|
+
* Cursor paging options.
|
|
914
|
+
*
|
|
915
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
916
|
+
*/
|
|
917
|
+
cursorPaging?: CursorPaging;
|
|
918
|
+
}
|
|
919
|
+
interface Aggregation extends AggregationKindOneOf {
|
|
920
|
+
/** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
|
|
921
|
+
value?: ValueAggregation;
|
|
922
|
+
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
923
|
+
range?: RangeAggregation;
|
|
924
|
+
/** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
925
|
+
scalar?: ScalarAggregation;
|
|
926
|
+
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
927
|
+
dateHistogram?: DateHistogramAggregation;
|
|
928
|
+
/** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
|
|
929
|
+
nested?: NestedAggregation;
|
|
930
|
+
/**
|
|
931
|
+
* Aggregation name, returned in `aggregations.results.name`.
|
|
932
|
+
* @maxLength 100
|
|
933
|
+
*/
|
|
934
|
+
name?: string | null;
|
|
935
|
+
/** Type of aggregation to perform. Must align with the corresponding aggregation field. */
|
|
936
|
+
type?: AggregationTypeWithLiterals;
|
|
937
|
+
/**
|
|
938
|
+
* Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
939
|
+
* @maxLength 200
|
|
940
|
+
*/
|
|
941
|
+
fieldPath?: string;
|
|
942
|
+
/**
|
|
943
|
+
* Deprecated. Use `nested` instead.
|
|
944
|
+
* @deprecated Deprecated. Use `nested` instead.
|
|
945
|
+
* @replacedBy kind.nested
|
|
946
|
+
* @targetRemovalDate 2024-03-30
|
|
947
|
+
*/
|
|
948
|
+
groupBy?: GroupByAggregation;
|
|
949
|
+
}
|
|
950
|
+
/** @oneof */
|
|
951
|
+
interface AggregationKindOneOf {
|
|
952
|
+
/** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
|
|
953
|
+
value?: ValueAggregation;
|
|
954
|
+
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
|
|
955
|
+
range?: RangeAggregation;
|
|
956
|
+
/** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
957
|
+
scalar?: ScalarAggregation;
|
|
958
|
+
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
|
|
959
|
+
dateHistogram?: DateHistogramAggregation;
|
|
960
|
+
/** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
|
|
961
|
+
nested?: NestedAggregation;
|
|
962
|
+
}
|
|
963
|
+
interface RangeBucket {
|
|
964
|
+
/** Inclusive lower bound of the range. Required if `to` is not provided. */
|
|
965
|
+
from?: number | null;
|
|
966
|
+
/** Exclusive upper bound of the range. Required if `from` is not provided. */
|
|
967
|
+
to?: number | null;
|
|
968
|
+
}
|
|
969
|
+
declare enum SortType {
|
|
970
|
+
/** Number of matches in the results. */
|
|
971
|
+
COUNT = "COUNT",
|
|
972
|
+
/** Alphabetically by the field value. */
|
|
973
|
+
VALUE = "VALUE"
|
|
974
|
+
}
|
|
975
|
+
/** @enumType */
|
|
976
|
+
type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
977
|
+
declare enum SortDirection {
|
|
978
|
+
/** Descending order. */
|
|
979
|
+
DESC = "DESC",
|
|
980
|
+
/** Ascending order. */
|
|
981
|
+
ASC = "ASC"
|
|
982
|
+
}
|
|
983
|
+
/** @enumType */
|
|
984
|
+
type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
985
|
+
declare enum MissingValues {
|
|
986
|
+
/** Exclude missing values from the aggregation results. */
|
|
987
|
+
EXCLUDE = "EXCLUDE",
|
|
988
|
+
/** Include missing values in the aggregation results. */
|
|
989
|
+
INCLUDE = "INCLUDE"
|
|
990
|
+
}
|
|
991
|
+
/** @enumType */
|
|
992
|
+
type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
993
|
+
interface IncludeMissingValuesOptions {
|
|
994
|
+
/**
|
|
995
|
+
* Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans.
|
|
996
|
+
* @maxLength 20
|
|
997
|
+
*/
|
|
998
|
+
addToBucket?: string;
|
|
999
|
+
}
|
|
1000
|
+
declare enum ScalarType {
|
|
1001
|
+
/** Total number of distinct values. */
|
|
1002
|
+
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
1003
|
+
/** Minimum value. */
|
|
1004
|
+
MIN = "MIN",
|
|
1005
|
+
/** Maximum value. */
|
|
1006
|
+
MAX = "MAX"
|
|
1007
|
+
}
|
|
1008
|
+
/** @enumType */
|
|
1009
|
+
type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
1010
|
+
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
1011
|
+
/** Options for including missing values in results. */
|
|
1012
|
+
includeOptions?: IncludeMissingValuesOptions;
|
|
1013
|
+
/** Sort type. */
|
|
1014
|
+
sortType?: SortTypeWithLiterals;
|
|
1015
|
+
/** Sort direction. */
|
|
1016
|
+
sortDirection?: SortDirectionWithLiterals;
|
|
1017
|
+
/**
|
|
1018
|
+
* Number of aggregation results to return.
|
|
1019
|
+
* Min: `1`
|
|
1020
|
+
* Max: `250`
|
|
1021
|
+
* Default: `10`
|
|
1022
|
+
*/
|
|
1023
|
+
limit?: number | null;
|
|
1024
|
+
/**
|
|
1025
|
+
* Whether to include or exclude missing values in the aggregation results.
|
|
1026
|
+
* Default: `EXCLUDE`.
|
|
1027
|
+
*/
|
|
1028
|
+
missingValues?: MissingValuesWithLiterals;
|
|
1029
|
+
}
|
|
1030
|
+
/** @oneof */
|
|
1031
|
+
interface ValueAggregationOptionsOneOf {
|
|
1032
|
+
/** Options for including missing values in results. */
|
|
1033
|
+
includeOptions?: IncludeMissingValuesOptions;
|
|
1034
|
+
}
|
|
1035
|
+
declare enum NestedAggregationType {
|
|
1036
|
+
/** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
|
|
1037
|
+
VALUE = "VALUE",
|
|
1038
|
+
/** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
|
|
1039
|
+
RANGE = "RANGE",
|
|
1040
|
+
/** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
1041
|
+
SCALAR = "SCALAR",
|
|
1042
|
+
/** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
|
|
1043
|
+
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
1044
|
+
}
|
|
1045
|
+
/** @enumType */
|
|
1046
|
+
type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
1047
|
+
interface RangeAggregation {
|
|
1048
|
+
/**
|
|
1049
|
+
* List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds.
|
|
1050
|
+
* @maxSize 50
|
|
1051
|
+
*/
|
|
1052
|
+
buckets?: RangeBucket[];
|
|
1053
|
+
}
|
|
1054
|
+
interface ScalarAggregation {
|
|
1055
|
+
/** Operator type for the scalar aggregation. */
|
|
1056
|
+
type?: ScalarTypeWithLiterals;
|
|
1057
|
+
}
|
|
1058
|
+
interface DateHistogramAggregation {
|
|
1059
|
+
/** Interval for date histogram aggregation. */
|
|
1060
|
+
interval?: IntervalWithLiterals;
|
|
1061
|
+
}
|
|
1062
|
+
declare enum Interval {
|
|
1063
|
+
YEAR = "YEAR",
|
|
1064
|
+
MONTH = "MONTH",
|
|
1065
|
+
WEEK = "WEEK",
|
|
1066
|
+
DAY = "DAY",
|
|
1067
|
+
HOUR = "HOUR",
|
|
1068
|
+
MINUTE = "MINUTE",
|
|
1069
|
+
SECOND = "SECOND"
|
|
1070
|
+
}
|
|
1071
|
+
/** @enumType */
|
|
1072
|
+
type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
1073
|
+
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
1074
|
+
/** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
|
|
1075
|
+
value?: ValueAggregation;
|
|
1076
|
+
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
|
|
1077
|
+
range?: RangeAggregation;
|
|
1078
|
+
/** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
1079
|
+
scalar?: ScalarAggregation;
|
|
1080
|
+
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
|
|
1081
|
+
dateHistogram?: DateHistogramAggregation;
|
|
1082
|
+
/**
|
|
1083
|
+
* Unique, caller-defined aggregation name, returned in `aggregations.results`.
|
|
1084
|
+
* @maxLength 100
|
|
1085
|
+
*/
|
|
1086
|
+
name?: string | null;
|
|
1087
|
+
/** Type of aggregation to perform. The matching aggregation field must be passed. */
|
|
1088
|
+
type?: NestedAggregationTypeWithLiterals;
|
|
1089
|
+
/**
|
|
1090
|
+
* Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
1091
|
+
* @maxLength 200
|
|
1092
|
+
*/
|
|
1093
|
+
fieldPath?: string;
|
|
1094
|
+
}
|
|
1095
|
+
/** @oneof */
|
|
1096
|
+
interface NestedAggregationItemKindOneOf {
|
|
1097
|
+
/** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
|
|
1098
|
+
value?: ValueAggregation;
|
|
1099
|
+
/** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
|
|
1100
|
+
range?: RangeAggregation;
|
|
1101
|
+
/** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
1102
|
+
scalar?: ScalarAggregation;
|
|
1103
|
+
/** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
|
|
1104
|
+
dateHistogram?: DateHistogramAggregation;
|
|
1105
|
+
}
|
|
1106
|
+
declare enum AggregationType {
|
|
1107
|
+
/** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
|
|
1108
|
+
VALUE = "VALUE",
|
|
1109
|
+
/** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
|
|
1110
|
+
RANGE = "RANGE",
|
|
1111
|
+
/** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
1112
|
+
SCALAR = "SCALAR",
|
|
1113
|
+
/** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
|
|
1114
|
+
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
1115
|
+
/** Flattened list of aggregations, where each aggregation is nested within previous one. */
|
|
1116
|
+
NESTED = "NESTED"
|
|
1117
|
+
}
|
|
1118
|
+
/** @enumType */
|
|
1119
|
+
type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
1120
|
+
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
|
|
1121
|
+
interface NestedAggregation {
|
|
1122
|
+
/**
|
|
1123
|
+
* Flattened list of aggregations, where each aggregation is nested within previous one.
|
|
1124
|
+
* @minSize 2
|
|
1125
|
+
* @maxSize 3
|
|
1126
|
+
*/
|
|
1127
|
+
nestedAggregations?: NestedAggregationItem[];
|
|
1128
|
+
}
|
|
1129
|
+
interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
1130
|
+
/** Value aggregation configuration. */
|
|
1131
|
+
value?: ValueAggregation;
|
|
1132
|
+
/**
|
|
1133
|
+
* Unique, caller-defined aggregation name, returned in `aggregations.results`.
|
|
1134
|
+
* @maxLength 100
|
|
1135
|
+
*/
|
|
1136
|
+
name?: string | null;
|
|
1137
|
+
/**
|
|
1138
|
+
* Field to aggregate by.
|
|
1139
|
+
* @maxLength 200
|
|
1140
|
+
*/
|
|
1141
|
+
fieldPath?: string;
|
|
1142
|
+
}
|
|
1143
|
+
/** @oneof */
|
|
1144
|
+
interface GroupByAggregationKindOneOf {
|
|
1145
|
+
/** Value aggregation configuration. */
|
|
1146
|
+
value?: ValueAggregation;
|
|
1147
|
+
}
|
|
1148
|
+
interface SearchDetails {
|
|
1149
|
+
/** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
|
|
1150
|
+
mode?: ModeWithLiterals;
|
|
1151
|
+
/**
|
|
1152
|
+
* Search term or expression.
|
|
1153
|
+
* @maxLength 100
|
|
1154
|
+
*/
|
|
1155
|
+
expression?: string | null;
|
|
1156
|
+
/**
|
|
1157
|
+
* Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
1158
|
+
* @maxLength 200
|
|
1159
|
+
* @maxSize 20
|
|
1160
|
+
*/
|
|
1161
|
+
fields?: string[];
|
|
1162
|
+
/** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */
|
|
1163
|
+
fuzzy?: boolean;
|
|
1164
|
+
}
|
|
1165
|
+
declare enum Mode {
|
|
1166
|
+
/** At least one of the search terms must be present. */
|
|
1167
|
+
OR = "OR",
|
|
1168
|
+
/** All search terms must be present. */
|
|
1169
|
+
AND = "AND"
|
|
1170
|
+
}
|
|
1171
|
+
/** @enumType */
|
|
1172
|
+
type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
1173
|
+
interface SearchParticipantsResponse {
|
|
1174
|
+
/** Participants matching the search criteria. */
|
|
1175
|
+
participants?: Participant[];
|
|
1176
|
+
/** Paging metadata. */
|
|
1177
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
1178
|
+
/** Aggregation data in case aggregations were requested. */
|
|
1179
|
+
aggregationData?: AggregationData;
|
|
1180
|
+
}
|
|
1181
|
+
interface CursorPagingMetadata {
|
|
1182
|
+
/** Number of items returned in current page. */
|
|
1183
|
+
count?: number | null;
|
|
1184
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
1185
|
+
cursors?: Cursors;
|
|
1186
|
+
/**
|
|
1187
|
+
* Whether there are more pages to retrieve following the current page.
|
|
1188
|
+
*
|
|
1189
|
+
* + `true`: Another page of results can be retrieved.
|
|
1190
|
+
* + `false`: This is the last page.
|
|
1191
|
+
*/
|
|
1192
|
+
hasNext?: boolean | null;
|
|
1193
|
+
}
|
|
1194
|
+
interface AggregationData {
|
|
1195
|
+
/**
|
|
1196
|
+
* key = aggregation name (as derived from search request).
|
|
1197
|
+
* @maxSize 10000
|
|
1198
|
+
*/
|
|
1199
|
+
results?: AggregationResults[];
|
|
1200
|
+
}
|
|
1201
|
+
interface ValueAggregationResult {
|
|
1202
|
+
/**
|
|
1203
|
+
* Value of the field.
|
|
1204
|
+
* @maxLength 100
|
|
1205
|
+
*/
|
|
1206
|
+
value?: string;
|
|
1207
|
+
/** Count of entities with this value. */
|
|
1208
|
+
count?: number;
|
|
1209
|
+
}
|
|
1210
|
+
interface RangeAggregationResult {
|
|
1211
|
+
/** Inclusive lower bound of the range. */
|
|
1212
|
+
from?: number | null;
|
|
1213
|
+
/** Exclusive upper bound of the range. */
|
|
1214
|
+
to?: number | null;
|
|
1215
|
+
/** Count of entities in this range. */
|
|
1216
|
+
count?: number;
|
|
1217
|
+
}
|
|
1218
|
+
interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
1219
|
+
/** Value aggregation results. */
|
|
1220
|
+
values?: ValueResults;
|
|
1221
|
+
/** Range aggregation results. */
|
|
1222
|
+
ranges?: RangeResults;
|
|
1223
|
+
/** Scalar aggregation results. */
|
|
1224
|
+
scalar?: AggregationResultsScalarResult;
|
|
1225
|
+
/**
|
|
1226
|
+
* User-defined name of aggregation, matches the one provided in request.
|
|
1227
|
+
* @maxLength 100
|
|
1228
|
+
*/
|
|
1229
|
+
name?: string;
|
|
1230
|
+
/** Type of aggregation that matches result. */
|
|
1231
|
+
type?: AggregationTypeWithLiterals;
|
|
1232
|
+
/**
|
|
1233
|
+
* Field to aggregate by, matches the one provided in request.
|
|
1234
|
+
* @maxLength 200
|
|
1235
|
+
*/
|
|
1236
|
+
fieldPath?: string;
|
|
1237
|
+
}
|
|
1238
|
+
/** @oneof */
|
|
1239
|
+
interface NestedAggregationResultsResultOneOf {
|
|
1240
|
+
/** Value aggregation results. */
|
|
1241
|
+
values?: ValueResults;
|
|
1242
|
+
/** Range aggregation results. */
|
|
1243
|
+
ranges?: RangeResults;
|
|
1244
|
+
/** Scalar aggregation results. */
|
|
1245
|
+
scalar?: AggregationResultsScalarResult;
|
|
1246
|
+
}
|
|
1247
|
+
interface ValueResults {
|
|
1248
|
+
/**
|
|
1249
|
+
* List of value aggregations.
|
|
1250
|
+
* @maxSize 250
|
|
1251
|
+
*/
|
|
1252
|
+
results?: ValueAggregationResult[];
|
|
1253
|
+
}
|
|
1254
|
+
interface RangeResults {
|
|
1255
|
+
/**
|
|
1256
|
+
* List of ranges returned in same order as requested.
|
|
1257
|
+
* @maxSize 50
|
|
1258
|
+
*/
|
|
1259
|
+
results?: RangeAggregationResult[];
|
|
1260
|
+
}
|
|
1261
|
+
interface AggregationResultsScalarResult {
|
|
1262
|
+
/** Type of scalar aggregation. */
|
|
1263
|
+
type?: ScalarTypeWithLiterals;
|
|
1264
|
+
/** Value of the scalar aggregation. */
|
|
1265
|
+
value?: number;
|
|
1266
|
+
}
|
|
1267
|
+
interface NestedValueAggregationResult {
|
|
1268
|
+
/**
|
|
1269
|
+
* Value of the field.
|
|
1270
|
+
* @maxLength 1000
|
|
1271
|
+
*/
|
|
1272
|
+
value?: string;
|
|
1273
|
+
/** Nested aggregations. */
|
|
1274
|
+
nestedResults?: NestedAggregationResults;
|
|
1275
|
+
}
|
|
1276
|
+
interface ValueResult {
|
|
1277
|
+
/**
|
|
1278
|
+
* Value of the field.
|
|
1279
|
+
* @maxLength 1000
|
|
1280
|
+
*/
|
|
1281
|
+
value?: string;
|
|
1282
|
+
/** Count of entities with this value. */
|
|
1283
|
+
count?: number | null;
|
|
1284
|
+
}
|
|
1285
|
+
interface RangeResult {
|
|
1286
|
+
/** Inclusive lower bound of the range. */
|
|
1287
|
+
from?: number | null;
|
|
1288
|
+
/** Exclusive upper bound of the range. */
|
|
1289
|
+
to?: number | null;
|
|
1290
|
+
/** Count of entities in this range. */
|
|
1291
|
+
count?: number | null;
|
|
1292
|
+
}
|
|
1293
|
+
interface ScalarResult {
|
|
1294
|
+
/** Value of the scalar aggregation. */
|
|
1295
|
+
value?: number;
|
|
1296
|
+
}
|
|
1297
|
+
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
1298
|
+
/** Value aggregation result. */
|
|
1299
|
+
value?: ValueResult;
|
|
1300
|
+
/** Range aggregation result. */
|
|
1301
|
+
range?: RangeResult;
|
|
1302
|
+
/** Scalar aggregation result. */
|
|
1303
|
+
scalar?: ScalarResult;
|
|
1304
|
+
/** Date histogram aggregation result. */
|
|
1305
|
+
dateHistogram?: ValueResult;
|
|
1306
|
+
}
|
|
1307
|
+
/** @oneof */
|
|
1308
|
+
interface NestedResultValueResultOneOf {
|
|
1309
|
+
/** Value aggregation result. */
|
|
1310
|
+
value?: ValueResult;
|
|
1311
|
+
/** Range aggregation result. */
|
|
1312
|
+
range?: RangeResult;
|
|
1313
|
+
/** Scalar aggregation result. */
|
|
1314
|
+
scalar?: ScalarResult;
|
|
1315
|
+
/** Date histogram aggregation result. */
|
|
1316
|
+
dateHistogram?: ValueResult;
|
|
1317
|
+
}
|
|
1318
|
+
interface Results {
|
|
1319
|
+
/** List of nested aggregations. */
|
|
1320
|
+
results?: Record<string, NestedResultValue>;
|
|
1321
|
+
}
|
|
1322
|
+
interface DateHistogramResult {
|
|
1323
|
+
/**
|
|
1324
|
+
* Date in ISO 8601 format.
|
|
1325
|
+
* @maxLength 100
|
|
1326
|
+
*/
|
|
1327
|
+
value?: string;
|
|
1328
|
+
/** Count of documents in the bucket. */
|
|
1329
|
+
count?: number;
|
|
1330
|
+
}
|
|
1331
|
+
interface GroupByValueResults {
|
|
1332
|
+
/**
|
|
1333
|
+
* List of value aggregations.
|
|
1334
|
+
* @maxSize 1000
|
|
1335
|
+
*/
|
|
1336
|
+
results?: NestedValueAggregationResult[];
|
|
1337
|
+
}
|
|
1338
|
+
interface DateHistogramResults {
|
|
1339
|
+
/**
|
|
1340
|
+
* List of date histogram aggregations.
|
|
1341
|
+
* @maxSize 200
|
|
1342
|
+
*/
|
|
1343
|
+
results?: DateHistogramResult[];
|
|
1344
|
+
}
|
|
1345
|
+
/**
|
|
1346
|
+
* Results of `NESTED` aggregation type in a flattened form.
|
|
1347
|
+
* Aggregations in resulting array are keyed by requested aggregation `name`.
|
|
1348
|
+
*/
|
|
1349
|
+
interface NestedResults {
|
|
1350
|
+
/**
|
|
1351
|
+
* List of nested aggregations.
|
|
1352
|
+
* @maxSize 1000
|
|
1353
|
+
*/
|
|
1354
|
+
results?: Results[];
|
|
1355
|
+
}
|
|
1356
|
+
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
1357
|
+
/** Value aggregation results. */
|
|
1358
|
+
values?: ValueResults;
|
|
1359
|
+
/** Range aggregation results. */
|
|
1360
|
+
ranges?: RangeResults;
|
|
1361
|
+
/** Scalar aggregation results. */
|
|
1362
|
+
scalar?: AggregationResultsScalarResult;
|
|
1363
|
+
/** Group by value aggregation results. */
|
|
1364
|
+
groupedByValue?: GroupByValueResults;
|
|
1365
|
+
/** Date histogram aggregation results. */
|
|
1366
|
+
dateHistogram?: DateHistogramResults;
|
|
1367
|
+
/** Nested aggregation results. */
|
|
1368
|
+
nested?: NestedResults;
|
|
1369
|
+
/**
|
|
1370
|
+
* User-defined name of aggregation as derived from search request.
|
|
1371
|
+
* @maxLength 100
|
|
1372
|
+
*/
|
|
1373
|
+
name?: string;
|
|
1374
|
+
/** Type of aggregation that must match provided kind as derived from search request. */
|
|
1375
|
+
type?: AggregationTypeWithLiterals;
|
|
1376
|
+
/**
|
|
1377
|
+
* Field to aggregate by as derived from search request.
|
|
1378
|
+
* @maxLength 200
|
|
1379
|
+
*/
|
|
1380
|
+
fieldPath?: string;
|
|
1381
|
+
}
|
|
1382
|
+
/** @oneof */
|
|
1383
|
+
interface AggregationResultsResultOneOf {
|
|
1384
|
+
/** Value aggregation results. */
|
|
1385
|
+
values?: ValueResults;
|
|
1386
|
+
/** Range aggregation results. */
|
|
1387
|
+
ranges?: RangeResults;
|
|
1388
|
+
/** Scalar aggregation results. */
|
|
1389
|
+
scalar?: AggregationResultsScalarResult;
|
|
1390
|
+
/** Group by value aggregation results. */
|
|
1391
|
+
groupedByValue?: GroupByValueResults;
|
|
1392
|
+
/** Date histogram aggregation results. */
|
|
1393
|
+
dateHistogram?: DateHistogramResults;
|
|
1394
|
+
/** Nested aggregation results. */
|
|
1395
|
+
nested?: NestedResults;
|
|
1396
|
+
}
|
|
359
1397
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
360
1398
|
createdEvent?: EntityCreatedEvent;
|
|
361
1399
|
updatedEvent?: EntityUpdatedEvent;
|
|
@@ -385,7 +1423,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
385
1423
|
/** If present, indicates the action that triggered the event. */
|
|
386
1424
|
originatedFrom?: string | null;
|
|
387
1425
|
/**
|
|
388
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01
|
|
1426
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at `16:00` and then again at `16:01`, the second update will always have a higher sequence number.
|
|
389
1427
|
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
390
1428
|
*/
|
|
391
1429
|
entityEventSequence?: string | null;
|
|
@@ -420,6 +1458,8 @@ interface EntityDeletedEvent {
|
|
|
420
1458
|
interface ActionEvent {
|
|
421
1459
|
bodyAsJson?: string;
|
|
422
1460
|
}
|
|
1461
|
+
interface Empty {
|
|
1462
|
+
}
|
|
423
1463
|
interface MessageEnvelope {
|
|
424
1464
|
/**
|
|
425
1465
|
* App instance ID.
|
|
@@ -435,6 +1475,8 @@ interface MessageEnvelope {
|
|
|
435
1475
|
identity?: IdentificationData;
|
|
436
1476
|
/** Stringify payload. */
|
|
437
1477
|
data?: string;
|
|
1478
|
+
/** Details related to the account */
|
|
1479
|
+
accountInfo?: AccountInfo;
|
|
438
1480
|
}
|
|
439
1481
|
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
440
1482
|
/**
|
|
@@ -492,6 +1534,82 @@ declare enum WebhookIdentityType {
|
|
|
492
1534
|
}
|
|
493
1535
|
/** @enumType */
|
|
494
1536
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1537
|
+
interface AccountInfo {
|
|
1538
|
+
/**
|
|
1539
|
+
* ID of the Wix account associated with the event.
|
|
1540
|
+
* @format GUID
|
|
1541
|
+
*/
|
|
1542
|
+
accountId?: string | null;
|
|
1543
|
+
/**
|
|
1544
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
1545
|
+
* @format GUID
|
|
1546
|
+
*/
|
|
1547
|
+
parentAccountId?: string | null;
|
|
1548
|
+
/**
|
|
1549
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
1550
|
+
* @format GUID
|
|
1551
|
+
*/
|
|
1552
|
+
siteId?: string | null;
|
|
1553
|
+
}
|
|
1554
|
+
interface ExportParticipantsStatsRequest {
|
|
1555
|
+
/**
|
|
1556
|
+
* program id to export data from
|
|
1557
|
+
* @format GUID
|
|
1558
|
+
*/
|
|
1559
|
+
programId: string;
|
|
1560
|
+
}
|
|
1561
|
+
interface ExportParticipantsStatsResponse {
|
|
1562
|
+
}
|
|
1563
|
+
/** @docsIgnore */
|
|
1564
|
+
type CreateParticipantApplicationErrors = {
|
|
1565
|
+
code?: 'PREMIUM_PLAN_REQUIRED';
|
|
1566
|
+
description?: string;
|
|
1567
|
+
data?: Record<string, any>;
|
|
1568
|
+
} | {
|
|
1569
|
+
code?: 'PARTICIPANTS_LIMIT_EXCEEDED';
|
|
1570
|
+
description?: string;
|
|
1571
|
+
data?: Record<string, any>;
|
|
1572
|
+
};
|
|
1573
|
+
/** @docsIgnore */
|
|
1574
|
+
type BulkCreateParticipantsApplicationErrors = {
|
|
1575
|
+
code?: 'MULTIPLE_PROGRAM_IDS_IN_BULK_CREATE';
|
|
1576
|
+
description?: string;
|
|
1577
|
+
data?: Record<string, any>;
|
|
1578
|
+
} | {
|
|
1579
|
+
code?: 'PREMIUM_PLAN_REQUIRED';
|
|
1580
|
+
description?: string;
|
|
1581
|
+
data?: Record<string, any>;
|
|
1582
|
+
} | {
|
|
1583
|
+
code?: 'PARTICIPANTS_LIMIT_EXCEEDED';
|
|
1584
|
+
description?: string;
|
|
1585
|
+
data?: Record<string, any>;
|
|
1586
|
+
};
|
|
1587
|
+
/** @docsIgnore */
|
|
1588
|
+
type IssueCertificateApplicationErrors = {
|
|
1589
|
+
code?: 'PARTICIPANT_NOT_ACTIVE';
|
|
1590
|
+
description?: string;
|
|
1591
|
+
data?: Record<string, any>;
|
|
1592
|
+
} | {
|
|
1593
|
+
code?: 'NO_CERTIFICATE_REWARD';
|
|
1594
|
+
description?: string;
|
|
1595
|
+
data?: Record<string, any>;
|
|
1596
|
+
} | {
|
|
1597
|
+
code?: 'PARTICIPANT_NOT_COMPLETED_PROGRAM';
|
|
1598
|
+
description?: string;
|
|
1599
|
+
data?: Record<string, any>;
|
|
1600
|
+
};
|
|
1601
|
+
/** @docsIgnore */
|
|
1602
|
+
type BulkUpdateParticipantTagsApplicationErrors = {
|
|
1603
|
+
code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
|
|
1604
|
+
description?: string;
|
|
1605
|
+
data?: Record<string, any>;
|
|
1606
|
+
};
|
|
1607
|
+
/** @docsIgnore */
|
|
1608
|
+
type BulkUpdateParticipantTagsByFilterApplicationErrors = {
|
|
1609
|
+
code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
|
|
1610
|
+
description?: string;
|
|
1611
|
+
data?: Record<string, any>;
|
|
1612
|
+
};
|
|
495
1613
|
|
|
496
1614
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
497
1615
|
getUrl: (context: any) => string;
|
|
@@ -503,10 +1621,29 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
503
1621
|
__responseType: Q;
|
|
504
1622
|
__originalResponseType: R;
|
|
505
1623
|
};
|
|
506
|
-
declare function
|
|
507
|
-
declare function
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
declare function
|
|
1624
|
+
declare function createParticipant(): __PublicMethodMetaInfo<'POST', {}, CreateParticipantRequest$1, CreateParticipantRequest, CreateParticipantResponse$1, CreateParticipantResponse>;
|
|
1625
|
+
declare function updateParticipant(): __PublicMethodMetaInfo<'PATCH', {
|
|
1626
|
+
participantId: string;
|
|
1627
|
+
}, UpdateParticipantRequest$1, UpdateParticipantRequest, UpdateParticipantResponse$1, UpdateParticipantResponse>;
|
|
1628
|
+
declare function bulkCreateParticipants(): __PublicMethodMetaInfo<'POST', {}, BulkCreateParticipantsRequest$1, BulkCreateParticipantsRequest, BulkCreateParticipantsResponse$1, BulkCreateParticipantsResponse>;
|
|
1629
|
+
declare function bulkCreateParticipantsForAllMembers(): __PublicMethodMetaInfo<'POST', {}, BulkCreateParticipantsForAllMembersRequest$1, BulkCreateParticipantsForAllMembersRequest, BulkCreateParticipantsForAllMembersResponse$1, BulkCreateParticipantsForAllMembersResponse>;
|
|
1630
|
+
declare function deleteParticipant(): __PublicMethodMetaInfo<'DELETE', {
|
|
1631
|
+
participantId: string;
|
|
1632
|
+
}, DeleteParticipantRequest$1, DeleteParticipantRequest, DeleteParticipantResponse$1, DeleteParticipantResponse>;
|
|
1633
|
+
declare function issueCertificate(): __PublicMethodMetaInfo<'POST', {
|
|
1634
|
+
participantId: string;
|
|
1635
|
+
}, IssueCertificateRequest$1, IssueCertificateRequest, IssueCertificateResponse$1, IssueCertificateResponse>;
|
|
1636
|
+
declare function getPremiumStats(): __PublicMethodMetaInfo<'GET', {}, GetPremiumStatsRequest$1, GetPremiumStatsRequest, GetPremiumStatsResponse$1, GetPremiumStatsResponse>;
|
|
1637
|
+
declare function getParticipant(): __PublicMethodMetaInfo<'GET', {
|
|
1638
|
+
participantId: string;
|
|
1639
|
+
}, GetParticipantRequest$1, GetParticipantRequest, GetParticipantResponse$1, GetParticipantResponse>;
|
|
1640
|
+
declare function queryParticipants(): __PublicMethodMetaInfo<'POST', {}, QueryParticipantsRequest$1, QueryParticipantsRequest, QueryParticipantsResponse$1, QueryParticipantsResponse>;
|
|
1641
|
+
declare function getAccessStatus(): __PublicMethodMetaInfo<'GET', {}, GetAccessStatusRequest$1, GetAccessStatusRequest, GetAccessStatusResponse$1, GetAccessStatusResponse>;
|
|
1642
|
+
declare function bulkUpdateParticipantTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateParticipantTagsRequest$1, BulkUpdateParticipantTagsRequest, BulkUpdateParticipantTagsResponse$1, BulkUpdateParticipantTagsResponse>;
|
|
1643
|
+
declare function bulkUpdateParticipantTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateParticipantTagsByFilterRequest$1, BulkUpdateParticipantTagsByFilterRequest, BulkUpdateParticipantTagsByFilterResponse$1, BulkUpdateParticipantTagsByFilterResponse>;
|
|
1644
|
+
declare function searchParticipants(): __PublicMethodMetaInfo<'POST', {}, SearchParticipantsRequest$1, SearchParticipantsRequest, SearchParticipantsResponse$1, SearchParticipantsResponse>;
|
|
1645
|
+
declare function exportParticipantsStats(): __PublicMethodMetaInfo<'GET', {
|
|
1646
|
+
programId: string;
|
|
1647
|
+
}, ExportParticipantsStatsRequest$1, ExportParticipantsStatsRequest, ExportParticipantsStatsResponse$1, ExportParticipantsStatsResponse>;
|
|
511
1648
|
|
|
512
|
-
export { type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkAddToProgramRequest as BulkAddToProgramRequestOriginal, type BulkAddToProgramResponse as BulkAddToProgramResponseOriginal, type BulkAddToProgramResult as BulkAddToProgramResultOriginal, type BulkApproveAllParticipantRequest as BulkApproveAllParticipantRequestOriginal, type BulkApproveAllParticipantResponse as BulkApproveAllParticipantResponseOriginal, type BulkApproveParticipantRequest as BulkApproveParticipantRequestOriginal, type BulkApproveParticipantResponse as BulkApproveParticipantResponseOriginal, type BulkApproveParticipantResult as BulkApproveParticipantResultOriginal, type BulkInviteAllToProgramRequest as BulkInviteAllToProgramRequestOriginal, type BulkInviteAllToProgramResponse as BulkInviteAllToProgramResponseOriginal, type BulkInviteToProgramRequest as BulkInviteToProgramRequestOriginal, type BulkInviteToProgramResponse as BulkInviteToProgramResponseOriginal, type BulkInviteToProgramResult as BulkInviteToProgramResultOriginal, type Certificate as CertificateOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FreeCouponDetails as FreeCouponDetailsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, JoinPath as JoinPathOriginal, type JoinPathWithLiterals as JoinPathWithLiteralsOriginal, type JoinedInfoJoinPathDetailsOneOf as JoinedInfoJoinPathDetailsOneOfOriginal, type JoinedInfo as JoinedInfoOriginal, type Member as MemberOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type PaidPlanDetails as PaidPlanDetailsOriginal, type ParticipantAdded as ParticipantAddedOriginal, type ParticipantApproved as ParticipantApprovedOriginal, type ParticipantInvited as ParticipantInvitedOriginal, type Participant as ParticipantOriginal, type Progress as ProgressOriginal, type RestoreInfo as RestoreInfoOriginal, type SinglePaymentDetails as SinglePaymentDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkAddToProgram, bulkApproveAllParticipant, bulkApproveParticipant, bulkInviteAllToProgram, bulkInviteToProgram };
|
|
1649
|
+
export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type AggregationData as AggregationDataOriginal, type AggregationKindOneOf as AggregationKindOneOfOriginal, type Aggregation as AggregationOriginal, type AggregationResults as AggregationResultsOriginal, type AggregationResultsResultOneOf as AggregationResultsResultOneOfOriginal, type AggregationResultsScalarResult as AggregationResultsScalarResultOriginal, AggregationType as AggregationTypeOriginal, type AggregationTypeWithLiterals as AggregationTypeWithLiteralsOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, BulkActionType as BulkActionTypeOriginal, type BulkActionTypeWithLiterals as BulkActionTypeWithLiteralsOriginal, type BulkCreateParticipantsApplicationErrors as BulkCreateParticipantsApplicationErrorsOriginal, type BulkCreateParticipantsForAllMembersRequest as BulkCreateParticipantsForAllMembersRequestOriginal, type BulkCreateParticipantsForAllMembersResponse as BulkCreateParticipantsForAllMembersResponseOriginal, type BulkCreateParticipantsRequest as BulkCreateParticipantsRequestOriginal, type BulkCreateParticipantsResponse as BulkCreateParticipantsResponseOriginal, type BulkParticipantMigrationResult as BulkParticipantMigrationResultOriginal, type BulkParticipantResult as BulkParticipantResultOriginal, type BulkUpdateParticipantTagsApplicationErrors as BulkUpdateParticipantTagsApplicationErrorsOriginal, type BulkUpdateParticipantTagsByFilterApplicationErrors as BulkUpdateParticipantTagsByFilterApplicationErrorsOriginal, type BulkUpdateParticipantTagsByFilterRequest as BulkUpdateParticipantTagsByFilterRequestOriginal, type BulkUpdateParticipantTagsByFilterResponse as BulkUpdateParticipantTagsByFilterResponseOriginal, type BulkUpdateParticipantTagsRequest as BulkUpdateParticipantTagsRequestOriginal, type BulkUpdateParticipantTagsResponse as BulkUpdateParticipantTagsResponseOriginal, type BulkUpdateParticipantTagsResult as BulkUpdateParticipantTagsResultOriginal, type BulkUpsertParticipantsMigrationRequest as BulkUpsertParticipantsMigrationRequestOriginal, type BulkUpsertParticipantsMigrationResponse as BulkUpsertParticipantsMigrationResponseOriginal, type CertificateInfo as CertificateInfoOriginal, type CreateParticipantApplicationErrors as CreateParticipantApplicationErrorsOriginal, type CreateParticipantRequest as CreateParticipantRequestOriginal, type CreateParticipantResponse as CreateParticipantResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type DateHistogramAggregation as DateHistogramAggregationOriginal, type DateHistogramResult as DateHistogramResultOriginal, type DateHistogramResults as DateHistogramResultsOriginal, type DeleteAllParticipantsMigrationRequest as DeleteAllParticipantsMigrationRequestOriginal, type DeleteAllParticipantsMigrationResponse as DeleteAllParticipantsMigrationResponseOriginal, type Delete as DeleteOriginal, type DeleteParticipantRequest as DeleteParticipantRequestOriginal, type DeleteParticipantResponse as DeleteParticipantResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EnrollmentInfo as EnrollmentInfoOriginal, type EnrollmentInfoPricingTypeDetailsOneOf as EnrollmentInfoPricingTypeDetailsOneOfOriginal, EnrollmentStatus as EnrollmentStatusOriginal, type EnrollmentStatusWithLiterals as EnrollmentStatusWithLiteralsOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExportParticipantsStatsRequest as ExportParticipantsStatsRequestOriginal, type ExportParticipantsStatsResponse as ExportParticipantsStatsResponseOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FreeCouponDetails as FreeCouponDetailsOriginal, type GetAccessStatusRequest as GetAccessStatusRequestOriginal, type GetAccessStatusResponse as GetAccessStatusResponseOriginal, type GetCompletionStatsRequest as GetCompletionStatsRequestOriginal, type GetCompletionStatsResponse as GetCompletionStatsResponseOriginal, type GetParticipantRequest as GetParticipantRequestOriginal, type GetParticipantResponse as GetParticipantResponseOriginal, type GetPremiumStatsRequest as GetPremiumStatsRequestOriginal, type GetPremiumStatsResponse as GetPremiumStatsResponseOriginal, type GroupByAggregationKindOneOf as GroupByAggregationKindOneOfOriginal, type GroupByAggregation as GroupByAggregationOriginal, type GroupByValueResults as GroupByValueResultsOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type IncludeMissingValuesOptions as IncludeMissingValuesOptionsOriginal, Interval as IntervalOriginal, type IntervalWithLiterals as IntervalWithLiteralsOriginal, type IssueCertificateApplicationErrors as IssueCertificateApplicationErrorsOriginal, type IssueCertificateRequest as IssueCertificateRequestOriginal, type IssueCertificateResponse as IssueCertificateResponseOriginal, type ItemMetadata as ItemMetadataOriginal, type Member as MemberOriginal, type MessageEnvelope as MessageEnvelopeOriginal, MissingValues as MissingValuesOriginal, type MissingValuesWithLiterals as MissingValuesWithLiteralsOriginal, Mode as ModeOriginal, type ModeWithLiterals as ModeWithLiteralsOriginal, type NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOfOriginal, type NestedAggregationItem as NestedAggregationItemOriginal, type NestedAggregation as NestedAggregationOriginal, type NestedAggregationResults as NestedAggregationResultsOriginal, type NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOfOriginal, NestedAggregationType as NestedAggregationTypeOriginal, type NestedAggregationTypeWithLiterals as NestedAggregationTypeWithLiteralsOriginal, type NestedResultValue as NestedResultValueOriginal, type NestedResultValueResultOneOf as NestedResultValueResultOneOfOriginal, type NestedResults as NestedResultsOriginal, type NestedValueAggregationResult as NestedValueAggregationResultOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PaidPlanDetails as PaidPlanDetailsOriginal, type ParticipantCompletedProgram as ParticipantCompletedProgramOriginal, type ParticipantExportsFinished as ParticipantExportsFinishedOriginal, type ParticipantLeft as ParticipantLeftOriginal, type ParticipantMigration as ParticipantMigrationOriginal, type ParticipantMissedProgramDeadline as ParticipantMissedProgramDeadlineOriginal, type Participant as ParticipantOriginal, type ParticipantProgramDurationEnded as ParticipantProgramDurationEndedOriginal, type ParticipantRemoved as ParticipantRemovedOriginal, type ParticipantTagsModified as ParticipantTagsModifiedOriginal, PricingType as PricingTypeOriginal, type PricingTypeWithLiterals as PricingTypeWithLiteralsOriginal, type Progress as ProgressOriginal, ProgressStatus as ProgressStatusOriginal, type ProgressStatusWithLiterals as ProgressStatusWithLiteralsOriginal, type QueryParticipantsRequest as QueryParticipantsRequestOriginal, type QueryParticipantsResponse as QueryParticipantsResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type RangeAggregation as RangeAggregationOriginal, type RangeAggregationResult as RangeAggregationResultOriginal, type RangeBucket as RangeBucketOriginal, type RangeResult as RangeResultOriginal, type RangeResults as RangeResultsOriginal, type ReindexMessageActionOneOf as ReindexMessageActionOneOfOriginal, type ReindexMessage as ReindexMessageOriginal, type ReindexParticipantsSearchRequest as ReindexParticipantsSearchRequestOriginal, type ReindexParticipantsSearchResponse as ReindexParticipantsSearchResponseOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type Results as ResultsOriginal, type ScalarAggregation as ScalarAggregationOriginal, type ScalarResult as ScalarResultOriginal, ScalarType as ScalarTypeOriginal, type ScalarTypeWithLiterals as ScalarTypeWithLiteralsOriginal, type Schema as SchemaOriginal, type SearchDetails as SearchDetailsOriginal, type SearchParticipantsRequest as SearchParticipantsRequestOriginal, type SearchParticipantsResponse as SearchParticipantsResponseOriginal, type SinglePaymentDetails as SinglePaymentDetailsOriginal, SortDirection as SortDirectionOriginal, type SortDirectionWithLiterals as SortDirectionWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, SortType as SortTypeOriginal, type SortTypeWithLiterals as SortTypeWithLiteralsOriginal, type Sorting as SortingOriginal, type SynchronizeTimeCapsuleTasksRequest as SynchronizeTimeCapsuleTasksRequestOriginal, type SynchronizeTimeCapsuleTasksResponse as SynchronizeTimeCapsuleTasksResponseOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type UpdateParticipantRequest as UpdateParticipantRequestOriginal, type UpdateParticipantResponse as UpdateParticipantResponseOriginal, type Upsert as UpsertOriginal, type ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOfOriginal, type ValueAggregation as ValueAggregationOriginal, type ValueAggregationResult as ValueAggregationResultOriginal, type ValueResult as ValueResultOriginal, type ValueResults as ValueResultsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateParticipants, bulkCreateParticipantsForAllMembers, bulkUpdateParticipantTags, bulkUpdateParticipantTagsByFilter, createParticipant, deleteParticipant, exportParticipantsStats, getAccessStatus, getParticipant, getPremiumStats, issueCertificate, queryParticipants, searchParticipants, updateParticipant };
|