@examplary/sdk 1.0.2 → 1.1.0
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/README.md +95 -9
- package/dist/generated/sdk.d.ts +1702 -0
- package/dist/generated/sdk.js +742 -0
- package/dist/generated/types.d.ts +5425 -0
- package/dist/generated/{client/client/types.gen.js → types.js} +1 -1
- package/dist/src/context.d.ts +7 -0
- package/dist/src/context.js +22 -0
- package/dist/src/error.d.ts +6 -0
- package/dist/src/error.js +24 -0
- package/dist/src/index.d.ts +5 -14
- package/dist/src/index.js +5 -45
- package/dist/src/options.d.ts +6 -0
- package/dist/{generated/client/core/types.gen.js → src/options.js} +0 -1
- package/dist/src/request.d.ts +3 -0
- package/dist/src/request.js +46 -0
- package/package.json +16 -8
- package/dist/generated/client/client/client.gen.d.ts +0 -2
- package/dist/generated/client/client/client.gen.js +0 -140
- package/dist/generated/client/client/index.d.ts +0 -8
- package/dist/generated/client/client/index.js +0 -16
- package/dist/generated/client/client/types.gen.d.ts +0 -87
- package/dist/generated/client/client/utils.gen.d.ts +0 -14
- package/dist/generated/client/client/utils.gen.js +0 -177
- package/dist/generated/client/client.gen.d.ts +0 -12
- package/dist/generated/client/client.gen.js +0 -6
- package/dist/generated/client/core/auth.gen.d.ts +0 -18
- package/dist/generated/client/core/auth.gen.js +0 -18
- package/dist/generated/client/core/bodySerializer.gen.d.ts +0 -25
- package/dist/generated/client/core/bodySerializer.gen.js +0 -60
- package/dist/generated/client/core/params.gen.d.ts +0 -43
- package/dist/generated/client/core/params.gen.js +0 -104
- package/dist/generated/client/core/pathSerializer.gen.d.ts +0 -33
- package/dist/generated/client/core/pathSerializer.gen.js +0 -115
- package/dist/generated/client/core/queryKeySerializer.gen.d.ts +0 -18
- package/dist/generated/client/core/queryKeySerializer.gen.js +0 -98
- package/dist/generated/client/core/serverSentEvents.gen.d.ts +0 -71
- package/dist/generated/client/core/serverSentEvents.gen.js +0 -135
- package/dist/generated/client/core/types.gen.d.ts +0 -78
- package/dist/generated/client/core/utils.gen.d.ts +0 -19
- package/dist/generated/client/core/utils.gen.js +0 -93
- package/dist/generated/client/index.d.ts +0 -2
- package/dist/generated/client/index.js +0 -36
- package/dist/generated/client/sdk.gen.d.ts +0 -863
- package/dist/generated/client/sdk.gen.js +0 -1826
- package/dist/generated/client/types.gen.d.ts +0 -2417
- package/dist/generated/client/types.gen.js +0 -3
|
@@ -1,863 +0,0 @@
|
|
|
1
|
-
import type { Client, Options as Options2, TDataShape } from './client';
|
|
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
|
-
/**
|
|
5
|
-
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
-
* individual options. This might be also useful if you want to implement a
|
|
7
|
-
* custom client.
|
|
8
|
-
*/
|
|
9
|
-
client?: Client;
|
|
10
|
-
/**
|
|
11
|
-
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
-
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
-
*/
|
|
14
|
-
meta?: Record<string, unknown>;
|
|
15
|
-
};
|
|
16
|
-
declare class HeyApiClient {
|
|
17
|
-
protected client: Client;
|
|
18
|
-
constructor(args?: {
|
|
19
|
-
client?: Client;
|
|
20
|
-
});
|
|
21
|
-
}
|
|
22
|
-
declare class HeyApiRegistry<T> {
|
|
23
|
-
private readonly defaultKey;
|
|
24
|
-
private readonly instances;
|
|
25
|
-
get(key?: string): T;
|
|
26
|
-
set(value: T, key?: string): void;
|
|
27
|
-
}
|
|
28
|
-
export declare class QuestionTypes extends HeyApiClient {
|
|
29
|
-
/**
|
|
30
|
-
* List public question types
|
|
31
|
-
*
|
|
32
|
-
* Lists all public question types, which can be enabled in workspaces.
|
|
33
|
-
*/
|
|
34
|
-
listPublic<ThrowOnError extends boolean = false>(options?: Options<GetQuestionTypesPublicData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
35
|
-
/**
|
|
36
|
-
* Delete question type
|
|
37
|
-
*
|
|
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.
|
|
39
|
-
*/
|
|
40
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeleteQuestionTypesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
41
|
-
/**
|
|
42
|
-
* Get question type
|
|
43
|
-
*
|
|
44
|
-
* Retrieves a specific question type by its ID.
|
|
45
|
-
*/
|
|
46
|
-
get<ThrowOnError extends boolean = false>(options: Options<GetQuestionTypesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
47
|
-
/**
|
|
48
|
-
* Get question type PCI module for QTI 3 export
|
|
49
|
-
*
|
|
50
|
-
* Get JS module for a question type PCI for QTI 3 export.
|
|
51
|
-
*/
|
|
52
|
-
getQti3Pci<ThrowOnError extends boolean = false>(options: Options<GetQuestionTypesByIdExportQti3PciData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
53
|
-
/**
|
|
54
|
-
* List question types
|
|
55
|
-
*
|
|
56
|
-
* Lists all question types, either those available by default or those created within the user's organization.
|
|
57
|
-
*/
|
|
58
|
-
list<ThrowOnError extends boolean = false>(options?: Options<GetQuestionTypesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
59
|
-
/**
|
|
60
|
-
* Upsert question type
|
|
61
|
-
*
|
|
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.
|
|
63
|
-
*/
|
|
64
|
-
upsert<ThrowOnError extends boolean = false>(options?: Options<PostQuestionTypesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
65
|
-
/**
|
|
66
|
-
* Enable question type
|
|
67
|
-
*
|
|
68
|
-
* Enable a question type for the current workspace.
|
|
69
|
-
*/
|
|
70
|
-
enable<ThrowOnError extends boolean = false>(options: Options<PostQuestionTypesByIdEnableData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
71
|
-
/**
|
|
72
|
-
* Disable question type
|
|
73
|
-
*
|
|
74
|
-
* Disable a question type for the current workspace.
|
|
75
|
-
*/
|
|
76
|
-
disable<ThrowOnError extends boolean = false>(options: Options<PostQuestionTypesByIdDisableData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
77
|
-
}
|
|
78
|
-
export declare class Items extends HeyApiClient {
|
|
79
|
-
/**
|
|
80
|
-
* List items by publisher
|
|
81
|
-
*
|
|
82
|
-
* Lists all library items for the specified publisher profile.
|
|
83
|
-
*/
|
|
84
|
-
list<ThrowOnError extends boolean = false>(options: Options<GetLibraryPublishersByPublisherIdItemsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
85
|
-
/**
|
|
86
|
-
* Create library item
|
|
87
|
-
*
|
|
88
|
-
* Adds an item to the library. Only the publisher owner can add items to their publisher profile.
|
|
89
|
-
*/
|
|
90
|
-
create<ThrowOnError extends boolean = false>(options: Options<PostLibraryPublishersByPublisherIdItemsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
91
|
-
}
|
|
92
|
-
export declare class Publishers extends HeyApiClient {
|
|
93
|
-
/**
|
|
94
|
-
* List featured publishers
|
|
95
|
-
*
|
|
96
|
-
* Lists all library publishers that are marked as featured.
|
|
97
|
-
*/
|
|
98
|
-
listFeatured<ThrowOnError extends boolean = false>(options?: Options<GetLibraryPublishersFeaturedData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
99
|
-
/**
|
|
100
|
-
* List all publishers
|
|
101
|
-
*
|
|
102
|
-
* Lists all library publisher profiles.
|
|
103
|
-
*/
|
|
104
|
-
listAll<ThrowOnError extends boolean = false>(options?: Options<GetLibraryPublishersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
105
|
-
/**
|
|
106
|
-
* Create publisher
|
|
107
|
-
*
|
|
108
|
-
* Creates a new library publisher profile.
|
|
109
|
-
*/
|
|
110
|
-
create<ThrowOnError extends boolean = false>(options?: Options<PostLibraryPublishersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
111
|
-
/**
|
|
112
|
-
* List my publishers
|
|
113
|
-
*
|
|
114
|
-
* Lists all library publisher profiles created by the authenticated user.
|
|
115
|
-
*/
|
|
116
|
-
listMine<ThrowOnError extends boolean = false>(options?: Options<GetLibraryPublishersMineData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
117
|
-
/**
|
|
118
|
-
* Delete publisher
|
|
119
|
-
*
|
|
120
|
-
* Deletes a library publisher profile. Only the owner can delete their publisher profile.
|
|
121
|
-
*/
|
|
122
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeleteLibraryPublishersByPublisherIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
123
|
-
/**
|
|
124
|
-
* Update publisher
|
|
125
|
-
*
|
|
126
|
-
* Updates a library publisher profile. Only the owner can update their publisher profile.
|
|
127
|
-
*/
|
|
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 {
|
|
159
|
-
/**
|
|
160
|
-
* OAuth authorization endpoint
|
|
161
|
-
*
|
|
162
|
-
* Initiates OAuth authorization flow. Redirects to the frontend authorization UI where users can approve or deny access.
|
|
163
|
-
*/
|
|
164
|
-
authorize<ThrowOnError extends boolean = false>(options: Options<GetOauthAuthorizeData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
165
|
-
/**
|
|
166
|
-
* OAuth token endpoint
|
|
167
|
-
*
|
|
168
|
-
* Exchange authorization code for access token, or refresh an existing token.
|
|
169
|
-
*/
|
|
170
|
-
token<ThrowOnError extends boolean = false>(options?: Options<PostOauthTokenData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
171
|
-
}
|
|
172
|
-
export declare class EmbedSessions extends HeyApiClient {
|
|
173
|
-
/**
|
|
174
|
-
* Create embed session
|
|
175
|
-
*
|
|
176
|
-
* Create a new embed session. This allows you to embed the exam generation flow into your own application.
|
|
177
|
-
*/
|
|
178
|
-
create<ThrowOnError extends boolean = false>(options?: Options<PostEmbedSessionsData, ThrowOnError>): import("./client").RequestResult<PostEmbedSessionsResponses, unknown, ThrowOnError>;
|
|
179
|
-
/**
|
|
180
|
-
* Revoke embed session
|
|
181
|
-
*
|
|
182
|
-
* Revoke access to an embed session by its ID.
|
|
183
|
-
*/
|
|
184
|
-
revoke<ThrowOnError extends boolean = false>(options: Options<DeleteEmbedSessionsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
185
|
-
/**
|
|
186
|
-
* Get embed session
|
|
187
|
-
*
|
|
188
|
-
* Retrieve an embed session by its ID.
|
|
189
|
-
*/
|
|
190
|
-
get<ThrowOnError extends boolean = false>(options: Options<GetEmbedSessionsByIdData, ThrowOnError>): import("./client").RequestResult<GetEmbedSessionsByIdResponses, unknown, ThrowOnError>;
|
|
191
|
-
}
|
|
192
|
-
export declare class Me extends HeyApiClient {
|
|
193
|
-
/**
|
|
194
|
-
* Get me
|
|
195
|
-
*
|
|
196
|
-
* Get the current user's account details.
|
|
197
|
-
*/
|
|
198
|
-
get<ThrowOnError extends boolean = false>(options?: Options<GetMeData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
199
|
-
/**
|
|
200
|
-
* Update me
|
|
201
|
-
*
|
|
202
|
-
* Update the current user's account details.
|
|
203
|
-
*/
|
|
204
|
-
update<ThrowOnError extends boolean = false>(options?: Options<PatchMeData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
205
|
-
}
|
|
206
|
-
export declare class Media extends HeyApiClient {
|
|
207
|
-
/**
|
|
208
|
-
* Get file upload URL
|
|
209
|
-
*
|
|
210
|
-
* Returns a signed URL for uploading a file, and a public URL for accessing it afterwards.
|
|
211
|
-
*/
|
|
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 {
|
|
225
|
-
/**
|
|
226
|
-
* Delete organization
|
|
227
|
-
*/
|
|
228
|
-
delete<ThrowOnError extends boolean = false>(options?: Options<DeleteOrgData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
229
|
-
/**
|
|
230
|
-
* Get organization
|
|
231
|
-
*/
|
|
232
|
-
get<ThrowOnError extends boolean = false>(options?: Options<GetOrgData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
233
|
-
/**
|
|
234
|
-
* Update organization
|
|
235
|
-
*/
|
|
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 {
|
|
241
|
-
/**
|
|
242
|
-
* List all organizations
|
|
243
|
-
*/
|
|
244
|
-
list<ThrowOnError extends boolean = false>(options?: Options<GetOrgsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
245
|
-
/**
|
|
246
|
-
* Create a new organization
|
|
247
|
-
*
|
|
248
|
-
* Create a new workspace to collaborate with others on exams.
|
|
249
|
-
*/
|
|
250
|
-
create<ThrowOnError extends boolean = false>(options?: Options<PostOrgsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
251
|
-
}
|
|
252
|
-
export declare class ApiKeys extends HeyApiClient {
|
|
253
|
-
/**
|
|
254
|
-
* Get API key
|
|
255
|
-
*
|
|
256
|
-
* Get the API key for the current org/user combination. Creates one if none exists.
|
|
257
|
-
*/
|
|
258
|
-
get<ThrowOnError extends boolean = false>(options?: Options<GetApiKeysData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
259
|
-
/**
|
|
260
|
-
* Reset API key
|
|
261
|
-
*
|
|
262
|
-
* Invalidate old API keys for this org/user and create a new one.
|
|
263
|
-
*/
|
|
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 {
|
|
299
|
-
/**
|
|
300
|
-
* Get taxonomies
|
|
301
|
-
*
|
|
302
|
-
* Get a list available taxonomies, including defaults and taxonomies created in the current workspace.
|
|
303
|
-
*/
|
|
304
|
-
list<ThrowOnError extends boolean = false>(options?: Options<GetTaxonomiesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
305
|
-
/**
|
|
306
|
-
* Create taxonomy
|
|
307
|
-
*
|
|
308
|
-
* Save a new taxonomy in the current workspace.
|
|
309
|
-
*/
|
|
310
|
-
create<ThrowOnError extends boolean = false>(options?: Options<PostTaxonomiesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
311
|
-
/**
|
|
312
|
-
* Delete taxonomy
|
|
313
|
-
*
|
|
314
|
-
* Delete a taxonomy from the current workspace. This fails if there are any exams associated with the taxonomy.
|
|
315
|
-
*/
|
|
316
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeleteTaxonomiesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
317
|
-
/**
|
|
318
|
-
* Update taxonomy
|
|
319
|
-
*
|
|
320
|
-
* Update an existing taxonomy in the current workspace.
|
|
321
|
-
*/
|
|
322
|
-
update<ThrowOnError extends boolean = false>(options: Options<PostTaxonomiesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
323
|
-
}
|
|
324
|
-
export declare class Permissions extends HeyApiClient {
|
|
325
|
-
/**
|
|
326
|
-
* Get sharing permissions
|
|
327
|
-
*
|
|
328
|
-
* Get a list of users, groups and orgs that have access to a specific resource.
|
|
329
|
-
*/
|
|
330
|
-
list<ThrowOnError extends boolean = false>(options: Options<GetPermissionsByResourceData, ThrowOnError>): import("./client").RequestResult<GetPermissionsByResourceResponses, GetPermissionsByResourceErrors, ThrowOnError>;
|
|
331
|
-
/**
|
|
332
|
-
* Create permission
|
|
333
|
-
*
|
|
334
|
-
* Create a new permission for a specific resource, or update the role of an existing actor.
|
|
335
|
-
*/
|
|
336
|
-
assign<ThrowOnError extends boolean = false>(options: Options<PostPermissionsByResourceData, ThrowOnError>): import("./client").RequestResult<PostPermissionsByResourceResponses, PostPermissionsByResourceErrors, ThrowOnError>;
|
|
337
|
-
/**
|
|
338
|
-
* Remove permission
|
|
339
|
-
*
|
|
340
|
-
* Remove a permission for a specific actor on a specific resource.
|
|
341
|
-
*/
|
|
342
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeletePermissionsByResourceByActorData, ThrowOnError>): import("./client").RequestResult<DeletePermissionsByResourceByActorResponses, DeletePermissionsByResourceByActorErrors, ThrowOnError>;
|
|
343
|
-
/**
|
|
344
|
-
* Get actor role
|
|
345
|
-
*
|
|
346
|
-
* Get the role of a specific actor for a specific resource.
|
|
347
|
-
*/
|
|
348
|
-
getActorRole<ThrowOnError extends boolean = false>(options: Options<GetPermissionsByResourceByActorData, ThrowOnError>): import("./client").RequestResult<GetPermissionsByResourceByActorResponses, GetPermissionsByResourceByActorErrors, ThrowOnError>;
|
|
349
|
-
}
|
|
350
|
-
export declare class StudentLevels extends HeyApiClient {
|
|
351
|
-
/**
|
|
352
|
-
* List available student levels
|
|
353
|
-
*
|
|
354
|
-
* Get a list of available default student levels.
|
|
355
|
-
*/
|
|
356
|
-
list<ThrowOnError extends boolean = false>(options?: Options<GetStudentLevelsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
357
|
-
}
|
|
358
|
-
export declare class Users extends HeyApiClient {
|
|
359
|
-
/**
|
|
360
|
-
* List users
|
|
361
|
-
*
|
|
362
|
-
* Get a list of all users in the workspace.
|
|
363
|
-
*/
|
|
364
|
-
list<ThrowOnError extends boolean = false>(options?: Options<GetUsersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
365
|
-
/**
|
|
366
|
-
* Create user
|
|
367
|
-
*
|
|
368
|
-
* Create a new user in the workspace.
|
|
369
|
-
*/
|
|
370
|
-
create<ThrowOnError extends boolean = false>(options?: Options<PostUsersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
371
|
-
/**
|
|
372
|
-
* Delete user
|
|
373
|
-
*
|
|
374
|
-
* Delete a user from the workspace.
|
|
375
|
-
*/
|
|
376
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeleteUsersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
377
|
-
/**
|
|
378
|
-
* Update user role
|
|
379
|
-
*
|
|
380
|
-
* Update a user's role within the workspace.
|
|
381
|
-
*/
|
|
382
|
-
update<ThrowOnError extends boolean = false>(options: Options<PatchUsersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
383
|
-
}
|
|
384
|
-
export declare class Sessions extends HeyApiClient {
|
|
385
|
-
/**
|
|
386
|
-
* List exam sessions
|
|
387
|
-
*
|
|
388
|
-
* Get a list of all student sessions for an exam, representing a set of answers from a student.
|
|
389
|
-
*/
|
|
390
|
-
list<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdSessionsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
391
|
-
/**
|
|
392
|
-
* Create session
|
|
393
|
-
*
|
|
394
|
-
* Manually create a session, possibly from uploaded data.
|
|
395
|
-
*/
|
|
396
|
-
import<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
397
|
-
/**
|
|
398
|
-
* Get answers from scan
|
|
399
|
-
*
|
|
400
|
-
* Scan student answers from a document.
|
|
401
|
-
*/
|
|
402
|
-
scan<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsScanData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
403
|
-
/**
|
|
404
|
-
* Delete exam session
|
|
405
|
-
*
|
|
406
|
-
* Remove an exam session.
|
|
407
|
-
*/
|
|
408
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeleteExamsByIdSessionsBySessionIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
409
|
-
/**
|
|
410
|
-
* Get exam session
|
|
411
|
-
*
|
|
412
|
-
* Get a single exam session by its ID, representing a set of answers from a student.
|
|
413
|
-
*/
|
|
414
|
-
get<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdSessionsBySessionIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
415
|
-
/**
|
|
416
|
-
* Provide feedback
|
|
417
|
-
*
|
|
418
|
-
* Set teacher feedback and/or a grade for a specific question in an exam session.
|
|
419
|
-
*/
|
|
420
|
-
saveFeedback<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdFeedbackData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
421
|
-
/**
|
|
422
|
-
* Provide overall feedback
|
|
423
|
-
*
|
|
424
|
-
* Set teacher feedback for the test as a whole in an exam session.
|
|
425
|
-
*/
|
|
426
|
-
saveOverallFeedback<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdOverallFeedbackData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
427
|
-
/**
|
|
428
|
-
* Generate overall feedback
|
|
429
|
-
*
|
|
430
|
-
* Generate feedback for the test as a whole in an exam session.
|
|
431
|
-
*/
|
|
432
|
-
generateOverallFeedback<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdGenerateOverallFeedbackData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
433
|
-
/**
|
|
434
|
-
* Accept AI grading suggestions
|
|
435
|
-
*
|
|
436
|
-
* Accept all AI-generated grading suggestions for the exam session.
|
|
437
|
-
*/
|
|
438
|
-
acceptAllSuggestions<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdSessionsBySessionIdSuggestionsAcceptAllData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
439
|
-
/**
|
|
440
|
-
* Accept single AI grading suggestion
|
|
441
|
-
*
|
|
442
|
-
* Accept a single AI-generated grading suggestion for the exam session.
|
|
443
|
-
*/
|
|
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 {
|
|
453
|
-
/**
|
|
454
|
-
* Import questions
|
|
455
|
-
*
|
|
456
|
-
* Import questions into an exam from a file. Support Word, PDF, Moodle quiz XML and plain text files.
|
|
457
|
-
*/
|
|
458
|
-
import<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdQuestionsImportData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
459
|
-
/**
|
|
460
|
-
* Generate question
|
|
461
|
-
*
|
|
462
|
-
* Generate a new question for the exam using an AI prompt.
|
|
463
|
-
*/
|
|
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>;
|
|
471
|
-
/**
|
|
472
|
-
* Regenerate question
|
|
473
|
-
*
|
|
474
|
-
* Update a question using an AI prompt.
|
|
475
|
-
*/
|
|
476
|
-
regenerate<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdQuestionsByQuestionIdGenerateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
477
|
-
}
|
|
478
|
-
export declare class Export extends HeyApiClient {
|
|
479
|
-
/**
|
|
480
|
-
* Export QTI 3 package
|
|
481
|
-
*
|
|
482
|
-
* Export an exam as a QTI 3 ZIP package.
|
|
483
|
-
*/
|
|
484
|
-
qti3Zip<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdExportQti3ZipData, ThrowOnError>): import("./client").RequestResult<PostExamsByIdExportQti3ZipResponses, unknown, ThrowOnError>;
|
|
485
|
-
/**
|
|
486
|
-
* Export QTI 2.1 package
|
|
487
|
-
*
|
|
488
|
-
* Export an exam as a QTI 2.1 ZIP package.
|
|
489
|
-
*/
|
|
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 {
|
|
501
|
-
/**
|
|
502
|
-
* List exams
|
|
503
|
-
*
|
|
504
|
-
* Get a list of all exams within your workspace.
|
|
505
|
-
*/
|
|
506
|
-
list<ThrowOnError extends boolean = false>(options?: Options<GetExamsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
507
|
-
/**
|
|
508
|
-
* Create exam
|
|
509
|
-
*
|
|
510
|
-
* Create a new exam within your workspace.
|
|
511
|
-
*/
|
|
512
|
-
create<ThrowOnError extends boolean = false>(options?: Options<PostExamsData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
513
|
-
/**
|
|
514
|
-
* Import exam
|
|
515
|
-
*
|
|
516
|
-
* Create an exam by importing one or more source materials (e.g. an existing exam).
|
|
517
|
-
*/
|
|
518
|
-
import<ThrowOnError extends boolean = false>(options?: Options<PostExamsImportData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
519
|
-
/**
|
|
520
|
-
* Delete exam
|
|
521
|
-
*
|
|
522
|
-
* Delete the exam.
|
|
523
|
-
*/
|
|
524
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeleteExamsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
525
|
-
/**
|
|
526
|
-
* Get exam
|
|
527
|
-
*
|
|
528
|
-
* Get a single exam by its ID.
|
|
529
|
-
*/
|
|
530
|
-
get<ThrowOnError extends boolean = false>(options: Options<GetExamsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
531
|
-
/**
|
|
532
|
-
* Update exam
|
|
533
|
-
*
|
|
534
|
-
* Update an existing exam.
|
|
535
|
-
*/
|
|
536
|
-
update<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
537
|
-
/**
|
|
538
|
-
* Duplicate exam
|
|
539
|
-
*
|
|
540
|
-
* Duplicate the exam's questions and settings to a new exam.
|
|
541
|
-
*/
|
|
542
|
-
duplicate<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdDuplicateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
543
|
-
/**
|
|
544
|
-
* Print exam
|
|
545
|
-
*
|
|
546
|
-
* Export an exam to a PDF file or Word document.
|
|
547
|
-
*/
|
|
548
|
-
print<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdPrintData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
549
|
-
/**
|
|
550
|
-
* Generate exam
|
|
551
|
-
*
|
|
552
|
-
* Initiate a job to generate new questions for the exam using AI, based on the source materials and metadata specified.
|
|
553
|
-
*/
|
|
554
|
-
startGeneration<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdGenerateData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
555
|
-
/**
|
|
556
|
-
* Cancel exam generation
|
|
557
|
-
*
|
|
558
|
-
* Cancel an ongoing job to generate new questions for the exam using AI.
|
|
559
|
-
*/
|
|
560
|
-
cancelGeneration<ThrowOnError extends boolean = false>(options: Options<PostExamsByIdGenerateCancelData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
561
|
-
/**
|
|
562
|
-
* Get exam context suggestions
|
|
563
|
-
*
|
|
564
|
-
* Get AI-generated suggestions for context/instructions to include in the exam generation prompt, based on the source materials linked to the exam.
|
|
565
|
-
*/
|
|
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 {
|
|
609
|
-
/**
|
|
610
|
-
* List practice spaces
|
|
611
|
-
*
|
|
612
|
-
* Get a list of all practice spaces you have access to in this workspace.
|
|
613
|
-
*/
|
|
614
|
-
list<ThrowOnError extends boolean = false>(options?: Options<GetPracticeSpacesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
615
|
-
/**
|
|
616
|
-
* Create practice space
|
|
617
|
-
*
|
|
618
|
-
* Create a new practice space within your workspace.
|
|
619
|
-
*/
|
|
620
|
-
create<ThrowOnError extends boolean = false>(options?: Options<PostPracticeSpacesData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
621
|
-
/**
|
|
622
|
-
* Delete practice space
|
|
623
|
-
*
|
|
624
|
-
* Delete the practice space.
|
|
625
|
-
*/
|
|
626
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeletePracticeSpacesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
627
|
-
/**
|
|
628
|
-
* Get practice space
|
|
629
|
-
*
|
|
630
|
-
* Get a single practice space by its ID.
|
|
631
|
-
*/
|
|
632
|
-
get<ThrowOnError extends boolean = false>(options: Options<GetPracticeSpacesByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
633
|
-
/**
|
|
634
|
-
* Update practice space
|
|
635
|
-
*
|
|
636
|
-
* Update an existing practice space.
|
|
637
|
-
*/
|
|
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>;
|
|
657
|
-
/**
|
|
658
|
-
* Preview top practice space questions
|
|
659
|
-
*
|
|
660
|
-
* Get a preview of the top practice space questions by quality score.
|
|
661
|
-
*/
|
|
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 {
|
|
681
|
-
/**
|
|
682
|
-
* List source materials in org
|
|
683
|
-
*
|
|
684
|
-
* Returns a list of source materials for the current organization.
|
|
685
|
-
*/
|
|
686
|
-
list<ThrowOnError extends boolean = false>(options?: Options<GetSourceMaterialsData, ThrowOnError>): import("./client").RequestResult<GetSourceMaterialsResponses, unknown, ThrowOnError>;
|
|
687
|
-
/**
|
|
688
|
-
* Add source material
|
|
689
|
-
*
|
|
690
|
-
* Add a source material and start processing it for later use in an exam.
|
|
691
|
-
*/
|
|
692
|
-
create<ThrowOnError extends boolean = false>(options?: Options<PostSourceMaterialsData, ThrowOnError>): import("./client").RequestResult<PostSourceMaterialsResponses, unknown, ThrowOnError>;
|
|
693
|
-
/**
|
|
694
|
-
* Delete source material
|
|
695
|
-
*
|
|
696
|
-
* Deletes the specified source material.
|
|
697
|
-
*/
|
|
698
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeleteSourceMaterialsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
699
|
-
/**
|
|
700
|
-
* Get source material
|
|
701
|
-
*
|
|
702
|
-
* Returns the current status and facts extracted from the specified source material.
|
|
703
|
-
*/
|
|
704
|
-
get<ThrowOnError extends boolean = false>(options: Options<GetSourceMaterialsByIdData, ThrowOnError>): import("./client").RequestResult<GetSourceMaterialsByIdResponses, unknown, ThrowOnError>;
|
|
705
|
-
/**
|
|
706
|
-
* Update source material
|
|
707
|
-
*
|
|
708
|
-
* Updates the specified source material.
|
|
709
|
-
*/
|
|
710
|
-
update<ThrowOnError extends boolean = false>(options: Options<PatchSourceMaterialsByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
711
|
-
/**
|
|
712
|
-
* Create a source material slice
|
|
713
|
-
*
|
|
714
|
-
* Create a new source material based on a specific page range of an existing source material.
|
|
715
|
-
*/
|
|
716
|
-
slice<ThrowOnError extends boolean = false>(options: Options<PostSourceMaterialsByIdSliceData, ThrowOnError>): import("./client").RequestResult<PostSourceMaterialsByIdSliceResponses, unknown, ThrowOnError>;
|
|
717
|
-
}
|
|
718
|
-
export declare class Folders extends HeyApiClient {
|
|
719
|
-
/**
|
|
720
|
-
* Get folders
|
|
721
|
-
*
|
|
722
|
-
* Get a list of folders for exam organisation that exist within the current workspace.
|
|
723
|
-
*/
|
|
724
|
-
list<ThrowOnError extends boolean = false>(options?: Options<GetFoldersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
725
|
-
/**
|
|
726
|
-
* Create folder
|
|
727
|
-
*
|
|
728
|
-
* Create a new folder in the current workspace.
|
|
729
|
-
*/
|
|
730
|
-
create<ThrowOnError extends boolean = false>(options?: Options<PostFoldersData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
731
|
-
/**
|
|
732
|
-
* Delete folder
|
|
733
|
-
*
|
|
734
|
-
* Delete a folder from the current workspace. If there are any exams in the folder, they will be moved out of the folder.
|
|
735
|
-
*/
|
|
736
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeleteFoldersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
737
|
-
/**
|
|
738
|
-
* Update folder
|
|
739
|
-
*
|
|
740
|
-
* Update an existing folder in the current workspace.
|
|
741
|
-
*/
|
|
742
|
-
update<ThrowOnError extends boolean = false>(options: Options<PostFoldersByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
743
|
-
}
|
|
744
|
-
export declare class QuestionBank extends HeyApiClient {
|
|
745
|
-
/**
|
|
746
|
-
* Get question bank items
|
|
747
|
-
*
|
|
748
|
-
* Get a list of question bank items that exist within the current workspace.
|
|
749
|
-
*/
|
|
750
|
-
list<ThrowOnError extends boolean = false>(options?: Options<GetQuestionBankData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
751
|
-
/**
|
|
752
|
-
* Add question to question bank
|
|
753
|
-
*
|
|
754
|
-
* Add a question to the question bank in the current workspace.
|
|
755
|
-
*/
|
|
756
|
-
create<ThrowOnError extends boolean = false>(options?: Options<PostQuestionBankData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
757
|
-
/**
|
|
758
|
-
* Delete question bank item
|
|
759
|
-
*
|
|
760
|
-
* Delete a question bank item from the current workspace.
|
|
761
|
-
*/
|
|
762
|
-
delete<ThrowOnError extends boolean = false>(options: Options<DeleteQuestionBankByIdData, ThrowOnError>): import("./client").RequestResult<unknown, unknown, ThrowOnError>;
|
|
763
|
-
/**
|
|
764
|
-
* Update question bank item
|
|
765
|
-
*
|
|
766
|
-
* Update an existing question bank item in the current workspace.
|
|
767
|
-
*/
|
|
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;
|
|
862
|
-
}
|
|
863
|
-
export {};
|