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