@examplary/sdk 1.0.3 → 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.
Files changed (46) hide show
  1. package/README.md +95 -9
  2. package/dist/generated/sdk.d.ts +1702 -0
  3. package/dist/generated/sdk.js +742 -0
  4. package/dist/generated/types.d.ts +5425 -0
  5. package/dist/generated/{client/client/types.gen.js → types.js} +1 -1
  6. package/dist/src/context.d.ts +7 -0
  7. package/dist/src/context.js +22 -0
  8. package/dist/src/error.d.ts +6 -0
  9. package/dist/src/error.js +24 -0
  10. package/dist/src/index.d.ts +5 -14
  11. package/dist/src/index.js +5 -45
  12. package/dist/src/options.d.ts +6 -0
  13. package/dist/{generated/client/core/types.gen.js → src/options.js} +0 -1
  14. package/dist/src/request.d.ts +3 -0
  15. package/dist/src/request.js +46 -0
  16. package/package.json +16 -8
  17. package/dist/generated/client/client/client.gen.d.ts +0 -2
  18. package/dist/generated/client/client/client.gen.js +0 -140
  19. package/dist/generated/client/client/index.d.ts +0 -8
  20. package/dist/generated/client/client/index.js +0 -16
  21. package/dist/generated/client/client/types.gen.d.ts +0 -87
  22. package/dist/generated/client/client/utils.gen.d.ts +0 -14
  23. package/dist/generated/client/client/utils.gen.js +0 -177
  24. package/dist/generated/client/client.gen.d.ts +0 -12
  25. package/dist/generated/client/client.gen.js +0 -6
  26. package/dist/generated/client/core/auth.gen.d.ts +0 -18
  27. package/dist/generated/client/core/auth.gen.js +0 -18
  28. package/dist/generated/client/core/bodySerializer.gen.d.ts +0 -25
  29. package/dist/generated/client/core/bodySerializer.gen.js +0 -60
  30. package/dist/generated/client/core/params.gen.d.ts +0 -43
  31. package/dist/generated/client/core/params.gen.js +0 -104
  32. package/dist/generated/client/core/pathSerializer.gen.d.ts +0 -33
  33. package/dist/generated/client/core/pathSerializer.gen.js +0 -115
  34. package/dist/generated/client/core/queryKeySerializer.gen.d.ts +0 -18
  35. package/dist/generated/client/core/queryKeySerializer.gen.js +0 -98
  36. package/dist/generated/client/core/serverSentEvents.gen.d.ts +0 -71
  37. package/dist/generated/client/core/serverSentEvents.gen.js +0 -135
  38. package/dist/generated/client/core/types.gen.d.ts +0 -78
  39. package/dist/generated/client/core/utils.gen.d.ts +0 -19
  40. package/dist/generated/client/core/utils.gen.js +0 -93
  41. package/dist/generated/client/index.d.ts +0 -2
  42. package/dist/generated/client/index.js +0 -36
  43. package/dist/generated/client/sdk.gen.d.ts +0 -863
  44. package/dist/generated/client/sdk.gen.js +0 -1826
  45. package/dist/generated/client/types.gen.d.ts +0 -2417
  46. package/dist/generated/client/types.gen.js +0 -3
@@ -0,0 +1,1702 @@
1
+ import { type ClientContext } from "../src/context";
2
+ import type { ExamplaryClientOptions, ExamplaryRequestOptions } from "../src/options";
3
+ import type { operations } from "./types";
4
+ type Prettify<T> = T extends object ? {
5
+ [K in keyof T]: T[K];
6
+ } & {} : T;
7
+ type _Query<K extends keyof operations> = operations[K] extends {
8
+ parameters: {
9
+ query?: infer Q;
10
+ };
11
+ } ? Q extends object ? Q : {} : {};
12
+ type _Body<K extends keyof operations> = operations[K] extends {
13
+ requestBody?: infer R;
14
+ } ? R extends {
15
+ content: {
16
+ "application/json": infer B;
17
+ };
18
+ } ? B extends object ? B : {} : {} : {};
19
+ type _SuccessShape<R> = [R] extends [never] ? never : R extends {
20
+ 200: infer T;
21
+ } ? T : R extends {
22
+ 201: infer T;
23
+ } ? T : R extends {
24
+ 202: infer T;
25
+ } ? T : R extends {
26
+ 204: infer T;
27
+ } ? T : never;
28
+ type _Response<K extends keyof operations> = _SuccessShape<operations[K]["responses"]> extends infer X ? [X] extends [never] ? any : X extends {
29
+ content: {
30
+ "application/json": infer T;
31
+ };
32
+ } ? T : any : any;
33
+ export type QuestionTypesListPublicArgs = Prettify<_Query<"questionTypes.listPublic"> & _Body<"questionTypes.listPublic">>;
34
+ export type QuestionTypesListPublicResponse = _Response<"questionTypes.listPublic">;
35
+ export type QuestionTypesGetArgs = Prettify<{
36
+ id: string;
37
+ } & _Query<"questionTypes.get"> & _Body<"questionTypes.get">>;
38
+ export type QuestionTypesGetResponse = _Response<"questionTypes.get">;
39
+ export type QuestionTypesDeleteArgs = Prettify<{
40
+ id: string;
41
+ } & _Query<"questionTypes.delete"> & _Body<"questionTypes.delete">>;
42
+ export type QuestionTypesDeleteResponse = _Response<"questionTypes.delete">;
43
+ export type QuestionTypesGetQti3PciArgs = Prettify<{
44
+ questionTypeId: string;
45
+ } & _Query<"questionTypes.getQti3Pci"> & _Body<"questionTypes.getQti3Pci">>;
46
+ export type QuestionTypesGetQti3PciResponse = _Response<"questionTypes.getQti3Pci">;
47
+ export type QuestionTypesListArgs = Prettify<_Query<"questionTypes.list"> & _Body<"questionTypes.list">>;
48
+ export type QuestionTypesListResponse = _Response<"questionTypes.list">;
49
+ export type QuestionTypesUpsertArgs = Prettify<_Query<"questionTypes.upsert"> & _Body<"questionTypes.upsert">>;
50
+ export type QuestionTypesUpsertResponse = _Response<"questionTypes.upsert">;
51
+ export type QuestionTypesEnableArgs = Prettify<{
52
+ questionTypeId: string;
53
+ } & _Query<"questionTypes.enable"> & _Body<"questionTypes.enable">>;
54
+ export type QuestionTypesEnableResponse = _Response<"questionTypes.enable">;
55
+ export type QuestionTypesDisableArgs = Prettify<{
56
+ questionTypeId: string;
57
+ } & _Query<"questionTypes.disable"> & _Body<"questionTypes.disable">>;
58
+ export type QuestionTypesDisableResponse = _Response<"questionTypes.disable">;
59
+ export type LibraryPublishersItemsListArgs = Prettify<{
60
+ publisherId: string;
61
+ } & _Query<"library.publishers.items.list"> & _Body<"library.publishers.items.list">>;
62
+ export type LibraryPublishersItemsListResponse = _Response<"library.publishers.items.list">;
63
+ export type LibraryPublishersItemsCreateArgs = Prettify<{
64
+ publisherId: string;
65
+ } & _Query<"library.publishers.items.create"> & _Body<"library.publishers.items.create">>;
66
+ export type LibraryPublishersItemsCreateResponse = _Response<"library.publishers.items.create">;
67
+ export type LibraryItemsListFeaturedArgs = Prettify<_Query<"library.items.listFeatured"> & _Body<"library.items.listFeatured">>;
68
+ export type LibraryItemsListFeaturedResponse = _Response<"library.items.listFeatured">;
69
+ export type LibraryItemsUpdateArgs = Prettify<{
70
+ itemId: string;
71
+ } & _Query<"library.items.update"> & _Body<"library.items.update">>;
72
+ export type LibraryItemsUpdateResponse = _Response<"library.items.update">;
73
+ export type LibraryItemsDeleteArgs = Prettify<{
74
+ itemId: string;
75
+ } & _Query<"library.items.delete"> & _Body<"library.items.delete">>;
76
+ export type LibraryItemsDeleteResponse = _Response<"library.items.delete">;
77
+ export type LibraryPublishersListFeaturedArgs = Prettify<_Query<"library.publishers.listFeatured"> & _Body<"library.publishers.listFeatured">>;
78
+ export type LibraryPublishersListFeaturedResponse = _Response<"library.publishers.listFeatured">;
79
+ export type LibraryPublishersListAllArgs = Prettify<_Query<"library.publishers.listAll"> & _Body<"library.publishers.listAll">>;
80
+ export type LibraryPublishersListAllResponse = _Response<"library.publishers.listAll">;
81
+ export type LibraryPublishersCreateArgs = Prettify<_Query<"library.publishers.create"> & _Body<"library.publishers.create">>;
82
+ export type LibraryPublishersCreateResponse = _Response<"library.publishers.create">;
83
+ export type LibraryPublishersListMineArgs = Prettify<_Query<"library.publishers.listMine"> & _Body<"library.publishers.listMine">>;
84
+ export type LibraryPublishersListMineResponse = _Response<"library.publishers.listMine">;
85
+ export type LibraryPublishersUpdateArgs = Prettify<{
86
+ publisherId: string;
87
+ } & _Query<"library.publishers.update"> & _Body<"library.publishers.update">>;
88
+ export type LibraryPublishersUpdateResponse = _Response<"library.publishers.update">;
89
+ export type LibraryPublishersDeleteArgs = Prettify<{
90
+ publisherId: string;
91
+ } & _Query<"library.publishers.delete"> & _Body<"library.publishers.delete">>;
92
+ export type LibraryPublishersDeleteResponse = _Response<"library.publishers.delete">;
93
+ export type OauthAuthorizeArgs = Prettify<_Query<"oauth.authorize"> & _Body<"oauth.authorize">>;
94
+ export type OauthAuthorizeResponse = _Response<"oauth.authorize">;
95
+ export type OauthTokenArgs = Prettify<_Query<"oauth.token"> & _Body<"oauth.token">>;
96
+ export type OauthTokenResponse = _Response<"oauth.token">;
97
+ export type EmbedSessionsCreateArgs = Prettify<_Query<"embedSessions.create"> & _Body<"embedSessions.create">>;
98
+ export type EmbedSessionsCreateResponse = _Response<"embedSessions.create">;
99
+ export type EmbedSessionsGetArgs = Prettify<{
100
+ id: string;
101
+ } & _Query<"embedSessions.get"> & _Body<"embedSessions.get">>;
102
+ export type EmbedSessionsGetResponse = _Response<"embedSessions.get">;
103
+ export type EmbedSessionsRevokeArgs = Prettify<{
104
+ id: string;
105
+ } & _Query<"embedSessions.revoke"> & _Body<"embedSessions.revoke">>;
106
+ export type EmbedSessionsRevokeResponse = _Response<"embedSessions.revoke">;
107
+ export type MeGetArgs = Prettify<_Query<"me.get"> & _Body<"me.get">>;
108
+ export type MeGetResponse = _Response<"me.get">;
109
+ export type MeUpdateArgs = Prettify<_Query<"me.update"> & _Body<"me.update">>;
110
+ export type MeUpdateResponse = _Response<"me.update">;
111
+ export type MediaUploadArgs = Prettify<_Query<"media.upload"> & _Body<"media.upload">>;
112
+ export type MediaUploadResponse = _Response<"media.upload">;
113
+ export type OrgGetArgs = Prettify<_Query<"org.get"> & _Body<"org.get">>;
114
+ export type OrgGetResponse = _Response<"org.get">;
115
+ export type OrgUpdateArgs = Prettify<_Query<"org.update"> & _Body<"org.update">>;
116
+ export type OrgUpdateResponse = _Response<"org.update">;
117
+ export type OrgDeleteArgs = Prettify<_Query<"org.delete"> & _Body<"org.delete">>;
118
+ export type OrgDeleteResponse = _Response<"org.delete">;
119
+ export type OrgCustomDomainGetArgs = Prettify<_Query<"org.customDomain.get"> & _Body<"org.customDomain.get">>;
120
+ export type OrgCustomDomainGetResponse = _Response<"org.customDomain.get">;
121
+ export type OrgCustomDomainUpdateArgs = Prettify<_Query<"org.customDomain.update"> & _Body<"org.customDomain.update">>;
122
+ export type OrgCustomDomainUpdateResponse = _Response<"org.customDomain.update">;
123
+ export type OrgsListArgs = Prettify<_Query<"orgs.list"> & _Body<"orgs.list">>;
124
+ export type OrgsListResponse = _Response<"orgs.list">;
125
+ export type OrgsCreateArgs = Prettify<_Query<"orgs.create"> & _Body<"orgs.create">>;
126
+ export type OrgsCreateResponse = _Response<"orgs.create">;
127
+ export type ApiKeysGetArgs = Prettify<_Query<"apiKeys.get"> & _Body<"apiKeys.get">>;
128
+ export type ApiKeysGetResponse = _Response<"apiKeys.get">;
129
+ export type ApiKeysResetArgs = Prettify<_Query<"apiKeys.reset"> & _Body<"apiKeys.reset">>;
130
+ export type ApiKeysResetResponse = _Response<"apiKeys.reset">;
131
+ export type AttributesListArgs = Prettify<_Query<"attributes.list"> & _Body<"attributes.list">>;
132
+ export type AttributesListResponse = _Response<"attributes.list">;
133
+ export type AttributesCreateArgs = Prettify<_Query<"attributes.create"> & _Body<"attributes.create">>;
134
+ export type AttributesCreateResponse = _Response<"attributes.create">;
135
+ export type AttributesReorderArgs = Prettify<_Query<"attributes.reorder"> & _Body<"attributes.reorder">>;
136
+ export type AttributesReorderResponse = _Response<"attributes.reorder">;
137
+ export type AttributesUpdateArgs = Prettify<{
138
+ id: string;
139
+ } & _Query<"attributes.update"> & _Body<"attributes.update">>;
140
+ export type AttributesUpdateResponse = _Response<"attributes.update">;
141
+ export type AttributesDeleteArgs = Prettify<{
142
+ id: string;
143
+ } & _Query<"attributes.delete"> & _Body<"attributes.delete">>;
144
+ export type AttributesDeleteResponse = _Response<"attributes.delete">;
145
+ export type TaxonomiesListArgs = Prettify<_Query<"taxonomies.list"> & _Body<"taxonomies.list">>;
146
+ export type TaxonomiesListResponse = _Response<"taxonomies.list">;
147
+ export type TaxonomiesCreateArgs = Prettify<_Query<"taxonomies.create"> & _Body<"taxonomies.create">>;
148
+ export type TaxonomiesCreateResponse = _Response<"taxonomies.create">;
149
+ export type TaxonomiesUpdateArgs = Prettify<{
150
+ id: string;
151
+ } & _Query<"taxonomies.update"> & _Body<"taxonomies.update">>;
152
+ export type TaxonomiesUpdateResponse = _Response<"taxonomies.update">;
153
+ export type TaxonomiesDeleteArgs = Prettify<{
154
+ id: string;
155
+ } & _Query<"taxonomies.delete"> & _Body<"taxonomies.delete">>;
156
+ export type TaxonomiesDeleteResponse = _Response<"taxonomies.delete">;
157
+ export type PermissionsAutocompleteArgs = Prettify<_Query<"permissions.autocomplete"> & _Body<"permissions.autocomplete">>;
158
+ export type PermissionsAutocompleteResponse = _Response<"permissions.autocomplete">;
159
+ export type PermissionsListArgs = Prettify<{
160
+ resource: string;
161
+ } & _Query<"permissions.list"> & _Body<"permissions.list">>;
162
+ export type PermissionsListResponse = _Response<"permissions.list">;
163
+ export type PermissionsAssignArgs = Prettify<{
164
+ resource: string;
165
+ } & _Query<"permissions.assign"> & _Body<"permissions.assign">>;
166
+ export type PermissionsAssignResponse = _Response<"permissions.assign">;
167
+ export type PermissionsGetActorRoleArgs = Prettify<{
168
+ actor: string;
169
+ resource: string;
170
+ } & _Query<"permissions.getActorRole"> & _Body<"permissions.getActorRole">>;
171
+ export type PermissionsGetActorRoleResponse = _Response<"permissions.getActorRole">;
172
+ export type PermissionsDeleteArgs = Prettify<{
173
+ resource: string;
174
+ actor: string;
175
+ } & _Query<"permissions.delete"> & _Body<"permissions.delete">>;
176
+ export type PermissionsDeleteResponse = _Response<"permissions.delete">;
177
+ export type StudentLevelsListArgs = Prettify<_Query<"studentLevels.list"> & _Body<"studentLevels.list">>;
178
+ export type StudentLevelsListResponse = _Response<"studentLevels.list">;
179
+ export type UsersListArgs = Prettify<_Query<"users.list"> & _Body<"users.list">>;
180
+ export type UsersListResponse = _Response<"users.list">;
181
+ export type UsersCreateArgs = Prettify<_Query<"users.create"> & _Body<"users.create">>;
182
+ export type UsersCreateResponse = _Response<"users.create">;
183
+ export type UsersUpdateArgs = Prettify<{
184
+ id: string;
185
+ } & _Query<"users.update"> & _Body<"users.update">>;
186
+ export type UsersUpdateResponse = _Response<"users.update">;
187
+ export type UsersDeleteArgs = Prettify<{
188
+ id: string;
189
+ } & _Query<"users.delete"> & _Body<"users.delete">>;
190
+ export type UsersDeleteResponse = _Response<"users.delete">;
191
+ export type ExamsSessionsListArgs = Prettify<{
192
+ examId: string;
193
+ } & _Query<"exams.sessions.list"> & _Body<"exams.sessions.list">>;
194
+ export type ExamsSessionsListResponse = _Response<"exams.sessions.list">;
195
+ export type ExamsSessionsImportArgs = Prettify<{
196
+ examId: string;
197
+ } & _Query<"exams.sessions.import"> & _Body<"exams.sessions.import">>;
198
+ export type ExamsSessionsImportResponse = _Response<"exams.sessions.import">;
199
+ export type ExamsSessionsScanArgs = Prettify<{
200
+ examId: string;
201
+ } & _Query<"exams.sessions.scan"> & _Body<"exams.sessions.scan">>;
202
+ export type ExamsSessionsScanResponse = _Response<"exams.sessions.scan">;
203
+ export type ExamsSessionsScanDocumentArgs = Prettify<{
204
+ examId: string;
205
+ } & _Query<"exams.sessions.scanDocument"> & _Body<"exams.sessions.scanDocument">>;
206
+ export type ExamsSessionsScanDocumentResponse = _Response<"exams.sessions.scanDocument">;
207
+ export type ExamsSessionsGetArgs = Prettify<{
208
+ examId: string;
209
+ sessionId: string;
210
+ } & _Query<"exams.sessions.get"> & _Body<"exams.sessions.get">>;
211
+ export type ExamsSessionsGetResponse = _Response<"exams.sessions.get">;
212
+ export type ExamsSessionsDeleteArgs = Prettify<{
213
+ examId: string;
214
+ sessionId: string;
215
+ } & _Query<"exams.sessions.delete"> & _Body<"exams.sessions.delete">>;
216
+ export type ExamsSessionsDeleteResponse = _Response<"exams.sessions.delete">;
217
+ export type ExamsSessionsSaveFeedbackArgs = Prettify<{
218
+ examId: string;
219
+ sessionId: string;
220
+ } & _Query<"exams.sessions.saveFeedback"> & _Body<"exams.sessions.saveFeedback">>;
221
+ export type ExamsSessionsSaveFeedbackResponse = _Response<"exams.sessions.saveFeedback">;
222
+ export type ExamsSessionsSaveOverallFeedbackArgs = Prettify<{
223
+ examId: string;
224
+ sessionId: string;
225
+ } & _Query<"exams.sessions.saveOverallFeedback"> & _Body<"exams.sessions.saveOverallFeedback">>;
226
+ export type ExamsSessionsSaveOverallFeedbackResponse = _Response<"exams.sessions.saveOverallFeedback">;
227
+ export type ExamsSessionsGenerateOverallFeedbackArgs = Prettify<{
228
+ examId: string;
229
+ sessionId: string;
230
+ } & _Query<"exams.sessions.generateOverallFeedback"> & _Body<"exams.sessions.generateOverallFeedback">>;
231
+ export type ExamsSessionsGenerateOverallFeedbackResponse = _Response<"exams.sessions.generateOverallFeedback">;
232
+ export type ExamsSessionsAcceptAllSuggestionsArgs = Prettify<{
233
+ examId: string;
234
+ sessionId: string;
235
+ } & _Query<"exams.sessions.acceptAllSuggestions"> & _Body<"exams.sessions.acceptAllSuggestions">>;
236
+ export type ExamsSessionsAcceptAllSuggestionsResponse = _Response<"exams.sessions.acceptAllSuggestions">;
237
+ export type ExamsSessionsAcceptSuggestionArgs = Prettify<{
238
+ examId: string;
239
+ sessionId: string;
240
+ questionId: string;
241
+ } & _Query<"exams.sessions.acceptSuggestion"> & _Body<"exams.sessions.acceptSuggestion">>;
242
+ export type ExamsSessionsAcceptSuggestionResponse = _Response<"exams.sessions.acceptSuggestion">;
243
+ export type ExamsSessionsEditAnswerArgs = Prettify<{
244
+ examId: string;
245
+ sessionId: string;
246
+ questionId: string;
247
+ } & _Query<"exams.sessions.editAnswer"> & _Body<"exams.sessions.editAnswer">>;
248
+ export type ExamsSessionsEditAnswerResponse = _Response<"exams.sessions.editAnswer">;
249
+ export type ExamsQuestionsImportArgs = Prettify<{
250
+ examId: string;
251
+ } & _Query<"exams.questions.import"> & _Body<"exams.questions.import">>;
252
+ export type ExamsQuestionsImportResponse = _Response<"exams.questions.import">;
253
+ export type ExamsQuestionsGenerateArgs = Prettify<{
254
+ examId: string;
255
+ } & _Query<"exams.questions.generate"> & _Body<"exams.questions.generate">>;
256
+ export type ExamsQuestionsGenerateResponse = _Response<"exams.questions.generate">;
257
+ export type ExamsQuestionsGetArgs = Prettify<{
258
+ examId: string;
259
+ questionId: string;
260
+ } & _Query<"exams.questions.get"> & _Body<"exams.questions.get">>;
261
+ export type ExamsQuestionsGetResponse = _Response<"exams.questions.get">;
262
+ export type ExamsQuestionsRegenerateArgs = Prettify<{
263
+ examId: string;
264
+ questionId: string;
265
+ } & _Query<"exams.questions.regenerate"> & _Body<"exams.questions.regenerate">>;
266
+ export type ExamsQuestionsRegenerateResponse = _Response<"exams.questions.regenerate">;
267
+ export type ExamsExportQti3ZipArgs = Prettify<{
268
+ examId: string;
269
+ } & _Query<"exams.export.qti3Zip"> & _Body<"exams.export.qti3Zip">>;
270
+ export type ExamsExportQti3ZipResponse = _Response<"exams.export.qti3Zip">;
271
+ export type ExamsExportQti21ZipArgs = Prettify<{
272
+ examId: string;
273
+ } & _Query<"exams.export.qti21Zip"> & _Body<"exams.export.qti21Zip">>;
274
+ export type ExamsExportQti21ZipResponse = _Response<"exams.export.qti21Zip">;
275
+ export type ExamsListArgs = Prettify<_Query<"exams.list"> & _Body<"exams.list">>;
276
+ export type ExamsListResponse = _Response<"exams.list">;
277
+ export type ExamsCreateArgs = Prettify<_Query<"exams.create"> & _Body<"exams.create">>;
278
+ export type ExamsCreateResponse = _Response<"exams.create">;
279
+ export type ExamsImportArgs = Prettify<_Query<"exams.import"> & _Body<"exams.import">>;
280
+ export type ExamsImportResponse = _Response<"exams.import">;
281
+ export type ExamsGetArgs = Prettify<{
282
+ id: string;
283
+ } & _Query<"exams.get"> & _Body<"exams.get">>;
284
+ export type ExamsGetResponse = _Response<"exams.get">;
285
+ export type ExamsUpdateArgs = Prettify<{
286
+ id: string;
287
+ } & _Query<"exams.update"> & _Body<"exams.update">>;
288
+ export type ExamsUpdateResponse = _Response<"exams.update">;
289
+ export type ExamsDeleteArgs = Prettify<{
290
+ id: string;
291
+ } & _Query<"exams.delete"> & _Body<"exams.delete">>;
292
+ export type ExamsDeleteResponse = _Response<"exams.delete">;
293
+ export type ExamsDuplicateArgs = Prettify<{
294
+ examId: string;
295
+ } & _Query<"exams.duplicate"> & _Body<"exams.duplicate">>;
296
+ export type ExamsDuplicateResponse = _Response<"exams.duplicate">;
297
+ export type ExamsPrintArgs = Prettify<{
298
+ examId: string;
299
+ } & _Query<"exams.print"> & _Body<"exams.print">>;
300
+ export type ExamsPrintResponse = _Response<"exams.print">;
301
+ export type ExamsStartGenerationArgs = Prettify<{
302
+ examId: string;
303
+ } & _Query<"exams.startGeneration"> & _Body<"exams.startGeneration">>;
304
+ export type ExamsStartGenerationResponse = _Response<"exams.startGeneration">;
305
+ export type ExamsCancelGenerationArgs = Prettify<{
306
+ examId: string;
307
+ } & _Query<"exams.cancelGeneration"> & _Body<"exams.cancelGeneration">>;
308
+ export type ExamsCancelGenerationResponse = _Response<"exams.cancelGeneration">;
309
+ export type ExamsGetContextSuggestionsArgs = Prettify<{
310
+ examId: string;
311
+ } & _Query<"exams.getContextSuggestions"> & _Body<"exams.getContextSuggestions">>;
312
+ export type ExamsGetContextSuggestionsResponse = _Response<"exams.getContextSuggestions">;
313
+ export type PracticeSpacesListArgs = Prettify<_Query<"practiceSpaces.list"> & _Body<"practiceSpaces.list">>;
314
+ export type PracticeSpacesListResponse = _Response<"practiceSpaces.list">;
315
+ export type PracticeSpacesCreateArgs = Prettify<_Query<"practiceSpaces.create"> & _Body<"practiceSpaces.create">>;
316
+ export type PracticeSpacesCreateResponse = _Response<"practiceSpaces.create">;
317
+ export type PracticeSpacesGetArgs = Prettify<{
318
+ id: string;
319
+ } & _Query<"practiceSpaces.get"> & _Body<"practiceSpaces.get">>;
320
+ export type PracticeSpacesGetResponse = _Response<"practiceSpaces.get">;
321
+ export type PracticeSpacesUpdateArgs = Prettify<{
322
+ id: string;
323
+ } & _Query<"practiceSpaces.update"> & _Body<"practiceSpaces.update">>;
324
+ export type PracticeSpacesUpdateResponse = _Response<"practiceSpaces.update">;
325
+ export type PracticeSpacesDeleteArgs = Prettify<{
326
+ id: string;
327
+ } & _Query<"practiceSpaces.delete"> & _Body<"practiceSpaces.delete">>;
328
+ export type PracticeSpacesDeleteResponse = _Response<"practiceSpaces.delete">;
329
+ export type PracticeSpacesDuplicateArgs = Prettify<{
330
+ practiceSpaceId: string;
331
+ } & _Query<"practiceSpaces.duplicate"> & _Body<"practiceSpaces.duplicate">>;
332
+ export type PracticeSpacesDuplicateResponse = _Response<"practiceSpaces.duplicate">;
333
+ export type PracticeSpacesGenerateTopicsArgs = Prettify<{
334
+ practiceSpaceId: string;
335
+ } & _Query<"practiceSpaces.generateTopics"> & _Body<"practiceSpaces.generateTopics">>;
336
+ export type PracticeSpacesGenerateTopicsResponse = _Response<"practiceSpaces.generateTopics">;
337
+ export type PracticeSpacesCancelGenerateTopicsArgs = Prettify<{
338
+ practiceSpaceId: string;
339
+ } & _Query<"practiceSpaces.cancelGenerateTopics"> & _Body<"practiceSpaces.cancelGenerateTopics">>;
340
+ export type PracticeSpacesCancelGenerateTopicsResponse = _Response<"practiceSpaces.cancelGenerateTopics">;
341
+ export type PracticeSpacesQuestionsPreviewArgs = Prettify<{
342
+ practiceSpaceId: string;
343
+ } & _Query<"practiceSpaces.questionsPreview"> & _Body<"practiceSpaces.questionsPreview">>;
344
+ export type PracticeSpacesQuestionsPreviewResponse = _Response<"practiceSpaces.questionsPreview">;
345
+ export type PracticeSpacesGetProgressArgs = Prettify<{
346
+ practiceSpaceId: string;
347
+ } & _Query<"practiceSpaces.getProgress"> & _Body<"practiceSpaces.getProgress">>;
348
+ export type PracticeSpacesGetProgressResponse = _Response<"practiceSpaces.getProgress">;
349
+ export type PracticeSpacesGenerateTopicFeedbackArgs = Prettify<{
350
+ practiceSpaceId: string;
351
+ } & _Query<"practiceSpaces.generateTopicFeedback"> & _Body<"practiceSpaces.generateTopicFeedback">>;
352
+ export type PracticeSpacesGenerateTopicFeedbackResponse = _Response<"practiceSpaces.generateTopicFeedback">;
353
+ export type PracticeSpacesStudentsListArgs = Prettify<{
354
+ practiceSpaceId: string;
355
+ } & _Query<"practiceSpaces.students.list"> & _Body<"practiceSpaces.students.list">>;
356
+ export type PracticeSpacesStudentsListResponse = _Response<"practiceSpaces.students.list">;
357
+ export type PracticeSpacesStudentsGetArgs = Prettify<{
358
+ practiceSpaceId: string;
359
+ studentId: string;
360
+ } & _Query<"practiceSpaces.students.get"> & _Body<"practiceSpaces.students.get">>;
361
+ export type PracticeSpacesStudentsGetResponse = _Response<"practiceSpaces.students.get">;
362
+ export type PracticeSpacesSessionsCreateArgs = Prettify<{
363
+ practiceSpaceId: string;
364
+ } & _Query<"practiceSpaces.sessions.create"> & _Body<"practiceSpaces.sessions.create">>;
365
+ export type PracticeSpacesSessionsCreateResponse = _Response<"practiceSpaces.sessions.create">;
366
+ export type PracticeSpacesSessionsGetMineArgs = Prettify<{
367
+ practiceSpaceId: string;
368
+ } & _Query<"practiceSpaces.sessions.getMine"> & _Body<"practiceSpaces.sessions.getMine">>;
369
+ export type PracticeSpacesSessionsGetMineResponse = _Response<"practiceSpaces.sessions.getMine">;
370
+ export type PracticeSpacesSessionsGetArgs = Prettify<{
371
+ practiceSpaceId: string;
372
+ sessionId: string;
373
+ } & _Query<"practiceSpaces.sessions.get"> & _Body<"practiceSpaces.sessions.get">>;
374
+ export type PracticeSpacesSessionsGetResponse = _Response<"practiceSpaces.sessions.get">;
375
+ export type PracticeSpacesSessionsSaveAnswerArgs = Prettify<{
376
+ practiceSpaceId: string;
377
+ sessionId: string;
378
+ questionId: string;
379
+ } & _Query<"practiceSpaces.sessions.saveAnswer"> & _Body<"practiceSpaces.sessions.saveAnswer">>;
380
+ export type PracticeSpacesSessionsSaveAnswerResponse = _Response<"practiceSpaces.sessions.saveAnswer">;
381
+ export type SourceMaterialsListArgs = Prettify<_Query<"sourceMaterials.list"> & _Body<"sourceMaterials.list">>;
382
+ export type SourceMaterialsListResponse = _Response<"sourceMaterials.list">;
383
+ export type SourceMaterialsCreateArgs = Prettify<_Query<"sourceMaterials.create"> & _Body<"sourceMaterials.create">>;
384
+ export type SourceMaterialsCreateResponse = _Response<"sourceMaterials.create">;
385
+ export type SourceMaterialsGetArgs = Prettify<{
386
+ id: string;
387
+ } & _Query<"sourceMaterials.get"> & _Body<"sourceMaterials.get">>;
388
+ export type SourceMaterialsGetResponse = _Response<"sourceMaterials.get">;
389
+ export type SourceMaterialsUpdateArgs = Prettify<{
390
+ id: string;
391
+ } & _Query<"sourceMaterials.update"> & _Body<"sourceMaterials.update">>;
392
+ export type SourceMaterialsUpdateResponse = _Response<"sourceMaterials.update">;
393
+ export type SourceMaterialsDeleteArgs = Prettify<{
394
+ id: string;
395
+ } & _Query<"sourceMaterials.delete"> & _Body<"sourceMaterials.delete">>;
396
+ export type SourceMaterialsDeleteResponse = _Response<"sourceMaterials.delete">;
397
+ export type SourceMaterialsSliceArgs = Prettify<{
398
+ sourceMaterialId: string;
399
+ } & _Query<"sourceMaterials.slice"> & _Body<"sourceMaterials.slice">>;
400
+ export type SourceMaterialsSliceResponse = _Response<"sourceMaterials.slice">;
401
+ export type FoldersListArgs = Prettify<_Query<"folders.list"> & _Body<"folders.list">>;
402
+ export type FoldersListResponse = _Response<"folders.list">;
403
+ export type FoldersCreateArgs = Prettify<_Query<"folders.create"> & _Body<"folders.create">>;
404
+ export type FoldersCreateResponse = _Response<"folders.create">;
405
+ export type FoldersUpdateArgs = Prettify<{
406
+ id: string;
407
+ } & _Query<"folders.update"> & _Body<"folders.update">>;
408
+ export type FoldersUpdateResponse = _Response<"folders.update">;
409
+ export type FoldersDeleteArgs = Prettify<{
410
+ id: string;
411
+ } & _Query<"folders.delete"> & _Body<"folders.delete">>;
412
+ export type FoldersDeleteResponse = _Response<"folders.delete">;
413
+ export type GroupsListArgs = Prettify<_Query<"groups.list"> & _Body<"groups.list">>;
414
+ export type GroupsListResponse = _Response<"groups.list">;
415
+ export type GroupsCreateArgs = Prettify<_Query<"groups.create"> & _Body<"groups.create">>;
416
+ export type GroupsCreateResponse = _Response<"groups.create">;
417
+ export type GroupsUpdateArgs = Prettify<{
418
+ id: string;
419
+ } & _Query<"groups.update"> & _Body<"groups.update">>;
420
+ export type GroupsUpdateResponse = _Response<"groups.update">;
421
+ export type GroupsDeleteArgs = Prettify<{
422
+ id: string;
423
+ } & _Query<"groups.delete"> & _Body<"groups.delete">>;
424
+ export type GroupsDeleteResponse = _Response<"groups.delete">;
425
+ export type GroupsListMembersArgs = Prettify<{
426
+ groupId: string;
427
+ } & _Query<"groups.listMembers"> & _Body<"groups.listMembers">>;
428
+ export type GroupsListMembersResponse = _Response<"groups.listMembers">;
429
+ export type GroupsAddMemberArgs = Prettify<{
430
+ groupId: string;
431
+ } & _Query<"groups.addMember"> & _Body<"groups.addMember">>;
432
+ export type GroupsAddMemberResponse = _Response<"groups.addMember">;
433
+ export type GroupsUpdateMemberArgs = Prettify<{
434
+ groupId: string;
435
+ userId: string;
436
+ } & _Query<"groups.updateMember"> & _Body<"groups.updateMember">>;
437
+ export type GroupsUpdateMemberResponse = _Response<"groups.updateMember">;
438
+ export type GroupsRemoveMemberArgs = Prettify<{
439
+ groupId: string;
440
+ userId: string;
441
+ } & _Query<"groups.removeMember"> & _Body<"groups.removeMember">>;
442
+ export type GroupsRemoveMemberResponse = _Response<"groups.removeMember">;
443
+ export type QuestionBankListArgs = Prettify<_Query<"questionBank.list"> & _Body<"questionBank.list">>;
444
+ export type QuestionBankListResponse = _Response<"questionBank.list">;
445
+ export type QuestionBankCreateArgs = Prettify<_Query<"questionBank.create"> & _Body<"questionBank.create">>;
446
+ export type QuestionBankCreateResponse = _Response<"questionBank.create">;
447
+ export type QuestionBankUpdateArgs = Prettify<{
448
+ id: string;
449
+ } & _Query<"questionBank.update"> & _Body<"questionBank.update">>;
450
+ export type QuestionBankUpdateResponse = _Response<"questionBank.update">;
451
+ export type QuestionBankDeleteArgs = Prettify<{
452
+ id: string;
453
+ } & _Query<"questionBank.delete"> & _Body<"questionBank.delete">>;
454
+ export type QuestionBankDeleteResponse = _Response<"questionBank.delete">;
455
+ export type GetRubricsArgs = Prettify<_Query<"getRubrics"> & _Body<"getRubrics">>;
456
+ export type GetRubricsResponse = _Response<"getRubrics">;
457
+ export type PostRubricsArgs = Prettify<_Query<"postRubrics"> & _Body<"postRubrics">>;
458
+ export type PostRubricsResponse = _Response<"postRubrics">;
459
+ export type PostRubricsGenerateArgs = Prettify<_Query<"postRubricsGenerate"> & _Body<"postRubricsGenerate">>;
460
+ export type PostRubricsGenerateResponse = _Response<"postRubricsGenerate">;
461
+ export type PatchRubricsIdArgs = Prettify<{
462
+ id: string;
463
+ } & _Query<"patchRubrics:id"> & _Body<"patchRubrics:id">>;
464
+ export type PatchRubricsIdResponse = _Response<"patchRubrics:id">;
465
+ export type DeleteRubricsIdArgs = Prettify<{
466
+ id: string;
467
+ } & _Query<"deleteRubrics:id"> & _Body<"deleteRubrics:id">>;
468
+ export type DeleteRubricsIdResponse = _Response<"deleteRubrics:id">;
469
+ export type JobsGetArgs = Prettify<{
470
+ id: string;
471
+ } & _Query<"jobs.get"> & _Body<"jobs.get">>;
472
+ export type JobsGetResponse = _Response<"jobs.get">;
473
+ export type JobsCancelArgs = Prettify<{
474
+ id: string;
475
+ } & _Query<"jobs.cancel"> & _Body<"jobs.cancel">>;
476
+ export type JobsCancelResponse = _Response<"jobs.cancel">;
477
+ export declare class QuestionTypes {
478
+ private readonly ctx;
479
+ constructor(ctx: ClientContext);
480
+ /**
481
+ * List public question types
482
+ *
483
+ * Lists all public question types, which can be enabled in workspaces.
484
+ *
485
+ * API endpoint: `GET /question-types/public`
486
+ */
487
+ listPublic(args?: QuestionTypesListPublicArgs, options?: ExamplaryRequestOptions): Promise<QuestionTypesListPublicResponse>;
488
+ /**
489
+ * Get question type
490
+ *
491
+ * Retrieves a specific question type by its ID.
492
+ *
493
+ * API endpoint: `GET /question-types/{id}`
494
+ */
495
+ get(id: string, options?: ExamplaryRequestOptions): Promise<QuestionTypesGetResponse>;
496
+ get(args: QuestionTypesGetArgs, options?: ExamplaryRequestOptions): Promise<QuestionTypesGetResponse>;
497
+ /**
498
+ * Delete question type
499
+ *
500
+ * 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.
501
+ *
502
+ * API endpoint: `DELETE /question-types/{id}`
503
+ */
504
+ delete(id: string, options?: ExamplaryRequestOptions): Promise<QuestionTypesDeleteResponse>;
505
+ delete(args: QuestionTypesDeleteArgs, options?: ExamplaryRequestOptions): Promise<QuestionTypesDeleteResponse>;
506
+ /**
507
+ * Get question type PCI module for QTI 3 export
508
+ *
509
+ * Get JS module for a question type PCI for QTI 3 export.
510
+ *
511
+ * API endpoint: `GET /question-types/{questionTypeId}/export/qti3-pci`
512
+ */
513
+ getQti3Pci(questionTypeId: string, options?: ExamplaryRequestOptions): Promise<QuestionTypesGetQti3PciResponse>;
514
+ getQti3Pci(args: QuestionTypesGetQti3PciArgs, options?: ExamplaryRequestOptions): Promise<QuestionTypesGetQti3PciResponse>;
515
+ /**
516
+ * List question types
517
+ *
518
+ * Lists all question types, either those available by default or those created within the user's organization.
519
+ *
520
+ * API endpoint: `GET /question-types`
521
+ */
522
+ list(args?: QuestionTypesListArgs, options?: ExamplaryRequestOptions): Promise<QuestionTypesListResponse>;
523
+ /**
524
+ * Upsert question type
525
+ *
526
+ * 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.
527
+ *
528
+ * API endpoint: `POST /question-types`
529
+ */
530
+ upsert(args?: QuestionTypesUpsertArgs, options?: ExamplaryRequestOptions): Promise<QuestionTypesUpsertResponse>;
531
+ /**
532
+ * Enable question type
533
+ *
534
+ * Enable a question type for the current workspace.
535
+ *
536
+ * API endpoint: `POST /question-types/{questionTypeId}/enable`
537
+ */
538
+ enable(questionTypeId: string, options?: ExamplaryRequestOptions): Promise<QuestionTypesEnableResponse>;
539
+ enable(args: QuestionTypesEnableArgs, options?: ExamplaryRequestOptions): Promise<QuestionTypesEnableResponse>;
540
+ /**
541
+ * Disable question type
542
+ *
543
+ * Disable a question type for the current workspace.
544
+ *
545
+ * API endpoint: `POST /question-types/{questionTypeId}/disable`
546
+ */
547
+ disable(questionTypeId: string, options?: ExamplaryRequestOptions): Promise<QuestionTypesDisableResponse>;
548
+ disable(args: QuestionTypesDisableArgs, options?: ExamplaryRequestOptions): Promise<QuestionTypesDisableResponse>;
549
+ }
550
+ export declare class LibraryPublishersItems {
551
+ private readonly ctx;
552
+ constructor(ctx: ClientContext);
553
+ /**
554
+ * List items by publisher
555
+ *
556
+ * Lists all library items for the specified publisher profile.
557
+ *
558
+ * API endpoint: `GET /library/publishers/{publisherId}/items`
559
+ */
560
+ list(publisherId: string, options?: ExamplaryRequestOptions): Promise<LibraryPublishersItemsListResponse>;
561
+ list(args: LibraryPublishersItemsListArgs, options?: ExamplaryRequestOptions): Promise<LibraryPublishersItemsListResponse>;
562
+ /**
563
+ * Create library item
564
+ *
565
+ * Adds an item to the library. Only the publisher owner can add items to their publisher profile.
566
+ *
567
+ * API endpoint: `POST /library/publishers/{publisherId}/items`
568
+ */
569
+ create(args: LibraryPublishersItemsCreateArgs, options?: ExamplaryRequestOptions): Promise<LibraryPublishersItemsCreateResponse>;
570
+ }
571
+ export declare class LibraryPublishers {
572
+ private readonly ctx;
573
+ constructor(ctx: ClientContext);
574
+ readonly items: LibraryPublishersItems;
575
+ /**
576
+ * List featured publishers
577
+ *
578
+ * Lists all library publishers that are marked as featured.
579
+ *
580
+ * API endpoint: `GET /library/publishers/featured`
581
+ */
582
+ listFeatured(args?: LibraryPublishersListFeaturedArgs, options?: ExamplaryRequestOptions): Promise<LibraryPublishersListFeaturedResponse>;
583
+ /**
584
+ * List all publishers
585
+ *
586
+ * Lists all library publisher profiles.
587
+ *
588
+ * API endpoint: `GET /library/publishers`
589
+ */
590
+ listAll(args?: LibraryPublishersListAllArgs, options?: ExamplaryRequestOptions): Promise<LibraryPublishersListAllResponse>;
591
+ /**
592
+ * Create publisher
593
+ *
594
+ * Creates a new library publisher profile.
595
+ *
596
+ * API endpoint: `POST /library/publishers`
597
+ */
598
+ create(args?: LibraryPublishersCreateArgs, options?: ExamplaryRequestOptions): Promise<LibraryPublishersCreateResponse>;
599
+ /**
600
+ * List my publishers
601
+ *
602
+ * Lists all library publisher profiles created by the authenticated user.
603
+ *
604
+ * API endpoint: `GET /library/publishers/mine`
605
+ */
606
+ listMine(args?: LibraryPublishersListMineArgs, options?: ExamplaryRequestOptions): Promise<LibraryPublishersListMineResponse>;
607
+ /**
608
+ * Update publisher
609
+ *
610
+ * Updates a library publisher profile. Only the owner can update their publisher profile.
611
+ *
612
+ * API endpoint: `PATCH /library/publishers/{publisherId}`
613
+ */
614
+ update(args: LibraryPublishersUpdateArgs, options?: ExamplaryRequestOptions): Promise<LibraryPublishersUpdateResponse>;
615
+ /**
616
+ * Delete publisher
617
+ *
618
+ * Deletes a library publisher profile. Only the owner can delete their publisher profile.
619
+ *
620
+ * API endpoint: `DELETE /library/publishers/{publisherId}`
621
+ */
622
+ delete(publisherId: string, options?: ExamplaryRequestOptions): Promise<LibraryPublishersDeleteResponse>;
623
+ delete(args: LibraryPublishersDeleteArgs, options?: ExamplaryRequestOptions): Promise<LibraryPublishersDeleteResponse>;
624
+ }
625
+ export declare class LibraryItems {
626
+ private readonly ctx;
627
+ constructor(ctx: ClientContext);
628
+ /**
629
+ * List featured library items
630
+ *
631
+ * Lists all library items that are marked as featured.
632
+ *
633
+ * API endpoint: `GET /library/items/featured`
634
+ */
635
+ listFeatured(args?: LibraryItemsListFeaturedArgs, options?: ExamplaryRequestOptions): Promise<LibraryItemsListFeaturedResponse>;
636
+ /**
637
+ * Update library item
638
+ *
639
+ * Updates a library item. Only the publisher owner can update items in their publisher profile.
640
+ *
641
+ * API endpoint: `PATCH /library/items/{itemId}`
642
+ */
643
+ update(args: LibraryItemsUpdateArgs, options?: ExamplaryRequestOptions): Promise<LibraryItemsUpdateResponse>;
644
+ /**
645
+ * Delete library item
646
+ *
647
+ * Deletes a library item. Only the publisher owner can delete items from their publisher profile.
648
+ *
649
+ * API endpoint: `DELETE /library/items/{itemId}`
650
+ */
651
+ delete(itemId: string, options?: ExamplaryRequestOptions): Promise<LibraryItemsDeleteResponse>;
652
+ delete(args: LibraryItemsDeleteArgs, options?: ExamplaryRequestOptions): Promise<LibraryItemsDeleteResponse>;
653
+ }
654
+ export declare class Library {
655
+ private readonly ctx;
656
+ constructor(ctx: ClientContext);
657
+ readonly publishers: LibraryPublishers;
658
+ readonly items: LibraryItems;
659
+ }
660
+ export declare class Oauth {
661
+ private readonly ctx;
662
+ constructor(ctx: ClientContext);
663
+ /**
664
+ * OAuth authorization endpoint
665
+ *
666
+ * Initiates OAuth authorization flow. Redirects to the frontend authorization UI where users can approve or deny access.
667
+ *
668
+ * API endpoint: `GET /oauth/authorize`
669
+ */
670
+ authorize(args: OauthAuthorizeArgs, options?: ExamplaryRequestOptions): Promise<OauthAuthorizeResponse>;
671
+ /**
672
+ * OAuth token endpoint
673
+ *
674
+ * Exchange authorization code for access token, or refresh an existing token.
675
+ *
676
+ * API endpoint: `POST /oauth/token`
677
+ */
678
+ token(args?: OauthTokenArgs, options?: ExamplaryRequestOptions): Promise<OauthTokenResponse>;
679
+ }
680
+ export declare class EmbedSessions {
681
+ private readonly ctx;
682
+ constructor(ctx: ClientContext);
683
+ /**
684
+ * Create embed session
685
+ *
686
+ * Create a new embed session. This allows you to embed the exam generation flow into your own application.
687
+ *
688
+ * API endpoint: `POST /embed-sessions`
689
+ */
690
+ create(args?: EmbedSessionsCreateArgs, options?: ExamplaryRequestOptions): Promise<EmbedSessionsCreateResponse>;
691
+ /**
692
+ * Get embed session
693
+ *
694
+ * Retrieve an embed session by its ID.
695
+ *
696
+ * API endpoint: `GET /embed-sessions/{id}`
697
+ */
698
+ get(id: string, options?: ExamplaryRequestOptions): Promise<EmbedSessionsGetResponse>;
699
+ get(args: EmbedSessionsGetArgs, options?: ExamplaryRequestOptions): Promise<EmbedSessionsGetResponse>;
700
+ /**
701
+ * Revoke embed session
702
+ *
703
+ * Revoke access to an embed session by its ID.
704
+ *
705
+ * API endpoint: `DELETE /embed-sessions/{id}`
706
+ */
707
+ revoke(id: string, options?: ExamplaryRequestOptions): Promise<EmbedSessionsRevokeResponse>;
708
+ revoke(args: EmbedSessionsRevokeArgs, options?: ExamplaryRequestOptions): Promise<EmbedSessionsRevokeResponse>;
709
+ }
710
+ export declare class Me {
711
+ private readonly ctx;
712
+ constructor(ctx: ClientContext);
713
+ /**
714
+ * Get me
715
+ *
716
+ * Get the current user's account details.
717
+ *
718
+ * API endpoint: `GET /me`
719
+ */
720
+ get(args?: MeGetArgs, options?: ExamplaryRequestOptions): Promise<MeGetResponse>;
721
+ /**
722
+ * Update me
723
+ *
724
+ * Update the current user's account details.
725
+ *
726
+ * API endpoint: `PATCH /me`
727
+ */
728
+ update(args?: MeUpdateArgs, options?: ExamplaryRequestOptions): Promise<MeUpdateResponse>;
729
+ }
730
+ export declare class Media {
731
+ private readonly ctx;
732
+ constructor(ctx: ClientContext);
733
+ /**
734
+ * Get file upload URL
735
+ *
736
+ * Returns a signed URL for uploading a file, and a public URL for accessing it afterwards.
737
+ *
738
+ * API endpoint: `GET /media/upload`
739
+ */
740
+ upload(args: MediaUploadArgs, options?: ExamplaryRequestOptions): Promise<MediaUploadResponse>;
741
+ }
742
+ export declare class OrgCustomDomain {
743
+ private readonly ctx;
744
+ constructor(ctx: ClientContext);
745
+ /**
746
+ * Get custom domain configuration
747
+ *
748
+ * API endpoint: `GET /org/custom-domain`
749
+ */
750
+ get(args?: OrgCustomDomainGetArgs, options?: ExamplaryRequestOptions): Promise<OrgCustomDomainGetResponse>;
751
+ /**
752
+ * Update custom domain configuration
753
+ *
754
+ * API endpoint: `POST /org/custom-domain`
755
+ */
756
+ update(args?: OrgCustomDomainUpdateArgs, options?: ExamplaryRequestOptions): Promise<OrgCustomDomainUpdateResponse>;
757
+ }
758
+ export declare class Org {
759
+ private readonly ctx;
760
+ constructor(ctx: ClientContext);
761
+ readonly customDomain: OrgCustomDomain;
762
+ /**
763
+ * Get organization
764
+ *
765
+ * API endpoint: `GET /org`
766
+ */
767
+ get(args?: OrgGetArgs, options?: ExamplaryRequestOptions): Promise<OrgGetResponse>;
768
+ /**
769
+ * Update organization
770
+ *
771
+ * API endpoint: `PATCH /org`
772
+ */
773
+ update(args?: OrgUpdateArgs, options?: ExamplaryRequestOptions): Promise<OrgUpdateResponse>;
774
+ /**
775
+ * Delete organization
776
+ *
777
+ * API endpoint: `DELETE /org`
778
+ */
779
+ delete(args?: OrgDeleteArgs, options?: ExamplaryRequestOptions): Promise<OrgDeleteResponse>;
780
+ }
781
+ export declare class Orgs {
782
+ private readonly ctx;
783
+ constructor(ctx: ClientContext);
784
+ /**
785
+ * List all organizations
786
+ *
787
+ * API endpoint: `GET /orgs`
788
+ */
789
+ list(args?: OrgsListArgs, options?: ExamplaryRequestOptions): Promise<OrgsListResponse>;
790
+ /**
791
+ * Create a new organization
792
+ *
793
+ * Create a new workspace to collaborate with others on exams.
794
+ *
795
+ * API endpoint: `POST /orgs`
796
+ */
797
+ create(args?: OrgsCreateArgs, options?: ExamplaryRequestOptions): Promise<OrgsCreateResponse>;
798
+ }
799
+ export declare class ApiKeys {
800
+ private readonly ctx;
801
+ constructor(ctx: ClientContext);
802
+ /**
803
+ * Get API key
804
+ *
805
+ * Get the API key for the current org/user combination. Creates one if none exists.
806
+ *
807
+ * API endpoint: `GET /api-keys`
808
+ */
809
+ get(args?: ApiKeysGetArgs, options?: ExamplaryRequestOptions): Promise<ApiKeysGetResponse>;
810
+ /**
811
+ * Reset API key
812
+ *
813
+ * Invalidate old API keys for this org/user and create a new one.
814
+ *
815
+ * API endpoint: `POST /api-keys/reset`
816
+ */
817
+ reset(args?: ApiKeysResetArgs, options?: ExamplaryRequestOptions): Promise<ApiKeysResetResponse>;
818
+ }
819
+ export declare class Attributes {
820
+ private readonly ctx;
821
+ constructor(ctx: ClientContext);
822
+ /**
823
+ * List attributes
824
+ *
825
+ * Get all custom attributes configured for the current workspace.
826
+ *
827
+ * API endpoint: `GET /attributes`
828
+ */
829
+ list(args?: AttributesListArgs, options?: ExamplaryRequestOptions): Promise<AttributesListResponse>;
830
+ /**
831
+ * Create attribute
832
+ *
833
+ * Create a new custom attribute in the current workspace.
834
+ *
835
+ * API endpoint: `POST /attributes`
836
+ */
837
+ create(args?: AttributesCreateArgs, options?: ExamplaryRequestOptions): Promise<AttributesCreateResponse>;
838
+ /**
839
+ * Reorder attributes
840
+ *
841
+ * Update the position of multiple attributes at once.
842
+ *
843
+ * API endpoint: `POST /attributes/reorder`
844
+ */
845
+ reorder(args?: AttributesReorderArgs, options?: ExamplaryRequestOptions): Promise<AttributesReorderResponse>;
846
+ /**
847
+ * Update attribute
848
+ *
849
+ * Update an existing attribute in the current workspace.
850
+ *
851
+ * API endpoint: `POST /attributes/{id}`
852
+ */
853
+ update(args: AttributesUpdateArgs, options?: ExamplaryRequestOptions): Promise<AttributesUpdateResponse>;
854
+ /**
855
+ * Delete attribute
856
+ *
857
+ * Delete a custom attribute from the current workspace. Default attributes cannot be deleted.
858
+ *
859
+ * API endpoint: `DELETE /attributes/{id}`
860
+ */
861
+ delete(id: string, options?: ExamplaryRequestOptions): Promise<AttributesDeleteResponse>;
862
+ delete(args: AttributesDeleteArgs, options?: ExamplaryRequestOptions): Promise<AttributesDeleteResponse>;
863
+ }
864
+ export declare class Taxonomies {
865
+ private readonly ctx;
866
+ constructor(ctx: ClientContext);
867
+ /**
868
+ * Get taxonomies
869
+ *
870
+ * Get a list available taxonomies, including defaults and taxonomies created in the current workspace.
871
+ *
872
+ * API endpoint: `GET /taxonomies`
873
+ */
874
+ list(args?: TaxonomiesListArgs, options?: ExamplaryRequestOptions): Promise<TaxonomiesListResponse>;
875
+ /**
876
+ * Create taxonomy
877
+ *
878
+ * Save a new taxonomy in the current workspace.
879
+ *
880
+ * API endpoint: `POST /taxonomies`
881
+ */
882
+ create(args?: TaxonomiesCreateArgs, options?: ExamplaryRequestOptions): Promise<TaxonomiesCreateResponse>;
883
+ /**
884
+ * Update taxonomy
885
+ *
886
+ * Update an existing taxonomy in the current workspace.
887
+ *
888
+ * API endpoint: `POST /taxonomies/{id}`
889
+ */
890
+ update(args: TaxonomiesUpdateArgs, options?: ExamplaryRequestOptions): Promise<TaxonomiesUpdateResponse>;
891
+ /**
892
+ * Delete taxonomy
893
+ *
894
+ * Delete a taxonomy from the current workspace. This fails if there are any exams associated with the taxonomy.
895
+ *
896
+ * API endpoint: `DELETE /taxonomies/{id}`
897
+ */
898
+ delete(id: string, options?: ExamplaryRequestOptions): Promise<TaxonomiesDeleteResponse>;
899
+ delete(args: TaxonomiesDeleteArgs, options?: ExamplaryRequestOptions): Promise<TaxonomiesDeleteResponse>;
900
+ }
901
+ export declare class Permissions {
902
+ private readonly ctx;
903
+ constructor(ctx: ClientContext);
904
+ /**
905
+ * Autocomplete users and groups
906
+ *
907
+ * Search for users and groups to share with. Returns matches by name or email. Respects restricted group visibility.
908
+ *
909
+ * API endpoint: `GET /permissions/autocomplete`
910
+ */
911
+ autocomplete(args: PermissionsAutocompleteArgs, options?: ExamplaryRequestOptions): Promise<PermissionsAutocompleteResponse>;
912
+ /**
913
+ * Get sharing permissions
914
+ *
915
+ * Get a list of users, groups and orgs that have access to a specific resource.
916
+ *
917
+ * API endpoint: `GET /permissions/{resource}`
918
+ */
919
+ list(resource: string, options?: ExamplaryRequestOptions): Promise<PermissionsListResponse>;
920
+ list(args: PermissionsListArgs, options?: ExamplaryRequestOptions): Promise<PermissionsListResponse>;
921
+ /**
922
+ * Create permission
923
+ *
924
+ * Create a new permission for a specific resource, or update the role of an existing actor.
925
+ *
926
+ * API endpoint: `POST /permissions/{resource}`
927
+ */
928
+ assign(args: PermissionsAssignArgs, options?: ExamplaryRequestOptions): Promise<PermissionsAssignResponse>;
929
+ /**
930
+ * Get actor role
931
+ *
932
+ * Get the role of a specific actor for a specific resource.
933
+ *
934
+ * API endpoint: `GET /permissions/{resource}/{actor}`
935
+ */
936
+ getActorRole(args: PermissionsGetActorRoleArgs, options?: ExamplaryRequestOptions): Promise<PermissionsGetActorRoleResponse>;
937
+ /**
938
+ * Remove permission
939
+ *
940
+ * Remove a permission for a specific actor on a specific resource.
941
+ *
942
+ * API endpoint: `DELETE /permissions/{resource}/{actor}`
943
+ */
944
+ delete(args: PermissionsDeleteArgs, options?: ExamplaryRequestOptions): Promise<PermissionsDeleteResponse>;
945
+ }
946
+ export declare class StudentLevels {
947
+ private readonly ctx;
948
+ constructor(ctx: ClientContext);
949
+ /**
950
+ * List available student levels
951
+ *
952
+ * Get a list of available default student levels.
953
+ *
954
+ * API endpoint: `GET /student-levels`
955
+ */
956
+ list(args?: StudentLevelsListArgs, options?: ExamplaryRequestOptions): Promise<StudentLevelsListResponse>;
957
+ }
958
+ export declare class Users {
959
+ private readonly ctx;
960
+ constructor(ctx: ClientContext);
961
+ /**
962
+ * List users
963
+ *
964
+ * Get a list of all users in the workspace.
965
+ *
966
+ * API endpoint: `GET /users`
967
+ */
968
+ list(args?: UsersListArgs, options?: ExamplaryRequestOptions): Promise<UsersListResponse>;
969
+ /**
970
+ * Create user
971
+ *
972
+ * Create a new user in the workspace.
973
+ *
974
+ * API endpoint: `POST /users`
975
+ */
976
+ create(args?: UsersCreateArgs, options?: ExamplaryRequestOptions): Promise<UsersCreateResponse>;
977
+ /**
978
+ * Update user role
979
+ *
980
+ * Update a user's role within the workspace.
981
+ *
982
+ * API endpoint: `PATCH /users/{id}`
983
+ */
984
+ update(id: string, options?: ExamplaryRequestOptions): Promise<UsersUpdateResponse>;
985
+ update(args: UsersUpdateArgs, options?: ExamplaryRequestOptions): Promise<UsersUpdateResponse>;
986
+ /**
987
+ * Delete user
988
+ *
989
+ * Delete a user from the workspace.
990
+ *
991
+ * API endpoint: `DELETE /users/{id}`
992
+ */
993
+ delete(id: string, options?: ExamplaryRequestOptions): Promise<UsersDeleteResponse>;
994
+ delete(args: UsersDeleteArgs, options?: ExamplaryRequestOptions): Promise<UsersDeleteResponse>;
995
+ }
996
+ export declare class ExamsSessions {
997
+ private readonly ctx;
998
+ constructor(ctx: ClientContext);
999
+ /**
1000
+ * List exam sessions
1001
+ *
1002
+ * Get a list of all student sessions for an exam, representing a set of answers from a student.
1003
+ *
1004
+ * API endpoint: `GET /exams/{examId}/sessions`
1005
+ */
1006
+ list(examId: string, options?: ExamplaryRequestOptions): Promise<ExamsSessionsListResponse>;
1007
+ list(args: ExamsSessionsListArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsListResponse>;
1008
+ /**
1009
+ * Create session
1010
+ *
1011
+ * Manually create a session, possibly from uploaded data.
1012
+ *
1013
+ * API endpoint: `POST /exams/{examId}/sessions`
1014
+ */
1015
+ import(args: ExamsSessionsImportArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsImportResponse>;
1016
+ /**
1017
+ * Get answers from scan
1018
+ *
1019
+ * Scan student answers from a document.
1020
+ *
1021
+ * API endpoint: `POST /exams/{examId}/sessions/scan`
1022
+ */
1023
+ scan(examId: string, options?: ExamplaryRequestOptions): Promise<ExamsSessionsScanResponse>;
1024
+ scan(args: ExamsSessionsScanArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsScanResponse>;
1025
+ /**
1026
+ * Scan document for student answers
1027
+ *
1028
+ * Start a background task to extract student answers from an uploaded PDF document.
1029
+ *
1030
+ * API endpoint: `POST /exams/{examId}/sessions/scan-document`
1031
+ */
1032
+ scanDocument(args: ExamsSessionsScanDocumentArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsScanDocumentResponse>;
1033
+ /**
1034
+ * Get exam session
1035
+ *
1036
+ * Get a single exam session by its ID, representing a set of answers from a student.
1037
+ *
1038
+ * API endpoint: `GET /exams/{examId}/sessions/{sessionId}`
1039
+ */
1040
+ get(args: ExamsSessionsGetArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsGetResponse>;
1041
+ /**
1042
+ * Delete exam session
1043
+ *
1044
+ * Remove an exam session.
1045
+ *
1046
+ * API endpoint: `DELETE /exams/{examId}/sessions/{sessionId}`
1047
+ */
1048
+ delete(args: ExamsSessionsDeleteArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsDeleteResponse>;
1049
+ /**
1050
+ * Provide feedback
1051
+ *
1052
+ * Set teacher feedback and/or a grade for a specific question in an exam session.
1053
+ *
1054
+ * API endpoint: `POST /exams/{examId}/sessions/{sessionId}/feedback`
1055
+ */
1056
+ saveFeedback(args: ExamsSessionsSaveFeedbackArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsSaveFeedbackResponse>;
1057
+ /**
1058
+ * Provide overall feedback
1059
+ *
1060
+ * Set teacher feedback for the test as a whole in an exam session.
1061
+ *
1062
+ * API endpoint: `POST /exams/{examId}/sessions/{sessionId}/overall-feedback`
1063
+ */
1064
+ saveOverallFeedback(args: ExamsSessionsSaveOverallFeedbackArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsSaveOverallFeedbackResponse>;
1065
+ /**
1066
+ * Generate overall feedback
1067
+ *
1068
+ * Generate feedback for the test as a whole in an exam session.
1069
+ *
1070
+ * API endpoint: `POST /exams/{examId}/sessions/{sessionId}/generate-overall-feedback`
1071
+ */
1072
+ generateOverallFeedback(args: ExamsSessionsGenerateOverallFeedbackArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsGenerateOverallFeedbackResponse>;
1073
+ /**
1074
+ * Accept AI grading suggestions
1075
+ *
1076
+ * Accept all AI-generated grading suggestions for the exam session.
1077
+ *
1078
+ * API endpoint: `POST /exams/{examId}/sessions/{sessionId}/suggestions/accept-all`
1079
+ */
1080
+ acceptAllSuggestions(args: ExamsSessionsAcceptAllSuggestionsArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsAcceptAllSuggestionsResponse>;
1081
+ /**
1082
+ * Accept single AI grading suggestion
1083
+ *
1084
+ * Accept a single AI-generated grading suggestion for the exam session.
1085
+ *
1086
+ * API endpoint: `POST /exams/{examId}/sessions/{sessionId}/suggestions/{questionId}/accept`
1087
+ */
1088
+ acceptSuggestion(args: ExamsSessionsAcceptSuggestionArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsAcceptSuggestionResponse>;
1089
+ /**
1090
+ * Edit answer
1091
+ *
1092
+ * Edit a single answer in an exam session.
1093
+ *
1094
+ * API endpoint: `PATCH /exams/{examId}/sessions/{sessionId}/answers/{questionId}`
1095
+ */
1096
+ editAnswer(args: ExamsSessionsEditAnswerArgs, options?: ExamplaryRequestOptions): Promise<ExamsSessionsEditAnswerResponse>;
1097
+ }
1098
+ export declare class ExamsQuestions {
1099
+ private readonly ctx;
1100
+ constructor(ctx: ClientContext);
1101
+ /**
1102
+ * Import questions
1103
+ *
1104
+ * Import questions into an exam from a file. Support Word, PDF, Moodle quiz XML and plain text files.
1105
+ *
1106
+ * API endpoint: `POST /exams/{examId}/questions/import`
1107
+ */
1108
+ import(args: ExamsQuestionsImportArgs, options?: ExamplaryRequestOptions): Promise<ExamsQuestionsImportResponse>;
1109
+ /**
1110
+ * Generate question
1111
+ *
1112
+ * Generate a new question for the exam using an AI prompt.
1113
+ *
1114
+ * API endpoint: `POST /exams/{examId}/questions/generate`
1115
+ */
1116
+ generate(args: ExamsQuestionsGenerateArgs, options?: ExamplaryRequestOptions): Promise<ExamsQuestionsGenerateResponse>;
1117
+ /**
1118
+ * Get question
1119
+ *
1120
+ * Retrieve a question by its ID.
1121
+ *
1122
+ * API endpoint: `GET /exams/{examId}/questions/{questionId}`
1123
+ */
1124
+ get(args: ExamsQuestionsGetArgs, options?: ExamplaryRequestOptions): Promise<ExamsQuestionsGetResponse>;
1125
+ /**
1126
+ * Regenerate question
1127
+ *
1128
+ * Update a question using an AI prompt.
1129
+ *
1130
+ * API endpoint: `POST /exams/{examId}/questions/{questionId}/generate`
1131
+ */
1132
+ regenerate(args: ExamsQuestionsRegenerateArgs, options?: ExamplaryRequestOptions): Promise<ExamsQuestionsRegenerateResponse>;
1133
+ }
1134
+ export declare class ExamsExport {
1135
+ private readonly ctx;
1136
+ constructor(ctx: ClientContext);
1137
+ /**
1138
+ * Export QTI 3 package
1139
+ *
1140
+ * Export an exam as a QTI 3 ZIP package.
1141
+ *
1142
+ * API endpoint: `POST /exams/{examId}/export/qti3-zip`
1143
+ */
1144
+ qti3Zip(examId: string, options?: ExamplaryRequestOptions): Promise<ExamsExportQti3ZipResponse>;
1145
+ qti3Zip(args: ExamsExportQti3ZipArgs, options?: ExamplaryRequestOptions): Promise<ExamsExportQti3ZipResponse>;
1146
+ /**
1147
+ * Export QTI 2.1 package
1148
+ *
1149
+ * Export an exam as a QTI 2.1 ZIP package.
1150
+ *
1151
+ * API endpoint: `POST /exams/{examId}/export/qti21-zip`
1152
+ */
1153
+ qti21Zip(examId: string, options?: ExamplaryRequestOptions): Promise<ExamsExportQti21ZipResponse>;
1154
+ qti21Zip(args: ExamsExportQti21ZipArgs, options?: ExamplaryRequestOptions): Promise<ExamsExportQti21ZipResponse>;
1155
+ }
1156
+ export declare class Exams {
1157
+ private readonly ctx;
1158
+ constructor(ctx: ClientContext);
1159
+ readonly sessions: ExamsSessions;
1160
+ readonly questions: ExamsQuestions;
1161
+ readonly export: ExamsExport;
1162
+ /**
1163
+ * List exams
1164
+ *
1165
+ * Get a list of all exams within your workspace.
1166
+ *
1167
+ * API endpoint: `GET /exams`
1168
+ */
1169
+ list(args: ExamsListArgs, options?: ExamplaryRequestOptions): Promise<ExamsListResponse>;
1170
+ /**
1171
+ * Create exam
1172
+ *
1173
+ * Create a new exam within your workspace.
1174
+ *
1175
+ * API endpoint: `POST /exams`
1176
+ */
1177
+ create(args?: ExamsCreateArgs, options?: ExamplaryRequestOptions): Promise<ExamsCreateResponse>;
1178
+ /**
1179
+ * Import exam
1180
+ *
1181
+ * Create an exam by importing one or more source materials (e.g. an existing exam).
1182
+ *
1183
+ * API endpoint: `POST /exams/import`
1184
+ */
1185
+ import(args?: ExamsImportArgs, options?: ExamplaryRequestOptions): Promise<ExamsImportResponse>;
1186
+ /**
1187
+ * Get exam
1188
+ *
1189
+ * Get a single exam by its ID.
1190
+ *
1191
+ * API endpoint: `GET /exams/{id}`
1192
+ */
1193
+ get(id: string, options?: ExamplaryRequestOptions): Promise<ExamsGetResponse>;
1194
+ get(args: ExamsGetArgs, options?: ExamplaryRequestOptions): Promise<ExamsGetResponse>;
1195
+ /**
1196
+ * Update exam
1197
+ *
1198
+ * Update an existing exam.
1199
+ *
1200
+ * API endpoint: `POST /exams/{id}`
1201
+ */
1202
+ update(id: string, options?: ExamplaryRequestOptions): Promise<ExamsUpdateResponse>;
1203
+ update(args: ExamsUpdateArgs, options?: ExamplaryRequestOptions): Promise<ExamsUpdateResponse>;
1204
+ /**
1205
+ * Delete exam
1206
+ *
1207
+ * Delete the exam.
1208
+ *
1209
+ * API endpoint: `DELETE /exams/{id}`
1210
+ */
1211
+ delete(id: string, options?: ExamplaryRequestOptions): Promise<ExamsDeleteResponse>;
1212
+ delete(args: ExamsDeleteArgs, options?: ExamplaryRequestOptions): Promise<ExamsDeleteResponse>;
1213
+ /**
1214
+ * Duplicate exam
1215
+ *
1216
+ * Duplicate the exam's questions and settings to a new exam.
1217
+ *
1218
+ * API endpoint: `POST /exams/{examId}/duplicate`
1219
+ */
1220
+ duplicate(args: ExamsDuplicateArgs, options?: ExamplaryRequestOptions): Promise<ExamsDuplicateResponse>;
1221
+ /**
1222
+ * Print exam
1223
+ *
1224
+ * Export an exam to a PDF file or Word document.
1225
+ *
1226
+ * API endpoint: `POST /exams/{examId}/print`
1227
+ */
1228
+ print(examId: string, options?: ExamplaryRequestOptions): Promise<ExamsPrintResponse>;
1229
+ print(args: ExamsPrintArgs, options?: ExamplaryRequestOptions): Promise<ExamsPrintResponse>;
1230
+ /**
1231
+ * Generate exam
1232
+ *
1233
+ * Initiate a job to generate new questions for the exam using AI, based on the source materials and metadata specified.
1234
+ *
1235
+ * API endpoint: `POST /exams/{examId}/generate`
1236
+ */
1237
+ startGeneration(examId: string, options?: ExamplaryRequestOptions): Promise<ExamsStartGenerationResponse>;
1238
+ startGeneration(args: ExamsStartGenerationArgs, options?: ExamplaryRequestOptions): Promise<ExamsStartGenerationResponse>;
1239
+ /**
1240
+ * Cancel exam generation
1241
+ *
1242
+ * Cancel an ongoing job to generate new questions for the exam using AI.
1243
+ *
1244
+ * API endpoint: `POST /exams/{examId}/generate/cancel`
1245
+ */
1246
+ cancelGeneration(examId: string, options?: ExamplaryRequestOptions): Promise<ExamsCancelGenerationResponse>;
1247
+ cancelGeneration(args: ExamsCancelGenerationArgs, options?: ExamplaryRequestOptions): Promise<ExamsCancelGenerationResponse>;
1248
+ /**
1249
+ * Get exam context suggestions
1250
+ *
1251
+ * Get AI-generated suggestions for context/instructions to include in the exam generation prompt, based on the source materials linked to the exam.
1252
+ *
1253
+ * API endpoint: `GET /exams/{examId}/context-suggestions`
1254
+ */
1255
+ getContextSuggestions(examId: string, options?: ExamplaryRequestOptions): Promise<ExamsGetContextSuggestionsResponse>;
1256
+ getContextSuggestions(args: ExamsGetContextSuggestionsArgs, options?: ExamplaryRequestOptions): Promise<ExamsGetContextSuggestionsResponse>;
1257
+ }
1258
+ export declare class PracticeSpacesStudents {
1259
+ private readonly ctx;
1260
+ constructor(ctx: ClientContext);
1261
+ /**
1262
+ * List practice space students
1263
+ *
1264
+ * Get a list of all students that practiced in a practice space.
1265
+ *
1266
+ * API endpoint: `GET /practice-spaces/{practiceSpaceId}/students`
1267
+ */
1268
+ list(practiceSpaceId: string, options?: ExamplaryRequestOptions): Promise<PracticeSpacesStudentsListResponse>;
1269
+ list(args: PracticeSpacesStudentsListArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesStudentsListResponse>;
1270
+ /**
1271
+ * Get practice space student
1272
+ *
1273
+ * Get details about a specific practice space student.
1274
+ *
1275
+ * API endpoint: `GET /practice-spaces/{practiceSpaceId}/students/{studentId}`
1276
+ */
1277
+ get(args: PracticeSpacesStudentsGetArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesStudentsGetResponse>;
1278
+ }
1279
+ export declare class PracticeSpacesSessions {
1280
+ private readonly ctx;
1281
+ constructor(ctx: ClientContext);
1282
+ /**
1283
+ * Create practice space session
1284
+ *
1285
+ * Create a new practice space session.
1286
+ *
1287
+ * API endpoint: `POST /practice-spaces/{practiceSpaceId}/sessions`
1288
+ */
1289
+ create(args: PracticeSpacesSessionsCreateArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesSessionsCreateResponse>;
1290
+ /**
1291
+ * Get my practice space session
1292
+ *
1293
+ * Get the current user's past practice space session.
1294
+ *
1295
+ * API endpoint: `GET /practice-spaces/{practiceSpaceId}/sessions/mine`
1296
+ */
1297
+ getMine(practiceSpaceId: string, options?: ExamplaryRequestOptions): Promise<PracticeSpacesSessionsGetMineResponse>;
1298
+ getMine(args: PracticeSpacesSessionsGetMineArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesSessionsGetMineResponse>;
1299
+ /**
1300
+ * Get practice space session
1301
+ *
1302
+ * Get a practice space session by its ID.
1303
+ *
1304
+ * API endpoint: `GET /practice-spaces/{practiceSpaceId}/sessions/{sessionId}`
1305
+ */
1306
+ get(args: PracticeSpacesSessionsGetArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesSessionsGetResponse>;
1307
+ /**
1308
+ * Save answer for a practice space session
1309
+ *
1310
+ * Save an answer for a specific question in a practice space session.
1311
+ *
1312
+ * API endpoint: `POST /practice-spaces/{practiceSpaceId}/sessions/{sessionId}/answers/{questionId}`
1313
+ */
1314
+ saveAnswer(args: PracticeSpacesSessionsSaveAnswerArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesSessionsSaveAnswerResponse>;
1315
+ }
1316
+ export declare class PracticeSpaces {
1317
+ private readonly ctx;
1318
+ constructor(ctx: ClientContext);
1319
+ readonly students: PracticeSpacesStudents;
1320
+ readonly sessions: PracticeSpacesSessions;
1321
+ /**
1322
+ * List practice spaces
1323
+ *
1324
+ * Get a list of all practice spaces you have access to in this workspace.
1325
+ *
1326
+ * API endpoint: `GET /practice-spaces`
1327
+ */
1328
+ list(args: PracticeSpacesListArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesListResponse>;
1329
+ /**
1330
+ * Create practice space
1331
+ *
1332
+ * Create a new practice space within your workspace.
1333
+ *
1334
+ * API endpoint: `POST /practice-spaces`
1335
+ */
1336
+ create(args?: PracticeSpacesCreateArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesCreateResponse>;
1337
+ /**
1338
+ * Get practice space
1339
+ *
1340
+ * Get a single practice space by its ID.
1341
+ *
1342
+ * API endpoint: `GET /practice-spaces/{id}`
1343
+ */
1344
+ get(id: string, options?: ExamplaryRequestOptions): Promise<PracticeSpacesGetResponse>;
1345
+ get(args: PracticeSpacesGetArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesGetResponse>;
1346
+ /**
1347
+ * Update practice space
1348
+ *
1349
+ * Update an existing practice space.
1350
+ *
1351
+ * API endpoint: `PATCH /practice-spaces/{id}`
1352
+ */
1353
+ update(args: PracticeSpacesUpdateArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesUpdateResponse>;
1354
+ /**
1355
+ * Delete practice space
1356
+ *
1357
+ * Delete the practice space.
1358
+ *
1359
+ * API endpoint: `DELETE /practice-spaces/{id}`
1360
+ */
1361
+ delete(id: string, options?: ExamplaryRequestOptions): Promise<PracticeSpacesDeleteResponse>;
1362
+ delete(args: PracticeSpacesDeleteArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesDeleteResponse>;
1363
+ /**
1364
+ * Duplicate practice space
1365
+ *
1366
+ * Duplicate the practice space's settings and topics to a new practice space.
1367
+ *
1368
+ * API endpoint: `POST /practice-spaces/{practiceSpaceId}/duplicate`
1369
+ */
1370
+ duplicate(args: PracticeSpacesDuplicateArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesDuplicateResponse>;
1371
+ /**
1372
+ * Generate practice space topics
1373
+ *
1374
+ * Start generating mastery topics for a practice space.
1375
+ *
1376
+ * API endpoint: `POST /practice-spaces/{practiceSpaceId}/generate-topics`
1377
+ */
1378
+ generateTopics(practiceSpaceId: string, options?: ExamplaryRequestOptions): Promise<PracticeSpacesGenerateTopicsResponse>;
1379
+ generateTopics(args: PracticeSpacesGenerateTopicsArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesGenerateTopicsResponse>;
1380
+ /**
1381
+ * Cancel practice space topic generation
1382
+ *
1383
+ * Cancel an in-progress mastery topic generation job.
1384
+ *
1385
+ * API endpoint: `POST /practice-spaces/{practiceSpaceId}/cancel-generate-topics`
1386
+ */
1387
+ cancelGenerateTopics(practiceSpaceId: string, options?: ExamplaryRequestOptions): Promise<PracticeSpacesCancelGenerateTopicsResponse>;
1388
+ cancelGenerateTopics(args: PracticeSpacesCancelGenerateTopicsArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesCancelGenerateTopicsResponse>;
1389
+ /**
1390
+ * Preview top practice space questions
1391
+ *
1392
+ * Get a preview of the top practice space questions by quality score.
1393
+ *
1394
+ * API endpoint: `GET /practice-spaces/{practiceSpaceId}/questions-preview`
1395
+ */
1396
+ questionsPreview(practiceSpaceId: string, options?: ExamplaryRequestOptions): Promise<PracticeSpacesQuestionsPreviewResponse>;
1397
+ questionsPreview(args: PracticeSpacesQuestionsPreviewArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesQuestionsPreviewResponse>;
1398
+ /**
1399
+ * Get practice space progress
1400
+ *
1401
+ * Get the progress of a single practice space by its ID.
1402
+ *
1403
+ * API endpoint: `GET /practice-spaces/{practiceSpaceId}/progress`
1404
+ */
1405
+ getProgress(practiceSpaceId: string, options?: ExamplaryRequestOptions): Promise<PracticeSpacesGetProgressResponse>;
1406
+ getProgress(args: PracticeSpacesGetProgressArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesGetProgressResponse>;
1407
+ /**
1408
+ * Generate practice space topic feedback
1409
+ *
1410
+ * Get feedback for a specific topic in a practice space.
1411
+ *
1412
+ * API endpoint: `POST /practice-spaces/{practiceSpaceId}/progress/topic-feedback`
1413
+ */
1414
+ generateTopicFeedback(args: PracticeSpacesGenerateTopicFeedbackArgs, options?: ExamplaryRequestOptions): Promise<PracticeSpacesGenerateTopicFeedbackResponse>;
1415
+ }
1416
+ export declare class SourceMaterials {
1417
+ private readonly ctx;
1418
+ constructor(ctx: ClientContext);
1419
+ /**
1420
+ * List source materials in org
1421
+ *
1422
+ * Returns a list of source materials for the current organization.
1423
+ *
1424
+ * API endpoint: `GET /source-materials`
1425
+ */
1426
+ list(args: SourceMaterialsListArgs, options?: ExamplaryRequestOptions): Promise<SourceMaterialsListResponse>;
1427
+ /**
1428
+ * Add source material
1429
+ *
1430
+ * Add a source material and start processing it for later use in an exam.
1431
+ *
1432
+ * API endpoint: `POST /source-materials`
1433
+ */
1434
+ create(args?: SourceMaterialsCreateArgs, options?: ExamplaryRequestOptions): Promise<SourceMaterialsCreateResponse>;
1435
+ /**
1436
+ * Get source material
1437
+ *
1438
+ * Returns the current status and facts extracted from the specified source material.
1439
+ *
1440
+ * API endpoint: `GET /source-materials/{id}`
1441
+ */
1442
+ get(id: string, options?: ExamplaryRequestOptions): Promise<SourceMaterialsGetResponse>;
1443
+ get(args: SourceMaterialsGetArgs, options?: ExamplaryRequestOptions): Promise<SourceMaterialsGetResponse>;
1444
+ /**
1445
+ * Update source material
1446
+ *
1447
+ * Updates the specified source material.
1448
+ *
1449
+ * API endpoint: `PATCH /source-materials/{id}`
1450
+ */
1451
+ update(args: SourceMaterialsUpdateArgs, options?: ExamplaryRequestOptions): Promise<SourceMaterialsUpdateResponse>;
1452
+ /**
1453
+ * Delete source material
1454
+ *
1455
+ * Deletes the specified source material.
1456
+ *
1457
+ * API endpoint: `DELETE /source-materials/{id}`
1458
+ */
1459
+ delete(id: string, options?: ExamplaryRequestOptions): Promise<SourceMaterialsDeleteResponse>;
1460
+ delete(args: SourceMaterialsDeleteArgs, options?: ExamplaryRequestOptions): Promise<SourceMaterialsDeleteResponse>;
1461
+ /**
1462
+ * Create a source material slice
1463
+ *
1464
+ * Create a new source material based on a specific page range of an existing source material.
1465
+ *
1466
+ * API endpoint: `POST /source-materials/{sourceMaterialId}/slice`
1467
+ */
1468
+ slice(args: SourceMaterialsSliceArgs, options?: ExamplaryRequestOptions): Promise<SourceMaterialsSliceResponse>;
1469
+ }
1470
+ export declare class Folders {
1471
+ private readonly ctx;
1472
+ constructor(ctx: ClientContext);
1473
+ /**
1474
+ * Get folders
1475
+ *
1476
+ * Get a list of folders for exam organisation that exist within the current workspace.
1477
+ *
1478
+ * API endpoint: `GET /folders`
1479
+ */
1480
+ list(args?: FoldersListArgs, options?: ExamplaryRequestOptions): Promise<FoldersListResponse>;
1481
+ /**
1482
+ * Create folder
1483
+ *
1484
+ * Create a new folder in the current workspace.
1485
+ *
1486
+ * API endpoint: `POST /folders`
1487
+ */
1488
+ create(args?: FoldersCreateArgs, options?: ExamplaryRequestOptions): Promise<FoldersCreateResponse>;
1489
+ /**
1490
+ * Update folder
1491
+ *
1492
+ * Update an existing folder in the current workspace.
1493
+ *
1494
+ * API endpoint: `POST /folders/{id}`
1495
+ */
1496
+ update(args: FoldersUpdateArgs, options?: ExamplaryRequestOptions): Promise<FoldersUpdateResponse>;
1497
+ /**
1498
+ * Delete folder
1499
+ *
1500
+ * Delete a folder from the current workspace. If there are any exams in the folder, they will be moved out of the folder.
1501
+ *
1502
+ * API endpoint: `DELETE /folders/{id}`
1503
+ */
1504
+ delete(id: string, options?: ExamplaryRequestOptions): Promise<FoldersDeleteResponse>;
1505
+ delete(args: FoldersDeleteArgs, options?: ExamplaryRequestOptions): Promise<FoldersDeleteResponse>;
1506
+ }
1507
+ export declare class Groups {
1508
+ private readonly ctx;
1509
+ constructor(ctx: ClientContext);
1510
+ /**
1511
+ * List groups
1512
+ *
1513
+ * List all groups in the organization. When restricted group visibility is enabled, only returns groups the user belongs to.
1514
+ *
1515
+ * API endpoint: `GET /groups`
1516
+ */
1517
+ list(args?: GroupsListArgs, options?: ExamplaryRequestOptions): Promise<GroupsListResponse>;
1518
+ /**
1519
+ * Create group
1520
+ *
1521
+ * Create a new group. Requires admin or owner org role.
1522
+ *
1523
+ * API endpoint: `POST /groups`
1524
+ */
1525
+ create(args?: GroupsCreateArgs, options?: ExamplaryRequestOptions): Promise<GroupsCreateResponse>;
1526
+ /**
1527
+ * Rename group
1528
+ *
1529
+ * Rename a group. Requires group manager/owner role or org admin/owner.
1530
+ *
1531
+ * API endpoint: `PATCH /groups/{id}`
1532
+ */
1533
+ update(args: GroupsUpdateArgs, options?: ExamplaryRequestOptions): Promise<GroupsUpdateResponse>;
1534
+ /**
1535
+ * Delete group
1536
+ *
1537
+ * Delete a group and revoke all associated permissions. Requires group manager/owner role or org admin/owner.
1538
+ *
1539
+ * API endpoint: `DELETE /groups/{id}`
1540
+ */
1541
+ delete(id: string, options?: ExamplaryRequestOptions): Promise<GroupsDeleteResponse>;
1542
+ delete(args: GroupsDeleteArgs, options?: ExamplaryRequestOptions): Promise<GroupsDeleteResponse>;
1543
+ /**
1544
+ * List group members
1545
+ *
1546
+ * List all members of a group with resolved user info. Respects restricted group visibility.
1547
+ *
1548
+ * API endpoint: `GET /groups/{groupId}/members`
1549
+ */
1550
+ listMembers(groupId: string, options?: ExamplaryRequestOptions): Promise<GroupsListMembersResponse>;
1551
+ listMembers(args: GroupsListMembersArgs, options?: ExamplaryRequestOptions): Promise<GroupsListMembersResponse>;
1552
+ /**
1553
+ * Add group member
1554
+ *
1555
+ * Add a member to a group. Requires group manager/owner role or org admin/owner.
1556
+ *
1557
+ * API endpoint: `POST /groups/{groupId}/members`
1558
+ */
1559
+ addMember(args: GroupsAddMemberArgs, options?: ExamplaryRequestOptions): Promise<GroupsAddMemberResponse>;
1560
+ /**
1561
+ * Change member role
1562
+ *
1563
+ * Change a member's role in the group. Requires group manager/owner role or org admin/owner.
1564
+ *
1565
+ * API endpoint: `PATCH /groups/{groupId}/members/{userId}`
1566
+ */
1567
+ updateMember(args: GroupsUpdateMemberArgs, options?: ExamplaryRequestOptions): Promise<GroupsUpdateMemberResponse>;
1568
+ /**
1569
+ * Remove group member
1570
+ *
1571
+ * Remove a member from the group. Requires group manager/owner role or org admin/owner. Cannot remove the owner.
1572
+ *
1573
+ * API endpoint: `DELETE /groups/{groupId}/members/{userId}`
1574
+ */
1575
+ removeMember(args: GroupsRemoveMemberArgs, options?: ExamplaryRequestOptions): Promise<GroupsRemoveMemberResponse>;
1576
+ }
1577
+ export declare class QuestionBank {
1578
+ private readonly ctx;
1579
+ constructor(ctx: ClientContext);
1580
+ /**
1581
+ * Get question bank items
1582
+ *
1583
+ * Get a list of question bank items that exist within the current workspace.
1584
+ *
1585
+ * API endpoint: `GET /question-bank`
1586
+ */
1587
+ list(args?: QuestionBankListArgs, options?: ExamplaryRequestOptions): Promise<QuestionBankListResponse>;
1588
+ /**
1589
+ * Add question to question bank
1590
+ *
1591
+ * Add a question to the question bank in the current workspace.
1592
+ *
1593
+ * API endpoint: `POST /question-bank`
1594
+ */
1595
+ create(args?: QuestionBankCreateArgs, options?: ExamplaryRequestOptions): Promise<QuestionBankCreateResponse>;
1596
+ /**
1597
+ * Update question bank item
1598
+ *
1599
+ * Update an existing question bank item in the current workspace.
1600
+ *
1601
+ * API endpoint: `PATCH /question-bank/{id}`
1602
+ */
1603
+ update(args: QuestionBankUpdateArgs, options?: ExamplaryRequestOptions): Promise<QuestionBankUpdateResponse>;
1604
+ /**
1605
+ * Delete question bank item
1606
+ *
1607
+ * Delete a question bank item from the current workspace.
1608
+ *
1609
+ * API endpoint: `DELETE /question-bank/{id}`
1610
+ */
1611
+ delete(id: string, options?: ExamplaryRequestOptions): Promise<QuestionBankDeleteResponse>;
1612
+ delete(args: QuestionBankDeleteArgs, options?: ExamplaryRequestOptions): Promise<QuestionBankDeleteResponse>;
1613
+ }
1614
+ export declare class Jobs {
1615
+ private readonly ctx;
1616
+ constructor(ctx: ClientContext);
1617
+ /**
1618
+ * Get job status
1619
+ *
1620
+ * Poll the status of a background job.
1621
+ *
1622
+ * API endpoint: `GET /jobs/{id}`
1623
+ */
1624
+ get(id: string, options?: ExamplaryRequestOptions): Promise<JobsGetResponse>;
1625
+ get(args: JobsGetArgs, options?: ExamplaryRequestOptions): Promise<JobsGetResponse>;
1626
+ /**
1627
+ * Cancel a job
1628
+ *
1629
+ * Cancel a background job.
1630
+ *
1631
+ * API endpoint: `DELETE /jobs/{id}`
1632
+ */
1633
+ cancel(id: string, options?: ExamplaryRequestOptions): Promise<JobsCancelResponse>;
1634
+ cancel(args: JobsCancelArgs, options?: ExamplaryRequestOptions): Promise<JobsCancelResponse>;
1635
+ }
1636
+ export declare class Examplary {
1637
+ private readonly ctx;
1638
+ readonly questionTypes: QuestionTypes;
1639
+ readonly library: Library;
1640
+ readonly oauth: Oauth;
1641
+ readonly embedSessions: EmbedSessions;
1642
+ readonly me: Me;
1643
+ readonly media: Media;
1644
+ readonly org: Org;
1645
+ readonly orgs: Orgs;
1646
+ readonly apiKeys: ApiKeys;
1647
+ readonly attributes: Attributes;
1648
+ readonly taxonomies: Taxonomies;
1649
+ readonly permissions: Permissions;
1650
+ readonly studentLevels: StudentLevels;
1651
+ readonly users: Users;
1652
+ readonly exams: Exams;
1653
+ readonly practiceSpaces: PracticeSpaces;
1654
+ readonly sourceMaterials: SourceMaterials;
1655
+ readonly folders: Folders;
1656
+ readonly groups: Groups;
1657
+ readonly questionBank: QuestionBank;
1658
+ readonly jobs: Jobs;
1659
+ constructor(options: ExamplaryClientOptions);
1660
+ /**
1661
+ * Get rubrics
1662
+ *
1663
+ * Get a list of rubrics that exist within the current workspace.
1664
+ *
1665
+ * API endpoint: `GET /rubrics`
1666
+ */
1667
+ getRubrics(args?: GetRubricsArgs, options?: ExamplaryRequestOptions): Promise<GetRubricsResponse>;
1668
+ /**
1669
+ * Save rubric
1670
+ *
1671
+ * Add a rubric to the current workspace.
1672
+ *
1673
+ * API endpoint: `POST /rubrics`
1674
+ */
1675
+ postRubrics(args?: PostRubricsArgs, options?: ExamplaryRequestOptions): Promise<PostRubricsResponse>;
1676
+ /**
1677
+ * Generate rubric
1678
+ *
1679
+ * Start a background job to generate a rubric using AI.
1680
+ *
1681
+ * API endpoint: `POST /rubrics/generate`
1682
+ */
1683
+ postRubricsGenerate(args?: PostRubricsGenerateArgs, options?: ExamplaryRequestOptions): Promise<PostRubricsGenerateResponse>;
1684
+ /**
1685
+ * Update rubric
1686
+ *
1687
+ * Update an existing rubric in the current workspace.
1688
+ *
1689
+ * API endpoint: `PATCH /rubrics/{id}`
1690
+ */
1691
+ patchRubricsId(args: PatchRubricsIdArgs, options?: ExamplaryRequestOptions): Promise<PatchRubricsIdResponse>;
1692
+ /**
1693
+ * Delete rubric
1694
+ *
1695
+ * Delete a rubric from the current workspace.
1696
+ *
1697
+ * API endpoint: `DELETE /rubrics/{id}`
1698
+ */
1699
+ deleteRubricsId(id: string, options?: ExamplaryRequestOptions): Promise<DeleteRubricsIdResponse>;
1700
+ deleteRubricsId(args: DeleteRubricsIdArgs, options?: ExamplaryRequestOptions): Promise<DeleteRubricsIdResponse>;
1701
+ }
1702
+ export {};