@studyfetch/sdk 1.18.0 → 1.20.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 (86) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/package.json +1 -1
  3. package/resources/v1/components.d.mts +0 -5
  4. package/resources/v1/components.d.mts.map +1 -1
  5. package/resources/v1/components.d.ts +0 -5
  6. package/resources/v1/components.d.ts.map +1 -1
  7. package/resources/v1/components.js +0 -1
  8. package/resources/v1/components.js.map +1 -1
  9. package/resources/v1/components.mjs +0 -1
  10. package/resources/v1/components.mjs.map +1 -1
  11. package/resources/v1/index.d.mts +2 -2
  12. package/resources/v1/index.d.mts.map +1 -1
  13. package/resources/v1/index.d.ts +2 -2
  14. package/resources/v1/index.d.ts.map +1 -1
  15. package/resources/v1/index.js +2 -2
  16. package/resources/v1/index.js.map +1 -1
  17. package/resources/v1/index.mjs +1 -1
  18. package/resources/v1/index.mjs.map +1 -1
  19. package/resources/v1/materials/index.d.mts +1 -1
  20. package/resources/v1/materials/index.d.mts.map +1 -1
  21. package/resources/v1/materials/index.d.ts +1 -1
  22. package/resources/v1/materials/index.d.ts.map +1 -1
  23. package/resources/v1/materials/index.js.map +1 -1
  24. package/resources/v1/materials/index.mjs.map +1 -1
  25. package/resources/v1/materials/materials.d.mts +24 -3
  26. package/resources/v1/materials/materials.d.mts.map +1 -1
  27. package/resources/v1/materials/materials.d.ts +24 -3
  28. package/resources/v1/materials/materials.d.ts.map +1 -1
  29. package/resources/v1/materials/materials.js +5 -2
  30. package/resources/v1/materials/materials.js.map +1 -1
  31. package/resources/v1/materials/materials.mjs +5 -2
  32. package/resources/v1/materials/materials.mjs.map +1 -1
  33. package/resources/v1/usage/analyst.d.mts +54 -0
  34. package/resources/v1/usage/analyst.d.mts.map +1 -0
  35. package/resources/v1/usage/analyst.d.ts +54 -0
  36. package/resources/v1/usage/analyst.d.ts.map +1 -0
  37. package/resources/v1/usage/analyst.js +57 -0
  38. package/resources/v1/usage/analyst.js.map +1 -0
  39. package/resources/v1/usage/analyst.mjs +53 -0
  40. package/resources/v1/usage/analyst.mjs.map +1 -0
  41. package/resources/v1/usage/index.d.mts +3 -0
  42. package/resources/v1/usage/index.d.mts.map +1 -0
  43. package/resources/v1/usage/index.d.ts +3 -0
  44. package/resources/v1/usage/index.d.ts.map +1 -0
  45. package/resources/v1/usage/index.js +9 -0
  46. package/resources/v1/usage/index.js.map +1 -0
  47. package/resources/v1/usage/index.mjs +4 -0
  48. package/resources/v1/usage/index.mjs.map +1 -0
  49. package/resources/v1/usage/usage.d.mts +114 -0
  50. package/resources/v1/usage/usage.d.mts.map +1 -0
  51. package/resources/v1/usage/usage.d.ts +114 -0
  52. package/resources/v1/usage/usage.d.ts.map +1 -0
  53. package/resources/v1/usage/usage.js +67 -0
  54. package/resources/v1/usage/usage.js.map +1 -0
  55. package/resources/v1/usage/usage.mjs +62 -0
  56. package/resources/v1/usage/usage.mjs.map +1 -0
  57. package/resources/v1/usage.d.mts +1 -109
  58. package/resources/v1/usage.d.mts.map +1 -1
  59. package/resources/v1/usage.d.ts +1 -109
  60. package/resources/v1/usage.d.ts.map +1 -1
  61. package/resources/v1/usage.js +2 -55
  62. package/resources/v1/usage.js.map +1 -1
  63. package/resources/v1/usage.mjs +1 -53
  64. package/resources/v1/usage.mjs.map +1 -1
  65. package/resources/v1/v1.d.mts +4 -4
  66. package/resources/v1/v1.d.mts.map +1 -1
  67. package/resources/v1/v1.d.ts +4 -4
  68. package/resources/v1/v1.d.ts.map +1 -1
  69. package/resources/v1/v1.js +2 -2
  70. package/resources/v1/v1.js.map +1 -1
  71. package/resources/v1/v1.mjs +2 -2
  72. package/resources/v1/v1.mjs.map +1 -1
  73. package/src/resources/v1/components.ts +0 -6
  74. package/src/resources/v1/index.ts +2 -1
  75. package/src/resources/v1/materials/index.ts +1 -0
  76. package/src/resources/v1/materials/materials.ts +29 -2
  77. package/src/resources/v1/usage/analyst.ts +102 -0
  78. package/src/resources/v1/usage/index.ts +9 -0
  79. package/src/resources/v1/usage/usage.ts +188 -0
  80. package/src/resources/v1/usage.ts +1 -178
  81. package/src/resources/v1/v1.ts +4 -2
  82. package/src/version.ts +1 -1
  83. package/version.d.mts +1 -1
  84. package/version.d.ts +1 -1
  85. package/version.js +1 -1
  86. package/version.mjs +1 -1
@@ -0,0 +1,102 @@
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 { buildHeaders } from '../../../internal/headers';
6
+ import { RequestOptions } from '../../../internal/request-options';
7
+
8
+ export class Analyst extends APIResource {
9
+ /**
10
+ * Get test results for users and groups in JWT
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * await client.v1.usage.analyst.getTestQuestions();
15
+ * ```
16
+ */
17
+ getTestQuestions(options?: RequestOptions): APIPromise<void> {
18
+ return this._client.get('/api/v1/usage-analyst/test-questions', {
19
+ ...options,
20
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
21
+ });
22
+ }
23
+
24
+ /**
25
+ * Get chat messages for users and groups in JWT
26
+ *
27
+ * @example
28
+ * ```ts
29
+ * await client.v1.usage.analyst.listChatMessages();
30
+ * ```
31
+ */
32
+ listChatMessages(options?: RequestOptions): APIPromise<void> {
33
+ return this._client.get('/api/v1/usage-analyst/chat-messages', {
34
+ ...options,
35
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
36
+ });
37
+ }
38
+
39
+ /**
40
+ * Get all events based on filters
41
+ *
42
+ * @example
43
+ * ```ts
44
+ * await client.v1.usage.analyst.listEvents({
45
+ * endDate: 'endDate',
46
+ * eventType: 'material_created',
47
+ * startDate: 'startDate',
48
+ * });
49
+ * ```
50
+ */
51
+ listEvents(query: AnalystListEventsParams, options?: RequestOptions): APIPromise<void> {
52
+ return this._client.get('/api/v1/usage-analyst/events', {
53
+ query,
54
+ ...options,
55
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
56
+ });
57
+ }
58
+ }
59
+
60
+ export interface AnalystListEventsParams {
61
+ /**
62
+ * End date for filtering (ISO 8601)
63
+ */
64
+ endDate: string;
65
+
66
+ /**
67
+ * Type of usage event to filter
68
+ */
69
+ eventType:
70
+ | 'material_created'
71
+ | 'material_uploaded'
72
+ | 'material_processed'
73
+ | 'material_deleted'
74
+ | 'component_created'
75
+ | 'component_accessed'
76
+ | 'component_deleted'
77
+ | 'component_usage'
78
+ | 'chat_message_sent'
79
+ | 'chat_session_started'
80
+ | 'chat_session_ended'
81
+ | 'test_created'
82
+ | 'test_started'
83
+ | 'test_completed'
84
+ | 'test_question_answered'
85
+ | 'test_retaken'
86
+ | 'audio_recap_create'
87
+ | 'assignment_grader_create'
88
+ | 'api_call'
89
+ | 'cache_hit'
90
+ | 'sso_login'
91
+ | 'sso_logout'
92
+ | 'student_performance';
93
+
94
+ /**
95
+ * Start date for filtering (ISO 8601)
96
+ */
97
+ startDate: string;
98
+ }
99
+
100
+ export declare namespace Analyst {
101
+ export { type AnalystListEventsParams as AnalystListEventsParams };
102
+ }
@@ -0,0 +1,9 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ export { Analyst, type AnalystListEventsParams } from './analyst';
4
+ export {
5
+ Usage,
6
+ type UsageGetStatsParams,
7
+ type UsageGetSummaryParams,
8
+ type UsageListEventsParams,
9
+ } from './usage';
@@ -0,0 +1,188 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../../core/resource';
4
+ import * as AnalystAPI from './analyst';
5
+ import { Analyst, AnalystListEventsParams } from './analyst';
6
+ import { APIPromise } from '../../../core/api-promise';
7
+ import { buildHeaders } from '../../../internal/headers';
8
+ import { RequestOptions } from '../../../internal/request-options';
9
+
10
+ export class Usage extends APIResource {
11
+ analyst: AnalystAPI.Analyst = new AnalystAPI.Analyst(this._client);
12
+
13
+ /**
14
+ * Get usage statistics
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * await client.v1.usage.getStats();
19
+ * ```
20
+ */
21
+ getStats(query: UsageGetStatsParams | null | undefined = {}, options?: RequestOptions): APIPromise<void> {
22
+ return this._client.get('/api/v1/usage/stats', {
23
+ query,
24
+ ...options,
25
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
26
+ });
27
+ }
28
+
29
+ /**
30
+ * Get usage summary
31
+ *
32
+ * @example
33
+ * ```ts
34
+ * await client.v1.usage.getSummary({
35
+ * endDate: 'endDate',
36
+ * period: 'hourly',
37
+ * startDate: 'startDate',
38
+ * });
39
+ * ```
40
+ */
41
+ getSummary(query: UsageGetSummaryParams, options?: RequestOptions): APIPromise<void> {
42
+ return this._client.get('/api/v1/usage/summary', {
43
+ query,
44
+ ...options,
45
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
46
+ });
47
+ }
48
+
49
+ /**
50
+ * Get usage events
51
+ *
52
+ * @example
53
+ * ```ts
54
+ * await client.v1.usage.listEvents();
55
+ * ```
56
+ */
57
+ listEvents(
58
+ query: UsageListEventsParams | null | undefined = {},
59
+ options?: RequestOptions,
60
+ ): APIPromise<void> {
61
+ return this._client.get('/api/v1/usage/events', {
62
+ query,
63
+ ...options,
64
+ headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
65
+ });
66
+ }
67
+ }
68
+
69
+ export interface UsageGetStatsParams {
70
+ /**
71
+ * End date for stats (ISO 8601)
72
+ */
73
+ endDate?: string;
74
+
75
+ /**
76
+ * Filter by group ID
77
+ */
78
+ groupId?: string;
79
+
80
+ /**
81
+ * Start date for stats (ISO 8601)
82
+ */
83
+ startDate?: string;
84
+
85
+ /**
86
+ * Filter by user ID
87
+ */
88
+ userId?: string;
89
+ }
90
+
91
+ export interface UsageGetSummaryParams {
92
+ /**
93
+ * End date for summary (ISO 8601)
94
+ */
95
+ endDate: string;
96
+
97
+ /**
98
+ * Summary period
99
+ */
100
+ period: 'hourly' | 'daily' | 'monthly';
101
+
102
+ /**
103
+ * Start date for summary (ISO 8601)
104
+ */
105
+ startDate: string;
106
+
107
+ /**
108
+ * Group results by
109
+ */
110
+ groupBy?: 'user' | 'group' | 'model' | 'endpoint';
111
+ }
112
+
113
+ export interface UsageListEventsParams {
114
+ /**
115
+ * End date for filtering (ISO 8601)
116
+ */
117
+ endDate?: string;
118
+
119
+ /**
120
+ * Filter by event type
121
+ */
122
+ eventType?:
123
+ | 'material_created'
124
+ | 'material_uploaded'
125
+ | 'material_processed'
126
+ | 'material_deleted'
127
+ | 'component_created'
128
+ | 'component_accessed'
129
+ | 'component_deleted'
130
+ | 'component_usage'
131
+ | 'chat_message_sent'
132
+ | 'chat_session_started'
133
+ | 'chat_session_ended'
134
+ | 'test_created'
135
+ | 'test_started'
136
+ | 'test_completed'
137
+ | 'test_question_answered'
138
+ | 'test_retaken'
139
+ | 'audio_recap_create'
140
+ | 'assignment_grader_create'
141
+ | 'api_call'
142
+ | 'cache_hit'
143
+ | 'sso_login'
144
+ | 'sso_logout'
145
+ | 'student_performance';
146
+
147
+ /**
148
+ * Filter by group ID
149
+ */
150
+ groupId?: string;
151
+
152
+ /**
153
+ * Number of results to return
154
+ */
155
+ limit?: number;
156
+
157
+ /**
158
+ * Offset for pagination
159
+ */
160
+ offset?: number;
161
+
162
+ /**
163
+ * Filter by resource ID
164
+ */
165
+ resourceId?: string;
166
+
167
+ /**
168
+ * Start date for filtering (ISO 8601)
169
+ */
170
+ startDate?: string;
171
+
172
+ /**
173
+ * Filter by user ID
174
+ */
175
+ userId?: string;
176
+ }
177
+
178
+ Usage.Analyst = Analyst;
179
+
180
+ export declare namespace Usage {
181
+ export {
182
+ type UsageGetStatsParams as UsageGetStatsParams,
183
+ type UsageGetSummaryParams as UsageGetSummaryParams,
184
+ type UsageListEventsParams as UsageListEventsParams,
185
+ };
186
+
187
+ export { Analyst as Analyst, type AnalystListEventsParams as AnalystListEventsParams };
188
+ }
@@ -1,180 +1,3 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
- import { APIResource } from '../../core/resource';
4
- import { APIPromise } from '../../core/api-promise';
5
- import { buildHeaders } from '../../internal/headers';
6
- import { RequestOptions } from '../../internal/request-options';
7
-
8
- export class Usage extends APIResource {
9
- /**
10
- * Get usage statistics
11
- *
12
- * @example
13
- * ```ts
14
- * await client.v1.usage.getStats();
15
- * ```
16
- */
17
- getStats(query: UsageGetStatsParams | null | undefined = {}, options?: RequestOptions): APIPromise<void> {
18
- return this._client.get('/api/v1/usage/stats', {
19
- query,
20
- ...options,
21
- headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
22
- });
23
- }
24
-
25
- /**
26
- * Get usage summary
27
- *
28
- * @example
29
- * ```ts
30
- * await client.v1.usage.getSummary({
31
- * endDate: 'endDate',
32
- * period: 'hourly',
33
- * startDate: 'startDate',
34
- * });
35
- * ```
36
- */
37
- getSummary(query: UsageGetSummaryParams, options?: RequestOptions): APIPromise<void> {
38
- return this._client.get('/api/v1/usage/summary', {
39
- query,
40
- ...options,
41
- headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
42
- });
43
- }
44
-
45
- /**
46
- * Get usage events
47
- *
48
- * @example
49
- * ```ts
50
- * await client.v1.usage.listEvents();
51
- * ```
52
- */
53
- listEvents(
54
- query: UsageListEventsParams | null | undefined = {},
55
- options?: RequestOptions,
56
- ): APIPromise<void> {
57
- return this._client.get('/api/v1/usage/events', {
58
- query,
59
- ...options,
60
- headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
61
- });
62
- }
63
- }
64
-
65
- export interface UsageGetStatsParams {
66
- /**
67
- * End date for stats (ISO 8601)
68
- */
69
- endDate?: string;
70
-
71
- /**
72
- * Filter by group ID
73
- */
74
- groupId?: string;
75
-
76
- /**
77
- * Start date for stats (ISO 8601)
78
- */
79
- startDate?: string;
80
-
81
- /**
82
- * Filter by user ID
83
- */
84
- userId?: string;
85
- }
86
-
87
- export interface UsageGetSummaryParams {
88
- /**
89
- * End date for summary (ISO 8601)
90
- */
91
- endDate: string;
92
-
93
- /**
94
- * Summary period
95
- */
96
- period: 'hourly' | 'daily' | 'monthly';
97
-
98
- /**
99
- * Start date for summary (ISO 8601)
100
- */
101
- startDate: string;
102
-
103
- /**
104
- * Group results by
105
- */
106
- groupBy?: 'user' | 'group' | 'model' | 'endpoint';
107
- }
108
-
109
- export interface UsageListEventsParams {
110
- /**
111
- * End date for filtering (ISO 8601)
112
- */
113
- endDate?: string;
114
-
115
- /**
116
- * Filter by event type
117
- */
118
- eventType?:
119
- | 'material_created'
120
- | 'material_uploaded'
121
- | 'material_processed'
122
- | 'material_deleted'
123
- | 'component_created'
124
- | 'component_accessed'
125
- | 'component_deleted'
126
- | 'component_usage'
127
- | 'chat_message_sent'
128
- | 'chat_session_started'
129
- | 'chat_session_ended'
130
- | 'test_created'
131
- | 'test_started'
132
- | 'test_completed'
133
- | 'test_question_answered'
134
- | 'test_retaken'
135
- | 'audio_recap_create'
136
- | 'assignment_grader_create'
137
- | 'api_call'
138
- | 'cache_hit'
139
- | 'sso_login'
140
- | 'sso_logout'
141
- | 'student_performance';
142
-
143
- /**
144
- * Filter by group ID
145
- */
146
- groupId?: string;
147
-
148
- /**
149
- * Number of results to return
150
- */
151
- limit?: number;
152
-
153
- /**
154
- * Offset for pagination
155
- */
156
- offset?: number;
157
-
158
- /**
159
- * Filter by resource ID
160
- */
161
- resourceId?: string;
162
-
163
- /**
164
- * Start date for filtering (ISO 8601)
165
- */
166
- startDate?: string;
167
-
168
- /**
169
- * Filter by user ID
170
- */
171
- userId?: string;
172
- }
173
-
174
- export declare namespace Usage {
175
- export {
176
- type UsageGetStatsParams as UsageGetStatsParams,
177
- type UsageGetSummaryParams as UsageGetSummaryParams,
178
- type UsageListEventsParams as UsageListEventsParams,
179
- };
180
- }
3
+ export * from './usage/index';
@@ -35,8 +35,6 @@ import {
35
35
  } from './flashcards';
36
36
  import * as FoldersAPI from './folders';
37
37
  import { FolderCreateParams, FolderListParams, FolderUpdateParams, Folders } from './folders';
38
- import * as UsageAPI from './usage';
39
- import { Usage, UsageGetStatsParams, UsageGetSummaryParams, UsageListEventsParams } from './usage';
40
38
  import * as AudioRecapsAPI from './audio-recaps/audio-recaps';
41
39
  import {
42
40
  AudioRecapAskQuestionParams,
@@ -54,6 +52,7 @@ import {
54
52
  MaterialGetDownloadURLParams,
55
53
  MaterialListParams,
56
54
  MaterialListResponse,
55
+ MaterialSearchParams,
57
56
  Materials,
58
57
  } from './materials/materials';
59
58
  import * as ScenariosAPI from './scenarios/scenarios';
@@ -75,6 +74,8 @@ import {
75
74
  } from './tests/tests';
76
75
  import * as UploadAPI from './upload/upload';
77
76
  import { Upload } from './upload/upload';
77
+ import * as UsageAPI from './usage/usage';
78
+ import { Usage, UsageGetStatsParams, UsageGetSummaryParams, UsageListEventsParams } from './usage/usage';
78
79
 
79
80
  export class V1 extends APIResource {
80
81
  materials: MaterialsAPI.Materials = new MaterialsAPI.Materials(this._client);
@@ -116,6 +117,7 @@ export declare namespace V1 {
116
117
  type MaterialCreateParams as MaterialCreateParams,
117
118
  type MaterialListParams as MaterialListParams,
118
119
  type MaterialGetDownloadURLParams as MaterialGetDownloadURLParams,
120
+ type MaterialSearchParams as MaterialSearchParams,
119
121
  };
120
122
 
121
123
  export {
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '1.18.0'; // x-release-please-version
1
+ export const VERSION = '1.20.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.18.0";
1
+ export declare const VERSION = "1.20.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.18.0";
1
+ export declare const VERSION = "1.20.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.18.0'; // x-release-please-version
4
+ exports.VERSION = '1.20.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '1.18.0'; // x-release-please-version
1
+ export const VERSION = '1.20.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map