@wix/auto_sdk_online-programs_quizzes 1.0.26 → 1.0.28

package/build/cjs/meta.d.ts

@@ -1,32 +1,43 @@
 import { CreateQuizRequest as CreateQuizRequest$1, CreateQuizResponse as CreateQuizResponse$1, CloneQuizRequest as CloneQuizRequest$1, CloneQuizResponse as CloneQuizResponse$1, BulkCreateQuizzesRequest as BulkCreateQuizzesRequest$1, BulkCreateQuizzesResponse as BulkCreateQuizzesResponse$1, GetQuizRequest as GetQuizRequest$1, GetQuizResponse as GetQuizResponse$1, DeleteQuizRequest as DeleteQuizRequest$1, DeleteQuizResponse as DeleteQuizResponse$1, BulkDeleteQuizzesRequest as BulkDeleteQuizzesRequest$1, BulkDeleteQuizzesResponse as BulkDeleteQuizzesResponse$1 } from './index.typings.js';
 import '@wix/sdk-types';
 
+/**
+ * A quiz definition used by an Online Programs quiz step.
+ *
+ * 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.
+ *
+ * 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.
+ *
+ * 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.
+ */
 interface Quiz {
     /**
-     * ID of the quiz
+     * Quiz ID.
      * @format GUID
      * @readonly
      */
     id?: string | null;
-    /** Quiz settings */
+    /** Quiz title, passing grade, and attempt limit. New submissions use the current settings; stored submissions retain their recorded grade data. */
     settings?: QuizSettings;
     /**
-     * Represents the current state of the quiz. Each time the it is modified, its `revision` changes. For an update operation to succeed, you MUST pass the latest revision
+     * Current revision of the stored quiz definition. The revision changes when the definition changes. The public Quiz API doesn't currently provide an update method.
      * @readonly
      */
     revision?: string | null;
     /**
-     * The time this quiz was created
+     * Date and time the quiz was created.
      * @readonly
      */
     createdDate?: Date | null;
     /**
-     * The time this quiz was last updated
+     * Date and time the quiz was last updated.
      * @readonly
      */
     updatedDate?: Date | null;
     /**
-     * Quiz fields
+     * Active questions in the quiz. Each `QuizField` defines one question and its answer input. Creating a quiz requires at least one question. An existing definition can have no active questions after its questions are deleted through another supported workflow; retrieving that definition doesn't fail solely because this list is empty.
+     *
+     * New submissions use the current questions; stored submissions retain their recorded answer evaluations. Reading an empty definition doesn't imply that it can be used to create a new quiz or accept submissions.
      * @minSize 1
      * @maxSize 200
      */
@@ -34,119 +45,130 @@ interface Quiz {
 }
 interface QuizSettings {
     /**
-     * Minimal grade to pass the quiz
+     * 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.
      * @max 100
      */
     passingGrade?: number | null;
     /**
-     * Quiz title
+     * Quiz title.
      * @maxLength 200
      */
     title?: string | null;
     /**
-     * Maximal number of submission attempts
+     * Maximum number of submissions allowed per submitter. If omitted, no attempt-limit check is applied. With `groupId`, the count uses group ID and submitter ID without filtering by quiz ID; otherwise, it uses quiz ID and submitter ID. Reusing a group ID across quizzes shares their attempt count.
      * @min 1
      */
     attempts?: number | null;
 }
+/** Defines one quiz question and its answer input. */
 interface QuizField extends QuizFieldFieldTypeOneOf {
-    /** Type for numeric input */
+    /** Numeric input. */
     numeric?: NumericField;
-    /** Type for text input */
+    /** Short-text input. */
     shortText?: ShortTextField;
-    /** Type for long text input */
+    /** Long-text input. Set this to an empty object (`{}`) to select it. */
     longText?: LongTextField;
-    /** Type for input with predefined options where only one can be selected */
+    /** Input with predefined options where only one option can be selected. */
     singleChoice?: SingleChoiceField;
-    /** Type for input with predefined options where multiple can be selected */
+    /** Input with predefined options where multiple options can be selected. */
     multiChoice?: MultiChoiceField;
-    /** Type for file input */
+    /** File-upload input. */
     fileUpload?: FileUploadField;
     /**
-     * Field ID
+     * Caller-generated GUID that identifies this question. Use a stable value that is unique within the quiz. Submission answer evaluations use this ID to identify the question.
      * @format GUID
      * @immutable
      */
     id?: string;
     /**
-     * Key used in submission
+     * Stable key used to match a submitted answer to this question. Use a value that is unique within the quiz and don't change or reuse it for another question.
      * @maxLength 200
      * @immutable
      */
     target?: string | null;
     /**
-     * Question
+     * Question text.
      * @minLength 1
      * @maxLength 350
      */
     question?: string | null;
-    /** Score of the question when answered right */
+    /** Score returned for evaluable answers, whether correct or incorrect. Omitted from non-evaluable answer evaluations. This value doesn't weight the submission's unweighted `earnedGrade` percentage. */
     score?: number | null;
     /**
-     * Message shown for right answer
+     * Feedback returned when an evaluable submitted answer is correct. Omitted for non-evaluable answers.
      * @maxLength 350
      */
     rightMessage?: string | null;
     /**
-     * Message shown for wrong answer
+     * Feedback returned when an evaluable submitted answer is incorrect. Omitted for non-evaluable answers.
      * @maxLength 350
      */
     wrongMessage?: string | null;
 }
 /** @oneof */
 interface QuizFieldFieldTypeOneOf {
-    /** Type for numeric input */
+    /** Numeric input. */
     numeric?: NumericField;
-    /** Type for text input */
+    /** Short-text input. */
     shortText?: ShortTextField;
-    /** Type for long text input */
+    /** Long-text input. Set this to an empty object (`{}`) to select it. */
     longText?: LongTextField;
-    /** Type for input with predefined options where only one can be selected */
+    /** Input with predefined options where only one option can be selected. */
     singleChoice?: SingleChoiceField;
-    /** Type for input with predefined options where multiple can be selected */
+    /** Input with predefined options where multiple options can be selected. */
     multiChoice?: MultiChoiceField;
-    /** Type for file input */
+    /** File-upload input. */
     fileUpload?: FileUploadField;
 }
+/** File categories used by Wix Forms. Categories don't define a custom extension or MIME-type allowlist; accepted file types are controlled by Wix Forms. See [About form fields](https://dev.wix.com/docs/api-reference/crm/forms/form-schemas/about-form-fields). */
 declare enum FileUploadFormat {
-    /** Image files. */
+    /** Image-file category. */
     IMAGE = "IMAGE",
-    /** Video files. */
+    /** Video-file category. */
     VIDEO = "VIDEO",
-    /** Audio files. */
+    /** Audio-file category. */
     AUDIO = "AUDIO",
-    /** Document files. */
+    /** Document-file category. */
     DOCUMENT = "DOCUMENT",
-    /** Archive files. */
+    /** Archive-file category. */
     ARCHIVE = "ARCHIVE",
-    /** 3D model files. */
+    /** 3D-model-file category. */
     MODEL_3D = "MODEL_3D"
 }
 /** @enumType */
 type FileUploadFormatWithLiterals = FileUploadFormat | 'IMAGE' | 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'ARCHIVE' | 'MODEL_3D';
 interface NumericField {
-    /** Right answer */
+    /**
+     * 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.
+     */
     rightAnswer?: number | null;
 }
 interface ShortTextField {
     /**
-     * Right answer
+     * 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.
      * @minLength 1
      * @maxLength 200
      */
     rightAnswer?: string | null;
 }
+/** Long-text input settings. Set `longText` to an empty object (`{}`) to select this input. Long-text answers aren't evaluated and count as correct when calculating the earned grade. */
 interface LongTextField {
 }
 interface SingleChoiceField {
     /**
-     * Right answer
+     * 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.
      * @minLength 1
      * @maxLength 350
      */
     rightAnswer?: string | null;
     /**
-     * Answer options
+     * Options available to the participant. Labels must be unique; comparison is case-sensitive. Duplicate labels are rejected with INVALID_QUIZ before creation.
      * @minSize 1
      * @maxSize 90
      * @minLength 1
@@ -154,17 +176,19 @@ interface SingleChoiceField {
      */
     options?: string[] | null;
 }
+/** Multiple-choice input settings. Existing Wix Forms image-choice questions are also returned in this shape, even when their original settings allow only one selection. Image-choice-specific settings aren't exposed by the Quiz API. */
 interface MultiChoiceField {
     /**
-     * Returned only with achievements:quizzes:v1:quiz:read_sensitive_fields permission.
-     * Repeated fields cannot use conditional annotations; the service redacts this field.
+     * 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.
      * @maxSize 90
      * @minLength 1
      * @maxLength 350
      */
     rightAnswer?: string[] | null;
     /**
-     * Answer options
+     * Options available to the participant.
      * @minSize 1
      * @maxSize 90
      * @minLength 1
@@ -174,42 +198,42 @@ interface MultiChoiceField {
 }
 interface FileUploadField {
     /**
-     * Text for upload button
+     * Text displayed on the upload button. Default: `Upload`.
      * @minLength 1
      * @maxLength 100
      */
     buttonText?: string | null;
     /**
-     * Limit of upload items
+     * Maximum number of files a participant can upload for this question, from `1` through `10`. Default: `10`.
      * @min 1
      * @max 10
      */
     itemsLimit?: number | null;
     /**
-     * Formats of files that can be uploaded.
+     * Wix Forms file categories that participants can upload.
      *
-     * Specify at least one format. `UNKNOWN_FILE_UPLOAD_FORMAT` isn't supported as a format selection.
+     * Specify at least one format. `UNKNOWN_FILE_UPLOAD_FORMAT` isn't supported as a format selection. File-upload answers aren't evaluated and count as correct when calculating the earned grade.
      * @maxSize 6
      */
     fileUploadFormats?: FileUploadFormatWithLiterals[];
 }
 interface CreateQuizRequest {
-    /** Quiz to created */
+    /** Quiz definition to create. Generate a stable unique GUID for every `quiz.fields.id` value. */
     quiz: Quiz;
 }
 interface CreateQuizResponse {
-    /** Created quiz */
+    /** Created quiz definition. Assign its `id` to `step.quizOptions.id` to create an Online Programs quiz step. */
     quiz?: Quiz;
 }
 interface CloneQuizRequest {
     /**
-     * ID of the quiz to be cloned
+     * ID of the quiz definition to clone.
      * @format GUID
      */
     quizId: string;
 }
 interface CloneQuizResponse {
-    /** Cloned quiz */
+    /** Cloned quiz definition with a new ID. Step associations and submissions aren't cloned. */
     quiz?: Quiz;
 }
 interface BulkCreateQuizzesRequest {
@@ -255,7 +279,7 @@ interface ApplicationError {
     data?: Record<string, any> | null;
 }
 interface BulkCreateQuizzesResponseBulkQuizResult {
-    /** Metadata for the individual create operation. */
+    /** Metadata for the individual create operation. When the operation fails, `error` contains the original Wix Forms application error. */
     itemMetadata?: ItemMetadata;
     /** Created quiz. Empty when `return_entity` is `false`. */
     item?: Quiz;
@@ -297,29 +321,29 @@ interface BulkQuizResult {
 }
 interface GetQuizRequest {
     /**
-     * ID of the quiz
+     * Quiz ID, available from `step.quizOptions.id` on a quiz-type Online Programs step.
      * @format GUID
      */
     quizId: string;
 }
 interface GetQuizResponse {
-    /** Requested quiz */
+    /** Requested quiz definition. */
     quiz?: Quiz;
 }
 interface DeleteQuizRequest {
     /**
-     * ID of quiz
+     * ID of the quiz definition to permanently delete.
      * @format GUID
      */
     quizId: string;
 }
 interface DeleteQuizResponse {
-    /** Deleted quiz */
+    /** Permanently deleted quiz definition. */
     quiz?: Quiz;
 }
 interface BulkDeleteQuizzesRequest {
     /**
-     * IDs of the quizzes to delete.
+     * IDs of the quiz definitions to permanently delete. Coordinate deletion with the Steps API and remove known step references first.
      * @minSize 1
      * @maxSize 100
      * @format GUID
@@ -337,7 +361,7 @@ interface BulkDeleteQuizzesResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 interface BulkDeleteQuizzesResponseBulkQuizResult {
-    /** Metadata for the individual delete operation. */
+    /** Metadata for the individual delete operation. When the operation fails, `error` contains the original Wix Forms application error. */
     itemMetadata?: ItemMetadata;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
@@ -495,6 +519,52 @@ interface AccountInfo {
      */
     siteId?: string | null;
 }
+/** @docsIgnore */
+type CreateQuizApplicationErrors = {
+    code?: 'INVALID_QUIZ';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUIZ_CONFLICT';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type CloneQuizApplicationErrors = {
+    code?: 'INVALID_QUIZ';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUIZ_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUIZ_CONFLICT';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type BulkCreateQuizzesApplicationErrors = {
+    code?: 'INVALID_QUIZ';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type GetQuizApplicationErrors = {
+    code?: 'QUIZ_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type DeleteQuizApplicationErrors = {
+    code?: 'QUIZ_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'QUIZ_CONFLICT';
+    description?: string;
+    data?: Record<string, any>;
+};
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -519,4 +589,4 @@ declare function deleteQuiz(): __PublicMethodMetaInfo<'DELETE', {
 }, DeleteQuizRequest$1, DeleteQuizRequest, DeleteQuizResponse$1, DeleteQuizResponse>;
 declare function bulkDeleteQuizzes(): __PublicMethodMetaInfo<'POST', {}, BulkDeleteQuizzesRequest$1, BulkDeleteQuizzesRequest, BulkDeleteQuizzesResponse$1, BulkDeleteQuizzesResponse>;
 
-export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCloneQuizzesRequest as BulkCloneQuizzesRequestOriginal, type BulkCloneQuizzesResponse as BulkCloneQuizzesResponseOriginal, type BulkCreateQuizzesRequest as BulkCreateQuizzesRequestOriginal, type BulkCreateQuizzesResponseBulkQuizResult as BulkCreateQuizzesResponseBulkQuizResultOriginal, type BulkCreateQuizzesResponse as BulkCreateQuizzesResponseOriginal, type BulkDeleteQuizzesRequest as BulkDeleteQuizzesRequestOriginal, type BulkDeleteQuizzesResponseBulkQuizResult as BulkDeleteQuizzesResponseBulkQuizResultOriginal, type BulkDeleteQuizzesResponse as BulkDeleteQuizzesResponseOriginal, type BulkQuizResult as BulkQuizResultOriginal, type CloneQuizRequest as CloneQuizRequestOriginal, type CloneQuizResponse as CloneQuizResponseOriginal, type CreateQuizRequest as CreateQuizRequestOriginal, type CreateQuizResponse as CreateQuizResponseOriginal, type DeleteQuizRequest as DeleteQuizRequestOriginal, type DeleteQuizResponse as DeleteQuizResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FileUploadField as FileUploadFieldOriginal, FileUploadFormat as FileUploadFormatOriginal, type FileUploadFormatWithLiterals as FileUploadFormatWithLiteralsOriginal, type GetQuizRequest as GetQuizRequestOriginal, type GetQuizResponse as GetQuizResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type LongTextField as LongTextFieldOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MultiChoiceField as MultiChoiceFieldOriginal, type NumericField as NumericFieldOriginal, type QuizFieldFieldTypeOneOf as QuizFieldFieldTypeOneOfOriginal, type QuizField as QuizFieldOriginal, type Quiz as QuizOriginal, type QuizSettings as QuizSettingsOriginal, type RestoreInfo as RestoreInfoOriginal, type ShortTextField as ShortTextFieldOriginal, type SingleChoiceField as SingleChoiceFieldOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateQuizzes, bulkDeleteQuizzes, cloneQuiz, createQuiz, deleteQuiz, getQuiz };
+export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCloneQuizzesRequest as BulkCloneQuizzesRequestOriginal, type BulkCloneQuizzesResponse as BulkCloneQuizzesResponseOriginal, type BulkCreateQuizzesApplicationErrors as BulkCreateQuizzesApplicationErrorsOriginal, type BulkCreateQuizzesRequest as BulkCreateQuizzesRequestOriginal, type BulkCreateQuizzesResponseBulkQuizResult as BulkCreateQuizzesResponseBulkQuizResultOriginal, type BulkCreateQuizzesResponse as BulkCreateQuizzesResponseOriginal, type BulkDeleteQuizzesRequest as BulkDeleteQuizzesRequestOriginal, type BulkDeleteQuizzesResponseBulkQuizResult as BulkDeleteQuizzesResponseBulkQuizResultOriginal, type BulkDeleteQuizzesResponse as BulkDeleteQuizzesResponseOriginal, type BulkQuizResult as BulkQuizResultOriginal, type CloneQuizApplicationErrors as CloneQuizApplicationErrorsOriginal, type CloneQuizRequest as CloneQuizRequestOriginal, type CloneQuizResponse as CloneQuizResponseOriginal, type CreateQuizApplicationErrors as CreateQuizApplicationErrorsOriginal, type CreateQuizRequest as CreateQuizRequestOriginal, type CreateQuizResponse as CreateQuizResponseOriginal, type DeleteQuizApplicationErrors as DeleteQuizApplicationErrorsOriginal, type DeleteQuizRequest as DeleteQuizRequestOriginal, type DeleteQuizResponse as DeleteQuizResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FileUploadField as FileUploadFieldOriginal, FileUploadFormat as FileUploadFormatOriginal, type FileUploadFormatWithLiterals as FileUploadFormatWithLiteralsOriginal, type GetQuizApplicationErrors as GetQuizApplicationErrorsOriginal, type GetQuizRequest as GetQuizRequestOriginal, type GetQuizResponse as GetQuizResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ItemMetadata as ItemMetadataOriginal, type LongTextField as LongTextFieldOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MultiChoiceField as MultiChoiceFieldOriginal, type NumericField as NumericFieldOriginal, type QuizFieldFieldTypeOneOf as QuizFieldFieldTypeOneOfOriginal, type QuizField as QuizFieldOriginal, type Quiz as QuizOriginal, type QuizSettings as QuizSettingsOriginal, type RestoreInfo as RestoreInfoOriginal, type ShortTextField as ShortTextFieldOriginal, type SingleChoiceField as SingleChoiceFieldOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateQuizzes, bulkDeleteQuizzes, cloneQuiz, createQuiz, deleteQuiz, getQuiz };