@examplary/sdk 0.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/client/client/client.gen.js +99 -163
- package/dist/generated/client/client/index.js +1 -1
- package/dist/generated/client/client/types.gen.d.ts +3 -4
- package/dist/generated/client/client/types.gen.js +1 -1
- package/dist/generated/client/client/utils.gen.js +94 -243
- package/dist/generated/client/client.gen.js +1 -1
- package/dist/generated/client/core/auth.gen.js +14 -65
- package/dist/generated/client/core/bodySerializer.gen.d.ts +4 -4
- package/dist/generated/client/core/bodySerializer.gen.js +12 -32
- package/dist/generated/client/core/params.gen.js +58 -145
- package/dist/generated/client/core/pathSerializer.gen.js +34 -66
- package/dist/generated/client/core/queryKeySerializer.gen.d.ts +1 -1
- package/dist/generated/client/core/queryKeySerializer.gen.js +21 -63
- package/dist/generated/client/core/serverSentEvents.gen.d.ts +1 -1
- package/dist/generated/client/core/serverSentEvents.gen.js +129 -276
- package/dist/generated/client/core/types.gen.d.ts +1 -1
- package/dist/generated/client/core/types.gen.js +1 -1
- package/dist/generated/client/core/utils.gen.js +56 -80
- package/dist/generated/client/index.d.ts +2 -2
- package/dist/generated/client/index.js +6 -1
- package/dist/generated/client/sdk.gen.d.ts +181 -3
- package/dist/generated/client/sdk.gen.js +1330 -799
- package/dist/generated/client/types.gen.d.ts +711 -71
- package/dist/src/index.js +26 -60
- package/package.json +8 -14
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file is auto-generated based on the Examplary API schema.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.Users = exports.Taxonomies = exports.StudentLevels = exports.SourceMaterials = exports.Sessions = exports.QuestionTypes = exports.Questions = exports.QuestionBank = exports.Publishers = exports.PracticeSpaces = exports.Permissions = exports.Orgs = exports.Org = exports.Oauth = exports.Media = exports.Me = exports.Library = exports.Items2 = exports.Items = exports.Folders = exports.Export = exports.Exams = exports.Examplary = exports.Exam = exports.EmbedSessions = exports.ApiKeys = void 0;
|
|
4
|
+
exports.Users = exports.Taxonomies = exports.Students = exports.StudentLevels = exports.SourceMaterials = exports.Sessions2 = exports.Sessions = exports.QuestionTypes = exports.Questions = exports.QuestionBank = exports.Publishers = exports.PracticeSpaces = exports.Permissions = exports.Orgs = exports.Org = exports.Oauth = exports.Media = exports.Me = exports.Library = exports.Jobs = exports.Items2 = exports.Items = exports.Folders = exports.Export = exports.Exams = exports.Examplary = exports.Exam = exports.EmbedSessions = exports.CustomDomain = exports.Attributes = exports.ApiKeys = void 0;
|
|
5
5
|
var sdk_gen_1 = require("./sdk.gen");
|
|
6
6
|
Object.defineProperty(exports, "ApiKeys", { enumerable: true, get: function () { return sdk_gen_1.ApiKeys; } });
|
|
7
|
+
Object.defineProperty(exports, "Attributes", { enumerable: true, get: function () { return sdk_gen_1.Attributes; } });
|
|
8
|
+
Object.defineProperty(exports, "CustomDomain", { enumerable: true, get: function () { return sdk_gen_1.CustomDomain; } });
|
|
7
9
|
Object.defineProperty(exports, "EmbedSessions", { enumerable: true, get: function () { return sdk_gen_1.EmbedSessions; } });
|
|
8
10
|
Object.defineProperty(exports, "Exam", { enumerable: true, get: function () { return sdk_gen_1.Exam; } });
|
|
9
11
|
Object.defineProperty(exports, "Examplary", { enumerable: true, get: function () { return sdk_gen_1.Examplary; } });
|
|
@@ -12,6 +14,7 @@ Object.defineProperty(exports, "Export", { enumerable: true, get: function () {
|
|
|
12
14
|
Object.defineProperty(exports, "Folders", { enumerable: true, get: function () { return sdk_gen_1.Folders; } });
|
|
13
15
|
Object.defineProperty(exports, "Items", { enumerable: true, get: function () { return sdk_gen_1.Items; } });
|
|
14
16
|
Object.defineProperty(exports, "Items2", { enumerable: true, get: function () { return sdk_gen_1.Items2; } });
|
|
17
|
+
Object.defineProperty(exports, "Jobs", { enumerable: true, get: function () { return sdk_gen_1.Jobs; } });
|
|
15
18
|
Object.defineProperty(exports, "Library", { enumerable: true, get: function () { return sdk_gen_1.Library; } });
|
|
16
19
|
Object.defineProperty(exports, "Me", { enumerable: true, get: function () { return sdk_gen_1.Me; } });
|
|
17
20
|
Object.defineProperty(exports, "Media", { enumerable: true, get: function () { return sdk_gen_1.Media; } });
|
|
@@ -25,7 +28,9 @@ Object.defineProperty(exports, "QuestionBank", { enumerable: true, get: function
|
|
|
25
28
|
Object.defineProperty(exports, "Questions", { enumerable: true, get: function () { return sdk_gen_1.Questions; } });
|
|
26
29
|
Object.defineProperty(exports, "QuestionTypes", { enumerable: true, get: function () { return sdk_gen_1.QuestionTypes; } });
|
|
27
30
|
Object.defineProperty(exports, "Sessions", { enumerable: true, get: function () { return sdk_gen_1.Sessions; } });
|
|
31
|
+
Object.defineProperty(exports, "Sessions2", { enumerable: true, get: function () { return sdk_gen_1.Sessions2; } });
|
|
28
32
|
Object.defineProperty(exports, "SourceMaterials", { enumerable: true, get: function () { return sdk_gen_1.SourceMaterials; } });
|
|
29
33
|
Object.defineProperty(exports, "StudentLevels", { enumerable: true, get: function () { return sdk_gen_1.StudentLevels; } });
|
|
34
|
+
Object.defineProperty(exports, "Students", { enumerable: true, get: function () { return sdk_gen_1.Students; } });
|
|
30
35
|
Object.defineProperty(exports, "Taxonomies", { enumerable: true, get: function () { return sdk_gen_1.Taxonomies; } });
|
|
31
36
|
Object.defineProperty(exports, "Users", { enumerable: true, get: function () { return sdk_gen_1.Users; } });
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Client, Options as Options2, TDataShape } from './client';
|
|
2
|
-
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,
|
|
3
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
2
|
+
import type { DeleteAttributesByIdData, DeleteEmbedSessionsByIdData, DeleteExamsByIdData, DeleteExamsByIdSessionsBySessionIdData, DeleteFoldersByIdData, DeleteJobsByIdData, DeleteLibraryItemsByItemIdData, DeleteLibraryPublishersByPublisherIdData, DeleteOrgData, DeletePermissionsByResourceByActorData, DeletePermissionsByResourceByActorErrors, DeletePermissionsByResourceByActorResponses, DeletePracticeSpacesByIdData, DeleteQuestionBankByIdData, DeleteQuestionTypesByIdData, DeleteRubricsByIdData, DeleteSourceMaterialsByIdData, DeleteTaxonomiesByIdData, DeleteUsersByIdData, GetApiKeysData, GetAttributesData, GetEmbedSessionsByIdData, GetEmbedSessionsByIdResponses, GetExamsByIdContextSuggestionsData, GetExamsByIdData, GetExamsByIdQuestionsByQuestionIdData, GetExamsByIdSessionsBySessionIdData, GetExamsByIdSessionsData, GetExamsData, GetFoldersData, GetJobsByIdData, GetLibraryItemsFeaturedData, GetLibraryPublishersByPublisherIdItemsData, GetLibraryPublishersData, GetLibraryPublishersFeaturedData, GetLibraryPublishersMineData, GetMeData, GetMediaUploadData, GetMediaUploadResponses, GetOauthAuthorizeData, GetOrgCustomDomainData, GetOrgData, GetOrgsData, GetPermissionsByResourceByActorData, GetPermissionsByResourceByActorErrors, GetPermissionsByResourceByActorResponses, GetPermissionsByResourceData, GetPermissionsByResourceErrors, GetPermissionsByResourceResponses, GetPracticeSpacesByIdData, GetPracticeSpacesByIdProgressData, GetPracticeSpacesByIdQuestionsPreviewData, GetPracticeSpacesByIdSessionsBySessionIdData, GetPracticeSpacesByIdSessionsMineData, GetPracticeSpacesByIdStudentsByStudentIdData, GetPracticeSpacesByIdStudentsData, GetPracticeSpacesData, GetQuestionBankData, GetQuestionTypesByIdData, GetQuestionTypesByIdExportQti3PciData, GetQuestionTypesData, GetQuestionTypesPublicData, GetRubricsData, GetSourceMaterialsByIdData, GetSourceMaterialsByIdResponses, GetSourceMaterialsData, GetSourceMaterialsResponses, GetStudentLevelsData, GetTaxonomiesData, GetUsersData, PatchExamsByIdSessionsBySessionIdAnswersByQuestionIdData, PatchLibraryItemsByItemIdData, PatchLibraryPublishersByPublisherIdData, PatchMeData, PatchOrgData, PatchPracticeSpacesByIdData, PatchQuestionBankByIdData, PatchRubricsByIdData, PatchSourceMaterialsByIdData, PatchUsersByIdData, PostApiKeysResetData, PostAttributesByIdData, PostAttributesData, PostAttributesReorderData, 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, PostOrgCustomDomainData, PostOrgsData, PostPermissionsByResourceData, PostPermissionsByResourceErrors, PostPermissionsByResourceResponses, PostPracticeSpacesByIdCancelGenerateTopicsData, PostPracticeSpacesByIdDuplicateData, PostPracticeSpacesByIdGenerateTopicsData, PostPracticeSpacesByIdProgressTopicFeedbackData, PostPracticeSpacesByIdSessionsBySessionIdAnswersByQuestionIdData, PostPracticeSpacesByIdSessionsData, PostPracticeSpacesData, PostQuestionBankData, PostQuestionTypesByIdDisableData, PostQuestionTypesByIdEnableData, PostQuestionTypesData, PostRubricsData, PostRubricsGenerateData, PostSourceMaterialsByIdSliceData, PostSourceMaterialsByIdSliceResponses, PostSourceMaterialsData, PostSourceMaterialsResponses, PostTaxonomiesByIdData, PostTaxonomiesData, PostUsersData } from './types.gen';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
6
6
|
* individual options. This might be also useful if you want to implement a
|
|
@@ -211,6 +211,16 @@ export declare class Media extends HeyApiClient {
|
|
|
211
211
|
*/
|
|
212
212
|
upload<ThrowOnError extends boolean = false>(options?: Options<GetMediaUploadData, ThrowOnError>): import("./client").RequestResult<GetMediaUploadResponses, unknown, ThrowOnError>;
|
|
213
213
|
}
|
|
214
|
+
export declare class CustomDomain extends HeyApiClient {
|
|
215
|
+
/**
|
|
216
|
+
* Get custom domain configuration
|
|
217
|
+
*/
|
|
218
|
+
get<ThrowOnError extends boolean = false>(options?: Options<GetOrgCustomDomainData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
219
|
+
/**
|
|
220
|
+
* Update custom domain configuration
|
|
221
|
+
*/
|
|
222
|
+
update<ThrowOnError extends boolean = false>(options?: Options<PostOrgCustomDomainData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
223
|
+
}
|
|
214
224
|
export declare class Org extends HeyApiClient {
|
|
215
225
|
/**
|
|
216
226
|
* Delete organization
|
|
@@ -224,6 +234,8 @@ export declare class Org extends HeyApiClient {
|
|
|
224
234
|
* Update organization
|
|
225
235
|
*/
|
|
226
236
|
update<ThrowOnError extends boolean = false>(options?: Options<PatchOrgData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
237
|
+
private _customDomain?;
|
|
238
|
+
get customDomain(): CustomDomain;
|
|
227
239
|
}
|
|
228
240
|
export declare class Orgs extends HeyApiClient {
|
|
229
241
|
/**
|
|
@@ -251,6 +263,38 @@ export declare class ApiKeys extends HeyApiClient {
|
|
|
251
263
|
*/
|
|
252
264
|
reset<ThrowOnError extends boolean = false>(options?: Options<PostApiKeysResetData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
253
265
|
}
|
|
266
|
+
export declare class Attributes extends HeyApiClient {
|
|
267
|
+
/**
|
|
268
|
+
* List attributes
|
|
269
|
+
*
|
|
270
|
+
* Get all custom attributes configured for the current workspace.
|
|
271
|
+
*/
|
|
272
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetAttributesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
273
|
+
/**
|
|
274
|
+
* Create attribute
|
|
275
|
+
*
|
|
276
|
+
* Create a new custom attribute in the current workspace.
|
|
277
|
+
*/
|
|
278
|
+
create<ThrowOnError extends boolean = false>(options?: Options<PostAttributesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
279
|
+
/**
|
|
280
|
+
* Reorder attributes
|
|
281
|
+
*
|
|
282
|
+
* Update the position of multiple attributes at once.
|
|
283
|
+
*/
|
|
284
|
+
reorder<ThrowOnError extends boolean = false>(options?: Options<PostAttributesReorderData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
285
|
+
/**
|
|
286
|
+
* Delete attribute
|
|
287
|
+
*
|
|
288
|
+
* Delete a custom attribute from the current workspace. Default attributes cannot be deleted.
|
|
289
|
+
*/
|
|
290
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteAttributesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
291
|
+
/**
|
|
292
|
+
* Update attribute
|
|
293
|
+
*
|
|
294
|
+
* Update an existing attribute in the current workspace.
|
|
295
|
+
*/
|
|
296
|
+
update<ThrowOnError extends boolean = false>(options: Options<PostAttributesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
297
|
+
}
|
|
254
298
|
export declare class Taxonomies extends HeyApiClient {
|
|
255
299
|
/**
|
|
256
300
|
* Get taxonomies
|
|
@@ -398,6 +442,12 @@ export declare class Sessions extends HeyApiClient {
|
|
|
398
442
|
* Accept a single AI-generated grading suggestion for the exam session.
|
|
399
443
|
*/
|
|
400
444
|
acceptSuggestion<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdSuggestionsByQuestionIdAcceptData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
445
|
+
/**
|
|
446
|
+
* Edit answer
|
|
447
|
+
*
|
|
448
|
+
* Edit a single answer in an exam session.
|
|
449
|
+
*/
|
|
450
|
+
editAnswer<ThrowOnError extends boolean = false>(options: Options<PatchExamsByIdSessionsBySessionIdAnswersByQuestionIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
401
451
|
}
|
|
402
452
|
export declare class Questions extends HeyApiClient {
|
|
403
453
|
/**
|
|
@@ -412,6 +462,12 @@ export declare class Questions extends HeyApiClient {
|
|
|
412
462
|
* Generate a new question for the exam using an AI prompt.
|
|
413
463
|
*/
|
|
414
464
|
generate<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdQuestionsGenerateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
465
|
+
/**
|
|
466
|
+
* Get question
|
|
467
|
+
*
|
|
468
|
+
* Retrieve a question by its ID.
|
|
469
|
+
*/
|
|
470
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdQuestionsByQuestionIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
415
471
|
/**
|
|
416
472
|
* Regenerate question
|
|
417
473
|
*
|
|
@@ -509,6 +565,46 @@ export declare class Exams extends HeyApiClient {
|
|
|
509
565
|
*/
|
|
510
566
|
getContextSuggestions<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdContextSuggestionsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
511
567
|
}
|
|
568
|
+
export declare class Students extends HeyApiClient {
|
|
569
|
+
/**
|
|
570
|
+
* List practice space students
|
|
571
|
+
*
|
|
572
|
+
* Get a list of all students that practiced in a practice space.
|
|
573
|
+
*/
|
|
574
|
+
list<ThrowOnError extends boolean = false>(options: Options<GetPracticeSpacesByIdStudentsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
575
|
+
/**
|
|
576
|
+
* Get practice space student
|
|
577
|
+
*
|
|
578
|
+
* Get details about a specific practice space student.
|
|
579
|
+
*/
|
|
580
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetPracticeSpacesByIdStudentsByStudentIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
581
|
+
}
|
|
582
|
+
export declare class Sessions2 extends HeyApiClient {
|
|
583
|
+
/**
|
|
584
|
+
* Create practice space session
|
|
585
|
+
*
|
|
586
|
+
* Create a new practice space session.
|
|
587
|
+
*/
|
|
588
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostPracticeSpacesByIdSessionsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
589
|
+
/**
|
|
590
|
+
* Get my practice space session
|
|
591
|
+
*
|
|
592
|
+
* Get the current user's past practice space session.
|
|
593
|
+
*/
|
|
594
|
+
getMine<ThrowOnError extends boolean = false>(options: Options<GetPracticeSpacesByIdSessionsMineData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
595
|
+
/**
|
|
596
|
+
* Get practice space session
|
|
597
|
+
*
|
|
598
|
+
* Get a practice space session by its ID.
|
|
599
|
+
*/
|
|
600
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetPracticeSpacesByIdSessionsBySessionIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
601
|
+
/**
|
|
602
|
+
* Save answer for a practice space session
|
|
603
|
+
*
|
|
604
|
+
* Save an answer for a specific question in a practice space session.
|
|
605
|
+
*/
|
|
606
|
+
saveAnswer<ThrowOnError extends boolean = false>(options: Options<PostPracticeSpacesByIdSessionsBySessionIdAnswersByQuestionIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
607
|
+
}
|
|
512
608
|
export declare class PracticeSpaces extends HeyApiClient {
|
|
513
609
|
/**
|
|
514
610
|
* List practice spaces
|
|
@@ -539,13 +635,47 @@ export declare class PracticeSpaces extends HeyApiClient {
|
|
|
539
635
|
*
|
|
540
636
|
* Update an existing practice space.
|
|
541
637
|
*/
|
|
542
|
-
update<ThrowOnError extends boolean = false>(options: Options<
|
|
638
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchPracticeSpacesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
639
|
+
/**
|
|
640
|
+
* Duplicate practice space
|
|
641
|
+
*
|
|
642
|
+
* Duplicate the practice space's settings and topics to a new practice space.
|
|
643
|
+
*/
|
|
644
|
+
duplicate<ThrowOnError extends boolean = false>(options: Options<PostPracticeSpacesByIdDuplicateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
645
|
+
/**
|
|
646
|
+
* Generate practice space topics
|
|
647
|
+
*
|
|
648
|
+
* Start generating mastery topics for a practice space.
|
|
649
|
+
*/
|
|
650
|
+
generateTopics<ThrowOnError extends boolean = false>(options: Options<PostPracticeSpacesByIdGenerateTopicsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
651
|
+
/**
|
|
652
|
+
* Cancel practice space topic generation
|
|
653
|
+
*
|
|
654
|
+
* Cancel an in-progress mastery topic generation job.
|
|
655
|
+
*/
|
|
656
|
+
cancelGenerateTopics<ThrowOnError extends boolean = false>(options: Options<PostPracticeSpacesByIdCancelGenerateTopicsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
543
657
|
/**
|
|
544
658
|
* Preview top practice space questions
|
|
545
659
|
*
|
|
546
660
|
* Get a preview of the top practice space questions by quality score.
|
|
547
661
|
*/
|
|
548
662
|
questionsPreview<ThrowOnError extends boolean = false>(options: Options<GetPracticeSpacesByIdQuestionsPreviewData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
663
|
+
/**
|
|
664
|
+
* Get practice space progress
|
|
665
|
+
*
|
|
666
|
+
* Get the progress of a single practice space by its ID.
|
|
667
|
+
*/
|
|
668
|
+
getProgress<ThrowOnError extends boolean = false>(options: Options<GetPracticeSpacesByIdProgressData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
669
|
+
/**
|
|
670
|
+
* Generate practice space topic feedback
|
|
671
|
+
*
|
|
672
|
+
* Get feedback for a specific topic in a practice space.
|
|
673
|
+
*/
|
|
674
|
+
generateTopicFeedback<ThrowOnError extends boolean = false>(options: Options<PostPracticeSpacesByIdProgressTopicFeedbackData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
675
|
+
private _students?;
|
|
676
|
+
get students(): Students;
|
|
677
|
+
private _sessions?;
|
|
678
|
+
get sessions(): Sessions2;
|
|
549
679
|
}
|
|
550
680
|
export declare class SourceMaterials extends HeyApiClient {
|
|
551
681
|
/**
|
|
@@ -637,12 +767,56 @@ export declare class QuestionBank extends HeyApiClient {
|
|
|
637
767
|
*/
|
|
638
768
|
update<ThrowOnError extends boolean = false>(options: Options<PatchQuestionBankByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
639
769
|
}
|
|
770
|
+
export declare class Jobs extends HeyApiClient {
|
|
771
|
+
/**
|
|
772
|
+
* Cancel a job
|
|
773
|
+
*
|
|
774
|
+
* Cancel a background job.
|
|
775
|
+
*/
|
|
776
|
+
cancel<ThrowOnError extends boolean = false>(options: Options<DeleteJobsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
777
|
+
/**
|
|
778
|
+
* Get job status
|
|
779
|
+
*
|
|
780
|
+
* Poll the status of a background job.
|
|
781
|
+
*/
|
|
782
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetJobsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
783
|
+
}
|
|
640
784
|
export declare class Examplary extends HeyApiClient {
|
|
641
785
|
static readonly __registry: HeyApiRegistry<Examplary>;
|
|
642
786
|
constructor(args?: {
|
|
643
787
|
client?: Client;
|
|
644
788
|
key?: string;
|
|
645
789
|
});
|
|
790
|
+
/**
|
|
791
|
+
* Get rubrics
|
|
792
|
+
*
|
|
793
|
+
* Get a list of rubrics that exist within the current workspace.
|
|
794
|
+
*/
|
|
795
|
+
getRubrics<ThrowOnError extends boolean = false>(options?: Options<GetRubricsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
796
|
+
/**
|
|
797
|
+
* Save rubric
|
|
798
|
+
*
|
|
799
|
+
* Add a rubric to the current workspace.
|
|
800
|
+
*/
|
|
801
|
+
postRubrics<ThrowOnError extends boolean = false>(options?: Options<PostRubricsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
802
|
+
/**
|
|
803
|
+
* Generate rubric
|
|
804
|
+
*
|
|
805
|
+
* Start a background job to generate a rubric using AI.
|
|
806
|
+
*/
|
|
807
|
+
postRubricsGenerate<ThrowOnError extends boolean = false>(options?: Options<PostRubricsGenerateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
808
|
+
/**
|
|
809
|
+
* Delete rubric
|
|
810
|
+
*
|
|
811
|
+
* Delete a rubric from the current workspace.
|
|
812
|
+
*/
|
|
813
|
+
deleteRubricsId<ThrowOnError extends boolean = false>(options: Options<DeleteRubricsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
814
|
+
/**
|
|
815
|
+
* Update rubric
|
|
816
|
+
*
|
|
817
|
+
* Update an existing rubric in the current workspace.
|
|
818
|
+
*/
|
|
819
|
+
patchRubricsId<ThrowOnError extends boolean = false>(options: Options<PatchRubricsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
646
820
|
private _questionTypes?;
|
|
647
821
|
get questionTypes(): QuestionTypes;
|
|
648
822
|
private _library?;
|
|
@@ -661,6 +835,8 @@ export declare class Examplary extends HeyApiClient {
|
|
|
661
835
|
get orgs(): Orgs;
|
|
662
836
|
private _apiKeys?;
|
|
663
837
|
get apiKeys(): ApiKeys;
|
|
838
|
+
private _attributes?;
|
|
839
|
+
get attributes(): Attributes;
|
|
664
840
|
private _taxonomies?;
|
|
665
841
|
get taxonomies(): Taxonomies;
|
|
666
842
|
private _permissions?;
|
|
@@ -681,5 +857,7 @@ export declare class Examplary extends HeyApiClient {
|
|
|
681
857
|
get folders(): Folders;
|
|
682
858
|
private _questionBank?;
|
|
683
859
|
get questionBank(): QuestionBank;
|
|
860
|
+
private _jobs?;
|
|
861
|
+
get jobs(): Jobs;
|
|
684
862
|
}
|
|
685
863
|
export {};
|