@wix/auto_sdk_online-programs_online-program-participants 1.0.3 → 1.0.5

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 (21) hide show
  1. package/build/cjs/index.js.map +1 -1
  2. package/build/cjs/index.typings.d.ts +273 -45
  3. package/build/cjs/index.typings.js.map +1 -1
  4. package/build/cjs/meta.d.ts +103 -19
  5. package/build/cjs/meta.js.map +1 -1
  6. package/build/es/index.mjs.map +1 -1
  7. package/build/es/index.typings.d.mts +273 -45
  8. package/build/es/index.typings.mjs.map +1 -1
  9. package/build/es/meta.d.mts +103 -19
  10. package/build/es/meta.mjs.map +1 -1
  11. package/build/internal/cjs/index.js.map +1 -1
  12. package/build/internal/cjs/index.typings.d.ts +273 -45
  13. package/build/internal/cjs/index.typings.js.map +1 -1
  14. package/build/internal/cjs/meta.d.ts +103 -19
  15. package/build/internal/cjs/meta.js.map +1 -1
  16. package/build/internal/es/index.mjs.map +1 -1
  17. package/build/internal/es/index.typings.d.mts +273 -45
  18. package/build/internal/es/index.typings.mjs.map +1 -1
  19. package/build/internal/es/meta.d.mts +103 -19
  20. package/build/internal/es/meta.mjs.map +1 -1
  21. package/package.json +2 -2
package/build/internal/cjs/index.typings.d.ts CHANGED
@@ -572,13 +572,23 @@ interface RemoveCouponFromOrderResponse {
572
572
  total?: string;
573
573
  }
574
574
  interface ListParticipantStepsRequest {
575
- /** @format GUID */
575
+ /**
576
+ * Challenge/Program (tenant) ID. GUID.
577
+ * @format GUID
578
+ */
576
579
  challengeId: string;
577
- /** @format GUID */
580
+ /**
581
+ * Participant entity ID within the challenge. GUID.
582
+ * @format GUID
583
+ */
578
584
  participantId: string;
585
+ /** Optional parent step ID to scope to sub-steps. */
579
586
  parentId?: string;
587
+ /** Optional absolute time window for time-based progress. */
580
588
  timeInterval?: TimeInterval;
589
+ /** Optional local date window for date-based progress. */
581
590
  dateInterval?: DateInterval;
591
+ /** Controls verbose description fields in response. */
582
592
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
583
593
  }
584
594
  declare enum DescriptionFieldSet {
@@ -590,6 +600,7 @@ declare enum DescriptionFieldSet {
590
600
  /** @enumType */
591
601
  type DescriptionFieldSetWithLiterals = DescriptionFieldSet | 'EXTENDED' | 'STANDARD';
592
602
  interface ListParticipantStepsResponse {
603
+ /** Participant steps matching the query. */
593
604
  steps?: ParticipantStep[];
594
605
  }
595
606
  interface ParticipantStep {
@@ -875,28 +886,52 @@ interface QuizSubmission {
875
886
  passingGrade?: number | null;
876
887
  }
877
888
  interface GetParticipantStepRequest {
878
- /** @format GUID */
889
+ /**
890
+ * Challenge/Program (tenant) ID. GUID.
891
+ * @format GUID
892
+ */
879
893
  challengeId: string;
880
- /** @format GUID */
894
+ /**
895
+ * Participant entity ID. GUID.
896
+ * @format GUID
897
+ */
881
898
  participantId: string;
899
+ /** Step ID (program step or resolved instance). */
882
900
  stepId: string;
901
+ /** Optional absolute time window for time-based progress. */
883
902
  timeInterval?: TimeInterval;
903
+ /** Controls verbose description fields in response. */
884
904
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
885
905
  }
886
906
  interface GetParticipantStepResponse {
907
+ /** Requested participant step details. */
887
908
  step?: ParticipantStep;
909
+ /** Immediate sub-steps for hierarchical steps (if any). */
888
910
  subSteps?: ParticipantStep[];
889
911
  }
890
912
  interface ResolveParticipantStepRequest {
891
- /** @format GUID */
913
+ /**
914
+ * Challenge/Program (tenant) ID. GUID.
915
+ * @format GUID
916
+ */
892
917
  challengeId: string;
893
- /** @format GUID */
918
+ /**
919
+ * Participant entity ID. GUID.
920
+ * @format GUID
921
+ */
894
922
  participantId: string;
923
+ /** Target step ID to resolve. */
895
924
  stepId: string;
925
+ /** Resolution action to apply. */
896
926
  status?: ResolutionStatusWithLiterals;
927
+ /** Optional instructor feedback payload. */
897
928
  feedback?: Feedback;
929
+ /** Optional idempotency key for action tracking. */
898
930
  actionId?: string;
899
- /** @format GUID */
931
+ /**
932
+ * Optional quiz submission to attach. GUID.
933
+ * @format GUID
934
+ */
900
935
  quizSubmissionId?: string | null;
901
936
  }
902
937
  declare enum ResolutionStatus {
@@ -908,8 +943,12 @@ declare enum ResolutionStatus {
908
943
  /** @enumType */
909
944
  type ResolutionStatusWithLiterals = ResolutionStatus | 'COMPLETED' | 'SKIPPED' | 'UNDO' | 'QUIZ_SUBMIT';
910
945
  interface ResolveParticipantStepResponse {
946
+ /** Updated participant step after resolution. */
911
947
  step?: ParticipantStep;
912
- /** @format GUID */
948
+ /**
949
+ * Server-generated action id. GUID.
950
+ * @format GUID
951
+ */
913
952
  actionId?: string;
914
953
  }
915
954
  interface StepResolved {
@@ -958,39 +997,71 @@ declare enum Status {
958
997
  /** @enumType */
959
998
  type StatusWithLiterals = Status | 'COMPLETED' | 'FAILED';
960
999
  interface UpdateStepFeedbackRequest {
961
- /** @format GUID */
1000
+ /**
1001
+ * Challenge/Program (tenant) ID. GUID.
1002
+ * @format GUID
1003
+ */
962
1004
  challengeId: string;
963
- /** @format GUID */
1005
+ /**
1006
+ * Participant entity ID. GUID.
1007
+ * @format GUID
1008
+ */
964
1009
  participantId: string;
1010
+ /** Target step ID to update feedback for. */
965
1011
  stepId: string;
1012
+ /** New feedback payload. */
966
1013
  feedback?: Feedback;
967
- /** @format GUID */
1014
+ /**
1015
+ * Idempotency key for feedback update. GUID.
1016
+ * @format GUID
1017
+ */
968
1018
  actionId?: string;
969
1019
  }
970
1020
  interface UpdateStepFeedbackResponse {
1021
+ /** Participant step with updated feedback. */
971
1022
  step?: ParticipantStep;
972
- /** @format GUID */
1023
+ /**
1024
+ * Server-generated action id. GUID.
1025
+ * @format GUID
1026
+ */
973
1027
  actionId?: string;
974
1028
  }
975
1029
  interface GetMediaUploadInfoRequest {
976
- /** @format GUID */
1030
+ /**
1031
+ * Challenge/Program (tenant) ID. GUID.
1032
+ * @format GUID
1033
+ */
977
1034
  challengeId: string;
978
- /** @format GUID */
1035
+ /**
1036
+ * Participant entity ID. GUID.
1037
+ * @format GUID
1038
+ */
979
1039
  participantId: string;
1040
+ /** Original filename to derive content-type and path. */
980
1041
  fileName?: string;
981
1042
  }
982
1043
  interface GetMediaUploadInfoResponse {
1044
+ /** Pre-signed URL to upload media. */
983
1045
  uploadUrl?: string;
1046
+ /** Token required by media service for upload. */
984
1047
  uploadToken?: string;
985
1048
  }
986
1049
  interface ListParticipantSectionsRequest {
987
- /** @format GUID */
1050
+ /**
1051
+ * Challenge/Program (tenant) ID. GUID.
1052
+ * @format GUID
1053
+ */
988
1054
  challengeId: string;
989
- /** @format GUID */
1055
+ /**
1056
+ * Participant entity ID. GUID.
1057
+ * @format GUID
1058
+ */
990
1059
  participantId: string;
1060
+ /** Controls verbose description fields in response. */
991
1061
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
992
1062
  }
993
1063
  interface ListParticipantSectionsResponse {
1064
+ /** Participant sections for the program. */
994
1065
  sections?: ParticipantSection[];
995
1066
  }
996
1067
  interface ParticipantSection {
@@ -1050,15 +1121,26 @@ interface Progress {
1050
1121
  nCompletedSteps?: string;
1051
1122
  }
1052
1123
  interface GetParticipantSectionRequest {
1053
- /** @format GUID */
1124
+ /**
1125
+ * Challenge/Program (tenant) ID. GUID.
1126
+ * @format GUID
1127
+ */
1054
1128
  challengeId: string;
1055
- /** @format GUID */
1129
+ /**
1130
+ * Participant entity ID. GUID.
1131
+ * @format GUID
1132
+ */
1056
1133
  participantId: string;
1057
- /** @format GUID */
1134
+ /**
1135
+ * Section ID to fetch. GUID.
1136
+ * @format GUID
1137
+ */
1058
1138
  sectionId: string;
1139
+ /** Controls verbose description fields in response. */
1059
1140
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1060
1141
  }
1061
1142
  interface GetParticipantSectionResponse {
1143
+ /** Requested participant section details. */
1062
1144
  section?: ParticipantSection;
1063
1145
  }
1064
1146
  interface MyProgramRequest {
@@ -1073,6 +1155,7 @@ interface MyProgramStepRequest {
1073
1155
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1074
1156
  }
1075
1157
  interface MyProgramStepResponse {
1158
+ /** Viewer's participant step derived for the program step. */
1076
1159
  participantStep?: ParticipantStep;
1077
1160
  }
1078
1161
  interface MyProgramSectionRequest {
@@ -1081,6 +1164,7 @@ interface MyProgramSectionRequest {
1081
1164
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1082
1165
  }
1083
1166
  interface MyProgramSectionResponse {
1167
+ /** Viewer's participant section derived for the program section. */
1084
1168
  participantSection?: ParticipantSection;
1085
1169
  }
1086
1170
  interface DomainEvent extends DomainEventBodyOneOf {
@@ -1294,6 +1378,9 @@ interface ParticipantStepResolvedEnvelope {
1294
1378
  declare function onParticipantStepResolved(handler: (event: ParticipantStepResolvedEnvelope) => void | Promise<void>): void;
1295
1379
  /** @public
1296
1380
  * @requiredField challengeId
1381
+ * @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
1382
+ * @applicableIdentity APP
1383
+ * @applicableIdentity MEMBER
1297
1384
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.QueryParticipants
1298
1385
  */
1299
1386
  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>>;
@@ -1304,6 +1391,9 @@ interface QueryParticipantsOptions {
1304
1391
  }
1305
1392
  /** @public
1306
1393
  * @requiredField challengeId
1394
+ * @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
1395
+ * @applicableIdentity APP
1396
+ * @applicableIdentity MEMBER
1307
1397
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListParticipants
1308
1398
  * @deprecated
1309
1399
  */
@@ -1325,6 +1415,9 @@ interface ListParticipantsOptions {
1325
1415
  }
1326
1416
  /** @public
1327
1417
  * @requiredField challengeId
1418
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_JOIN
1419
+ * @applicableIdentity APP
1420
+ * @applicableIdentity MEMBER
1328
1421
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.JoinParticipant
1329
1422
  */
1330
1423
  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>>;
@@ -1346,6 +1439,8 @@ interface JoinParticipantOptions {
1346
1439
  * @public
1347
1440
  * @documentationMaturity preview
1348
1441
  * @requiredField challengeId
1442
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
1443
+ * @applicableIdentity APP
1349
1444
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.AddParticipant
1350
1445
  */
1351
1446
  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>>;
@@ -1360,6 +1455,8 @@ interface AddParticipantOptions {
1360
1455
  * @public
1361
1456
  * @documentationMaturity preview
1362
1457
  * @requiredField challengeId
1458
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
1459
+ * @applicableIdentity APP
1363
1460
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.AddParticipants
1364
1461
  */
1365
1462
  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>>;
@@ -1375,6 +1472,8 @@ interface AddParticipantsOptions {
1375
1472
  /** @public
1376
1473
  * @documentationMaturity preview
1377
1474
  * @requiredField challengeId
1475
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
1476
+ * @applicableIdentity APP
1378
1477
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.AddAllParticipant
1379
1478
  */
1380
1479
  declare function addAllParticipant(challengeId: string, options?: AddAllParticipantOptions): Promise<void>;
@@ -1384,6 +1483,9 @@ interface AddAllParticipantOptions {
1384
1483
  }
1385
1484
  /** @public
1386
1485
  * @requiredField challengeId
1486
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_JOIN
1487
+ * @applicableIdentity APP
1488
+ * @applicableIdentity MEMBER
1387
1489
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.CreateJoinRequest
1388
1490
  */
1389
1491
  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>>;
@@ -1397,6 +1499,8 @@ interface CreateJoinRequestOptions {
1397
1499
  }
1398
1500
  /** @public
1399
1501
  * @requiredField challengeId
1502
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
1503
+ * @applicableIdentity APP
1400
1504
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.InviteParticipants
1401
1505
  */
1402
1506
  declare function inviteParticipants(challengeId: string, options?: InviteParticipantsOptions): Promise<NonNullablePaths<InviteParticipantsResponse, `invitations` | `invitations.${number}.participantId` | `invitations.${number}.approvalRequestId` | `actionId`, 4>>;
@@ -1407,6 +1511,8 @@ interface InviteParticipantsOptions {
1407
1511
  }
1408
1512
  /** @public
1409
1513
  * @requiredField challengeId
1514
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ADD
1515
+ * @applicableIdentity APP
1410
1516
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.InviteAllParticipants
1411
1517
  */
1412
1518
  declare function inviteAllParticipants(challengeId: string, options?: InviteAllParticipantsOptions): Promise<void>;
@@ -1420,6 +1526,9 @@ interface InviteAllParticipantsOptions {
1420
1526
  * @requiredField identifiers
1421
1527
  * @requiredField identifiers.challengeId
1422
1528
  * @requiredField identifiers.participantId
1529
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
1530
+ * @applicableIdentity APP
1531
+ * @applicableIdentity MEMBER
1423
1532
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetParticipant
1424
1533
  */
1425
1534
  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>>;
@@ -1433,6 +1542,7 @@ interface GetParticipantIdentifiers {
1433
1542
  * @requiredField identifiers
1434
1543
  * @requiredField identifiers.challengeId
1435
1544
  * @requiredField identifiers.participantId
1545
+ * @permissionId CHALLENGE-PARTICIPATE.UPDATE-PARTICIPANT
1436
1546
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.UpdateParticipant
1437
1547
  */
1438
1548
  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>>;
@@ -1461,6 +1571,9 @@ interface UpdateParticipantOptionsUpdateOneOf {
1461
1571
  * @requiredField identifiers
1462
1572
  * @requiredField identifiers.challengeId
1463
1573
  * @requiredField identifiers.participantId
1574
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_REMOVE
1575
+ * @applicableIdentity APP
1576
+ * @applicableIdentity MEMBER
1464
1577
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.DeleteParticipant
1465
1578
  */
1466
1579
  declare function deleteParticipant(identifiers: NonNullablePaths<DeleteParticipantIdentifiers, `challengeId` | `participantId`, 2>, options?: DeleteParticipantOptions): Promise<NonNullablePaths<DeleteParticipantResponse, `actionId`, 2>>;
@@ -1478,6 +1591,7 @@ interface DeleteParticipantOptions {
1478
1591
  * @requiredField identifiers
1479
1592
  * @requiredField identifiers.challengeId
1480
1593
  * @requiredField identifiers.participantId
1594
+ * @permissionId CHALLENGE-PARTICIPATE.UPDATE-PARTICIPANT
1481
1595
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ReviveParticipant
1482
1596
  */
1483
1597
  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>>;
@@ -1495,6 +1609,7 @@ interface ReviveParticipantOptions {
1495
1609
  * @requiredField identifiers
1496
1610
  * @requiredField identifiers.challengeId
1497
1611
  * @requiredField identifiers.participantId
1612
+ * @permissionId CHALLENGE-PARTICIPATE.UPDATE-PARTICIPANT
1498
1613
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ResetParticipantProgress
1499
1614
  */
1500
1615
  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>>;
@@ -1514,6 +1629,8 @@ interface ResetParticipantProgressOptions {
1514
1629
  * @requiredField identifiers
1515
1630
  * @requiredField identifiers.challengeId
1516
1631
  * @requiredField identifiers.participantId
1632
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ISSUE_CERTIFICATE
1633
+ * @applicableIdentity APP
1517
1634
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.IssueParticipantCertificate
1518
1635
  */
1519
1636
  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>>;
@@ -1533,6 +1650,8 @@ interface IssueParticipantCertificateIdentifiers {
1533
1650
  * @requiredField identifiers
1534
1651
  * @requiredField identifiers.challengeId
1535
1652
  * @requiredField identifiers.participantId
1653
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_ISSUE_CERTIFICATE
1654
+ * @applicableIdentity APP
1536
1655
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.IssueCertificate
1537
1656
  */
1538
1657
  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>>;
@@ -1552,6 +1671,9 @@ interface IssueCertificateIdentifiers {
1552
1671
  * @requiredField identifiers
1553
1672
  * @requiredField identifiers.challengeId
1554
1673
  * @requiredField identifiers.participantId
1674
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
1675
+ * @applicableIdentity APP
1676
+ * @applicableIdentity MEMBER
1555
1677
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetCertificate
1556
1678
  */
1557
1679
  declare function getCertificate(identifiers: NonNullablePaths<GetCertificateIdentifiers, `challengeId` | `participantId`, 2>): Promise<NonNullablePaths<GetCertificateResponse, `certificateUrl`, 2>>;
@@ -1571,6 +1693,9 @@ interface GetCertificateIdentifiers {
1571
1693
  * @requiredField identifiers
1572
1694
  * @requiredField identifiers.challengeId
1573
1695
  * @requiredField identifiers.participantId
1696
+ * @permissionId CHALLENGE-PARTICIPATE.CREATE-ORDER
1697
+ * @applicableIdentity APP
1698
+ * @applicableIdentity MEMBER
1574
1699
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.CreatePaymentOrder
1575
1700
  */
1576
1701
  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>>;
@@ -1595,6 +1720,9 @@ interface CreatePaymentOrderOptions {
1595
1720
  * @requiredField identifiers.challengeId
1596
1721
  * @requiredField identifiers.orderId
1597
1722
  * @requiredField identifiers.participantId
1723
+ * @permissionId CHALLENGE-PARTICIPATE.CREATE-ORDER
1724
+ * @applicableIdentity APP
1725
+ * @applicableIdentity MEMBER
1598
1726
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ApplyCouponToOrder
1599
1727
  */
1600
1728
  declare function applyCouponToOrder(identifiers: NonNullablePaths<ApplyCouponToOrderIdentifiers, `challengeId` | `orderId` | `participantId`, 2>, couponCode: string, options?: ApplyCouponToOrderOptions): Promise<NonNullablePaths<ApplyCouponToOrderResponse, `couponId` | `subTotal` | `discount` | `total`, 2>>;
@@ -1616,6 +1744,9 @@ interface ApplyCouponToOrderOptions {
1616
1744
  * @requiredField identifiers.couponId
1617
1745
  * @requiredField identifiers.orderId
1618
1746
  * @requiredField identifiers.participantId
1747
+ * @permissionId CHALLENGE-PARTICIPATE.CREATE-ORDER
1748
+ * @applicableIdentity APP
1749
+ * @applicableIdentity MEMBER
1619
1750
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.RemoveCouponFromOrder
1620
1751
  */
1621
1752
  declare function removeCouponFromOrder(identifiers: NonNullablePaths<RemoveCouponFromOrderIdentifiers, `challengeId` | `couponId` | `orderId` | `participantId`, 2>, options?: RemoveCouponFromOrderOptions): Promise<NonNullablePaths<RemoveCouponFromOrderResponse, `total`, 2>>;
@@ -1637,21 +1768,35 @@ interface RemoveCouponFromOrderOptions {
1637
1768
  * @requiredField identifiers
1638
1769
  * @requiredField identifiers.challengeId
1639
1770
  * @requiredField identifiers.participantId
1771
+ * @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
1772
+ * @applicableIdentity APP
1773
+ * @applicableIdentity MEMBER
1640
1774
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListSteps
1641
1775
  * @deprecated
1642
- * @targetRemovalDate 2025-10-01
1776
+ * @replacedBy Program Steps service List
1777
+ * @targetRemovalDate 2026-06-30
1643
1778
  */
1644
1779
  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>>;
1645
1780
  interface ListStepsIdentifiers {
1646
- /** @format GUID */
1781
+ /**
1782
+ * Challenge/Program (tenant) ID. GUID.
1783
+ * @format GUID
1784
+ */
1647
1785
  challengeId: string;
1648
- /** @format GUID */
1786
+ /**
1787
+ * Participant entity ID within the challenge. GUID.
1788
+ * @format GUID
1789
+ */
1649
1790
  participantId: string;
1650
1791
  }
1651
1792
  interface ListStepsOptions {
1793
+ /** Optional parent step ID to scope to sub-steps. */
1652
1794
  parentId?: string;
1795
+ /** Optional absolute time window for time-based progress. */
1653
1796
  timeInterval?: TimeInterval;
1797
+ /** Optional local date window for date-based progress. */
1654
1798
  dateInterval?: DateInterval;
1799
+ /** Controls verbose description fields in response. */
1655
1800
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1656
1801
  }
1657
1802
  /** @public
@@ -1659,20 +1804,33 @@ interface ListStepsOptions {
1659
1804
  * @requiredField identifiers.challengeId
1660
1805
  * @requiredField identifiers.participantId
1661
1806
  * @requiredField identifiers.stepId
1807
+ * @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
1808
+ * @applicableIdentity APP
1809
+ * @applicableIdentity MEMBER
1662
1810
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetStep
1663
1811
  * @deprecated
1664
- * @targetRemovalDate 2025-10-01
1812
+ * @replacedBy Program Steps service Get
1813
+ * @targetRemovalDate 2026-06-30
1665
1814
  */
1666
1815
  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>>;
1667
1816
  interface GetStepIdentifiers {
1668
- /** @format GUID */
1817
+ /**
1818
+ * Challenge/Program (tenant) ID. GUID.
1819
+ * @format GUID
1820
+ */
1669
1821
  challengeId: string;
1670
- /** @format GUID */
1822
+ /**
1823
+ * Participant entity ID. GUID.
1824
+ * @format GUID
1825
+ */
1671
1826
  participantId: string;
1827
+ /** Step ID (program step or resolved instance). */
1672
1828
  stepId: string;
1673
1829
  }
1674
1830
  interface GetStepOptions {
1831
+ /** Optional absolute time window for time-based progress. */
1675
1832
  timeInterval?: TimeInterval;
1833
+ /** Controls verbose description fields in response. */
1676
1834
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1677
1835
  }
1678
1836
  /** @public
@@ -1680,23 +1838,39 @@ interface GetStepOptions {
1680
1838
  * @requiredField identifiers.challengeId
1681
1839
  * @requiredField identifiers.participantId
1682
1840
  * @requiredField identifiers.stepId
1841
+ * @permissionId CHALLENGE-PARTICIPATE.COMPLETE-PARTICIPANT-STEP
1842
+ * @applicableIdentity APP
1843
+ * @applicableIdentity MEMBER
1683
1844
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ResolveStep
1684
1845
  * @deprecated
1685
- * @targetRemovalDate 2025-10-01
1846
+ * @targetRemovalDate 2026-06-30
1686
1847
  */
1687
1848
  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>>;
1688
1849
  interface ResolveStepIdentifiers {
1689
- /** @format GUID */
1850
+ /**
1851
+ * Challenge/Program (tenant) ID. GUID.
1852
+ * @format GUID
1853
+ */
1690
1854
  challengeId: string;
1691
- /** @format GUID */
1855
+ /**
1856
+ * Participant entity ID. GUID.
1857
+ * @format GUID
1858
+ */
1692
1859
  participantId: string;
1860
+ /** Target step ID to resolve. */
1693
1861
  stepId: string;
1694
1862
  }
1695
1863
  interface ResolveStepOptions {
1864
+ /** Resolution action to apply. */
1696
1865
  status?: ResolutionStatusWithLiterals;
1866
+ /** Optional instructor feedback payload. */
1697
1867
  feedback?: Feedback;
1868
+ /** Optional idempotency key for action tracking. */
1698
1869
  actionId?: string;
1699
- /** @format GUID */
1870
+ /**
1871
+ * Optional quiz submission to attach. GUID.
1872
+ * @format GUID
1873
+ */
1700
1874
  quizSubmissionId?: string | null;
1701
1875
  }
1702
1876
  /** @public
@@ -1704,39 +1878,61 @@ interface ResolveStepOptions {
1704
1878
  * @requiredField identifiers.challengeId
1705
1879
  * @requiredField identifiers.participantId
1706
1880
  * @requiredField identifiers.stepId
1881
+ * @permissionId CHALLENGE-PARTICIPATE.COMPLETE-PARTICIPANT-STEP
1882
+ * @applicableIdentity APP
1883
+ * @applicableIdentity MEMBER
1707
1884
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.UpdateStepFeedback
1708
1885
  * @deprecated
1709
- * @targetRemovalDate 2025-10-01
1886
+ * @targetRemovalDate 2026-06-30
1710
1887
  */
1711
1888
  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>>;
1712
1889
  interface UpdateStepFeedbackIdentifiers {
1713
- /** @format GUID */
1890
+ /**
1891
+ * Challenge/Program (tenant) ID. GUID.
1892
+ * @format GUID
1893
+ */
1714
1894
  challengeId: string;
1715
- /** @format GUID */
1895
+ /**
1896
+ * Participant entity ID. GUID.
1897
+ * @format GUID
1898
+ */
1716
1899
  participantId: string;
1900
+ /** Target step ID to update feedback for. */
1717
1901
  stepId: string;
1718
1902
  }
1719
1903
  interface UpdateStepFeedbackOptions {
1904
+ /** New feedback payload. */
1720
1905
  feedback?: Feedback;
1721
- /** @format GUID */
1906
+ /**
1907
+ * Idempotency key for feedback update. GUID.
1908
+ * @format GUID
1909
+ */
1722
1910
  actionId?: string;
1723
1911
  }
1724
1912
  /** @public
1725
1913
  * @requiredField identifiers
1726
1914
  * @requiredField identifiers.challengeId
1727
1915
  * @requiredField identifiers.participantId
1916
+ * @permissionId CHALLENGE-PARTICIPATE.UPLOAD-MEDIA
1728
1917
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetMediaUploadInfo
1729
1918
  * @deprecated
1730
- * @targetRemovalDate 2025-10-01
1919
+ * @targetRemovalDate 2026-06-30
1731
1920
  */
1732
1921
  declare function getMediaUploadInfo(identifiers: NonNullablePaths<GetMediaUploadInfoIdentifiers, `challengeId` | `participantId`, 2>, options?: GetMediaUploadInfoOptions): Promise<NonNullablePaths<GetMediaUploadInfoResponse, `uploadUrl` | `uploadToken`, 2>>;
1733
1922
  interface GetMediaUploadInfoIdentifiers {
1734
- /** @format GUID */
1923
+ /**
1924
+ * Challenge/Program (tenant) ID. GUID.
1925
+ * @format GUID
1926
+ */
1735
1927
  challengeId: string;
1736
- /** @format GUID */
1928
+ /**
1929
+ * Participant entity ID. GUID.
1930
+ * @format GUID
1931
+ */
1737
1932
  participantId: string;
1738
1933
  }
1739
1934
  interface GetMediaUploadInfoOptions {
1935
+ /** Original filename to derive content-type and path. */
1740
1936
  fileName?: string;
1741
1937
  }
1742
1938
  /**
@@ -1745,18 +1941,28 @@ interface GetMediaUploadInfoOptions {
1745
1941
  * @requiredField identifiers
1746
1942
  * @requiredField identifiers.challengeId
1747
1943
  * @requiredField identifiers.participantId
1944
+ * @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
1945
+ * @applicableIdentity APP
1946
+ * @applicableIdentity MEMBER
1748
1947
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.ListSections
1749
1948
  * @deprecated
1750
- * @targetRemovalDate 2025-10-01
1949
+ * @targetRemovalDate 2026-06-30
1751
1950
  */
1752
1951
  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>>;
1753
1952
  interface ListSectionsIdentifiers {
1754
- /** @format GUID */
1953
+ /**
1954
+ * Challenge/Program (tenant) ID. GUID.
1955
+ * @format GUID
1956
+ */
1755
1957
  challengeId: string;
1756
- /** @format GUID */
1958
+ /**
1959
+ * Participant entity ID. GUID.
1960
+ * @format GUID
1961
+ */
1757
1962
  participantId: string;
1758
1963
  }
1759
1964
  interface ListSectionsOptions {
1965
+ /** Controls verbose description fields in response. */
1760
1966
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1761
1967
  }
1762
1968
  /** @public
@@ -1764,24 +1970,40 @@ interface ListSectionsOptions {
1764
1970
  * @requiredField identifiers.challengeId
1765
1971
  * @requiredField identifiers.participantId
1766
1972
  * @requiredField identifiers.sectionId
1973
+ * @permissionId CHALLENGE-PARTICIPATE.FIND-PARTICIPANT
1974
+ * @applicableIdentity APP
1975
+ * @applicableIdentity MEMBER
1767
1976
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.GetSection
1768
1977
  * @deprecated
1769
- * @targetRemovalDate 2025-10-01
1978
+ * @targetRemovalDate 2026-06-30
1770
1979
  */
1771
1980
  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>>;
1772
1981
  interface GetSectionIdentifiers {
1773
- /** @format GUID */
1982
+ /**
1983
+ * Challenge/Program (tenant) ID. GUID.
1984
+ * @format GUID
1985
+ */
1774
1986
  challengeId: string;
1775
- /** @format GUID */
1987
+ /**
1988
+ * Participant entity ID. GUID.
1989
+ * @format GUID
1990
+ */
1776
1991
  participantId: string;
1777
- /** @format GUID */
1992
+ /**
1993
+ * Section ID to fetch. GUID.
1994
+ * @format GUID
1995
+ */
1778
1996
  sectionId: string;
1779
1997
  }
1780
1998
  interface GetSectionOptions {
1999
+ /** Controls verbose description fields in response. */
1781
2000
  descriptionFieldSet?: DescriptionFieldSetWithLiterals;
1782
2001
  }
1783
2002
  /** @public
1784
2003
  * @requiredField programId
2004
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
2005
+ * @applicableIdentity APP
2006
+ * @applicableIdentity MEMBER
1785
2007
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgram
1786
2008
  */
1787
2009
  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>>;
@@ -1789,9 +2011,12 @@ declare function myProgram(programId: string): Promise<NonNullablePaths<MyProgra
1789
2011
  * @requiredField identifiers
1790
2012
  * @requiredField identifiers.programId
1791
2013
  * @requiredField identifiers.programStepId
2014
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
2015
+ * @applicableIdentity APP
2016
+ * @applicableIdentity MEMBER
1792
2017
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgramStep
1793
2018
  * @deprecated
1794
- * @targetRemovalDate 2025-10-01
2019
+ * @targetRemovalDate 2026-06-30
1795
2020
  */
1796
2021
  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>>;
1797
2022
  interface MyProgramStepIdentifiers {
@@ -1805,9 +2030,12 @@ interface MyProgramStepOptions {
1805
2030
  * @requiredField identifiers
1806
2031
  * @requiredField identifiers.programId
1807
2032
  * @requiredField identifiers.programSectionId
2033
+ * @permissionId ONLINE_PROGRAMS.PARTICIPANT_READ
2034
+ * @applicableIdentity APP
2035
+ * @applicableIdentity MEMBER
1808
2036
  * @fqn com.wixpress.achievements.api.v1.ParticipantsService.MyProgramSection
1809
2037
  * @deprecated
1810
- * @targetRemovalDate 2025-10-01
2038
+ * @targetRemovalDate 2026-06-30
1811
2039
  */
1812
2040
  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>>;
1813
2041
  interface MyProgramSectionIdentifiers {