@studyfetch/sdk 1.41.0 → 1.42.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 (54) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/README.md +6 -6
  3. package/package.json +1 -1
  4. package/resources/v1/folders.d.mts +2 -77
  5. package/resources/v1/folders.d.mts.map +1 -1
  6. package/resources/v1/folders.d.ts +2 -77
  7. package/resources/v1/folders.d.ts.map +1 -1
  8. package/resources/v1/folders.js.map +1 -1
  9. package/resources/v1/folders.mjs.map +1 -1
  10. package/resources/v1/index.d.mts +1 -1
  11. package/resources/v1/index.d.mts.map +1 -1
  12. package/resources/v1/index.d.ts +1 -1
  13. package/resources/v1/index.d.ts.map +1 -1
  14. package/resources/v1/index.js.map +1 -1
  15. package/resources/v1/index.mjs.map +1 -1
  16. package/resources/v1/materials/index.d.mts +2 -2
  17. package/resources/v1/materials/index.d.mts.map +1 -1
  18. package/resources/v1/materials/index.d.ts +2 -2
  19. package/resources/v1/materials/index.d.ts.map +1 -1
  20. package/resources/v1/materials/index.js.map +1 -1
  21. package/resources/v1/materials/index.mjs.map +1 -1
  22. package/resources/v1/materials/materials.d.mts +179 -834
  23. package/resources/v1/materials/materials.d.mts.map +1 -1
  24. package/resources/v1/materials/materials.d.ts +179 -834
  25. package/resources/v1/materials/materials.d.ts.map +1 -1
  26. package/resources/v1/materials/materials.js +29 -22
  27. package/resources/v1/materials/materials.js.map +1 -1
  28. package/resources/v1/materials/materials.mjs +29 -22
  29. package/resources/v1/materials/materials.mjs.map +1 -1
  30. package/resources/v1/materials/upload.d.mts +14 -407
  31. package/resources/v1/materials/upload.d.mts.map +1 -1
  32. package/resources/v1/materials/upload.d.ts +14 -407
  33. package/resources/v1/materials/upload.d.ts.map +1 -1
  34. package/resources/v1/materials/upload.js +5 -5
  35. package/resources/v1/materials/upload.js.map +1 -1
  36. package/resources/v1/materials/upload.mjs +5 -5
  37. package/resources/v1/materials/upload.mjs.map +1 -1
  38. package/resources/v1/v1.d.mts +2 -2
  39. package/resources/v1/v1.d.mts.map +1 -1
  40. package/resources/v1/v1.d.ts +2 -2
  41. package/resources/v1/v1.d.ts.map +1 -1
  42. package/resources/v1/v1.js.map +1 -1
  43. package/resources/v1/v1.mjs.map +1 -1
  44. package/src/resources/v1/folders.ts +2 -98
  45. package/src/resources/v1/index.ts +5 -9
  46. package/src/resources/v1/materials/index.ts +5 -14
  47. package/src/resources/v1/materials/materials.ts +165 -1018
  48. package/src/resources/v1/materials/upload.ts +16 -520
  49. package/src/resources/v1/v1.ts +10 -18
  50. package/src/version.ts +1 -1
  51. package/version.d.mts +1 -1
  52. package/version.d.ts +1 -1
  53. package/version.js +1 -1
  54. package/version.mjs +1 -1
@@ -1,6 +1,7 @@
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 MaterialsAPI from './materials';
4
5
  import { APIPromise } from '../../../core/api-promise';
5
6
  import { type Uploadable } from '../../../core/uploads';
6
7
  import { RequestOptions } from '../../../internal/request-options';
@@ -12,7 +13,7 @@ export class Upload extends APIResource {
12
13
  *
13
14
  * @example
14
15
  * ```ts
15
- * const response =
16
+ * const materialResponse =
16
17
  * await client.v1.materials.upload.completeUpload({
17
18
  * materialId: 'materialId',
18
19
  * s3Key: 's3Key',
@@ -22,7 +23,7 @@ export class Upload extends APIResource {
22
23
  completeUpload(
23
24
  body: UploadCompleteUploadParams,
24
25
  options?: RequestOptions,
25
- ): APIPromise<UploadCompleteUploadResponse> {
26
+ ): APIPromise<MaterialsAPI.MaterialResponse> {
26
27
  return this._client.post('/api/v1/materials/upload/complete', { body, ...options });
27
28
  }
28
29
 
@@ -51,14 +52,17 @@ export class Upload extends APIResource {
51
52
  *
52
53
  * @example
53
54
  * ```ts
54
- * const response =
55
+ * const materialResponse =
55
56
  * await client.v1.materials.upload.uploadFile({
56
57
  * file: fs.createReadStream('path/to/file'),
57
58
  * name: 'name',
58
59
  * });
59
60
  * ```
60
61
  */
61
- uploadFile(body: UploadUploadFileParams, options?: RequestOptions): APIPromise<UploadUploadFileResponse> {
62
+ uploadFile(
63
+ body: UploadUploadFileParams,
64
+ options?: RequestOptions,
65
+ ): APIPromise<MaterialsAPI.MaterialResponse> {
62
66
  return this._client.post(
63
67
  '/api/v1/materials/upload',
64
68
  multipartFormRequestOptions({ body, ...options }, this._client),
@@ -71,7 +75,7 @@ export class Upload extends APIResource {
71
75
  *
72
76
  * @example
73
77
  * ```ts
74
- * const response =
78
+ * const materialResponse =
75
79
  * await client.v1.materials.upload.uploadFileAndProcess({
76
80
  * file: fs.createReadStream('path/to/file'),
77
81
  * name: 'name',
@@ -81,7 +85,7 @@ export class Upload extends APIResource {
81
85
  uploadFileAndProcess(
82
86
  body: UploadUploadFileAndProcessParams,
83
87
  options?: RequestOptions,
84
- ): APIPromise<UploadUploadFileAndProcessResponse> {
88
+ ): APIPromise<MaterialsAPI.MaterialResponse> {
85
89
  return this._client.post(
86
90
  '/api/v1/materials/upload/file-and-process',
87
91
  multipartFormRequestOptions({ body, ...options }, this._client),
@@ -93,7 +97,7 @@ export class Upload extends APIResource {
93
97
  *
94
98
  * @example
95
99
  * ```ts
96
- * const response =
100
+ * const materialResponse =
97
101
  * await client.v1.materials.upload.uploadFromURL({
98
102
  * name: 'name',
99
103
  * url: 'url',
@@ -103,7 +107,7 @@ export class Upload extends APIResource {
103
107
  uploadFromURL(
104
108
  body: UploadUploadFromURLParams,
105
109
  options?: RequestOptions,
106
- ): APIPromise<UploadUploadFromURLResponse> {
110
+ ): APIPromise<MaterialsAPI.MaterialResponse> {
107
111
  return this._client.post('/api/v1/materials/upload/url', { body, ...options });
108
112
  }
109
113
 
@@ -113,7 +117,7 @@ export class Upload extends APIResource {
113
117
  *
114
118
  * @example
115
119
  * ```ts
116
- * const response =
120
+ * const materialResponse =
117
121
  * await client.v1.materials.upload.uploadFromURLAndProcess({
118
122
  * name: 'My Document',
119
123
  * url: 'https://example.com/document.pdf',
@@ -123,106 +127,11 @@ export class Upload extends APIResource {
123
127
  uploadFromURLAndProcess(
124
128
  body: UploadUploadFromURLAndProcessParams,
125
129
  options?: RequestOptions,
126
- ): APIPromise<UploadUploadFromURLAndProcessResponse> {
130
+ ): APIPromise<MaterialsAPI.MaterialResponse> {
127
131
  return this._client.post('/api/v1/materials/upload/url-and-process', { body, ...options });
128
132
  }
129
133
  }
130
134
 
131
- export interface UploadCompleteUploadResponse {
132
- /**
133
- * Material ID
134
- */
135
- _id: string;
136
-
137
- /**
138
- * Material content
139
- */
140
- content: UploadCompleteUploadResponse.Content;
141
-
142
- /**
143
- * Content type
144
- */
145
- contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
146
-
147
- /**
148
- * Creation timestamp
149
- */
150
- createdAt: string;
151
-
152
- /**
153
- * Folder ID
154
- */
155
- folderId: string | null;
156
-
157
- /**
158
- * Material name
159
- */
160
- name: string;
161
-
162
- /**
163
- * Organization ID
164
- */
165
- organizationId: string;
166
-
167
- /**
168
- * Material status
169
- */
170
- status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
171
-
172
- /**
173
- * Last update timestamp
174
- */
175
- updatedAt: string;
176
-
177
- /**
178
- * Material metadata
179
- */
180
- metadata?: unknown;
181
-
182
- /**
183
- * References that this material cites
184
- */
185
- references?: Array<UploadCompleteUploadResponse.Reference>;
186
-
187
- /**
188
- * Usage information
189
- */
190
- usage?: unknown;
191
- }
192
-
193
- export namespace UploadCompleteUploadResponse {
194
- /**
195
- * Material content
196
- */
197
- export interface Content {
198
- filename?: string;
199
-
200
- fileSize?: number;
201
-
202
- mimeType?: string;
203
-
204
- s3Key?: string;
205
-
206
- s3Url?: string;
207
-
208
- text?: string;
209
-
210
- url?: string;
211
- }
212
-
213
- export interface Reference {
214
- /**
215
- * Reference title
216
- */
217
- title: string;
218
-
219
- /**
220
- * Reference URL
221
- */
222
- url?: string;
223
- }
224
- }
225
-
226
135
  export interface UploadGetPresignedURLResponse {
227
136
  /**
228
137
  * Material ID to use for completion
@@ -240,386 +149,6 @@ export interface UploadGetPresignedURLResponse {
240
149
  uploadUrl: string;
241
150
  }
242
151
 
243
- export interface UploadUploadFileResponse {
244
- /**
245
- * Material ID
246
- */
247
- _id: string;
248
-
249
- /**
250
- * Material content
251
- */
252
- content: UploadUploadFileResponse.Content;
253
-
254
- /**
255
- * Content type
256
- */
257
- contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
258
-
259
- /**
260
- * Creation timestamp
261
- */
262
- createdAt: string;
263
-
264
- /**
265
- * Folder ID
266
- */
267
- folderId: string | null;
268
-
269
- /**
270
- * Material name
271
- */
272
- name: string;
273
-
274
- /**
275
- * Organization ID
276
- */
277
- organizationId: string;
278
-
279
- /**
280
- * Material status
281
- */
282
- status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
283
-
284
- /**
285
- * Last update timestamp
286
- */
287
- updatedAt: string;
288
-
289
- /**
290
- * Material metadata
291
- */
292
- metadata?: unknown;
293
-
294
- /**
295
- * References that this material cites
296
- */
297
- references?: Array<UploadUploadFileResponse.Reference>;
298
-
299
- /**
300
- * Usage information
301
- */
302
- usage?: unknown;
303
- }
304
-
305
- export namespace UploadUploadFileResponse {
306
- /**
307
- * Material content
308
- */
309
- export interface Content {
310
- filename?: string;
311
-
312
- fileSize?: number;
313
-
314
- mimeType?: string;
315
-
316
- s3Key?: string;
317
-
318
- s3Url?: string;
319
-
320
- text?: string;
321
-
322
- url?: string;
323
- }
324
-
325
- export interface Reference {
326
- /**
327
- * Reference title
328
- */
329
- title: string;
330
-
331
- /**
332
- * Reference URL
333
- */
334
- url?: string;
335
- }
336
- }
337
-
338
- export interface UploadUploadFileAndProcessResponse {
339
- /**
340
- * Material ID
341
- */
342
- _id: string;
343
-
344
- /**
345
- * Material content
346
- */
347
- content: UploadUploadFileAndProcessResponse.Content;
348
-
349
- /**
350
- * Content type
351
- */
352
- contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
353
-
354
- /**
355
- * Creation timestamp
356
- */
357
- createdAt: string;
358
-
359
- /**
360
- * Folder ID
361
- */
362
- folderId: string | null;
363
-
364
- /**
365
- * Material name
366
- */
367
- name: string;
368
-
369
- /**
370
- * Organization ID
371
- */
372
- organizationId: string;
373
-
374
- /**
375
- * Material status
376
- */
377
- status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
378
-
379
- /**
380
- * Last update timestamp
381
- */
382
- updatedAt: string;
383
-
384
- /**
385
- * Material metadata
386
- */
387
- metadata?: unknown;
388
-
389
- /**
390
- * References that this material cites
391
- */
392
- references?: Array<UploadUploadFileAndProcessResponse.Reference>;
393
-
394
- /**
395
- * Usage information
396
- */
397
- usage?: unknown;
398
- }
399
-
400
- export namespace UploadUploadFileAndProcessResponse {
401
- /**
402
- * Material content
403
- */
404
- export interface Content {
405
- filename?: string;
406
-
407
- fileSize?: number;
408
-
409
- mimeType?: string;
410
-
411
- s3Key?: string;
412
-
413
- s3Url?: string;
414
-
415
- text?: string;
416
-
417
- url?: string;
418
- }
419
-
420
- export interface Reference {
421
- /**
422
- * Reference title
423
- */
424
- title: string;
425
-
426
- /**
427
- * Reference URL
428
- */
429
- url?: string;
430
- }
431
- }
432
-
433
- export interface UploadUploadFromURLResponse {
434
- /**
435
- * Material ID
436
- */
437
- _id: string;
438
-
439
- /**
440
- * Material content
441
- */
442
- content: UploadUploadFromURLResponse.Content;
443
-
444
- /**
445
- * Content type
446
- */
447
- contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
448
-
449
- /**
450
- * Creation timestamp
451
- */
452
- createdAt: string;
453
-
454
- /**
455
- * Folder ID
456
- */
457
- folderId: string | null;
458
-
459
- /**
460
- * Material name
461
- */
462
- name: string;
463
-
464
- /**
465
- * Organization ID
466
- */
467
- organizationId: string;
468
-
469
- /**
470
- * Material status
471
- */
472
- status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
473
-
474
- /**
475
- * Last update timestamp
476
- */
477
- updatedAt: string;
478
-
479
- /**
480
- * Material metadata
481
- */
482
- metadata?: unknown;
483
-
484
- /**
485
- * References that this material cites
486
- */
487
- references?: Array<UploadUploadFromURLResponse.Reference>;
488
-
489
- /**
490
- * Usage information
491
- */
492
- usage?: unknown;
493
- }
494
-
495
- export namespace UploadUploadFromURLResponse {
496
- /**
497
- * Material content
498
- */
499
- export interface Content {
500
- filename?: string;
501
-
502
- fileSize?: number;
503
-
504
- mimeType?: string;
505
-
506
- s3Key?: string;
507
-
508
- s3Url?: string;
509
-
510
- text?: string;
511
-
512
- url?: string;
513
- }
514
-
515
- export interface Reference {
516
- /**
517
- * Reference title
518
- */
519
- title: string;
520
-
521
- /**
522
- * Reference URL
523
- */
524
- url?: string;
525
- }
526
- }
527
-
528
- export interface UploadUploadFromURLAndProcessResponse {
529
- /**
530
- * Material ID
531
- */
532
- _id: string;
533
-
534
- /**
535
- * Material content
536
- */
537
- content: UploadUploadFromURLAndProcessResponse.Content;
538
-
539
- /**
540
- * Content type
541
- */
542
- contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
543
-
544
- /**
545
- * Creation timestamp
546
- */
547
- createdAt: string;
548
-
549
- /**
550
- * Folder ID
551
- */
552
- folderId: string | null;
553
-
554
- /**
555
- * Material name
556
- */
557
- name: string;
558
-
559
- /**
560
- * Organization ID
561
- */
562
- organizationId: string;
563
-
564
- /**
565
- * Material status
566
- */
567
- status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
568
-
569
- /**
570
- * Last update timestamp
571
- */
572
- updatedAt: string;
573
-
574
- /**
575
- * Material metadata
576
- */
577
- metadata?: unknown;
578
-
579
- /**
580
- * References that this material cites
581
- */
582
- references?: Array<UploadUploadFromURLAndProcessResponse.Reference>;
583
-
584
- /**
585
- * Usage information
586
- */
587
- usage?: unknown;
588
- }
589
-
590
- export namespace UploadUploadFromURLAndProcessResponse {
591
- /**
592
- * Material content
593
- */
594
- export interface Content {
595
- filename?: string;
596
-
597
- fileSize?: number;
598
-
599
- mimeType?: string;
600
-
601
- s3Key?: string;
602
-
603
- s3Url?: string;
604
-
605
- text?: string;
606
-
607
- url?: string;
608
- }
609
-
610
- export interface Reference {
611
- /**
612
- * Reference title
613
- */
614
- title: string;
615
-
616
- /**
617
- * Reference URL
618
- */
619
- url?: string;
620
- }
621
- }
622
-
623
152
  export interface UploadCompleteUploadParams {
624
153
  /**
625
154
  * Material ID from presigned URL response
@@ -661,21 +190,7 @@ export interface UploadGetPresignedURLParams {
661
190
  /**
662
191
  * References that this material cites
663
192
  */
664
- references?: Array<UploadGetPresignedURLParams.Reference>;
665
- }
666
-
667
- export namespace UploadGetPresignedURLParams {
668
- export interface Reference {
669
- /**
670
- * Reference title
671
- */
672
- title: string;
673
-
674
- /**
675
- * Reference URL
676
- */
677
- url?: string;
678
- }
193
+ references?: Array<MaterialsAPI.Reference>;
679
194
  }
680
195
 
681
196
  export interface UploadUploadFileParams {
@@ -772,7 +287,7 @@ export interface UploadUploadFromURLAndProcessParams {
772
287
  /**
773
288
  * References that this material cites
774
289
  */
775
- references?: Array<UploadUploadFromURLAndProcessParams.Reference>;
290
+ references?: Array<MaterialsAPI.Reference>;
776
291
 
777
292
  /**
778
293
  * Maximum time to wait for processing in milliseconds (default: 5 minutes)
@@ -780,28 +295,9 @@ export interface UploadUploadFromURLAndProcessParams {
780
295
  timeoutMs?: number;
781
296
  }
782
297
 
783
- export namespace UploadUploadFromURLAndProcessParams {
784
- export interface Reference {
785
- /**
786
- * Reference title
787
- */
788
- title: string;
789
-
790
- /**
791
- * Reference URL
792
- */
793
- url?: string;
794
- }
795
- }
796
-
797
298
  export declare namespace Upload {
798
299
  export {
799
- type UploadCompleteUploadResponse as UploadCompleteUploadResponse,
800
300
  type UploadGetPresignedURLResponse as UploadGetPresignedURLResponse,
801
- type UploadUploadFileResponse as UploadUploadFileResponse,
802
- type UploadUploadFileAndProcessResponse as UploadUploadFileAndProcessResponse,
803
- type UploadUploadFromURLResponse as UploadUploadFromURLResponse,
804
- type UploadUploadFromURLAndProcessResponse as UploadUploadFromURLAndProcessResponse,
805
301
  type UploadCompleteUploadParams as UploadCompleteUploadParams,
806
302
  type UploadGetPresignedURLParams as UploadGetPresignedURLParams,
807
303
  type UploadUploadFileParams as UploadUploadFileParams,
@@ -64,31 +64,27 @@ import * as EmbedAPI from './embed/embed';
64
64
  import { Embed, EmbedGetThemeParams, EmbedVerifyParams } from './embed/embed';
65
65
  import * as MaterialsAPI from './materials/materials';
66
66
  import {
67
+ Content,
68
+ GeneratedMaterialResponse,
67
69
  MaterialCreateAndProcessParams,
68
- MaterialCreateAndProcessResponse,
69
70
  MaterialCreateBatchUploadURLsParams,
70
71
  MaterialCreateBatchUploadURLsResponse,
71
72
  MaterialCreateParams,
72
- MaterialCreateResponse,
73
73
  MaterialGenerateAndProcessParams,
74
- MaterialGenerateAndProcessResponse,
75
74
  MaterialGenerateParams,
76
- MaterialGenerateResponse,
77
75
  MaterialGetDebugInfoResponse,
78
76
  MaterialGetDownloadURLParams,
79
77
  MaterialGetDownloadURLResponse,
80
78
  MaterialListParams,
81
79
  MaterialListResponse,
82
80
  MaterialMoveParams,
83
- MaterialMoveResponse,
84
81
  MaterialRenameParams,
85
- MaterialRenameResponse,
86
- MaterialReprocessResponse,
87
- MaterialRetrieveResponse,
82
+ MaterialResponse,
88
83
  MaterialSearchParams,
89
84
  MaterialSearchResponse,
90
- MaterialUpdateResponse,
85
+ MaterialUpdateParams,
91
86
  Materials,
87
+ Reference,
92
88
  } from './materials/materials';
93
89
  import { APIPromise } from '../../core/api-promise';
94
90
  import { buildHeaders } from '../../internal/headers';
@@ -206,21 +202,17 @@ export declare namespace V1 {
206
202
 
207
203
  export {
208
204
  Materials as Materials,
209
- type MaterialCreateResponse as MaterialCreateResponse,
210
- type MaterialRetrieveResponse as MaterialRetrieveResponse,
211
- type MaterialUpdateResponse as MaterialUpdateResponse,
205
+ type Content as Content,
206
+ type GeneratedMaterialResponse as GeneratedMaterialResponse,
207
+ type MaterialResponse as MaterialResponse,
208
+ type Reference as Reference,
212
209
  type MaterialListResponse as MaterialListResponse,
213
- type MaterialCreateAndProcessResponse as MaterialCreateAndProcessResponse,
214
210
  type MaterialCreateBatchUploadURLsResponse as MaterialCreateBatchUploadURLsResponse,
215
- type MaterialGenerateResponse as MaterialGenerateResponse,
216
- type MaterialGenerateAndProcessResponse as MaterialGenerateAndProcessResponse,
217
211
  type MaterialGetDebugInfoResponse as MaterialGetDebugInfoResponse,
218
212
  type MaterialGetDownloadURLResponse as MaterialGetDownloadURLResponse,
219
- type MaterialMoveResponse as MaterialMoveResponse,
220
- type MaterialRenameResponse as MaterialRenameResponse,
221
- type MaterialReprocessResponse as MaterialReprocessResponse,
222
213
  type MaterialSearchResponse as MaterialSearchResponse,
223
214
  type MaterialCreateParams as MaterialCreateParams,
215
+ type MaterialUpdateParams as MaterialUpdateParams,
224
216
  type MaterialListParams as MaterialListParams,
225
217
  type MaterialCreateAndProcessParams as MaterialCreateAndProcessParams,
226
218
  type MaterialCreateBatchUploadURLsParams as MaterialCreateBatchUploadURLsParams,
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '1.41.0'; // x-release-please-version
1
+ export const VERSION = '1.42.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.41.0";
1
+ export declare const VERSION = "1.42.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "1.41.0";
1
+ export declare const VERSION = "1.42.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.41.0'; // x-release-please-version
4
+ exports.VERSION = '1.42.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map