@wix/auto_sdk_online-programs_quizzes 1.0.31 → 1.0.33
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +0 -4
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +5 -11
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +5 -7
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +0 -4
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +5 -11
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +5 -7
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +0 -4
- package/build/internal/cjs/index.typings.d.ts +5 -11
- package/build/internal/cjs/meta.d.ts +5 -7
- package/build/internal/es/index.d.mts +0 -4
- package/build/internal/es/index.typings.d.mts +5 -11
- package/build/internal/es/meta.d.mts +5 -7
- package/package.json +2 -2
|
@@ -76,8 +76,6 @@ interface DeleteQuizSignature {
|
|
|
76
76
|
* This operation doesn't check whether Online Programs steps reference the quiz. Coordinate deletion with the Steps API and remove known step references first. Otherwise, steps can retain dangling quiz references.
|
|
77
77
|
*
|
|
78
78
|
* To delete multiple quiz definitions in a single API call, call [Bulk Delete Quizzes](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/bulk-delete-quizzes).
|
|
79
|
-
*
|
|
80
|
-
* NOT-PRECEDENT: This caller-responsibility behavior is retained as a production v1 compatibility exception. New delete APIs should provide an authoritative server-side reference safeguard.
|
|
81
79
|
* @param - ID of the quiz definition to permanently delete.
|
|
82
80
|
*/
|
|
83
81
|
(quizId: string): Promise<NonNullablePaths<DeleteQuizResponse, `quiz.fields` | `quiz.fields.${number}._id`, 3> & {
|
|
@@ -94,8 +92,6 @@ interface BulkDeleteQuizzesSignature {
|
|
|
94
92
|
* This operation doesn't check whether Online Programs steps reference the quizzes. Coordinate deletion with the Steps API and remove known step references first. Otherwise, steps can retain dangling quiz references.
|
|
95
93
|
*
|
|
96
94
|
* To delete a single quiz definition, call [Delete Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/delete-quiz).
|
|
97
|
-
*
|
|
98
|
-
* NOT-PRECEDENT: This caller-responsibility behavior is retained as a production v1 compatibility exception. New bulk-delete APIs should provide an authoritative server-side reference safeguard.
|
|
99
95
|
* @param - IDs of the quiz definitions to permanently delete. Coordinate deletion with the Steps API and remove known step references first.
|
|
100
96
|
*/
|
|
101
97
|
(quizIds: string[]): Promise<NonNullablePaths<BulkDeleteQuizzesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
|
|
@@ -6,8 +6,6 @@ import { NonNullablePaths } from '@wix/sdk-types';
|
|
|
6
6
|
* Create or clone a quiz, then assign the returned quiz ID to `step.quizOptions.id` when creating an Online Programs step. Quiz IDs are intentionally discovered through quiz-type steps rather than through a Quiz list or query method.
|
|
7
7
|
*
|
|
8
8
|
* New submissions are evaluated against the quiz definition that exists when the submission is created. Previously stored submissions retain their recorded grades and answer evaluations if the definition changes later.
|
|
9
|
-
*
|
|
10
|
-
* NOT-PRECEDENT: The production v1 entity retains its legacy `wix.achievements.quizzes.v1.quiz` identity for compatibility. The Online Programs placement and workflow described here provide its public product context.
|
|
11
9
|
*/
|
|
12
10
|
interface Quiz {
|
|
13
11
|
/**
|
|
@@ -54,7 +52,7 @@ interface QuizSettings {
|
|
|
54
52
|
*/
|
|
55
53
|
title?: string | null;
|
|
56
54
|
/**
|
|
57
|
-
* Maximum number of submissions allowed per submitter. If omitted, no attempt-limit check is applied.
|
|
55
|
+
* Maximum number of submissions allowed per submitter. If omitted, no attempt-limit check is applied. Submissions grouped together share an attempt count, even across quizzes. See [Attempt limits](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/quiz-grading#attempt-limits) for how submissions are counted.
|
|
58
56
|
* @min 1
|
|
59
57
|
*/
|
|
60
58
|
attempts?: number | null;
|
|
@@ -140,7 +138,7 @@ interface NumericField {
|
|
|
140
138
|
/**
|
|
141
139
|
* Correct numeric value. Matching is exact. If no correct value is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
142
140
|
*
|
|
143
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct value is stored.
|
|
141
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct value is stored.
|
|
144
142
|
*/
|
|
145
143
|
rightAnswer?: number | null;
|
|
146
144
|
}
|
|
@@ -148,7 +146,7 @@ interface ShortTextField {
|
|
|
148
146
|
/**
|
|
149
147
|
* Correct text. Matching trims leading and trailing whitespace and is case-insensitive. If no correct text is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
150
148
|
*
|
|
151
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct text is stored.
|
|
149
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct text is stored.
|
|
152
150
|
* @minLength 1
|
|
153
151
|
* @maxLength 200
|
|
154
152
|
*/
|
|
@@ -161,7 +159,7 @@ interface SingleChoiceField {
|
|
|
161
159
|
/**
|
|
162
160
|
* Correct option. When supplied, it must exactly match an entry in `options`; otherwise, creation fails with INVALID_QUIZ. Matching submitted answers is exact. If no correct option is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
163
161
|
*
|
|
164
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct option is stored.
|
|
162
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct option is stored.
|
|
165
163
|
* @minLength 1
|
|
166
164
|
* @maxLength 350
|
|
167
165
|
*/
|
|
@@ -180,7 +178,7 @@ interface MultiChoiceField {
|
|
|
180
178
|
/**
|
|
181
179
|
* Correct options. Every supplied value must exactly match an entry in `options`; otherwise, creation fails with INVALID_QUIZ. Matching submitted answers ignores option order but doesn't ignore duplicate values. If no correct options are stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
182
180
|
*
|
|
183
|
-
* Empty in responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove stored keys or change grading; an empty response list doesn't mean no correct options are stored.
|
|
181
|
+
* Empty in responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove stored keys or change grading; an empty response list doesn't mean no correct options are stored.
|
|
184
182
|
* @maxSize 90
|
|
185
183
|
* @minLength 1
|
|
186
184
|
* @maxLength 350
|
|
@@ -669,8 +667,6 @@ declare function getQuiz(quizId: string): Promise<NonNullablePaths<Quiz, `fields
|
|
|
669
667
|
* This operation doesn't check whether Online Programs steps reference the quiz. Coordinate deletion with the Steps API and remove known step references first. Otherwise, steps can retain dangling quiz references.
|
|
670
668
|
*
|
|
671
669
|
* To delete multiple quiz definitions in a single API call, call [Bulk Delete Quizzes](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/bulk-delete-quizzes).
|
|
672
|
-
*
|
|
673
|
-
* NOT-PRECEDENT: This caller-responsibility behavior is retained as a production v1 compatibility exception. New delete APIs should provide an authoritative server-side reference safeguard.
|
|
674
670
|
* @param quizId - ID of the quiz definition to permanently delete.
|
|
675
671
|
* @public
|
|
676
672
|
* @requiredField quizId
|
|
@@ -689,8 +685,6 @@ declare function deleteQuiz(quizId: string): Promise<NonNullablePaths<DeleteQuiz
|
|
|
689
685
|
* This operation doesn't check whether Online Programs steps reference the quizzes. Coordinate deletion with the Steps API and remove known step references first. Otherwise, steps can retain dangling quiz references.
|
|
690
686
|
*
|
|
691
687
|
* To delete a single quiz definition, call [Delete Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/delete-quiz).
|
|
692
|
-
*
|
|
693
|
-
* NOT-PRECEDENT: This caller-responsibility behavior is retained as a production v1 compatibility exception. New bulk-delete APIs should provide an authoritative server-side reference safeguard.
|
|
694
688
|
* @param quizIds - IDs of the quiz definitions to permanently delete. Coordinate deletion with the Steps API and remove known step references first.
|
|
695
689
|
* @public
|
|
696
690
|
* @documentationMaturity preview
|
|
@@ -7,8 +7,6 @@ import '@wix/sdk-types';
|
|
|
7
7
|
* Create or clone a quiz, then assign the returned quiz ID to `step.quizOptions.id` when creating an Online Programs step. Quiz IDs are intentionally discovered through quiz-type steps rather than through a Quiz list or query method.
|
|
8
8
|
*
|
|
9
9
|
* New submissions are evaluated against the quiz definition that exists when the submission is created. Previously stored submissions retain their recorded grades and answer evaluations if the definition changes later.
|
|
10
|
-
*
|
|
11
|
-
* NOT-PRECEDENT: The production v1 entity retains its legacy `wix.achievements.quizzes.v1.quiz` identity for compatibility. The Online Programs placement and workflow described here provide its public product context.
|
|
12
10
|
*/
|
|
13
11
|
interface Quiz {
|
|
14
12
|
/**
|
|
@@ -55,7 +53,7 @@ interface QuizSettings {
|
|
|
55
53
|
*/
|
|
56
54
|
title?: string | null;
|
|
57
55
|
/**
|
|
58
|
-
* Maximum number of submissions allowed per submitter. If omitted, no attempt-limit check is applied.
|
|
56
|
+
* Maximum number of submissions allowed per submitter. If omitted, no attempt-limit check is applied. Submissions grouped together share an attempt count, even across quizzes. See [Attempt limits](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/quiz-grading#attempt-limits) for how submissions are counted.
|
|
59
57
|
* @min 1
|
|
60
58
|
*/
|
|
61
59
|
attempts?: number | null;
|
|
@@ -141,7 +139,7 @@ interface NumericField {
|
|
|
141
139
|
/**
|
|
142
140
|
* Correct numeric value. Matching is exact. If no correct value is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
143
141
|
*
|
|
144
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct value is stored.
|
|
142
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct value is stored.
|
|
145
143
|
*/
|
|
146
144
|
rightAnswer?: number | null;
|
|
147
145
|
}
|
|
@@ -149,7 +147,7 @@ interface ShortTextField {
|
|
|
149
147
|
/**
|
|
150
148
|
* Correct text. Matching trims leading and trailing whitespace and is case-insensitive. If no correct text is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
151
149
|
*
|
|
152
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct text is stored.
|
|
150
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct text is stored.
|
|
153
151
|
* @minLength 1
|
|
154
152
|
* @maxLength 200
|
|
155
153
|
*/
|
|
@@ -162,7 +160,7 @@ interface SingleChoiceField {
|
|
|
162
160
|
/**
|
|
163
161
|
* Correct option. When supplied, it must exactly match an entry in `options`; otherwise, creation fails with INVALID_QUIZ. Matching submitted answers is exact. If no correct option is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
164
162
|
*
|
|
165
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct option is stored.
|
|
163
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct option is stored.
|
|
166
164
|
* @minLength 1
|
|
167
165
|
* @maxLength 350
|
|
168
166
|
*/
|
|
@@ -181,7 +179,7 @@ interface MultiChoiceField {
|
|
|
181
179
|
/**
|
|
182
180
|
* Correct options. Every supplied value must exactly match an entry in `options`; otherwise, creation fails with INVALID_QUIZ. Matching submitted answers ignores option order but doesn't ignore duplicate values. If no correct options are stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
183
181
|
*
|
|
184
|
-
* Empty in responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove stored keys or change grading; an empty response list doesn't mean no correct options are stored.
|
|
182
|
+
* Empty in responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove stored keys or change grading; an empty response list doesn't mean no correct options are stored.
|
|
185
183
|
* @maxSize 90
|
|
186
184
|
* @minLength 1
|
|
187
185
|
* @maxLength 350
|
|
@@ -76,8 +76,6 @@ interface DeleteQuizSignature {
|
|
|
76
76
|
* This operation doesn't check whether Online Programs steps reference the quiz. Coordinate deletion with the Steps API and remove known step references first. Otherwise, steps can retain dangling quiz references.
|
|
77
77
|
*
|
|
78
78
|
* To delete multiple quiz definitions in a single API call, call [Bulk Delete Quizzes](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/bulk-delete-quizzes).
|
|
79
|
-
*
|
|
80
|
-
* NOT-PRECEDENT: This caller-responsibility behavior is retained as a production v1 compatibility exception. New delete APIs should provide an authoritative server-side reference safeguard.
|
|
81
79
|
* @param - ID of the quiz definition to permanently delete.
|
|
82
80
|
*/
|
|
83
81
|
(quizId: string): Promise<NonNullablePaths<DeleteQuizResponse, `quiz.fields` | `quiz.fields.${number}._id`, 3> & {
|
|
@@ -94,8 +92,6 @@ interface BulkDeleteQuizzesSignature {
|
|
|
94
92
|
* This operation doesn't check whether Online Programs steps reference the quizzes. Coordinate deletion with the Steps API and remove known step references first. Otherwise, steps can retain dangling quiz references.
|
|
95
93
|
*
|
|
96
94
|
* To delete a single quiz definition, call [Delete Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/delete-quiz).
|
|
97
|
-
*
|
|
98
|
-
* NOT-PRECEDENT: This caller-responsibility behavior is retained as a production v1 compatibility exception. New bulk-delete APIs should provide an authoritative server-side reference safeguard.
|
|
99
95
|
* @param - IDs of the quiz definitions to permanently delete. Coordinate deletion with the Steps API and remove known step references first.
|
|
100
96
|
*/
|
|
101
97
|
(quizIds: string[]): Promise<NonNullablePaths<BulkDeleteQuizzesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 4>>;
|
|
@@ -6,8 +6,6 @@ import { NonNullablePaths } from '@wix/sdk-types';
|
|
|
6
6
|
* Create or clone a quiz, then assign the returned quiz ID to `step.quizOptions.id` when creating an Online Programs step. Quiz IDs are intentionally discovered through quiz-type steps rather than through a Quiz list or query method.
|
|
7
7
|
*
|
|
8
8
|
* New submissions are evaluated against the quiz definition that exists when the submission is created. Previously stored submissions retain their recorded grades and answer evaluations if the definition changes later.
|
|
9
|
-
*
|
|
10
|
-
* NOT-PRECEDENT: The production v1 entity retains its legacy `wix.achievements.quizzes.v1.quiz` identity for compatibility. The Online Programs placement and workflow described here provide its public product context.
|
|
11
9
|
*/
|
|
12
10
|
interface Quiz {
|
|
13
11
|
/**
|
|
@@ -54,7 +52,7 @@ interface QuizSettings {
|
|
|
54
52
|
*/
|
|
55
53
|
title?: string | null;
|
|
56
54
|
/**
|
|
57
|
-
* Maximum number of submissions allowed per submitter. If omitted, no attempt-limit check is applied.
|
|
55
|
+
* Maximum number of submissions allowed per submitter. If omitted, no attempt-limit check is applied. Submissions grouped together share an attempt count, even across quizzes. See [Attempt limits](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/quiz-grading#attempt-limits) for how submissions are counted.
|
|
58
56
|
* @min 1
|
|
59
57
|
*/
|
|
60
58
|
attempts?: number | null;
|
|
@@ -140,7 +138,7 @@ interface NumericField {
|
|
|
140
138
|
/**
|
|
141
139
|
* Correct numeric value. Matching is exact. If no correct value is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
142
140
|
*
|
|
143
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct value is stored.
|
|
141
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct value is stored.
|
|
144
142
|
*/
|
|
145
143
|
rightAnswer?: number | null;
|
|
146
144
|
}
|
|
@@ -148,7 +146,7 @@ interface ShortTextField {
|
|
|
148
146
|
/**
|
|
149
147
|
* Correct text. Matching trims leading and trailing whitespace and is case-insensitive. If no correct text is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
150
148
|
*
|
|
151
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct text is stored.
|
|
149
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct text is stored.
|
|
152
150
|
* @minLength 1
|
|
153
151
|
* @maxLength 200
|
|
154
152
|
*/
|
|
@@ -161,7 +159,7 @@ interface SingleChoiceField {
|
|
|
161
159
|
/**
|
|
162
160
|
* Correct option. When supplied, it must exactly match an entry in `options`; otherwise, creation fails with INVALID_QUIZ. Matching submitted answers is exact. If no correct option is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
163
161
|
*
|
|
164
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct option is stored.
|
|
162
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct option is stored.
|
|
165
163
|
* @minLength 1
|
|
166
164
|
* @maxLength 350
|
|
167
165
|
*/
|
|
@@ -180,7 +178,7 @@ interface MultiChoiceField {
|
|
|
180
178
|
/**
|
|
181
179
|
* Correct options. Every supplied value must exactly match an entry in `options`; otherwise, creation fails with INVALID_QUIZ. Matching submitted answers ignores option order but doesn't ignore duplicate values. If no correct options are stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
182
180
|
*
|
|
183
|
-
* Empty in responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove stored keys or change grading; an empty response list doesn't mean no correct options are stored.
|
|
181
|
+
* Empty in responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove stored keys or change grading; an empty response list doesn't mean no correct options are stored.
|
|
184
182
|
* @maxSize 90
|
|
185
183
|
* @minLength 1
|
|
186
184
|
* @maxLength 350
|
|
@@ -669,8 +667,6 @@ declare function getQuiz(quizId: string): Promise<NonNullablePaths<Quiz, `fields
|
|
|
669
667
|
* This operation doesn't check whether Online Programs steps reference the quiz. Coordinate deletion with the Steps API and remove known step references first. Otherwise, steps can retain dangling quiz references.
|
|
670
668
|
*
|
|
671
669
|
* To delete multiple quiz definitions in a single API call, call [Bulk Delete Quizzes](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/bulk-delete-quizzes).
|
|
672
|
-
*
|
|
673
|
-
* NOT-PRECEDENT: This caller-responsibility behavior is retained as a production v1 compatibility exception. New delete APIs should provide an authoritative server-side reference safeguard.
|
|
674
670
|
* @param quizId - ID of the quiz definition to permanently delete.
|
|
675
671
|
* @public
|
|
676
672
|
* @requiredField quizId
|
|
@@ -689,8 +685,6 @@ declare function deleteQuiz(quizId: string): Promise<NonNullablePaths<DeleteQuiz
|
|
|
689
685
|
* This operation doesn't check whether Online Programs steps reference the quizzes. Coordinate deletion with the Steps API and remove known step references first. Otherwise, steps can retain dangling quiz references.
|
|
690
686
|
*
|
|
691
687
|
* To delete a single quiz definition, call [Delete Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/delete-quiz).
|
|
692
|
-
*
|
|
693
|
-
* NOT-PRECEDENT: This caller-responsibility behavior is retained as a production v1 compatibility exception. New bulk-delete APIs should provide an authoritative server-side reference safeguard.
|
|
694
688
|
* @param quizIds - IDs of the quiz definitions to permanently delete. Coordinate deletion with the Steps API and remove known step references first.
|
|
695
689
|
* @public
|
|
696
690
|
* @documentationMaturity preview
|
|
@@ -7,8 +7,6 @@ import '@wix/sdk-types';
|
|
|
7
7
|
* Create or clone a quiz, then assign the returned quiz ID to `step.quizOptions.id` when creating an Online Programs step. Quiz IDs are intentionally discovered through quiz-type steps rather than through a Quiz list or query method.
|
|
8
8
|
*
|
|
9
9
|
* New submissions are evaluated against the quiz definition that exists when the submission is created. Previously stored submissions retain their recorded grades and answer evaluations if the definition changes later.
|
|
10
|
-
*
|
|
11
|
-
* NOT-PRECEDENT: The production v1 entity retains its legacy `wix.achievements.quizzes.v1.quiz` identity for compatibility. The Online Programs placement and workflow described here provide its public product context.
|
|
12
10
|
*/
|
|
13
11
|
interface Quiz {
|
|
14
12
|
/**
|
|
@@ -55,7 +53,7 @@ interface QuizSettings {
|
|
|
55
53
|
*/
|
|
56
54
|
title?: string | null;
|
|
57
55
|
/**
|
|
58
|
-
* Maximum number of submissions allowed per submitter. If omitted, no attempt-limit check is applied.
|
|
56
|
+
* Maximum number of submissions allowed per submitter. If omitted, no attempt-limit check is applied. Submissions grouped together share an attempt count, even across quizzes. See [Attempt limits](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/quiz-grading#attempt-limits) for how submissions are counted.
|
|
59
57
|
* @min 1
|
|
60
58
|
*/
|
|
61
59
|
attempts?: number | null;
|
|
@@ -141,7 +139,7 @@ interface NumericField {
|
|
|
141
139
|
/**
|
|
142
140
|
* Correct numeric value. Matching is exact. If no correct value is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
143
141
|
*
|
|
144
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct value is stored.
|
|
142
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct value is stored.
|
|
145
143
|
*/
|
|
146
144
|
rightAnswer?: number | null;
|
|
147
145
|
}
|
|
@@ -149,7 +147,7 @@ interface ShortTextField {
|
|
|
149
147
|
/**
|
|
150
148
|
* Correct text. Matching trims leading and trailing whitespace and is case-insensitive. If no correct text is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
151
149
|
*
|
|
152
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct text is stored.
|
|
150
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct text is stored.
|
|
153
151
|
* @minLength 1
|
|
154
152
|
* @maxLength 200
|
|
155
153
|
*/
|
|
@@ -162,7 +160,7 @@ interface SingleChoiceField {
|
|
|
162
160
|
/**
|
|
163
161
|
* Correct option. When supplied, it must exactly match an entry in `options`; otherwise, creation fails with INVALID_QUIZ. Matching submitted answers is exact. If no correct option is stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
164
162
|
*
|
|
165
|
-
* Omitted from responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct option is stored.
|
|
163
|
+
* Omitted from responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove the stored key or change grading; an absent response value doesn't mean no correct option is stored.
|
|
166
164
|
* @minLength 1
|
|
167
165
|
* @maxLength 350
|
|
168
166
|
*/
|
|
@@ -181,7 +179,7 @@ interface MultiChoiceField {
|
|
|
181
179
|
/**
|
|
182
180
|
* Correct options. Every supplied value must exactly match an entry in `options`; otherwise, creation fails with INVALID_QUIZ. Matching submitted answers ignores option order but doesn't ignore duplicate values. If no correct options are stored for this question, its submitted answer is non-evaluable and counts as correct when calculating the earned grade.
|
|
183
181
|
*
|
|
184
|
-
* Empty in responses when the caller lacks achievements:quizzes:v1:quiz:read_sensitive_fields permission. Response filtering doesn't remove stored keys or change grading; an empty response list doesn't mean no correct options are stored.
|
|
182
|
+
* Empty in responses when the caller lacks `achievements:quizzes:v1:quiz:read_sensitive_fields` permission. Response filtering doesn't remove stored keys or change grading; an empty response list doesn't mean no correct options are stored.
|
|
185
183
|
* @maxSize 90
|
|
186
184
|
* @minLength 1
|
|
187
185
|
* @maxLength 350
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/auto_sdk_online-programs_quizzes",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.33",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/",
|
|
@@ -50,5 +50,5 @@
|
|
|
50
50
|
"fqdn": "wix.achievements.quizzes.v1.quiz"
|
|
51
51
|
}
|
|
52
52
|
},
|
|
53
|
-
"falconPackageHash": "
|
|
53
|
+
"falconPackageHash": "08105b81737a18749598520eed031ac138ab3a1f4497860cac9a95f1"
|
|
54
54
|
}
|