@wix/auto_sdk_online-programs_online-program-participants 1.0.0

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 (39) hide show
  1. package/build/cjs/index.d.ts +208 -0
  2. package/build/cjs/index.js +7335 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1803 -0
  5. package/build/cjs/index.typings.js +6922 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1205 -0
  8. package/build/cjs/meta.js +5346 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/es/index.d.mts +208 -0
  11. package/build/es/index.mjs +7263 -0
  12. package/build/es/index.mjs.map +1 -0
  13. package/build/es/index.typings.d.mts +1803 -0
  14. package/build/es/index.typings.mjs +6853 -0
  15. package/build/es/index.typings.mjs.map +1 -0
  16. package/build/es/meta.d.mts +1205 -0
  17. package/build/es/meta.mjs +5290 -0
  18. package/build/es/meta.mjs.map +1 -0
  19. package/build/es/package.json +3 -0
  20. package/build/internal/cjs/index.d.ts +208 -0
  21. package/build/internal/cjs/index.js +7335 -0
  22. package/build/internal/cjs/index.js.map +1 -0
  23. package/build/internal/cjs/index.typings.d.ts +1803 -0
  24. package/build/internal/cjs/index.typings.js +6922 -0
  25. package/build/internal/cjs/index.typings.js.map +1 -0
  26. package/build/internal/cjs/meta.d.ts +1205 -0
  27. package/build/internal/cjs/meta.js +5346 -0
  28. package/build/internal/cjs/meta.js.map +1 -0
  29. package/build/internal/es/index.d.mts +208 -0
  30. package/build/internal/es/index.mjs +7263 -0
  31. package/build/internal/es/index.mjs.map +1 -0
  32. package/build/internal/es/index.typings.d.mts +1803 -0
  33. package/build/internal/es/index.typings.mjs +6853 -0
  34. package/build/internal/es/index.typings.mjs.map +1 -0
  35. package/build/internal/es/meta.d.mts +1205 -0
  36. package/build/internal/es/meta.mjs +5290 -0
  37. package/build/internal/es/meta.mjs.map +1 -0
  38. package/meta/package.json +3 -0
  39. package/package.json +54 -0
@@ -0,0 +1,1803 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
3
+ interface Participant {
4
+ /** @format GUID */
5
+ _id?: string;
6
+ member?: Member;
7
+ challenge?: EntitySummary;
8
+ timeFrame?: TimeInterval;
9
+ stepsSummary?: StepsSummary;
10
+ orderIds?: string[];
11
+ transitions?: StateTransition[];
12
+ timezone?: string;
13
+ dateFrame?: DateInterval;
14
+ socialGroupId?: string | null;
15
+ performance?: number;
16
+ joinPath?: JoinPath;
17
+ /** Certificate issued to participant on successful program complete */
18
+ certificate?: Certificate;
19
+ }
20
+ interface StepEvent {
21
+ stepId?: string;
22
+ transition?: ParticipantStepStateTransition;
23
+ }
24
+ interface ParticipantStepStateTransition {
25
+ state?: ParticipantStepStateWithLiterals;
26
+ occurredAt?: Date | null;
27
+ }
28
+ declare enum ParticipantStepState {
29
+ PENDING = "PENDING",
30
+ RUNNING = "RUNNING",
31
+ COMPLETED = "COMPLETED",
32
+ SKIPPED = "SKIPPED",
33
+ CONFIRMED = "CONFIRMED",
34
+ REJECTED = "REJECTED",
35
+ OVERDUE = "OVERDUE",
36
+ FAILED = "FAILED"
37
+ }
38
+ /** @enumType */
39
+ type ParticipantStepStateWithLiterals = ParticipantStepState | 'PENDING' | 'RUNNING' | 'COMPLETED' | 'SKIPPED' | 'CONFIRMED' | 'REJECTED' | 'OVERDUE' | 'FAILED';
40
+ declare enum State {
41
+ JOIN_REQUESTED = "JOIN_REQUESTED",
42
+ INVITED = "INVITED",
43
+ JOIN_REJECTED = "JOIN_REJECTED",
44
+ PAYMENT_REQUESTED = "PAYMENT_REQUESTED",
45
+ PAYMENT_STARTED = "PAYMENT_STARTED",
46
+ JOINED = "JOINED",
47
+ LEFT = "LEFT",
48
+ REMOVED = "REMOVED",
49
+ RUNNING = "RUNNING",
50
+ COMPLETED = "COMPLETED",
51
+ FAILED = "FAILED",
52
+ PAYMENT_STARTED_OFFLINE = "PAYMENT_STARTED_OFFLINE",
53
+ SUSPENDED = "SUSPENDED",
54
+ AUTO_REMOVED = "AUTO_REMOVED"
55
+ }
56
+ /** @enumType */
57
+ type StateWithLiterals = State | 'JOIN_REQUESTED' | 'INVITED' | 'JOIN_REJECTED' | 'PAYMENT_REQUESTED' | 'PAYMENT_STARTED' | 'JOINED' | 'LEFT' | 'REMOVED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'PAYMENT_STARTED_OFFLINE' | 'SUSPENDED' | 'AUTO_REMOVED';
58
+ interface Free {
59
+ }
60
+ interface Added {
61
+ }
62
+ interface SinglePayment {
63
+ orderId?: string;
64
+ }
65
+ interface PaidPlan {
66
+ planIds?: string[];
67
+ }
68
+ interface FreeCoupon {
69
+ couponId?: string;
70
+ }
71
+ interface Member {
72
+ /** @format GUID */
73
+ _id?: string;
74
+ fullName?: string;
75
+ imageUrl?: string | null;
76
+ /** @format GUID */
77
+ contactId?: string | null;
78
+ /** @format GUID */
79
+ userId?: string | null;
80
+ }
81
+ interface EntitySummary {
82
+ _id?: string;
83
+ title?: string | null;
84
+ media?: MediaItem;
85
+ }
86
+ /** Deprecated - Copy this message into your service, do not reference it */
87
+ interface MediaItem extends MediaItemMediaOneOf {
88
+ /** WixMedia image */
89
+ image?: string;
90
+ /** WixMedia video */
91
+ video?: string;
92
+ /** WixMedia document */
93
+ document?: string;
94
+ }
95
+ /** @oneof */
96
+ interface MediaItemMediaOneOf {
97
+ /** WixMedia image */
98
+ image?: string;
99
+ /** WixMedia video */
100
+ video?: string;
101
+ /** WixMedia document */
102
+ document?: string;
103
+ }
104
+ interface FocalPoint {
105
+ /** X-coordinate of the focal point. */
106
+ x?: number;
107
+ /** Y-coordinate of the focal point. */
108
+ y?: number;
109
+ /** crop by height */
110
+ height?: number | null;
111
+ /** crop by width */
112
+ width?: number | null;
113
+ }
114
+ interface TimeInterval {
115
+ start?: Date | null;
116
+ finish?: Date | null;
117
+ }
118
+ interface StepsSummary {
119
+ stepsNumber?: number;
120
+ completedStepsNumber?: number;
121
+ failedStepsNumber?: number;
122
+ postedFeedbacksNumber?: number;
123
+ lastEvent?: StepEvent;
124
+ }
125
+ interface StateTransition {
126
+ state?: StateWithLiterals;
127
+ occurredAt?: Date | null;
128
+ offlineTrxId?: string | null;
129
+ }
130
+ interface DateInterval {
131
+ start?: string;
132
+ finish?: string | null;
133
+ }
134
+ interface JoinPath extends JoinPathPathOneOf {
135
+ free?: Free;
136
+ added?: Added;
137
+ singlePayment?: SinglePayment;
138
+ paidPlan?: PaidPlan;
139
+ freeCoupon?: FreeCoupon;
140
+ }
141
+ /** @oneof */
142
+ interface JoinPathPathOneOf {
143
+ free?: Free;
144
+ added?: Added;
145
+ singlePayment?: SinglePayment;
146
+ paidPlan?: PaidPlan;
147
+ freeCoupon?: FreeCoupon;
148
+ }
149
+ interface Certificate {
150
+ /**
151
+ * when certificate was issued, UTC
152
+ * @readonly
153
+ */
154
+ issuedDate?: Date | null;
155
+ }
156
+ interface QueryParticipantsRequest {
157
+ paging?: Paging;
158
+ /** @format GUID */
159
+ challengeId: string;
160
+ sorting?: QueryParticipantsRequestSorting;
161
+ filter?: ParticipantsFilter;
162
+ }
163
+ interface ParticipantJoinDate {
164
+ start?: string | null;
165
+ end?: string | null;
166
+ }
167
+ declare enum ParticipationState {
168
+ NotStarted = "NotStarted",
169
+ InProgress = "InProgress",
170
+ Finished = "Finished",
171
+ Suspended = "Suspended",
172
+ AutoRemoved = "AutoRemoved"
173
+ }
174
+ /** @enumType */
175
+ type ParticipationStateWithLiterals = ParticipationState | 'NotStarted' | 'InProgress' | 'Finished' | 'Suspended' | 'AutoRemoved';
176
+ interface ParticipantPerformance {
177
+ /** @max 100 */
178
+ start?: number | null;
179
+ /** @max 100 */
180
+ end?: number | null;
181
+ }
182
+ declare enum QueryParticipantsRequestJoinPath {
183
+ UNKNOWN_JOIN_PATH = "UNKNOWN_JOIN_PATH",
184
+ FREE = "FREE",
185
+ ADDED = "ADDED",
186
+ SINGLE_PAYMENT = "SINGLE_PAYMENT",
187
+ PAID_PLAN = "PAID_PLAN"
188
+ }
189
+ /** @enumType */
190
+ type QueryParticipantsRequestJoinPathWithLiterals = QueryParticipantsRequestJoinPath | 'UNKNOWN_JOIN_PATH' | 'FREE' | 'ADDED' | 'SINGLE_PAYMENT' | 'PAID_PLAN';
191
+ declare enum QueryParticipantsRequestSortingCriterion {
192
+ DEFAULT = "DEFAULT",
193
+ JOIN_DATE = "JOIN_DATE",
194
+ NAME = "NAME",
195
+ LAST_EVENT = "LAST_EVENT",
196
+ PERFORMANCE = "PERFORMANCE"
197
+ }
198
+ /** @enumType */
199
+ type QueryParticipantsRequestSortingCriterionWithLiterals = QueryParticipantsRequestSortingCriterion | 'DEFAULT' | 'JOIN_DATE' | 'NAME' | 'LAST_EVENT' | 'PERFORMANCE';
200
+ declare enum QueryParticipantsRequestSortingOrder {
201
+ ORDER_DEFAULT = "ORDER_DEFAULT",
202
+ ORDER_ASC = "ORDER_ASC",
203
+ ORDER_DESC = "ORDER_DESC"
204
+ }
205
+ /** @enumType */
206
+ type QueryParticipantsRequestSortingOrderWithLiterals = QueryParticipantsRequestSortingOrder | 'ORDER_DEFAULT' | 'ORDER_ASC' | 'ORDER_DESC';
207
+ interface Paging {
208
+ /** Number of items to load. */
209
+ limit?: number | null;
210
+ /** Number of items to skip in the current sort order. */
211
+ offset?: number | null;
212
+ }
213
+ interface QueryParticipantsRequestSorting {
214
+ criterion?: QueryParticipantsRequestSortingCriterionWithLiterals;
215
+ order?: QueryParticipantsRequestSortingOrderWithLiterals;
216
+ }
217
+ interface ParticipantsFilter {
218
+ /** @format GUID */
219
+ memberIds?: string[] | null;
220
+ memberName?: string | null;
221
+ states?: StateWithLiterals[];
222
+ joinedAt?: ParticipantJoinDate;
223
+ participationStates?: ParticipationStateWithLiterals[];
224
+ performance?: ParticipantPerformance[];
225
+ joinPath?: QueryParticipantsRequestJoinPathWithLiterals;
226
+ }
227
+ interface QueryParticipantsResponse {
228
+ totalCount?: number;
229
+ participants?: Participant[];
230
+ }
231
+ interface ListParticipantsRequest {
232
+ paging?: Paging;
233
+ /** @format GUID */
234
+ challengeId: string;
235
+ /**
236
+ * @format GUID
237
+ * @deprecated
238
+ */
239
+ memberId?: string | null;
240
+ states?: StateWithLiterals[];
241
+ memberIds?: string[] | null;
242
+ /** @deprecated */
243
+ sortingCriterion?: SortingCriterionWithLiterals;
244
+ /** @minLength 2 */
245
+ memberName?: string | null;
246
+ sorting?: Sorting;
247
+ }
248
+ declare enum SortingCriterion {
249
+ DEFAULT = "DEFAULT",
250
+ JOIN_DATE = "JOIN_DATE",
251
+ NAME = "NAME",
252
+ LAST_EVENT = "LAST_EVENT",
253
+ PERFORMANCE = "PERFORMANCE"
254
+ }
255
+ /** @enumType */
256
+ type SortingCriterionWithLiterals = SortingCriterion | 'DEFAULT' | 'JOIN_DATE' | 'NAME' | 'LAST_EVENT' | 'PERFORMANCE';
257
+ declare enum SortingOrder {
258
+ ORDER_DEFAULT = "ORDER_DEFAULT",
259
+ ORDER_ASC = "ORDER_ASC",
260
+ ORDER_DESC = "ORDER_DESC"
261
+ }
262
+ /** @enumType */
263
+ type SortingOrderWithLiterals = SortingOrder | 'ORDER_DEFAULT' | 'ORDER_ASC' | 'ORDER_DESC';
264
+ interface Sorting {
265
+ criterion?: SortingCriterionWithLiterals;
266
+ order?: SortingOrderWithLiterals;
267
+ }
268
+ interface ListParticipantsResponse {
269
+ totalCount?: number;
270
+ participants?: Participant[];
271
+ }
272
+ interface JoinParticipantRequest {
273
+ /** @format GUID */
274
+ challengeId: string;
275
+ /**
276
+ * ignored, taken from callScope instead
277
+ * @format GUID
278
+ * @deprecated ignored, taken from callScope instead
279
+ * @targetRemovalDate 2024-09-01
280
+ */
281
+ memberId?: string;
282
+ timeZone?: string;
283
+ /** @format GUID */
284
+ actionId?: string;
285
+ startDate?: string | null;
286
+ }
287
+ interface JoinParticipantResponse {
288
+ /** @format GUID */
289
+ participantId?: string;
290
+ /** @format GUID */
291
+ actionId?: string;
292
+ participant?: Participant;
293
+ }
294
+ interface ParticipantJoined {
295
+ participant?: Participant;
296
+ /**
297
+ * user id for program owner
298
+ * @format GUID
299
+ */
300
+ ownerId?: string;
301
+ /**
302
+ * owner's contact id
303
+ * @format GUID
304
+ */
305
+ ownerContactId?: string;
306
+ /** paid price for the program. */
307
+ payment?: Price;
308
+ }
309
+ interface Price {
310
+ /** @format DECIMAL_VALUE */
311
+ amount?: string;
312
+ /** @format CURRENCY */
313
+ currency?: string;
314
+ }
315
+ /** Add participant */
316
+ interface AddParticipantRequest {
317
+ /** @format GUID */
318
+ challengeId: string;
319
+ /** @format GUID */
320
+ memberId?: string;
321
+ /** @format GUID */
322
+ actionId?: string;
323
+ }
324
+ interface AddParticipantResponse {
325
+ participant?: Participant;
326
+ /** @format GUID */
327
+ actionId?: string;
328
+ }
329
+ /** Add participants */
330
+ interface AddParticipantsRequest {
331
+ /** @format GUID */
332
+ challengeId: string;
333
+ /**
334
+ * @format GUID
335
+ * @maxSize 1000
336
+ */
337
+ memberIds?: string[];
338
+ /** @format GUID */
339
+ actionId?: string;
340
+ }
341
+ interface AddParticipantsResponse {
342
+ participants?: Participant[];
343
+ /** @format GUID */
344
+ actionId?: string;
345
+ }
346
+ interface AddAllParticipantRequest {
347
+ /** @format GUID */
348
+ challengeId: string;
349
+ /** @format GUID */
350
+ excludeIds?: string[];
351
+ }
352
+ interface AddAllParticipantResponse {
353
+ }
354
+ interface CreateJoinRequestRequest {
355
+ /** @format GUID */
356
+ challengeId: string;
357
+ /** @format GUID */
358
+ memberId?: string;
359
+ timeZone?: string;
360
+ /** @format GUID */
361
+ actionId?: string;
362
+ startDate?: string | null;
363
+ }
364
+ interface CreateJoinRequestResponse {
365
+ /** @format GUID */
366
+ participantId?: string;
367
+ /** @format GUID */
368
+ approvalRequestId?: string;
369
+ /** @format GUID */
370
+ actionId?: string;
371
+ participant?: Participant;
372
+ }
373
+ interface InviteParticipantsRequest {
374
+ /** @format GUID */
375
+ challengeId: string;
376
+ memberIds?: string[];
377
+ /** @format GUID */
378
+ actionId?: string;
379
+ }
380
+ interface InviteParticipantsResponse {
381
+ invitations?: InvitationDetails[];
382
+ /** @format GUID */
383
+ actionId?: string;
384
+ }
385
+ interface InvitationDetails {
386
+ /** @format GUID */
387
+ participantId?: string;
388
+ /** @format GUID */
389
+ approvalRequestId?: string;
390
+ }
391
+ interface InviteAllParticipantsRequest {
392
+ /** @format GUID */
393
+ challengeId: string;
394
+ /** @format GUID */
395
+ excludeIds?: string[];
396
+ }
397
+ interface InviteAllParticipantsResponse {
398
+ }
399
+ interface GetParticipantRequest {
400
+ /** @format GUID */
401
+ challengeId: string;
402
+ /** @format GUID */
403
+ participantId: string;
404
+ }
405
+ interface GetParticipantResponse {
406
+ participant?: Participant;
407
+ }
408
+ interface UpdateParticipantRequest extends UpdateParticipantRequestUpdateOneOf {
409
+ startDate?: string;
410
+ /** @format GUID */
411
+ challengeId: string;
412
+ /** @format GUID */
413
+ participantId: string;
414
+ /** @format GUID */
415
+ actionId?: string;
416
+ }
417
+ /** @oneof */
418
+ interface UpdateParticipantRequestUpdateOneOf {
419
+ startDate?: string;
420
+ }
421
+ interface UpdateParticipantResponse {
422
+ participant?: Participant;
423
+ /** @format GUID */
424
+ actionId?: string;
425
+ }
426
+ interface DeleteParticipantRequest {
427
+ /** @format GUID */
428
+ challengeId: string;
429
+ /** @format GUID */
430
+ participantId: string;
431
+ /** @format GUID */
432
+ actionId?: string;
433
+ }
434
+ interface DeleteParticipantResponse {
435
+ /** @format GUID */
436
+ actionId?: string;
437
+ }
438
+ interface ReviveParticipantRequest {
439
+ /** @format GUID */
440
+ challengeId: string;
441
+ /** @format GUID */
442
+ participantId: string;
443
+ /** @format GUID */
444
+ actionId?: string;
445
+ }
446
+ interface ReviveParticipantResponse {
447
+ participant?: Participant;
448
+ /** @format GUID */
449
+ actionId?: string;
450
+ }
451
+ interface ResetParticipantProgressRequest {
452
+ /** @format GUID */
453
+ challengeId: string;
454
+ /** @format GUID */
455
+ participantId: string;
456
+ timeZone?: string;
457
+ startDate?: string | null;
458
+ /** @format GUID */
459
+ actionId?: string;
460
+ }
461
+ interface ResetParticipantProgressResponse {
462
+ participant?: Participant;
463
+ /** @format GUID */
464
+ actionId?: string;
465
+ }
466
+ interface IssueParticipantCertificateRequest {
467
+ /**
468
+ * Participant to issue manually certificate
469
+ * @format GUID
470
+ */
471
+ participantId: string;
472
+ /**
473
+ * Program id. TODO: really bad to have it here, needed for url
474
+ * @format GUID
475
+ */
476
+ challengeId: string;
477
+ }
478
+ interface IssueParticipantCertificateResponse {
479
+ /** Updated participant */
480
+ participant?: Participant;
481
+ }
482
+ interface IssueCertificateRequest {
483
+ /**
484
+ * Participant to get certificate
485
+ * @format GUID
486
+ */
487
+ participantId: string;
488
+ /**
489
+ * Program id. TODO: really bad to have it here, needed for url
490
+ * @format GUID
491
+ */
492
+ challengeId: string;
493
+ }
494
+ interface IssueCertificateResponse {
495
+ /** Updated participant */
496
+ participant?: Participant;
497
+ }
498
+ interface GetCertificateRequest {
499
+ /**
500
+ * Participant to get certificate
501
+ * @format GUID
502
+ */
503
+ participantId: string;
504
+ /**
505
+ * Program id. TODO: really bad to have it here, needed for url
506
+ * @format GUID
507
+ */
508
+ challengeId: string;
509
+ }
510
+ interface GetCertificateResponse {
511
+ /**
512
+ * URL on media to get certificate
513
+ * @format WEB_URL
514
+ */
515
+ certificateUrl?: string;
516
+ }
517
+ interface CreatePaymentOrderRequest {
518
+ /** @format GUID */
519
+ challengeId: string;
520
+ /** @format GUID */
521
+ participantId: string;
522
+ /** @format GUID */
523
+ actionId?: string;
524
+ timeZone?: string | null;
525
+ startDate?: string | null;
526
+ paymentType?: PaymentTypeWithLiterals;
527
+ }
528
+ declare enum PaymentType {
529
+ SINGLE_PAYMENT = "SINGLE_PAYMENT",
530
+ PAID_PLANS = "PAID_PLANS"
531
+ }
532
+ /** @enumType */
533
+ type PaymentTypeWithLiterals = PaymentType | 'SINGLE_PAYMENT' | 'PAID_PLANS';
534
+ interface CreatePaymentOrderResponse {
535
+ /** @format GUID */
536
+ orderId?: string;
537
+ /** @format GUID */
538
+ actionId?: string;
539
+ participant?: Participant;
540
+ }
541
+ interface ApplyCouponToOrderRequest {
542
+ /** @format GUID */
543
+ challengeId: string;
544
+ /** @format GUID */
545
+ participantId: string;
546
+ /** @format GUID */
547
+ orderId: string;
548
+ couponCode: string;
549
+ /** @format GUID */
550
+ actionId?: string;
551
+ }
552
+ interface ApplyCouponToOrderResponse {
553
+ /** @format GUID */
554
+ couponId?: string;
555
+ subTotal?: string;
556
+ discount?: string;
557
+ total?: string;
558
+ }
559
+ interface RemoveCouponFromOrderRequest {
560
+ /** @format GUID */
561
+ challengeId: string;
562
+ /** @format GUID */
563
+ participantId: string;
564
+ /** @format GUID */
565
+ orderId: string;
566
+ /** @format GUID */
567
+ couponId: string;
568
+ /** @format GUID */
569
+ actionId?: string;
570
+ }
571
+ interface RemoveCouponFromOrderResponse {
572
+ total?: string;
573
+ }
574
+ interface ListParticipantStepsRequest {
575
+ /** @format GUID */
576
+ challengeId: string;
577
+ /** @format GUID */
578
+ participantId: string;
579
+ parentId?: string;
580
+ timeInterval?: TimeInterval;
581
+ dateInterval?: DateInterval;
582
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
583
+ }
584
+ declare enum DescriptionFieldSet {
585
+ /** title and detailed description. */
586
+ EXTENDED = "EXTENDED",
587
+ /** title only. */
588
+ STANDARD = "STANDARD"
589
+ }
590
+ /** @enumType */
591
+ type DescriptionFieldSetWithLiterals = DescriptionFieldSet | 'EXTENDED' | 'STANDARD';
592
+ interface ListParticipantStepsResponse {
593
+ steps?: ParticipantStep[];
594
+ }
595
+ interface ParticipantStep {
596
+ _id?: string;
597
+ source?: ChallengeStep;
598
+ timeFrame?: TimeInterval;
599
+ feedback?: Feedback;
600
+ transitions?: ParticipantStepStateTransition[];
601
+ dateFrame?: DateInterval;
602
+ quizSubmission?: QuizSubmission;
603
+ }
604
+ interface FeedbackItem extends FeedbackItemValueOneOf {
605
+ number?: number | null;
606
+ text?: string | null;
607
+ media?: MediaItems;
608
+ choice?: FeedbackItemChoice;
609
+ quantity?: Quantity;
610
+ multiSelect?: Choices;
611
+ /** @format GUID */
612
+ feedbackItemSettingsId?: string;
613
+ }
614
+ /** @oneof */
615
+ interface FeedbackItemValueOneOf {
616
+ number?: number | null;
617
+ text?: string | null;
618
+ media?: MediaItems;
619
+ choice?: FeedbackItemChoice;
620
+ quantity?: Quantity;
621
+ multiSelect?: Choices;
622
+ }
623
+ interface MediaItems {
624
+ mediaItems?: MediaItem[];
625
+ }
626
+ interface FeedbackItemChoice {
627
+ choiceId?: string;
628
+ }
629
+ interface Quantity {
630
+ unitName?: string;
631
+ amount?: number;
632
+ }
633
+ interface Choices {
634
+ choiceIds?: string[];
635
+ }
636
+ interface ChallengeStep {
637
+ _id?: string;
638
+ settings?: ChallengeStepSettings;
639
+ /**
640
+ * @format GUID
641
+ * @deprecated
642
+ */
643
+ recurrenceSourceId?: string | null;
644
+ createdAt?: Date | null;
645
+ updatedAt?: Date | null;
646
+ /**
647
+ * @format GUID
648
+ * @readonly
649
+ */
650
+ sectionId?: string | null;
651
+ }
652
+ interface GeneralSettings extends GeneralSettingsStepTypeOneOf {
653
+ individual?: IndividualSettings;
654
+ /** @deprecated */
655
+ group?: GroupSettings;
656
+ quiz?: QuizSettings;
657
+ video?: VideoStepSettings;
658
+ /** steps description: title, details, image and etc. */
659
+ description?: ObjectDescription;
660
+ duration?: TimeDuration;
661
+ /** @deprecated */
662
+ recurrenceSettings?: RecurrenceSettings;
663
+ }
664
+ /** @oneof */
665
+ interface GeneralSettingsStepTypeOneOf {
666
+ individual?: IndividualSettings;
667
+ /** @deprecated */
668
+ group?: GroupSettings;
669
+ quiz?: QuizSettings;
670
+ video?: VideoStepSettings;
671
+ }
672
+ interface ObjectDescription {
673
+ /** @maxLength 150 */
674
+ title?: string | null;
675
+ /** @maxLength 2000 */
676
+ details?: string | null;
677
+ media?: MediaItem;
678
+ }
679
+ interface IndividualSettings {
680
+ /** should be renamed, it's a flag whether the questionnaire section is enabled. */
681
+ confirmationRequired?: boolean;
682
+ /** feedback list settings. */
683
+ feedbackSettings?: FeedbackItemSettings[];
684
+ /** whether the quiz section in enabled. */
685
+ showQuiz?: boolean;
686
+ /** quiz list settings. */
687
+ quizSettings?: FeedbackItemSettings[];
688
+ }
689
+ interface FeedbackItemSettings {
690
+ _id?: string;
691
+ type?: FeedbackItemType;
692
+ question?: string;
693
+ isRequired?: boolean;
694
+ correctAnswerMessage?: string | null;
695
+ wrongAnswerMessage?: string | null;
696
+ }
697
+ interface NumericFeedbackItem {
698
+ /** @min 1 */
699
+ maxValue?: number;
700
+ }
701
+ interface TextFeedbackItem {
702
+ }
703
+ interface MediaFeedbackItem {
704
+ }
705
+ interface MultipleChoiceFeedbackItem {
706
+ choices?: Choice[];
707
+ }
708
+ declare enum ChoiceRightness {
709
+ NEUTRAL = "NEUTRAL",
710
+ RIGHT = "RIGHT",
711
+ WRONG = "WRONG"
712
+ }
713
+ /** @enumType */
714
+ type ChoiceRightnessWithLiterals = ChoiceRightness | 'NEUTRAL' | 'RIGHT' | 'WRONG';
715
+ interface Choice {
716
+ _id?: string;
717
+ description?: ObjectDescription;
718
+ rightness?: ChoiceRightnessWithLiterals;
719
+ }
720
+ interface QuantityFeedbackItem {
721
+ unitName?: string | null;
722
+ amount?: number;
723
+ }
724
+ interface FeedbackItemType extends FeedbackItemTypeTypeOneOf {
725
+ numeric?: NumericFeedbackItem;
726
+ text?: TextFeedbackItem;
727
+ media?: MediaFeedbackItem;
728
+ multipleChoice?: MultipleChoiceFeedbackItem;
729
+ quantity?: QuantityFeedbackItem;
730
+ multiSelect?: MultipleChoiceFeedbackItem;
731
+ }
732
+ /** @oneof */
733
+ interface FeedbackItemTypeTypeOneOf {
734
+ numeric?: NumericFeedbackItem;
735
+ text?: TextFeedbackItem;
736
+ media?: MediaFeedbackItem;
737
+ multipleChoice?: MultipleChoiceFeedbackItem;
738
+ quantity?: QuantityFeedbackItem;
739
+ multiSelect?: MultipleChoiceFeedbackItem;
740
+ }
741
+ interface GroupSettings {
742
+ completionCriteria?: CompletionCriteria;
743
+ }
744
+ interface CompletionCriteria {
745
+ completedSteps?: QuantityCriterion;
746
+ completedMilestones?: QuantityCriterion;
747
+ scoredPoints?: MinThreshold;
748
+ }
749
+ interface QuantityCriterion extends QuantityCriterionCriterionOneOf {
750
+ all?: All;
751
+ minThreshold?: MinThreshold;
752
+ }
753
+ /** @oneof */
754
+ interface QuantityCriterionCriterionOneOf {
755
+ all?: All;
756
+ minThreshold?: MinThreshold;
757
+ }
758
+ interface All {
759
+ }
760
+ interface MinThreshold {
761
+ /** @min 1 */
762
+ value?: number;
763
+ }
764
+ interface QuizSettings {
765
+ quizId?: string;
766
+ questionCount?: number;
767
+ passingGrade?: number | null;
768
+ migrationDetails?: QuizMigrationDetails;
769
+ }
770
+ declare enum QuizType {
771
+ QUIZ = "QUIZ",
772
+ QUESTIONNAIRE = "QUESTIONNAIRE"
773
+ }
774
+ /** @enumType */
775
+ type QuizTypeWithLiterals = QuizType | 'QUIZ' | 'QUESTIONNAIRE';
776
+ interface QuizMigrationDetails {
777
+ sourceStepId?: string;
778
+ show?: boolean;
779
+ quizType?: QuizTypeWithLiterals;
780
+ }
781
+ interface VideoStepSettings extends VideoStepSettingsVideoSourceOneOf {
782
+ wixVideo?: WixVideo;
783
+ video?: string;
784
+ requiredCompletionPercentage?: number;
785
+ coverImage?: string;
786
+ durationInMilliseconds?: number | null;
787
+ deleted?: boolean;
788
+ }
789
+ /** @oneof */
790
+ interface VideoStepSettingsVideoSourceOneOf {
791
+ wixVideo?: WixVideo;
792
+ video?: string;
793
+ }
794
+ interface WixVideo {
795
+ /** @format GUID */
796
+ _id?: string;
797
+ paid?: boolean;
798
+ }
799
+ interface VideoResolution {
800
+ /** Video URL. */
801
+ url?: string;
802
+ /** Video height. */
803
+ height?: number;
804
+ /** Video width. */
805
+ width?: number;
806
+ /** Video format for example, mp4, hls. */
807
+ format?: string;
808
+ }
809
+ interface TimeDuration {
810
+ unit?: DurationUnitWithLiterals;
811
+ value?: number;
812
+ }
813
+ declare enum DurationUnit {
814
+ WEEKS = "WEEKS",
815
+ DAYS = "DAYS",
816
+ HOURS = "HOURS",
817
+ MINUTES = "MINUTES"
818
+ }
819
+ /** @enumType */
820
+ type DurationUnitWithLiterals = DurationUnit | 'WEEKS' | 'DAYS' | 'HOURS' | 'MINUTES';
821
+ interface RecurrenceSettings {
822
+ schedules?: RecurrenceSchedule[];
823
+ /** @min 1 */
824
+ recurrencesCount?: number | null;
825
+ }
826
+ interface RecurrenceSchedule {
827
+ startDelay?: TimeDuration;
828
+ interval?: TimeDuration;
829
+ }
830
+ interface EmbeddingSettings {
831
+ /** step start delay. */
832
+ startConditions?: StartCondition[];
833
+ /** @deprecated */
834
+ isMilestone?: boolean;
835
+ /** @deprecated */
836
+ points?: number | null;
837
+ }
838
+ interface StartCondition {
839
+ /** whether the step should start on join. */
840
+ dependency?: StepDependency;
841
+ /** step delay regarding the challenge start. */
842
+ delay?: TimeDuration;
843
+ }
844
+ interface StepDependency extends StepDependencyDependencyTypeOneOf {
845
+ container?: Container;
846
+ /** @deprecated */
847
+ step?: Step;
848
+ }
849
+ /** @oneof */
850
+ interface StepDependencyDependencyTypeOneOf {
851
+ container?: Container;
852
+ /** @deprecated */
853
+ step?: Step;
854
+ }
855
+ interface Container {
856
+ }
857
+ interface Step {
858
+ stepId?: string;
859
+ }
860
+ interface ChallengeStepSettings {
861
+ general?: GeneralSettings;
862
+ embedding?: EmbeddingSettings;
863
+ }
864
+ interface Feedback {
865
+ items?: FeedbackItem[];
866
+ createdAt?: Date | null;
867
+ updatedAt?: Date | null;
868
+ quiz?: FeedbackItem[];
869
+ }
870
+ interface QuizSubmission {
871
+ quizSubmissionId?: string;
872
+ score?: number | null;
873
+ grade?: number | null;
874
+ rightAnswers?: number | null;
875
+ passingGrade?: number | null;
876
+ }
877
+ interface GetParticipantStepRequest {
878
+ /** @format GUID */
879
+ challengeId: string;
880
+ /** @format GUID */
881
+ participantId: string;
882
+ stepId: string;
883
+ timeInterval?: TimeInterval;
884
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
885
+ }
886
+ interface GetParticipantStepResponse {
887
+ step?: ParticipantStep;
888
+ subSteps?: ParticipantStep[];
889
+ }
890
+ interface ResolveParticipantStepRequest {
891
+ /** @format GUID */
892
+ challengeId: string;
893
+ /** @format GUID */
894
+ participantId: string;
895
+ stepId: string;
896
+ status?: ResolutionStatusWithLiterals;
897
+ feedback?: Feedback;
898
+ actionId?: string;
899
+ /** @format GUID */
900
+ quizSubmissionId?: string | null;
901
+ }
902
+ declare enum ResolutionStatus {
903
+ COMPLETED = "COMPLETED",
904
+ SKIPPED = "SKIPPED",
905
+ UNDO = "UNDO",
906
+ QUIZ_SUBMIT = "QUIZ_SUBMIT"
907
+ }
908
+ /** @enumType */
909
+ type ResolutionStatusWithLiterals = ResolutionStatus | 'COMPLETED' | 'SKIPPED' | 'UNDO' | 'QUIZ_SUBMIT';
910
+ interface ResolveParticipantStepResponse {
911
+ step?: ParticipantStep;
912
+ /** @format GUID */
913
+ actionId?: string;
914
+ }
915
+ interface StepResolved {
916
+ challengeId?: string;
917
+ participantId?: string;
918
+ memberId?: string;
919
+ stepTitle?: string;
920
+ participantStepId?: string;
921
+ challengeStepId?: string;
922
+ /** TODO why it is repeated? */
923
+ feedback?: Feedback[];
924
+ /** Title of the program. Used in Notifications */
925
+ programName?: string;
926
+ /**
927
+ * user id for program owner
928
+ * @format GUID
929
+ */
930
+ ownerId?: string;
931
+ /**
932
+ * owner's contact id
933
+ * @format GUID
934
+ */
935
+ ownerContactId?: string;
936
+ /**
937
+ * participants contact
938
+ * @format GUID
939
+ */
940
+ participantContactId?: string;
941
+ /** info about quiz submission in that step */
942
+ quizSubmissionData?: QuizSubmissionData;
943
+ /** info about if participant completed step successfully or not */
944
+ status?: StatusWithLiterals;
945
+ }
946
+ interface QuizSubmissionData {
947
+ /** @format GUID */
948
+ submissionId?: string | null;
949
+ earnedScore?: number | null;
950
+ passingGrade?: number | null;
951
+ }
952
+ declare enum Status {
953
+ /** step completed */
954
+ COMPLETED = "COMPLETED",
955
+ /** participant failed to resolve step */
956
+ FAILED = "FAILED"
957
+ }
958
+ /** @enumType */
959
+ type StatusWithLiterals = Status | 'COMPLETED' | 'FAILED';
960
+ interface UpdateStepFeedbackRequest {
961
+ /** @format GUID */
962
+ challengeId: string;
963
+ /** @format GUID */
964
+ participantId: string;
965
+ stepId: string;
966
+ feedback?: Feedback;
967
+ /** @format GUID */
968
+ actionId?: string;
969
+ }
970
+ interface UpdateStepFeedbackResponse {
971
+ step?: ParticipantStep;
972
+ /** @format GUID */
973
+ actionId?: string;
974
+ }
975
+ interface GetMediaUploadInfoRequest {
976
+ /** @format GUID */
977
+ challengeId: string;
978
+ /** @format GUID */
979
+ participantId: string;
980
+ fileName?: string;
981
+ }
982
+ interface GetMediaUploadInfoResponse {
983
+ uploadUrl?: string;
984
+ uploadToken?: string;
985
+ }
986
+ interface ListParticipantSectionsRequest {
987
+ /** @format GUID */
988
+ challengeId: string;
989
+ /** @format GUID */
990
+ participantId: string;
991
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
992
+ }
993
+ interface ListParticipantSectionsResponse {
994
+ sections?: ParticipantSection[];
995
+ }
996
+ interface ParticipantSection {
997
+ _id?: string;
998
+ source?: ChallengeSection;
999
+ steps?: ParticipantStep[];
1000
+ transitions?: ParticipantSectionStateTransition[];
1001
+ progress?: Progress;
1002
+ }
1003
+ interface WaitingDate {
1004
+ startDate?: string;
1005
+ }
1006
+ interface WaitingDependency {
1007
+ sectionId?: string;
1008
+ }
1009
+ interface Running {
1010
+ dateInterval?: DateInterval;
1011
+ }
1012
+ interface Completed {
1013
+ }
1014
+ interface Overdue {
1015
+ }
1016
+ interface ChallengeSection {
1017
+ /** challenge section id. */
1018
+ _id?: string;
1019
+ /** challenge section settings. */
1020
+ settings?: Settings;
1021
+ createdAt?: Date | null;
1022
+ updatedAt?: Date | null;
1023
+ /** list of challenge steps laying inside the section. */
1024
+ steps?: ChallengeStep[];
1025
+ }
1026
+ interface Settings {
1027
+ /** section description(title, details, image...) */
1028
+ description?: ObjectDescription;
1029
+ /** condition for the section start. */
1030
+ startCondition?: StartCondition;
1031
+ }
1032
+ interface ParticipantSectionStateTransition extends ParticipantSectionStateTransitionStateOneOf {
1033
+ waitingDate?: WaitingDate;
1034
+ waitingDependency?: WaitingDependency;
1035
+ running?: Running;
1036
+ completed?: Completed;
1037
+ overdue?: Overdue;
1038
+ occurredAt?: Date | null;
1039
+ }
1040
+ /** @oneof */
1041
+ interface ParticipantSectionStateTransitionStateOneOf {
1042
+ waitingDate?: WaitingDate;
1043
+ waitingDependency?: WaitingDependency;
1044
+ running?: Running;
1045
+ completed?: Completed;
1046
+ overdue?: Overdue;
1047
+ }
1048
+ interface Progress {
1049
+ nTotalSteps?: string;
1050
+ nCompletedSteps?: string;
1051
+ }
1052
+ interface GetParticipantSectionRequest {
1053
+ /** @format GUID */
1054
+ challengeId: string;
1055
+ /** @format GUID */
1056
+ participantId: string;
1057
+ /** @format GUID */
1058
+ sectionId: string;
1059
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1060
+ }
1061
+ interface GetParticipantSectionResponse {
1062
+ section?: ParticipantSection;
1063
+ }
1064
+ interface MyProgramRequest {
1065
+ programId: string;
1066
+ }
1067
+ interface MyProgramResponse {
1068
+ participant?: Participant;
1069
+ }
1070
+ interface MyProgramStepRequest {
1071
+ programId: string;
1072
+ programStepId: string;
1073
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1074
+ }
1075
+ interface MyProgramStepResponse {
1076
+ participantStep?: ParticipantStep;
1077
+ }
1078
+ interface MyProgramSectionRequest {
1079
+ programId: string;
1080
+ programSectionId: string;
1081
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1082
+ }
1083
+ interface MyProgramSectionResponse {
1084
+ participantSection?: ParticipantSection;
1085
+ }
1086
+ interface DomainEvent extends DomainEventBodyOneOf {
1087
+ createdEvent?: EntityCreatedEvent;
1088
+ updatedEvent?: EntityUpdatedEvent;
1089
+ deletedEvent?: EntityDeletedEvent;
1090
+ actionEvent?: ActionEvent;
1091
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1092
+ _id?: string;
1093
+ /**
1094
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1095
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1096
+ */
1097
+ entityFqdn?: string;
1098
+ /**
1099
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1100
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1101
+ */
1102
+ slug?: string;
1103
+ /** ID of the entity associated with the event. */
1104
+ entityId?: string;
1105
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1106
+ eventTime?: Date | null;
1107
+ /**
1108
+ * Whether the event was triggered as a result of a privacy regulation application
1109
+ * (for example, GDPR).
1110
+ */
1111
+ triggeredByAnonymizeRequest?: boolean | null;
1112
+ /** If present, indicates the action that triggered the event. */
1113
+ originatedFrom?: string | null;
1114
+ /**
1115
+ * 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.
1116
+ * 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.
1117
+ */
1118
+ entityEventSequence?: string | null;
1119
+ }
1120
+ /** @oneof */
1121
+ interface DomainEventBodyOneOf {
1122
+ createdEvent?: EntityCreatedEvent;
1123
+ updatedEvent?: EntityUpdatedEvent;
1124
+ deletedEvent?: EntityDeletedEvent;
1125
+ actionEvent?: ActionEvent;
1126
+ }
1127
+ interface EntityCreatedEvent {
1128
+ entity?: string;
1129
+ }
1130
+ interface RestoreInfo {
1131
+ deletedDate?: Date | null;
1132
+ }
1133
+ interface EntityUpdatedEvent {
1134
+ /**
1135
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1136
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1137
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1138
+ */
1139
+ currentEntity?: string;
1140
+ }
1141
+ interface EntityDeletedEvent {
1142
+ /** Entity that was deleted. */
1143
+ deletedEntity?: string | null;
1144
+ }
1145
+ interface ActionEvent {
1146
+ body?: string;
1147
+ }
1148
+ interface MessageEnvelope {
1149
+ /**
1150
+ * App instance ID.
1151
+ * @format GUID
1152
+ */
1153
+ instanceId?: string | null;
1154
+ /**
1155
+ * Event type.
1156
+ * @maxLength 150
1157
+ */
1158
+ eventType?: string;
1159
+ /** The identification type and identity data. */
1160
+ identity?: IdentificationData;
1161
+ /** Stringify payload. */
1162
+ data?: string;
1163
+ }
1164
+ interface IdentificationData extends IdentificationDataIdOneOf {
1165
+ /**
1166
+ * ID of a site visitor that has not logged in to the site.
1167
+ * @format GUID
1168
+ */
1169
+ anonymousVisitorId?: string;
1170
+ /**
1171
+ * ID of a site visitor that has logged in to the site.
1172
+ * @format GUID
1173
+ */
1174
+ memberId?: string;
1175
+ /**
1176
+ * ID of a Wix user (site owner, contributor, etc.).
1177
+ * @format GUID
1178
+ */
1179
+ wixUserId?: string;
1180
+ /**
1181
+ * ID of an app.
1182
+ * @format GUID
1183
+ */
1184
+ appId?: string;
1185
+ /** @readonly */
1186
+ identityType?: WebhookIdentityTypeWithLiterals;
1187
+ }
1188
+ /** @oneof */
1189
+ interface IdentificationDataIdOneOf {
1190
+ /**
1191
+ * ID of a site visitor that has not logged in to the site.
1192
+ * @format GUID
1193
+ */
1194
+ anonymousVisitorId?: string;
1195
+ /**
1196
+ * ID of a site visitor that has logged in to the site.
1197
+ * @format GUID
1198
+ */
1199
+ memberId?: string;
1200
+ /**
1201
+ * ID of a Wix user (site owner, contributor, etc.).
1202
+ * @format GUID
1203
+ */
1204
+ wixUserId?: string;
1205
+ /**
1206
+ * ID of an app.
1207
+ * @format GUID
1208
+ */
1209
+ appId?: string;
1210
+ }
1211
+ declare enum WebhookIdentityType {
1212
+ UNKNOWN = "UNKNOWN",
1213
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1214
+ MEMBER = "MEMBER",
1215
+ WIX_USER = "WIX_USER",
1216
+ APP = "APP"
1217
+ }
1218
+ /** @enumType */
1219
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1220
+ interface BaseEventMetadata {
1221
+ /**
1222
+ * App instance ID.
1223
+ * @format GUID
1224
+ */
1225
+ instanceId?: string | null;
1226
+ /**
1227
+ * Event type.
1228
+ * @maxLength 150
1229
+ */
1230
+ eventType?: string;
1231
+ /** The identification type and identity data. */
1232
+ identity?: IdentificationData;
1233
+ }
1234
+ interface EventMetadata extends BaseEventMetadata {
1235
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1236
+ _id?: string;
1237
+ /**
1238
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1239
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1240
+ */
1241
+ entityFqdn?: string;
1242
+ /**
1243
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1244
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1245
+ */
1246
+ slug?: string;
1247
+ /** ID of the entity associated with the event. */
1248
+ entityId?: string;
1249
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1250
+ eventTime?: Date | null;
1251
+ /**
1252
+ * Whether the event was triggered as a result of a privacy regulation application
1253
+ * (for example, GDPR).
1254
+ */
1255
+ triggeredByAnonymizeRequest?: boolean | null;
1256
+ /** If present, indicates the action that triggered the event. */
1257
+ originatedFrom?: string | null;
1258
+ /**
1259
+ * 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.
1260
+ * 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.
1261
+ */
1262
+ entityEventSequence?: string | null;
1263
+ }
1264
+ interface ParticipantDeletedEnvelope {
1265
+ metadata: EventMetadata;
1266
+ }
1267
+ /** @webhook
1268
+ * @eventType wix.challenges.v1.participant_deleted
1269
+ * @serviceIdentifier com.wixpress.achievements.api.v1.ParticipantsService
1270
+ * @slug deleted
1271
+ */
1272
+ declare function onParticipantDeleted(handler: (event: ParticipantDeletedEnvelope) => void | Promise<void>): void;
1273
+ interface ParticipantJoinedEnvelope {
1274
+ data: ParticipantJoined;
1275
+ metadata: EventMetadata;
1276
+ }
1277
+ /** @permissionId PARTICIPANTS.PARTICIPANT_READ
1278
+ * @webhook
1279
+ * @eventType wix.challenges.v1.participant_participant_joined
1280
+ * @serviceIdentifier com.wixpress.achievements.api.v1.ParticipantsService
1281
+ * @slug participant_joined
1282
+ */
1283
+ declare function onParticipantJoined(handler: (event: ParticipantJoinedEnvelope) => void | Promise<void>): void;
1284
+ interface ParticipantStepResolvedEnvelope {
1285
+ data: StepResolved;
1286
+ metadata: EventMetadata;
1287
+ }
1288
+ /** @permissionId PARTICIPANTS.PARTICIPANT_READ
1289
+ * @webhook
1290
+ * @eventType wix.challenges.v1.participant_step_resolved
1291
+ * @serviceIdentifier com.wixpress.achievements.api.v1.ParticipantsService
1292
+ * @slug step_resolved
1293
+ */
1294
+ declare function onParticipantStepResolved(handler: (event: ParticipantStepResolvedEnvelope) => void | Promise<void>): void;
1295
+ /** @public
1296
+ * @requiredField challengeId
1297
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.QueryParticipants
1298
+ */
1299
+ declare function queryParticipants(challengeId: string, options?: QueryParticipantsOptions): Promise<NonNullablePaths<QueryParticipantsResponse, `totalCount` | `participants` | `participants.${number}._id` | `participants.${number}.member._id` | `participants.${number}.member.fullName` | `participants.${number}.challenge._id` | `participants.${number}.stepsSummary.stepsNumber` | `participants.${number}.stepsSummary.completedStepsNumber` | `participants.${number}.stepsSummary.failedStepsNumber` | `participants.${number}.stepsSummary.postedFeedbacksNumber` | `participants.${number}.stepsSummary.lastEvent.stepId` | `participants.${number}.timezone` | `participants.${number}.dateFrame.start` | `participants.${number}.performance` | `participants.${number}.joinPath.singlePayment.orderId` | `participants.${number}.joinPath.freeCoupon.couponId`, 6>>;
1300
+ interface QueryParticipantsOptions {
1301
+ paging?: Paging;
1302
+ sorting?: QueryParticipantsRequestSorting;
1303
+ filter?: ParticipantsFilter;
1304
+ }
1305
+ /** @public
1306
+ * @requiredField challengeId
1307
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListParticipants
1308
+ * @deprecated
1309
+ */
1310
+ declare function listParticipants(challengeId: string, options?: ListParticipantsOptions): Promise<NonNullablePaths<ListParticipantsResponse, `totalCount` | `participants` | `participants.${number}._id` | `participants.${number}.member._id` | `participants.${number}.member.fullName` | `participants.${number}.challenge._id` | `participants.${number}.stepsSummary.stepsNumber` | `participants.${number}.stepsSummary.completedStepsNumber` | `participants.${number}.stepsSummary.failedStepsNumber` | `participants.${number}.stepsSummary.postedFeedbacksNumber` | `participants.${number}.stepsSummary.lastEvent.stepId` | `participants.${number}.timezone` | `participants.${number}.dateFrame.start` | `participants.${number}.performance` | `participants.${number}.joinPath.singlePayment.orderId` | `participants.${number}.joinPath.freeCoupon.couponId`, 6>>;
1311
+ interface ListParticipantsOptions {
1312
+ paging?: Paging;
1313
+ /**
1314
+ * @format GUID
1315
+ * @deprecated
1316
+ */
1317
+ memberId?: string | null;
1318
+ states?: StateWithLiterals[];
1319
+ memberIds?: string[] | null;
1320
+ /** @deprecated */
1321
+ sortingCriterion?: SortingCriterionWithLiterals;
1322
+ /** @minLength 2 */
1323
+ memberName?: string | null;
1324
+ sorting?: Sorting;
1325
+ }
1326
+ /** @public
1327
+ * @requiredField challengeId
1328
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.JoinParticipant
1329
+ */
1330
+ declare function joinParticipant(challengeId: string, options?: JoinParticipantOptions): Promise<NonNullablePaths<JoinParticipantResponse, `participantId` | `actionId` | `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
1331
+ interface JoinParticipantOptions {
1332
+ /**
1333
+ * ignored, taken from callScope instead
1334
+ * @format GUID
1335
+ * @deprecated ignored, taken from callScope instead
1336
+ * @targetRemovalDate 2024-09-01
1337
+ */
1338
+ memberId?: string;
1339
+ timeZone?: string;
1340
+ /** @format GUID */
1341
+ actionId?: string;
1342
+ startDate?: string | null;
1343
+ }
1344
+ /**
1345
+ * owner adds participant to the challenge
1346
+ * @public
1347
+ * @documentationMaturity preview
1348
+ * @requiredField challengeId
1349
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.AddParticipant
1350
+ */
1351
+ declare function addParticipant(challengeId: string, options?: AddParticipantOptions): Promise<NonNullablePaths<AddParticipantResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId` | `actionId`, 6>>;
1352
+ interface AddParticipantOptions {
1353
+ /** @format GUID */
1354
+ memberId?: string;
1355
+ /** @format GUID */
1356
+ actionId?: string;
1357
+ }
1358
+ /**
1359
+ * owner adds participants to the challenge
1360
+ * @public
1361
+ * @documentationMaturity preview
1362
+ * @requiredField challengeId
1363
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.AddParticipants
1364
+ */
1365
+ declare function addParticipants(challengeId: string, options?: AddParticipantsOptions): Promise<NonNullablePaths<AddParticipantsResponse, `participants` | `participants.${number}._id` | `participants.${number}.member._id` | `participants.${number}.member.fullName` | `participants.${number}.challenge._id` | `participants.${number}.stepsSummary.stepsNumber` | `participants.${number}.stepsSummary.completedStepsNumber` | `participants.${number}.stepsSummary.failedStepsNumber` | `participants.${number}.stepsSummary.postedFeedbacksNumber` | `participants.${number}.stepsSummary.lastEvent.stepId` | `participants.${number}.timezone` | `participants.${number}.dateFrame.start` | `participants.${number}.performance` | `participants.${number}.joinPath.singlePayment.orderId` | `participants.${number}.joinPath.freeCoupon.couponId` | `actionId`, 6>>;
1366
+ interface AddParticipantsOptions {
1367
+ /**
1368
+ * @format GUID
1369
+ * @maxSize 1000
1370
+ */
1371
+ memberIds?: string[];
1372
+ /** @format GUID */
1373
+ actionId?: string;
1374
+ }
1375
+ /** @public
1376
+ * @documentationMaturity preview
1377
+ * @requiredField challengeId
1378
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.AddAllParticipant
1379
+ */
1380
+ declare function addAllParticipant(challengeId: string, options?: AddAllParticipantOptions): Promise<void>;
1381
+ interface AddAllParticipantOptions {
1382
+ /** @format GUID */
1383
+ excludeIds?: string[];
1384
+ }
1385
+ /** @public
1386
+ * @requiredField challengeId
1387
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.CreateJoinRequest
1388
+ */
1389
+ declare function createJoinRequest(challengeId: string, options?: CreateJoinRequestOptions): Promise<NonNullablePaths<CreateJoinRequestResponse, `participantId` | `approvalRequestId` | `actionId` | `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
1390
+ interface CreateJoinRequestOptions {
1391
+ /** @format GUID */
1392
+ memberId?: string;
1393
+ timeZone?: string;
1394
+ /** @format GUID */
1395
+ actionId?: string;
1396
+ startDate?: string | null;
1397
+ }
1398
+ /** @public
1399
+ * @requiredField challengeId
1400
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.InviteParticipants
1401
+ */
1402
+ declare function inviteParticipants(challengeId: string, options?: InviteParticipantsOptions): Promise<NonNullablePaths<InviteParticipantsResponse, `invitations` | `invitations.${number}.participantId` | `invitations.${number}.approvalRequestId` | `actionId`, 4>>;
1403
+ interface InviteParticipantsOptions {
1404
+ memberIds?: string[];
1405
+ /** @format GUID */
1406
+ actionId?: string;
1407
+ }
1408
+ /** @public
1409
+ * @requiredField challengeId
1410
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.InviteAllParticipants
1411
+ */
1412
+ declare function inviteAllParticipants(challengeId: string, options?: InviteAllParticipantsOptions): Promise<void>;
1413
+ interface InviteAllParticipantsOptions {
1414
+ /** @format GUID */
1415
+ excludeIds?: string[];
1416
+ }
1417
+ /**
1418
+ * returns participant by id
1419
+ * @public
1420
+ * @requiredField identifiers
1421
+ * @requiredField identifiers.challengeId
1422
+ * @requiredField identifiers.participantId
1423
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetParticipant
1424
+ */
1425
+ declare function getParticipant(identifiers: NonNullablePaths<GetParticipantIdentifiers, `challengeId` | `participantId`, 2>): Promise<NonNullablePaths<Participant, `_id` | `member._id` | `member.fullName` | `challenge._id` | `stepsSummary.stepsNumber` | `stepsSummary.completedStepsNumber` | `stepsSummary.failedStepsNumber` | `stepsSummary.postedFeedbacksNumber` | `stepsSummary.lastEvent.stepId` | `stepsSummary.lastEvent.transition.state` | `orderIds` | `transitions` | `transitions.${number}.state` | `timezone` | `dateFrame.start` | `performance` | `joinPath.singlePayment.orderId` | `joinPath.paidPlan.planIds` | `joinPath.freeCoupon.couponId`, 5>>;
1426
+ interface GetParticipantIdentifiers {
1427
+ /** @format GUID */
1428
+ challengeId: string;
1429
+ /** @format GUID */
1430
+ participantId: string;
1431
+ }
1432
+ /** @public
1433
+ * @requiredField identifiers
1434
+ * @requiredField identifiers.challengeId
1435
+ * @requiredField identifiers.participantId
1436
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.UpdateParticipant
1437
+ */
1438
+ declare function updateParticipant(identifiers: NonNullablePaths<UpdateParticipantIdentifiers, `challengeId` | `participantId`, 2>, options?: UpdateParticipantOptions): Promise<NonNullablePaths<UpdateParticipantResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId` | `actionId`, 6>>;
1439
+ interface UpdateParticipantIdentifiers extends UpdateParticipantIdentifiersUpdateOneOf {
1440
+ /** @format GUID */
1441
+ challengeId: string;
1442
+ /** @format GUID */
1443
+ participantId: string;
1444
+ }
1445
+ /** @oneof */
1446
+ interface UpdateParticipantIdentifiersUpdateOneOf {
1447
+ startDate?: string;
1448
+ }
1449
+ interface UpdateParticipantOptions extends UpdateParticipantOptionsUpdateOneOf {
1450
+ startDate?: string;
1451
+ /** @format GUID */
1452
+ actionId?: string;
1453
+ }
1454
+ /** @oneof */
1455
+ interface UpdateParticipantOptionsUpdateOneOf {
1456
+ startDate?: string;
1457
+ }
1458
+ /**
1459
+ * by owner - makes participant REMOVED. By participant himself - LEFT.
1460
+ * @public
1461
+ * @requiredField identifiers
1462
+ * @requiredField identifiers.challengeId
1463
+ * @requiredField identifiers.participantId
1464
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.DeleteParticipant
1465
+ */
1466
+ declare function deleteParticipant(identifiers: NonNullablePaths<DeleteParticipantIdentifiers, `challengeId` | `participantId`, 2>, options?: DeleteParticipantOptions): Promise<NonNullablePaths<DeleteParticipantResponse, `actionId`, 2>>;
1467
+ interface DeleteParticipantIdentifiers {
1468
+ /** @format GUID */
1469
+ challengeId: string;
1470
+ /** @format GUID */
1471
+ participantId: string;
1472
+ }
1473
+ interface DeleteParticipantOptions {
1474
+ /** @format GUID */
1475
+ actionId?: string;
1476
+ }
1477
+ /** @public
1478
+ * @requiredField identifiers
1479
+ * @requiredField identifiers.challengeId
1480
+ * @requiredField identifiers.participantId
1481
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ReviveParticipant
1482
+ */
1483
+ declare function reviveParticipant(identifiers: NonNullablePaths<ReviveParticipantIdentifiers, `challengeId` | `participantId`, 2>, options?: ReviveParticipantOptions): Promise<NonNullablePaths<ReviveParticipantResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId` | `actionId`, 6>>;
1484
+ interface ReviveParticipantIdentifiers {
1485
+ /** @format GUID */
1486
+ challengeId: string;
1487
+ /** @format GUID */
1488
+ participantId: string;
1489
+ }
1490
+ interface ReviveParticipantOptions {
1491
+ /** @format GUID */
1492
+ actionId?: string;
1493
+ }
1494
+ /** @public
1495
+ * @requiredField identifiers
1496
+ * @requiredField identifiers.challengeId
1497
+ * @requiredField identifiers.participantId
1498
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ResetParticipantProgress
1499
+ */
1500
+ declare function resetParticipantProgress(identifiers: NonNullablePaths<ResetParticipantProgressIdentifiers, `challengeId` | `participantId`, 2>, options?: ResetParticipantProgressOptions): Promise<NonNullablePaths<ResetParticipantProgressResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId` | `actionId`, 6>>;
1501
+ interface ResetParticipantProgressIdentifiers {
1502
+ /** @format GUID */
1503
+ challengeId: string;
1504
+ /** @format GUID */
1505
+ participantId: string;
1506
+ }
1507
+ interface ResetParticipantProgressOptions {
1508
+ timeZone?: string;
1509
+ startDate?: string | null;
1510
+ /** @format GUID */
1511
+ actionId?: string;
1512
+ }
1513
+ /** @public
1514
+ * @requiredField identifiers
1515
+ * @requiredField identifiers.challengeId
1516
+ * @requiredField identifiers.participantId
1517
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.IssueParticipantCertificate
1518
+ */
1519
+ declare function issueParticipantCertificate(identifiers: NonNullablePaths<IssueParticipantCertificateIdentifiers, `challengeId` | `participantId`, 2>): Promise<NonNullablePaths<IssueParticipantCertificateResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
1520
+ interface IssueParticipantCertificateIdentifiers {
1521
+ /**
1522
+ * Program id. TODO: really bad to have it here, needed for url
1523
+ * @format GUID
1524
+ */
1525
+ challengeId: string;
1526
+ /**
1527
+ * Participant to issue manually certificate
1528
+ * @format GUID
1529
+ */
1530
+ participantId: string;
1531
+ }
1532
+ /** @public
1533
+ * @requiredField identifiers
1534
+ * @requiredField identifiers.challengeId
1535
+ * @requiredField identifiers.participantId
1536
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.IssueCertificate
1537
+ */
1538
+ declare function issueCertificate(identifiers: NonNullablePaths<IssueCertificateIdentifiers, `challengeId` | `participantId`, 2>): Promise<NonNullablePaths<IssueCertificateResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
1539
+ interface IssueCertificateIdentifiers {
1540
+ /**
1541
+ * Program id. TODO: really bad to have it here, needed for url
1542
+ * @format GUID
1543
+ */
1544
+ challengeId: string;
1545
+ /**
1546
+ * Participant to get certificate
1547
+ * @format GUID
1548
+ */
1549
+ participantId: string;
1550
+ }
1551
+ /** @public
1552
+ * @requiredField identifiers
1553
+ * @requiredField identifiers.challengeId
1554
+ * @requiredField identifiers.participantId
1555
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetCertificate
1556
+ */
1557
+ declare function getCertificate(identifiers: NonNullablePaths<GetCertificateIdentifiers, `challengeId` | `participantId`, 2>): Promise<NonNullablePaths<GetCertificateResponse, `certificateUrl`, 2>>;
1558
+ interface GetCertificateIdentifiers {
1559
+ /**
1560
+ * Program id. TODO: really bad to have it here, needed for url
1561
+ * @format GUID
1562
+ */
1563
+ challengeId: string;
1564
+ /**
1565
+ * Participant to get certificate
1566
+ * @format GUID
1567
+ */
1568
+ participantId: string;
1569
+ }
1570
+ /** @public
1571
+ * @requiredField identifiers
1572
+ * @requiredField identifiers.challengeId
1573
+ * @requiredField identifiers.participantId
1574
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.CreatePaymentOrder
1575
+ */
1576
+ declare function createPaymentOrder(identifiers: NonNullablePaths<CreatePaymentOrderIdentifiers, `challengeId` | `participantId`, 2>, options?: CreatePaymentOrderOptions): Promise<NonNullablePaths<CreatePaymentOrderResponse, `orderId` | `actionId` | `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
1577
+ interface CreatePaymentOrderIdentifiers {
1578
+ /** @format GUID */
1579
+ challengeId: string;
1580
+ /** @format GUID */
1581
+ participantId: string;
1582
+ }
1583
+ interface CreatePaymentOrderOptions {
1584
+ /** @format GUID */
1585
+ actionId?: string;
1586
+ timeZone?: string | null;
1587
+ startDate?: string | null;
1588
+ paymentType?: PaymentTypeWithLiterals;
1589
+ }
1590
+ /**
1591
+ * ---------------------------------------------------- Coupons -----------------------------------------------------
1592
+ * @public
1593
+ * @requiredField couponCode
1594
+ * @requiredField identifiers
1595
+ * @requiredField identifiers.challengeId
1596
+ * @requiredField identifiers.orderId
1597
+ * @requiredField identifiers.participantId
1598
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ApplyCouponToOrder
1599
+ */
1600
+ declare function applyCouponToOrder(identifiers: NonNullablePaths<ApplyCouponToOrderIdentifiers, `challengeId` | `orderId` | `participantId`, 2>, couponCode: string, options?: ApplyCouponToOrderOptions): Promise<NonNullablePaths<ApplyCouponToOrderResponse, `couponId` | `subTotal` | `discount` | `total`, 2>>;
1601
+ interface ApplyCouponToOrderIdentifiers {
1602
+ /** @format GUID */
1603
+ challengeId: string;
1604
+ /** @format GUID */
1605
+ participantId: string;
1606
+ /** @format GUID */
1607
+ orderId: string;
1608
+ }
1609
+ interface ApplyCouponToOrderOptions {
1610
+ /** @format GUID */
1611
+ actionId?: string;
1612
+ }
1613
+ /** @public
1614
+ * @requiredField identifiers
1615
+ * @requiredField identifiers.challengeId
1616
+ * @requiredField identifiers.couponId
1617
+ * @requiredField identifiers.orderId
1618
+ * @requiredField identifiers.participantId
1619
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.RemoveCouponFromOrder
1620
+ */
1621
+ declare function removeCouponFromOrder(identifiers: NonNullablePaths<RemoveCouponFromOrderIdentifiers, `challengeId` | `couponId` | `orderId` | `participantId`, 2>, options?: RemoveCouponFromOrderOptions): Promise<NonNullablePaths<RemoveCouponFromOrderResponse, `total`, 2>>;
1622
+ interface RemoveCouponFromOrderIdentifiers {
1623
+ /** @format GUID */
1624
+ challengeId: string;
1625
+ /** @format GUID */
1626
+ participantId: string;
1627
+ /** @format GUID */
1628
+ orderId: string;
1629
+ /** @format GUID */
1630
+ couponId: string;
1631
+ }
1632
+ interface RemoveCouponFromOrderOptions {
1633
+ /** @format GUID */
1634
+ actionId?: string;
1635
+ }
1636
+ /** @public
1637
+ * @requiredField identifiers
1638
+ * @requiredField identifiers.challengeId
1639
+ * @requiredField identifiers.participantId
1640
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListSteps
1641
+ */
1642
+ declare function listSteps(identifiers: NonNullablePaths<ListStepsIdentifiers, `challengeId` | `participantId`, 2>, options?: ListStepsOptions): Promise<NonNullablePaths<ListParticipantStepsResponse, `steps` | `steps.${number}._id` | `steps.${number}.source._id` | `steps.${number}.dateFrame.start` | `steps.${number}.quizSubmission.quizSubmissionId`, 5>>;
1643
+ interface ListStepsIdentifiers {
1644
+ /** @format GUID */
1645
+ challengeId: string;
1646
+ /** @format GUID */
1647
+ participantId: string;
1648
+ }
1649
+ interface ListStepsOptions {
1650
+ parentId?: string;
1651
+ timeInterval?: TimeInterval;
1652
+ dateInterval?: DateInterval;
1653
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1654
+ }
1655
+ /** @public
1656
+ * @requiredField identifiers
1657
+ * @requiredField identifiers.challengeId
1658
+ * @requiredField identifiers.participantId
1659
+ * @requiredField identifiers.stepId
1660
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetStep
1661
+ */
1662
+ declare function getStep(identifiers: NonNullablePaths<GetStepIdentifiers, `challengeId` | `participantId` | `stepId`, 2>, options?: GetStepOptions): Promise<NonNullablePaths<GetParticipantStepResponse, `step._id` | `step.source._id` | `step.source.settings.general.individual.confirmationRequired` | `step.source.settings.general.individual.feedbackSettings` | `step.source.settings.general.individual.feedbackSettings.${number}._id` | `step.source.settings.general.individual.feedbackSettings.${number}.type.numeric.maxValue` | `step.source.settings.general.individual.feedbackSettings.${number}.type.quantity.amount` | `step.source.settings.general.individual.feedbackSettings.${number}.question` | `step.source.settings.general.individual.feedbackSettings.${number}.isRequired` | `step.source.settings.general.individual.showQuiz` | `step.source.settings.general.individual.quizSettings` | `step.source.settings.general.group.completionCriteria.completedSteps.minThreshold.value` | `step.source.settings.general.quiz.quizId` | `step.source.settings.general.quiz.questionCount` | `step.source.settings.general.quiz.migrationDetails.sourceStepId` | `step.source.settings.general.quiz.migrationDetails.show` | `step.source.settings.general.quiz.migrationDetails.quizType` | `step.source.settings.general.video.wixVideo._id` | `step.source.settings.general.video.wixVideo.paid` | `step.source.settings.general.video.requiredCompletionPercentage` | `step.source.settings.general.video.deleted` | `step.source.settings.general.duration.unit` | `step.source.settings.general.duration.value` | `step.source.settings.general.recurrenceSettings.schedules` | `step.source.settings.embedding.startConditions` | `step.source.settings.embedding.startConditions.${number}.dependency.step.stepId` | `step.source.settings.embedding.isMilestone` | `step.feedback.items` | `step.feedback.items.${number}.choice.choiceId` | `step.feedback.items.${number}.quantity.unitName` | `step.feedback.items.${number}.quantity.amount` | `step.feedback.items.${number}.feedbackItemSettingsId` | `step.feedback.quiz` | `step.transitions` | `step.transitions.${number}.state` | `step.dateFrame.start` | `step.quizSubmission.quizSubmissionId` | `subSteps` | `subSteps.${number}._id` | `subSteps.${number}.source._id` | `subSteps.${number}.dateFrame.start` | `subSteps.${number}.quizSubmission.quizSubmissionId`, 11>>;
1663
+ interface GetStepIdentifiers {
1664
+ /** @format GUID */
1665
+ challengeId: string;
1666
+ /** @format GUID */
1667
+ participantId: string;
1668
+ stepId: string;
1669
+ }
1670
+ interface GetStepOptions {
1671
+ timeInterval?: TimeInterval;
1672
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1673
+ }
1674
+ /** @public
1675
+ * @requiredField identifiers
1676
+ * @requiredField identifiers.challengeId
1677
+ * @requiredField identifiers.participantId
1678
+ * @requiredField identifiers.stepId
1679
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ResolveStep
1680
+ */
1681
+ declare function resolveStep(identifiers: NonNullablePaths<ResolveStepIdentifiers, `challengeId` | `participantId` | `stepId`, 2>, options?: ResolveStepOptions): Promise<NonNullablePaths<ResolveParticipantStepResponse, `step._id` | `step.source._id` | `step.source.settings.general.individual.confirmationRequired` | `step.source.settings.general.individual.feedbackSettings` | `step.source.settings.general.individual.feedbackSettings.${number}._id` | `step.source.settings.general.individual.feedbackSettings.${number}.type.numeric.maxValue` | `step.source.settings.general.individual.feedbackSettings.${number}.type.quantity.amount` | `step.source.settings.general.individual.feedbackSettings.${number}.question` | `step.source.settings.general.individual.feedbackSettings.${number}.isRequired` | `step.source.settings.general.individual.showQuiz` | `step.source.settings.general.individual.quizSettings` | `step.source.settings.general.group.completionCriteria.completedSteps.minThreshold.value` | `step.source.settings.general.quiz.quizId` | `step.source.settings.general.quiz.questionCount` | `step.source.settings.general.quiz.migrationDetails.sourceStepId` | `step.source.settings.general.quiz.migrationDetails.show` | `step.source.settings.general.quiz.migrationDetails.quizType` | `step.source.settings.general.video.wixVideo._id` | `step.source.settings.general.video.wixVideo.paid` | `step.source.settings.general.video.requiredCompletionPercentage` | `step.source.settings.general.video.deleted` | `step.source.settings.general.duration.unit` | `step.source.settings.general.duration.value` | `step.source.settings.general.recurrenceSettings.schedules` | `step.source.settings.embedding.startConditions` | `step.source.settings.embedding.startConditions.${number}.dependency.step.stepId` | `step.source.settings.embedding.isMilestone` | `step.feedback.items` | `step.feedback.items.${number}.choice.choiceId` | `step.feedback.items.${number}.quantity.unitName` | `step.feedback.items.${number}.quantity.amount` | `step.feedback.items.${number}.feedbackItemSettingsId` | `step.feedback.quiz` | `step.transitions` | `step.transitions.${number}.state` | `step.dateFrame.start` | `step.quizSubmission.quizSubmissionId` | `actionId`, 11>>;
1682
+ interface ResolveStepIdentifiers {
1683
+ /** @format GUID */
1684
+ challengeId: string;
1685
+ /** @format GUID */
1686
+ participantId: string;
1687
+ stepId: string;
1688
+ }
1689
+ interface ResolveStepOptions {
1690
+ status?: ResolutionStatusWithLiterals;
1691
+ feedback?: Feedback;
1692
+ actionId?: string;
1693
+ /** @format GUID */
1694
+ quizSubmissionId?: string | null;
1695
+ }
1696
+ /** @public
1697
+ * @requiredField identifiers
1698
+ * @requiredField identifiers.challengeId
1699
+ * @requiredField identifiers.participantId
1700
+ * @requiredField identifiers.stepId
1701
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.UpdateStepFeedback
1702
+ */
1703
+ declare function updateStepFeedback(identifiers: NonNullablePaths<UpdateStepFeedbackIdentifiers, `challengeId` | `participantId` | `stepId`, 2>, options?: UpdateStepFeedbackOptions): Promise<NonNullablePaths<UpdateStepFeedbackResponse, `step._id` | `step.source._id` | `step.source.settings.general.individual.confirmationRequired` | `step.source.settings.general.individual.feedbackSettings` | `step.source.settings.general.individual.feedbackSettings.${number}._id` | `step.source.settings.general.individual.feedbackSettings.${number}.type.numeric.maxValue` | `step.source.settings.general.individual.feedbackSettings.${number}.type.quantity.amount` | `step.source.settings.general.individual.feedbackSettings.${number}.question` | `step.source.settings.general.individual.feedbackSettings.${number}.isRequired` | `step.source.settings.general.individual.showQuiz` | `step.source.settings.general.individual.quizSettings` | `step.source.settings.general.group.completionCriteria.completedSteps.minThreshold.value` | `step.source.settings.general.quiz.quizId` | `step.source.settings.general.quiz.questionCount` | `step.source.settings.general.quiz.migrationDetails.sourceStepId` | `step.source.settings.general.quiz.migrationDetails.show` | `step.source.settings.general.quiz.migrationDetails.quizType` | `step.source.settings.general.video.wixVideo._id` | `step.source.settings.general.video.wixVideo.paid` | `step.source.settings.general.video.requiredCompletionPercentage` | `step.source.settings.general.video.deleted` | `step.source.settings.general.duration.unit` | `step.source.settings.general.duration.value` | `step.source.settings.general.recurrenceSettings.schedules` | `step.source.settings.embedding.startConditions` | `step.source.settings.embedding.startConditions.${number}.dependency.step.stepId` | `step.source.settings.embedding.isMilestone` | `step.feedback.items` | `step.feedback.items.${number}.choice.choiceId` | `step.feedback.items.${number}.quantity.unitName` | `step.feedback.items.${number}.quantity.amount` | `step.feedback.items.${number}.feedbackItemSettingsId` | `step.feedback.quiz` | `step.transitions` | `step.transitions.${number}.state` | `step.dateFrame.start` | `step.quizSubmission.quizSubmissionId` | `actionId`, 11>>;
1704
+ interface UpdateStepFeedbackIdentifiers {
1705
+ /** @format GUID */
1706
+ challengeId: string;
1707
+ /** @format GUID */
1708
+ participantId: string;
1709
+ stepId: string;
1710
+ }
1711
+ interface UpdateStepFeedbackOptions {
1712
+ feedback?: Feedback;
1713
+ /** @format GUID */
1714
+ actionId?: string;
1715
+ }
1716
+ /** @public
1717
+ * @requiredField identifiers
1718
+ * @requiredField identifiers.challengeId
1719
+ * @requiredField identifiers.participantId
1720
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetMediaUploadInfo
1721
+ */
1722
+ declare function getMediaUploadInfo(identifiers: NonNullablePaths<GetMediaUploadInfoIdentifiers, `challengeId` | `participantId`, 2>, options?: GetMediaUploadInfoOptions): Promise<NonNullablePaths<GetMediaUploadInfoResponse, `uploadUrl` | `uploadToken`, 2>>;
1723
+ interface GetMediaUploadInfoIdentifiers {
1724
+ /** @format GUID */
1725
+ challengeId: string;
1726
+ /** @format GUID */
1727
+ participantId: string;
1728
+ }
1729
+ interface GetMediaUploadInfoOptions {
1730
+ fileName?: string;
1731
+ }
1732
+ /**
1733
+ * ---------------------------------------------------- Sections --------------------------------------------------------
1734
+ * @public
1735
+ * @requiredField identifiers
1736
+ * @requiredField identifiers.challengeId
1737
+ * @requiredField identifiers.participantId
1738
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListSections
1739
+ */
1740
+ declare function listSections(identifiers: NonNullablePaths<ListSectionsIdentifiers, `challengeId` | `participantId`, 2>, options?: ListSectionsOptions): Promise<NonNullablePaths<ListParticipantSectionsResponse, `sections` | `sections.${number}._id` | `sections.${number}.source._id` | `sections.${number}.progress.nTotalSteps` | `sections.${number}.progress.nCompletedSteps`, 5>>;
1741
+ interface ListSectionsIdentifiers {
1742
+ /** @format GUID */
1743
+ challengeId: string;
1744
+ /** @format GUID */
1745
+ participantId: string;
1746
+ }
1747
+ interface ListSectionsOptions {
1748
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1749
+ }
1750
+ /** @public
1751
+ * @requiredField identifiers
1752
+ * @requiredField identifiers.challengeId
1753
+ * @requiredField identifiers.participantId
1754
+ * @requiredField identifiers.sectionId
1755
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetSection
1756
+ */
1757
+ declare function getSection(identifiers: NonNullablePaths<GetSectionIdentifiers, `challengeId` | `participantId` | `sectionId`, 2>, options?: GetSectionOptions): Promise<NonNullablePaths<GetParticipantSectionResponse, `section._id` | `section.source._id` | `section.source.settings.startCondition.dependency.step.stepId` | `section.source.settings.startCondition.delay.unit` | `section.source.settings.startCondition.delay.value` | `section.source.steps` | `section.source.steps.${number}._id` | `section.source.steps.${number}.settings.embedding.isMilestone` | `section.steps` | `section.steps.${number}._id` | `section.steps.${number}.dateFrame.start` | `section.steps.${number}.quizSubmission.quizSubmissionId` | `section.transitions` | `section.transitions.${number}.waitingDate.startDate` | `section.transitions.${number}.waitingDependency.sectionId` | `section.progress.nTotalSteps` | `section.progress.nCompletedSteps`, 8>>;
1758
+ interface GetSectionIdentifiers {
1759
+ /** @format GUID */
1760
+ challengeId: string;
1761
+ /** @format GUID */
1762
+ participantId: string;
1763
+ /** @format GUID */
1764
+ sectionId: string;
1765
+ }
1766
+ interface GetSectionOptions {
1767
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1768
+ }
1769
+ /** @public
1770
+ * @requiredField programId
1771
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgram
1772
+ */
1773
+ declare function myProgram(programId: string): Promise<NonNullablePaths<MyProgramResponse, `participant._id` | `participant.member._id` | `participant.member.fullName` | `participant.challenge._id` | `participant.stepsSummary.stepsNumber` | `participant.stepsSummary.completedStepsNumber` | `participant.stepsSummary.failedStepsNumber` | `participant.stepsSummary.postedFeedbacksNumber` | `participant.stepsSummary.lastEvent.stepId` | `participant.stepsSummary.lastEvent.transition.state` | `participant.orderIds` | `participant.transitions` | `participant.transitions.${number}.state` | `participant.timezone` | `participant.dateFrame.start` | `participant.performance` | `participant.joinPath.singlePayment.orderId` | `participant.joinPath.paidPlan.planIds` | `participant.joinPath.freeCoupon.couponId`, 6>>;
1774
+ /** @public
1775
+ * @requiredField identifiers
1776
+ * @requiredField identifiers.programId
1777
+ * @requiredField identifiers.programStepId
1778
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgramStep
1779
+ */
1780
+ declare function myProgramStep(identifiers: NonNullablePaths<MyProgramStepIdentifiers, `programId` | `programStepId`, 2>, options?: MyProgramStepOptions): Promise<NonNullablePaths<MyProgramStepResponse, `participantStep._id` | `participantStep.source._id` | `participantStep.source.settings.general.individual.confirmationRequired` | `participantStep.source.settings.general.individual.feedbackSettings` | `participantStep.source.settings.general.individual.feedbackSettings.${number}._id` | `participantStep.source.settings.general.individual.feedbackSettings.${number}.type.numeric.maxValue` | `participantStep.source.settings.general.individual.feedbackSettings.${number}.type.quantity.amount` | `participantStep.source.settings.general.individual.feedbackSettings.${number}.question` | `participantStep.source.settings.general.individual.feedbackSettings.${number}.isRequired` | `participantStep.source.settings.general.individual.showQuiz` | `participantStep.source.settings.general.individual.quizSettings` | `participantStep.source.settings.general.group.completionCriteria.completedSteps.minThreshold.value` | `participantStep.source.settings.general.quiz.quizId` | `participantStep.source.settings.general.quiz.questionCount` | `participantStep.source.settings.general.quiz.migrationDetails.sourceStepId` | `participantStep.source.settings.general.quiz.migrationDetails.show` | `participantStep.source.settings.general.quiz.migrationDetails.quizType` | `participantStep.source.settings.general.video.wixVideo._id` | `participantStep.source.settings.general.video.wixVideo.paid` | `participantStep.source.settings.general.video.requiredCompletionPercentage` | `participantStep.source.settings.general.video.deleted` | `participantStep.source.settings.general.duration.unit` | `participantStep.source.settings.general.duration.value` | `participantStep.source.settings.general.recurrenceSettings.schedules` | `participantStep.source.settings.embedding.startConditions` | `participantStep.source.settings.embedding.startConditions.${number}.dependency.step.stepId` | `participantStep.source.settings.embedding.isMilestone` | `participantStep.feedback.items` | `participantStep.feedback.items.${number}.choice.choiceId` | `participantStep.feedback.items.${number}.quantity.unitName` | `participantStep.feedback.items.${number}.quantity.amount` | `participantStep.feedback.items.${number}.feedbackItemSettingsId` | `participantStep.feedback.quiz` | `participantStep.transitions` | `participantStep.transitions.${number}.state` | `participantStep.dateFrame.start` | `participantStep.quizSubmission.quizSubmissionId`, 11>>;
1781
+ interface MyProgramStepIdentifiers {
1782
+ programId: string;
1783
+ programStepId: string;
1784
+ }
1785
+ interface MyProgramStepOptions {
1786
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1787
+ }
1788
+ /** @public
1789
+ * @requiredField identifiers
1790
+ * @requiredField identifiers.programId
1791
+ * @requiredField identifiers.programSectionId
1792
+ * @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgramSection
1793
+ */
1794
+ declare function myProgramSection(identifiers: NonNullablePaths<MyProgramSectionIdentifiers, `programId` | `programSectionId`, 2>, options?: MyProgramSectionOptions): Promise<NonNullablePaths<MyProgramSectionResponse, `participantSection._id` | `participantSection.source._id` | `participantSection.source.settings.startCondition.dependency.step.stepId` | `participantSection.source.settings.startCondition.delay.unit` | `participantSection.source.settings.startCondition.delay.value` | `participantSection.source.steps` | `participantSection.source.steps.${number}._id` | `participantSection.source.steps.${number}.settings.embedding.isMilestone` | `participantSection.steps` | `participantSection.steps.${number}._id` | `participantSection.steps.${number}.dateFrame.start` | `participantSection.steps.${number}.quizSubmission.quizSubmissionId` | `participantSection.transitions` | `participantSection.transitions.${number}.waitingDate.startDate` | `participantSection.transitions.${number}.waitingDependency.sectionId` | `participantSection.progress.nTotalSteps` | `participantSection.progress.nCompletedSteps`, 8>>;
1795
+ interface MyProgramSectionIdentifiers {
1796
+ programId: string;
1797
+ programSectionId: string;
1798
+ }
1799
+ interface MyProgramSectionOptions {
1800
+ descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1801
+ }
1802
+
1803
+ export { type ActionEvent, type AddAllParticipantOptions, type AddAllParticipantRequest, type AddAllParticipantResponse, type AddParticipantOptions, type AddParticipantRequest, type AddParticipantResponse, type AddParticipantsOptions, type AddParticipantsRequest, type AddParticipantsResponse, type Added, type All, type ApplyCouponToOrderIdentifiers, type ApplyCouponToOrderOptions, type ApplyCouponToOrderRequest, type ApplyCouponToOrderResponse, type BaseEventMetadata, type Certificate, type ChallengeSection, type ChallengeStep, type ChallengeStepSettings, type Choice, ChoiceRightness, type ChoiceRightnessWithLiterals, type Choices, type Completed, type CompletionCriteria, type Container, type CreateJoinRequestOptions, type CreateJoinRequestRequest, type CreateJoinRequestResponse, type CreatePaymentOrderIdentifiers, type CreatePaymentOrderOptions, type CreatePaymentOrderRequest, type CreatePaymentOrderResponse, type DateInterval, type DeleteParticipantIdentifiers, type DeleteParticipantOptions, type DeleteParticipantRequest, type DeleteParticipantResponse, DescriptionFieldSet, type DescriptionFieldSetWithLiterals, type DomainEvent, type DomainEventBodyOneOf, DurationUnit, type DurationUnitWithLiterals, type EmbeddingSettings, type EntityCreatedEvent, type EntityDeletedEvent, type EntitySummary, type EntityUpdatedEvent, type EventMetadata, type Feedback, type FeedbackItem, type FeedbackItemChoice, type FeedbackItemSettings, type FeedbackItemType, type FeedbackItemTypeTypeOneOf, type FeedbackItemValueOneOf, type FocalPoint, type Free, type FreeCoupon, type GeneralSettings, type GeneralSettingsStepTypeOneOf, type GetCertificateIdentifiers, type GetCertificateRequest, type GetCertificateResponse, type GetMediaUploadInfoIdentifiers, type GetMediaUploadInfoOptions, type GetMediaUploadInfoRequest, type GetMediaUploadInfoResponse, type GetParticipantIdentifiers, type GetParticipantRequest, type GetParticipantResponse, type GetParticipantSectionRequest, type GetParticipantSectionResponse, type GetParticipantStepRequest, type GetParticipantStepResponse, type GetSectionIdentifiers, type GetSectionOptions, type GetStepIdentifiers, type GetStepOptions, type GroupSettings, type IdentificationData, type IdentificationDataIdOneOf, type IndividualSettings, type InvitationDetails, type InviteAllParticipantsOptions, type InviteAllParticipantsRequest, type InviteAllParticipantsResponse, type InviteParticipantsOptions, type InviteParticipantsRequest, type InviteParticipantsResponse, type IssueCertificateIdentifiers, type IssueCertificateRequest, type IssueCertificateResponse, type IssueParticipantCertificateIdentifiers, type IssueParticipantCertificateRequest, type IssueParticipantCertificateResponse, type JoinParticipantOptions, type JoinParticipantRequest, type JoinParticipantResponse, type JoinPath, type JoinPathPathOneOf, type ListParticipantSectionsRequest, type ListParticipantSectionsResponse, type ListParticipantStepsRequest, type ListParticipantStepsResponse, type ListParticipantsOptions, type ListParticipantsRequest, type ListParticipantsResponse, type ListSectionsIdentifiers, type ListSectionsOptions, type ListStepsIdentifiers, type ListStepsOptions, type MediaFeedbackItem, type MediaItem, type MediaItemMediaOneOf, type MediaItems, type Member, type MessageEnvelope, type MinThreshold, type MultipleChoiceFeedbackItem, type MyProgramRequest, type MyProgramResponse, type MyProgramSectionIdentifiers, type MyProgramSectionOptions, type MyProgramSectionRequest, type MyProgramSectionResponse, type MyProgramStepIdentifiers, type MyProgramStepOptions, type MyProgramStepRequest, type MyProgramStepResponse, type NumericFeedbackItem, type ObjectDescription, type Overdue, type Paging, type PaidPlan, type Participant, type ParticipantDeletedEnvelope, type ParticipantJoinDate, type ParticipantJoined, type ParticipantJoinedEnvelope, type ParticipantPerformance, type ParticipantSection, type ParticipantSectionStateTransition, type ParticipantSectionStateTransitionStateOneOf, type ParticipantStep, type ParticipantStepResolvedEnvelope, ParticipantStepState, type ParticipantStepStateTransition, type ParticipantStepStateWithLiterals, type ParticipantsFilter, ParticipationState, type ParticipationStateWithLiterals, PaymentType, type PaymentTypeWithLiterals, type Price, type Progress, type Quantity, type QuantityCriterion, type QuantityCriterionCriterionOneOf, type QuantityFeedbackItem, type QueryParticipantsOptions, type QueryParticipantsRequest, QueryParticipantsRequestJoinPath, type QueryParticipantsRequestJoinPathWithLiterals, type QueryParticipantsRequestSorting, QueryParticipantsRequestSortingCriterion, type QueryParticipantsRequestSortingCriterionWithLiterals, QueryParticipantsRequestSortingOrder, type QueryParticipantsRequestSortingOrderWithLiterals, type QueryParticipantsResponse, type QuizMigrationDetails, type QuizSettings, type QuizSubmission, type QuizSubmissionData, QuizType, type QuizTypeWithLiterals, type RecurrenceSchedule, type RecurrenceSettings, type RemoveCouponFromOrderIdentifiers, type RemoveCouponFromOrderOptions, type RemoveCouponFromOrderRequest, type RemoveCouponFromOrderResponse, type ResetParticipantProgressIdentifiers, type ResetParticipantProgressOptions, type ResetParticipantProgressRequest, type ResetParticipantProgressResponse, ResolutionStatus, type ResolutionStatusWithLiterals, type ResolveParticipantStepRequest, type ResolveParticipantStepResponse, type ResolveStepIdentifiers, type ResolveStepOptions, type RestoreInfo, type ReviveParticipantIdentifiers, type ReviveParticipantOptions, type ReviveParticipantRequest, type ReviveParticipantResponse, type Running, type Settings, type SinglePayment, type Sorting, SortingCriterion, type SortingCriterionWithLiterals, SortingOrder, type SortingOrderWithLiterals, type StartCondition, State, type StateTransition, type StateWithLiterals, Status, type StatusWithLiterals, type Step, type StepDependency, type StepDependencyDependencyTypeOneOf, type StepEvent, type StepResolved, type StepsSummary, type TextFeedbackItem, type TimeDuration, type TimeInterval, type UpdateParticipantIdentifiers, type UpdateParticipantIdentifiersUpdateOneOf, type UpdateParticipantOptions, type UpdateParticipantOptionsUpdateOneOf, type UpdateParticipantRequest, type UpdateParticipantRequestUpdateOneOf, type UpdateParticipantResponse, type UpdateStepFeedbackIdentifiers, type UpdateStepFeedbackOptions, type UpdateStepFeedbackRequest, type UpdateStepFeedbackResponse, type VideoResolution, type VideoStepSettings, type VideoStepSettingsVideoSourceOneOf, type WaitingDate, type WaitingDependency, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixVideo, addAllParticipant, addParticipant, addParticipants, applyCouponToOrder, createJoinRequest, createPaymentOrder, deleteParticipant, getCertificate, getMediaUploadInfo, getParticipant, getSection, getStep, inviteAllParticipants, inviteParticipants, issueCertificate, issueParticipantCertificate, joinParticipant, listParticipants, listSections, listSteps, myProgram, myProgramSection, myProgramStep, onParticipantDeleted, onParticipantJoined, onParticipantStepResolved, queryParticipants, removeCouponFromOrder, resetParticipantProgress, resolveStep, reviveParticipant, updateParticipant, updateStepFeedback };