@wix/auto_sdk_online-programs_participants 1.0.13 → 1.0.15
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 +137 -49
- package/build/cjs/index.js +1188 -205
- 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 +1301 -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-B-mpcshi.d.ts +2268 -0
- package/build/es/index.d.mts +137 -49
- package/build/es/index.mjs +1150 -186
- 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 +1301 -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-B-mpcshi.d.mts +2268 -0
- package/build/internal/cjs/index.d.ts +152 -49
- package/build/internal/cjs/index.typings.d.ts +12 -690
- package/build/internal/cjs/meta.d.ts +1472 -265
- package/build/internal/cjs/online-programs-participants-v3-participant-participants.universal-Cicta6rs.d.ts +2311 -0
- package/build/internal/es/index.d.mts +152 -49
- package/build/internal/es/index.typings.d.mts +12 -690
- package/build/internal/es/meta.d.mts +1472 -265
- package/build/internal/es/online-programs-participants-v3-participant-participants.universal-Cicta6rs.d.mts +2311 -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
|
@@ -1,6 +1,12 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ae as CreateParticipantRequest$1, af as CreateParticipantResponse$1, ag as UpdateParticipantRequest$1, ah as UpdateParticipantResponse$1, ai as BulkCreateParticipantsRequest$1, c as BulkCreateParticipantsResponse$1, ax as BulkCreateParticipantsForAllMembersRequest$1, f as BulkCreateParticipantsForAllMembersResponse$1, ay as DeleteParticipantRequest$1, az as DeleteParticipantResponse$1, aA as IssueCertificateRequest$1, g as IssueCertificateResponse$1, aD as GetPremiumStatsRequest$1, G as GetPremiumStatsResponse$1, aE as GetParticipantRequest$1, aF as GetParticipantResponse$1, aG as QueryParticipantsRequest$1, aM as QueryParticipantsResponse$1, aP as GetAccessStatusRequest$1, j as GetAccessStatusResponse$1, aQ as BulkUpdateParticipantTagsRequest$1, l as BulkUpdateParticipantTagsResponse$1, aS as BulkUpdateParticipantTagsByFilterRequest$1, o as BulkUpdateParticipantTagsByFilterResponse$1, aT as SearchParticipantsRequest$1, r as SearchParticipantsResponse$1, bH as ExportParticipantsStatsRequest$1, bI as ExportParticipantsStatsResponse$1 } from './online-programs-participants-v3-participant-participants.universal-Cicta6rs.mjs';
|
|
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,353 +14,1413 @@ 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
|
|
19
|
-
* @format GUID
|
|
20
|
-
* @readonly
|
|
33
|
+
* Member ID of the participant on the site.
|
|
34
|
+
* @format GUID
|
|
35
|
+
* @readonly
|
|
36
|
+
*/
|
|
37
|
+
memberId?: string;
|
|
38
|
+
/**
|
|
39
|
+
* ID of the program the participant is enrolled in.
|
|
40
|
+
* @format GUID
|
|
41
|
+
* @readonly
|
|
42
|
+
*/
|
|
43
|
+
programId?: string;
|
|
44
|
+
/**
|
|
45
|
+
* Program completion progress. This field is conditional and must be explicitly requested via `fields` parameter.
|
|
46
|
+
* @readonly
|
|
47
|
+
*/
|
|
48
|
+
progress?: Progress;
|
|
49
|
+
/**
|
|
50
|
+
* Certificate info for participant
|
|
51
|
+
* @readonly
|
|
52
|
+
*/
|
|
53
|
+
certificateInfo?: CertificateInfo;
|
|
54
|
+
/**
|
|
55
|
+
* Site member info snapshot for the participant
|
|
56
|
+
* @readonly
|
|
57
|
+
*/
|
|
58
|
+
member?: Member;
|
|
59
|
+
/**
|
|
60
|
+
* Last activity date of the participant in the program (can either be status change or step resolution).
|
|
61
|
+
* @readonly
|
|
62
|
+
*/
|
|
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). */
|
|
77
|
+
extendedFields?: ExtendedFields;
|
|
78
|
+
/** Tags for categorizing and organizing participants. */
|
|
79
|
+
tags?: Tags;
|
|
80
|
+
}
|
|
81
|
+
declare enum PricingType {
|
|
82
|
+
/** Member joined a program that is configured as free to join, with no payment required. */
|
|
83
|
+
FREE = "FREE",
|
|
84
|
+
/** Member was added to the program by site owner. */
|
|
85
|
+
ADDED_MANUALLY = "ADDED_MANUALLY",
|
|
86
|
+
/** Member paid once to join the program. */
|
|
87
|
+
SINGLE_PAYMENT = "SINGLE_PAYMENT",
|
|
88
|
+
/** Member joined using a Pricing Plan. */
|
|
89
|
+
PAID_PLAN = "PAID_PLAN",
|
|
90
|
+
/** Member joined a paid program using a coupon that provided 100% discount. */
|
|
91
|
+
FREE_COUPON = "FREE_COUPON"
|
|
92
|
+
}
|
|
93
|
+
/** @enumType */
|
|
94
|
+
type PricingTypeWithLiterals = PricingType | 'FREE' | 'ADDED_MANUALLY' | 'SINGLE_PAYMENT' | 'PAID_PLAN' | 'FREE_COUPON';
|
|
95
|
+
interface SinglePaymentDetails {
|
|
96
|
+
/**
|
|
97
|
+
* ID of the cashier order which was used to pay for joining the program.
|
|
98
|
+
* @format GUID
|
|
99
|
+
* @immutable
|
|
100
|
+
*/
|
|
101
|
+
paymentOrderId?: string;
|
|
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
|
+
*/
|
|
107
|
+
offlineTransactionId?: string | null;
|
|
108
|
+
}
|
|
109
|
+
interface PaidPlanDetails {
|
|
110
|
+
/**
|
|
111
|
+
* ID of the Paid Plan for which member has paid to join the program.
|
|
112
|
+
* @format GUID
|
|
113
|
+
* @immutable
|
|
114
|
+
*/
|
|
115
|
+
paidPlanId?: string;
|
|
116
|
+
}
|
|
117
|
+
interface FreeCouponDetails {
|
|
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
|
+
*/
|
|
123
|
+
freeCouponId?: string;
|
|
124
|
+
}
|
|
125
|
+
interface Progress {
|
|
126
|
+
/** Number of program steps completed by member. */
|
|
127
|
+
totalStepsCompleted?: number;
|
|
128
|
+
/** Total number of program steps available to resolve. */
|
|
129
|
+
totalStepsAvailable?: number;
|
|
130
|
+
/**
|
|
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.
|
|
133
|
+
* @max 100
|
|
134
|
+
*/
|
|
135
|
+
completionPercentage?: number;
|
|
136
|
+
}
|
|
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. */
|
|
184
|
+
JOINED = "JOINED",
|
|
185
|
+
/** Enrollment temporarily suspended due to payment issues. */
|
|
186
|
+
SUSPENDED = "SUSPENDED",
|
|
187
|
+
/** Automatically removed via a Wix Automations workflow. */
|
|
188
|
+
AUTO_REMOVED = "AUTO_REMOVED",
|
|
189
|
+
/** Removed from the program by the site owner. */
|
|
190
|
+
REMOVED = "REMOVED",
|
|
191
|
+
/** Participant voluntarily left the program. */
|
|
192
|
+
LEFT = "LEFT"
|
|
193
|
+
}
|
|
194
|
+
/** @enumType */
|
|
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"
|
|
207
|
+
}
|
|
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. */
|
|
212
|
+
singlePaymentDetails?: SinglePaymentDetails;
|
|
213
|
+
/** Details about a Paid Plan enrollment. */
|
|
214
|
+
paidPlanDetails?: PaidPlanDetails;
|
|
215
|
+
/** Details about a Free Coupon enrollment. */
|
|
216
|
+
freeCouponDetails?: FreeCouponDetails;
|
|
217
|
+
/**
|
|
218
|
+
* Time zone of the site when the participant was enrolled in the program, in IANA timezone format (e.g., "America/New_York").
|
|
219
|
+
* @maxLength 50
|
|
220
|
+
* @readonly
|
|
221
|
+
*/
|
|
222
|
+
timeZone?: string;
|
|
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.
|
|
225
|
+
* @format LOCAL_DATE
|
|
226
|
+
* @readonly
|
|
227
|
+
*/
|
|
228
|
+
startDate?: string;
|
|
229
|
+
/** Pricing type used for the participant's enrollment in the program. */
|
|
230
|
+
pricingType?: PricingTypeWithLiterals;
|
|
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.
|
|
233
|
+
* @format LOCAL_DATE
|
|
234
|
+
* @readonly
|
|
235
|
+
*/
|
|
236
|
+
deadline?: string | null;
|
|
237
|
+
}
|
|
238
|
+
/** @oneof */
|
|
239
|
+
interface EnrollmentInfoPricingTypeDetailsOneOf {
|
|
240
|
+
/** Details about a Single Payment enrollment. */
|
|
241
|
+
singlePaymentDetails?: SinglePaymentDetails;
|
|
242
|
+
/** Details about a Paid Plan enrollment. */
|
|
243
|
+
paidPlanDetails?: PaidPlanDetails;
|
|
244
|
+
/** Details about a Free Coupon enrollment. */
|
|
245
|
+
freeCouponDetails?: FreeCouponDetails;
|
|
246
|
+
}
|
|
247
|
+
interface ExtendedFields {
|
|
248
|
+
/**
|
|
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).
|
|
255
|
+
*/
|
|
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 {
|
|
288
|
+
/**
|
|
289
|
+
* List of tag IDs.
|
|
290
|
+
* @maxSize 100
|
|
291
|
+
* @maxLength 5
|
|
292
|
+
*/
|
|
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
|
+
interface ParticipantAdded {
|
|
325
|
+
/**
|
|
326
|
+
* ID of the program to which the participant was added.
|
|
327
|
+
* @format GUID
|
|
328
|
+
*/
|
|
329
|
+
programId?: string;
|
|
330
|
+
/**
|
|
331
|
+
* Member ID of the participant on the site.
|
|
332
|
+
* @format GUID
|
|
333
|
+
*/
|
|
334
|
+
memberId?: string;
|
|
335
|
+
}
|
|
336
|
+
/**
|
|
337
|
+
* Domain event emitted when a participant's tags are modified.
|
|
338
|
+
* Pre-publication rename from TagsModified; no consumers of the legacy FQN are known.
|
|
339
|
+
*/
|
|
340
|
+
interface ParticipantTagsModified {
|
|
341
|
+
/** The Participant with updated tags */
|
|
342
|
+
participant?: Participant;
|
|
343
|
+
/** Tags that were assigned */
|
|
344
|
+
assignedTags?: Tags;
|
|
345
|
+
/** Tags that were unassigned */
|
|
346
|
+
unassignedTags?: Tags;
|
|
347
|
+
}
|
|
348
|
+
interface ParticipantCompletedProgram {
|
|
349
|
+
/**
|
|
350
|
+
* ID of the participant who completed the program.
|
|
351
|
+
* @format GUID
|
|
352
|
+
*/
|
|
353
|
+
participantId?: string;
|
|
354
|
+
/**
|
|
355
|
+
* ID of the program which was completed.
|
|
356
|
+
* @format GUID
|
|
357
|
+
*/
|
|
358
|
+
programId?: string;
|
|
359
|
+
/**
|
|
360
|
+
* Member ID of the participant who completed the program.
|
|
361
|
+
* @format GUID
|
|
362
|
+
*/
|
|
363
|
+
memberId?: string;
|
|
364
|
+
}
|
|
365
|
+
interface ParticipantMissedProgramDeadline {
|
|
366
|
+
/**
|
|
367
|
+
* ID of the participant who missed the deadline.
|
|
368
|
+
* @format GUID
|
|
369
|
+
*/
|
|
370
|
+
participantId?: string;
|
|
371
|
+
/**
|
|
372
|
+
* ID of the program for which the deadline was missed.
|
|
373
|
+
* @format GUID
|
|
374
|
+
*/
|
|
375
|
+
programId?: string;
|
|
376
|
+
/**
|
|
377
|
+
* Member ID of the participant who missed the deadline.
|
|
378
|
+
* @format GUID
|
|
379
|
+
*/
|
|
380
|
+
memberId?: string;
|
|
381
|
+
}
|
|
382
|
+
interface ParticipantProgramDurationEnded {
|
|
383
|
+
/**
|
|
384
|
+
* ID of the participant whose program duration ended.
|
|
385
|
+
* @format GUID
|
|
386
|
+
*/
|
|
387
|
+
participantId?: string;
|
|
388
|
+
/**
|
|
389
|
+
* ID of the program whose duration ended for the participant.
|
|
390
|
+
* @format GUID
|
|
391
|
+
*/
|
|
392
|
+
programId?: string;
|
|
393
|
+
/**
|
|
394
|
+
* Member ID of the participant whose program duration ended.
|
|
395
|
+
* @format GUID
|
|
396
|
+
*/
|
|
397
|
+
memberId?: string;
|
|
398
|
+
}
|
|
399
|
+
/** Domain event emitted when a participant is removed from a program by an administrator. */
|
|
400
|
+
interface ParticipantRemoved {
|
|
401
|
+
/**
|
|
402
|
+
* ID of the participant who was removed.
|
|
403
|
+
* @format GUID
|
|
404
|
+
*/
|
|
405
|
+
participantId?: string;
|
|
406
|
+
/**
|
|
407
|
+
* ID of the program from which the participant was removed.
|
|
408
|
+
* @format GUID
|
|
409
|
+
*/
|
|
410
|
+
programId?: string;
|
|
411
|
+
/**
|
|
412
|
+
* Member ID of the participant who was removed.
|
|
413
|
+
* @format GUID
|
|
414
|
+
*/
|
|
415
|
+
memberId?: string;
|
|
416
|
+
}
|
|
417
|
+
/** Domain event emitted when a participant voluntarily leaves a program. */
|
|
418
|
+
interface ParticipantLeft {
|
|
419
|
+
/**
|
|
420
|
+
* ID of the participant who left the program.
|
|
421
|
+
* @format GUID
|
|
422
|
+
*/
|
|
423
|
+
participantId?: string;
|
|
424
|
+
/**
|
|
425
|
+
* ID of the program the participant left.
|
|
426
|
+
* @format GUID
|
|
427
|
+
*/
|
|
428
|
+
programId?: string;
|
|
429
|
+
/**
|
|
430
|
+
* Member ID of the participant who left.
|
|
431
|
+
* @format GUID
|
|
432
|
+
*/
|
|
433
|
+
memberId?: string;
|
|
434
|
+
}
|
|
435
|
+
interface ParticipantExportsFinished {
|
|
436
|
+
/**
|
|
437
|
+
* program id from which stats were exported
|
|
438
|
+
* @format GUID
|
|
439
|
+
*/
|
|
440
|
+
programId?: string;
|
|
441
|
+
/**
|
|
442
|
+
* url to download report
|
|
443
|
+
* @format WEB_URL
|
|
444
|
+
*/
|
|
445
|
+
downloadUrl?: string;
|
|
446
|
+
/** days url will be downloadable */
|
|
447
|
+
downloadUrlTtlDays?: number;
|
|
448
|
+
}
|
|
449
|
+
interface CreateParticipantRequest {
|
|
450
|
+
/** Participant to create */
|
|
451
|
+
participant: Participant;
|
|
452
|
+
/**
|
|
453
|
+
* Array of conditional fields to include in the response.
|
|
454
|
+
* 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.
|
|
455
|
+
* @maxSize 1
|
|
456
|
+
*/
|
|
457
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
458
|
+
}
|
|
459
|
+
/**
|
|
460
|
+
* Enum for specifying which conditional fields to include in responses.
|
|
461
|
+
* Use these values in the `fields` parameter to request expensive or conditional fields.
|
|
462
|
+
*/
|
|
463
|
+
declare enum RequestedFields {
|
|
464
|
+
/** Request the progress field to be calculated and included in the response. */
|
|
465
|
+
PROGRESS = "PROGRESS"
|
|
466
|
+
}
|
|
467
|
+
/** @enumType */
|
|
468
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'PROGRESS';
|
|
469
|
+
interface CreateParticipantResponse {
|
|
470
|
+
/** Created participant */
|
|
471
|
+
participant?: Participant;
|
|
472
|
+
}
|
|
473
|
+
interface UpdateParticipantRequest {
|
|
474
|
+
/** Participant to update. Must include the participant ID. */
|
|
475
|
+
participant: Participant;
|
|
476
|
+
/**
|
|
477
|
+
* Array of conditional fields to include in the response.
|
|
478
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
479
|
+
* @maxSize 1
|
|
480
|
+
*/
|
|
481
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
482
|
+
/**
|
|
483
|
+
* Optional explicit field mask. If omitted, the API infers it from writable fields in `participant`.
|
|
484
|
+
* @internal
|
|
485
|
+
*/
|
|
486
|
+
fieldMask?: string[];
|
|
487
|
+
}
|
|
488
|
+
interface UpdateParticipantResponse {
|
|
489
|
+
/** Updated participant */
|
|
490
|
+
participant?: Participant;
|
|
491
|
+
}
|
|
492
|
+
interface BulkCreateParticipantsRequest {
|
|
493
|
+
/**
|
|
494
|
+
* List of participants to create.
|
|
495
|
+
* @minSize 1
|
|
496
|
+
* @maxSize 100
|
|
497
|
+
*/
|
|
498
|
+
participants: Participant[];
|
|
499
|
+
/** Whether to return entities in response or not. */
|
|
500
|
+
returnEntity?: boolean;
|
|
501
|
+
/**
|
|
502
|
+
* Array of conditional fields to include in the response.
|
|
503
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
504
|
+
* @maxSize 1
|
|
505
|
+
*/
|
|
506
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
507
|
+
}
|
|
508
|
+
interface BulkCreateParticipantsResponse {
|
|
509
|
+
/**
|
|
510
|
+
* Results of the bulk create operation.
|
|
511
|
+
* @minSize 1
|
|
512
|
+
* @maxSize 100
|
|
513
|
+
*/
|
|
514
|
+
results?: BulkParticipantResult[];
|
|
515
|
+
/** Metadata about the bulk action. */
|
|
516
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
517
|
+
}
|
|
518
|
+
interface BulkParticipantResult {
|
|
519
|
+
/** Metadata for the item. */
|
|
520
|
+
itemMetadata?: ItemMetadata;
|
|
521
|
+
/** The participant entity. Empty if `return_entity` is `false`. */
|
|
522
|
+
item?: Participant;
|
|
523
|
+
}
|
|
524
|
+
interface ItemMetadata {
|
|
525
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
526
|
+
id?: string | null;
|
|
527
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
528
|
+
originalIndex?: number;
|
|
529
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
530
|
+
success?: boolean;
|
|
531
|
+
/** Details about the error in case of failure. */
|
|
532
|
+
error?: ApplicationError;
|
|
533
|
+
}
|
|
534
|
+
interface ApplicationError {
|
|
535
|
+
/** Error code. */
|
|
536
|
+
code?: string;
|
|
537
|
+
/** Description of the error. */
|
|
538
|
+
description?: string;
|
|
539
|
+
/** Data related to the error. */
|
|
540
|
+
data?: Record<string, any> | null;
|
|
541
|
+
}
|
|
542
|
+
interface BulkActionMetadata {
|
|
543
|
+
/** Number of items that were successfully processed. */
|
|
544
|
+
totalSuccesses?: number;
|
|
545
|
+
/** Number of items that couldn't be processed. */
|
|
546
|
+
totalFailures?: number;
|
|
547
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
548
|
+
undetailedFailures?: number;
|
|
549
|
+
}
|
|
550
|
+
interface BulkUpsertParticipantsMigrationRequest {
|
|
551
|
+
/**
|
|
552
|
+
* List of participants to create or update.
|
|
553
|
+
* @minSize 1
|
|
554
|
+
* @maxSize 100
|
|
555
|
+
*/
|
|
556
|
+
participants?: ParticipantMigration[];
|
|
557
|
+
}
|
|
558
|
+
interface ParticipantMigration {
|
|
559
|
+
/** Participant to create or update. */
|
|
560
|
+
participant?: Participant;
|
|
561
|
+
/**
|
|
562
|
+
* Resolved step IDs to restore on participant.
|
|
563
|
+
* @maxSize 5000
|
|
564
|
+
* @format GUID
|
|
565
|
+
*/
|
|
566
|
+
resolvedStepIds?: string[];
|
|
567
|
+
}
|
|
568
|
+
interface BulkUpsertParticipantsMigrationResponse {
|
|
569
|
+
/**
|
|
570
|
+
* Results of the bulk migration operation.
|
|
571
|
+
* @minSize 1
|
|
572
|
+
* @maxSize 100
|
|
573
|
+
*/
|
|
574
|
+
results?: BulkParticipantMigrationResult[];
|
|
575
|
+
/** Metadata about the bulk action. */
|
|
576
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
577
|
+
}
|
|
578
|
+
interface BulkParticipantMigrationResult {
|
|
579
|
+
/** Metadata for the item. */
|
|
580
|
+
itemMetadata?: ItemMetadata;
|
|
581
|
+
/** Action type of bulk action (INSERT OR UPDATE) for that endpoint. */
|
|
582
|
+
action?: BulkActionTypeWithLiterals;
|
|
583
|
+
}
|
|
584
|
+
declare enum BulkActionType {
|
|
585
|
+
/** default action type, should never be used */
|
|
586
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
587
|
+
/** Action type for inserting new items. */
|
|
588
|
+
INSERT = "INSERT",
|
|
589
|
+
/** Action type for updating existing items. */
|
|
590
|
+
UPDATE = "UPDATE"
|
|
591
|
+
}
|
|
592
|
+
/** @enumType */
|
|
593
|
+
type BulkActionTypeWithLiterals = BulkActionType | 'UNKNOWN_ACTION_TYPE' | 'INSERT' | 'UPDATE';
|
|
594
|
+
interface DeleteAllParticipantsMigrationRequest {
|
|
595
|
+
}
|
|
596
|
+
interface DeleteAllParticipantsMigrationResponse {
|
|
597
|
+
}
|
|
598
|
+
interface ReindexParticipantsSearchRequest {
|
|
599
|
+
/**
|
|
600
|
+
* @minSize 1
|
|
601
|
+
* @maxSize 1000
|
|
602
|
+
* @format GUID
|
|
603
|
+
*/
|
|
604
|
+
participantIds?: string[];
|
|
605
|
+
}
|
|
606
|
+
interface ReindexParticipantsSearchResponse {
|
|
607
|
+
}
|
|
608
|
+
interface SynchronizeTimeCapsuleTasksRequest {
|
|
609
|
+
/**
|
|
610
|
+
* Metasite whose participant finish tasks should be synchronized.
|
|
611
|
+
* @format GUID
|
|
612
|
+
*/
|
|
613
|
+
metaSiteId?: string;
|
|
614
|
+
}
|
|
615
|
+
interface SynchronizeTimeCapsuleTasksResponse {
|
|
616
|
+
/**
|
|
617
|
+
* ID of the asynchronous job that will process the request. Pass this ID to Get Async Job to track the operation status.
|
|
618
|
+
* @format GUID
|
|
619
|
+
*/
|
|
620
|
+
jobId?: string;
|
|
621
|
+
}
|
|
622
|
+
interface BulkCreateParticipantsForAllMembersRequest {
|
|
623
|
+
/**
|
|
624
|
+
* ID of the program for which to create participants for all site members in bulk.
|
|
625
|
+
* @format GUID
|
|
626
|
+
*/
|
|
627
|
+
programId: string;
|
|
628
|
+
/**
|
|
629
|
+
* Site member IDs to exclude from bulk participant creation. Maximum 100 member IDs can be excluded.
|
|
630
|
+
* @format GUID
|
|
631
|
+
* @maxSize 100
|
|
632
|
+
*/
|
|
633
|
+
excludeMemberIds?: string[];
|
|
634
|
+
}
|
|
635
|
+
interface BulkCreateParticipantsForAllMembersResponse {
|
|
636
|
+
/**
|
|
637
|
+
* ID of the asynchronous job that will process the request. Pass this ID to Get Async Job to track the operation status.
|
|
638
|
+
* @format GUID
|
|
639
|
+
*/
|
|
640
|
+
jobId?: string;
|
|
641
|
+
}
|
|
642
|
+
interface DeleteParticipantRequest {
|
|
643
|
+
/**
|
|
644
|
+
* ID of the participant to delete.
|
|
645
|
+
* @format GUID
|
|
646
|
+
*/
|
|
647
|
+
participantId: string;
|
|
648
|
+
}
|
|
649
|
+
interface DeleteParticipantResponse {
|
|
650
|
+
}
|
|
651
|
+
interface IssueCertificateRequest {
|
|
652
|
+
/**
|
|
653
|
+
* ID of the participant to issue the certificate to.
|
|
654
|
+
* @format GUID
|
|
655
|
+
*/
|
|
656
|
+
participantId: string;
|
|
657
|
+
/**
|
|
658
|
+
* Array of conditional fields to include in the response.
|
|
659
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
660
|
+
* @maxSize 1
|
|
661
|
+
*/
|
|
662
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
663
|
+
}
|
|
664
|
+
interface IssueCertificateResponse {
|
|
665
|
+
/** Updated participant */
|
|
666
|
+
participant?: Participant;
|
|
667
|
+
}
|
|
668
|
+
interface GetCompletionStatsRequest {
|
|
669
|
+
/**
|
|
670
|
+
* ID of the program to retrieve completion statistics for.
|
|
671
|
+
* @format GUID
|
|
672
|
+
*/
|
|
673
|
+
programId?: string;
|
|
674
|
+
}
|
|
675
|
+
interface GetCompletionStatsResponse {
|
|
676
|
+
/** Number of participants that completed the program */
|
|
677
|
+
completedParticipantsCount?: number;
|
|
678
|
+
/** Percentage of participants that completed the program */
|
|
679
|
+
completionRate?: number;
|
|
680
|
+
}
|
|
681
|
+
interface GetPremiumStatsRequest {
|
|
682
|
+
}
|
|
683
|
+
interface GetPremiumStatsResponse {
|
|
684
|
+
/** True if site has Online Programs premium feature */
|
|
685
|
+
premiumEnabled?: boolean;
|
|
686
|
+
/** Count of active participants on the site */
|
|
687
|
+
activeParticipantsCount?: number;
|
|
688
|
+
/** Limit of active participants on a site without premium */
|
|
689
|
+
activeParticipantsLimit?: number;
|
|
690
|
+
}
|
|
691
|
+
interface GetParticipantRequest {
|
|
692
|
+
/**
|
|
693
|
+
* ID of the participant to fetch.
|
|
694
|
+
* @format GUID
|
|
695
|
+
*/
|
|
696
|
+
participantId: string;
|
|
697
|
+
/**
|
|
698
|
+
* Array of conditional fields to include in the response.
|
|
699
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
700
|
+
* @maxSize 1
|
|
701
|
+
*/
|
|
702
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
703
|
+
}
|
|
704
|
+
interface GetParticipantResponse {
|
|
705
|
+
/** The retrieved participant. */
|
|
706
|
+
participant?: Participant;
|
|
707
|
+
}
|
|
708
|
+
interface QueryParticipantsRequest {
|
|
709
|
+
/** Platformized query */
|
|
710
|
+
query?: QueryV2;
|
|
711
|
+
/**
|
|
712
|
+
* Array of conditional fields to include in the response.
|
|
713
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
714
|
+
* @maxSize 1
|
|
715
|
+
*/
|
|
716
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
717
|
+
}
|
|
718
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
719
|
+
/** Paging options to limit and offset the number of items. */
|
|
720
|
+
paging?: Paging;
|
|
721
|
+
/** 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`. */
|
|
722
|
+
cursorPaging?: CursorPaging;
|
|
723
|
+
/**
|
|
724
|
+
* Filter object.
|
|
725
|
+
*
|
|
726
|
+
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
727
|
+
*/
|
|
728
|
+
filter?: Record<string, any> | null;
|
|
729
|
+
/**
|
|
730
|
+
* Sort object.
|
|
731
|
+
*
|
|
732
|
+
* Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
733
|
+
* @maxSize 100
|
|
734
|
+
*/
|
|
735
|
+
sort?: Sorting[];
|
|
736
|
+
/**
|
|
737
|
+
* 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.
|
|
738
|
+
* @maxSize 100
|
|
739
|
+
* @maxLength 1000
|
|
740
|
+
*/
|
|
741
|
+
fields?: string[];
|
|
742
|
+
/**
|
|
743
|
+
* 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.
|
|
744
|
+
* @maxSize 100
|
|
745
|
+
* @maxLength 1000
|
|
746
|
+
*/
|
|
747
|
+
fieldsets?: string[];
|
|
748
|
+
}
|
|
749
|
+
/** @oneof */
|
|
750
|
+
interface QueryV2PagingMethodOneOf {
|
|
751
|
+
/** Paging options to limit and offset the number of items. */
|
|
752
|
+
paging?: Paging;
|
|
753
|
+
/** 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`. */
|
|
754
|
+
cursorPaging?: CursorPaging;
|
|
755
|
+
}
|
|
756
|
+
interface Sorting {
|
|
757
|
+
/**
|
|
758
|
+
* Name of the field to sort by.
|
|
759
|
+
* @maxLength 512
|
|
760
|
+
*/
|
|
761
|
+
fieldName?: string;
|
|
762
|
+
/** Sort order. */
|
|
763
|
+
order?: SortOrderWithLiterals;
|
|
764
|
+
}
|
|
765
|
+
declare enum SortOrder {
|
|
766
|
+
ASC = "ASC",
|
|
767
|
+
DESC = "DESC"
|
|
768
|
+
}
|
|
769
|
+
/** @enumType */
|
|
770
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
771
|
+
interface Paging {
|
|
772
|
+
/** Number of items to load. */
|
|
773
|
+
limit?: number | null;
|
|
774
|
+
/** Number of items to skip in the current sort order. */
|
|
775
|
+
offset?: number | null;
|
|
776
|
+
}
|
|
777
|
+
interface CursorPaging {
|
|
778
|
+
/**
|
|
779
|
+
* Maximum number of items to return in the results.
|
|
780
|
+
* @max 100
|
|
781
|
+
*/
|
|
782
|
+
limit?: number | null;
|
|
783
|
+
/**
|
|
784
|
+
* Pointer to the next or previous page in the list of results.
|
|
785
|
+
*
|
|
786
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
787
|
+
* Not relevant for the first request.
|
|
788
|
+
* @maxLength 16000
|
|
789
|
+
*/
|
|
790
|
+
cursor?: string | null;
|
|
791
|
+
}
|
|
792
|
+
interface QueryParticipantsResponse {
|
|
793
|
+
/** List of participants matching the query. */
|
|
794
|
+
participants?: Participant[];
|
|
795
|
+
/** Paging metadata. */
|
|
796
|
+
pagingMetadata?: PagingMetadataV2;
|
|
797
|
+
}
|
|
798
|
+
interface PagingMetadataV2 {
|
|
799
|
+
/** Number of items returned in the response. */
|
|
800
|
+
count?: number | null;
|
|
801
|
+
/** Offset that was requested. */
|
|
802
|
+
offset?: number | null;
|
|
803
|
+
/** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
|
|
804
|
+
total?: number | null;
|
|
805
|
+
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
806
|
+
tooManyToCount?: boolean | null;
|
|
807
|
+
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
808
|
+
cursors?: Cursors;
|
|
809
|
+
/**
|
|
810
|
+
* Indicates if there are more results after the current page.
|
|
811
|
+
* If `true`, another page of results can be retrieved.
|
|
812
|
+
* If `false`, this is the last page.
|
|
813
|
+
* @internal
|
|
814
|
+
*/
|
|
815
|
+
hasNext?: boolean | null;
|
|
816
|
+
}
|
|
817
|
+
interface Cursors {
|
|
818
|
+
/**
|
|
819
|
+
* Cursor string pointing to the next page in the list of results.
|
|
820
|
+
* @maxLength 16000
|
|
821
|
+
*/
|
|
822
|
+
next?: string | null;
|
|
823
|
+
/**
|
|
824
|
+
* Cursor pointing to the previous page in the list of results.
|
|
825
|
+
* @maxLength 16000
|
|
826
|
+
*/
|
|
827
|
+
prev?: string | null;
|
|
828
|
+
}
|
|
829
|
+
interface GetAccessStatusRequest {
|
|
830
|
+
}
|
|
831
|
+
interface GetAccessStatusResponse {
|
|
832
|
+
/** True if participants cannot access online programs due to some limitations */
|
|
833
|
+
accessBlocked?: boolean;
|
|
834
|
+
}
|
|
835
|
+
interface BulkUpdateParticipantTagsRequest {
|
|
836
|
+
/**
|
|
837
|
+
* Participant IDs to update tags for (1-100 items)
|
|
838
|
+
* @minSize 1
|
|
839
|
+
* @maxSize 100
|
|
840
|
+
* @format GUID
|
|
841
|
+
*/
|
|
842
|
+
participantIds: string[];
|
|
843
|
+
/** Tags to assign to the Participants */
|
|
844
|
+
assignTags?: Tags;
|
|
845
|
+
/** Tags to unassign from the Participants */
|
|
846
|
+
unassignTags?: Tags;
|
|
847
|
+
}
|
|
848
|
+
interface BulkUpdateParticipantTagsResponse {
|
|
849
|
+
/**
|
|
850
|
+
* Results for each Participant
|
|
851
|
+
* @minSize 1
|
|
852
|
+
* @maxSize 100
|
|
853
|
+
*/
|
|
854
|
+
results?: BulkUpdateParticipantTagsResult[];
|
|
855
|
+
/** Metadata about the bulk operation */
|
|
856
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
857
|
+
}
|
|
858
|
+
interface BulkUpdateParticipantTagsResult {
|
|
859
|
+
/** Metadata for this specific item */
|
|
860
|
+
itemMetadata?: ItemMetadata;
|
|
861
|
+
}
|
|
862
|
+
interface BulkUpdateParticipantTagsByFilterRequest {
|
|
863
|
+
/** WQL filter to select Participants */
|
|
864
|
+
filter: Record<string, any> | null;
|
|
865
|
+
/** Tags to assign to matching Participants */
|
|
866
|
+
assignTags?: Tags;
|
|
867
|
+
/** Tags to unassign from matching Participants */
|
|
868
|
+
unassignTags?: Tags;
|
|
869
|
+
}
|
|
870
|
+
interface BulkUpdateParticipantTagsByFilterResponse {
|
|
871
|
+
/**
|
|
872
|
+
* Job ID for tracking the async operation. Pass this ID to Get Async Job to track the operation status.
|
|
873
|
+
* @format GUID
|
|
874
|
+
*/
|
|
875
|
+
jobId?: string;
|
|
876
|
+
}
|
|
877
|
+
interface SearchParticipantsRequest {
|
|
878
|
+
/** Query to search participants. */
|
|
879
|
+
search?: CursorSearch;
|
|
880
|
+
/**
|
|
881
|
+
* Array of conditional fields to include in the response.
|
|
882
|
+
* Use RequestedFields.PROGRESS to include the progress field which is conditionally returned.
|
|
883
|
+
* @maxSize 1
|
|
884
|
+
*/
|
|
885
|
+
fields?: RequestedFieldsWithLiterals[];
|
|
886
|
+
}
|
|
887
|
+
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
888
|
+
/**
|
|
889
|
+
* Cursor paging options.
|
|
890
|
+
*
|
|
891
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
892
|
+
*/
|
|
893
|
+
cursorPaging?: CursorPaging;
|
|
894
|
+
/**
|
|
895
|
+
* Filter object.
|
|
896
|
+
*
|
|
897
|
+
* Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
898
|
+
*/
|
|
899
|
+
filter?: Record<string, any> | null;
|
|
900
|
+
/**
|
|
901
|
+
* List of sort objects.
|
|
902
|
+
*
|
|
903
|
+
* Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
904
|
+
* @maxSize 10
|
|
905
|
+
*/
|
|
906
|
+
sort?: Sorting[];
|
|
907
|
+
/**
|
|
908
|
+
* 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.
|
|
909
|
+
* @maxSize 10
|
|
910
|
+
*/
|
|
911
|
+
aggregations?: Aggregation[];
|
|
912
|
+
/** Free text to match in searchable fields. */
|
|
913
|
+
search?: SearchDetails;
|
|
914
|
+
/**
|
|
915
|
+
* 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.
|
|
916
|
+
* Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z".
|
|
917
|
+
* @maxLength 50
|
|
918
|
+
*/
|
|
919
|
+
timeZone?: string | null;
|
|
920
|
+
}
|
|
921
|
+
/** @oneof */
|
|
922
|
+
interface CursorSearchPagingMethodOneOf {
|
|
923
|
+
/**
|
|
924
|
+
* Cursor paging options.
|
|
925
|
+
*
|
|
926
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
21
927
|
*/
|
|
22
|
-
|
|
928
|
+
cursorPaging?: CursorPaging;
|
|
929
|
+
}
|
|
930
|
+
interface Aggregation extends AggregationKindOneOf {
|
|
931
|
+
/** 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. */
|
|
932
|
+
value?: ValueAggregation;
|
|
933
|
+
/** 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. */
|
|
934
|
+
range?: RangeAggregation;
|
|
935
|
+
/** 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`. */
|
|
936
|
+
scalar?: ScalarAggregation;
|
|
937
|
+
/** 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. */
|
|
938
|
+
dateHistogram?: DateHistogramAggregation;
|
|
939
|
+
/** 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`. */
|
|
940
|
+
nested?: NestedAggregation;
|
|
23
941
|
/**
|
|
24
|
-
*
|
|
25
|
-
* @
|
|
26
|
-
* @readonly
|
|
942
|
+
* Aggregation name, returned in `aggregations.results.name`.
|
|
943
|
+
* @maxLength 100
|
|
27
944
|
*/
|
|
28
|
-
|
|
945
|
+
name?: string | null;
|
|
946
|
+
/** Type of aggregation to perform. Must align with the corresponding aggregation field. */
|
|
947
|
+
type?: AggregationTypeWithLiterals;
|
|
29
948
|
/**
|
|
30
|
-
*
|
|
31
|
-
* @
|
|
949
|
+
* Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
950
|
+
* @maxLength 200
|
|
32
951
|
*/
|
|
33
|
-
|
|
34
|
-
/** state of participation in the program */
|
|
35
|
-
state?: StateWithLiterals;
|
|
952
|
+
fieldPath?: string;
|
|
36
953
|
/**
|
|
37
|
-
*
|
|
38
|
-
* @
|
|
954
|
+
* Deprecated. Use `nested` instead.
|
|
955
|
+
* @deprecated Deprecated. Use `nested` instead.
|
|
956
|
+
* @replacedBy kind.nested
|
|
957
|
+
* @targetRemovalDate 2024-03-30
|
|
39
958
|
*/
|
|
40
|
-
|
|
41
|
-
joinedInfo?: JoinedInfo;
|
|
42
|
-
/** @readonly */
|
|
43
|
-
member?: Member;
|
|
44
|
-
/** @readonly */
|
|
45
|
-
lastActivityDate?: Date | null;
|
|
46
|
-
extendedFields?: ExtendedFields;
|
|
47
|
-
}
|
|
48
|
-
declare enum JoinPath {
|
|
49
|
-
UNKNOWN_JOIN_PATH = "UNKNOWN_JOIN_PATH",
|
|
50
|
-
/** Member joined to the program for free */
|
|
51
|
-
FREE = "FREE",
|
|
52
|
-
/** Member was added to the program by site owner */
|
|
53
|
-
ADDED = "ADDED",
|
|
54
|
-
/** Member paid once to join the program */
|
|
55
|
-
SINGLE_PAYMENT = "SINGLE_PAYMENT",
|
|
56
|
-
/** Member has Paid Plan to join */
|
|
57
|
-
PAID_PLAN = "PAID_PLAN",
|
|
58
|
-
/** Member joined with the Free Coupon */
|
|
59
|
-
FREE_COUPON = "FREE_COUPON"
|
|
959
|
+
groupBy?: GroupByAggregation;
|
|
60
960
|
}
|
|
61
|
-
/** @
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
961
|
+
/** @oneof */
|
|
962
|
+
interface AggregationKindOneOf {
|
|
963
|
+
/** 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. */
|
|
964
|
+
value?: ValueAggregation;
|
|
965
|
+
/** 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. */
|
|
966
|
+
range?: RangeAggregation;
|
|
967
|
+
/** 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`. */
|
|
968
|
+
scalar?: ScalarAggregation;
|
|
969
|
+
/** 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. */
|
|
970
|
+
dateHistogram?: DateHistogramAggregation;
|
|
971
|
+
/** 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`. */
|
|
972
|
+
nested?: NestedAggregation;
|
|
68
973
|
}
|
|
69
|
-
interface
|
|
70
|
-
/**
|
|
71
|
-
|
|
974
|
+
interface RangeBucket {
|
|
975
|
+
/** Inclusive lower bound of the range. Required if `to` is not provided. */
|
|
976
|
+
from?: number | null;
|
|
977
|
+
/** Exclusive upper bound of the range. Required if `from` is not provided. */
|
|
978
|
+
to?: number | null;
|
|
72
979
|
}
|
|
73
|
-
|
|
74
|
-
/**
|
|
75
|
-
|
|
980
|
+
declare enum SortType {
|
|
981
|
+
/** Number of matches in the results. */
|
|
982
|
+
COUNT = "COUNT",
|
|
983
|
+
/** Alphabetically by the field value. */
|
|
984
|
+
VALUE = "VALUE"
|
|
76
985
|
}
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
/**
|
|
81
|
-
|
|
82
|
-
/**
|
|
83
|
-
|
|
84
|
-
* @max 100
|
|
85
|
-
*/
|
|
86
|
-
completionPercentage?: number;
|
|
986
|
+
/** @enumType */
|
|
987
|
+
type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
988
|
+
declare enum SortDirection {
|
|
989
|
+
/** Descending order. */
|
|
990
|
+
DESC = "DESC",
|
|
991
|
+
/** Ascending order. */
|
|
992
|
+
ASC = "ASC"
|
|
87
993
|
}
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
/**
|
|
92
|
-
|
|
93
|
-
/**
|
|
94
|
-
|
|
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 */
|
|
98
|
-
SUSPENDED = "SUSPENDED",
|
|
99
|
-
/** Participant removed automatically after some program condition */
|
|
100
|
-
AUTO_REMOVED = "AUTO_REMOVED",
|
|
101
|
-
/** Participant removed by site owner */
|
|
102
|
-
REMOVED = "REMOVED",
|
|
103
|
-
/** Participant left the program by himself */
|
|
104
|
-
LEFT = "LEFT"
|
|
994
|
+
/** @enumType */
|
|
995
|
+
type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
996
|
+
declare enum MissingValues {
|
|
997
|
+
/** Exclude missing values from the aggregation results. */
|
|
998
|
+
EXCLUDE = "EXCLUDE",
|
|
999
|
+
/** Include missing values in the aggregation results. */
|
|
1000
|
+
INCLUDE = "INCLUDE"
|
|
105
1001
|
}
|
|
106
1002
|
/** @enumType */
|
|
107
|
-
type
|
|
108
|
-
interface
|
|
1003
|
+
type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
1004
|
+
interface IncludeMissingValuesOptions {
|
|
109
1005
|
/**
|
|
110
|
-
*
|
|
111
|
-
* @
|
|
1006
|
+
* Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans.
|
|
1007
|
+
* @maxLength 20
|
|
112
1008
|
*/
|
|
113
|
-
|
|
1009
|
+
addToBucket?: string;
|
|
114
1010
|
}
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
1011
|
+
declare enum ScalarType {
|
|
1012
|
+
/** Total number of distinct values. */
|
|
1013
|
+
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
1014
|
+
/** Minimum value. */
|
|
1015
|
+
MIN = "MIN",
|
|
1016
|
+
/** Maximum value. */
|
|
1017
|
+
MAX = "MAX",
|
|
119
1018
|
/**
|
|
120
|
-
*
|
|
121
|
-
* @
|
|
1019
|
+
* Sum of values.
|
|
1020
|
+
* @internal
|
|
122
1021
|
*/
|
|
123
|
-
|
|
1022
|
+
SUM = "SUM",
|
|
124
1023
|
/**
|
|
125
|
-
*
|
|
126
|
-
* @
|
|
1024
|
+
* Average of values.
|
|
1025
|
+
* @internal
|
|
127
1026
|
*/
|
|
128
|
-
|
|
129
|
-
|
|
1027
|
+
AVG = "AVG"
|
|
1028
|
+
}
|
|
1029
|
+
/** @enumType */
|
|
1030
|
+
type ScalarTypeWithLiterals = ScalarType | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
1031
|
+
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
1032
|
+
/** Options for including missing values in results. */
|
|
1033
|
+
includeOptions?: IncludeMissingValuesOptions;
|
|
1034
|
+
/** Sort type. */
|
|
1035
|
+
sortType?: SortTypeWithLiterals;
|
|
1036
|
+
/** Sort direction. */
|
|
1037
|
+
sortDirection?: SortDirectionWithLiterals;
|
|
130
1038
|
/**
|
|
131
|
-
*
|
|
132
|
-
*
|
|
1039
|
+
* Number of aggregation results to return.
|
|
1040
|
+
* Min: `1`
|
|
1041
|
+
* Max: `250`
|
|
1042
|
+
* Default: `10`
|
|
1043
|
+
*/
|
|
1044
|
+
limit?: number | null;
|
|
1045
|
+
/**
|
|
1046
|
+
* Whether to include or exclude missing values in the aggregation results.
|
|
1047
|
+
* Default: `EXCLUDE`.
|
|
133
1048
|
*/
|
|
134
|
-
|
|
1049
|
+
missingValues?: MissingValuesWithLiterals;
|
|
135
1050
|
}
|
|
136
1051
|
/** @oneof */
|
|
137
|
-
interface
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
freeCouponDetails?: FreeCouponDetails;
|
|
1052
|
+
interface ValueAggregationOptionsOneOf {
|
|
1053
|
+
/** Options for including missing values in results. */
|
|
1054
|
+
includeOptions?: IncludeMissingValuesOptions;
|
|
141
1055
|
}
|
|
142
|
-
|
|
1056
|
+
declare enum NestedAggregationType {
|
|
1057
|
+
/** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
|
|
1058
|
+
VALUE = "VALUE",
|
|
1059
|
+
/** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
|
|
1060
|
+
RANGE = "RANGE",
|
|
1061
|
+
/** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
1062
|
+
SCALAR = "SCALAR",
|
|
1063
|
+
/** 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.). */
|
|
1064
|
+
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
1065
|
+
}
|
|
1066
|
+
/** @enumType */
|
|
1067
|
+
type NestedAggregationTypeWithLiterals = NestedAggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
1068
|
+
interface RangeAggregation {
|
|
143
1069
|
/**
|
|
144
|
-
*
|
|
145
|
-
* @
|
|
1070
|
+
* List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds.
|
|
1071
|
+
* @maxSize 50
|
|
146
1072
|
*/
|
|
147
|
-
|
|
1073
|
+
buckets?: RangeBucket[];
|
|
1074
|
+
}
|
|
1075
|
+
interface ScalarAggregation {
|
|
1076
|
+
/** Operator type for the scalar aggregation. */
|
|
1077
|
+
type?: ScalarTypeWithLiterals;
|
|
1078
|
+
}
|
|
1079
|
+
interface DateHistogramAggregation {
|
|
1080
|
+
/** Interval for date histogram aggregation. */
|
|
1081
|
+
interval?: IntervalWithLiterals;
|
|
1082
|
+
}
|
|
1083
|
+
declare enum Interval {
|
|
1084
|
+
YEAR = "YEAR",
|
|
1085
|
+
MONTH = "MONTH",
|
|
1086
|
+
WEEK = "WEEK",
|
|
1087
|
+
DAY = "DAY",
|
|
1088
|
+
HOUR = "HOUR",
|
|
1089
|
+
MINUTE = "MINUTE",
|
|
1090
|
+
SECOND = "SECOND"
|
|
1091
|
+
}
|
|
1092
|
+
/** @enumType */
|
|
1093
|
+
type IntervalWithLiterals = Interval | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
1094
|
+
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
1095
|
+
/** 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. */
|
|
1096
|
+
value?: ValueAggregation;
|
|
1097
|
+
/** 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. */
|
|
1098
|
+
range?: RangeAggregation;
|
|
1099
|
+
/** 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`. */
|
|
1100
|
+
scalar?: ScalarAggregation;
|
|
1101
|
+
/** 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. */
|
|
1102
|
+
dateHistogram?: DateHistogramAggregation;
|
|
148
1103
|
/**
|
|
149
|
-
*
|
|
1104
|
+
* Unique, caller-defined aggregation name, returned in `aggregations.results`.
|
|
150
1105
|
* @maxLength 100
|
|
151
1106
|
*/
|
|
152
|
-
|
|
153
|
-
/**
|
|
154
|
-
|
|
155
|
-
* @format EMAIL
|
|
156
|
-
*/
|
|
157
|
-
email?: string | null;
|
|
158
|
-
/** @format GUID */
|
|
159
|
-
contactId?: string;
|
|
1107
|
+
name?: string | null;
|
|
1108
|
+
/** Type of aggregation to perform. The matching aggregation field must be passed. */
|
|
1109
|
+
type?: NestedAggregationTypeWithLiterals;
|
|
160
1110
|
/**
|
|
161
|
-
*
|
|
162
|
-
* @
|
|
1111
|
+
* Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
1112
|
+
* @maxLength 200
|
|
163
1113
|
*/
|
|
164
|
-
|
|
1114
|
+
fieldPath?: string;
|
|
165
1115
|
}
|
|
166
|
-
|
|
1116
|
+
/** @oneof */
|
|
1117
|
+
interface NestedAggregationItemKindOneOf {
|
|
1118
|
+
/** 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. */
|
|
1119
|
+
value?: ValueAggregation;
|
|
1120
|
+
/** 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. */
|
|
1121
|
+
range?: RangeAggregation;
|
|
1122
|
+
/** 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`. */
|
|
1123
|
+
scalar?: ScalarAggregation;
|
|
1124
|
+
/** 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. */
|
|
1125
|
+
dateHistogram?: DateHistogramAggregation;
|
|
1126
|
+
}
|
|
1127
|
+
declare enum AggregationType {
|
|
1128
|
+
/** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
|
|
1129
|
+
VALUE = "VALUE",
|
|
1130
|
+
/** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
|
|
1131
|
+
RANGE = "RANGE",
|
|
1132
|
+
/** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
1133
|
+
SCALAR = "SCALAR",
|
|
1134
|
+
/** 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.). */
|
|
1135
|
+
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
1136
|
+
/** Flattened list of aggregations, where each aggregation is nested within previous one. */
|
|
1137
|
+
NESTED = "NESTED"
|
|
1138
|
+
}
|
|
1139
|
+
/** @enumType */
|
|
1140
|
+
type AggregationTypeWithLiterals = AggregationType | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
1141
|
+
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
|
|
1142
|
+
interface NestedAggregation {
|
|
167
1143
|
/**
|
|
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).
|
|
1144
|
+
* Flattened list of aggregations, where each aggregation is nested within previous one.
|
|
1145
|
+
* @minSize 2
|
|
1146
|
+
* @maxSize 3
|
|
174
1147
|
*/
|
|
175
|
-
|
|
1148
|
+
nestedAggregations?: NestedAggregationItem[];
|
|
176
1149
|
}
|
|
177
|
-
interface
|
|
1150
|
+
interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
1151
|
+
/** Value aggregation configuration. */
|
|
1152
|
+
value?: ValueAggregation;
|
|
178
1153
|
/**
|
|
179
|
-
*
|
|
180
|
-
* @
|
|
1154
|
+
* Unique, caller-defined aggregation name, returned in `aggregations.results`.
|
|
1155
|
+
* @maxLength 100
|
|
181
1156
|
*/
|
|
182
|
-
|
|
1157
|
+
name?: string | null;
|
|
183
1158
|
/**
|
|
184
|
-
*
|
|
185
|
-
* @
|
|
1159
|
+
* Field to aggregate by.
|
|
1160
|
+
* @maxLength 200
|
|
186
1161
|
*/
|
|
187
|
-
|
|
1162
|
+
fieldPath?: string;
|
|
1163
|
+
}
|
|
1164
|
+
/** @oneof */
|
|
1165
|
+
interface GroupByAggregationKindOneOf {
|
|
1166
|
+
/** Value aggregation configuration. */
|
|
1167
|
+
value?: ValueAggregation;
|
|
188
1168
|
}
|
|
189
|
-
interface
|
|
1169
|
+
interface SearchDetails {
|
|
1170
|
+
/** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
|
|
1171
|
+
mode?: ModeWithLiterals;
|
|
190
1172
|
/**
|
|
191
|
-
*
|
|
192
|
-
* @
|
|
1173
|
+
* Search term or expression.
|
|
1174
|
+
* @maxLength 100
|
|
193
1175
|
*/
|
|
194
|
-
|
|
1176
|
+
expression?: string | null;
|
|
195
1177
|
/**
|
|
196
|
-
*
|
|
197
|
-
* @
|
|
198
|
-
* @
|
|
199
|
-
* @maxSize 100
|
|
1178
|
+
* 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`.
|
|
1179
|
+
* @maxLength 200
|
|
1180
|
+
* @maxSize 20
|
|
200
1181
|
*/
|
|
201
|
-
|
|
202
|
-
/**
|
|
203
|
-
|
|
204
|
-
}
|
|
205
|
-
interface BulkInviteToProgramResponse {
|
|
206
|
-
/** Participants created by bulk action */
|
|
207
|
-
results?: BulkInviteToProgramResult[];
|
|
208
|
-
/** Bulk action metadata. */
|
|
209
|
-
bulkActionMetadata?: BulkActionMetadata;
|
|
210
|
-
}
|
|
211
|
-
interface ItemMetadata {
|
|
212
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
213
|
-
id?: string | null;
|
|
214
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
215
|
-
originalIndex?: number;
|
|
216
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
217
|
-
success?: boolean;
|
|
218
|
-
/** Details about the error in case of failure. */
|
|
219
|
-
error?: ApplicationError;
|
|
220
|
-
}
|
|
221
|
-
interface ApplicationError {
|
|
222
|
-
/** Error code. */
|
|
223
|
-
code?: string;
|
|
224
|
-
/** Description of the error. */
|
|
225
|
-
description?: string;
|
|
226
|
-
/** Data related to the error. */
|
|
227
|
-
data?: Record<string, any> | null;
|
|
1182
|
+
fields?: string[];
|
|
1183
|
+
/** 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. */
|
|
1184
|
+
fuzzy?: boolean;
|
|
228
1185
|
}
|
|
229
|
-
|
|
230
|
-
/**
|
|
231
|
-
|
|
232
|
-
/**
|
|
233
|
-
|
|
1186
|
+
declare enum Mode {
|
|
1187
|
+
/** At least one of the search terms must be present. */
|
|
1188
|
+
OR = "OR",
|
|
1189
|
+
/** All search terms must be present. */
|
|
1190
|
+
AND = "AND"
|
|
234
1191
|
}
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
/**
|
|
239
|
-
|
|
240
|
-
/**
|
|
241
|
-
|
|
1192
|
+
/** @enumType */
|
|
1193
|
+
type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
1194
|
+
interface SearchParticipantsResponse {
|
|
1195
|
+
/** Participants matching the search criteria. */
|
|
1196
|
+
participants?: Participant[];
|
|
1197
|
+
/** Paging metadata. */
|
|
1198
|
+
pagingMetadata?: CursorPagingMetadata;
|
|
1199
|
+
/** Aggregation data in case aggregations were requested. */
|
|
1200
|
+
aggregationData?: AggregationData;
|
|
242
1201
|
}
|
|
243
|
-
interface
|
|
1202
|
+
interface CursorPagingMetadata {
|
|
1203
|
+
/** Number of items returned in current page. */
|
|
1204
|
+
count?: number | null;
|
|
1205
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
1206
|
+
cursors?: Cursors;
|
|
244
1207
|
/**
|
|
245
|
-
*
|
|
246
|
-
*
|
|
1208
|
+
* Whether there are more pages to retrieve following the current page.
|
|
1209
|
+
*
|
|
1210
|
+
* + `true`: Another page of results can be retrieved.
|
|
1211
|
+
* + `false`: This is the last page.
|
|
247
1212
|
*/
|
|
248
|
-
|
|
1213
|
+
hasNext?: boolean | null;
|
|
249
1214
|
/**
|
|
250
|
-
*
|
|
251
|
-
*
|
|
1215
|
+
* Total number of items matching the filter.
|
|
1216
|
+
* Available only on the first page of *Search* results, not included in *Query* or *List* results.
|
|
1217
|
+
* If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.
|
|
1218
|
+
* @internal
|
|
252
1219
|
*/
|
|
253
|
-
|
|
1220
|
+
total?: number | null;
|
|
254
1221
|
}
|
|
255
|
-
interface
|
|
1222
|
+
interface AggregationData {
|
|
256
1223
|
/**
|
|
257
|
-
*
|
|
258
|
-
* @
|
|
1224
|
+
* key = aggregation name (as derived from search request).
|
|
1225
|
+
* @maxSize 10000
|
|
259
1226
|
*/
|
|
260
|
-
|
|
1227
|
+
results?: AggregationResults[];
|
|
1228
|
+
}
|
|
1229
|
+
interface ValueAggregationResult {
|
|
261
1230
|
/**
|
|
262
|
-
*
|
|
263
|
-
* @
|
|
264
|
-
* @maxSize 100
|
|
1231
|
+
* Value of the field.
|
|
1232
|
+
* @maxLength 100
|
|
265
1233
|
*/
|
|
266
|
-
|
|
1234
|
+
value?: string;
|
|
1235
|
+
/** Count of entities with this value. */
|
|
1236
|
+
count?: number;
|
|
267
1237
|
}
|
|
268
|
-
interface
|
|
269
|
-
/**
|
|
270
|
-
|
|
1238
|
+
interface RangeAggregationResult {
|
|
1239
|
+
/** Inclusive lower bound of the range. */
|
|
1240
|
+
from?: number | null;
|
|
1241
|
+
/** Exclusive upper bound of the range. */
|
|
1242
|
+
to?: number | null;
|
|
1243
|
+
/** Count of entities in this range. */
|
|
1244
|
+
count?: number;
|
|
271
1245
|
}
|
|
272
|
-
interface
|
|
1246
|
+
interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
1247
|
+
/** Value aggregation results. */
|
|
1248
|
+
values?: ValueResults;
|
|
1249
|
+
/** Range aggregation results. */
|
|
1250
|
+
ranges?: RangeResults;
|
|
1251
|
+
/** Scalar aggregation results. */
|
|
1252
|
+
scalar?: AggregationResultsScalarResult;
|
|
273
1253
|
/**
|
|
274
|
-
*
|
|
275
|
-
* @
|
|
1254
|
+
* User-defined name of aggregation, matches the one provided in request.
|
|
1255
|
+
* @maxLength 100
|
|
276
1256
|
*/
|
|
277
|
-
|
|
1257
|
+
name?: string;
|
|
1258
|
+
/** Type of aggregation that matches result. */
|
|
1259
|
+
type?: AggregationTypeWithLiterals;
|
|
278
1260
|
/**
|
|
279
|
-
*
|
|
280
|
-
* @
|
|
281
|
-
* @minSize 1
|
|
282
|
-
* @maxSize 1000
|
|
1261
|
+
* Field to aggregate by, matches the one provided in request.
|
|
1262
|
+
* @maxLength 200
|
|
283
1263
|
*/
|
|
284
|
-
|
|
285
|
-
/** Return added participants in the response or not. */
|
|
286
|
-
returnEntity?: boolean;
|
|
1264
|
+
fieldPath?: string;
|
|
287
1265
|
}
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
results
|
|
291
|
-
|
|
292
|
-
|
|
1266
|
+
/** @oneof */
|
|
1267
|
+
interface NestedAggregationResultsResultOneOf {
|
|
1268
|
+
/** Value aggregation results. */
|
|
1269
|
+
values?: ValueResults;
|
|
1270
|
+
/** Range aggregation results. */
|
|
1271
|
+
ranges?: RangeResults;
|
|
1272
|
+
/** Scalar aggregation results. */
|
|
1273
|
+
scalar?: AggregationResultsScalarResult;
|
|
293
1274
|
}
|
|
294
|
-
interface
|
|
295
|
-
/**
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
1275
|
+
interface ValueResults {
|
|
1276
|
+
/**
|
|
1277
|
+
* List of value aggregations.
|
|
1278
|
+
* @maxSize 250
|
|
1279
|
+
*/
|
|
1280
|
+
results?: ValueAggregationResult[];
|
|
299
1281
|
}
|
|
300
|
-
interface
|
|
1282
|
+
interface RangeResults {
|
|
301
1283
|
/**
|
|
302
|
-
*
|
|
303
|
-
* @
|
|
304
|
-
* @maxSize 100
|
|
1284
|
+
* List of ranges returned in same order as requested.
|
|
1285
|
+
* @maxSize 50
|
|
305
1286
|
*/
|
|
306
|
-
|
|
1287
|
+
results?: RangeAggregationResult[];
|
|
1288
|
+
}
|
|
1289
|
+
interface AggregationResultsScalarResult {
|
|
1290
|
+
/** Type of scalar aggregation. */
|
|
1291
|
+
type?: ScalarTypeWithLiterals;
|
|
1292
|
+
/** Value of the scalar aggregation. */
|
|
1293
|
+
value?: number;
|
|
1294
|
+
}
|
|
1295
|
+
interface NestedValueAggregationResult {
|
|
307
1296
|
/**
|
|
308
|
-
*
|
|
309
|
-
* @
|
|
1297
|
+
* Value of the field.
|
|
1298
|
+
* @maxLength 1000
|
|
310
1299
|
*/
|
|
311
|
-
|
|
312
|
-
/**
|
|
313
|
-
|
|
1300
|
+
value?: string;
|
|
1301
|
+
/** Nested aggregations. */
|
|
1302
|
+
nestedResults?: NestedAggregationResults;
|
|
314
1303
|
}
|
|
315
|
-
interface
|
|
316
|
-
/**
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
1304
|
+
interface ValueResult {
|
|
1305
|
+
/**
|
|
1306
|
+
* Value of the field.
|
|
1307
|
+
* @maxLength 1000
|
|
1308
|
+
*/
|
|
1309
|
+
value?: string;
|
|
1310
|
+
/** Count of entities with this value. */
|
|
1311
|
+
count?: number | null;
|
|
320
1312
|
}
|
|
321
|
-
interface
|
|
322
|
-
/**
|
|
323
|
-
|
|
324
|
-
/**
|
|
325
|
-
|
|
1313
|
+
interface RangeResult {
|
|
1314
|
+
/** Inclusive lower bound of the range. */
|
|
1315
|
+
from?: number | null;
|
|
1316
|
+
/** Exclusive upper bound of the range. */
|
|
1317
|
+
to?: number | null;
|
|
1318
|
+
/** Count of entities in this range. */
|
|
1319
|
+
count?: number | null;
|
|
326
1320
|
}
|
|
327
|
-
interface
|
|
1321
|
+
interface ScalarResult {
|
|
1322
|
+
/** Value of the scalar aggregation. */
|
|
1323
|
+
value?: number;
|
|
1324
|
+
}
|
|
1325
|
+
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
1326
|
+
/** Value aggregation result. */
|
|
1327
|
+
value?: ValueResult;
|
|
1328
|
+
/** Range aggregation result. */
|
|
1329
|
+
range?: RangeResult;
|
|
1330
|
+
/** Scalar aggregation result. */
|
|
1331
|
+
scalar?: ScalarResult;
|
|
1332
|
+
/** Date histogram aggregation result. */
|
|
1333
|
+
dateHistogram?: ValueResult;
|
|
1334
|
+
}
|
|
1335
|
+
/** @oneof */
|
|
1336
|
+
interface NestedResultValueResultOneOf {
|
|
1337
|
+
/** Value aggregation result. */
|
|
1338
|
+
value?: ValueResult;
|
|
1339
|
+
/** Range aggregation result. */
|
|
1340
|
+
range?: RangeResult;
|
|
1341
|
+
/** Scalar aggregation result. */
|
|
1342
|
+
scalar?: ScalarResult;
|
|
1343
|
+
/** Date histogram aggregation result. */
|
|
1344
|
+
dateHistogram?: ValueResult;
|
|
1345
|
+
}
|
|
1346
|
+
interface Results {
|
|
1347
|
+
/** List of nested aggregations. */
|
|
1348
|
+
results?: Record<string, NestedResultValue>;
|
|
1349
|
+
}
|
|
1350
|
+
interface DateHistogramResult {
|
|
328
1351
|
/**
|
|
329
|
-
*
|
|
330
|
-
* @
|
|
1352
|
+
* Date in ISO 8601 format.
|
|
1353
|
+
* @maxLength 100
|
|
331
1354
|
*/
|
|
332
|
-
|
|
1355
|
+
value?: string;
|
|
1356
|
+
/** Count of documents in the bucket. */
|
|
1357
|
+
count?: number;
|
|
1358
|
+
}
|
|
1359
|
+
interface GroupByValueResults {
|
|
333
1360
|
/**
|
|
334
|
-
*
|
|
335
|
-
* @
|
|
1361
|
+
* List of value aggregations.
|
|
1362
|
+
* @maxSize 1000
|
|
336
1363
|
*/
|
|
337
|
-
|
|
1364
|
+
results?: NestedValueAggregationResult[];
|
|
338
1365
|
}
|
|
339
|
-
interface
|
|
1366
|
+
interface DateHistogramResults {
|
|
340
1367
|
/**
|
|
341
|
-
*
|
|
342
|
-
* @
|
|
1368
|
+
* List of date histogram aggregations.
|
|
1369
|
+
* @maxSize 200
|
|
343
1370
|
*/
|
|
344
|
-
|
|
1371
|
+
results?: DateHistogramResult[];
|
|
1372
|
+
}
|
|
1373
|
+
/**
|
|
1374
|
+
* Results of `NESTED` aggregation type in a flattened form.
|
|
1375
|
+
* Aggregations in resulting array are keyed by requested aggregation `name`.
|
|
1376
|
+
*/
|
|
1377
|
+
interface NestedResults {
|
|
345
1378
|
/**
|
|
346
|
-
*
|
|
347
|
-
* @
|
|
348
|
-
* @maxSize 100
|
|
1379
|
+
* List of nested aggregations.
|
|
1380
|
+
* @maxSize 1000
|
|
349
1381
|
*/
|
|
350
|
-
|
|
1382
|
+
results?: Results[];
|
|
351
1383
|
}
|
|
352
|
-
interface
|
|
1384
|
+
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
1385
|
+
/** Value aggregation results. */
|
|
1386
|
+
values?: ValueResults;
|
|
1387
|
+
/** Range aggregation results. */
|
|
1388
|
+
ranges?: RangeResults;
|
|
1389
|
+
/** Scalar aggregation results. */
|
|
1390
|
+
scalar?: AggregationResultsScalarResult;
|
|
1391
|
+
/** Group by value aggregation results. */
|
|
1392
|
+
groupedByValue?: GroupByValueResults;
|
|
1393
|
+
/** Date histogram aggregation results. */
|
|
1394
|
+
dateHistogram?: DateHistogramResults;
|
|
1395
|
+
/** Nested aggregation results. */
|
|
1396
|
+
nested?: NestedResults;
|
|
353
1397
|
/**
|
|
354
|
-
*
|
|
355
|
-
* @
|
|
1398
|
+
* User-defined name of aggregation as derived from search request.
|
|
1399
|
+
* @maxLength 100
|
|
356
1400
|
*/
|
|
357
|
-
|
|
1401
|
+
name?: string;
|
|
1402
|
+
/** Type of aggregation that must match provided kind as derived from search request. */
|
|
1403
|
+
type?: AggregationTypeWithLiterals;
|
|
1404
|
+
/**
|
|
1405
|
+
* Field to aggregate by as derived from search request.
|
|
1406
|
+
* @maxLength 200
|
|
1407
|
+
*/
|
|
1408
|
+
fieldPath?: string;
|
|
1409
|
+
}
|
|
1410
|
+
/** @oneof */
|
|
1411
|
+
interface AggregationResultsResultOneOf {
|
|
1412
|
+
/** Value aggregation results. */
|
|
1413
|
+
values?: ValueResults;
|
|
1414
|
+
/** Range aggregation results. */
|
|
1415
|
+
ranges?: RangeResults;
|
|
1416
|
+
/** Scalar aggregation results. */
|
|
1417
|
+
scalar?: AggregationResultsScalarResult;
|
|
1418
|
+
/** Group by value aggregation results. */
|
|
1419
|
+
groupedByValue?: GroupByValueResults;
|
|
1420
|
+
/** Date histogram aggregation results. */
|
|
1421
|
+
dateHistogram?: DateHistogramResults;
|
|
1422
|
+
/** Nested aggregation results. */
|
|
1423
|
+
nested?: NestedResults;
|
|
358
1424
|
}
|
|
359
1425
|
interface DomainEvent extends DomainEventBodyOneOf {
|
|
360
1426
|
createdEvent?: EntityCreatedEvent;
|
|
@@ -385,7 +1451,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
385
1451
|
/** If present, indicates the action that triggered the event. */
|
|
386
1452
|
originatedFrom?: string | null;
|
|
387
1453
|
/**
|
|
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
|
|
1454
|
+
* 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
1455
|
* 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
1456
|
*/
|
|
391
1457
|
entityEventSequence?: string | null;
|
|
@@ -399,8 +1465,18 @@ interface DomainEventBodyOneOf {
|
|
|
399
1465
|
}
|
|
400
1466
|
interface EntityCreatedEvent {
|
|
401
1467
|
entityAsJson?: string;
|
|
1468
|
+
/**
|
|
1469
|
+
* Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
|
|
1470
|
+
* @internal
|
|
1471
|
+
*/
|
|
1472
|
+
triggeredByUndelete?: boolean | null;
|
|
402
1473
|
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
403
1474
|
restoreInfo?: RestoreInfo;
|
|
1475
|
+
/**
|
|
1476
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
1477
|
+
* @internal
|
|
1478
|
+
*/
|
|
1479
|
+
additionalMetadataAsJson?: string | null;
|
|
404
1480
|
}
|
|
405
1481
|
interface RestoreInfo {
|
|
406
1482
|
deletedDate?: Date | null;
|
|
@@ -412,14 +1488,48 @@ interface EntityUpdatedEvent {
|
|
|
412
1488
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
413
1489
|
*/
|
|
414
1490
|
currentEntityAsJson?: string;
|
|
1491
|
+
/**
|
|
1492
|
+
* This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
|
|
1493
|
+
* wont populate it / have any reference to it in the API.
|
|
1494
|
+
* The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
|
|
1495
|
+
* the developer should send only the new (current) entity.
|
|
1496
|
+
* An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
|
|
1497
|
+
* Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
|
|
1498
|
+
* @internal
|
|
1499
|
+
* @deprecated
|
|
1500
|
+
*/
|
|
1501
|
+
previousEntityAsJson?: string | null;
|
|
1502
|
+
/**
|
|
1503
|
+
* Map of fully qualified field paths to their previous values for fields that changed.
|
|
1504
|
+
* For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
|
|
1505
|
+
* @internal
|
|
1506
|
+
*/
|
|
1507
|
+
modifiedFields?: Record<string, any>;
|
|
1508
|
+
/**
|
|
1509
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
1510
|
+
* @internal
|
|
1511
|
+
*/
|
|
1512
|
+
additionalMetadataAsJson?: string | null;
|
|
415
1513
|
}
|
|
416
1514
|
interface EntityDeletedEvent {
|
|
1515
|
+
/**
|
|
1516
|
+
* Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
|
|
1517
|
+
* @internal
|
|
1518
|
+
*/
|
|
1519
|
+
movedToTrash?: boolean | null;
|
|
417
1520
|
/** Entity that was deleted. */
|
|
418
1521
|
deletedEntityAsJson?: string | null;
|
|
1522
|
+
/**
|
|
1523
|
+
* Optional domain-specific metadata defined by the API owner, encoded as JSON.
|
|
1524
|
+
* @internal
|
|
1525
|
+
*/
|
|
1526
|
+
additionalMetadataAsJson?: string | null;
|
|
419
1527
|
}
|
|
420
1528
|
interface ActionEvent {
|
|
421
1529
|
bodyAsJson?: string;
|
|
422
1530
|
}
|
|
1531
|
+
interface Empty {
|
|
1532
|
+
}
|
|
423
1533
|
interface MessageEnvelope {
|
|
424
1534
|
/**
|
|
425
1535
|
* App instance ID.
|
|
@@ -435,6 +1545,8 @@ interface MessageEnvelope {
|
|
|
435
1545
|
identity?: IdentificationData;
|
|
436
1546
|
/** Stringify payload. */
|
|
437
1547
|
data?: string;
|
|
1548
|
+
/** Details related to the account */
|
|
1549
|
+
accountInfo?: AccountInfo;
|
|
438
1550
|
}
|
|
439
1551
|
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
440
1552
|
/**
|
|
@@ -492,6 +1604,82 @@ declare enum WebhookIdentityType {
|
|
|
492
1604
|
}
|
|
493
1605
|
/** @enumType */
|
|
494
1606
|
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1607
|
+
interface AccountInfo {
|
|
1608
|
+
/**
|
|
1609
|
+
* ID of the Wix account associated with the event.
|
|
1610
|
+
* @format GUID
|
|
1611
|
+
*/
|
|
1612
|
+
accountId?: string | null;
|
|
1613
|
+
/**
|
|
1614
|
+
* ID of the parent Wix account. Only included when accountId belongs to a child account.
|
|
1615
|
+
* @format GUID
|
|
1616
|
+
*/
|
|
1617
|
+
parentAccountId?: string | null;
|
|
1618
|
+
/**
|
|
1619
|
+
* ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
|
|
1620
|
+
* @format GUID
|
|
1621
|
+
*/
|
|
1622
|
+
siteId?: string | null;
|
|
1623
|
+
}
|
|
1624
|
+
interface ExportParticipantsStatsRequest {
|
|
1625
|
+
/**
|
|
1626
|
+
* program id to export data from
|
|
1627
|
+
* @format GUID
|
|
1628
|
+
*/
|
|
1629
|
+
programId: string;
|
|
1630
|
+
}
|
|
1631
|
+
interface ExportParticipantsStatsResponse {
|
|
1632
|
+
}
|
|
1633
|
+
/** @docsIgnore */
|
|
1634
|
+
type CreateParticipantApplicationErrors = {
|
|
1635
|
+
code?: 'PREMIUM_PLAN_REQUIRED';
|
|
1636
|
+
description?: string;
|
|
1637
|
+
data?: Record<string, any>;
|
|
1638
|
+
} | {
|
|
1639
|
+
code?: 'PARTICIPANTS_LIMIT_EXCEEDED';
|
|
1640
|
+
description?: string;
|
|
1641
|
+
data?: Record<string, any>;
|
|
1642
|
+
};
|
|
1643
|
+
/** @docsIgnore */
|
|
1644
|
+
type BulkCreateParticipantsApplicationErrors = {
|
|
1645
|
+
code?: 'MULTIPLE_PROGRAM_IDS_IN_BULK_CREATE';
|
|
1646
|
+
description?: string;
|
|
1647
|
+
data?: Record<string, any>;
|
|
1648
|
+
} | {
|
|
1649
|
+
code?: 'PREMIUM_PLAN_REQUIRED';
|
|
1650
|
+
description?: string;
|
|
1651
|
+
data?: Record<string, any>;
|
|
1652
|
+
} | {
|
|
1653
|
+
code?: 'PARTICIPANTS_LIMIT_EXCEEDED';
|
|
1654
|
+
description?: string;
|
|
1655
|
+
data?: Record<string, any>;
|
|
1656
|
+
};
|
|
1657
|
+
/** @docsIgnore */
|
|
1658
|
+
type IssueCertificateApplicationErrors = {
|
|
1659
|
+
code?: 'PARTICIPANT_NOT_ACTIVE';
|
|
1660
|
+
description?: string;
|
|
1661
|
+
data?: Record<string, any>;
|
|
1662
|
+
} | {
|
|
1663
|
+
code?: 'NO_CERTIFICATE_REWARD';
|
|
1664
|
+
description?: string;
|
|
1665
|
+
data?: Record<string, any>;
|
|
1666
|
+
} | {
|
|
1667
|
+
code?: 'PARTICIPANT_NOT_COMPLETED_PROGRAM';
|
|
1668
|
+
description?: string;
|
|
1669
|
+
data?: Record<string, any>;
|
|
1670
|
+
};
|
|
1671
|
+
/** @docsIgnore */
|
|
1672
|
+
type BulkUpdateParticipantTagsApplicationErrors = {
|
|
1673
|
+
code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
|
|
1674
|
+
description?: string;
|
|
1675
|
+
data?: Record<string, any>;
|
|
1676
|
+
};
|
|
1677
|
+
/** @docsIgnore */
|
|
1678
|
+
type BulkUpdateParticipantTagsByFilterApplicationErrors = {
|
|
1679
|
+
code?: 'EMPTY_ASSIGN_AND_UNASSIGN_LISTS';
|
|
1680
|
+
description?: string;
|
|
1681
|
+
data?: Record<string, any>;
|
|
1682
|
+
};
|
|
495
1683
|
|
|
496
1684
|
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
497
1685
|
getUrl: (context: any) => string;
|
|
@@ -503,10 +1691,29 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
|
|
|
503
1691
|
__responseType: Q;
|
|
504
1692
|
__originalResponseType: R;
|
|
505
1693
|
};
|
|
506
|
-
declare function
|
|
507
|
-
declare function
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
declare function
|
|
1694
|
+
declare function createParticipant(): __PublicMethodMetaInfo<'POST', {}, CreateParticipantRequest$1, CreateParticipantRequest, CreateParticipantResponse$1, CreateParticipantResponse>;
|
|
1695
|
+
declare function updateParticipant(): __PublicMethodMetaInfo<'PATCH', {
|
|
1696
|
+
participantId: string;
|
|
1697
|
+
}, UpdateParticipantRequest$1, UpdateParticipantRequest, UpdateParticipantResponse$1, UpdateParticipantResponse>;
|
|
1698
|
+
declare function bulkCreateParticipants(): __PublicMethodMetaInfo<'POST', {}, BulkCreateParticipantsRequest$1, BulkCreateParticipantsRequest, BulkCreateParticipantsResponse$1, BulkCreateParticipantsResponse>;
|
|
1699
|
+
declare function bulkCreateParticipantsForAllMembers(): __PublicMethodMetaInfo<'POST', {}, BulkCreateParticipantsForAllMembersRequest$1, BulkCreateParticipantsForAllMembersRequest, BulkCreateParticipantsForAllMembersResponse$1, BulkCreateParticipantsForAllMembersResponse>;
|
|
1700
|
+
declare function deleteParticipant(): __PublicMethodMetaInfo<'DELETE', {
|
|
1701
|
+
participantId: string;
|
|
1702
|
+
}, DeleteParticipantRequest$1, DeleteParticipantRequest, DeleteParticipantResponse$1, DeleteParticipantResponse>;
|
|
1703
|
+
declare function issueCertificate(): __PublicMethodMetaInfo<'POST', {
|
|
1704
|
+
participantId: string;
|
|
1705
|
+
}, IssueCertificateRequest$1, IssueCertificateRequest, IssueCertificateResponse$1, IssueCertificateResponse>;
|
|
1706
|
+
declare function getPremiumStats(): __PublicMethodMetaInfo<'GET', {}, GetPremiumStatsRequest$1, GetPremiumStatsRequest, GetPremiumStatsResponse$1, GetPremiumStatsResponse>;
|
|
1707
|
+
declare function getParticipant(): __PublicMethodMetaInfo<'GET', {
|
|
1708
|
+
participantId: string;
|
|
1709
|
+
}, GetParticipantRequest$1, GetParticipantRequest, GetParticipantResponse$1, GetParticipantResponse>;
|
|
1710
|
+
declare function queryParticipants(): __PublicMethodMetaInfo<'POST', {}, QueryParticipantsRequest$1, QueryParticipantsRequest, QueryParticipantsResponse$1, QueryParticipantsResponse>;
|
|
1711
|
+
declare function getAccessStatus(): __PublicMethodMetaInfo<'GET', {}, GetAccessStatusRequest$1, GetAccessStatusRequest, GetAccessStatusResponse$1, GetAccessStatusResponse>;
|
|
1712
|
+
declare function bulkUpdateParticipantTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateParticipantTagsRequest$1, BulkUpdateParticipantTagsRequest, BulkUpdateParticipantTagsResponse$1, BulkUpdateParticipantTagsResponse>;
|
|
1713
|
+
declare function bulkUpdateParticipantTagsByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateParticipantTagsByFilterRequest$1, BulkUpdateParticipantTagsByFilterRequest, BulkUpdateParticipantTagsByFilterResponse$1, BulkUpdateParticipantTagsByFilterResponse>;
|
|
1714
|
+
declare function searchParticipants(): __PublicMethodMetaInfo<'POST', {}, SearchParticipantsRequest$1, SearchParticipantsRequest, SearchParticipantsResponse$1, SearchParticipantsResponse>;
|
|
1715
|
+
declare function exportParticipantsStats(): __PublicMethodMetaInfo<'GET', {
|
|
1716
|
+
programId: string;
|
|
1717
|
+
}, ExportParticipantsStatsRequest$1, ExportParticipantsStatsRequest, ExportParticipantsStatsResponse$1, ExportParticipantsStatsResponse>;
|
|
511
1718
|
|
|
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 };
|
|
1719
|
+
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 ParticipantAdded as ParticipantAddedOriginal, 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 };
|