@examplary/sdk 1.0.0 → 1.0.3
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 +31 -1
- package/dist/generated/client/sdk.gen.d.ts +394 -116
- package/dist/generated/client/sdk.gen.js +1373 -442
- package/dist/generated/client/types.gen.d.ts +711 -71
- package/dist/src/index.js +26 -60
- package/package.json +8 -14
|
@@ -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
|
|
@@ -25,561 +25,839 @@ declare class HeyApiRegistry<T> {
|
|
|
25
25
|
get(key?: string): T;
|
|
26
26
|
set(value: T, key?: string): void;
|
|
27
27
|
}
|
|
28
|
-
export declare class
|
|
29
|
-
static readonly __registry: HeyApiRegistry<Examplary>;
|
|
30
|
-
constructor(args?: {
|
|
31
|
-
client?: Client;
|
|
32
|
-
key?: string;
|
|
33
|
-
});
|
|
28
|
+
export declare class QuestionTypes extends HeyApiClient {
|
|
34
29
|
/**
|
|
35
30
|
* List public question types
|
|
36
31
|
*
|
|
37
32
|
* Lists all public question types, which can be enabled in workspaces.
|
|
38
33
|
*/
|
|
39
|
-
|
|
34
|
+
listPublic<ThrowOnError extends boolean = false>(options?: Options<GetQuestionTypesPublicData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
40
35
|
/**
|
|
41
36
|
* Delete question type
|
|
42
37
|
*
|
|
43
38
|
* 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.
|
|
44
39
|
*/
|
|
45
|
-
|
|
40
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteQuestionTypesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
46
41
|
/**
|
|
47
42
|
* Get question type
|
|
48
43
|
*
|
|
49
44
|
* Retrieves a specific question type by its ID.
|
|
50
45
|
*/
|
|
51
|
-
|
|
46
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetQuestionTypesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
52
47
|
/**
|
|
53
48
|
* Get question type PCI module for QTI 3 export
|
|
54
49
|
*
|
|
55
50
|
* Get JS module for a question type PCI for QTI 3 export.
|
|
56
51
|
*/
|
|
57
|
-
|
|
52
|
+
getQti3Pci<ThrowOnError extends boolean = false>(options: Options<GetQuestionTypesByIdExportQti3PciData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
58
53
|
/**
|
|
59
54
|
* List question types
|
|
60
55
|
*
|
|
61
56
|
* Lists all question types, either those available by default or those created within the user's organization.
|
|
62
57
|
*/
|
|
63
|
-
|
|
58
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetQuestionTypesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
64
59
|
/**
|
|
65
60
|
* Upsert question type
|
|
66
61
|
*
|
|
67
62
|
* 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.
|
|
68
63
|
*/
|
|
69
|
-
|
|
64
|
+
upsert<ThrowOnError extends boolean = false>(options?: Options<PostQuestionTypesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
70
65
|
/**
|
|
71
66
|
* Enable question type
|
|
72
67
|
*
|
|
73
68
|
* Enable a question type for the current workspace.
|
|
74
69
|
*/
|
|
75
|
-
|
|
70
|
+
enable<ThrowOnError extends boolean = false>(options: Options<PostQuestionTypesByIdEnableData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
76
71
|
/**
|
|
77
72
|
* Disable question type
|
|
78
73
|
*
|
|
79
74
|
* Disable a question type for the current workspace.
|
|
80
75
|
*/
|
|
81
|
-
|
|
76
|
+
disable<ThrowOnError extends boolean = false>(options: Options<PostQuestionTypesByIdDisableData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
77
|
+
}
|
|
78
|
+
export declare class Items extends HeyApiClient {
|
|
82
79
|
/**
|
|
83
80
|
* List items by publisher
|
|
84
81
|
*
|
|
85
82
|
* Lists all library items for the specified publisher profile.
|
|
86
83
|
*/
|
|
87
|
-
|
|
84
|
+
list<ThrowOnError extends boolean = false>(options: Options<GetLibraryPublishersByPublisherIdItemsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
88
85
|
/**
|
|
89
86
|
* Create library item
|
|
90
87
|
*
|
|
91
88
|
* Adds an item to the library. Only the publisher owner can add items to their publisher profile.
|
|
92
89
|
*/
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
*
|
|
97
|
-
* Lists all library items that are marked as featured.
|
|
98
|
-
*/
|
|
99
|
-
getLibraryItemsFeatured<ThrowOnError extends boolean = false>(options?: Options<GetLibraryItemsFeaturedData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
100
|
-
/**
|
|
101
|
-
* Delete library item
|
|
102
|
-
*
|
|
103
|
-
* Deletes a library item. Only the publisher owner can delete items from their publisher profile.
|
|
104
|
-
*/
|
|
105
|
-
deleteLibraryItemsItemId<ThrowOnError extends boolean = false>(options: Options<DeleteLibraryItemsByItemIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
106
|
-
/**
|
|
107
|
-
* Update library item
|
|
108
|
-
*
|
|
109
|
-
* Updates a library item. Only the publisher owner can update items in their publisher profile.
|
|
110
|
-
*/
|
|
111
|
-
patchLibraryItemsItemId<ThrowOnError extends boolean = false>(options: Options<PatchLibraryItemsByItemIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
90
|
+
create<ThrowOnError extends boolean = false>(options: Options<PostLibraryPublishersByPublisherIdItemsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
91
|
+
}
|
|
92
|
+
export declare class Publishers extends HeyApiClient {
|
|
112
93
|
/**
|
|
113
94
|
* List featured publishers
|
|
114
95
|
*
|
|
115
96
|
* Lists all library publishers that are marked as featured.
|
|
116
97
|
*/
|
|
117
|
-
|
|
98
|
+
listFeatured<ThrowOnError extends boolean = false>(options?: Options<GetLibraryPublishersFeaturedData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
118
99
|
/**
|
|
119
100
|
* List all publishers
|
|
120
101
|
*
|
|
121
102
|
* Lists all library publisher profiles.
|
|
122
103
|
*/
|
|
123
|
-
|
|
104
|
+
listAll<ThrowOnError extends boolean = false>(options?: Options<GetLibraryPublishersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
124
105
|
/**
|
|
125
106
|
* Create publisher
|
|
126
107
|
*
|
|
127
108
|
* Creates a new library publisher profile.
|
|
128
109
|
*/
|
|
129
|
-
|
|
110
|
+
create<ThrowOnError extends boolean = false>(options?: Options<PostLibraryPublishersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
130
111
|
/**
|
|
131
112
|
* List my publishers
|
|
132
113
|
*
|
|
133
114
|
* Lists all library publisher profiles created by the authenticated user.
|
|
134
115
|
*/
|
|
135
|
-
|
|
116
|
+
listMine<ThrowOnError extends boolean = false>(options?: Options<GetLibraryPublishersMineData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
136
117
|
/**
|
|
137
118
|
* Delete publisher
|
|
138
119
|
*
|
|
139
120
|
* Deletes a library publisher profile. Only the owner can delete their publisher profile.
|
|
140
121
|
*/
|
|
141
|
-
|
|
122
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteLibraryPublishersByPublisherIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
142
123
|
/**
|
|
143
124
|
* Update publisher
|
|
144
125
|
*
|
|
145
126
|
* Updates a library publisher profile. Only the owner can update their publisher profile.
|
|
146
127
|
*/
|
|
147
|
-
|
|
128
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchLibraryPublishersByPublisherIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
129
|
+
private _items?;
|
|
130
|
+
get items(): Items;
|
|
131
|
+
}
|
|
132
|
+
export declare class Items2 extends HeyApiClient {
|
|
133
|
+
/**
|
|
134
|
+
* List featured library items
|
|
135
|
+
*
|
|
136
|
+
* Lists all library items that are marked as featured.
|
|
137
|
+
*/
|
|
138
|
+
listFeatured<ThrowOnError extends boolean = false>(options?: Options<GetLibraryItemsFeaturedData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
139
|
+
/**
|
|
140
|
+
* Delete library item
|
|
141
|
+
*
|
|
142
|
+
* Deletes a library item. Only the publisher owner can delete items from their publisher profile.
|
|
143
|
+
*/
|
|
144
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteLibraryItemsByItemIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
145
|
+
/**
|
|
146
|
+
* Update library item
|
|
147
|
+
*
|
|
148
|
+
* Updates a library item. Only the publisher owner can update items in their publisher profile.
|
|
149
|
+
*/
|
|
150
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchLibraryItemsByItemIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
151
|
+
}
|
|
152
|
+
export declare class Library extends HeyApiClient {
|
|
153
|
+
private _publishers?;
|
|
154
|
+
get publishers(): Publishers;
|
|
155
|
+
private _items?;
|
|
156
|
+
get items(): Items2;
|
|
157
|
+
}
|
|
158
|
+
export declare class Oauth extends HeyApiClient {
|
|
148
159
|
/**
|
|
149
160
|
* OAuth authorization endpoint
|
|
150
161
|
*
|
|
151
162
|
* Initiates OAuth authorization flow. Redirects to the frontend authorization UI where users can approve or deny access.
|
|
152
163
|
*/
|
|
153
|
-
|
|
164
|
+
authorize<ThrowOnError extends boolean = false>(options: Options<GetOauthAuthorizeData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
154
165
|
/**
|
|
155
166
|
* OAuth token endpoint
|
|
156
167
|
*
|
|
157
168
|
* Exchange authorization code for access token, or refresh an existing token.
|
|
158
169
|
*/
|
|
159
|
-
|
|
170
|
+
token<ThrowOnError extends boolean = false>(options?: Options<PostOauthTokenData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
171
|
+
}
|
|
172
|
+
export declare class EmbedSessions extends HeyApiClient {
|
|
160
173
|
/**
|
|
161
174
|
* Create embed session
|
|
162
175
|
*
|
|
163
176
|
* Create a new embed session. This allows you to embed the exam generation flow into your own application.
|
|
164
177
|
*/
|
|
165
|
-
|
|
178
|
+
create<ThrowOnError extends boolean = false>(options?: Options<PostEmbedSessionsData, ThrowOnError>): import("./client").RequestResult<PostEmbedSessionsResponses, unknown, ThrowOnError>;
|
|
166
179
|
/**
|
|
167
180
|
* Revoke embed session
|
|
168
181
|
*
|
|
169
182
|
* Revoke access to an embed session by its ID.
|
|
170
183
|
*/
|
|
171
|
-
|
|
184
|
+
revoke<ThrowOnError extends boolean = false>(options: Options<DeleteEmbedSessionsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
172
185
|
/**
|
|
173
186
|
* Get embed session
|
|
174
187
|
*
|
|
175
188
|
* Retrieve an embed session by its ID.
|
|
176
189
|
*/
|
|
177
|
-
|
|
190
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetEmbedSessionsByIdData, ThrowOnError>): import("./client").RequestResult<GetEmbedSessionsByIdResponses, unknown, ThrowOnError>;
|
|
191
|
+
}
|
|
192
|
+
export declare class Me extends HeyApiClient {
|
|
178
193
|
/**
|
|
179
194
|
* Get me
|
|
180
195
|
*
|
|
181
196
|
* Get the current user's account details.
|
|
182
197
|
*/
|
|
183
|
-
|
|
198
|
+
get<ThrowOnError extends boolean = false>(options?: Options<GetMeData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
184
199
|
/**
|
|
185
200
|
* Update me
|
|
186
201
|
*
|
|
187
202
|
* Update the current user's account details.
|
|
188
203
|
*/
|
|
189
|
-
|
|
204
|
+
update<ThrowOnError extends boolean = false>(options?: Options<PatchMeData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
205
|
+
}
|
|
206
|
+
export declare class Media extends HeyApiClient {
|
|
190
207
|
/**
|
|
191
208
|
* Get file upload URL
|
|
192
209
|
*
|
|
193
210
|
* Returns a signed URL for uploading a file, and a public URL for accessing it afterwards.
|
|
194
211
|
*/
|
|
195
|
-
|
|
212
|
+
upload<ThrowOnError extends boolean = false>(options?: Options<GetMediaUploadData, ThrowOnError>): import("./client").RequestResult<GetMediaUploadResponses, unknown, ThrowOnError>;
|
|
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
|
+
}
|
|
224
|
+
export declare class Org extends HeyApiClient {
|
|
196
225
|
/**
|
|
197
226
|
* Delete organization
|
|
198
227
|
*/
|
|
199
|
-
|
|
228
|
+
delete<ThrowOnError extends boolean = false>(options?: Options<DeleteOrgData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
200
229
|
/**
|
|
201
230
|
* Get organization
|
|
202
231
|
*/
|
|
203
|
-
|
|
232
|
+
get<ThrowOnError extends boolean = false>(options?: Options<GetOrgData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
204
233
|
/**
|
|
205
234
|
* Update organization
|
|
206
235
|
*/
|
|
207
|
-
|
|
236
|
+
update<ThrowOnError extends boolean = false>(options?: Options<PatchOrgData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
237
|
+
private _customDomain?;
|
|
238
|
+
get customDomain(): CustomDomain;
|
|
239
|
+
}
|
|
240
|
+
export declare class Orgs extends HeyApiClient {
|
|
208
241
|
/**
|
|
209
242
|
* List all organizations
|
|
210
243
|
*/
|
|
211
|
-
|
|
244
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetOrgsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
212
245
|
/**
|
|
213
246
|
* Create a new organization
|
|
214
247
|
*
|
|
215
248
|
* Create a new workspace to collaborate with others on exams.
|
|
216
249
|
*/
|
|
217
|
-
|
|
250
|
+
create<ThrowOnError extends boolean = false>(options?: Options<PostOrgsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
251
|
+
}
|
|
252
|
+
export declare class ApiKeys extends HeyApiClient {
|
|
218
253
|
/**
|
|
219
254
|
* Get API key
|
|
220
255
|
*
|
|
221
256
|
* Get the API key for the current org/user combination. Creates one if none exists.
|
|
222
257
|
*/
|
|
223
|
-
|
|
258
|
+
get<ThrowOnError extends boolean = false>(options?: Options<GetApiKeysData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
224
259
|
/**
|
|
225
260
|
* Reset API key
|
|
226
261
|
*
|
|
227
262
|
* Invalidate old API keys for this org/user and create a new one.
|
|
228
263
|
*/
|
|
229
|
-
|
|
264
|
+
reset<ThrowOnError extends boolean = false>(options?: Options<PostApiKeysResetData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
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
|
+
}
|
|
298
|
+
export declare class Taxonomies extends HeyApiClient {
|
|
230
299
|
/**
|
|
231
300
|
* Get taxonomies
|
|
232
301
|
*
|
|
233
302
|
* Get a list available taxonomies, including defaults and taxonomies created in the current workspace.
|
|
234
303
|
*/
|
|
235
|
-
|
|
304
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetTaxonomiesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
236
305
|
/**
|
|
237
306
|
* Create taxonomy
|
|
238
307
|
*
|
|
239
308
|
* Save a new taxonomy in the current workspace.
|
|
240
309
|
*/
|
|
241
|
-
|
|
310
|
+
create<ThrowOnError extends boolean = false>(options?: Options<PostTaxonomiesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
242
311
|
/**
|
|
243
312
|
* Delete taxonomy
|
|
244
313
|
*
|
|
245
314
|
* Delete a taxonomy from the current workspace. This fails if there are any exams associated with the taxonomy.
|
|
246
315
|
*/
|
|
247
|
-
|
|
316
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteTaxonomiesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
248
317
|
/**
|
|
249
318
|
* Update taxonomy
|
|
250
319
|
*
|
|
251
320
|
* Update an existing taxonomy in the current workspace.
|
|
252
321
|
*/
|
|
253
|
-
|
|
322
|
+
update<ThrowOnError extends boolean = false>(options: Options<PostTaxonomiesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
323
|
+
}
|
|
324
|
+
export declare class Permissions extends HeyApiClient {
|
|
254
325
|
/**
|
|
255
326
|
* Get sharing permissions
|
|
256
327
|
*
|
|
257
328
|
* Get a list of users, groups and orgs that have access to a specific resource.
|
|
258
329
|
*/
|
|
259
|
-
|
|
330
|
+
list<ThrowOnError extends boolean = false>(options: Options<GetPermissionsByResourceData, ThrowOnError>): import("./client").RequestResult<GetPermissionsByResourceResponses, GetPermissionsByResourceErrors, ThrowOnError>;
|
|
260
331
|
/**
|
|
261
332
|
* Create permission
|
|
262
333
|
*
|
|
263
334
|
* Create a new permission for a specific resource, or update the role of an existing actor.
|
|
264
335
|
*/
|
|
265
|
-
|
|
336
|
+
assign<ThrowOnError extends boolean = false>(options: Options<PostPermissionsByResourceData, ThrowOnError>): import("./client").RequestResult<PostPermissionsByResourceResponses, PostPermissionsByResourceErrors, ThrowOnError>;
|
|
266
337
|
/**
|
|
267
338
|
* Remove permission
|
|
268
339
|
*
|
|
269
340
|
* Remove a permission for a specific actor on a specific resource.
|
|
270
341
|
*/
|
|
271
|
-
|
|
342
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeletePermissionsByResourceByActorData, ThrowOnError>): import("./client").RequestResult<DeletePermissionsByResourceByActorResponses, DeletePermissionsByResourceByActorErrors, ThrowOnError>;
|
|
272
343
|
/**
|
|
273
344
|
* Get actor role
|
|
274
345
|
*
|
|
275
346
|
* Get the role of a specific actor for a specific resource.
|
|
276
347
|
*/
|
|
277
|
-
|
|
348
|
+
getActorRole<ThrowOnError extends boolean = false>(options: Options<GetPermissionsByResourceByActorData, ThrowOnError>): import("./client").RequestResult<GetPermissionsByResourceByActorResponses, GetPermissionsByResourceByActorErrors, ThrowOnError>;
|
|
349
|
+
}
|
|
350
|
+
export declare class StudentLevels extends HeyApiClient {
|
|
278
351
|
/**
|
|
279
352
|
* List available student levels
|
|
280
353
|
*
|
|
281
354
|
* Get a list of available default student levels.
|
|
282
355
|
*/
|
|
283
|
-
|
|
356
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetStudentLevelsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
357
|
+
}
|
|
358
|
+
export declare class Users extends HeyApiClient {
|
|
284
359
|
/**
|
|
285
360
|
* List users
|
|
286
361
|
*
|
|
287
362
|
* Get a list of all users in the workspace.
|
|
288
363
|
*/
|
|
289
|
-
|
|
364
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetUsersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
290
365
|
/**
|
|
291
366
|
* Create user
|
|
292
367
|
*
|
|
293
368
|
* Create a new user in the workspace.
|
|
294
369
|
*/
|
|
295
|
-
|
|
370
|
+
create<ThrowOnError extends boolean = false>(options?: Options<PostUsersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
296
371
|
/**
|
|
297
372
|
* Delete user
|
|
298
373
|
*
|
|
299
374
|
* Delete a user from the workspace.
|
|
300
375
|
*/
|
|
301
|
-
|
|
376
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteUsersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
302
377
|
/**
|
|
303
378
|
* Update user role
|
|
304
379
|
*
|
|
305
380
|
* Update a user's role within the workspace.
|
|
306
381
|
*/
|
|
307
|
-
|
|
382
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchUsersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
383
|
+
}
|
|
384
|
+
export declare class Sessions extends HeyApiClient {
|
|
308
385
|
/**
|
|
309
386
|
* List exam sessions
|
|
310
387
|
*
|
|
311
388
|
* Get a list of all student sessions for an exam, representing a set of answers from a student.
|
|
312
389
|
*/
|
|
313
|
-
|
|
390
|
+
list<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdSessionsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
314
391
|
/**
|
|
315
392
|
* Create session
|
|
316
393
|
*
|
|
317
394
|
* Manually create a session, possibly from uploaded data.
|
|
318
395
|
*/
|
|
319
|
-
|
|
396
|
+
import<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
320
397
|
/**
|
|
321
398
|
* Get answers from scan
|
|
322
399
|
*
|
|
323
400
|
* Scan student answers from a document.
|
|
324
401
|
*/
|
|
325
|
-
|
|
402
|
+
scan<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsScanData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
326
403
|
/**
|
|
327
404
|
* Delete exam session
|
|
328
405
|
*
|
|
329
406
|
* Remove an exam session.
|
|
330
407
|
*/
|
|
331
|
-
|
|
408
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteExamsByIdSessionsBySessionIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
332
409
|
/**
|
|
333
410
|
* Get exam session
|
|
334
411
|
*
|
|
335
412
|
* Get a single exam session by its ID, representing a set of answers from a student.
|
|
336
413
|
*/
|
|
337
|
-
|
|
414
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdSessionsBySessionIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
338
415
|
/**
|
|
339
416
|
* Provide feedback
|
|
340
417
|
*
|
|
341
418
|
* Set teacher feedback and/or a grade for a specific question in an exam session.
|
|
342
419
|
*/
|
|
343
|
-
|
|
420
|
+
saveFeedback<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdFeedbackData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
344
421
|
/**
|
|
345
422
|
* Provide overall feedback
|
|
346
423
|
*
|
|
347
424
|
* Set teacher feedback for the test as a whole in an exam session.
|
|
348
425
|
*/
|
|
349
|
-
|
|
426
|
+
saveOverallFeedback<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdOverallFeedbackData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
350
427
|
/**
|
|
351
428
|
* Generate overall feedback
|
|
352
429
|
*
|
|
353
430
|
* Generate feedback for the test as a whole in an exam session.
|
|
354
431
|
*/
|
|
355
|
-
|
|
432
|
+
generateOverallFeedback<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdGenerateOverallFeedbackData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
356
433
|
/**
|
|
357
434
|
* Accept AI grading suggestions
|
|
358
435
|
*
|
|
359
436
|
* Accept all AI-generated grading suggestions for the exam session.
|
|
360
437
|
*/
|
|
361
|
-
|
|
438
|
+
acceptAllSuggestions<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdSuggestionsAcceptAllData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
362
439
|
/**
|
|
363
440
|
* Accept single AI grading suggestion
|
|
364
441
|
*
|
|
365
442
|
* Accept a single AI-generated grading suggestion for the exam session.
|
|
366
443
|
*/
|
|
367
|
-
|
|
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>;
|
|
451
|
+
}
|
|
452
|
+
export declare class Questions extends HeyApiClient {
|
|
368
453
|
/**
|
|
369
454
|
* Import questions
|
|
370
455
|
*
|
|
371
456
|
* Import questions into an exam from a file. Support Word, PDF, Moodle quiz XML and plain text files.
|
|
372
457
|
*/
|
|
373
|
-
|
|
458
|
+
import<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdQuestionsImportData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
374
459
|
/**
|
|
375
460
|
* Generate question
|
|
376
461
|
*
|
|
377
462
|
* Generate a new question for the exam using an AI prompt.
|
|
378
463
|
*/
|
|
379
|
-
|
|
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>;
|
|
380
471
|
/**
|
|
381
472
|
* Regenerate question
|
|
382
473
|
*
|
|
383
474
|
* Update a question using an AI prompt.
|
|
384
475
|
*/
|
|
385
|
-
|
|
476
|
+
regenerate<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdQuestionsByQuestionIdGenerateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
477
|
+
}
|
|
478
|
+
export declare class Export extends HeyApiClient {
|
|
386
479
|
/**
|
|
387
480
|
* Export QTI 3 package
|
|
388
481
|
*
|
|
389
482
|
* Export an exam as a QTI 3 ZIP package.
|
|
390
483
|
*/
|
|
391
|
-
|
|
484
|
+
qti3Zip<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdExportQti3ZipData, ThrowOnError>): import("./client").RequestResult<PostExamsByIdExportQti3ZipResponses, unknown, ThrowOnError>;
|
|
392
485
|
/**
|
|
393
486
|
* Export QTI 2.1 package
|
|
394
487
|
*
|
|
395
488
|
* Export an exam as a QTI 2.1 ZIP package.
|
|
396
489
|
*/
|
|
397
|
-
|
|
490
|
+
qti21Zip<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdExportQti21ZipData, ThrowOnError>): import("./client").RequestResult<PostExamsByIdExportQti21ZipResponses, unknown, ThrowOnError>;
|
|
491
|
+
}
|
|
492
|
+
export declare class Exam extends HeyApiClient {
|
|
493
|
+
private _sessions?;
|
|
494
|
+
get sessions(): Sessions;
|
|
495
|
+
private _questions?;
|
|
496
|
+
get questions(): Questions;
|
|
497
|
+
private _export?;
|
|
498
|
+
get export(): Export;
|
|
499
|
+
}
|
|
500
|
+
export declare class Exams extends HeyApiClient {
|
|
398
501
|
/**
|
|
399
502
|
* List exams
|
|
400
503
|
*
|
|
401
504
|
* Get a list of all exams within your workspace.
|
|
402
505
|
*/
|
|
403
|
-
|
|
506
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetExamsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
404
507
|
/**
|
|
405
508
|
* Create exam
|
|
406
509
|
*
|
|
407
510
|
* Create a new exam within your workspace.
|
|
408
511
|
*/
|
|
409
|
-
|
|
512
|
+
create<ThrowOnError extends boolean = false>(options?: Options<PostExamsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
410
513
|
/**
|
|
411
514
|
* Import exam
|
|
412
515
|
*
|
|
413
516
|
* Create an exam by importing one or more source materials (e.g. an existing exam).
|
|
414
517
|
*/
|
|
415
|
-
|
|
518
|
+
import<ThrowOnError extends boolean = false>(options?: Options<PostExamsImportData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
416
519
|
/**
|
|
417
520
|
* Delete exam
|
|
418
521
|
*
|
|
419
522
|
* Delete the exam.
|
|
420
523
|
*/
|
|
421
|
-
|
|
524
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteExamsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
422
525
|
/**
|
|
423
526
|
* Get exam
|
|
424
527
|
*
|
|
425
528
|
* Get a single exam by its ID.
|
|
426
529
|
*/
|
|
427
|
-
|
|
530
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
428
531
|
/**
|
|
429
532
|
* Update exam
|
|
430
533
|
*
|
|
431
534
|
* Update an existing exam.
|
|
432
535
|
*/
|
|
433
|
-
|
|
536
|
+
update<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
434
537
|
/**
|
|
435
538
|
* Duplicate exam
|
|
436
539
|
*
|
|
437
540
|
* Duplicate the exam's questions and settings to a new exam.
|
|
438
541
|
*/
|
|
439
|
-
|
|
542
|
+
duplicate<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdDuplicateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
440
543
|
/**
|
|
441
544
|
* Print exam
|
|
442
545
|
*
|
|
443
546
|
* Export an exam to a PDF file or Word document.
|
|
444
547
|
*/
|
|
445
|
-
|
|
548
|
+
print<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdPrintData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
446
549
|
/**
|
|
447
550
|
* Generate exam
|
|
448
551
|
*
|
|
449
552
|
* Initiate a job to generate new questions for the exam using AI, based on the source materials and metadata specified.
|
|
450
553
|
*/
|
|
451
|
-
|
|
554
|
+
startGeneration<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdGenerateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
452
555
|
/**
|
|
453
556
|
* Cancel exam generation
|
|
454
557
|
*
|
|
455
558
|
* Cancel an ongoing job to generate new questions for the exam using AI.
|
|
456
559
|
*/
|
|
457
|
-
|
|
560
|
+
cancelGeneration<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdGenerateCancelData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
458
561
|
/**
|
|
459
562
|
* Get exam context suggestions
|
|
460
563
|
*
|
|
461
564
|
* Get AI-generated suggestions for context/instructions to include in the exam generation prompt, based on the source materials linked to the exam.
|
|
462
565
|
*/
|
|
463
|
-
|
|
566
|
+
getContextSuggestions<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdContextSuggestionsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
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
|
+
}
|
|
608
|
+
export declare class PracticeSpaces extends HeyApiClient {
|
|
464
609
|
/**
|
|
465
610
|
* List practice spaces
|
|
466
611
|
*
|
|
467
612
|
* Get a list of all practice spaces you have access to in this workspace.
|
|
468
613
|
*/
|
|
469
|
-
|
|
614
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetPracticeSpacesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
470
615
|
/**
|
|
471
616
|
* Create practice space
|
|
472
617
|
*
|
|
473
618
|
* Create a new practice space within your workspace.
|
|
474
619
|
*/
|
|
475
|
-
|
|
620
|
+
create<ThrowOnError extends boolean = false>(options?: Options<PostPracticeSpacesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
476
621
|
/**
|
|
477
622
|
* Delete practice space
|
|
478
623
|
*
|
|
479
624
|
* Delete the practice space.
|
|
480
625
|
*/
|
|
481
|
-
|
|
626
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeletePracticeSpacesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
482
627
|
/**
|
|
483
628
|
* Get practice space
|
|
484
629
|
*
|
|
485
630
|
* Get a single practice space by its ID.
|
|
486
631
|
*/
|
|
487
|
-
|
|
632
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetPracticeSpacesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
488
633
|
/**
|
|
489
634
|
* Update practice space
|
|
490
635
|
*
|
|
491
636
|
* Update an existing practice space.
|
|
492
637
|
*/
|
|
493
|
-
|
|
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>;
|
|
494
657
|
/**
|
|
495
658
|
* Preview top practice space questions
|
|
496
659
|
*
|
|
497
660
|
* Get a preview of the top practice space questions by quality score.
|
|
498
661
|
*/
|
|
499
|
-
|
|
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;
|
|
679
|
+
}
|
|
680
|
+
export declare class SourceMaterials extends HeyApiClient {
|
|
500
681
|
/**
|
|
501
682
|
* List source materials in org
|
|
502
683
|
*
|
|
503
684
|
* Returns a list of source materials for the current organization.
|
|
504
685
|
*/
|
|
505
|
-
|
|
686
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetSourceMaterialsData, ThrowOnError>): import("./client").RequestResult<GetSourceMaterialsResponses, unknown, ThrowOnError>;
|
|
506
687
|
/**
|
|
507
688
|
* Add source material
|
|
508
689
|
*
|
|
509
690
|
* Add a source material and start processing it for later use in an exam.
|
|
510
691
|
*/
|
|
511
|
-
|
|
692
|
+
create<ThrowOnError extends boolean = false>(options?: Options<PostSourceMaterialsData, ThrowOnError>): import("./client").RequestResult<PostSourceMaterialsResponses, unknown, ThrowOnError>;
|
|
512
693
|
/**
|
|
513
694
|
* Delete source material
|
|
514
695
|
*
|
|
515
696
|
* Deletes the specified source material.
|
|
516
697
|
*/
|
|
517
|
-
|
|
698
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSourceMaterialsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
518
699
|
/**
|
|
519
700
|
* Get source material
|
|
520
701
|
*
|
|
521
702
|
* Returns the current status and facts extracted from the specified source material.
|
|
522
703
|
*/
|
|
523
|
-
|
|
704
|
+
get<ThrowOnError extends boolean = false>(options: Options<GetSourceMaterialsByIdData, ThrowOnError>): import("./client").RequestResult<GetSourceMaterialsByIdResponses, unknown, ThrowOnError>;
|
|
524
705
|
/**
|
|
525
706
|
* Update source material
|
|
526
707
|
*
|
|
527
708
|
* Updates the specified source material.
|
|
528
709
|
*/
|
|
529
|
-
|
|
710
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchSourceMaterialsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
530
711
|
/**
|
|
531
712
|
* Create a source material slice
|
|
532
713
|
*
|
|
533
714
|
* Create a new source material based on a specific page range of an existing source material.
|
|
534
715
|
*/
|
|
535
|
-
|
|
716
|
+
slice<ThrowOnError extends boolean = false>(options: Options<PostSourceMaterialsByIdSliceData, ThrowOnError>): import("./client").RequestResult<PostSourceMaterialsByIdSliceResponses, unknown, ThrowOnError>;
|
|
717
|
+
}
|
|
718
|
+
export declare class Folders extends HeyApiClient {
|
|
536
719
|
/**
|
|
537
720
|
* Get folders
|
|
538
721
|
*
|
|
539
722
|
* Get a list of folders for exam organisation that exist within the current workspace.
|
|
540
723
|
*/
|
|
541
|
-
|
|
724
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetFoldersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
542
725
|
/**
|
|
543
726
|
* Create folder
|
|
544
727
|
*
|
|
545
728
|
* Create a new folder in the current workspace.
|
|
546
729
|
*/
|
|
547
|
-
|
|
730
|
+
create<ThrowOnError extends boolean = false>(options?: Options<PostFoldersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
548
731
|
/**
|
|
549
732
|
* Delete folder
|
|
550
733
|
*
|
|
551
734
|
* Delete a folder from the current workspace. If there are any exams in the folder, they will be moved out of the folder.
|
|
552
735
|
*/
|
|
553
|
-
|
|
736
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteFoldersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
554
737
|
/**
|
|
555
738
|
* Update folder
|
|
556
739
|
*
|
|
557
740
|
* Update an existing folder in the current workspace.
|
|
558
741
|
*/
|
|
559
|
-
|
|
742
|
+
update<ThrowOnError extends boolean = false>(options: Options<PostFoldersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
743
|
+
}
|
|
744
|
+
export declare class QuestionBank extends HeyApiClient {
|
|
560
745
|
/**
|
|
561
746
|
* Get question bank items
|
|
562
747
|
*
|
|
563
748
|
* Get a list of question bank items that exist within the current workspace.
|
|
564
749
|
*/
|
|
565
|
-
|
|
750
|
+
list<ThrowOnError extends boolean = false>(options?: Options<GetQuestionBankData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
566
751
|
/**
|
|
567
752
|
* Add question to question bank
|
|
568
753
|
*
|
|
569
754
|
* Add a question to the question bank in the current workspace.
|
|
570
755
|
*/
|
|
571
|
-
|
|
756
|
+
create<ThrowOnError extends boolean = false>(options?: Options<PostQuestionBankData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
572
757
|
/**
|
|
573
758
|
* Delete question bank item
|
|
574
759
|
*
|
|
575
760
|
* Delete a question bank item from the current workspace.
|
|
576
761
|
*/
|
|
577
|
-
|
|
762
|
+
delete<ThrowOnError extends boolean = false>(options: Options<DeleteQuestionBankByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
578
763
|
/**
|
|
579
764
|
* Update question bank item
|
|
580
765
|
*
|
|
581
766
|
* Update an existing question bank item in the current workspace.
|
|
582
767
|
*/
|
|
583
|
-
|
|
768
|
+
update<ThrowOnError extends boolean = false>(options: Options<PatchQuestionBankByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
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
|
+
}
|
|
784
|
+
export declare class Examplary extends HeyApiClient {
|
|
785
|
+
static readonly __registry: HeyApiRegistry<Examplary>;
|
|
786
|
+
constructor(args?: {
|
|
787
|
+
client?: Client;
|
|
788
|
+
key?: string;
|
|
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>;
|
|
820
|
+
private _questionTypes?;
|
|
821
|
+
get questionTypes(): QuestionTypes;
|
|
822
|
+
private _library?;
|
|
823
|
+
get library(): Library;
|
|
824
|
+
private _oauth?;
|
|
825
|
+
get oauth(): Oauth;
|
|
826
|
+
private _embedSessions?;
|
|
827
|
+
get embedSessions(): EmbedSessions;
|
|
828
|
+
private _me?;
|
|
829
|
+
get me(): Me;
|
|
830
|
+
private _media?;
|
|
831
|
+
get media(): Media;
|
|
832
|
+
private _org?;
|
|
833
|
+
get org(): Org;
|
|
834
|
+
private _orgs?;
|
|
835
|
+
get orgs(): Orgs;
|
|
836
|
+
private _apiKeys?;
|
|
837
|
+
get apiKeys(): ApiKeys;
|
|
838
|
+
private _attributes?;
|
|
839
|
+
get attributes(): Attributes;
|
|
840
|
+
private _taxonomies?;
|
|
841
|
+
get taxonomies(): Taxonomies;
|
|
842
|
+
private _permissions?;
|
|
843
|
+
get permissions(): Permissions;
|
|
844
|
+
private _studentLevels?;
|
|
845
|
+
get studentLevels(): StudentLevels;
|
|
846
|
+
private _users?;
|
|
847
|
+
get users(): Users;
|
|
848
|
+
private _exam?;
|
|
849
|
+
get exam(): Exam;
|
|
850
|
+
private _exams?;
|
|
851
|
+
get exams(): Exams;
|
|
852
|
+
private _practiceSpaces?;
|
|
853
|
+
get practiceSpaces(): PracticeSpaces;
|
|
854
|
+
private _sourceMaterials?;
|
|
855
|
+
get sourceMaterials(): SourceMaterials;
|
|
856
|
+
private _folders?;
|
|
857
|
+
get folders(): Folders;
|
|
858
|
+
private _questionBank?;
|
|
859
|
+
get questionBank(): QuestionBank;
|
|
860
|
+
private _jobs?;
|
|
861
|
+
get jobs(): Jobs;
|
|
584
862
|
}
|
|
585
863
|
export {};
|