@epilot/file-client 1.13.0 → 1.14.0-rc1

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/dist/openapi.d.ts CHANGED
@@ -9,29 +9,79 @@ import type {
9
9
  } from 'openapi-client-axios';
10
10
 
11
11
  declare namespace Components {
12
+ namespace Parameters {
13
+ export type ActivityIdQueryParam = /**
14
+ * See https://github.com/ulid/spec
15
+ * example:
16
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
17
+ */
18
+ Schemas.ActivityId /* ulid */;
19
+ export type AsyncOperationQueryParam = boolean;
20
+ export type FillActivityQueryParam = boolean;
21
+ export type StrictQueryParam = boolean;
22
+ }
23
+ export interface QueryParameters {
24
+ StrictQueryParam?: Parameters.StrictQueryParam;
25
+ ActivityIdQueryParam?: Parameters.ActivityIdQueryParam;
26
+ FillActivityQueryParam?: Parameters.FillActivityQueryParam;
27
+ AsyncOperationQueryParam?: Parameters.AsyncOperationQueryParam;
28
+ }
12
29
  namespace Schemas {
30
+ /**
31
+ * See https://github.com/ulid/spec
32
+ * example:
33
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
34
+ */
35
+ export type ActivityId = string; // ulid
36
+ /**
37
+ * Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
38
+ */
39
+ export interface BaseEntityAcl {
40
+ view?: string[];
41
+ edit?: string[];
42
+ delete?: string[];
43
+ }
44
+ /**
45
+ * The user / organization owning this entity.
46
+ *
47
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
48
+ *
49
+ */
50
+ export interface BaseEntityOwner {
51
+ /**
52
+ * example:
53
+ * 123
54
+ */
55
+ org_id: string;
56
+ /**
57
+ * example:
58
+ * 123
59
+ */
60
+ user_id?: string;
61
+ }
13
62
  export interface CommonSaveFilePayload {
14
63
  [name: string]: any;
15
64
  /**
16
65
  * if passed, adds a new version to existing file entity
66
+ * example:
67
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
17
68
  */
18
- file_entity_id?: string;
19
- document_type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
69
+ _id?: string;
20
70
  /**
21
- * example:
22
- * document.pdf
71
+ * Deprecated, use _id instead
23
72
  */
24
- filename?: string;
25
- _tags?: string[];
26
- access_control?: "private" | "public-read";
73
+ file_entity_id?: string;
27
74
  /**
28
75
  * List of entities to relate the file to
29
76
  */
30
77
  relations?: FileRelationItem[];
31
78
  }
32
- export interface DeleteFilePayload {
33
- s3ref: S3Reference;
34
- }
79
+ /**
80
+ * Custom external download url used for the file
81
+ * example:
82
+ * https://some-api-url.com/download?file_id=123
83
+ */
84
+ export type CustomDownloadUrl = string; // uri
35
85
  export type DownloadFilesPayload = {
36
86
  id: /**
37
87
  * example:
@@ -56,28 +106,108 @@ declare namespace Components {
56
106
  * contact
57
107
  */
58
108
  export type EntitySlug = string;
59
- export interface FileEntity {
60
- _id?: /**
109
+ export interface FileAttributes {
110
+ /**
61
111
  * example:
62
- * ef7d985c-2385-44f4-9c71-ae06a52264f8
112
+ * [
113
+ * "tag1",
114
+ * "tag2"
115
+ * ]
63
116
  */
64
- FileEntityId;
117
+ _tags?: string[];
118
+ /**
119
+ * example:
120
+ * [
121
+ * "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
122
+ * "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
123
+ * ]
124
+ */
125
+ _purpose?: string[];
126
+ /**
127
+ * Manifest ID used to create/update the entity
128
+ */
129
+ _manifest?: string /* uuid */[];
65
130
  /**
66
131
  * example:
67
132
  * document.pdf
68
133
  */
69
134
  filename?: string;
135
+ type?: FileType;
136
+ /**
137
+ * MIME type of the file
138
+ * example:
139
+ * application/pdf
140
+ */
141
+ mime_type?: string;
142
+ /**
143
+ * File size in bytes
144
+ * example:
145
+ * 1234
146
+ */
147
+ size_bytes?: number;
148
+ /**
149
+ * Human readable file size
150
+ * example:
151
+ * 1.2 MB
152
+ */
153
+ readable_size?: string;
70
154
  access_control?: "private" | "public-read";
71
155
  /**
72
156
  * Direct URL for file (public only if file access control is public-read)
73
157
  * example:
74
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
158
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
75
159
  */
76
160
  public_url?: string; // url
161
+ custom_download_url?: /**
162
+ * Custom external download url used for the file
163
+ * example:
164
+ * https://some-api-url.com/download?file_id=123
165
+ */
166
+ CustomDownloadUrl /* uri */;
167
+ }
168
+ export interface FileEntity {
169
+ /**
170
+ * example:
171
+ * document.pdf
172
+ */
173
+ _title: string;
174
+ _schema: "file";
175
+ /**
176
+ * example:
177
+ * 123
178
+ */
179
+ _org: string;
180
+ _id: /**
181
+ * example:
182
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
183
+ */
184
+ FileEntityId;
185
+ /**
186
+ * example:
187
+ * [
188
+ * "tag1",
189
+ * "tag2"
190
+ * ]
191
+ */
192
+ _tags?: string[];
77
193
  /**
78
- * Human readable type for file
194
+ * example:
195
+ * [
196
+ * "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
197
+ * "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
198
+ * ]
199
+ */
200
+ _purpose?: string[];
201
+ /**
202
+ * Manifest ID used to create/update the entity
203
+ */
204
+ _manifest?: string /* uuid */[];
205
+ /**
206
+ * example:
207
+ * document.pdf
79
208
  */
80
- type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
209
+ filename: string;
210
+ type: FileType;
81
211
  /**
82
212
  * MIME type of the file
83
213
  * example:
@@ -86,11 +216,53 @@ declare namespace Components {
86
216
  mime_type?: string;
87
217
  /**
88
218
  * File size in bytes
219
+ * example:
220
+ * 1234
89
221
  */
90
222
  size_bytes?: number;
91
- versions?: {
92
- s3ref?: S3Reference;
93
- }[];
223
+ /**
224
+ * Human readable file size
225
+ * example:
226
+ * 1.2 MB
227
+ */
228
+ readable_size?: string;
229
+ access_control: "private" | "public-read";
230
+ /**
231
+ * Direct URL for file (public only if file access control is public-read)
232
+ * example:
233
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
234
+ */
235
+ public_url?: string; // url
236
+ custom_download_url?: /**
237
+ * Custom external download url used for the file
238
+ * example:
239
+ * https://some-api-url.com/download?file_id=123
240
+ */
241
+ CustomDownloadUrl /* uri */;
242
+ /**
243
+ * Source URL for the file. Included if the entity was created from source_url, or when ?source_url=true
244
+ * example:
245
+ * https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf
246
+ */
247
+ source_url?: string;
248
+ s3ref?: S3Ref;
249
+ versions: FileItem[];
250
+ _updated_at?: string; // date-time
251
+ _created_at?: string; // date-time
252
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
253
+ _owners?: /**
254
+ * The user / organization owning this entity.
255
+ *
256
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
257
+ *
258
+ */
259
+ BaseEntityOwner[];
260
+ /**
261
+ * Additional fields that are not part of the schema
262
+ */
263
+ __additional?: {
264
+ [name: string]: any;
265
+ } | null;
94
266
  }
95
267
  /**
96
268
  * example:
@@ -98,16 +270,7 @@ declare namespace Components {
98
270
  */
99
271
  export type FileEntityId = string;
100
272
  export interface FileItem {
101
- /**
102
- * example:
103
- * epilot-files-prod
104
- */
105
- bucket: string;
106
- /**
107
- * example:
108
- * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
109
- */
110
- key: string;
273
+ s3ref?: S3Ref;
111
274
  /**
112
275
  * example:
113
276
  * document.pdf
@@ -118,6 +281,11 @@ declare namespace Components {
118
281
  * 1234
119
282
  */
120
283
  size_bytes?: number;
284
+ /**
285
+ * example:
286
+ * 1.2 MB
287
+ */
288
+ readable_size?: string;
121
289
  /**
122
290
  * example:
123
291
  * image/jpeg
@@ -138,35 +306,18 @@ declare namespace Components {
138
306
  EntitySlug;
139
307
  _tags?: string[];
140
308
  }
309
+ export type FileType = "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
141
310
  export interface FileUpload {
311
+ s3ref?: S3Reference;
142
312
  /**
143
313
  * example:
144
- * {
145
- * "bucket": "epilot-files-prod",
146
- * "key": "123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
147
- * }
148
- */
149
- s3ref?: {
150
- /**
151
- * example:
152
- * epilot-files-prod
153
- */
154
- bucket: string;
155
- /**
156
- * example:
157
- * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
158
- */
159
- key: string;
160
- };
161
- /**
162
- * example:
163
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
314
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
164
315
  */
165
316
  upload_url?: string; // url
166
317
  /**
167
318
  * Returned only if file is permanent i.e. file_entity_id is passed
168
319
  * example:
169
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
320
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
170
321
  */
171
322
  public_url?: string; // url
172
323
  }
@@ -188,10 +339,11 @@ declare namespace Components {
188
339
  */
189
340
  last_accessed_at?: string;
190
341
  }
342
+ export type S3Ref = S3Reference;
191
343
  export interface S3Reference {
192
344
  /**
193
345
  * example:
194
- * epilot-files-prod
346
+ * epilot-prod-user-content
195
347
  */
196
348
  bucket: string;
197
349
  /**
@@ -204,76 +356,232 @@ declare namespace Components {
204
356
  [name: string]: any;
205
357
  /**
206
358
  * if passed, adds a new version to existing file entity
359
+ * example:
360
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
361
+ */
362
+ _id?: string;
363
+ /**
364
+ * Deprecated, use _id instead
207
365
  */
208
366
  file_entity_id?: string;
209
- document_type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
367
+ /**
368
+ * List of entities to relate the file to
369
+ */
370
+ relations?: FileRelationItem[];
371
+ /**
372
+ * example:
373
+ * [
374
+ * "tag1",
375
+ * "tag2"
376
+ * ]
377
+ */
378
+ _tags?: string[];
379
+ /**
380
+ * example:
381
+ * [
382
+ * "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
383
+ * "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
384
+ * ]
385
+ */
386
+ _purpose?: string[];
387
+ /**
388
+ * Manifest ID used to create/update the entity
389
+ */
390
+ _manifest?: string /* uuid */[];
210
391
  /**
211
392
  * example:
212
393
  * document.pdf
213
394
  */
214
395
  filename?: string;
215
- _tags?: string[];
216
- access_control?: "private" | "public-read";
396
+ type?: FileType;
217
397
  /**
218
- * List of entities to relate the file to
398
+ * MIME type of the file
399
+ * example:
400
+ * application/pdf
219
401
  */
220
- relations?: FileRelationItem[];
402
+ mime_type?: string;
221
403
  /**
404
+ * File size in bytes
405
+ * example:
406
+ * 1234
407
+ */
408
+ size_bytes?: number;
409
+ /**
410
+ * Human readable file size
411
+ * example:
412
+ * 1.2 MB
413
+ */
414
+ readable_size?: string;
415
+ access_control?: "private" | "public-read";
416
+ /**
417
+ * Direct URL for file (public only if file access control is public-read)
418
+ * example:
419
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
420
+ */
421
+ public_url?: string; // url
422
+ custom_download_url?: /**
222
423
  * Custom external download url used for the file
424
+ * example:
425
+ * https://some-api-url.com/download?file_id=123
223
426
  */
224
- custom_download_url: string; // uri
427
+ CustomDownloadUrl /* uri */;
225
428
  }
226
- export type SaveFilePayload = SaveS3FilePayload | SaveCustomFilePayload;
227
- export interface SaveFilePayloadV2 {
429
+ export interface SaveFileFromSourceURLPayload {
228
430
  [name: string]: any;
229
- s3ref: {
230
- /**
231
- * example:
232
- * epilot-files-prod
233
- */
234
- bucket: string;
235
- /**
236
- * example:
237
- * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
238
- */
239
- key: string;
240
- };
241
431
  /**
432
+ * if passed, adds a new version to existing file entity
242
433
  * example:
243
- * document.pdf
434
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
244
435
  */
245
- filename: string;
436
+ _id?: string;
246
437
  /**
247
- * if passed, adds a new version to existing file entity
438
+ * Deprecated, use _id instead
248
439
  */
249
440
  file_entity_id?: string;
250
- document_type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
441
+ /**
442
+ * List of entities to relate the file to
443
+ */
444
+ relations?: FileRelationItem[];
445
+ /**
446
+ * example:
447
+ * [
448
+ * "tag1",
449
+ * "tag2"
450
+ * ]
451
+ */
251
452
  _tags?: string[];
453
+ /**
454
+ * example:
455
+ * [
456
+ * "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
457
+ * "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
458
+ * ]
459
+ */
460
+ _purpose?: string[];
461
+ /**
462
+ * Manifest ID used to create/update the entity
463
+ */
464
+ _manifest?: string /* uuid */[];
465
+ /**
466
+ * example:
467
+ * document.pdf
468
+ */
469
+ filename?: string;
470
+ type?: FileType;
471
+ /**
472
+ * MIME type of the file
473
+ * example:
474
+ * application/pdf
475
+ */
476
+ mime_type?: string;
477
+ /**
478
+ * File size in bytes
479
+ * example:
480
+ * 1234
481
+ */
482
+ size_bytes?: number;
483
+ /**
484
+ * Human readable file size
485
+ * example:
486
+ * 1.2 MB
487
+ */
488
+ readable_size?: string;
252
489
  access_control?: "private" | "public-read";
253
490
  /**
491
+ * Direct URL for file (public only if file access control is public-read)
492
+ * example:
493
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
494
+ */
495
+ public_url?: string; // url
496
+ custom_download_url?: /**
254
497
  * Custom external download url used for the file
498
+ * example:
499
+ * https://some-api-url.com/download?file_id=123
255
500
  */
256
- custom_download_url?: string; // uri
501
+ CustomDownloadUrl /* uri */;
502
+ source_url?: /**
503
+ * Custom external download url used for the file
504
+ * example:
505
+ * https://some-api-url.com/download?file_id=123
506
+ */
507
+ CustomDownloadUrl /* uri */;
257
508
  }
509
+ export type SaveFilePayload = SaveS3FilePayload | SaveFileFromSourceURLPayload | SaveCustomFilePayload;
510
+ export type SaveFilePayloadV2 = SaveS3FilePayload | SaveFileFromSourceURLPayload | SaveCustomFilePayload;
258
511
  export interface SaveS3FilePayload {
259
512
  [name: string]: any;
260
513
  /**
261
514
  * if passed, adds a new version to existing file entity
515
+ * example:
516
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
517
+ */
518
+ _id?: string;
519
+ /**
520
+ * Deprecated, use _id instead
262
521
  */
263
522
  file_entity_id?: string;
264
- document_type?: "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
523
+ /**
524
+ * List of entities to relate the file to
525
+ */
526
+ relations?: FileRelationItem[];
527
+ /**
528
+ * example:
529
+ * [
530
+ * "tag1",
531
+ * "tag2"
532
+ * ]
533
+ */
534
+ _tags?: string[];
535
+ /**
536
+ * example:
537
+ * [
538
+ * "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
539
+ * "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
540
+ * ]
541
+ */
542
+ _purpose?: string[];
543
+ /**
544
+ * Manifest ID used to create/update the entity
545
+ */
546
+ _manifest?: string /* uuid */[];
265
547
  /**
266
548
  * example:
267
549
  * document.pdf
268
550
  */
269
551
  filename?: string;
270
- _tags?: string[];
552
+ type?: FileType;
553
+ /**
554
+ * MIME type of the file
555
+ * example:
556
+ * application/pdf
557
+ */
558
+ mime_type?: string;
559
+ /**
560
+ * File size in bytes
561
+ * example:
562
+ * 1234
563
+ */
564
+ size_bytes?: number;
565
+ /**
566
+ * Human readable file size
567
+ * example:
568
+ * 1.2 MB
569
+ */
570
+ readable_size?: string;
271
571
  access_control?: "private" | "public-read";
272
572
  /**
273
- * List of entities to relate the file to
573
+ * Direct URL for file (public only if file access control is public-read)
574
+ * example:
575
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
274
576
  */
275
- relations?: FileRelationItem[];
276
- s3ref: S3Reference;
577
+ public_url?: string; // url
578
+ custom_download_url?: /**
579
+ * Custom external download url used for the file
580
+ * example:
581
+ * https://some-api-url.com/download?file_id=123
582
+ */
583
+ CustomDownloadUrl /* uri */;
584
+ s3ref?: S3Ref;
277
585
  }
278
586
  export interface UploadFilePayload {
279
587
  /**
@@ -310,7 +618,7 @@ declare namespace Components {
310
618
  * example:
311
619
  * https://some-api-url.com?file_id=123&expires_at=1699273500029&signature=abcdefg
312
620
  */
313
- custom_download_url: string; // uri
621
+ custom_download_url: string;
314
622
  }
315
623
  }
316
624
  }
@@ -323,6 +631,10 @@ declare namespace Paths {
323
631
  * invoice-2023-12.pdf
324
632
  */
325
633
  export type Filename = string;
634
+ /**
635
+ * An optional cache-busting hash for the file
636
+ */
637
+ export type Hash = string;
326
638
  /**
327
639
  * Id of the publicly generated link
328
640
  * example:
@@ -344,16 +656,40 @@ declare namespace Paths {
344
656
  */
345
657
  Parameters.Filename;
346
658
  }
659
+ export interface QueryParameters {
660
+ hash?: /* An optional cache-busting hash for the file */ Parameters.Hash;
661
+ }
347
662
  namespace Responses {
348
663
  export interface $302 {
349
664
  }
350
665
  }
351
666
  }
352
667
  namespace DeleteFile {
353
- export type RequestBody = Components.Schemas.DeleteFilePayload;
668
+ namespace Parameters {
669
+ export type ActivityId = /**
670
+ * See https://github.com/ulid/spec
671
+ * example:
672
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
673
+ */
674
+ Components.Schemas.ActivityId /* ulid */;
675
+ export type Id = /**
676
+ * example:
677
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
678
+ */
679
+ Components.Schemas.FileEntityId;
680
+ export type Purge = boolean;
681
+ export type Strict = boolean;
682
+ }
683
+ export interface PathParameters {
684
+ id: Parameters.Id;
685
+ }
686
+ export interface QueryParameters {
687
+ purge?: Parameters.Purge;
688
+ activity_id?: Parameters.ActivityId;
689
+ strict?: Parameters.Strict;
690
+ }
354
691
  namespace Responses {
355
- export interface $200 {
356
- }
692
+ export type $200 = Components.Schemas.FileEntity;
357
693
  }
358
694
  }
359
695
  namespace DeleteSession {
@@ -383,7 +719,7 @@ declare namespace Paths {
383
719
  export interface $200 {
384
720
  /**
385
721
  * example:
386
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
722
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
387
723
  */
388
724
  download_url?: string; // uri
389
725
  }
@@ -395,7 +731,7 @@ declare namespace Paths {
395
731
  export type $200 = {
396
732
  /**
397
733
  * example:
398
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
734
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
399
735
  */
400
736
  download_url?: string; // uri
401
737
  file_entity_id?: string; // uuid
@@ -417,7 +753,7 @@ declare namespace Paths {
417
753
  export interface $200 {
418
754
  /**
419
755
  * example:
420
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
756
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
421
757
  */
422
758
  download_url?: string; // uri
423
759
  }
@@ -435,14 +771,46 @@ declare namespace Paths {
435
771
  id: Parameters.Id;
436
772
  }
437
773
  namespace Responses {
438
- /**
439
- * example:
440
- * https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c/invoice-2023-12.pdf
441
- */
442
- export type $201 = string;
774
+ /**
775
+ * example:
776
+ * https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c/invoice-2023-12.pdf
777
+ */
778
+ export type $201 = string;
779
+ }
780
+ }
781
+ namespace GetFile {
782
+ namespace Parameters {
783
+ export type Async = boolean;
784
+ export type Id = /**
785
+ * example:
786
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
787
+ */
788
+ Components.Schemas.FileEntityId;
789
+ /**
790
+ * Generate a source_url for the file entity, if it doesn't have one
791
+ */
792
+ export type SourceUrl = boolean;
793
+ export type Strict = boolean;
794
+ }
795
+ export interface PathParameters {
796
+ id: Parameters.Id;
797
+ }
798
+ export interface QueryParameters {
799
+ source_url?: /* Generate a source_url for the file entity, if it doesn't have one */ Parameters.SourceUrl;
800
+ strict?: Parameters.Strict;
801
+ async?: Parameters.Async;
802
+ }
803
+ namespace Responses {
804
+ export type $200 = Components.Schemas.FileEntity;
805
+ }
806
+ }
807
+ namespace GetSession {
808
+ namespace Responses {
809
+ export interface $200 {
810
+ }
443
811
  }
444
812
  }
445
- namespace GetAllPublicLinksForFile {
813
+ namespace ListPublicLinksForFile {
446
814
  namespace Parameters {
447
815
  /**
448
816
  * ID of the file entity
@@ -465,12 +833,6 @@ declare namespace Paths {
465
833
  }
466
834
  }
467
835
  }
468
- namespace GetSession {
469
- namespace Responses {
470
- export interface $200 {
471
- }
472
- }
473
- }
474
836
  namespace PreviewFile {
475
837
  namespace Parameters {
476
838
  export type H = number;
@@ -522,7 +884,7 @@ declare namespace Paths {
522
884
  w?: Parameters.W;
523
885
  h?: Parameters.H;
524
886
  }
525
- export type RequestBody = Components.Schemas.S3Reference;
887
+ export type RequestBody = Components.Schemas.S3Ref;
526
888
  }
527
889
  namespace PreviewS3FileGet {
528
890
  namespace Parameters {
@@ -564,15 +926,45 @@ declare namespace Paths {
564
926
  }
565
927
  }
566
928
  namespace SaveFile {
929
+ namespace Parameters {
930
+ export type ActivityId = /**
931
+ * See https://github.com/ulid/spec
932
+ * example:
933
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
934
+ */
935
+ Components.Schemas.ActivityId /* ulid */;
936
+ export type Async = boolean;
937
+ }
938
+ export interface QueryParameters {
939
+ activity_id?: Parameters.ActivityId;
940
+ async?: Parameters.Async;
941
+ }
567
942
  export type RequestBody = Components.Schemas.SaveFilePayload;
568
943
  namespace Responses {
569
944
  export type $201 = Components.Schemas.FileEntity;
570
945
  }
571
946
  }
572
947
  namespace SaveFileV2 {
948
+ namespace Parameters {
949
+ export type ActivityId = /**
950
+ * See https://github.com/ulid/spec
951
+ * example:
952
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
953
+ */
954
+ Components.Schemas.ActivityId /* ulid */;
955
+ export type Async = boolean;
956
+ export type FillActivity = boolean;
957
+ export type Strict = boolean;
958
+ }
959
+ export interface QueryParameters {
960
+ activity_id?: Parameters.ActivityId;
961
+ fill_activity?: Parameters.FillActivity;
962
+ strict?: Parameters.Strict;
963
+ async?: Parameters.Async;
964
+ }
573
965
  export type RequestBody = Components.Schemas.SaveFilePayloadV2;
574
966
  namespace Responses {
575
- export type $201 = Components.Schemas.FileEntity;
967
+ export type $200 = Components.Schemas.FileEntity;
576
968
  }
577
969
  }
578
970
  namespace UploadFile {
@@ -589,34 +981,16 @@ declare namespace Paths {
589
981
  export type RequestBody = Components.Schemas.UploadFilePayload;
590
982
  namespace Responses {
591
983
  export interface $201 {
984
+ s3ref?: Components.Schemas.S3Reference;
592
985
  /**
593
986
  * example:
594
- * {
595
- * "bucket": "epilot-files-prod",
596
- * "key": "123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
597
- * }
598
- */
599
- s3ref?: {
600
- /**
601
- * example:
602
- * epilot-files-prod
603
- */
604
- bucket: string;
605
- /**
606
- * example:
607
- * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
608
- */
609
- key: string;
610
- };
611
- /**
612
- * example:
613
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
987
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
614
988
  */
615
989
  upload_url?: string; // url
616
990
  /**
617
991
  * Returned only if file is permanent i.e. file_entity_id is passed
618
992
  * example:
619
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
993
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
620
994
  */
621
995
  public_url?: string; // url
622
996
  }
@@ -626,28 +1000,10 @@ declare namespace Paths {
626
1000
  export type RequestBody = Components.Schemas.UploadFilePayload;
627
1001
  namespace Responses {
628
1002
  export interface $201 {
1003
+ s3ref?: Components.Schemas.S3Reference;
629
1004
  /**
630
1005
  * example:
631
- * {
632
- * "bucket": "epilot-files-prod",
633
- * "key": "123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"
634
- * }
635
- */
636
- s3ref?: {
637
- /**
638
- * example:
639
- * epilot-files-prod
640
- */
641
- bucket: string;
642
- /**
643
- * example:
644
- * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
645
- */
646
- key: string;
647
- };
648
- /**
649
- * example:
650
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
1006
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
651
1007
  */
652
1008
  upload_url?: string; // url
653
1009
  }
@@ -679,26 +1035,40 @@ declare namespace Paths {
679
1035
  }
680
1036
  }
681
1037
 
1038
+
682
1039
  export interface OperationMethods {
683
1040
  /**
684
- * uploadFilePublic - uploadFilePublic
1041
+ * uploadFileV2 - uploadFileV2
685
1042
  *
686
1043
  * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
687
1044
  *
688
- * Use the createFile operation to store file file permanently.
1045
+ * Use the saveFileV2 operation to store file file permanently.
689
1046
  *
690
1047
  */
691
- 'uploadFilePublic'(
692
- parameters?: Parameters<UnknownParamsObject> | null,
693
- data?: Paths.UploadFilePublic.RequestBody,
1048
+ 'uploadFileV2'(
1049
+ parameters?: Parameters<Paths.UploadFileV2.QueryParameters> | null,
1050
+ data?: Paths.UploadFileV2.RequestBody,
694
1051
  config?: AxiosRequestConfig
695
- ): OperationResponse<Paths.UploadFilePublic.Responses.$201>
1052
+ ): OperationResponse<Paths.UploadFileV2.Responses.$201>
1053
+ /**
1054
+ * saveFileV2 - saveFileV2
1055
+ *
1056
+ * Saves a permanent file entity. Updates an existing file entity when `_id` is passed.
1057
+ *
1058
+ * Saves metadata to file entity and stores a version when `s3ref` or `source_url` is passed.
1059
+ *
1060
+ */
1061
+ 'saveFileV2'(
1062
+ parameters?: Parameters<Paths.SaveFileV2.QueryParameters> | null,
1063
+ data?: Paths.SaveFileV2.RequestBody,
1064
+ config?: AxiosRequestConfig
1065
+ ): OperationResponse<Paths.SaveFileV2.Responses.$200>
696
1066
  /**
697
1067
  * uploadFile - uploadFile
698
1068
  *
699
1069
  * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
700
1070
  *
701
- * Use the createFile operation to store file file permanently.
1071
+ * Use the saveFile operation to store file file permanently.
702
1072
  *
703
1073
  */
704
1074
  'uploadFile'(
@@ -717,40 +1087,40 @@ export interface OperationMethods {
717
1087
  *
718
1088
  */
719
1089
  'saveFile'(
720
- parameters?: Parameters<UnknownParamsObject> | null,
1090
+ parameters?: Parameters<Paths.SaveFile.QueryParameters> | null,
721
1091
  data?: Paths.SaveFile.RequestBody,
722
1092
  config?: AxiosRequestConfig
723
1093
  ): OperationResponse<Paths.SaveFile.Responses.$201>
724
1094
  /**
725
- * downloadFile - downloadFile
1095
+ * getFile - getFile
726
1096
  *
727
- * Generate pre-signed download S3 url for a file
1097
+ * Get a file entity by id
728
1098
  */
729
- 'downloadFile'(
730
- parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
1099
+ 'getFile'(
1100
+ parameters?: Parameters<Paths.GetFile.QueryParameters & Paths.GetFile.PathParameters> | null,
731
1101
  data?: any,
732
1102
  config?: AxiosRequestConfig
733
- ): OperationResponse<Paths.DownloadFile.Responses.$200>
1103
+ ): OperationResponse<Paths.GetFile.Responses.$200>
734
1104
  /**
735
- * verifyCustomDownloadUrl - verifyCustomDownloadUrl
1105
+ * deleteFile - deleteFile
736
1106
  *
737
- * Verify a pre-signed custom download url for a file
1107
+ * Delete a file entity by id
738
1108
  */
739
- 'verifyCustomDownloadUrl'(
740
- parameters?: Parameters<UnknownParamsObject> | null,
741
- data?: Paths.VerifyCustomDownloadUrl.RequestBody,
1109
+ 'deleteFile'(
1110
+ parameters?: Parameters<Paths.DeleteFile.QueryParameters & Paths.DeleteFile.PathParameters> | null,
1111
+ data?: any,
742
1112
  config?: AxiosRequestConfig
743
- ): OperationResponse<Paths.VerifyCustomDownloadUrl.Responses.$200>
1113
+ ): OperationResponse<Paths.DeleteFile.Responses.$200>
744
1114
  /**
745
- * downloadFiles - downloadFiles
1115
+ * downloadFile - downloadFile
746
1116
  *
747
- * Generate pre-signed download S3 urls for multiple files
1117
+ * Generate pre-signed download S3 url for a file
748
1118
  */
749
- 'downloadFiles'(
750
- parameters?: Parameters<UnknownParamsObject> | null,
751
- data?: Paths.DownloadFiles.RequestBody,
1119
+ 'downloadFile'(
1120
+ parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
1121
+ data?: any,
752
1122
  config?: AxiosRequestConfig
753
- ): OperationResponse<Paths.DownloadFiles.Responses.$200>
1123
+ ): OperationResponse<Paths.DownloadFile.Responses.$200>
754
1124
  /**
755
1125
  * downloadS3File - downloadS3File
756
1126
  *
@@ -762,22 +1132,22 @@ export interface OperationMethods {
762
1132
  config?: AxiosRequestConfig
763
1133
  ): OperationResponse<Paths.DownloadS3File.Responses.$200>
764
1134
  /**
765
- * previewFile - previewFile
1135
+ * downloadFiles - downloadFiles
766
1136
  *
767
- * Generate thumbnail preview for a file entity
1137
+ * Bulk generate pre-signed download S3 urls for multiple files
768
1138
  */
769
- 'previewFile'(
770
- parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
771
- data?: any,
1139
+ 'downloadFiles'(
1140
+ parameters?: Parameters<UnknownParamsObject> | null,
1141
+ data?: Paths.DownloadFiles.RequestBody,
772
1142
  config?: AxiosRequestConfig
773
- ): OperationResponse<any>
1143
+ ): OperationResponse<Paths.DownloadFiles.Responses.$200>
774
1144
  /**
775
- * previewPublicFile - previewPublicFile
1145
+ * previewFile - previewFile
776
1146
  *
777
- * Generate thumbnail preview for a public file entity
1147
+ * Generate thumbnail preview for a file entity
778
1148
  */
779
- 'previewPublicFile'(
780
- parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
1149
+ 'previewFile'(
1150
+ parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
781
1151
  data?: any,
782
1152
  config?: AxiosRequestConfig
783
1153
  ): OperationResponse<any>
@@ -802,15 +1172,15 @@ export interface OperationMethods {
802
1172
  config?: AxiosRequestConfig
803
1173
  ): OperationResponse<any>
804
1174
  /**
805
- * deleteFile - deleteFile
1175
+ * previewPublicFile - previewPublicFile
806
1176
  *
807
- * Delete file entity
1177
+ * Generate thumbnail preview for a public file entity
808
1178
  */
809
- 'deleteFile'(
810
- parameters?: Parameters<UnknownParamsObject> | null,
811
- data?: Paths.DeleteFile.RequestBody,
1179
+ 'previewPublicFile'(
1180
+ parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
1181
+ data?: any,
812
1182
  config?: AxiosRequestConfig
813
- ): OperationResponse<Paths.DeleteFile.Responses.$200>
1183
+ ): OperationResponse<any>
814
1184
  /**
815
1185
  * getSession - getSession
816
1186
  *
@@ -835,19 +1205,19 @@ export interface OperationMethods {
835
1205
  config?: AxiosRequestConfig
836
1206
  ): OperationResponse<Paths.DeleteSession.Responses.$200>
837
1207
  /**
838
- * getAllPublicLinksForFile - getAllPublicLinksForFile
1208
+ * listPublicLinksForFile - listPublicLinksForFile
839
1209
  *
840
- * Not yet implemented; This API would fetches all the public links that are previously generated for a file
1210
+ * Not yet implemented; This API would fetch all the public links that are previously generated for a file
841
1211
  */
842
- 'getAllPublicLinksForFile'(
843
- parameters?: Parameters<Paths.GetAllPublicLinksForFile.PathParameters> | null,
1212
+ 'listPublicLinksForFile'(
1213
+ parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
844
1214
  data?: any,
845
1215
  config?: AxiosRequestConfig
846
- ): OperationResponse<Paths.GetAllPublicLinksForFile.Responses.$200>
1216
+ ): OperationResponse<Paths.ListPublicLinksForFile.Responses.$200>
847
1217
  /**
848
1218
  * generatePublicLink - generatePublicLink
849
1219
  *
850
- * Generates a public link to access the private files
1220
+ * Generates a public link to access a private file
851
1221
  *
852
1222
  */
853
1223
  'generatePublicLink'(
@@ -861,14 +1231,14 @@ export interface OperationMethods {
861
1231
  * Redirects to a accessible signed url for the respective file associated to the public link
862
1232
  */
863
1233
  'accessPublicLink'(
864
- parameters?: Parameters<Paths.AccessPublicLink.PathParameters> | null,
1234
+ parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
865
1235
  data?: any,
866
1236
  config?: AxiosRequestConfig
867
1237
  ): OperationResponse<any>
868
1238
  /**
869
1239
  * revokePublicLink - revokePublicLink
870
1240
  *
871
- * Not yet implemented; This operation would revokes a given public link by ID
1241
+ * Not yet implemented; This operation would revoke a given public link by ID
872
1242
  */
873
1243
  'revokePublicLink'(
874
1244
  parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
@@ -876,50 +1246,60 @@ export interface OperationMethods {
876
1246
  config?: AxiosRequestConfig
877
1247
  ): OperationResponse<Paths.RevokePublicLink.Responses.$204>
878
1248
  /**
879
- * uploadFileV2 - uploadFileV2
880
- *
881
- * Create pre-signed S3 URL to upload a file to keep temporarily (one week). - v2
882
- *
883
- * Use the createFile operation to store file file permanently.
1249
+ * verifyCustomDownloadUrl - verifyCustomDownloadUrl
884
1250
  *
1251
+ * Verify a pre-signed custom download url for a file
885
1252
  */
886
- 'uploadFileV2'(
887
- parameters?: Parameters<Paths.UploadFileV2.QueryParameters> | null,
888
- data?: Paths.UploadFileV2.RequestBody,
1253
+ 'verifyCustomDownloadUrl'(
1254
+ parameters?: Parameters<UnknownParamsObject> | null,
1255
+ data?: Paths.VerifyCustomDownloadUrl.RequestBody,
889
1256
  config?: AxiosRequestConfig
890
- ): OperationResponse<Paths.UploadFileV2.Responses.$201>
1257
+ ): OperationResponse<Paths.VerifyCustomDownloadUrl.Responses.$200>
891
1258
  /**
892
- * saveFileV2 - saveFileV2
893
- *
894
- * Create / Update a permanent File entity
1259
+ * uploadFilePublic - uploadFilePublic
895
1260
  *
896
- * Makes file object permanent
1261
+ * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
897
1262
  *
898
- * Saves metadata to file entity
1263
+ * Use the saveFileV2 operation to store file file permanently.
899
1264
  *
900
1265
  */
901
- 'saveFileV2'(
1266
+ 'uploadFilePublic'(
902
1267
  parameters?: Parameters<UnknownParamsObject> | null,
903
- data?: Paths.SaveFileV2.RequestBody,
1268
+ data?: Paths.UploadFilePublic.RequestBody,
904
1269
  config?: AxiosRequestConfig
905
- ): OperationResponse<Paths.SaveFileV2.Responses.$201>
1270
+ ): OperationResponse<Paths.UploadFilePublic.Responses.$201>
906
1271
  }
907
1272
 
908
1273
  export interface PathsDictionary {
909
- ['/v1/files/public/upload']: {
1274
+ ['/v2/files/upload']: {
910
1275
  /**
911
- * uploadFilePublic - uploadFilePublic
1276
+ * uploadFileV2 - uploadFileV2
912
1277
  *
913
1278
  * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
914
1279
  *
915
- * Use the createFile operation to store file file permanently.
1280
+ * Use the saveFileV2 operation to store file file permanently.
916
1281
  *
917
1282
  */
918
1283
  'post'(
919
- parameters?: Parameters<UnknownParamsObject> | null,
920
- data?: Paths.UploadFilePublic.RequestBody,
1284
+ parameters?: Parameters<Paths.UploadFileV2.QueryParameters> | null,
1285
+ data?: Paths.UploadFileV2.RequestBody,
921
1286
  config?: AxiosRequestConfig
922
- ): OperationResponse<Paths.UploadFilePublic.Responses.$201>
1287
+ ): OperationResponse<Paths.UploadFileV2.Responses.$201>
1288
+ }
1289
+ ['/v2/files']: {
1290
+ /**
1291
+ * saveFileV2 - saveFileV2
1292
+ *
1293
+ * Saves a permanent file entity. Updates an existing file entity when `_id` is passed.
1294
+ *
1295
+ * Saves metadata to file entity and stores a version when `s3ref` or `source_url` is passed.
1296
+ *
1297
+ */
1298
+ 'post'(
1299
+ parameters?: Parameters<Paths.SaveFileV2.QueryParameters> | null,
1300
+ data?: Paths.SaveFileV2.RequestBody,
1301
+ config?: AxiosRequestConfig
1302
+ ): OperationResponse<Paths.SaveFileV2.Responses.$200>
923
1303
  }
924
1304
  ['/v1/files/upload']: {
925
1305
  /**
@@ -927,7 +1307,7 @@ export interface PathsDictionary {
927
1307
  *
928
1308
  * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
929
1309
  *
930
- * Use the createFile operation to store file file permanently.
1310
+ * Use the saveFile operation to store file file permanently.
931
1311
  *
932
1312
  */
933
1313
  'post'(
@@ -948,11 +1328,33 @@ export interface PathsDictionary {
948
1328
  *
949
1329
  */
950
1330
  'post'(
951
- parameters?: Parameters<UnknownParamsObject> | null,
1331
+ parameters?: Parameters<Paths.SaveFile.QueryParameters> | null,
952
1332
  data?: Paths.SaveFile.RequestBody,
953
1333
  config?: AxiosRequestConfig
954
1334
  ): OperationResponse<Paths.SaveFile.Responses.$201>
955
1335
  }
1336
+ ['/v2/files/{id}']: {
1337
+ /**
1338
+ * getFile - getFile
1339
+ *
1340
+ * Get a file entity by id
1341
+ */
1342
+ 'get'(
1343
+ parameters?: Parameters<Paths.GetFile.QueryParameters & Paths.GetFile.PathParameters> | null,
1344
+ data?: any,
1345
+ config?: AxiosRequestConfig
1346
+ ): OperationResponse<Paths.GetFile.Responses.$200>
1347
+ /**
1348
+ * deleteFile - deleteFile
1349
+ *
1350
+ * Delete a file entity by id
1351
+ */
1352
+ 'delete'(
1353
+ parameters?: Parameters<Paths.DeleteFile.QueryParameters & Paths.DeleteFile.PathParameters> | null,
1354
+ data?: any,
1355
+ config?: AxiosRequestConfig
1356
+ ): OperationResponse<Paths.DeleteFile.Responses.$200>
1357
+ }
956
1358
  ['/v1/files/{id}/download']: {
957
1359
  /**
958
1360
  * downloadFile - downloadFile
@@ -965,23 +1367,23 @@ export interface PathsDictionary {
965
1367
  config?: AxiosRequestConfig
966
1368
  ): OperationResponse<Paths.DownloadFile.Responses.$200>
967
1369
  }
968
- ['/v1/files/download:verify']: {
1370
+ ['/v1/files:downloadS3']: {
969
1371
  /**
970
- * verifyCustomDownloadUrl - verifyCustomDownloadUrl
1372
+ * downloadS3File - downloadS3File
971
1373
  *
972
- * Verify a pre-signed custom download url for a file
1374
+ * Generate pre-signed download S3 url for a file
973
1375
  */
974
1376
  'post'(
975
- parameters?: Parameters<UnknownParamsObject> | null,
976
- data?: Paths.VerifyCustomDownloadUrl.RequestBody,
1377
+ parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
1378
+ data?: any,
977
1379
  config?: AxiosRequestConfig
978
- ): OperationResponse<Paths.VerifyCustomDownloadUrl.Responses.$200>
1380
+ ): OperationResponse<Paths.DownloadS3File.Responses.$200>
979
1381
  }
980
1382
  ['/v1/files:downloadFiles']: {
981
1383
  /**
982
1384
  * downloadFiles - downloadFiles
983
1385
  *
984
- * Generate pre-signed download S3 urls for multiple files
1386
+ * Bulk generate pre-signed download S3 urls for multiple files
985
1387
  */
986
1388
  'post'(
987
1389
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -989,18 +1391,6 @@ export interface PathsDictionary {
989
1391
  config?: AxiosRequestConfig
990
1392
  ): OperationResponse<Paths.DownloadFiles.Responses.$200>
991
1393
  }
992
- ['/v1/files:downloadS3']: {
993
- /**
994
- * downloadS3File - downloadS3File
995
- *
996
- * Generate pre-signed download S3 url for a file
997
- */
998
- 'post'(
999
- parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
1000
- data?: any,
1001
- config?: AxiosRequestConfig
1002
- ): OperationResponse<Paths.DownloadS3File.Responses.$200>
1003
- }
1004
1394
  ['/v1/files/{id}/preview']: {
1005
1395
  /**
1006
1396
  * previewFile - previewFile
@@ -1013,19 +1403,17 @@ export interface PathsDictionary {
1013
1403
  config?: AxiosRequestConfig
1014
1404
  ): OperationResponse<any>
1015
1405
  }
1016
- ['/v1/files/public/{id}/preview']: {
1406
+ ['/v1/files:previewS3']: {
1017
1407
  /**
1018
- * previewPublicFile - previewPublicFile
1408
+ * previewS3File - previewS3File
1019
1409
  *
1020
- * Generate thumbnail preview for a public file entity
1410
+ * Generate thumbnail preview from an s3 reference for a file entity
1021
1411
  */
1022
- 'get'(
1023
- parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
1024
- data?: any,
1412
+ 'post'(
1413
+ parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
1414
+ data?: Paths.PreviewS3File.RequestBody,
1025
1415
  config?: AxiosRequestConfig
1026
1416
  ): OperationResponse<any>
1027
- }
1028
- ['/v1/files:previewS3']: {
1029
1417
  /**
1030
1418
  * previewS3FileGet - previewS3FileGet
1031
1419
  *
@@ -1036,28 +1424,18 @@ export interface PathsDictionary {
1036
1424
  data?: any,
1037
1425
  config?: AxiosRequestConfig
1038
1426
  ): OperationResponse<any>
1039
- /**
1040
- * previewS3File - previewS3File
1041
- *
1042
- * Generate thumbnail preview from an s3 reference for a file entity
1043
- */
1044
- 'post'(
1045
- parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
1046
- data?: Paths.PreviewS3File.RequestBody,
1047
- config?: AxiosRequestConfig
1048
- ): OperationResponse<any>
1049
1427
  }
1050
- ['/v1/files/delete']: {
1428
+ ['/v1/files/public/{id}/preview']: {
1051
1429
  /**
1052
- * deleteFile - deleteFile
1430
+ * previewPublicFile - previewPublicFile
1053
1431
  *
1054
- * Delete file entity
1432
+ * Generate thumbnail preview for a public file entity
1055
1433
  */
1056
- 'delete'(
1057
- parameters?: Parameters<UnknownParamsObject> | null,
1058
- data?: Paths.DeleteFile.RequestBody,
1434
+ 'get'(
1435
+ parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
1436
+ data?: any,
1059
1437
  config?: AxiosRequestConfig
1060
- ): OperationResponse<Paths.DeleteFile.Responses.$200>
1438
+ ): OperationResponse<any>
1061
1439
  }
1062
1440
  ['/v1/files/session']: {
1063
1441
  /**
@@ -1088,7 +1466,7 @@ export interface PathsDictionary {
1088
1466
  /**
1089
1467
  * generatePublicLink - generatePublicLink
1090
1468
  *
1091
- * Generates a public link to access the private files
1469
+ * Generates a public link to access a private file
1092
1470
  *
1093
1471
  */
1094
1472
  'post'(
@@ -1097,15 +1475,15 @@ export interface PathsDictionary {
1097
1475
  config?: AxiosRequestConfig
1098
1476
  ): OperationResponse<Paths.GeneratePublicLink.Responses.$201>
1099
1477
  /**
1100
- * getAllPublicLinksForFile - getAllPublicLinksForFile
1478
+ * listPublicLinksForFile - listPublicLinksForFile
1101
1479
  *
1102
- * Not yet implemented; This API would fetches all the public links that are previously generated for a file
1480
+ * Not yet implemented; This API would fetch all the public links that are previously generated for a file
1103
1481
  */
1104
1482
  'get'(
1105
- parameters?: Parameters<Paths.GetAllPublicLinksForFile.PathParameters> | null,
1483
+ parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
1106
1484
  data?: any,
1107
1485
  config?: AxiosRequestConfig
1108
- ): OperationResponse<Paths.GetAllPublicLinksForFile.Responses.$200>
1486
+ ): OperationResponse<Paths.ListPublicLinksForFile.Responses.$200>
1109
1487
  }
1110
1488
  ['/v1/files/public/links/{id}/{filename}']: {
1111
1489
  /**
@@ -1114,7 +1492,7 @@ export interface PathsDictionary {
1114
1492
  * Redirects to a accessible signed url for the respective file associated to the public link
1115
1493
  */
1116
1494
  'get'(
1117
- parameters?: Parameters<Paths.AccessPublicLink.PathParameters> | null,
1495
+ parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
1118
1496
  data?: any,
1119
1497
  config?: AxiosRequestConfig
1120
1498
  ): OperationResponse<any>
@@ -1123,7 +1501,7 @@ export interface PathsDictionary {
1123
1501
  /**
1124
1502
  * revokePublicLink - revokePublicLink
1125
1503
  *
1126
- * Not yet implemented; This operation would revokes a given public link by ID
1504
+ * Not yet implemented; This operation would revoke a given public link by ID
1127
1505
  */
1128
1506
  'delete'(
1129
1507
  parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
@@ -1131,55 +1509,58 @@ export interface PathsDictionary {
1131
1509
  config?: AxiosRequestConfig
1132
1510
  ): OperationResponse<Paths.RevokePublicLink.Responses.$204>
1133
1511
  }
1134
- ['/v2/files/upload']: {
1512
+ ['/v1/files/download:verify']: {
1135
1513
  /**
1136
- * uploadFileV2 - uploadFileV2
1137
- *
1138
- * Create pre-signed S3 URL to upload a file to keep temporarily (one week). - v2
1139
- *
1140
- * Use the createFile operation to store file file permanently.
1514
+ * verifyCustomDownloadUrl - verifyCustomDownloadUrl
1141
1515
  *
1516
+ * Verify a pre-signed custom download url for a file
1142
1517
  */
1143
1518
  'post'(
1144
- parameters?: Parameters<Paths.UploadFileV2.QueryParameters> | null,
1145
- data?: Paths.UploadFileV2.RequestBody,
1519
+ parameters?: Parameters<UnknownParamsObject> | null,
1520
+ data?: Paths.VerifyCustomDownloadUrl.RequestBody,
1146
1521
  config?: AxiosRequestConfig
1147
- ): OperationResponse<Paths.UploadFileV2.Responses.$201>
1522
+ ): OperationResponse<Paths.VerifyCustomDownloadUrl.Responses.$200>
1148
1523
  }
1149
- ['/v2/files']: {
1524
+ ['/v1/files/public/upload']: {
1150
1525
  /**
1151
- * saveFileV2 - saveFileV2
1152
- *
1153
- * Create / Update a permanent File entity
1526
+ * uploadFilePublic - uploadFilePublic
1154
1527
  *
1155
- * Makes file object permanent
1528
+ * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
1156
1529
  *
1157
- * Saves metadata to file entity
1530
+ * Use the saveFileV2 operation to store file file permanently.
1158
1531
  *
1159
1532
  */
1160
1533
  'post'(
1161
1534
  parameters?: Parameters<UnknownParamsObject> | null,
1162
- data?: Paths.SaveFileV2.RequestBody,
1535
+ data?: Paths.UploadFilePublic.RequestBody,
1163
1536
  config?: AxiosRequestConfig
1164
- ): OperationResponse<Paths.SaveFileV2.Responses.$201>
1537
+ ): OperationResponse<Paths.UploadFilePublic.Responses.$201>
1165
1538
  }
1166
1539
  }
1167
1540
 
1168
1541
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
1169
1542
 
1543
+
1544
+ export type ActivityId = Components.Schemas.ActivityId;
1545
+ export type BaseEntityAcl = Components.Schemas.BaseEntityAcl;
1546
+ export type BaseEntityOwner = Components.Schemas.BaseEntityOwner;
1170
1547
  export type CommonSaveFilePayload = Components.Schemas.CommonSaveFilePayload;
1171
- export type DeleteFilePayload = Components.Schemas.DeleteFilePayload;
1548
+ export type CustomDownloadUrl = Components.Schemas.CustomDownloadUrl;
1172
1549
  export type DownloadFilesPayload = Components.Schemas.DownloadFilesPayload;
1173
1550
  export type EntityId = Components.Schemas.EntityId;
1174
1551
  export type EntitySlug = Components.Schemas.EntitySlug;
1552
+ export type FileAttributes = Components.Schemas.FileAttributes;
1175
1553
  export type FileEntity = Components.Schemas.FileEntity;
1176
1554
  export type FileEntityId = Components.Schemas.FileEntityId;
1177
1555
  export type FileItem = Components.Schemas.FileItem;
1178
1556
  export type FileRelationItem = Components.Schemas.FileRelationItem;
1557
+ export type FileType = Components.Schemas.FileType;
1179
1558
  export type FileUpload = Components.Schemas.FileUpload;
1180
1559
  export type PublicLink = Components.Schemas.PublicLink;
1560
+ export type S3Ref = Components.Schemas.S3Ref;
1181
1561
  export type S3Reference = Components.Schemas.S3Reference;
1182
1562
  export type SaveCustomFilePayload = Components.Schemas.SaveCustomFilePayload;
1563
+ export type SaveFileFromSourceURLPayload = Components.Schemas.SaveFileFromSourceURLPayload;
1183
1564
  export type SaveFilePayload = Components.Schemas.SaveFilePayload;
1184
1565
  export type SaveFilePayloadV2 = Components.Schemas.SaveFilePayloadV2;
1185
1566
  export type SaveS3FilePayload = Components.Schemas.SaveS3FilePayload;