@epilot/file-client 1.0.4 → 1.1.3

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 (4) hide show
  1. package/dist/definition.js +1 -1
  2. package/dist/openapi.d.ts +57 -11
  3. package/package.json +1 -1
  4. package/src/openapi.d.ts +57 -11
package/dist/definition.js CHANGED
@@ -1 +1 @@
1
- !function(e,t){for(var i in t)e[i]=t[i];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,i){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=a(i(279));t.default=n.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"File API","version":"0.1.0","description":"File Upload and Management for epilot SaaS"},"tags":[{"name":"files","description":"Files"}],"security":[{"EpilotAuth":[]},{"AsOrganization":[]}],"paths":{"/v1/files/public/upload":{"post":{"operationId":"uploadFilePublic","summary":"uploadFilePublic","security":[],"description":"Create pre-signed S3 URL to upload a file to keep temporarily (one week).\\n\\nUse the createFile operation to store file file permanently.\\n","tags":["files"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFilePayload"}}}},"responses":{"201":{"description":"Pre-signed URL for POST / PUT upload","content":{"application/json":{"schema":{"type":"object","properties":{"upload_url":{"type":"string","format":"url","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"},"s3ref":{"allOf":[{"$ref":"#/components/schemas/S3Reference"},{"example":{"bucket":"epilot-files-prod","key":"123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}}]}}}}}}}}},"/v1/files/upload":{"post":{"operationId":"uploadFile","summary":"uploadFile","description":"Create pre-signed S3 URL to upload a file to keep temporarily (one week).\\n\\nUse the createFile operation to store file file permanently.\\n","tags":["files"],"parameters":[{"name":"file_entity_id","in":"query","description":"file entity id","schema":{"$ref":"#/components/schemas/FileEntityId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFilePayload","type":"object"}}}},"responses":{"201":{"description":"Pre-signed URL for POST / PUT upload","content":{"application/json":{"schema":{"type":"object","properties":{"upload_url":{"type":"string","format":"url","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"},"s3ref":{"allOf":[{"$ref":"#/components/schemas/S3Reference"},{"example":{"bucket":"epilot-files-prod","key":"123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}}]}}}}}}}}},"/v1/files":{"post":{"operationId":"saveFile","summary":"saveFile","description":"Create / Update a permanent File entity\\n\\nMakes file object permanent\\n\\nSaves metadata to file entity\\n","tags":["files"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveFilePayload"}}}},"responses":{"201":{"description":"Created File Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileEntity"}}}}}}},"/v1/files/{id}/download":{"get":{"operationId":"downloadFile","summary":"downloadFile","description":"Generate pre-signed download S3 url for a file","tags":["files"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FileEntityId"}},{"name":"version","in":"query","description":"index of file version","schema":{"type":"integer","default":0}}],"responses":{"200":{"description":"Generated thumbnail image","content":{"application/json":{"schema":{"type":"object","properties":{"download_url":{"type":"string","format":"uri","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"}}}}}}}}},"/v1/files/{id}/preview":{"get":{"operationId":"previewFile","summary":"previewFile","description":"Generate thumbnail preview for a file entity","tags":["files"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FileEntityId"}},{"name":"version","in":"query","description":"index of file version","schema":{"type":"integer","default":0}},{"name":"w","in":"query","description":"width","schema":{"type":"integer"}},{"name":"h","in":"query","description":"height","schema":{"type":"integer"}}],"responses":{"200":{"description":"Generated thumbnail image","content":{"image/png":{},"image/jpeg":{}}}}}},"/v1/files/delete":{"delete":{"operationId":"deleteFile","summary":"deleteFile","description":"Delete file entity","tags":["files"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFilePayload"}}}},"responses":{"200":{"description":"File delete response"}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id when using internal auth"}},"schemas":{"FileEntityId":{"type":"string","example":"ef7d985c-2385-44f4-9c71-ae06a52264f8"},"FileEntity":{"type":"object","properties":{"_id":{"$ref":"#/components/schemas/FileEntityId"},"filename":{"type":"string","example":"document.pdf"},"access_control":{"type":"string","default":"private","enum":["private","public"]},"versions":{"type":"array","items":{"type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"}}}}}},"UploadFilePayload":{"type":"object","properties":{"filename":{"type":"string","example":"document.pdf"},"mime_type":{"description":"MIME type of file","type":"string","example":"image/png","default":"application/octet-stream"}},"required":["filename"]},"SaveFilePayload":{"type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"},"file_entity_id":{"type":"string","description":"if passed, adds a new version to existing file entity"},"filename":{"type":"string","example":"document.pdf"},"_tags":{"type":"array","items":{"type":"string"}},"access_control":{"type":"string","default":"private","enum":["private","public"]}},"required":["s3ref"]},"DeleteFilePayload":{"type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"}},"required":["s3ref"]},"S3Reference":{"type":"object","properties":{"bucket":{"type":"string","example":"epilot-files-prod"},"key":{"type":"string","example":"123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}},"required":["bucket","key"]},"FileItem":{"allOf":[{"$ref":"#/components/schemas/S3Reference"},{"type":"object","properties":{"filename":{"type":"string","example":"document.pdf"},"size_bytes":{"type":"integer","example":1234},"mime_type":{"type":"string","example":"image/jpeg"}}}]}}}}')}},t={};return function i(a){if(t[a])return t[a].exports;var n=t[a]={exports:{}};return e[a].call(n.exports,n,n.exports,i),n.exports}(914)})());
1
+ !function(e,t){for(var i in t)e[i]=t[i];t.__esModule&&Object.defineProperty(e,"__esModule",{value:!0})}(exports,(()=>{"use strict";var e={914:function(e,t,i){var a=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var n=a(i(279));t.default=n.default},279:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"File API","version":"0.1.0","description":"File Upload and Management for epilot SaaS"},"tags":[{"name":"files","description":"Files"}],"security":[{"EpilotAuth":[]},{"AsOrganization":[]}],"paths":{"/v1/files/public/upload":{"post":{"operationId":"uploadFilePublic","summary":"uploadFilePublic","security":[],"description":"Create pre-signed S3 URL to upload a file to keep temporarily (one week).\\n\\nUse the createFile operation to store file file permanently.\\n","tags":["files"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFilePayload"}}}},"responses":{"201":{"description":"Pre-signed URL for POST / PUT upload","content":{"application/json":{"schema":{"type":"object","properties":{"s3ref":{"allOf":[{"$ref":"#/components/schemas/S3Reference"},{"example":{"bucket":"epilot-files-prod","key":"123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}}]},"upload_url":{"type":"string","format":"url","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"}}}}}}}}},"/v1/files/upload":{"post":{"operationId":"uploadFile","summary":"uploadFile","description":"Create pre-signed S3 URL to upload a file to keep temporarily (one week).\\n\\nUse the createFile operation to store file file permanently.\\n","tags":["files"],"parameters":[{"name":"file_entity_id","in":"query","description":"file entity id","schema":{"$ref":"#/components/schemas/FileEntityId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadFilePayload","type":"object"}}}},"responses":{"201":{"description":"Pre-signed URL for POST / PUT upload","content":{"application/json":{"schema":{"type":"object","properties":{"s3ref":{"allOf":[{"$ref":"#/components/schemas/S3Reference"},{"example":{"bucket":"epilot-files-prod","key":"123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}}]},"upload_url":{"type":"string","format":"url","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"},"public_url":{"description":"Returned only if file is permanent i.e. file_entity_id is passed","type":"string","format":"url","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}}}}}}}}},"/v1/files":{"post":{"operationId":"saveFile","summary":"saveFile","description":"Create / Update a permanent File entity\\n\\nMakes file object permanent\\n\\nSaves metadata to file entity\\n","tags":["files"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveFilePayload"}}}},"responses":{"201":{"description":"Created File Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileEntity"}}}}}}},"/v1/files/{id}/download":{"get":{"operationId":"downloadFile","summary":"downloadFile","description":"Generate pre-signed download S3 url for a file","tags":["files"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FileEntityId"}},{"name":"version","in":"query","description":"index of file version","schema":{"type":"integer","default":0}},{"name":"attachment","in":"query","description":"to set content disposition","schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Generated thumbnail image","content":{"application/json":{"schema":{"type":"object","properties":{"download_url":{"type":"string","format":"uri","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123"}}}}}}}}},"/v1/files/{id}/preview":{"get":{"operationId":"previewFile","summary":"previewFile","description":"Generate thumbnail preview for a file entity","tags":["files"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FileEntityId"}},{"name":"version","in":"query","description":"index of file version","schema":{"type":"integer","default":0}},{"name":"w","in":"query","description":"width","schema":{"type":"integer"}},{"name":"h","in":"query","description":"height","schema":{"type":"integer"}}],"responses":{"200":{"description":"Generated thumbnail image","content":{"image/png":{},"image/jpeg":{}}}}}},"/v1/files:previewS3":{"post":{"operationId":"previewS3File","summary":"previewS3File","description":"Generate thumbnail preview from an s3 reference for a file entity","tags":["files"],"parameters":[{"name":"w","in":"query","description":"width","schema":{"type":"integer"}},{"name":"h","in":"query","description":"height","schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/S3Reference"}}}},"responses":{"200":{"description":"Generated thumbnail image","content":{"image/png":{},"image/jpeg":{}}}}}},"/v1/files/delete":{"delete":{"operationId":"deleteFile","summary":"deleteFile","description":"Delete file entity","tags":["files"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteFilePayload"}}}},"responses":{"200":{"description":"File delete response"}}}}},"components":{"securitySchemes":{"EpilotAuth":{"type":"http","scheme":"bearer","description":"Epilot Bearer Token"},"AsOrganization":{"type":"apiKey","in":"header","name":"x-ivy-org-id","description":"Set organization id when using internal auth"}},"schemas":{"FileEntityId":{"type":"string","example":"ef7d985c-2385-44f4-9c71-ae06a52264f8"},"FileEntity":{"type":"object","properties":{"_id":{"$ref":"#/components/schemas/FileEntityId"},"filename":{"type":"string","example":"document.pdf"},"access_control":{"type":"string","default":"private","enum":["private","public"]},"public_url":{"type":"string","format":"url","example":"https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"},"versions":{"type":"array","items":{"type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"}}}}}},"UploadFilePayload":{"type":"object","properties":{"filename":{"type":"string","example":"document.pdf"},"mime_type":{"description":"MIME type of file","type":"string","example":"application/pdf","default":"application/octet-stream"}},"required":["filename"]},"SaveFilePayload":{"type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"},"file_entity_id":{"type":"string","description":"if passed, adds a new version to existing file entity"},"filename":{"type":"string","example":"document.pdf"},"_tags":{"type":"array","items":{"type":"string"}},"access_control":{"type":"string","default":"private","enum":["private","public"]}},"required":["s3ref"]},"DeleteFilePayload":{"type":"object","properties":{"s3ref":{"$ref":"#/components/schemas/S3Reference"}},"required":["s3ref"]},"S3Reference":{"type":"object","properties":{"bucket":{"type":"string","example":"epilot-files-prod"},"key":{"type":"string","example":"123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf"}},"required":["bucket","key"]},"FileItem":{"allOf":[{"$ref":"#/components/schemas/S3Reference"},{"type":"object","properties":{"filename":{"type":"string","example":"document.pdf"},"size_bytes":{"type":"integer","example":1234},"mime_type":{"type":"string","example":"image/jpeg"}}}]}}}}')}},t={};return function i(a){if(t[a])return t[a].exports;var n=t[a]={exports:{}};return e[a].call(n.exports,n,n.exports,i),n.exports}(914)})());
package/dist/openapi.d.ts CHANGED
@@ -20,6 +20,11 @@ declare namespace Components {
20
20
  */
21
21
  filename?: string;
22
22
  access_control?: "private" | "public";
23
+ /**
24
+ * example:
25
+ * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
26
+ */
27
+ public_url?: string; // url
23
28
  versions?: {
24
29
  s3ref?: S3Reference;
25
30
  }[];
@@ -91,7 +96,7 @@ declare namespace Components {
91
96
  /**
92
97
  * MIME type of file
93
98
  * example:
94
- * image/png
99
+ * application/pdf
95
100
  */
96
101
  mime_type?: string;
97
102
  }
@@ -103,6 +108,7 @@ declare namespace Paths {
103
108
  }
104
109
  namespace DownloadFile {
105
110
  namespace Parameters {
111
+ export type Attachment = boolean;
106
112
  export type Id = Components.Schemas.FileEntityId;
107
113
  export type Version = number;
108
114
  }
@@ -111,6 +117,7 @@ declare namespace Paths {
111
117
  }
112
118
  export interface QueryParameters {
113
119
  version?: Parameters.Version;
120
+ attachment?: Parameters.Attachment;
114
121
  }
115
122
  namespace Responses {
116
123
  export interface $200 {
@@ -138,6 +145,17 @@ declare namespace Paths {
138
145
  h?: Parameters.H;
139
146
  }
140
147
  }
148
+ namespace PreviewS3File {
149
+ namespace Parameters {
150
+ export type H = number;
151
+ export type W = number;
152
+ }
153
+ export interface QueryParameters {
154
+ w?: Parameters.W;
155
+ h?: Parameters.H;
156
+ }
157
+ export type RequestBody = Components.Schemas.S3Reference;
158
+ }
141
159
  namespace SaveFile {
142
160
  export type RequestBody = Components.Schemas.SaveFilePayload;
143
161
  namespace Responses {
@@ -154,11 +172,6 @@ declare namespace Paths {
154
172
  export type RequestBody = Components.Schemas.UploadFilePayload;
155
173
  namespace Responses {
156
174
  export interface $201 {
157
- /**
158
- * example:
159
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
160
- */
161
- upload_url?: string; // url
162
175
  /**
163
176
  * example:
164
177
  * {
@@ -178,6 +191,17 @@ declare namespace Paths {
178
191
  */
179
192
  key: string;
180
193
  };
194
+ /**
195
+ * example:
196
+ * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
197
+ */
198
+ upload_url?: string; // url
199
+ /**
200
+ * Returned only if file is permanent i.e. file_entity_id is passed
201
+ * example:
202
+ * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
203
+ */
204
+ public_url?: string; // url
181
205
  }
182
206
  }
183
207
  }
@@ -185,11 +209,6 @@ declare namespace Paths {
185
209
  export type RequestBody = Components.Schemas.UploadFilePayload;
186
210
  namespace Responses {
187
211
  export interface $201 {
188
- /**
189
- * example:
190
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
191
- */
192
- upload_url?: string; // url
193
212
  /**
194
213
  * example:
195
214
  * {
@@ -209,6 +228,11 @@ declare namespace Paths {
209
228
  */
210
229
  key: string;
211
230
  };
231
+ /**
232
+ * example:
233
+ * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
234
+ */
235
+ upload_url?: string; // url
212
236
  }
213
237
  }
214
238
  }
@@ -276,6 +300,16 @@ export interface OperationMethods {
276
300
  data?: any,
277
301
  config?: AxiosRequestConfig
278
302
  ): OperationResponse<any>
303
+ /**
304
+ * previewS3File - previewS3File
305
+ *
306
+ * Generate thumbnail preview from an s3 reference for a file entity
307
+ */
308
+ 'previewS3File'(
309
+ parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
310
+ data?: Paths.PreviewS3File.RequestBody,
311
+ config?: AxiosRequestConfig
312
+ ): OperationResponse<any>
279
313
  /**
280
314
  * deleteFile - deleteFile
281
315
  *
@@ -360,6 +394,18 @@ export interface PathsDictionary {
360
394
  config?: AxiosRequestConfig
361
395
  ): OperationResponse<any>
362
396
  }
397
+ ['/v1/files:previewS3']: {
398
+ /**
399
+ * previewS3File - previewS3File
400
+ *
401
+ * Generate thumbnail preview from an s3 reference for a file entity
402
+ */
403
+ 'post'(
404
+ parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
405
+ data?: Paths.PreviewS3File.RequestBody,
406
+ config?: AxiosRequestConfig
407
+ ): OperationResponse<any>
408
+ }
363
409
  ['/v1/files/delete']: {
364
410
  /**
365
411
  * deleteFile - deleteFile
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/file-client",
3
- "version": "1.0.4",
3
+ "version": "1.1.3",
4
4
  "description": "API client for epilot File API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/openapi.d.ts CHANGED
@@ -20,6 +20,11 @@ declare namespace Components {
20
20
  */
21
21
  filename?: string;
22
22
  access_control?: "private" | "public";
23
+ /**
24
+ * example:
25
+ * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
26
+ */
27
+ public_url?: string; // url
23
28
  versions?: {
24
29
  s3ref?: S3Reference;
25
30
  }[];
@@ -91,7 +96,7 @@ declare namespace Components {
91
96
  /**
92
97
  * MIME type of file
93
98
  * example:
94
- * image/png
99
+ * application/pdf
95
100
  */
96
101
  mime_type?: string;
97
102
  }
@@ -103,6 +108,7 @@ declare namespace Paths {
103
108
  }
104
109
  namespace DownloadFile {
105
110
  namespace Parameters {
111
+ export type Attachment = boolean;
106
112
  export type Id = Components.Schemas.FileEntityId;
107
113
  export type Version = number;
108
114
  }
@@ -111,6 +117,7 @@ declare namespace Paths {
111
117
  }
112
118
  export interface QueryParameters {
113
119
  version?: Parameters.Version;
120
+ attachment?: Parameters.Attachment;
114
121
  }
115
122
  namespace Responses {
116
123
  export interface $200 {
@@ -138,6 +145,17 @@ declare namespace Paths {
138
145
  h?: Parameters.H;
139
146
  }
140
147
  }
148
+ namespace PreviewS3File {
149
+ namespace Parameters {
150
+ export type H = number;
151
+ export type W = number;
152
+ }
153
+ export interface QueryParameters {
154
+ w?: Parameters.W;
155
+ h?: Parameters.H;
156
+ }
157
+ export type RequestBody = Components.Schemas.S3Reference;
158
+ }
141
159
  namespace SaveFile {
142
160
  export type RequestBody = Components.Schemas.SaveFilePayload;
143
161
  namespace Responses {
@@ -154,11 +172,6 @@ declare namespace Paths {
154
172
  export type RequestBody = Components.Schemas.UploadFilePayload;
155
173
  namespace Responses {
156
174
  export interface $201 {
157
- /**
158
- * example:
159
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
160
- */
161
- upload_url?: string; // url
162
175
  /**
163
176
  * example:
164
177
  * {
@@ -178,6 +191,17 @@ declare namespace Paths {
178
191
  */
179
192
  key: string;
180
193
  };
194
+ /**
195
+ * example:
196
+ * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
197
+ */
198
+ upload_url?: string; // url
199
+ /**
200
+ * Returned only if file is permanent i.e. file_entity_id is passed
201
+ * example:
202
+ * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
203
+ */
204
+ public_url?: string; // url
181
205
  }
182
206
  }
183
207
  }
@@ -185,11 +209,6 @@ declare namespace Paths {
185
209
  export type RequestBody = Components.Schemas.UploadFilePayload;
186
210
  namespace Responses {
187
211
  export interface $201 {
188
- /**
189
- * example:
190
- * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
191
- */
192
- upload_url?: string; // url
193
212
  /**
194
213
  * example:
195
214
  * {
@@ -209,6 +228,11 @@ declare namespace Paths {
209
228
  */
210
229
  key: string;
211
230
  };
231
+ /**
232
+ * example:
233
+ * https://epilot-files-prod.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
234
+ */
235
+ upload_url?: string; // url
212
236
  }
213
237
  }
214
238
  }
@@ -276,6 +300,16 @@ export interface OperationMethods {
276
300
  data?: any,
277
301
  config?: AxiosRequestConfig
278
302
  ): OperationResponse<any>
303
+ /**
304
+ * previewS3File - previewS3File
305
+ *
306
+ * Generate thumbnail preview from an s3 reference for a file entity
307
+ */
308
+ 'previewS3File'(
309
+ parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
310
+ data?: Paths.PreviewS3File.RequestBody,
311
+ config?: AxiosRequestConfig
312
+ ): OperationResponse<any>
279
313
  /**
280
314
  * deleteFile - deleteFile
281
315
  *
@@ -360,6 +394,18 @@ export interface PathsDictionary {
360
394
  config?: AxiosRequestConfig
361
395
  ): OperationResponse<any>
362
396
  }
397
+ ['/v1/files:previewS3']: {
398
+ /**
399
+ * previewS3File - previewS3File
400
+ *
401
+ * Generate thumbnail preview from an s3 reference for a file entity
402
+ */
403
+ 'post'(
404
+ parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
405
+ data?: Paths.PreviewS3File.RequestBody,
406
+ config?: AxiosRequestConfig
407
+ ): OperationResponse<any>
408
+ }
363
409
  ['/v1/files/delete']: {
364
410
  /**
365
411
  * deleteFile - deleteFile