@wix/auto_sdk_online-programs_quizzes 1.0.29 → 1.0.30

package/build/internal/cjs/index.d.ts

@@ -7,7 +7,9 @@ interface CreateQuizSignature {
     /**
      * Creates a detached quiz definition with at least one question.
      *
-     * To use the quiz in an Online Program, pass the returned quiz ID as `step.quizOptions.id` when calling the Steps API's `CreateStep` or `BulkCreateSteps` method.
+     * To use the quiz in an Online Program, specify the returned quiz ID as `step.quizOptions.id` 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.
+     *
+     * To create multiple quiz definitions in a single API call, call [Bulk Create Quizzes](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/bulk-create-quizzes).
      * @param - Quiz definition to create. Generate a stable unique GUID for every `quiz.fields.id` value.
      * @returns Created quiz definition. Assign its `id` to `step.quizOptions.id` to create an Online Programs quiz step.
      */
@@ -32,7 +34,9 @@ interface CloneQuizSignature {
 declare function bulkCreateQuizzes$1(httpClient: HttpClient): BulkCreateQuizzesSignature;
 interface BulkCreateQuizzesSignature {
     /**
-     * Creates up to 30 detached quiz definitions in a single API call. Each definition must contain at least one question.
+     * Creates up to 30 detached quiz definitions in a single API call.
+     *
+     * Each definition must contain at least one question.
      *
      * Quiz IDs, revisions, and creation and update timestamps are assigned by the server. Client-supplied values for these read-only fields are ignored. Question IDs (`quizzes.fields.id`) must be supplied by the caller.
      *
@@ -40,7 +44,9 @@ interface BulkCreateQuizzesSignature {
      *
      * 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.
      *
-     * To use the quizzes in an Online Program, pass the returned quiz IDs as `step.quizOptions.id` values when calling the Steps API's `CreateStep` or `BulkCreateSteps` method.
+     * 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.
+     *
+     * To create a single quiz definition, call [Create Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/create-quiz).
      * @param - Quiz definitions to create.
      */
     (quizzes: NonNullablePaths<Quiz, `fields` | `fields.${number}._id` | `fields.${number}.multiChoice.options` | `fields.${number}.question` | `fields.${number}.singleChoice.options` | `fields.${number}.target`, 3>[], options?: BulkCreateQuizzesOptions): Promise<NonNullablePaths<BulkCreateQuizzesResponse, `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> & {
@@ -69,6 +75,8 @@ interface DeleteQuizSignature {
      *
      * 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.
      *
+     * 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).
+     *
      * 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.
      * @param - ID of the quiz definition to permanently delete.
      */
@@ -85,6 +93,8 @@ interface BulkDeleteQuizzesSignature {
      *
      * 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.
      *
+     * To delete a single quiz definition, call [Delete Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/delete-quiz).
+     *
      * 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.
      * @param - IDs of the quiz definitions to permanently delete. Coordinate deletion with the Steps API and remove known step references first.
      */

package/build/internal/cjs/index.typings.d.ts

@@ -44,7 +44,7 @@ interface Quiz {
 }
 interface QuizSettings {
     /**
-     * Minimum unweighted integer percentage required to pass, from `0` through `100`. The earned grade is calculated as `floor((correct answer count / submitted answer count) * 100)`; question `score` values don't weight it. Non-evaluable answers count as correct. If omitted, the submission has no earned or passing grade and its status is COMPLETED, even if an individual evaluated answer is incorrect.
+     * Minimum unweighted integer percentage required to pass. The earned grade is calculated as `floor((correct answer count / submitted answer count) * 100)`; question `score` values don't weight it. Non-evaluable answers count as correct. If omitted, the submission has no earned or passing grade and its status is COMPLETED, even if an individual evaluated answer is incorrect.
      * @max 100
      */
     passingGrade?: number | null;
@@ -197,13 +197,17 @@ interface MultiChoiceField {
 }
 interface FileUploadField {
     /**
-     * Text displayed on the upload button. Default: `Upload`.
+     * Text displayed on the upload button.
+     *
+     * Default: `Upload`.
      * @minLength 1
      * @maxLength 100
      */
     buttonText?: string | null;
     /**
-     * Maximum number of files a participant can upload for this question, from `1` through `10`. Default: `10`.
+     * Maximum number of files a participant can upload for this question.
+     *
+     * Default: `10`.
      * @min 1
      * @max 10
      */
@@ -565,7 +569,9 @@ type DeleteQuizApplicationErrors = {
 /**
  * Creates a detached quiz definition with at least one question.
  *
- * To use the quiz in an Online Program, pass the returned quiz ID as `step.quizOptions.id` when calling the Steps API's `CreateStep` or `BulkCreateSteps` method.
+ * To use the quiz in an Online Program, specify the returned quiz ID as `step.quizOptions.id` 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.
+ *
+ * To create multiple quiz definitions in a single API call, call [Bulk Create Quizzes](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/bulk-create-quizzes).
  * @param quiz - Quiz definition to create. Generate a stable unique GUID for every `quiz.fields.id` value.
  * @public
  * @requiredField quiz
@@ -601,7 +607,9 @@ declare function cloneQuiz(quizId: string): Promise<NonNullablePaths<CloneQuizRe
     __applicationErrorsType?: CloneQuizApplicationErrors;
 }>;
 /**
- * Creates up to 30 detached quiz definitions in a single API call. Each definition must contain at least one question.
+ * Creates up to 30 detached quiz definitions in a single API call.
+ *
+ * Each definition must contain at least one question.
  *
  * Quiz IDs, revisions, and creation and update timestamps are assigned by the server. Client-supplied values for these read-only fields are ignored. Question IDs (`quizzes.fields.id`) must be supplied by the caller.
  *
@@ -609,7 +617,9 @@ declare function cloneQuiz(quizId: string): Promise<NonNullablePaths<CloneQuizRe
  *
  * 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.
  *
- * To use the quizzes in an Online Program, pass the returned quiz IDs as `step.quizOptions.id` values when calling the Steps API's `CreateStep` or `BulkCreateSteps` method.
+ * 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.
+ *
+ * To create a single quiz definition, call [Create Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/create-quiz).
  * @param quizzes - Quiz definitions to create.
  * @public
  * @documentationMaturity preview
@@ -658,6 +668,8 @@ declare function getQuiz(quizId: string): Promise<NonNullablePaths<Quiz, `fields
  *
  * 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.
  *
+ * 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).
+ *
  * 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.
  * @param quizId - ID of the quiz definition to permanently delete.
  * @public
@@ -676,6 +688,8 @@ declare function deleteQuiz(quizId: string): Promise<NonNullablePaths<DeleteQuiz
  *
  * 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.
  *
+ * To delete a single quiz definition, call [Delete Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/delete-quiz).
+ *
  * 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.
  * @param quizIds - IDs of the quiz definitions to permanently delete. Coordinate deletion with the Steps API and remove known step references first.
  * @public

package/build/internal/cjs/meta.d.ts

@@ -45,7 +45,7 @@ interface Quiz {
 }
 interface QuizSettings {
     /**
-     * Minimum unweighted integer percentage required to pass, from `0` through `100`. The earned grade is calculated as `floor((correct answer count / submitted answer count) * 100)`; question `score` values don't weight it. Non-evaluable answers count as correct. If omitted, the submission has no earned or passing grade and its status is COMPLETED, even if an individual evaluated answer is incorrect.
+     * Minimum unweighted integer percentage required to pass. The earned grade is calculated as `floor((correct answer count / submitted answer count) * 100)`; question `score` values don't weight it. Non-evaluable answers count as correct. If omitted, the submission has no earned or passing grade and its status is COMPLETED, even if an individual evaluated answer is incorrect.
      * @max 100
      */
     passingGrade?: number | null;
@@ -198,13 +198,17 @@ interface MultiChoiceField {
 }
 interface FileUploadField {
     /**
-     * Text displayed on the upload button. Default: `Upload`.
+     * Text displayed on the upload button.
+     *
+     * Default: `Upload`.
      * @minLength 1
      * @maxLength 100
      */
     buttonText?: string | null;
     /**
-     * Maximum number of files a participant can upload for this question, from `1` through `10`. Default: `10`.
+     * Maximum number of files a participant can upload for this question.
+     *
+     * Default: `10`.
      * @min 1
      * @max 10
      */

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

@@ -7,7 +7,9 @@ interface CreateQuizSignature {
     /**
      * Creates a detached quiz definition with at least one question.
      *
-     * To use the quiz in an Online Program, pass the returned quiz ID as `step.quizOptions.id` when calling the Steps API's `CreateStep` or `BulkCreateSteps` method.
+     * To use the quiz in an Online Program, specify the returned quiz ID as `step.quizOptions.id` 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.
+     *
+     * To create multiple quiz definitions in a single API call, call [Bulk Create Quizzes](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/bulk-create-quizzes).
      * @param - Quiz definition to create. Generate a stable unique GUID for every `quiz.fields.id` value.
      * @returns Created quiz definition. Assign its `id` to `step.quizOptions.id` to create an Online Programs quiz step.
      */
@@ -32,7 +34,9 @@ interface CloneQuizSignature {
 declare function bulkCreateQuizzes$1(httpClient: HttpClient): BulkCreateQuizzesSignature;
 interface BulkCreateQuizzesSignature {
     /**
-     * Creates up to 30 detached quiz definitions in a single API call. Each definition must contain at least one question.
+     * Creates up to 30 detached quiz definitions in a single API call.
+     *
+     * Each definition must contain at least one question.
      *
      * Quiz IDs, revisions, and creation and update timestamps are assigned by the server. Client-supplied values for these read-only fields are ignored. Question IDs (`quizzes.fields.id`) must be supplied by the caller.
      *
@@ -40,7 +44,9 @@ interface BulkCreateQuizzesSignature {
      *
      * 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.
      *
-     * To use the quizzes in an Online Program, pass the returned quiz IDs as `step.quizOptions.id` values when calling the Steps API's `CreateStep` or `BulkCreateSteps` method.
+     * 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.
+     *
+     * To create a single quiz definition, call [Create Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/create-quiz).
      * @param - Quiz definitions to create.
      */
     (quizzes: NonNullablePaths<Quiz, `fields` | `fields.${number}._id` | `fields.${number}.multiChoice.options` | `fields.${number}.question` | `fields.${number}.singleChoice.options` | `fields.${number}.target`, 3>[], options?: BulkCreateQuizzesOptions): Promise<NonNullablePaths<BulkCreateQuizzesResponse, `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> & {
@@ -69,6 +75,8 @@ interface DeleteQuizSignature {
      *
      * 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.
      *
+     * 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).
+     *
      * 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.
      * @param - ID of the quiz definition to permanently delete.
      */
@@ -85,6 +93,8 @@ interface BulkDeleteQuizzesSignature {
      *
      * 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.
      *
+     * To delete a single quiz definition, call [Delete Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/delete-quiz).
+     *
      * 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.
      * @param - IDs of the quiz definitions to permanently delete. Coordinate deletion with the Steps API and remove known step references first.
      */

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

@@ -44,7 +44,7 @@ interface Quiz {
 }
 interface QuizSettings {
     /**
-     * Minimum unweighted integer percentage required to pass, from `0` through `100`. The earned grade is calculated as `floor((correct answer count / submitted answer count) * 100)`; question `score` values don't weight it. Non-evaluable answers count as correct. If omitted, the submission has no earned or passing grade and its status is COMPLETED, even if an individual evaluated answer is incorrect.
+     * Minimum unweighted integer percentage required to pass. The earned grade is calculated as `floor((correct answer count / submitted answer count) * 100)`; question `score` values don't weight it. Non-evaluable answers count as correct. If omitted, the submission has no earned or passing grade and its status is COMPLETED, even if an individual evaluated answer is incorrect.
      * @max 100
      */
     passingGrade?: number | null;
@@ -197,13 +197,17 @@ interface MultiChoiceField {
 }
 interface FileUploadField {
     /**
-     * Text displayed on the upload button. Default: `Upload`.
+     * Text displayed on the upload button.
+     *
+     * Default: `Upload`.
      * @minLength 1
      * @maxLength 100
      */
     buttonText?: string | null;
     /**
-     * Maximum number of files a participant can upload for this question, from `1` through `10`. Default: `10`.
+     * Maximum number of files a participant can upload for this question.
+     *
+     * Default: `10`.
      * @min 1
      * @max 10
      */
@@ -565,7 +569,9 @@ type DeleteQuizApplicationErrors = {
 /**
  * Creates a detached quiz definition with at least one question.
  *
- * To use the quiz in an Online Program, pass the returned quiz ID as `step.quizOptions.id` when calling the Steps API's `CreateStep` or `BulkCreateSteps` method.
+ * To use the quiz in an Online Program, specify the returned quiz ID as `step.quizOptions.id` 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.
+ *
+ * To create multiple quiz definitions in a single API call, call [Bulk Create Quizzes](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/bulk-create-quizzes).
  * @param quiz - Quiz definition to create. Generate a stable unique GUID for every `quiz.fields.id` value.
  * @public
  * @requiredField quiz
@@ -601,7 +607,9 @@ declare function cloneQuiz(quizId: string): Promise<NonNullablePaths<CloneQuizRe
     __applicationErrorsType?: CloneQuizApplicationErrors;
 }>;
 /**
- * Creates up to 30 detached quiz definitions in a single API call. Each definition must contain at least one question.
+ * Creates up to 30 detached quiz definitions in a single API call.
+ *
+ * Each definition must contain at least one question.
  *
  * Quiz IDs, revisions, and creation and update timestamps are assigned by the server. Client-supplied values for these read-only fields are ignored. Question IDs (`quizzes.fields.id`) must be supplied by the caller.
  *
@@ -609,7 +617,9 @@ declare function cloneQuiz(quizId: string): Promise<NonNullablePaths<CloneQuizRe
  *
  * 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.
  *
- * To use the quizzes in an Online Program, pass the returned quiz IDs as `step.quizOptions.id` values when calling the Steps API's `CreateStep` or `BulkCreateSteps` method.
+ * 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.
+ *
+ * To create a single quiz definition, call [Create Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/create-quiz).
  * @param quizzes - Quiz definitions to create.
  * @public
  * @documentationMaturity preview
@@ -658,6 +668,8 @@ declare function getQuiz(quizId: string): Promise<NonNullablePaths<Quiz, `fields
  *
  * 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.
  *
+ * 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).
+ *
  * 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.
  * @param quizId - ID of the quiz definition to permanently delete.
  * @public
@@ -676,6 +688,8 @@ declare function deleteQuiz(quizId: string): Promise<NonNullablePaths<DeleteQuiz
  *
  * 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.
  *
+ * To delete a single quiz definition, call [Delete Quiz](https://dev.wix.com/docs/api-reference/business-management/online-programs/quizzes/delete-quiz).
+ *
  * 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.
  * @param quizIds - IDs of the quiz definitions to permanently delete. Coordinate deletion with the Steps API and remove known step references first.
  * @public

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

@@ -45,7 +45,7 @@ interface Quiz {
 }
 interface QuizSettings {
     /**
-     * Minimum unweighted integer percentage required to pass, from `0` through `100`. The earned grade is calculated as `floor((correct answer count / submitted answer count) * 100)`; question `score` values don't weight it. Non-evaluable answers count as correct. If omitted, the submission has no earned or passing grade and its status is COMPLETED, even if an individual evaluated answer is incorrect.
+     * Minimum unweighted integer percentage required to pass. The earned grade is calculated as `floor((correct answer count / submitted answer count) * 100)`; question `score` values don't weight it. Non-evaluable answers count as correct. If omitted, the submission has no earned or passing grade and its status is COMPLETED, even if an individual evaluated answer is incorrect.
      * @max 100
      */
     passingGrade?: number | null;
@@ -198,13 +198,17 @@ interface MultiChoiceField {
 }
 interface FileUploadField {
     /**
-     * Text displayed on the upload button. Default: `Upload`.
+     * Text displayed on the upload button.
+     *
+     * Default: `Upload`.
      * @minLength 1
      * @maxLength 100
      */
     buttonText?: string | null;
     /**
-     * Maximum number of files a participant can upload for this question, from `1` through `10`. Default: `10`.
+     * Maximum number of files a participant can upload for this question.
+     *
+     * Default: `10`.
      * @min 1
      * @max 10
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_online-programs_quizzes",
-  "version": "1.0.29",
+  "version": "1.0.30",
   "license": "MIT",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
       "fqdn": "wix.achievements.quizzes.v1.quiz"
     }
   },
-  "falconPackageHash": "cac1955e6cbdce3aceecf2aec692d681902270ef88cda2d9bbe5cb7b"
+  "falconPackageHash": "6032021aec899920f31a423efb6d127cbc9a83814db2ff1a91900cc0"
 }