@studyfetch/sdk 1.34.0 → 1.36.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/v1/folders.d.mts +530 -21
- package/resources/v1/folders.d.mts.map +1 -1
- package/resources/v1/folders.d.ts +530 -21
- package/resources/v1/folders.d.ts.map +1 -1
- package/resources/v1/folders.js +26 -40
- package/resources/v1/folders.js.map +1 -1
- package/resources/v1/folders.mjs +26 -40
- package/resources/v1/folders.mjs.map +1 -1
- package/resources/v1/index.d.mts +1 -1
- package/resources/v1/index.d.mts.map +1 -1
- package/resources/v1/index.d.ts +1 -1
- package/resources/v1/index.d.ts.map +1 -1
- package/resources/v1/index.js.map +1 -1
- package/resources/v1/index.mjs +1 -1
- package/resources/v1/index.mjs.map +1 -1
- package/resources/v1/materials/materials.d.mts +29 -62
- package/resources/v1/materials/materials.d.mts.map +1 -1
- package/resources/v1/materials/materials.d.ts +29 -62
- package/resources/v1/materials/materials.d.ts.map +1 -1
- package/resources/v1/materials/materials.js.map +1 -1
- package/resources/v1/materials/materials.mjs.map +1 -1
- package/resources/v1/v1.d.mts +2 -2
- package/resources/v1/v1.d.mts.map +1 -1
- package/resources/v1/v1.d.ts +2 -2
- package/resources/v1/v1.d.ts.map +1 -1
- package/resources/v1/v1.js.map +1 -1
- package/resources/v1/v1.mjs +1 -1
- package/resources/v1/v1.mjs.map +1 -1
- package/src/client.ts +2 -0
- package/src/resources/v1/folders.ts +666 -51
- package/src/resources/v1/index.ts +15 -1
- package/src/resources/v1/materials/materials.ts +31 -76
- package/src/resources/v1/v1.ts +24 -1
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -7,37 +7,39 @@ export declare class Folders extends APIResource {
|
|
|
7
7
|
*
|
|
8
8
|
* @example
|
|
9
9
|
* ```ts
|
|
10
|
-
* await client.v1.folders.create({
|
|
10
|
+
* const folder = await client.v1.folders.create({
|
|
11
|
+
* name: 'name',
|
|
12
|
+
* });
|
|
11
13
|
* ```
|
|
12
14
|
*/
|
|
13
|
-
create(body: FolderCreateParams, options?: RequestOptions): APIPromise<
|
|
15
|
+
create(body: FolderCreateParams, options?: RequestOptions): APIPromise<FolderCreateResponse>;
|
|
14
16
|
/**
|
|
15
17
|
* Get folder by ID
|
|
16
18
|
*
|
|
17
19
|
* @example
|
|
18
20
|
* ```ts
|
|
19
|
-
* await client.v1.folders.retrieve('id');
|
|
21
|
+
* const folder = await client.v1.folders.retrieve('id');
|
|
20
22
|
* ```
|
|
21
23
|
*/
|
|
22
|
-
retrieve(id: string, options?: RequestOptions): APIPromise<
|
|
24
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<FolderRetrieveResponse>;
|
|
23
25
|
/**
|
|
24
26
|
* Update folder
|
|
25
27
|
*
|
|
26
28
|
* @example
|
|
27
29
|
* ```ts
|
|
28
|
-
* await client.v1.folders.update('id');
|
|
30
|
+
* const folder = await client.v1.folders.update('id');
|
|
29
31
|
* ```
|
|
30
32
|
*/
|
|
31
|
-
update(id: string, body: FolderUpdateParams, options?: RequestOptions): APIPromise<
|
|
33
|
+
update(id: string, body: FolderUpdateParams, options?: RequestOptions): APIPromise<FolderUpdateResponse>;
|
|
32
34
|
/**
|
|
33
35
|
* Get all folders
|
|
34
36
|
*
|
|
35
37
|
* @example
|
|
36
38
|
* ```ts
|
|
37
|
-
* await client.v1.folders.list();
|
|
39
|
+
* const folders = await client.v1.folders.list();
|
|
38
40
|
* ```
|
|
39
41
|
*/
|
|
40
|
-
list(query?: FolderListParams | null | undefined, options?: RequestOptions): APIPromise<
|
|
42
|
+
list(query?: FolderListParams | null | undefined, options?: RequestOptions): APIPromise<FolderListResponse>;
|
|
41
43
|
/**
|
|
42
44
|
* Delete folder
|
|
43
45
|
*
|
|
@@ -52,24 +54,503 @@ export declare class Folders extends APIResource {
|
|
|
52
54
|
*
|
|
53
55
|
* @example
|
|
54
56
|
* ```ts
|
|
55
|
-
* await client.v1.folders.getTree();
|
|
57
|
+
* const response = await client.v1.folders.getTree();
|
|
56
58
|
* ```
|
|
57
59
|
*/
|
|
58
|
-
getTree(options?: RequestOptions): APIPromise<
|
|
60
|
+
getTree(options?: RequestOptions): APIPromise<FolderGetTreeResponse>;
|
|
59
61
|
/**
|
|
62
|
+
* Get all materials in folder
|
|
63
|
+
*
|
|
60
64
|
* @example
|
|
61
65
|
* ```ts
|
|
62
|
-
* await client.v1.folders.listMaterials(
|
|
66
|
+
* const response = await client.v1.folders.listMaterials(
|
|
67
|
+
* 'id',
|
|
68
|
+
* );
|
|
63
69
|
* ```
|
|
64
70
|
*/
|
|
65
|
-
listMaterials(id: string, options?: RequestOptions): APIPromise<
|
|
71
|
+
listMaterials(id: string, query?: FolderListMaterialsParams | null | undefined, options?: RequestOptions): APIPromise<FolderListMaterialsResponse>;
|
|
66
72
|
/**
|
|
73
|
+
* Move folder to new parent
|
|
74
|
+
*
|
|
67
75
|
* @example
|
|
68
76
|
* ```ts
|
|
69
|
-
* await client.v1.folders.move('id'
|
|
77
|
+
* const response = await client.v1.folders.move('id', {
|
|
78
|
+
* parentFolderId: 'parentFolderId',
|
|
79
|
+
* });
|
|
70
80
|
* ```
|
|
71
81
|
*/
|
|
72
|
-
move(id: string, options?: RequestOptions): APIPromise<
|
|
82
|
+
move(id: string, body: FolderMoveParams, options?: RequestOptions): APIPromise<FolderMoveResponse>;
|
|
83
|
+
}
|
|
84
|
+
export interface FolderCreateResponse {
|
|
85
|
+
/**
|
|
86
|
+
* Folder ID
|
|
87
|
+
*/
|
|
88
|
+
_id: string;
|
|
89
|
+
/**
|
|
90
|
+
* Creation date
|
|
91
|
+
*/
|
|
92
|
+
createdAt: string;
|
|
93
|
+
/**
|
|
94
|
+
* Folder name
|
|
95
|
+
*/
|
|
96
|
+
name: string;
|
|
97
|
+
/**
|
|
98
|
+
* Organization ID
|
|
99
|
+
*/
|
|
100
|
+
organizationId: string;
|
|
101
|
+
/**
|
|
102
|
+
* Folder status
|
|
103
|
+
*/
|
|
104
|
+
status: 'active' | 'deleted';
|
|
105
|
+
/**
|
|
106
|
+
* Last update date
|
|
107
|
+
*/
|
|
108
|
+
updatedAt: string;
|
|
109
|
+
/**
|
|
110
|
+
* Folder description
|
|
111
|
+
*/
|
|
112
|
+
description?: string;
|
|
113
|
+
/**
|
|
114
|
+
* Folder metadata
|
|
115
|
+
*/
|
|
116
|
+
metadata?: FolderCreateResponse.Metadata;
|
|
117
|
+
/**
|
|
118
|
+
* Parent folder ID
|
|
119
|
+
*/
|
|
120
|
+
parentFolderId?: string | null;
|
|
121
|
+
}
|
|
122
|
+
export declare namespace FolderCreateResponse {
|
|
123
|
+
/**
|
|
124
|
+
* Folder metadata
|
|
125
|
+
*/
|
|
126
|
+
interface Metadata {
|
|
127
|
+
/**
|
|
128
|
+
* Folder color
|
|
129
|
+
*/
|
|
130
|
+
color?: string;
|
|
131
|
+
/**
|
|
132
|
+
* Folder icon
|
|
133
|
+
*/
|
|
134
|
+
icon?: string;
|
|
135
|
+
/**
|
|
136
|
+
* Last activity date
|
|
137
|
+
*/
|
|
138
|
+
lastActivity?: string;
|
|
139
|
+
/**
|
|
140
|
+
* Number of materials in folder
|
|
141
|
+
*/
|
|
142
|
+
materialCount?: number;
|
|
143
|
+
/**
|
|
144
|
+
* Total size of materials in folder
|
|
145
|
+
*/
|
|
146
|
+
totalSize?: number;
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
export interface FolderRetrieveResponse {
|
|
150
|
+
/**
|
|
151
|
+
* Folder ID
|
|
152
|
+
*/
|
|
153
|
+
_id: unknown;
|
|
154
|
+
/**
|
|
155
|
+
* Total number of materials
|
|
156
|
+
*/
|
|
157
|
+
materialCount: number;
|
|
158
|
+
/**
|
|
159
|
+
* Folder name
|
|
160
|
+
*/
|
|
161
|
+
name: string;
|
|
162
|
+
/**
|
|
163
|
+
* Organization ID
|
|
164
|
+
*/
|
|
165
|
+
organizationId: string;
|
|
166
|
+
/**
|
|
167
|
+
* Folder status
|
|
168
|
+
*/
|
|
169
|
+
status: 'active' | 'deleted';
|
|
170
|
+
/**
|
|
171
|
+
* Subfolders
|
|
172
|
+
*/
|
|
173
|
+
subfolders: Array<unknown>;
|
|
174
|
+
/**
|
|
175
|
+
* Creation date
|
|
176
|
+
*/
|
|
177
|
+
createdAt?: unknown;
|
|
178
|
+
/**
|
|
179
|
+
* Folder description
|
|
180
|
+
*/
|
|
181
|
+
description?: string;
|
|
182
|
+
/**
|
|
183
|
+
* Folder metadata
|
|
184
|
+
*/
|
|
185
|
+
metadata?: FolderRetrieveResponse.Metadata;
|
|
186
|
+
/**
|
|
187
|
+
* Parent folder ID
|
|
188
|
+
*/
|
|
189
|
+
parentFolderId?: string | null;
|
|
190
|
+
/**
|
|
191
|
+
* Last update date
|
|
192
|
+
*/
|
|
193
|
+
updatedAt?: unknown;
|
|
194
|
+
}
|
|
195
|
+
export declare namespace FolderRetrieveResponse {
|
|
196
|
+
/**
|
|
197
|
+
* Folder metadata
|
|
198
|
+
*/
|
|
199
|
+
interface Metadata {
|
|
200
|
+
/**
|
|
201
|
+
* Folder color
|
|
202
|
+
*/
|
|
203
|
+
color?: string;
|
|
204
|
+
/**
|
|
205
|
+
* Folder icon
|
|
206
|
+
*/
|
|
207
|
+
icon?: string;
|
|
208
|
+
/**
|
|
209
|
+
* Last activity date
|
|
210
|
+
*/
|
|
211
|
+
lastActivity?: string;
|
|
212
|
+
/**
|
|
213
|
+
* Number of materials in folder
|
|
214
|
+
*/
|
|
215
|
+
materialCount?: number;
|
|
216
|
+
/**
|
|
217
|
+
* Total size of materials in folder
|
|
218
|
+
*/
|
|
219
|
+
totalSize?: number;
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
export interface FolderUpdateResponse {
|
|
223
|
+
/**
|
|
224
|
+
* Folder ID
|
|
225
|
+
*/
|
|
226
|
+
_id: string;
|
|
227
|
+
/**
|
|
228
|
+
* Creation date
|
|
229
|
+
*/
|
|
230
|
+
createdAt: string;
|
|
231
|
+
/**
|
|
232
|
+
* Folder name
|
|
233
|
+
*/
|
|
234
|
+
name: string;
|
|
235
|
+
/**
|
|
236
|
+
* Organization ID
|
|
237
|
+
*/
|
|
238
|
+
organizationId: string;
|
|
239
|
+
/**
|
|
240
|
+
* Folder status
|
|
241
|
+
*/
|
|
242
|
+
status: 'active' | 'deleted';
|
|
243
|
+
/**
|
|
244
|
+
* Last update date
|
|
245
|
+
*/
|
|
246
|
+
updatedAt: string;
|
|
247
|
+
/**
|
|
248
|
+
* Folder description
|
|
249
|
+
*/
|
|
250
|
+
description?: string;
|
|
251
|
+
/**
|
|
252
|
+
* Folder metadata
|
|
253
|
+
*/
|
|
254
|
+
metadata?: FolderUpdateResponse.Metadata;
|
|
255
|
+
/**
|
|
256
|
+
* Parent folder ID
|
|
257
|
+
*/
|
|
258
|
+
parentFolderId?: string | null;
|
|
259
|
+
}
|
|
260
|
+
export declare namespace FolderUpdateResponse {
|
|
261
|
+
/**
|
|
262
|
+
* Folder metadata
|
|
263
|
+
*/
|
|
264
|
+
interface Metadata {
|
|
265
|
+
/**
|
|
266
|
+
* Folder color
|
|
267
|
+
*/
|
|
268
|
+
color?: string;
|
|
269
|
+
/**
|
|
270
|
+
* Folder icon
|
|
271
|
+
*/
|
|
272
|
+
icon?: string;
|
|
273
|
+
/**
|
|
274
|
+
* Last activity date
|
|
275
|
+
*/
|
|
276
|
+
lastActivity?: string;
|
|
277
|
+
/**
|
|
278
|
+
* Number of materials in folder
|
|
279
|
+
*/
|
|
280
|
+
materialCount?: number;
|
|
281
|
+
/**
|
|
282
|
+
* Total size of materials in folder
|
|
283
|
+
*/
|
|
284
|
+
totalSize?: number;
|
|
285
|
+
}
|
|
286
|
+
}
|
|
287
|
+
export type FolderListResponse = Array<FolderListResponse.FolderListResponseItem>;
|
|
288
|
+
export declare namespace FolderListResponse {
|
|
289
|
+
interface FolderListResponseItem {
|
|
290
|
+
/**
|
|
291
|
+
* Folder ID
|
|
292
|
+
*/
|
|
293
|
+
_id: string;
|
|
294
|
+
/**
|
|
295
|
+
* Creation date
|
|
296
|
+
*/
|
|
297
|
+
createdAt: string;
|
|
298
|
+
/**
|
|
299
|
+
* Folder name
|
|
300
|
+
*/
|
|
301
|
+
name: string;
|
|
302
|
+
/**
|
|
303
|
+
* Organization ID
|
|
304
|
+
*/
|
|
305
|
+
organizationId: string;
|
|
306
|
+
/**
|
|
307
|
+
* Folder status
|
|
308
|
+
*/
|
|
309
|
+
status: 'active' | 'deleted';
|
|
310
|
+
/**
|
|
311
|
+
* Last update date
|
|
312
|
+
*/
|
|
313
|
+
updatedAt: string;
|
|
314
|
+
/**
|
|
315
|
+
* Folder description
|
|
316
|
+
*/
|
|
317
|
+
description?: string;
|
|
318
|
+
/**
|
|
319
|
+
* Folder metadata
|
|
320
|
+
*/
|
|
321
|
+
metadata?: FolderListResponseItem.Metadata;
|
|
322
|
+
/**
|
|
323
|
+
* Parent folder ID
|
|
324
|
+
*/
|
|
325
|
+
parentFolderId?: string | null;
|
|
326
|
+
}
|
|
327
|
+
namespace FolderListResponseItem {
|
|
328
|
+
/**
|
|
329
|
+
* Folder metadata
|
|
330
|
+
*/
|
|
331
|
+
interface Metadata {
|
|
332
|
+
/**
|
|
333
|
+
* Folder color
|
|
334
|
+
*/
|
|
335
|
+
color?: string;
|
|
336
|
+
/**
|
|
337
|
+
* Folder icon
|
|
338
|
+
*/
|
|
339
|
+
icon?: string;
|
|
340
|
+
/**
|
|
341
|
+
* Last activity date
|
|
342
|
+
*/
|
|
343
|
+
lastActivity?: string;
|
|
344
|
+
/**
|
|
345
|
+
* Number of materials in folder
|
|
346
|
+
*/
|
|
347
|
+
materialCount?: number;
|
|
348
|
+
/**
|
|
349
|
+
* Total size of materials in folder
|
|
350
|
+
*/
|
|
351
|
+
totalSize?: number;
|
|
352
|
+
}
|
|
353
|
+
}
|
|
354
|
+
}
|
|
355
|
+
export type FolderGetTreeResponse = Array<FolderGetTreeResponse.FolderGetTreeResponseItem>;
|
|
356
|
+
export declare namespace FolderGetTreeResponse {
|
|
357
|
+
interface FolderGetTreeResponseItem {
|
|
358
|
+
/**
|
|
359
|
+
* Folder ID
|
|
360
|
+
*/
|
|
361
|
+
_id: unknown;
|
|
362
|
+
/**
|
|
363
|
+
* Folder name
|
|
364
|
+
*/
|
|
365
|
+
name: string;
|
|
366
|
+
/**
|
|
367
|
+
* Organization ID
|
|
368
|
+
*/
|
|
369
|
+
organizationId: string;
|
|
370
|
+
/**
|
|
371
|
+
* Folder status
|
|
372
|
+
*/
|
|
373
|
+
status: 'active' | 'deleted';
|
|
374
|
+
/**
|
|
375
|
+
* Nested subfolders
|
|
376
|
+
*/
|
|
377
|
+
subfolders: Array<unknown>;
|
|
378
|
+
/**
|
|
379
|
+
* Creation date
|
|
380
|
+
*/
|
|
381
|
+
createdAt?: unknown;
|
|
382
|
+
/**
|
|
383
|
+
* Folder description
|
|
384
|
+
*/
|
|
385
|
+
description?: string;
|
|
386
|
+
/**
|
|
387
|
+
* Folder metadata
|
|
388
|
+
*/
|
|
389
|
+
metadata?: FolderGetTreeResponseItem.Metadata;
|
|
390
|
+
/**
|
|
391
|
+
* Parent folder ID
|
|
392
|
+
*/
|
|
393
|
+
parentFolderId?: string | null;
|
|
394
|
+
/**
|
|
395
|
+
* Last update date
|
|
396
|
+
*/
|
|
397
|
+
updatedAt?: unknown;
|
|
398
|
+
}
|
|
399
|
+
namespace FolderGetTreeResponseItem {
|
|
400
|
+
/**
|
|
401
|
+
* Folder metadata
|
|
402
|
+
*/
|
|
403
|
+
interface Metadata {
|
|
404
|
+
/**
|
|
405
|
+
* Folder color
|
|
406
|
+
*/
|
|
407
|
+
color?: string;
|
|
408
|
+
/**
|
|
409
|
+
* Folder icon
|
|
410
|
+
*/
|
|
411
|
+
icon?: string;
|
|
412
|
+
/**
|
|
413
|
+
* Last activity date
|
|
414
|
+
*/
|
|
415
|
+
lastActivity?: string;
|
|
416
|
+
/**
|
|
417
|
+
* Number of materials in folder
|
|
418
|
+
*/
|
|
419
|
+
materialCount?: number;
|
|
420
|
+
/**
|
|
421
|
+
* Total size of materials in folder
|
|
422
|
+
*/
|
|
423
|
+
totalSize?: number;
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
}
|
|
427
|
+
export type FolderListMaterialsResponse = Array<FolderListMaterialsResponse.FolderListMaterialsResponseItem>;
|
|
428
|
+
export declare namespace FolderListMaterialsResponse {
|
|
429
|
+
interface FolderListMaterialsResponseItem {
|
|
430
|
+
/**
|
|
431
|
+
* Material ID
|
|
432
|
+
*/
|
|
433
|
+
_id: string;
|
|
434
|
+
/**
|
|
435
|
+
* Material content
|
|
436
|
+
*/
|
|
437
|
+
content: FolderListMaterialsResponseItem.Content;
|
|
438
|
+
/**
|
|
439
|
+
* Content type
|
|
440
|
+
*/
|
|
441
|
+
contentType: 'text' | 'pdf' | 'video' | 'audio' | 'image' | 'epub';
|
|
442
|
+
/**
|
|
443
|
+
* Creation timestamp
|
|
444
|
+
*/
|
|
445
|
+
createdAt: string;
|
|
446
|
+
/**
|
|
447
|
+
* Folder ID
|
|
448
|
+
*/
|
|
449
|
+
folderId: string | null;
|
|
450
|
+
/**
|
|
451
|
+
* Material name
|
|
452
|
+
*/
|
|
453
|
+
name: string;
|
|
454
|
+
/**
|
|
455
|
+
* Organization ID
|
|
456
|
+
*/
|
|
457
|
+
organizationId: string;
|
|
458
|
+
/**
|
|
459
|
+
* Material status
|
|
460
|
+
*/
|
|
461
|
+
status: 'active' | 'processing' | 'pending_upload' | 'error' | 'deleted';
|
|
462
|
+
/**
|
|
463
|
+
* Last update timestamp
|
|
464
|
+
*/
|
|
465
|
+
updatedAt: string;
|
|
466
|
+
/**
|
|
467
|
+
* Material metadata
|
|
468
|
+
*/
|
|
469
|
+
metadata?: unknown;
|
|
470
|
+
/**
|
|
471
|
+
* Usage information
|
|
472
|
+
*/
|
|
473
|
+
usage?: unknown;
|
|
474
|
+
}
|
|
475
|
+
namespace FolderListMaterialsResponseItem {
|
|
476
|
+
/**
|
|
477
|
+
* Material content
|
|
478
|
+
*/
|
|
479
|
+
interface Content {
|
|
480
|
+
filename?: string;
|
|
481
|
+
fileSize?: number;
|
|
482
|
+
mimeType?: string;
|
|
483
|
+
s3Key?: string;
|
|
484
|
+
s3Url?: string;
|
|
485
|
+
text?: string;
|
|
486
|
+
url?: string;
|
|
487
|
+
}
|
|
488
|
+
}
|
|
489
|
+
}
|
|
490
|
+
export interface FolderMoveResponse {
|
|
491
|
+
/**
|
|
492
|
+
* Folder ID
|
|
493
|
+
*/
|
|
494
|
+
_id: string;
|
|
495
|
+
/**
|
|
496
|
+
* Creation date
|
|
497
|
+
*/
|
|
498
|
+
createdAt: string;
|
|
499
|
+
/**
|
|
500
|
+
* Folder name
|
|
501
|
+
*/
|
|
502
|
+
name: string;
|
|
503
|
+
/**
|
|
504
|
+
* Organization ID
|
|
505
|
+
*/
|
|
506
|
+
organizationId: string;
|
|
507
|
+
/**
|
|
508
|
+
* Folder status
|
|
509
|
+
*/
|
|
510
|
+
status: 'active' | 'deleted';
|
|
511
|
+
/**
|
|
512
|
+
* Last update date
|
|
513
|
+
*/
|
|
514
|
+
updatedAt: string;
|
|
515
|
+
/**
|
|
516
|
+
* Folder description
|
|
517
|
+
*/
|
|
518
|
+
description?: string;
|
|
519
|
+
/**
|
|
520
|
+
* Folder metadata
|
|
521
|
+
*/
|
|
522
|
+
metadata?: FolderMoveResponse.Metadata;
|
|
523
|
+
/**
|
|
524
|
+
* Parent folder ID
|
|
525
|
+
*/
|
|
526
|
+
parentFolderId?: string | null;
|
|
527
|
+
}
|
|
528
|
+
export declare namespace FolderMoveResponse {
|
|
529
|
+
/**
|
|
530
|
+
* Folder metadata
|
|
531
|
+
*/
|
|
532
|
+
interface Metadata {
|
|
533
|
+
/**
|
|
534
|
+
* Folder color
|
|
535
|
+
*/
|
|
536
|
+
color?: string;
|
|
537
|
+
/**
|
|
538
|
+
* Folder icon
|
|
539
|
+
*/
|
|
540
|
+
icon?: string;
|
|
541
|
+
/**
|
|
542
|
+
* Last activity date
|
|
543
|
+
*/
|
|
544
|
+
lastActivity?: string;
|
|
545
|
+
/**
|
|
546
|
+
* Number of materials in folder
|
|
547
|
+
*/
|
|
548
|
+
materialCount?: number;
|
|
549
|
+
/**
|
|
550
|
+
* Total size of materials in folder
|
|
551
|
+
*/
|
|
552
|
+
totalSize?: number;
|
|
553
|
+
}
|
|
73
554
|
}
|
|
74
555
|
export interface FolderCreateParams {
|
|
75
556
|
/**
|
|
@@ -77,19 +558,31 @@ export interface FolderCreateParams {
|
|
|
77
558
|
*/
|
|
78
559
|
name: string;
|
|
79
560
|
/**
|
|
80
|
-
*
|
|
561
|
+
* Folder description
|
|
562
|
+
*/
|
|
563
|
+
description?: string;
|
|
564
|
+
/**
|
|
565
|
+
* Additional metadata
|
|
566
|
+
*/
|
|
567
|
+
metadata?: unknown;
|
|
568
|
+
/**
|
|
569
|
+
* Parent folder ID
|
|
81
570
|
*/
|
|
82
|
-
|
|
571
|
+
parentFolderId?: string;
|
|
83
572
|
}
|
|
84
573
|
export interface FolderUpdateParams {
|
|
85
574
|
/**
|
|
86
|
-
* New folder
|
|
575
|
+
* New folder description
|
|
87
576
|
*/
|
|
88
|
-
|
|
577
|
+
description?: string;
|
|
578
|
+
/**
|
|
579
|
+
* Updated metadata
|
|
580
|
+
*/
|
|
581
|
+
metadata?: unknown;
|
|
89
582
|
/**
|
|
90
|
-
* New
|
|
583
|
+
* New folder name
|
|
91
584
|
*/
|
|
92
|
-
|
|
585
|
+
name?: string;
|
|
93
586
|
}
|
|
94
587
|
export interface FolderListParams {
|
|
95
588
|
/**
|
|
@@ -97,7 +590,23 @@ export interface FolderListParams {
|
|
|
97
590
|
*/
|
|
98
591
|
parentId?: unknown;
|
|
99
592
|
}
|
|
593
|
+
export interface FolderListMaterialsParams {
|
|
594
|
+
/**
|
|
595
|
+
* Number of items per page (default: 20, max: 200)
|
|
596
|
+
*/
|
|
597
|
+
limit?: string;
|
|
598
|
+
/**
|
|
599
|
+
* Page number (default: 1)
|
|
600
|
+
*/
|
|
601
|
+
page?: string;
|
|
602
|
+
}
|
|
603
|
+
export interface FolderMoveParams {
|
|
604
|
+
/**
|
|
605
|
+
* New parent folder ID or null for root level
|
|
606
|
+
*/
|
|
607
|
+
parentFolderId: string | null;
|
|
608
|
+
}
|
|
100
609
|
export declare namespace Folders {
|
|
101
|
-
export { type FolderCreateParams as FolderCreateParams, type FolderUpdateParams as FolderUpdateParams, type FolderListParams as FolderListParams, };
|
|
610
|
+
export { type FolderCreateResponse as FolderCreateResponse, type FolderRetrieveResponse as FolderRetrieveResponse, type FolderUpdateResponse as FolderUpdateResponse, type FolderListResponse as FolderListResponse, type FolderGetTreeResponse as FolderGetTreeResponse, type FolderListMaterialsResponse as FolderListMaterialsResponse, type FolderMoveResponse as FolderMoveResponse, type FolderCreateParams as FolderCreateParams, type FolderUpdateParams as FolderUpdateParams, type FolderListParams as FolderListParams, type FolderListMaterialsParams as FolderListMaterialsParams, type FolderMoveParams as FolderMoveParams, };
|
|
102
611
|
}
|
|
103
612
|
//# sourceMappingURL=folders.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"folders.d.mts","sourceRoot":"","sources":["../../src/resources/v1/folders.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"folders.d.mts","sourceRoot":"","sources":["../../src/resources/v1/folders.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI5F;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIlF;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIxG;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;OAOG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIpE;;;;;;;;;OASG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;CAGnG;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC,QAAQ,CAAC;IAEzC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,GAAG,EAAE,OAAO,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;IAE7B;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC;IAE3C;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,oBAAoB,CAAC,QAAQ,CAAC;IAEzC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAC,sBAAsB,CAAC,CAAC;AAElF,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,sBAAsB;QACrC;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;QAE7B;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC,QAAQ,CAAC;QAE3C;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAChC;IAED,UAAiB,sBAAsB,CAAC;QACtC;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC,qBAAqB,CAAC,yBAAyB,CAAC,CAAC;AAE3F,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,yBAAyB;QACxC;;WAEG;QACH,GAAG,EAAE,OAAO,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;QAE7B;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAE3B;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,QAAQ,CAAC,EAAE,yBAAyB,CAAC,QAAQ,CAAC;QAE9C;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB;IAED,UAAiB,yBAAyB,CAAC;QACzC;;WAEG;QACH,UAAiB,QAAQ;YACvB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,CAAC;YAEvB;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC,2BAA2B,CAAC,+BAA+B,CAAC,CAAC;AAE7G,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,+BAA+B;QAC9C;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,OAAO,EAAE,+BAA+B,CAAC,OAAO,CAAC;QAEjD;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;QAEnE;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,YAAY,GAAG,gBAAgB,GAAG,OAAO,GAAG,SAAS,CAAC;QAEzE;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;IAED,UAAiB,+BAA+B,CAAC;QAC/C;;WAEG;QACH,UAAiB,OAAO;YACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;KACF;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;IAE7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC;IAEvC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|