@wix/auto_sdk_online-programs_quizzes 1.0.0

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

@@ -0,0 +1,318 @@
+import { CreateQuizRequest as CreateQuizRequest$1, CreateQuizResponse as CreateQuizResponse$1, CloneQuizRequest as CloneQuizRequest$1, CloneQuizResponse as CloneQuizResponse$1, BulkCreateQuizRequest as BulkCreateQuizRequest$1, BulkCreateQuizResponse as BulkCreateQuizResponse$1, BulkCloneQuizRequest as BulkCloneQuizRequest$1, BulkCloneQuizResponse as BulkCloneQuizResponse$1, GetQuizRequest as GetQuizRequest$1, GetQuizResponse as GetQuizResponse$1, DeleteQuizRequest as DeleteQuizRequest$1, DeleteQuizResponse as DeleteQuizResponse$1 } from './index.typings.mjs';
+import '@wix/sdk-types';
+
+interface Quiz {
+    /**
+     * ID of the quiz
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /** Quiz settings */
+    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
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * The time this quiz was created
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * The time this quiz was last updated
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Quiz fields
+     * @minSize 1
+     * @maxSize 200
+     */
+    fields?: QuizField[];
+}
+interface QuizSettings {
+    /**
+     * Minimal grade to pass the quiz
+     * @max 100
+     */
+    passingGrade?: number | null;
+    /**
+     * Quiz title
+     * @maxLength 200
+     */
+    title?: string | null;
+    /**
+     * Maximal number of submission attempts
+     * @min 1
+     */
+    attempts?: number | null;
+}
+interface QuizField extends QuizFieldFieldTypeOneOf {
+    /** Type for numeric input */
+    numeric?: NumericField;
+    /** Type for text input */
+    shortText?: ShortTextField;
+    /** Type for long text input */
+    longText?: LongTextField;
+    /** Type for input with predefined options where only one can be selected */
+    singleChoice?: SingleChoiceField;
+    /** Type for input with predefined options where multiple can be selected */
+    multiChoice?: MultiChoiceField;
+    /** Type for file input */
+    fileUpload?: FileUploadField;
+    /**
+     * Field ID
+     * @format GUID
+     * @immutable
+     */
+    id?: string;
+    /**
+     * Key used in submission
+     * @maxLength 200
+     * @immutable
+     */
+    target?: string | null;
+    /**
+     * Question
+     * @minLength 1
+     * @maxLength 350
+     */
+    question?: string | null;
+    /** Score of the question when answered right */
+    score?: number | null;
+    /**
+     * Message shown for right answer
+     * @maxLength 350
+     */
+    rightMessage?: string | null;
+    /**
+     * Message shown for wrong answer
+     * @maxLength 350
+     */
+    wrongMessage?: string | null;
+}
+/** @oneof */
+interface QuizFieldFieldTypeOneOf {
+    /** Type for numeric input */
+    numeric?: NumericField;
+    /** Type for text input */
+    shortText?: ShortTextField;
+    /** Type for long text input */
+    longText?: LongTextField;
+    /** Type for input with predefined options where only one can be selected */
+    singleChoice?: SingleChoiceField;
+    /** Type for input with predefined options where multiple can be selected */
+    multiChoice?: MultiChoiceField;
+    /** Type for file input */
+    fileUpload?: FileUploadField;
+}
+declare enum FileFormat {
+    IMAGE = "IMAGE",
+    VIDEO = "VIDEO",
+    AUDIO = "AUDIO",
+    DOCUMENT = "DOCUMENT",
+    ARCHIVE = "ARCHIVE"
+}
+/** @enumType */
+type FileFormatWithLiterals = FileFormat | 'IMAGE' | 'VIDEO' | 'AUDIO' | 'DOCUMENT' | 'ARCHIVE';
+interface NumericField {
+    /** Right answer */
+    rightAnswer?: number | null;
+}
+interface ShortTextField {
+    /**
+     * Right answer
+     * @minLength 1
+     * @maxLength 200
+     */
+    rightAnswer?: string | null;
+}
+interface LongTextField {
+}
+interface SingleChoiceField {
+    /**
+     * Right answer
+     * @minLength 1
+     * @maxLength 350
+     */
+    rightAnswer?: string | null;
+    /**
+     * Answer options
+     * @minSize 1
+     * @maxSize 90
+     * @minLength 1
+     * @maxLength 350
+     */
+    options?: string[] | null;
+}
+interface MultiChoiceField {
+    /**
+     * Right answer
+     * @maxSize 90
+     * @minLength 1
+     * @maxLength 350
+     */
+    rightAnswer?: string[] | null;
+    /**
+     * Answer options
+     * @minSize 1
+     * @maxSize 90
+     * @minLength 1
+     * @maxLength 350
+     */
+    options?: string[] | null;
+}
+interface FileUploadField {
+    /**
+     * Text for upload button
+     * @minLength 1
+     * @maxLength 100
+     */
+    buttonText?: string | null;
+    /**
+     * Limit of upload items
+     * @min 1
+     * @max 10
+     */
+    itemsLimit?: number | null;
+    /**
+     * Formats of files that can be uploaded
+     * @minSize 1
+     * @maxSize 4
+     */
+    fileFormats?: FileFormatWithLiterals[];
+}
+interface CreateQuizRequest {
+    /** Quiz to created */
+    quiz: Quiz;
+}
+interface CreateQuizResponse {
+    /** Created quiz */
+    quiz?: Quiz;
+}
+interface CloneQuizRequest {
+    /**
+     * ID of the quiz to be cloned
+     * @format GUID
+     */
+    quizId: string;
+}
+interface CloneQuizResponse {
+    /** Cloned quiz */
+    quiz?: Quiz;
+}
+interface BulkCreateQuizRequest {
+    /**
+     * Quizzes to be created
+     * @maxSize 30
+     */
+    quizzes: Quiz[];
+    /** When set, items will be returned on successful create */
+    returnEntity?: boolean;
+}
+interface BulkCreateQuizResponse {
+    /** Created quizzes with metadata */
+    results?: BulkQuizResult[];
+}
+interface BulkQuizResult {
+    /** Created quiz metadata */
+    itemMetadata?: ItemMetadata;
+    /** Created quiz */
+    item?: Quiz;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkCloneQuizRequest {
+    /**
+     * IDs of the quizzes to clone.
+     * @minSize 1
+     * @maxSize 30
+     * @format GUID
+     */
+    quizIds: string[];
+    /**
+     * Whether to return the cloned quizzes in the response.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean;
+}
+interface BulkCloneQuizResponse {
+    /** Results of the bulk clone operation, including cloned quizzes and metadata. */
+    results?: BulkQuizResult[];
+    /** Metadata about the bulk operation. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface GetQuizRequest {
+    /**
+     * ID of the quiz
+     * @format GUID
+     */
+    quizId: string;
+}
+interface GetQuizResponse {
+    /** Requested quiz */
+    quiz?: Quiz;
+}
+interface DeleteQuizRequest {
+    /**
+     * ID of quiz
+     * @format GUID
+     */
+    quizId: string;
+}
+interface DeleteQuizResponse {
+    /** Deleted quiz */
+    quiz?: Quiz;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createQuiz(): __PublicMethodMetaInfo<'POST', {}, CreateQuizRequest$1, CreateQuizRequest, CreateQuizResponse$1, CreateQuizResponse>;
+declare function cloneQuiz(): __PublicMethodMetaInfo<'POST', {
+    quizId: string;
+}, CloneQuizRequest$1, CloneQuizRequest, CloneQuizResponse$1, CloneQuizResponse>;
+declare function bulkCreateQuiz(): __PublicMethodMetaInfo<'POST', {}, BulkCreateQuizRequest$1, BulkCreateQuizRequest, BulkCreateQuizResponse$1, BulkCreateQuizResponse>;
+declare function bulkCloneQuiz(): __PublicMethodMetaInfo<'POST', {}, BulkCloneQuizRequest$1, BulkCloneQuizRequest, BulkCloneQuizResponse$1, BulkCloneQuizResponse>;
+declare function getQuiz(): __PublicMethodMetaInfo<'GET', {
+    quizId: string;
+}, GetQuizRequest$1, GetQuizRequest, GetQuizResponse$1, GetQuizResponse>;
+declare function deleteQuiz(): __PublicMethodMetaInfo<'DELETE', {
+    quizId: string;
+}, DeleteQuizRequest$1, DeleteQuizRequest, DeleteQuizResponse$1, DeleteQuizResponse>;
+
+export { type __PublicMethodMetaInfo, bulkCloneQuiz, bulkCreateQuiz, cloneQuiz, createQuiz, deleteQuiz, getQuiz };

package/build/internal/es/meta.mjs

@@ -0,0 +1,353 @@
+// src/achievements-quizzes-v1-quiz-quizzes.http.ts
+import { toURLSearchParams } from "@wix/sdk-runtime/rest-modules";
+import { transformSDKFloatToRESTFloat } from "@wix/sdk-runtime/transformations/float";
+import { transformRESTFloatToSDKFloat } from "@wix/sdk-runtime/transformations/float";
+import { transformSDKTimestampToRESTTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
+import { transformRESTTimestampToSDKTimestamp } from "@wix/sdk-runtime/transformations/timestamp";
+import { transformPaths } from "@wix/sdk-runtime/transformations/transform-paths";
+import { resolveUrl } from "@wix/sdk-runtime/rest-modules";
+function resolveWixAchievementsQuizzesV1QuizServiceUrl(opts) {
+  const domainToMappings = {};
+  return resolveUrl(Object.assign(opts, { domainToMappings }));
+}
+var PACKAGE_NAME = "@wix/auto_sdk_online-programs_quizzes";
+function createQuiz(payload) {
+  function __createQuiz({ host }) {
+    const serializedData = transformPaths(payload, [
+      {
+        transformFn: transformSDKTimestampToRESTTimestamp,
+        paths: [{ path: "quiz.createdDate" }, { path: "quiz.updatedDate" }]
+      },
+      {
+        transformFn: transformSDKFloatToRESTFloat,
+        paths: [
+          { path: "quiz.fields.score" },
+          { path: "quiz.fields.numeric.rightAnswer" }
+        ]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.achievements.quizzes.v1.quiz",
+      method: "POST",
+      methodFqn: "wix.achievements.quizzes.v1.QuizService.CreateQuiz",
+      packageName: PACKAGE_NAME,
+      url: resolveWixAchievementsQuizzesV1QuizServiceUrl({
+        protoPath: "/v1/quizzes",
+        data: serializedData,
+        host
+      }),
+      data: serializedData,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "quiz.createdDate" }, { path: "quiz.updatedDate" }]
+        },
+        {
+          transformFn: transformRESTFloatToSDKFloat,
+          paths: [
+            { path: "quiz.fields.score" },
+            { path: "quiz.fields.numeric.rightAnswer" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __createQuiz;
+}
+function cloneQuiz(payload) {
+  function __cloneQuiz({ host }) {
+    const metadata = {
+      entityFqdn: "wix.achievements.quizzes.v1.quiz",
+      method: "POST",
+      methodFqn: "wix.achievements.quizzes.v1.QuizService.CloneQuiz",
+      packageName: PACKAGE_NAME,
+      url: resolveWixAchievementsQuizzesV1QuizServiceUrl({
+        protoPath: "/v1/quizzes/{quizId}/clone",
+        data: payload,
+        host
+      }),
+      data: payload,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "quiz.createdDate" }, { path: "quiz.updatedDate" }]
+        },
+        {
+          transformFn: transformRESTFloatToSDKFloat,
+          paths: [
+            { path: "quiz.fields.score" },
+            { path: "quiz.fields.numeric.rightAnswer" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __cloneQuiz;
+}
+function bulkCreateQuiz(payload) {
+  function __bulkCreateQuiz({ host }) {
+    const serializedData = transformPaths(payload, [
+      {
+        transformFn: transformSDKTimestampToRESTTimestamp,
+        paths: [
+          { path: "quizzes.createdDate" },
+          { path: "quizzes.updatedDate" }
+        ]
+      },
+      {
+        transformFn: transformSDKFloatToRESTFloat,
+        paths: [
+          { path: "quizzes.fields.score" },
+          { path: "quizzes.fields.numeric.rightAnswer" }
+        ]
+      }
+    ]);
+    const metadata = {
+      entityFqdn: "wix.achievements.quizzes.v1.quiz",
+      method: "POST",
+      methodFqn: "wix.achievements.quizzes.v1.QuizService.BulkCreateQuiz",
+      packageName: PACKAGE_NAME,
+      url: resolveWixAchievementsQuizzesV1QuizServiceUrl({
+        protoPath: "/v1/bulk/quizzes/create",
+        data: serializedData,
+        host
+      }),
+      data: serializedData,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "results.item.createdDate" },
+            { path: "results.item.updatedDate" }
+          ]
+        },
+        {
+          transformFn: transformRESTFloatToSDKFloat,
+          paths: [
+            { path: "results.item.fields.score" },
+            { path: "results.item.fields.numeric.rightAnswer" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __bulkCreateQuiz;
+}
+function bulkCloneQuiz(payload) {
+  function __bulkCloneQuiz({ host }) {
+    const metadata = {
+      entityFqdn: "wix.achievements.quizzes.v1.quiz",
+      method: "POST",
+      methodFqn: "wix.achievements.quizzes.v1.QuizService.BulkCloneQuiz",
+      packageName: PACKAGE_NAME,
+      url: resolveWixAchievementsQuizzesV1QuizServiceUrl({
+        protoPath: "/v1/bulk/quizzes/clone",
+        data: payload,
+        host
+      }),
+      data: payload,
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [
+            { path: "results.item.createdDate" },
+            { path: "results.item.updatedDate" }
+          ]
+        },
+        {
+          transformFn: transformRESTFloatToSDKFloat,
+          paths: [
+            { path: "results.item.fields.score" },
+            { path: "results.item.fields.numeric.rightAnswer" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __bulkCloneQuiz;
+}
+function getQuiz(payload) {
+  function __getQuiz({ host }) {
+    const metadata = {
+      entityFqdn: "wix.achievements.quizzes.v1.quiz",
+      method: "GET",
+      methodFqn: "wix.achievements.quizzes.v1.QuizService.GetQuiz",
+      packageName: PACKAGE_NAME,
+      url: resolveWixAchievementsQuizzesV1QuizServiceUrl({
+        protoPath: "/v1/quizzes/{quizId}",
+        data: payload,
+        host
+      }),
+      params: toURLSearchParams(payload),
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "quiz.createdDate" }, { path: "quiz.updatedDate" }]
+        },
+        {
+          transformFn: transformRESTFloatToSDKFloat,
+          paths: [
+            { path: "quiz.fields.score" },
+            { path: "quiz.fields.numeric.rightAnswer" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __getQuiz;
+}
+function deleteQuiz(payload) {
+  function __deleteQuiz({ host }) {
+    const metadata = {
+      entityFqdn: "wix.achievements.quizzes.v1.quiz",
+      method: "DELETE",
+      methodFqn: "wix.achievements.quizzes.v1.QuizService.DeleteQuiz",
+      packageName: PACKAGE_NAME,
+      url: resolveWixAchievementsQuizzesV1QuizServiceUrl({
+        protoPath: "/v1/quizzes/{quizId}",
+        data: payload,
+        host
+      }),
+      params: toURLSearchParams(payload),
+      transformResponse: (payload2) => transformPaths(payload2, [
+        {
+          transformFn: transformRESTTimestampToSDKTimestamp,
+          paths: [{ path: "quiz.createdDate" }, { path: "quiz.updatedDate" }]
+        },
+        {
+          transformFn: transformRESTFloatToSDKFloat,
+          paths: [
+            { path: "quiz.fields.score" },
+            { path: "quiz.fields.numeric.rightAnswer" }
+          ]
+        }
+      ])
+    };
+    return metadata;
+  }
+  return __deleteQuiz;
+}
+
+// src/achievements-quizzes-v1-quiz-quizzes.meta.ts
+function createQuiz2() {
+  const payload = {};
+  const getRequestOptions = createQuiz(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v1/quizzes",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function cloneQuiz2() {
+  const payload = { quizId: ":quizId" };
+  const getRequestOptions = cloneQuiz(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v1/quizzes/{quizId}/clone",
+    pathParams: { quizId: "quizId" },
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function bulkCreateQuiz2() {
+  const payload = {};
+  const getRequestOptions = bulkCreateQuiz(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v1/bulk/quizzes/create",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function bulkCloneQuiz2() {
+  const payload = {};
+  const getRequestOptions = bulkCloneQuiz(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "POST",
+    path: "/v1/bulk/quizzes/clone",
+    pathParams: {},
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function getQuiz2() {
+  const payload = { quizId: ":quizId" };
+  const getRequestOptions = getQuiz(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "GET",
+    path: "/v1/quizzes/{quizId}",
+    pathParams: { quizId: "quizId" },
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+function deleteQuiz2() {
+  const payload = { quizId: ":quizId" };
+  const getRequestOptions = deleteQuiz(payload);
+  const getUrl = (context) => {
+    const { url } = getRequestOptions(context);
+    return url;
+  };
+  return {
+    getUrl,
+    httpMethod: "DELETE",
+    path: "/v1/quizzes/{quizId}",
+    pathParams: { quizId: "quizId" },
+    __requestType: null,
+    __originalRequestType: null,
+    __responseType: null,
+    __originalResponseType: null
+  };
+}
+export {
+  bulkCloneQuiz2 as bulkCloneQuiz,
+  bulkCreateQuiz2 as bulkCreateQuiz,
+  cloneQuiz2 as cloneQuiz,
+  createQuiz2 as createQuiz,
+  deleteQuiz2 as deleteQuiz,
+  getQuiz2 as getQuiz
+};
+//# sourceMappingURL=meta.mjs.map