@wix/auto_sdk_online-programs_quizzes 1.0.33 → 1.0.34

package/build/internal/es/index.typings.d.mts

@@ -32,7 +32,7 @@ interface Quiz {
      */
     _updatedDate?: Date | null;
     /**
-     * Active questions in the quiz. Each `QuizField` defines one question and its answer input. Creating or cloning a quiz requires at least one active question. GetQuiz can return a legacy stored definition with an empty list; don't assume a retrieved definition has active questions.
+     * Active questions in the quiz. Each `QuizField` defines one question and its answer input. Creating or cloning a quiz requires at least one active question. A retrieved quiz can have an empty list after all its questions have been deleted. Check for active questions before displaying or reusing it.
      *
      * New submissions use the current questions; stored submissions retain their recorded answer evaluations.
      * @minSize 1
@@ -138,7 +138,7 @@ interface NumericField {
     /**
      * 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.
      *
-     * 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.
+     * Omitted from responses when the caller can't access answer keys. Hidden answers still participate in grading; an absent response value doesn't mean no correct value is stored.
      */
     rightAnswer?: number | null;
 }
@@ -146,7 +146,7 @@ interface ShortTextField {
     /**
      * 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.
      *
-     * 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.
+     * Omitted from responses when the caller can't access answer keys. Hidden answers still participate in grading; an absent response value doesn't mean no correct text is stored.
      * @minLength 1
      * @maxLength 200
      */
@@ -159,7 +159,7 @@ interface SingleChoiceField {
     /**
      * 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.
      *
-     * 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.
+     * Omitted from responses when the caller can't access answer keys. Hidden answers still participate in grading; an absent response value doesn't mean no correct option is stored.
      * @minLength 1
      * @maxLength 350
      */
@@ -178,7 +178,7 @@ interface MultiChoiceField {
     /**
      * 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.
      *
-     * 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.
+     * Empty in responses when the caller can't access answer keys. Hidden answers still participate in grading; an empty response list doesn't mean no correct options are stored.
      * @maxSize 90
      * @minLength 1
      * @maxLength 350
@@ -280,9 +280,9 @@ interface ApplicationError {
     data?: Record<string, any> | null;
 }
 interface BulkCreateQuizzesResponseBulkQuizResult {
-    /** Metadata for the individual create operation. When the operation fails, `error` contains the original Wix Forms application error. */
+    /** Result metadata for the individual create operation. If `success` is `false`, inspect `error` for details. Individual results can contain error codes not listed for the request. */
     itemMetadata?: ItemMetadata;
-    /** Created quiz. Empty when `return_entity` is `false`. */
+    /** Created quiz. Empty when `returnEntity` is `false`. */
     item?: Quiz;
 }
 interface BulkActionMetadata {
@@ -362,7 +362,7 @@ interface BulkDeleteQuizzesResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkDeleteQuizzesResponseBulkQuizResult {
-    /** Metadata for the individual delete operation. When the operation fails, `error` contains the original Wix Forms application error. */
+    /** Result metadata for the individual delete operation. If `success` is `false`, inspect `error` for details. Individual results can contain error codes not listed for the request. */
     itemMetadata?: ItemMetadata;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
@@ -591,7 +591,7 @@ declare function createQuiz(quiz: NonNullablePaths<Quiz, `fields` | `fields.${nu
 /**
  * Clones a quiz definition and returns a new quiz ID.
  *
- * Checks the source before cloning. An existing definition found to have no active questions is rejected with INVALID_QUIZ before cloning. Source checks aren't atomic with cloning.
+ * A quiz with no active questions can't be cloned; the request fails with INVALID_QUIZ. Avoid modifying the source quiz while cloning it.
  *
  * This operation copies the question and settings definition only. It doesn't copy Online Programs step associations or quiz submissions. Attach the returned ID to a step separately when needed.
  * @param quizId - ID of the quiz definition to clone.
@@ -613,7 +613,7 @@ declare function cloneQuiz(quizId: string): Promise<NonNullablePaths<CloneQuizRe
  *
  * Invalid quiz definitions fail the entire request before any quizzes are created.
  *
- * Individual item failures don't fail the bulk request. For each failed item, `results.itemMetadata.error` contains the original application error from the Wix Forms operation.
+ * Individual item failures don't fail the bulk request. Check `results.itemMetadata.success` for each item and inspect `results.itemMetadata.error` when it is `false`. Individual results can contain error codes not listed for the request.
  *
  * To use the quizzes in an Online Program, specify the returned quiz IDs as `step.quizOptions.id` values when calling the Steps API's [Create Step](https://dev.wix.com/docs/api-reference/business-management/online-programs/steps/create-step) or [Bulk Create Steps](https://dev.wix.com/docs/api-reference/business-management/online-programs/steps/bulk-create-steps) method.
  *
@@ -647,7 +647,7 @@ interface BulkCreateQuizzesOptions {
 /**
  * Retrieves a quiz definition by ID.
  *
- * A legacy stored definition whose questions have all been deleted can be returned with an empty fields list. The minimum question requirement for creation and cloning doesn't guarantee a nonempty result from this method.
+ * A retrieved quiz can have an empty fields list after all its questions have been deleted. Check for active questions before displaying or reusing it.
  *
  * To discover a quiz ID, query or retrieve its quiz-type Online Programs step and read `step.quizOptions.id`.
  * @param quizId - Quiz ID, available from `step.quizOptions.id` on a quiz-type Online Programs step.
@@ -680,7 +680,7 @@ declare function deleteQuiz(quizId: string): Promise<NonNullablePaths<DeleteQuiz
 /**
  * Permanently deletes up to 100 quiz definitions.
  *
- * Individual item failures don't fail the bulk request. For each failed item, `results.itemMetadata.error` contains the original application error from the Wix Forms operation.
+ * Individual item failures don't fail the bulk request. Check `results.itemMetadata.success` for each item and inspect `results.itemMetadata.error` when it is `false`. Individual results can contain error codes not listed for the request.
  *
  * 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.
  *

package/build/internal/es/meta.d.mts

@@ -33,7 +33,7 @@ interface Quiz {
      */
     updatedDate?: Date | null;
     /**
-     * Active questions in the quiz. Each `QuizField` defines one question and its answer input. Creating or cloning a quiz requires at least one active question. GetQuiz can return a legacy stored definition with an empty list; don't assume a retrieved definition has active questions.
+     * Active questions in the quiz. Each `QuizField` defines one question and its answer input. Creating or cloning a quiz requires at least one active question. A retrieved quiz can have an empty list after all its questions have been deleted. Check for active questions before displaying or reusing it.
      *
      * New submissions use the current questions; stored submissions retain their recorded answer evaluations.
      * @minSize 1
@@ -139,7 +139,7 @@ interface NumericField {
     /**
      * 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.
      *
-     * 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.
+     * Omitted from responses when the caller can't access answer keys. Hidden answers still participate in grading; an absent response value doesn't mean no correct value is stored.
      */
     rightAnswer?: number | null;
 }
@@ -147,7 +147,7 @@ interface ShortTextField {
     /**
      * 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.
      *
-     * 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.
+     * Omitted from responses when the caller can't access answer keys. Hidden answers still participate in grading; an absent response value doesn't mean no correct text is stored.
      * @minLength 1
      * @maxLength 200
      */
@@ -160,7 +160,7 @@ interface SingleChoiceField {
     /**
      * 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.
      *
-     * 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.
+     * Omitted from responses when the caller can't access answer keys. Hidden answers still participate in grading; an absent response value doesn't mean no correct option is stored.
      * @minLength 1
      * @maxLength 350
      */
@@ -179,7 +179,7 @@ interface MultiChoiceField {
     /**
      * 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.
      *
-     * 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.
+     * Empty in responses when the caller can't access answer keys. Hidden answers still participate in grading; an empty response list doesn't mean no correct options are stored.
      * @maxSize 90
      * @minLength 1
      * @maxLength 350
@@ -281,9 +281,9 @@ interface ApplicationError {
     data?: Record<string, any> | null;
 }
 interface BulkCreateQuizzesResponseBulkQuizResult {
-    /** Metadata for the individual create operation. When the operation fails, `error` contains the original Wix Forms application error. */
+    /** Result metadata for the individual create operation. If `success` is `false`, inspect `error` for details. Individual results can contain error codes not listed for the request. */
     itemMetadata?: ItemMetadata;
-    /** Created quiz. Empty when `return_entity` is `false`. */
+    /** Created quiz. Empty when `returnEntity` is `false`. */
     item?: Quiz;
 }
 interface BulkActionMetadata {
@@ -363,7 +363,7 @@ interface BulkDeleteQuizzesResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkDeleteQuizzesResponseBulkQuizResult {
-    /** Metadata for the individual delete operation. When the operation fails, `error` contains the original Wix Forms application error. */
+    /** Result metadata for the individual delete operation. If `success` is `false`, inspect `error` for details. Individual results can contain error codes not listed for the request. */
     itemMetadata?: ItemMetadata;
 }
 interface DomainEvent extends DomainEventBodyOneOf {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_online-programs_quizzes",
-  "version": "1.0.33",
+  "version": "1.0.34",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.achievements.quizzes.v1.quiz"
     }
   },
-  "falconPackageHash": "08105b81737a18749598520eed031ac138ab3a1f4497860cac9a95f1"
+  "falconPackageHash": "a0d248de385f1db8df74f64355fad0f78d61cb031c8d7cb1dac45223"
 }