@examplary/sdk 0.0.1

package/dist/generated/client/sdk.gen.d.ts

@@ -0,0 +1,685 @@
+import type { Client, Options as Options2, TDataShape } from './client';
+import type { DeleteEmbedSessionsByIdData, DeleteExamsByIdData, DeleteExamsByIdSessionsBySessionIdData, DeleteFoldersByIdData, DeleteLibraryItemsByItemIdData, DeleteLibraryPublishersByPublisherIdData, DeleteOrgData, DeletePermissionsByResourceByActorData, DeletePermissionsByResourceByActorErrors, DeletePermissionsByResourceByActorResponses, DeletePracticeSpacesByIdData, DeleteQuestionBankByIdData, DeleteQuestionTypesByIdData, DeleteSourceMaterialsByIdData, DeleteTaxonomiesByIdData, DeleteUsersByIdData, GetApiKeysData, GetEmbedSessionsByIdData, GetEmbedSessionsByIdResponses, GetExamsByIdContextSuggestionsData, GetExamsByIdData, GetExamsByIdSessionsBySessionIdData, GetExamsByIdSessionsData, GetExamsData, GetFoldersData, GetLibraryItemsFeaturedData, GetLibraryPublishersByPublisherIdItemsData, GetLibraryPublishersData, GetLibraryPublishersFeaturedData, GetLibraryPublishersMineData, GetMeData, GetMediaUploadData, GetMediaUploadResponses, GetOauthAuthorizeData, GetOrgData, GetOrgsData, GetPermissionsByResourceByActorData, GetPermissionsByResourceByActorErrors, GetPermissionsByResourceByActorResponses, GetPermissionsByResourceData, GetPermissionsByResourceErrors, GetPermissionsByResourceResponses, GetPracticeSpacesByIdData, GetPracticeSpacesByIdQuestionsPreviewData, GetPracticeSpacesData, GetQuestionBankData, GetQuestionTypesByIdData, GetQuestionTypesByIdExportQti3PciData, GetQuestionTypesData, GetQuestionTypesPublicData, GetSourceMaterialsByIdData, GetSourceMaterialsByIdResponses, GetSourceMaterialsData, GetSourceMaterialsResponses, GetStudentLevelsData, GetTaxonomiesData, GetUsersData, PatchLibraryItemsByItemIdData, PatchLibraryPublishersByPublisherIdData, PatchMeData, PatchOrgData, PatchQuestionBankByIdData, PatchSourceMaterialsByIdData, PatchUsersByIdData, PostApiKeysResetData, PostEmbedSessionsData, PostEmbedSessionsResponses, PostExamsByIdData, PostExamsByIdDuplicateData, PostExamsByIdExportQti21ZipData, PostExamsByIdExportQti21ZipResponses, PostExamsByIdExportQti3ZipData, PostExamsByIdExportQti3ZipResponses, PostExamsByIdGenerateCancelData, PostExamsByIdGenerateData, PostExamsByIdPrintData, PostExamsByIdQuestionsByQuestionIdGenerateData, PostExamsByIdQuestionsGenerateData, PostExamsByIdQuestionsImportData, PostExamsByIdSessionsBySessionIdFeedbackData, PostExamsByIdSessionsBySessionIdGenerateOverallFeedbackData, PostExamsByIdSessionsBySessionIdOverallFeedbackData, PostExamsByIdSessionsBySessionIdSuggestionsAcceptAllData, PostExamsByIdSessionsBySessionIdSuggestionsByQuestionIdAcceptData, PostExamsByIdSessionsData, PostExamsByIdSessionsScanData, PostExamsData, PostExamsImportData, PostFoldersByIdData, PostFoldersData, PostLibraryPublishersByPublisherIdItemsData, PostLibraryPublishersData, PostOauthTokenData, PostOrgsData, PostPermissionsByResourceData, PostPermissionsByResourceErrors, PostPermissionsByResourceResponses, PostPracticeSpacesByIdData, PostPracticeSpacesData, PostQuestionBankData, PostQuestionTypesByIdDisableData, PostQuestionTypesByIdEnableData, PostQuestionTypesData, PostSourceMaterialsByIdSliceData, PostSourceMaterialsByIdSliceResponses, PostSourceMaterialsData, PostSourceMaterialsResponses, PostTaxonomiesByIdData, PostTaxonomiesData, PostUsersData } from './types.gen';
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+declare class HeyApiClient {
+    protected client: Client;
+    constructor(args?: {
+        client?: Client;
+    });
+}
+declare class HeyApiRegistry<T> {
+    private readonly defaultKey;
+    private readonly instances;
+    get(key?: string): T;
+    set(value: T, key?: string): void;
+}
+export declare class QuestionTypes extends HeyApiClient {
+    /**
+     * List public question types
+     *
+     * Lists all public question types, which can be enabled in workspaces.
+     */
+    listPublic<ThrowOnError extends boolean = false>(options?: Options<GetQuestionTypesPublicData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Delete question type
+     *
+     * Deletes a specific question type by its ID. Note that only the owner organization of the question type can delete it, and only if it has not been used in an exam.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeleteQuestionTypesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Get question type
+     *
+     * Retrieves a specific question type by its ID.
+     */
+    get<ThrowOnError extends boolean = false>(options: Options<GetQuestionTypesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Get question type PCI module for QTI 3 export
+     *
+     * Get JS module for a question type PCI for QTI 3 export.
+     */
+    getQti3Pci<ThrowOnError extends boolean = false>(options: Options<GetQuestionTypesByIdExportQti3PciData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * List question types
+     *
+     * Lists all question types, either those available by default or those created within the user's organization.
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<GetQuestionTypesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Upsert question type
+     *
+     * Creates a new question type or updates an existing one. If the question type already exists, it will be updated; otherwise, a new one will be created.
+     */
+    upsert<ThrowOnError extends boolean = false>(options?: Options<PostQuestionTypesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Enable question type
+     *
+     * Enable a question type for the current workspace.
+     */
+    enable<ThrowOnError extends boolean = false>(options: Options<PostQuestionTypesByIdEnableData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Disable question type
+     *
+     * Disable a question type for the current workspace.
+     */
+    disable<ThrowOnError extends boolean = false>(options: Options<PostQuestionTypesByIdDisableData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Items extends HeyApiClient {
+    /**
+     * List items by publisher
+     *
+     * Lists all library items for the specified publisher profile.
+     */
+    list<ThrowOnError extends boolean = false>(options: Options<GetLibraryPublishersByPublisherIdItemsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Create library item
+     *
+     * Adds an item to the library. Only the publisher owner can add items to their publisher profile.
+     */
+    create<ThrowOnError extends boolean = false>(options: Options<PostLibraryPublishersByPublisherIdItemsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Publishers extends HeyApiClient {
+    /**
+     * List featured publishers
+     *
+     * Lists all library publishers that are marked as featured.
+     */
+    listFeatured<ThrowOnError extends boolean = false>(options?: Options<GetLibraryPublishersFeaturedData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * List all publishers
+     *
+     * Lists all library publisher profiles.
+     */
+    listAll<ThrowOnError extends boolean = false>(options?: Options<GetLibraryPublishersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Create publisher
+     *
+     * Creates a new library publisher profile.
+     */
+    create<ThrowOnError extends boolean = false>(options?: Options<PostLibraryPublishersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * List my publishers
+     *
+     * Lists all library publisher profiles created by the authenticated user.
+     */
+    listMine<ThrowOnError extends boolean = false>(options?: Options<GetLibraryPublishersMineData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Delete publisher
+     *
+     * Deletes a library publisher profile. Only the owner can delete their publisher profile.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeleteLibraryPublishersByPublisherIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Update publisher
+     *
+     * Updates a library publisher profile. Only the owner can update their publisher profile.
+     */
+    update<ThrowOnError extends boolean = false>(options: Options<PatchLibraryPublishersByPublisherIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    private _items?;
+    get items(): Items;
+}
+export declare class Items2 extends HeyApiClient {
+    /**
+     * List featured library items
+     *
+     * Lists all library items that are marked as featured.
+     */
+    listFeatured<ThrowOnError extends boolean = false>(options?: Options<GetLibraryItemsFeaturedData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Delete library item
+     *
+     * Deletes a library item. Only the publisher owner can delete items from their publisher profile.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeleteLibraryItemsByItemIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Update library item
+     *
+     * Updates a library item. Only the publisher owner can update items in their publisher profile.
+     */
+    update<ThrowOnError extends boolean = false>(options: Options<PatchLibraryItemsByItemIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Library extends HeyApiClient {
+    private _publishers?;
+    get publishers(): Publishers;
+    private _items?;
+    get items(): Items2;
+}
+export declare class Oauth extends HeyApiClient {
+    /**
+     * OAuth authorization endpoint
+     *
+     * Initiates OAuth authorization flow. Redirects to the frontend authorization UI where users can approve or deny access.
+     */
+    authorize<ThrowOnError extends boolean = false>(options: Options<GetOauthAuthorizeData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * OAuth token endpoint
+     *
+     * Exchange authorization code for access token, or refresh an existing token.
+     */
+    token<ThrowOnError extends boolean = false>(options?: Options<PostOauthTokenData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class EmbedSessions extends HeyApiClient {
+    /**
+     * Create embed session
+     *
+     * Create a new embed session. This allows you to embed the exam generation flow into your own application.
+     */
+    create<ThrowOnError extends boolean = false>(options?: Options<PostEmbedSessionsData, ThrowOnError>): import("./client").RequestResult<PostEmbedSessionsResponses, unknown, ThrowOnError>;
+    /**
+     * Revoke embed session
+     *
+     * Revoke access to an embed session by its ID.
+     */
+    revoke<ThrowOnError extends boolean = false>(options: Options<DeleteEmbedSessionsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Get embed session
+     *
+     * Retrieve an embed session by its ID.
+     */
+    get<ThrowOnError extends boolean = false>(options: Options<GetEmbedSessionsByIdData, ThrowOnError>): import("./client").RequestResult<GetEmbedSessionsByIdResponses, unknown, ThrowOnError>;
+}
+export declare class Me extends HeyApiClient {
+    /**
+     * Get me
+     *
+     * Get the current user's account details.
+     */
+    get<ThrowOnError extends boolean = false>(options?: Options<GetMeData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Update me
+     *
+     * Update the current user's account details.
+     */
+    update<ThrowOnError extends boolean = false>(options?: Options<PatchMeData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Media extends HeyApiClient {
+    /**
+     * Get file upload URL
+     *
+     * Returns a signed URL for uploading a file, and a public URL for accessing it afterwards.
+     */
+    upload<ThrowOnError extends boolean = false>(options?: Options<GetMediaUploadData, ThrowOnError>): import("./client").RequestResult<GetMediaUploadResponses, unknown, ThrowOnError>;
+}
+export declare class Org extends HeyApiClient {
+    /**
+     * Delete organization
+     */
+    delete<ThrowOnError extends boolean = false>(options?: Options<DeleteOrgData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Get organization
+     */
+    get<ThrowOnError extends boolean = false>(options?: Options<GetOrgData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Update organization
+     */
+    update<ThrowOnError extends boolean = false>(options?: Options<PatchOrgData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Orgs extends HeyApiClient {
+    /**
+     * List all organizations
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<GetOrgsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Create a new organization
+     *
+     * Create a new workspace to collaborate with others on exams.
+     */
+    create<ThrowOnError extends boolean = false>(options?: Options<PostOrgsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class ApiKeys extends HeyApiClient {
+    /**
+     * Get API key
+     *
+     * Get the API key for the current org/user combination. Creates one if none exists.
+     */
+    get<ThrowOnError extends boolean = false>(options?: Options<GetApiKeysData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Reset API key
+     *
+     * Invalidate old API keys for this org/user and create a new one.
+     */
+    reset<ThrowOnError extends boolean = false>(options?: Options<PostApiKeysResetData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Taxonomies extends HeyApiClient {
+    /**
+     * Get taxonomies
+     *
+     * Get a list available taxonomies, including defaults and taxonomies created in the current workspace.
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<GetTaxonomiesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Create taxonomy
+     *
+     * Save a new taxonomy in the current workspace.
+     */
+    create<ThrowOnError extends boolean = false>(options?: Options<PostTaxonomiesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Delete taxonomy
+     *
+     * Delete a taxonomy from the current workspace. This fails if there are any exams associated with the taxonomy.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeleteTaxonomiesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Update taxonomy
+     *
+     * Update an existing taxonomy in the current workspace.
+     */
+    update<ThrowOnError extends boolean = false>(options: Options<PostTaxonomiesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Permissions extends HeyApiClient {
+    /**
+     * Get sharing permissions
+     *
+     * Get a list of users, groups and orgs that have access to a specific resource.
+     */
+    list<ThrowOnError extends boolean = false>(options: Options<GetPermissionsByResourceData, ThrowOnError>): import("./client").RequestResult<GetPermissionsByResourceResponses, GetPermissionsByResourceErrors, ThrowOnError>;
+    /**
+     * Create permission
+     *
+     * Create a new permission for a specific resource, or update the role of an existing actor.
+     */
+    assign<ThrowOnError extends boolean = false>(options: Options<PostPermissionsByResourceData, ThrowOnError>): import("./client").RequestResult<PostPermissionsByResourceResponses, PostPermissionsByResourceErrors, ThrowOnError>;
+    /**
+     * Remove permission
+     *
+     * Remove a permission for a specific actor on a specific resource.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeletePermissionsByResourceByActorData, ThrowOnError>): import("./client").RequestResult<DeletePermissionsByResourceByActorResponses, DeletePermissionsByResourceByActorErrors, ThrowOnError>;
+    /**
+     * Get actor role
+     *
+     * Get the role of a specific actor for a specific resource.
+     */
+    getActorRole<ThrowOnError extends boolean = false>(options: Options<GetPermissionsByResourceByActorData, ThrowOnError>): import("./client").RequestResult<GetPermissionsByResourceByActorResponses, GetPermissionsByResourceByActorErrors, ThrowOnError>;
+}
+export declare class StudentLevels extends HeyApiClient {
+    /**
+     * List available student levels
+     *
+     * Get a list of available default student levels.
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<GetStudentLevelsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Users extends HeyApiClient {
+    /**
+     * List users
+     *
+     * Get a list of all users in the workspace.
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<GetUsersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Create user
+     *
+     * Create a new user in the workspace.
+     */
+    create<ThrowOnError extends boolean = false>(options?: Options<PostUsersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Delete user
+     *
+     * Delete a user from the workspace.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeleteUsersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Update user role
+     *
+     * Update a user's role within the workspace.
+     */
+    update<ThrowOnError extends boolean = false>(options: Options<PatchUsersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Sessions extends HeyApiClient {
+    /**
+     * List exam sessions
+     *
+     * Get a list of all student sessions for an exam, representing a set of answers from a student.
+     */
+    list<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdSessionsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Create session
+     *
+     * Manually create a session, possibly from uploaded data.
+     */
+    import<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Get answers from scan
+     *
+     * Scan student answers from a document.
+     */
+    scan<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsScanData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Delete exam session
+     *
+     * Remove an exam session.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeleteExamsByIdSessionsBySessionIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Get exam session
+     *
+     * Get a single exam session by its ID, representing a set of answers from a student.
+     */
+    get<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdSessionsBySessionIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Provide feedback
+     *
+     * Set teacher feedback and/or a grade for a specific question in an exam session.
+     */
+    saveFeedback<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdFeedbackData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Provide overall feedback
+     *
+     * Set teacher feedback for the test as a whole in an exam session.
+     */
+    saveOverallFeedback<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdOverallFeedbackData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Generate overall feedback
+     *
+     * Generate feedback for the test as a whole in an exam session.
+     */
+    generateOverallFeedback<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdGenerateOverallFeedbackData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Accept AI grading suggestions
+     *
+     * Accept all AI-generated grading suggestions for the exam session.
+     */
+    acceptAllSuggestions<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdSuggestionsAcceptAllData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Accept single AI grading suggestion
+     *
+     * Accept a single AI-generated grading suggestion for the exam session.
+     */
+    acceptSuggestion<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdSuggestionsByQuestionIdAcceptData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Questions extends HeyApiClient {
+    /**
+     * Import questions
+     *
+     * Import questions into an exam from a file. Support Word, PDF, Moodle quiz XML and plain text files.
+     */
+    import<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdQuestionsImportData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Generate question
+     *
+     * Generate a new question for the exam using an AI prompt.
+     */
+    generate<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdQuestionsGenerateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Regenerate question
+     *
+     * Update a question using an AI prompt.
+     */
+    regenerate<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdQuestionsByQuestionIdGenerateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Export extends HeyApiClient {
+    /**
+     * Export QTI 3 package
+     *
+     * Export an exam as a QTI 3 ZIP package.
+     */
+    qti3Zip<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdExportQti3ZipData, ThrowOnError>): import("./client").RequestResult<PostExamsByIdExportQti3ZipResponses, unknown, ThrowOnError>;
+    /**
+     * Export QTI 2.1 package
+     *
+     * Export an exam as a QTI 2.1 ZIP package.
+     */
+    qti21Zip<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdExportQti21ZipData, ThrowOnError>): import("./client").RequestResult<PostExamsByIdExportQti21ZipResponses, unknown, ThrowOnError>;
+}
+export declare class Exam extends HeyApiClient {
+    private _sessions?;
+    get sessions(): Sessions;
+    private _questions?;
+    get questions(): Questions;
+    private _export?;
+    get export(): Export;
+}
+export declare class Exams extends HeyApiClient {
+    /**
+     * List exams
+     *
+     * Get a list of all exams within your workspace.
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<GetExamsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Create exam
+     *
+     * Create a new exam within your workspace.
+     */
+    create<ThrowOnError extends boolean = false>(options?: Options<PostExamsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Import exam
+     *
+     * Create an exam by importing one or more source materials (e.g. an existing exam).
+     */
+    import<ThrowOnError extends boolean = false>(options?: Options<PostExamsImportData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Delete exam
+     *
+     * Delete the exam.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeleteExamsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Get exam
+     *
+     * Get a single exam by its ID.
+     */
+    get<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Update exam
+     *
+     * Update an existing exam.
+     */
+    update<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Duplicate exam
+     *
+     * Duplicate the exam's questions and settings to a new exam.
+     */
+    duplicate<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdDuplicateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Print exam
+     *
+     * Export an exam to a PDF file or Word document.
+     */
+    print<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdPrintData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Generate exam
+     *
+     * Initiate a job to generate new questions for the exam using AI, based on the source materials and metadata specified.
+     */
+    startGeneration<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdGenerateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Cancel exam generation
+     *
+     * Cancel an ongoing job to generate new questions for the exam using AI.
+     */
+    cancelGeneration<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdGenerateCancelData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Get exam context suggestions
+     *
+     * Get AI-generated suggestions for context/instructions to include in the exam generation prompt, based on the source materials linked to the exam.
+     */
+    getContextSuggestions<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdContextSuggestionsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class PracticeSpaces extends HeyApiClient {
+    /**
+     * List practice spaces
+     *
+     * Get a list of all practice spaces you have access to in this workspace.
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<GetPracticeSpacesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Create practice space
+     *
+     * Create a new practice space within your workspace.
+     */
+    create<ThrowOnError extends boolean = false>(options?: Options<PostPracticeSpacesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Delete practice space
+     *
+     * Delete the practice space.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeletePracticeSpacesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Get practice space
+     *
+     * Get a single practice space by its ID.
+     */
+    get<ThrowOnError extends boolean = false>(options: Options<GetPracticeSpacesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Update practice space
+     *
+     * Update an existing practice space.
+     */
+    update<ThrowOnError extends boolean = false>(options: Options<PostPracticeSpacesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Preview top practice space questions
+     *
+     * Get a preview of the top practice space questions by quality score.
+     */
+    questionsPreview<ThrowOnError extends boolean = false>(options: Options<GetPracticeSpacesByIdQuestionsPreviewData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class SourceMaterials extends HeyApiClient {
+    /**
+     * List source materials in org
+     *
+     * Returns a list of source materials for the current organization.
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<GetSourceMaterialsData, ThrowOnError>): import("./client").RequestResult<GetSourceMaterialsResponses, unknown, ThrowOnError>;
+    /**
+     * Add source material
+     *
+     * Add a source material and start processing it for later use in an exam.
+     */
+    create<ThrowOnError extends boolean = false>(options?: Options<PostSourceMaterialsData, ThrowOnError>): import("./client").RequestResult<PostSourceMaterialsResponses, unknown, ThrowOnError>;
+    /**
+     * Delete source material
+     *
+     * Deletes the specified source material.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeleteSourceMaterialsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Get source material
+     *
+     * Returns the current status and facts extracted from the specified source material.
+     */
+    get<ThrowOnError extends boolean = false>(options: Options<GetSourceMaterialsByIdData, ThrowOnError>): import("./client").RequestResult<GetSourceMaterialsByIdResponses, unknown, ThrowOnError>;
+    /**
+     * Update source material
+     *
+     * Updates the specified source material.
+     */
+    update<ThrowOnError extends boolean = false>(options: Options<PatchSourceMaterialsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Create a source material slice
+     *
+     * Create a new source material based on a specific page range of an existing source material.
+     */
+    slice<ThrowOnError extends boolean = false>(options: Options<PostSourceMaterialsByIdSliceData, ThrowOnError>): import("./client").RequestResult<PostSourceMaterialsByIdSliceResponses, unknown, ThrowOnError>;
+}
+export declare class Folders extends HeyApiClient {
+    /**
+     * Get folders
+     *
+     * Get a list of folders for exam organisation that exist within the current workspace.
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<GetFoldersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Create folder
+     *
+     * Create a new folder in the current workspace.
+     */
+    create<ThrowOnError extends boolean = false>(options?: Options<PostFoldersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Delete folder
+     *
+     * Delete a folder from the current workspace. If there are any exams in the folder, they will be moved out of the folder.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeleteFoldersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Update folder
+     *
+     * Update an existing folder in the current workspace.
+     */
+    update<ThrowOnError extends boolean = false>(options: Options<PostFoldersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class QuestionBank extends HeyApiClient {
+    /**
+     * Get question bank items
+     *
+     * Get a list of question bank items that exist within the current workspace.
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<GetQuestionBankData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Add question to question bank
+     *
+     * Add a question to the question bank in the current workspace.
+     */
+    create<ThrowOnError extends boolean = false>(options?: Options<PostQuestionBankData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Delete question bank item
+     *
+     * Delete a question bank item from the current workspace.
+     */
+    delete<ThrowOnError extends boolean = false>(options: Options<DeleteQuestionBankByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+    /**
+     * Update question bank item
+     *
+     * Update an existing question bank item in the current workspace.
+     */
+    update<ThrowOnError extends boolean = false>(options: Options<PatchQuestionBankByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
+}
+export declare class Examplary extends HeyApiClient {
+    static readonly __registry: HeyApiRegistry<Examplary>;
+    constructor(args?: {
+        client?: Client;
+        key?: string;
+    });
+    private _questionTypes?;
+    get questionTypes(): QuestionTypes;
+    private _library?;
+    get library(): Library;
+    private _oauth?;
+    get oauth(): Oauth;
+    private _embedSessions?;
+    get embedSessions(): EmbedSessions;
+    private _me?;
+    get me(): Me;
+    private _media?;
+    get media(): Media;
+    private _org?;
+    get org(): Org;
+    private _orgs?;
+    get orgs(): Orgs;
+    private _apiKeys?;
+    get apiKeys(): ApiKeys;
+    private _taxonomies?;
+    get taxonomies(): Taxonomies;
+    private _permissions?;
+    get permissions(): Permissions;
+    private _studentLevels?;
+    get studentLevels(): StudentLevels;
+    private _users?;
+    get users(): Users;
+    private _exam?;
+    get exam(): Exam;
+    private _exams?;
+    get exams(): Exams;
+    private _practiceSpaces?;
+    get practiceSpaces(): PracticeSpaces;
+    private _sourceMaterials?;
+    get sourceMaterials(): SourceMaterials;
+    private _folders?;
+    get folders(): Folders;
+    private _questionBank?;
+    get questionBank(): QuestionBank;
+}
+export {};