@studyfetch/sdk 1.15.0 → 1.17.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 (58) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +18 -37
  3. package/package.json +1 -1
  4. package/resources/v1/assignment-grader.d.mts +166 -0
  5. package/resources/v1/assignment-grader.d.mts.map +1 -0
  6. package/resources/v1/assignment-grader.d.ts +166 -0
  7. package/resources/v1/assignment-grader.d.ts.map +1 -0
  8. package/resources/v1/assignment-grader.js +51 -0
  9. package/resources/v1/assignment-grader.js.map +1 -0
  10. package/resources/v1/assignment-grader.mjs +47 -0
  11. package/resources/v1/assignment-grader.mjs.map +1 -0
  12. package/resources/v1/index.d.mts +1 -0
  13. package/resources/v1/index.d.mts.map +1 -1
  14. package/resources/v1/index.d.ts +1 -0
  15. package/resources/v1/index.d.ts.map +1 -1
  16. package/resources/v1/index.js +3 -1
  17. package/resources/v1/index.js.map +1 -1
  18. package/resources/v1/index.mjs +1 -0
  19. package/resources/v1/index.mjs.map +1 -1
  20. package/resources/v1/scenarios/component.d.mts +0 -5
  21. package/resources/v1/scenarios/component.d.mts.map +1 -1
  22. package/resources/v1/scenarios/component.d.ts +0 -5
  23. package/resources/v1/scenarios/component.d.ts.map +1 -1
  24. package/resources/v1/scenarios/component.js +0 -1
  25. package/resources/v1/scenarios/component.js.map +1 -1
  26. package/resources/v1/scenarios/component.mjs +0 -1
  27. package/resources/v1/scenarios/component.mjs.map +1 -1
  28. package/resources/v1/scenarios/scenarios.d.mts +1 -8
  29. package/resources/v1/scenarios/scenarios.d.mts.map +1 -1
  30. package/resources/v1/scenarios/scenarios.d.ts +1 -8
  31. package/resources/v1/scenarios/scenarios.d.ts.map +1 -1
  32. package/resources/v1/scenarios/scenarios.js +1 -4
  33. package/resources/v1/scenarios/scenarios.js.map +1 -1
  34. package/resources/v1/scenarios/scenarios.mjs +1 -4
  35. package/resources/v1/scenarios/scenarios.mjs.map +1 -1
  36. package/resources/v1/usage.d.mts +1 -1
  37. package/resources/v1/usage.d.mts.map +1 -1
  38. package/resources/v1/usage.d.ts +1 -1
  39. package/resources/v1/usage.d.ts.map +1 -1
  40. package/resources/v1/v1.d.mts +4 -0
  41. package/resources/v1/v1.d.mts.map +1 -1
  42. package/resources/v1/v1.d.ts +4 -0
  43. package/resources/v1/v1.d.ts.map +1 -1
  44. package/resources/v1/v1.js +4 -0
  45. package/resources/v1/v1.js.map +1 -1
  46. package/resources/v1/v1.mjs +4 -0
  47. package/resources/v1/v1.mjs.map +1 -1
  48. package/src/resources/v1/assignment-grader.ts +213 -0
  49. package/src/resources/v1/index.ts +7 -0
  50. package/src/resources/v1/scenarios/component.ts +0 -6
  51. package/src/resources/v1/scenarios/scenarios.ts +1 -9
  52. package/src/resources/v1/usage.ts +1 -0
  53. package/src/resources/v1/v1.ts +20 -0
  54. package/src/version.ts +1 -1
  55. package/version.d.mts +1 -1
  56. package/version.d.ts +1 -1
  57. package/version.js +1 -1
  58. package/version.mjs +1 -1
@@ -0,0 +1,213 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import { APIPromise } from '../../core/api-promise';
5
+ import { RequestOptions } from '../../internal/request-options';
6
+ import { path } from '../../internal/utils/path';
7
+
8
+ export class AssignmentGrader extends APIResource {
9
+ /**
10
+ * Grade a new assignment
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const assignmentGrader =
15
+ * await client.v1.assignmentGrader.create({
16
+ * rubric: {
17
+ * criteria: [{ pointsPossible: 0, title: 'title' }],
18
+ * },
19
+ * title: 'title',
20
+ * });
21
+ * ```
22
+ */
23
+ create(
24
+ body: AssignmentGraderCreateParams,
25
+ options?: RequestOptions,
26
+ ): APIPromise<AssignmentGraderCreateResponse> {
27
+ return this._client.post('/api/v1/assignment-grader/create', { body, ...options });
28
+ }
29
+
30
+ /**
31
+ * Get all assignment graders
32
+ *
33
+ * @example
34
+ * ```ts
35
+ * const response = await client.v1.assignmentGrader.getAll();
36
+ * ```
37
+ */
38
+ getAll(options?: RequestOptions): APIPromise<AssignmentGraderGetAllResponse> {
39
+ return this._client.get('/api/v1/assignment-grader/get', options);
40
+ }
41
+
42
+ /**
43
+ * Get an assignment grader by ID
44
+ *
45
+ * @example
46
+ * ```ts
47
+ * const response = await client.v1.assignmentGrader.getByID(
48
+ * 'id',
49
+ * );
50
+ * ```
51
+ */
52
+ getByID(id: string, options?: RequestOptions): APIPromise<AssignmentGraderGetByIDResponse> {
53
+ return this._client.get(path`/api/v1/assignment-grader/get/${id}`, options);
54
+ }
55
+ }
56
+
57
+ export interface AssignmentGraderCreateResponse {
58
+ /**
59
+ * Assignment grader ID
60
+ */
61
+ id: string;
62
+
63
+ /**
64
+ * Creation timestamp
65
+ */
66
+ createdAt: string;
67
+
68
+ /**
69
+ * Overall grade percentage
70
+ */
71
+ grade: number;
72
+
73
+ /**
74
+ * Grading results
75
+ */
76
+ rubric: unknown;
77
+
78
+ /**
79
+ * Assignment title
80
+ */
81
+ title: string;
82
+ }
83
+
84
+ export type AssignmentGraderGetAllResponse =
85
+ Array<AssignmentGraderGetAllResponse.AssignmentGraderGetAllResponseItem>;
86
+
87
+ export namespace AssignmentGraderGetAllResponse {
88
+ export interface AssignmentGraderGetAllResponseItem {
89
+ /**
90
+ * Assignment grader ID
91
+ */
92
+ id: string;
93
+
94
+ /**
95
+ * Creation timestamp
96
+ */
97
+ createdAt: string;
98
+
99
+ /**
100
+ * Overall grade percentage
101
+ */
102
+ grade: number;
103
+
104
+ /**
105
+ * Grading results
106
+ */
107
+ rubric: unknown;
108
+
109
+ /**
110
+ * Assignment title
111
+ */
112
+ title: string;
113
+ }
114
+ }
115
+
116
+ export interface AssignmentGraderGetByIDResponse {
117
+ /**
118
+ * Assignment grader ID
119
+ */
120
+ id: string;
121
+
122
+ /**
123
+ * Creation timestamp
124
+ */
125
+ createdAt: string;
126
+
127
+ /**
128
+ * Overall grade percentage
129
+ */
130
+ grade: number;
131
+
132
+ /**
133
+ * Grading results
134
+ */
135
+ rubric: unknown;
136
+
137
+ /**
138
+ * Assignment title
139
+ */
140
+ title: string;
141
+ }
142
+
143
+ export interface AssignmentGraderCreateParams {
144
+ /**
145
+ * Grading rubric
146
+ */
147
+ rubric: AssignmentGraderCreateParams.Rubric;
148
+
149
+ /**
150
+ * Title of the assignment
151
+ */
152
+ title: string;
153
+
154
+ /**
155
+ * Material ID to grade
156
+ */
157
+ materialId?: string;
158
+
159
+ /**
160
+ * AI model to use
161
+ */
162
+ model?: string;
163
+
164
+ /**
165
+ * Text content to grade
166
+ */
167
+ textToGrade?: string;
168
+
169
+ /**
170
+ * User ID for tracking
171
+ */
172
+ userId?: string;
173
+ }
174
+
175
+ export namespace AssignmentGraderCreateParams {
176
+ /**
177
+ * Grading rubric
178
+ */
179
+ export interface Rubric {
180
+ /**
181
+ * Grading criteria
182
+ */
183
+ criteria: Array<Rubric.Criterion>;
184
+ }
185
+
186
+ export namespace Rubric {
187
+ export interface Criterion {
188
+ /**
189
+ * Points possible for this criterion
190
+ */
191
+ pointsPossible: number;
192
+
193
+ /**
194
+ * Title of the criterion
195
+ */
196
+ title: string;
197
+
198
+ /**
199
+ * Description of the criterion
200
+ */
201
+ description?: string;
202
+ }
203
+ }
204
+ }
205
+
206
+ export declare namespace AssignmentGrader {
207
+ export {
208
+ type AssignmentGraderCreateResponse as AssignmentGraderCreateResponse,
209
+ type AssignmentGraderGetAllResponse as AssignmentGraderGetAllResponse,
210
+ type AssignmentGraderGetByIDResponse as AssignmentGraderGetByIDResponse,
211
+ type AssignmentGraderCreateParams as AssignmentGraderCreateParams,
212
+ };
213
+ }
@@ -1,5 +1,12 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
+ export {
4
+ AssignmentGrader,
5
+ type AssignmentGraderCreateResponse,
6
+ type AssignmentGraderGetAllResponse,
7
+ type AssignmentGraderGetByIDResponse,
8
+ type AssignmentGraderCreateParams,
9
+ } from './assignment-grader';
3
10
  export {
4
11
  AudioRecaps,
5
12
  type AudioRecapCreateParams,
@@ -28,7 +28,6 @@ export class Component extends APIResource {
28
28
  * @example
29
29
  * ```ts
30
30
  * await client.v1.scenarios.component.update('componentId', {
31
- * body_componentId: 'componentId',
32
31
  * name: 'name',
33
32
  * });
34
33
  * ```
@@ -58,11 +57,6 @@ export class Component extends APIResource {
58
57
  }
59
58
 
60
59
  export interface ComponentUpdateParams {
61
- /**
62
- * Associated component ID
63
- */
64
- body_componentId: string;
65
-
66
60
  /**
67
61
  * Scenario name
68
62
  */
@@ -56,10 +56,7 @@ export class Scenarios extends APIResource {
56
56
  *
57
57
  * @example
58
58
  * ```ts
59
- * await client.v1.scenarios.update('id', {
60
- * componentId: 'componentId',
61
- * name: 'name',
62
- * });
59
+ * await client.v1.scenarios.update('id', { name: 'name' });
63
60
  * ```
64
61
  */
65
62
  update(id: string, body: ScenarioUpdateParams, options?: RequestOptions): APIPromise<void> {
@@ -257,11 +254,6 @@ export interface ScenarioCreateParams {
257
254
  }
258
255
 
259
256
  export interface ScenarioUpdateParams {
260
- /**
261
- * Associated component ID
262
- */
263
- componentId: string;
264
-
265
257
  /**
266
258
  * Scenario name
267
259
  */
@@ -133,6 +133,7 @@ export interface UsageListEventsParams {
133
133
  | 'test_question_answered'
134
134
  | 'test_retaken'
135
135
  | 'audio_recap_create'
136
+ | 'assignment_grader_create'
136
137
  | 'api_call'
137
138
  | 'cache_hit'
138
139
  | 'sso_login'
@@ -1,6 +1,14 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  import { APIResource } from '../../core/resource';
4
+ import * as AssignmentGraderAPI from './assignment-grader';
5
+ import {
6
+ AssignmentGrader,
7
+ AssignmentGraderCreateParams,
8
+ AssignmentGraderCreateResponse,
9
+ AssignmentGraderGetAllResponse,
10
+ AssignmentGraderGetByIDResponse,
11
+ } from './assignment-grader';
4
12
  import * as ComponentsAPI from './components';
5
13
  import {
6
14
  Component,
@@ -81,6 +89,9 @@ export class V1 extends APIResource {
81
89
  scenarios: ScenariosAPI.Scenarios = new ScenariosAPI.Scenarios(this._client);
82
90
  explainers: ExplainersAPI.Explainers = new ExplainersAPI.Explainers(this._client);
83
91
  upload: UploadAPI.Upload = new UploadAPI.Upload(this._client);
92
+ assignmentGrader: AssignmentGraderAPI.AssignmentGrader = new AssignmentGraderAPI.AssignmentGrader(
93
+ this._client,
94
+ );
84
95
  }
85
96
 
86
97
  V1.Materials = Materials;
@@ -95,6 +106,7 @@ V1.Flashcards = Flashcards;
95
106
  V1.Scenarios = Scenarios;
96
107
  V1.Explainers = Explainers;
97
108
  V1.Upload = Upload;
109
+ V1.AssignmentGrader = AssignmentGrader;
98
110
 
99
111
  export declare namespace V1 {
100
112
  export {
@@ -185,4 +197,12 @@ export declare namespace V1 {
185
197
  };
186
198
 
187
199
  export { Upload as Upload };
200
+
201
+ export {
202
+ AssignmentGrader as AssignmentGrader,
203
+ type AssignmentGraderCreateResponse as AssignmentGraderCreateResponse,
204
+ type AssignmentGraderGetAllResponse as AssignmentGraderGetAllResponse,
205
+ type AssignmentGraderGetByIDResponse as AssignmentGraderGetByIDResponse,
206
+ type AssignmentGraderCreateParams as AssignmentGraderCreateParams,
207
+ };
188
208
  }
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '1.15.0'; // x-release-please-version
1
+ export const VERSION = '1.17.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.15.0";
1
+ export declare const VERSION = "1.17.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.15.0";
1
+ export declare const VERSION = "1.17.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '1.15.0'; // x-release-please-version
4
+ exports.VERSION = '1.17.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '1.15.0'; // x-release-please-version
1
+ export const VERSION = '1.17.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map