@epilot/sdk 2.4.4-alpha.0 → 2.4.4

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 (222) hide show
  1. package/dist/access-token.d-CnmUTOlq.d.cts +552 -0
  2. package/dist/access-token.d-CnmUTOlq.d.ts +552 -0
  3. package/dist/address-suggestions.d-_YwTOR-9.d.cts +339 -0
  4. package/dist/address-suggestions.d-_YwTOR-9.d.ts +339 -0
  5. package/dist/address.d-CwAPOVxa.d.cts +437 -0
  6. package/dist/address.d-CwAPOVxa.d.ts +437 -0
  7. package/dist/ai-agents.d-OkXfr2bz.d.cts +1339 -0
  8. package/dist/ai-agents.d-OkXfr2bz.d.ts +1339 -0
  9. package/dist/apis/access-token.d.cts +18 -0
  10. package/dist/apis/access-token.d.ts +12 -9
  11. package/dist/apis/address-suggestions.d.cts +18 -0
  12. package/dist/apis/address-suggestions.d.ts +12 -9
  13. package/dist/apis/address.d.cts +18 -0
  14. package/dist/apis/address.d.ts +12 -9
  15. package/dist/apis/ai-agents.d.cts +18 -0
  16. package/dist/apis/ai-agents.d.ts +12 -9
  17. package/dist/apis/app.d.cts +18 -0
  18. package/dist/apis/app.d.ts +12 -9
  19. package/dist/apis/audit-logs.d.cts +18 -0
  20. package/dist/apis/audit-logs.d.ts +12 -9
  21. package/dist/apis/automation.d.cts +18 -0
  22. package/dist/apis/automation.d.ts +12 -9
  23. package/dist/apis/billing.d.cts +18 -0
  24. package/dist/apis/billing.d.ts +12 -9
  25. package/dist/apis/blueprint-manifest.d.cts +18 -0
  26. package/dist/apis/blueprint-manifest.d.ts +12 -9
  27. package/dist/apis/calendar.d.cts +18 -0
  28. package/dist/apis/calendar.d.ts +12 -9
  29. package/dist/apis/configuration-hub.d.cts +18 -0
  30. package/dist/apis/configuration-hub.d.ts +12 -9
  31. package/dist/apis/consent.d.cts +18 -0
  32. package/dist/apis/consent.d.ts +12 -9
  33. package/dist/apis/customer-portal.d.cts +18 -0
  34. package/dist/apis/customer-portal.d.ts +12 -9
  35. package/dist/apis/dashboard.d.cts +18 -0
  36. package/dist/apis/dashboard.d.ts +12 -9
  37. package/dist/apis/data-governance.d.cts +18 -0
  38. package/dist/apis/data-governance.d.ts +12 -9
  39. package/dist/apis/deduplication.d.cts +18 -0
  40. package/dist/apis/deduplication.d.ts +12 -9
  41. package/dist/apis/design.d.cts +18 -0
  42. package/dist/apis/design.d.ts +12 -9
  43. package/dist/apis/document.d.cts +18 -0
  44. package/dist/apis/document.d.ts +12 -9
  45. package/dist/apis/email-settings.d.cts +18 -0
  46. package/dist/apis/email-settings.d.ts +12 -9
  47. package/dist/apis/email-template.d.cts +18 -0
  48. package/dist/apis/email-template.d.ts +12 -9
  49. package/dist/apis/entity-mapping.d.cts +18 -0
  50. package/dist/apis/entity-mapping.d.ts +12 -9
  51. package/dist/apis/entity.d.cts +18 -0
  52. package/dist/apis/entity.d.ts +12 -9
  53. package/dist/apis/environments.d.cts +18 -0
  54. package/dist/apis/environments.d.ts +12 -9
  55. package/dist/apis/event-catalog.d.cts +18 -0
  56. package/dist/apis/event-catalog.d.ts +12 -9
  57. package/dist/apis/file.d.cts +18 -0
  58. package/dist/apis/file.d.ts +12 -9
  59. package/dist/apis/iban.d.cts +18 -0
  60. package/dist/apis/iban.d.ts +12 -9
  61. package/dist/apis/integration-toolkit.d.cts +18 -0
  62. package/dist/apis/integration-toolkit.d.ts +12 -9
  63. package/dist/apis/journey.d.cts +18 -0
  64. package/dist/apis/journey.d.ts +12 -9
  65. package/dist/apis/kanban.d.cts +18 -0
  66. package/dist/apis/kanban.d.ts +12 -9
  67. package/dist/apis/message.d.cts +18 -0
  68. package/dist/apis/message.d.ts +12 -9
  69. package/dist/apis/metering.d.cts +18 -0
  70. package/dist/apis/metering.d.ts +12 -9
  71. package/dist/apis/notes.d.cts +18 -0
  72. package/dist/apis/notes.d.ts +12 -9
  73. package/dist/apis/notification.d.cts +18 -0
  74. package/dist/apis/notification.d.ts +12 -9
  75. package/dist/apis/organization.d.cts +18 -0
  76. package/dist/apis/organization.d.ts +12 -9
  77. package/dist/apis/partner-directory.d.cts +18 -0
  78. package/dist/apis/partner-directory.d.ts +12 -9
  79. package/dist/apis/permissions.d.cts +18 -0
  80. package/dist/apis/permissions.d.ts +12 -9
  81. package/dist/apis/pricing-tier.d.cts +18 -0
  82. package/dist/apis/pricing-tier.d.ts +12 -9
  83. package/dist/apis/pricing.d.cts +18 -0
  84. package/dist/apis/pricing.d.ts +12 -9
  85. package/dist/apis/purpose.d.cts +18 -0
  86. package/dist/apis/purpose.d.ts +12 -9
  87. package/dist/apis/query.d.cts +18 -0
  88. package/dist/apis/query.d.ts +12 -9
  89. package/dist/apis/sandbox.d.cts +18 -0
  90. package/dist/apis/sandbox.d.ts +12 -9
  91. package/dist/apis/sharing.d.cts +18 -0
  92. package/dist/apis/sharing.d.ts +12 -9
  93. package/dist/apis/submission.d.cts +18 -0
  94. package/dist/apis/submission.d.ts +12 -9
  95. package/dist/apis/target.d.cts +597 -0
  96. package/dist/apis/target.d.ts +591 -9
  97. package/dist/apis/targeting.d.cts +18 -0
  98. package/dist/apis/targeting.d.ts +12 -9
  99. package/dist/apis/template-variables.d.cts +18 -0
  100. package/dist/apis/template-variables.d.ts +12 -9
  101. package/dist/apis/user.d.cts +18 -0
  102. package/dist/apis/user.d.ts +12 -9
  103. package/dist/apis/validation-rules.d.cts +18 -0
  104. package/dist/apis/validation-rules.d.ts +12 -9
  105. package/dist/apis/webhooks.d.cts +18 -0
  106. package/dist/apis/webhooks.d.ts +12 -9
  107. package/dist/apis/workflow-definition.d.cts +18 -0
  108. package/dist/apis/workflow-definition.d.ts +12 -9
  109. package/dist/apis/workflow.d.cts +18 -0
  110. package/dist/apis/workflow.d.ts +12 -9
  111. package/dist/app.d-u7Dq42kU.d.cts +3391 -0
  112. package/dist/app.d-u7Dq42kU.d.ts +3391 -0
  113. package/dist/audit-logs.d-BRToFqeX.d.cts +287 -0
  114. package/dist/audit-logs.d-BRToFqeX.d.ts +287 -0
  115. package/dist/automation.d-Du6-uiz5.d.cts +5283 -0
  116. package/dist/automation.d-Du6-uiz5.d.ts +5283 -0
  117. package/dist/billing.d-Bs8Ku9qE.d.cts +993 -0
  118. package/dist/billing.d-Bs8Ku9qE.d.ts +993 -0
  119. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +4343 -0
  120. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +4343 -0
  121. package/dist/calendar.d-BEjLDagH.d.cts +353 -0
  122. package/dist/calendar.d-BEjLDagH.d.ts +353 -0
  123. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +478 -0
  124. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +478 -0
  125. package/dist/consent.d-C2PROHhX.d.cts +265 -0
  126. package/dist/consent.d-C2PROHhX.d.ts +265 -0
  127. package/dist/customer-portal.d-DyZ2n2dW.d.cts +16728 -0
  128. package/dist/customer-portal.d-DyZ2n2dW.d.ts +16728 -0
  129. package/dist/dashboard.d-CsGcA74I.d.cts +440 -0
  130. package/dist/dashboard.d-CsGcA74I.d.ts +440 -0
  131. package/dist/data-governance.d-BbZ466j5.d.cts +1178 -0
  132. package/dist/data-governance.d-BbZ466j5.d.ts +1178 -0
  133. package/dist/deduplication.d-D5GYddVu.d.cts +218 -0
  134. package/dist/deduplication.d-D5GYddVu.d.ts +218 -0
  135. package/dist/design.d-BRre8iLg.d.cts +2346 -0
  136. package/dist/design.d-BRre8iLg.d.ts +2346 -0
  137. package/dist/document.d-DN37pjdx.d.cts +648 -0
  138. package/dist/document.d-DN37pjdx.d.ts +648 -0
  139. package/dist/email-settings.d-B7Q_xT25.d.cts +2417 -0
  140. package/dist/email-settings.d-B7Q_xT25.d.ts +2417 -0
  141. package/dist/email-template.d-gtQkdaXM.d.cts +1188 -0
  142. package/dist/email-template.d-gtQkdaXM.d.ts +1188 -0
  143. package/dist/entity-mapping.d-DKSW3sfy.d.cts +1092 -0
  144. package/dist/entity-mapping.d-DKSW3sfy.d.ts +1092 -0
  145. package/dist/entity.d-BHR9dEon.d.cts +18479 -0
  146. package/dist/entity.d-BHR9dEon.d.ts +18479 -0
  147. package/dist/environments.d-BvqvN-PD.d.cts +382 -0
  148. package/dist/environments.d-BvqvN-PD.d.ts +382 -0
  149. package/dist/event-catalog.d-ENw6HO-w.d.cts +1511 -0
  150. package/dist/event-catalog.d-ENw6HO-w.d.ts +1511 -0
  151. package/dist/file.d-DcTJxjp7.d.cts +2992 -0
  152. package/dist/file.d-DcTJxjp7.d.ts +2992 -0
  153. package/dist/iban.d-BwdiGbxi.d.cts +70 -0
  154. package/dist/iban.d-BwdiGbxi.d.ts +70 -0
  155. package/dist/index.d.cts +182 -0
  156. package/dist/index.d.ts +182 -12
  157. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +5796 -0
  158. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +5796 -0
  159. package/dist/journey.d-ClXO0xK8.d.cts +1931 -0
  160. package/dist/journey.d-ClXO0xK8.d.ts +1931 -0
  161. package/dist/kanban.d-BHnSRCYW.d.cts +760 -0
  162. package/dist/kanban.d-BHnSRCYW.d.ts +760 -0
  163. package/dist/message.d-B5UuSqgw.d.cts +3811 -0
  164. package/dist/message.d-B5UuSqgw.d.ts +3811 -0
  165. package/dist/metering.d-DvtPv7wk.d.cts +1841 -0
  166. package/dist/metering.d-DvtPv7wk.d.ts +1841 -0
  167. package/dist/notes.d-BC-scR42.d.cts +1046 -0
  168. package/dist/notes.d-BC-scR42.d.ts +1046 -0
  169. package/dist/notification.d-BfBL3lga.d.cts +1147 -0
  170. package/dist/notification.d-BfBL3lga.d.ts +1147 -0
  171. package/dist/organization.d-DqwnNxMg.d.cts +1271 -0
  172. package/dist/organization.d-DqwnNxMg.d.ts +1271 -0
  173. package/dist/partner-directory.d-BCIjHoGs.d.cts +2337 -0
  174. package/dist/partner-directory.d-BCIjHoGs.d.ts +2337 -0
  175. package/dist/permissions.d-l6AT8SYP.d.cts +1279 -0
  176. package/dist/permissions.d-l6AT8SYP.d.ts +1279 -0
  177. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +81 -0
  178. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +81 -0
  179. package/dist/pricing.d-BHpMU4KU.d.cts +12255 -0
  180. package/dist/pricing.d-BHpMU4KU.d.ts +12255 -0
  181. package/dist/purpose.d-CbIYfTua.d.cts +372 -0
  182. package/dist/purpose.d-CbIYfTua.d.ts +372 -0
  183. package/dist/query.d-Cmp78IhZ.d.cts +2375 -0
  184. package/dist/query.d-Cmp78IhZ.d.ts +2375 -0
  185. package/dist/sandbox.d-BdbOFzDu.d.cts +465 -0
  186. package/dist/sandbox.d-BdbOFzDu.d.ts +465 -0
  187. package/dist/sharing.d-sOXq-gtz.d.cts +571 -0
  188. package/dist/sharing.d-sOXq-gtz.d.ts +571 -0
  189. package/dist/submission.d-BamwfhXw.d.cts +469 -0
  190. package/dist/submission.d-BamwfhXw.d.ts +469 -0
  191. package/dist/targeting.d-BNmcVsNS.d.cts +2057 -0
  192. package/dist/targeting.d-BNmcVsNS.d.ts +2057 -0
  193. package/dist/template-variables.d-Ble9TSBa.d.cts +1320 -0
  194. package/dist/template-variables.d-Ble9TSBa.d.ts +1320 -0
  195. package/dist/types-ChU9Acbv.d.cts +37 -0
  196. package/dist/types-ChU9Acbv.d.ts +37 -0
  197. package/dist/user.d-D18fe97W.d.cts +2270 -0
  198. package/dist/user.d-D18fe97W.d.ts +2270 -0
  199. package/dist/validation-rules.d-Db5c5zTf.d.cts +807 -0
  200. package/dist/validation-rules.d-Db5c5zTf.d.ts +807 -0
  201. package/dist/webhooks.d-pLHIL_io.d.cts +1256 -0
  202. package/dist/webhooks.d-pLHIL_io.d.ts +1256 -0
  203. package/dist/workflow-definition.d-DOeb0KVV.d.cts +1922 -0
  204. package/dist/workflow-definition.d-DOeb0KVV.d.ts +1922 -0
  205. package/dist/workflow.d-CMSKt8oN.d.cts +3151 -0
  206. package/dist/workflow.d-CMSKt8oN.d.ts +3151 -0
  207. package/package.json +1 -1
  208. package/dist/apis/_registry.d.ts +0 -8
  209. package/dist/authorize.d.ts +0 -3
  210. package/dist/bin/cli.d.ts +0 -1
  211. package/dist/client-factory.d.ts +0 -9
  212. package/dist/client-map.d.ts +0 -102
  213. package/dist/compact.d.ts +0 -22
  214. package/dist/help.d.ts +0 -12
  215. package/dist/large-response.d.ts +0 -9
  216. package/dist/openapi.d.ts +0 -12
  217. package/dist/overrides.d.ts +0 -9
  218. package/dist/proxy.d.ts +0 -14
  219. package/dist/registry.d.ts +0 -19
  220. package/dist/retry.d.ts +0 -11
  221. package/dist/sdk.d.ts +0 -29
  222. package/dist/types.d.ts +0 -53
@@ -0,0 +1,2992 @@
1
+ import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
+
3
+ /* Auto-copied from file-client */
4
+ /* eslint-disable */
5
+
6
+
7
+
8
+ declare namespace Components {
9
+ namespace Parameters {
10
+ export type ActivityIdQueryParam = /**
11
+ * See https://github.com/ulid/spec
12
+ * example:
13
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
14
+ */
15
+ Schemas.ActivityId /* ulid */;
16
+ export type AsyncOperationQueryParam = boolean;
17
+ export type DeleteTempFileQueryParam = boolean;
18
+ export type EntityIdPathParam = /**
19
+ * example:
20
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
21
+ */
22
+ Schemas.EntityId;
23
+ export type FillActivityQueryParam = boolean;
24
+ export type StrictQueryParam = boolean;
25
+ export type VersionOnlyQueryParam = boolean;
26
+ }
27
+ export interface PathParameters {
28
+ EntityIdPathParam?: Parameters.EntityIdPathParam;
29
+ }
30
+ export interface QueryParameters {
31
+ StrictQueryParam?: Parameters.StrictQueryParam;
32
+ ActivityIdQueryParam?: Parameters.ActivityIdQueryParam;
33
+ FillActivityQueryParam?: Parameters.FillActivityQueryParam;
34
+ AsyncOperationQueryParam?: Parameters.AsyncOperationQueryParam;
35
+ DeleteTempFileQueryParam?: Parameters.DeleteTempFileQueryParam;
36
+ VersionOnlyQueryParam?: Parameters.VersionOnlyQueryParam;
37
+ }
38
+ namespace Responses {
39
+ /**
40
+ * A generic error returned by the API
41
+ * example:
42
+ * {
43
+ * "status": 400,
44
+ * "error": "Bad Request: filename is required"
45
+ * }
46
+ */
47
+ export interface BadRequestError {
48
+ /**
49
+ * The HTTP status code of the error
50
+ * example:
51
+ * 400
52
+ */
53
+ status?: number;
54
+ /**
55
+ * The error message
56
+ * example:
57
+ * Bad Request
58
+ */
59
+ error?: string;
60
+ }
61
+ /**
62
+ * A generic error returned by the API
63
+ * example:
64
+ * {
65
+ * "status": 403,
66
+ * "error": "Forbidden: You do not have permission to access this file"
67
+ * }
68
+ */
69
+ export interface ForbiddenError {
70
+ /**
71
+ * The HTTP status code of the error
72
+ * example:
73
+ * 400
74
+ */
75
+ status?: number;
76
+ /**
77
+ * The error message
78
+ * example:
79
+ * Bad Request
80
+ */
81
+ error?: string;
82
+ }
83
+ /**
84
+ * A generic error returned by the API
85
+ * example:
86
+ * {
87
+ * "status": 500,
88
+ * "error": "Internal Server Error"
89
+ * }
90
+ */
91
+ export interface InternalServerError {
92
+ /**
93
+ * The HTTP status code of the error
94
+ * example:
95
+ * 400
96
+ */
97
+ status?: number;
98
+ /**
99
+ * The error message
100
+ * example:
101
+ * Bad Request
102
+ */
103
+ error?: string;
104
+ }
105
+ /**
106
+ * A generic error returned by the API
107
+ * example:
108
+ * {
109
+ * "status": 404,
110
+ * "error": "Not Found: File entity not found"
111
+ * }
112
+ */
113
+ export interface NotFoundError {
114
+ /**
115
+ * The HTTP status code of the error
116
+ * example:
117
+ * 400
118
+ */
119
+ status?: number;
120
+ /**
121
+ * The error message
122
+ * example:
123
+ * Bad Request
124
+ */
125
+ error?: string;
126
+ }
127
+ /**
128
+ * A generic error returned by the API
129
+ * example:
130
+ * {
131
+ * "status": 401,
132
+ * "error": "Unauthorized: Invalid or expired token"
133
+ * }
134
+ */
135
+ export interface UnauthorizedError {
136
+ /**
137
+ * The HTTP status code of the error
138
+ * example:
139
+ * 400
140
+ */
141
+ status?: number;
142
+ /**
143
+ * The error message
144
+ * example:
145
+ * Bad Request
146
+ */
147
+ error?: string;
148
+ }
149
+ }
150
+ namespace Schemas {
151
+ /**
152
+ * See https://github.com/ulid/spec
153
+ * example:
154
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
155
+ */
156
+ export type ActivityId = string; // ulid
157
+ /**
158
+ * Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
159
+ */
160
+ export interface BaseEntityAcl {
161
+ view?: string[];
162
+ edit?: string[];
163
+ delete?: string[];
164
+ }
165
+ /**
166
+ * The user / organization owning this entity.
167
+ *
168
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
169
+ *
170
+ */
171
+ export interface BaseEntityOwner {
172
+ /**
173
+ * example:
174
+ * 123
175
+ */
176
+ org_id: string;
177
+ /**
178
+ * example:
179
+ * 123
180
+ */
181
+ user_id?: string;
182
+ }
183
+ /**
184
+ * Payload for batch version save. Only s3ref payloads are supported.
185
+ */
186
+ export interface BatchSaveFileVersionPayload {
187
+ /**
188
+ * Target file entity to add version to
189
+ * example:
190
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
191
+ */
192
+ _id?: /**
193
+ * Target file entity to add version to
194
+ * example:
195
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
196
+ */
197
+ string | string /* uuid */;
198
+ /**
199
+ * Deprecated, use _id instead
200
+ */
201
+ file_entity_id?: string;
202
+ /**
203
+ * example:
204
+ * document.pdf
205
+ */
206
+ filename?: string;
207
+ /**
208
+ * example:
209
+ * application/pdf
210
+ */
211
+ mime_type?: string;
212
+ access_control?: "private" | "public-read";
213
+ s3ref: S3Ref;
214
+ }
215
+ export interface CommonSaveFilePayload {
216
+ [name: string]: any;
217
+ /**
218
+ * if passed, adds a new version to existing file entity
219
+ * example:
220
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
221
+ */
222
+ _id?: /**
223
+ * if passed, adds a new version to existing file entity
224
+ * example:
225
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
226
+ */
227
+ string | string /* uuid */;
228
+ /**
229
+ * Deprecated, use _id instead
230
+ */
231
+ file_entity_id?: string;
232
+ /**
233
+ * List of entities to relate the file to
234
+ */
235
+ relations?: FileRelationItem[];
236
+ }
237
+ /**
238
+ * Custom external download url used for the file
239
+ * example:
240
+ * https://some-api-url.com/download?file_id=123
241
+ */
242
+ export type CustomDownloadUrl = string; // uri
243
+ export type DownloadFilesPayload = {
244
+ id: /**
245
+ * example:
246
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
247
+ */
248
+ FileEntityId;
249
+ /**
250
+ * File version
251
+ * example:
252
+ * 0
253
+ */
254
+ version?: number;
255
+ }[];
256
+ /**
257
+ * example:
258
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
259
+ */
260
+ export type EntityId = string;
261
+ /**
262
+ * URL-friendly identifier for the entity schema
263
+ * example:
264
+ * contact
265
+ */
266
+ export type EntitySlug = string;
267
+ /**
268
+ * A generic error returned by the API
269
+ */
270
+ export interface ErrorObject {
271
+ /**
272
+ * The HTTP status code of the error
273
+ * example:
274
+ * 400
275
+ */
276
+ status?: number;
277
+ /**
278
+ * The error message
279
+ * example:
280
+ * Bad Request
281
+ */
282
+ error?: string;
283
+ }
284
+ export interface FileAttributes {
285
+ /**
286
+ * example:
287
+ * [
288
+ * "tag1",
289
+ * "tag2"
290
+ * ]
291
+ */
292
+ _tags?: string[];
293
+ /**
294
+ * example:
295
+ * [
296
+ * "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
297
+ * "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
298
+ * ]
299
+ */
300
+ _purpose?: string[];
301
+ /**
302
+ * Manifest ID used to create/update the entity
303
+ */
304
+ _manifest?: string /* uuid */[];
305
+ /**
306
+ * example:
307
+ * document.pdf
308
+ */
309
+ filename?: string;
310
+ type?: FileType;
311
+ /**
312
+ * MIME type of the file
313
+ * example:
314
+ * application/pdf
315
+ */
316
+ mime_type?: string;
317
+ /**
318
+ * File size in bytes
319
+ * example:
320
+ * 1234
321
+ */
322
+ size_bytes?: number;
323
+ /**
324
+ * Human readable file size
325
+ * example:
326
+ * 1.2 MB
327
+ */
328
+ readable_size?: string;
329
+ access_control?: "private" | "public-read";
330
+ /**
331
+ * Direct URL for file (public only if file access control is public-read)
332
+ * example:
333
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
334
+ */
335
+ public_url?: string; // url
336
+ custom_download_url?: /**
337
+ * Custom external download url used for the file
338
+ * example:
339
+ * https://some-api-url.com/download?file_id=123
340
+ */
341
+ CustomDownloadUrl /* uri */;
342
+ }
343
+ export interface FileCollectionAttributes {
344
+ /**
345
+ * Name of the collection
346
+ */
347
+ name?: string;
348
+ /**
349
+ * Array of parent collection slugs, empty array if top-level collection
350
+ */
351
+ parents?: string[];
352
+ /**
353
+ * Whether the collection is starred / favorited
354
+ */
355
+ starred?: boolean;
356
+ /**
357
+ * List of location slugs where the collection is enabled. If empty, enabled for all.
358
+ */
359
+ enabled_locations?: string[];
360
+ /**
361
+ * List of purpose IDs where the collection is enabled. If empty, enabled for all.
362
+ */
363
+ enabled_purposes?: string[];
364
+ }
365
+ /**
366
+ * Request body for creating a file collection
367
+ */
368
+ export interface FileCollectionCreateRequest {
369
+ /**
370
+ * Name of the collection
371
+ */
372
+ name: string;
373
+ /**
374
+ * Array of parent collection slugs, empty array if top-level collection
375
+ */
376
+ parents?: string[];
377
+ /**
378
+ * Whether the collection is starred / favorited
379
+ */
380
+ starred?: boolean;
381
+ /**
382
+ * List of location slugs where the collection is enabled. If empty, enabled for all.
383
+ */
384
+ enabled_locations?: string[];
385
+ /**
386
+ * List of purpose IDs where the collection is enabled. If empty, enabled for all.
387
+ */
388
+ enabled_purposes?: string[];
389
+ }
390
+ /**
391
+ * Generated uuid for a file collection
392
+ */
393
+ export type FileCollectionId = string; // uuid
394
+ /**
395
+ * A file collection with identifiers and timestamps
396
+ */
397
+ export interface FileCollectionItem {
398
+ /**
399
+ * Full slug for the collection. Format depends on collection type:
400
+ * - User collection: `_system_files_collection_{entity_uuid}_{user_id}:{collection_name}`
401
+ * Example: `_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents`
402
+ * - Global collection: `_system_files_collection_schema_{schema_slug}:{collection_name}`
403
+ * Example: `_system_files_collection_schema_opportunity:templates`
404
+ *
405
+ * example:
406
+ * _system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234:documents
407
+ */
408
+ slug?: string;
409
+ /**
410
+ * Display name of the collection
411
+ * example:
412
+ * Documents
413
+ */
414
+ name: string;
415
+ id?: /* Generated uuid for a file collection */ FileCollectionId /* uuid */;
416
+ /**
417
+ * Array of parent collection slugs, empty array if top-level collection. Format depends on collection type:
418
+ * - User collection: `_system_files_collection_{entity_uuid}_{user_id}`
419
+ * Example: `["_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"]`
420
+ * - Global collection: `_system_files_collection_schema_{schema_slug}`
421
+ * Example: `["_system_files_collection_schema_opportunity"]`
422
+ *
423
+ * example:
424
+ * [
425
+ * "_system_files_collection_3fa85f64-5717-4562-b3fc-2c963f66afa6_10234"
426
+ * ]
427
+ */
428
+ parents?: string[];
429
+ /**
430
+ * Whether the collection is starred / favorited
431
+ * example:
432
+ * false
433
+ */
434
+ starred?: boolean;
435
+ /**
436
+ * Display order for the collection
437
+ * example:
438
+ * 0
439
+ */
440
+ order?: number;
441
+ /**
442
+ * List of location slugs where the collection is enabled. If empty, enabled for all.
443
+ */
444
+ enabled_locations?: string[];
445
+ /**
446
+ * List of purpose slugs where the collection is enabled. If empty, enabled for all.
447
+ * example:
448
+ * [
449
+ * "9eefcb98-93cf-4c5b-a040-f1d26d57c177",
450
+ * "5c544c09-a691-43ed-a7fa-0a8b44b5b161"
451
+ * ]
452
+ */
453
+ enabled_purposes?: string[];
454
+ /**
455
+ * Timestamp when the collection was created
456
+ * example:
457
+ * 2024-01-01T12:00:00Z
458
+ */
459
+ created_at?: string; // date-time
460
+ /**
461
+ * Timestamp when the collection was last updated
462
+ * example:
463
+ * 2024-01-02T12:00:00Z
464
+ */
465
+ updated_at?: string; // date-time
466
+ }
467
+ export interface FileEntity {
468
+ /**
469
+ * example:
470
+ * document.pdf
471
+ */
472
+ _title: string;
473
+ _schema: "file";
474
+ /**
475
+ * example:
476
+ * 123
477
+ */
478
+ _org: string;
479
+ _id: /**
480
+ * example:
481
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
482
+ */
483
+ FileEntityId;
484
+ /**
485
+ * example:
486
+ * [
487
+ * "tag1",
488
+ * "tag2"
489
+ * ]
490
+ */
491
+ _tags?: string[];
492
+ /**
493
+ * example:
494
+ * [
495
+ * "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
496
+ * "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
497
+ * ]
498
+ */
499
+ _purpose?: string[];
500
+ /**
501
+ * Manifest ID used to create/update the entity
502
+ */
503
+ _manifest?: string /* uuid */[];
504
+ /**
505
+ * example:
506
+ * document.pdf
507
+ */
508
+ filename: string;
509
+ type: FileType;
510
+ /**
511
+ * MIME type of the file
512
+ * example:
513
+ * application/pdf
514
+ */
515
+ mime_type?: string;
516
+ /**
517
+ * File size in bytes
518
+ * example:
519
+ * 1234
520
+ */
521
+ size_bytes?: number;
522
+ /**
523
+ * Human readable file size
524
+ * example:
525
+ * 1.2 MB
526
+ */
527
+ readable_size?: string;
528
+ access_control: "private" | "public-read";
529
+ /**
530
+ * Direct URL for file (public only if file access control is public-read)
531
+ * example:
532
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
533
+ */
534
+ public_url?: string; // url
535
+ custom_download_url?: /**
536
+ * Custom external download url used for the file
537
+ * example:
538
+ * https://some-api-url.com/download?file_id=123
539
+ */
540
+ CustomDownloadUrl /* uri */;
541
+ /**
542
+ * Source URL for the file. Included if the entity was created from source_url, or when ?source_url=true
543
+ * example:
544
+ * https://productengineer-content.s3.eu-west-1.amazonaws.com/product-engineer-checklist.pdf
545
+ */
546
+ source_url?: string;
547
+ s3ref?: S3Reference;
548
+ versions: FileItem[];
549
+ _updated_at?: string; // date-time
550
+ _created_at?: string; // date-time
551
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
552
+ _owners?: /**
553
+ * The user / organization owning this entity.
554
+ *
555
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
556
+ *
557
+ */
558
+ BaseEntityOwner[];
559
+ /**
560
+ * Additional fields that are not part of the schema
561
+ */
562
+ __additional?: {
563
+ [name: string]: any;
564
+ } | null;
565
+ }
566
+ /**
567
+ * example:
568
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
569
+ */
570
+ export type FileEntityId = /**
571
+ * example:
572
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
573
+ */
574
+ string | string /* uuid */;
575
+ export interface FileItem {
576
+ s3ref?: S3Ref;
577
+ /**
578
+ * example:
579
+ * document.pdf
580
+ */
581
+ filename?: string;
582
+ /**
583
+ * example:
584
+ * 1234
585
+ */
586
+ size_bytes?: number;
587
+ /**
588
+ * example:
589
+ * 1.2 MB
590
+ */
591
+ readable_size?: string;
592
+ /**
593
+ * example:
594
+ * image/jpeg
595
+ */
596
+ mime_type?: string;
597
+ }
598
+ export interface FileRelationItem {
599
+ entity_id: /**
600
+ * example:
601
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
602
+ */
603
+ EntityId;
604
+ _schema?: /**
605
+ * URL-friendly identifier for the entity schema
606
+ * example:
607
+ * contact
608
+ */
609
+ EntitySlug;
610
+ _tags?: string[];
611
+ }
612
+ export type FileType = "document" | "document_template" | "text" | "image" | "video" | "audio" | "spreadsheet" | "presentation" | "font" | "archive" | "application" | "unknown";
613
+ export interface FileUpload {
614
+ s3ref?: S3Reference;
615
+ /**
616
+ * example:
617
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
618
+ */
619
+ upload_url?: string; // url
620
+ /**
621
+ * Returned only if file is permanent i.e. file_entity_id is passed
622
+ * example:
623
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
624
+ */
625
+ public_url?: string; // url
626
+ }
627
+ export interface PublicLink {
628
+ /**
629
+ * ID of the public link
630
+ * example:
631
+ * 3ef5c6d9-818d-45e6-8efb-b1de59079a1c
632
+ */
633
+ id?: string;
634
+ /**
635
+ * Public link of the file
636
+ * example:
637
+ * https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c
638
+ */
639
+ link?: string;
640
+ /**
641
+ * The most recent timestamp when the file was accessed
642
+ */
643
+ last_accessed_at?: string;
644
+ }
645
+ export type S3Ref = S3Reference;
646
+ export interface S3Reference {
647
+ /**
648
+ * example:
649
+ * epilot-prod-user-content
650
+ */
651
+ bucket: string;
652
+ /**
653
+ * example:
654
+ * 123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
655
+ */
656
+ key: string;
657
+ }
658
+ export interface SaveCustomFilePayload {
659
+ [name: string]: any;
660
+ /**
661
+ * if passed, adds a new version to existing file entity
662
+ * example:
663
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
664
+ */
665
+ _id?: /**
666
+ * if passed, adds a new version to existing file entity
667
+ * example:
668
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
669
+ */
670
+ string | string /* uuid */;
671
+ /**
672
+ * Deprecated, use _id instead
673
+ */
674
+ file_entity_id?: string;
675
+ /**
676
+ * List of entities to relate the file to
677
+ */
678
+ relations?: FileRelationItem[];
679
+ /**
680
+ * example:
681
+ * [
682
+ * "tag1",
683
+ * "tag2"
684
+ * ]
685
+ */
686
+ _tags?: string[];
687
+ /**
688
+ * example:
689
+ * [
690
+ * "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
691
+ * "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
692
+ * ]
693
+ */
694
+ _purpose?: string[];
695
+ /**
696
+ * Manifest ID used to create/update the entity
697
+ */
698
+ _manifest?: string /* uuid */[];
699
+ /**
700
+ * example:
701
+ * document.pdf
702
+ */
703
+ filename?: string;
704
+ type?: FileType;
705
+ /**
706
+ * MIME type of the file
707
+ * example:
708
+ * application/pdf
709
+ */
710
+ mime_type?: string;
711
+ /**
712
+ * File size in bytes
713
+ * example:
714
+ * 1234
715
+ */
716
+ size_bytes?: number;
717
+ /**
718
+ * Human readable file size
719
+ * example:
720
+ * 1.2 MB
721
+ */
722
+ readable_size?: string;
723
+ access_control?: "private" | "public-read";
724
+ /**
725
+ * Direct URL for file (public only if file access control is public-read)
726
+ * example:
727
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
728
+ */
729
+ public_url?: string; // url
730
+ custom_download_url?: /**
731
+ * Custom external download url used for the file
732
+ * example:
733
+ * https://some-api-url.com/download?file_id=123
734
+ */
735
+ CustomDownloadUrl /* uri */;
736
+ }
737
+ export interface SaveFileFromSourceURLPayload {
738
+ [name: string]: any;
739
+ /**
740
+ * if passed, adds a new version to existing file entity
741
+ * example:
742
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
743
+ */
744
+ _id?: /**
745
+ * if passed, adds a new version to existing file entity
746
+ * example:
747
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
748
+ */
749
+ string | string /* uuid */;
750
+ /**
751
+ * Deprecated, use _id instead
752
+ */
753
+ file_entity_id?: string;
754
+ /**
755
+ * List of entities to relate the file to
756
+ */
757
+ relations?: FileRelationItem[];
758
+ /**
759
+ * example:
760
+ * [
761
+ * "tag1",
762
+ * "tag2"
763
+ * ]
764
+ */
765
+ _tags?: string[];
766
+ /**
767
+ * example:
768
+ * [
769
+ * "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
770
+ * "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
771
+ * ]
772
+ */
773
+ _purpose?: string[];
774
+ /**
775
+ * Manifest ID used to create/update the entity
776
+ */
777
+ _manifest?: string /* uuid */[];
778
+ /**
779
+ * example:
780
+ * document.pdf
781
+ */
782
+ filename?: string;
783
+ type?: FileType;
784
+ /**
785
+ * MIME type of the file
786
+ * example:
787
+ * application/pdf
788
+ */
789
+ mime_type?: string;
790
+ /**
791
+ * File size in bytes
792
+ * example:
793
+ * 1234
794
+ */
795
+ size_bytes?: number;
796
+ /**
797
+ * Human readable file size
798
+ * example:
799
+ * 1.2 MB
800
+ */
801
+ readable_size?: string;
802
+ access_control?: "private" | "public-read";
803
+ /**
804
+ * Direct URL for file (public only if file access control is public-read)
805
+ * example:
806
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
807
+ */
808
+ public_url?: string; // url
809
+ custom_download_url?: /**
810
+ * Custom external download url used for the file
811
+ * example:
812
+ * https://some-api-url.com/download?file_id=123
813
+ */
814
+ CustomDownloadUrl /* uri */;
815
+ source_url?: /**
816
+ * Custom external download url used for the file
817
+ * example:
818
+ * https://some-api-url.com/download?file_id=123
819
+ */
820
+ CustomDownloadUrl /* uri */;
821
+ }
822
+ export type SaveFilePayload = SaveS3FilePayload | SaveFileFromSourceURLPayload | SaveCustomFilePayload;
823
+ export type SaveFilePayloadV2 = SaveS3FilePayload | SaveFileFromSourceURLPayload | SaveCustomFilePayload;
824
+ export interface SaveS3FilePayload {
825
+ [name: string]: any;
826
+ /**
827
+ * if passed, adds a new version to existing file entity
828
+ * example:
829
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
830
+ */
831
+ _id?: /**
832
+ * if passed, adds a new version to existing file entity
833
+ * example:
834
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
835
+ */
836
+ string | string /* uuid */;
837
+ /**
838
+ * Deprecated, use _id instead
839
+ */
840
+ file_entity_id?: string;
841
+ /**
842
+ * List of entities to relate the file to
843
+ */
844
+ relations?: FileRelationItem[];
845
+ /**
846
+ * example:
847
+ * [
848
+ * "tag1",
849
+ * "tag2"
850
+ * ]
851
+ */
852
+ _tags?: string[];
853
+ /**
854
+ * example:
855
+ * [
856
+ * "8d396871-95a0-4c9d-bb4d-9eda9c35776c",
857
+ * "da7cdf9a-01be-40c9-a29c-9a8f9f0de6f8"
858
+ * ]
859
+ */
860
+ _purpose?: string[];
861
+ /**
862
+ * Manifest ID used to create/update the entity
863
+ */
864
+ _manifest?: string /* uuid */[];
865
+ /**
866
+ * example:
867
+ * document.pdf
868
+ */
869
+ filename?: string;
870
+ type?: FileType;
871
+ /**
872
+ * MIME type of the file
873
+ * example:
874
+ * application/pdf
875
+ */
876
+ mime_type?: string;
877
+ /**
878
+ * File size in bytes
879
+ * example:
880
+ * 1234
881
+ */
882
+ size_bytes?: number;
883
+ /**
884
+ * Human readable file size
885
+ * example:
886
+ * 1.2 MB
887
+ */
888
+ readable_size?: string;
889
+ access_control?: "private" | "public-read";
890
+ /**
891
+ * Direct URL for file (public only if file access control is public-read)
892
+ * example:
893
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
894
+ */
895
+ public_url?: string; // url
896
+ custom_download_url?: /**
897
+ * Custom external download url used for the file
898
+ * example:
899
+ * https://some-api-url.com/download?file_id=123
900
+ */
901
+ CustomDownloadUrl /* uri */;
902
+ s3ref?: S3Ref;
903
+ }
904
+ export interface UploadFilePayload {
905
+ /**
906
+ * example:
907
+ * document.pdf
908
+ */
909
+ filename: string;
910
+ /**
911
+ * MIME type of file
912
+ * example:
913
+ * application/pdf
914
+ */
915
+ mime_type?: string;
916
+ /**
917
+ * Used to index the file at the storage layer, which helps when browsing for this file
918
+ * example:
919
+ * 2f6a377c8e78
920
+ */
921
+ index_tag?: string;
922
+ /**
923
+ * Allows passing in custom metadata for the file, expects key-value pairs of string type
924
+ * example:
925
+ * {
926
+ * "color": "blue"
927
+ * }
928
+ */
929
+ metadata?: {
930
+ [name: string]: string;
931
+ };
932
+ }
933
+ export interface VerifyCustomDownloadUrlPayload {
934
+ /**
935
+ * Custom external download url with signature and expiration time
936
+ * example:
937
+ * https://some-api-url.com?file_id=123&expires_at=1699273500029&signature=abcdefg
938
+ */
939
+ custom_download_url: string;
940
+ }
941
+ }
942
+ }
943
+ declare namespace Paths {
944
+ namespace AccessPublicLink {
945
+ namespace Parameters {
946
+ export type Filename = string;
947
+ export type Hash = string;
948
+ export type Id = string;
949
+ }
950
+ export interface PathParameters {
951
+ id: Parameters.Id;
952
+ filename: Parameters.Filename;
953
+ }
954
+ export interface QueryParameters {
955
+ hash?: Parameters.Hash;
956
+ }
957
+ namespace Responses {
958
+ export interface $302 {
959
+ }
960
+ export type $404 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
961
+ export type $500 = /**
962
+ * A generic error returned by the API
963
+ * example:
964
+ * {
965
+ * "status": 500,
966
+ * "error": "Internal Server Error"
967
+ * }
968
+ */
969
+ Components.Responses.InternalServerError;
970
+ }
971
+ }
972
+ namespace CreateUserSchemaFileCollection {
973
+ namespace Parameters {
974
+ export type Slug = string;
975
+ }
976
+ export interface PathParameters {
977
+ slug: Parameters.Slug;
978
+ }
979
+ export type RequestBody = /* Request body for creating a file collection */ Components.Schemas.FileCollectionCreateRequest;
980
+ namespace Responses {
981
+ export type $201 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
982
+ export type $400 = /**
983
+ * A generic error returned by the API
984
+ * example:
985
+ * {
986
+ * "status": 400,
987
+ * "error": "Bad Request: filename is required"
988
+ * }
989
+ */
990
+ Components.Responses.BadRequestError;
991
+ export type $401 = /**
992
+ * A generic error returned by the API
993
+ * example:
994
+ * {
995
+ * "status": 401,
996
+ * "error": "Unauthorized: Invalid or expired token"
997
+ * }
998
+ */
999
+ Components.Responses.UnauthorizedError;
1000
+ export type $500 = /**
1001
+ * A generic error returned by the API
1002
+ * example:
1003
+ * {
1004
+ * "status": 500,
1005
+ * "error": "Internal Server Error"
1006
+ * }
1007
+ */
1008
+ Components.Responses.InternalServerError;
1009
+ }
1010
+ }
1011
+ namespace DeleteFile {
1012
+ namespace Parameters {
1013
+ export type ActivityId = /**
1014
+ * See https://github.com/ulid/spec
1015
+ * example:
1016
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
1017
+ */
1018
+ Components.Schemas.ActivityId /* ulid */;
1019
+ export type Id = /**
1020
+ * example:
1021
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1022
+ */
1023
+ Components.Schemas.FileEntityId;
1024
+ /**
1025
+ * Provide `true` to permanently delete the file from storage, otherwise it will be soft-deleted
1026
+ */
1027
+ export type Purge = boolean;
1028
+ export type Strict = boolean;
1029
+ }
1030
+ export interface PathParameters {
1031
+ id: Parameters.Id;
1032
+ }
1033
+ export interface QueryParameters {
1034
+ purge?: /* Provide `true` to permanently delete the file from storage, otherwise it will be soft-deleted */ Parameters.Purge;
1035
+ activity_id?: Parameters.ActivityId;
1036
+ strict?: Parameters.Strict;
1037
+ }
1038
+ namespace Responses {
1039
+ export type $200 = Components.Schemas.FileEntity;
1040
+ export type $401 = /**
1041
+ * A generic error returned by the API
1042
+ * example:
1043
+ * {
1044
+ * "status": 401,
1045
+ * "error": "Unauthorized: Invalid or expired token"
1046
+ * }
1047
+ */
1048
+ Components.Responses.UnauthorizedError;
1049
+ export type $403 = /**
1050
+ * A generic error returned by the API
1051
+ * example:
1052
+ * {
1053
+ * "status": 403,
1054
+ * "error": "Forbidden: You do not have permission to access this file"
1055
+ * }
1056
+ */
1057
+ Components.Responses.ForbiddenError;
1058
+ export type $404 = /**
1059
+ * A generic error returned by the API
1060
+ * example:
1061
+ * {
1062
+ * "status": 404,
1063
+ * "error": "Not Found: File entity not found"
1064
+ * }
1065
+ */
1066
+ Components.Responses.NotFoundError;
1067
+ export type $500 = /**
1068
+ * A generic error returned by the API
1069
+ * example:
1070
+ * {
1071
+ * "status": 500,
1072
+ * "error": "Internal Server Error"
1073
+ * }
1074
+ */
1075
+ Components.Responses.InternalServerError;
1076
+ }
1077
+ }
1078
+ namespace DeleteSession {
1079
+ namespace Responses {
1080
+ export interface $200 {
1081
+ }
1082
+ }
1083
+ }
1084
+ namespace DeleteUserSchemaFileCollection {
1085
+ namespace Parameters {
1086
+ export type CollectionSlug = string;
1087
+ export type Slug = string;
1088
+ }
1089
+ export interface PathParameters {
1090
+ slug: Parameters.Slug;
1091
+ collectionSlug: Parameters.CollectionSlug;
1092
+ }
1093
+ namespace Responses {
1094
+ export interface $200 {
1095
+ }
1096
+ export type $401 = /**
1097
+ * A generic error returned by the API
1098
+ * example:
1099
+ * {
1100
+ * "status": 401,
1101
+ * "error": "Unauthorized: Invalid or expired token"
1102
+ * }
1103
+ */
1104
+ Components.Responses.UnauthorizedError;
1105
+ export type $404 = /**
1106
+ * A generic error returned by the API
1107
+ * example:
1108
+ * {
1109
+ * "status": 404,
1110
+ * "error": "Not Found: File entity not found"
1111
+ * }
1112
+ */
1113
+ Components.Responses.NotFoundError;
1114
+ export type $500 = /**
1115
+ * A generic error returned by the API
1116
+ * example:
1117
+ * {
1118
+ * "status": 500,
1119
+ * "error": "Internal Server Error"
1120
+ * }
1121
+ */
1122
+ Components.Responses.InternalServerError;
1123
+ }
1124
+ }
1125
+ namespace DownloadFile {
1126
+ namespace Parameters {
1127
+ export type Attachment = boolean;
1128
+ export type Id = /**
1129
+ * example:
1130
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1131
+ */
1132
+ Components.Schemas.FileEntityId;
1133
+ export type Version = number;
1134
+ }
1135
+ export interface PathParameters {
1136
+ id: Parameters.Id;
1137
+ }
1138
+ export interface QueryParameters {
1139
+ version?: Parameters.Version;
1140
+ attachment?: Parameters.Attachment;
1141
+ }
1142
+ namespace Responses {
1143
+ export interface $200 {
1144
+ /**
1145
+ * Pre-signed S3 URL valid for downloading the file
1146
+ * example:
1147
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
1148
+ */
1149
+ download_url?: string; // uri
1150
+ }
1151
+ export type $401 = /**
1152
+ * A generic error returned by the API
1153
+ * example:
1154
+ * {
1155
+ * "status": 401,
1156
+ * "error": "Unauthorized: Invalid or expired token"
1157
+ * }
1158
+ */
1159
+ Components.Responses.UnauthorizedError;
1160
+ export type $403 = /**
1161
+ * A generic error returned by the API
1162
+ * example:
1163
+ * {
1164
+ * "status": 403,
1165
+ * "error": "Forbidden: You do not have permission to access this file"
1166
+ * }
1167
+ */
1168
+ Components.Responses.ForbiddenError;
1169
+ export type $404 = /**
1170
+ * A generic error returned by the API
1171
+ * example:
1172
+ * {
1173
+ * "status": 404,
1174
+ * "error": "Not Found: File entity not found"
1175
+ * }
1176
+ */
1177
+ Components.Responses.NotFoundError;
1178
+ export type $500 = /**
1179
+ * A generic error returned by the API
1180
+ * example:
1181
+ * {
1182
+ * "status": 500,
1183
+ * "error": "Internal Server Error"
1184
+ * }
1185
+ */
1186
+ Components.Responses.InternalServerError;
1187
+ }
1188
+ }
1189
+ namespace DownloadFiles {
1190
+ export type RequestBody = Components.Schemas.DownloadFilesPayload;
1191
+ namespace Responses {
1192
+ export type $200 = {
1193
+ /**
1194
+ * Pre-signed S3 URL for downloading the file
1195
+ * example:
1196
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
1197
+ */
1198
+ download_url?: string; // uri
1199
+ /**
1200
+ * The file entity ID (matches the requested ID)
1201
+ */
1202
+ file_entity_id?: string; // uuid
1203
+ }[];
1204
+ export type $400 = /**
1205
+ * A generic error returned by the API
1206
+ * example:
1207
+ * {
1208
+ * "status": 400,
1209
+ * "error": "Bad Request: filename is required"
1210
+ * }
1211
+ */
1212
+ Components.Responses.BadRequestError;
1213
+ export type $401 = /**
1214
+ * A generic error returned by the API
1215
+ * example:
1216
+ * {
1217
+ * "status": 401,
1218
+ * "error": "Unauthorized: Invalid or expired token"
1219
+ * }
1220
+ */
1221
+ Components.Responses.UnauthorizedError;
1222
+ export type $500 = /**
1223
+ * A generic error returned by the API
1224
+ * example:
1225
+ * {
1226
+ * "status": 500,
1227
+ * "error": "Internal Server Error"
1228
+ * }
1229
+ */
1230
+ Components.Responses.InternalServerError;
1231
+ }
1232
+ }
1233
+ namespace DownloadS3File {
1234
+ namespace Parameters {
1235
+ export type Attachment = boolean;
1236
+ export type S3Bucket = string;
1237
+ export type S3Key = string;
1238
+ }
1239
+ export interface QueryParameters {
1240
+ s3_key: Parameters.S3Key;
1241
+ s3_bucket: Parameters.S3Bucket;
1242
+ attachment?: Parameters.Attachment;
1243
+ }
1244
+ namespace Responses {
1245
+ export interface $200 {
1246
+ /**
1247
+ * Pre-signed S3 URL valid for downloading the file
1248
+ * example:
1249
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
1250
+ */
1251
+ download_url?: string; // uri
1252
+ }
1253
+ export type $400 = /**
1254
+ * A generic error returned by the API
1255
+ * example:
1256
+ * {
1257
+ * "status": 400,
1258
+ * "error": "Bad Request: filename is required"
1259
+ * }
1260
+ */
1261
+ Components.Responses.BadRequestError;
1262
+ export type $401 = /**
1263
+ * A generic error returned by the API
1264
+ * example:
1265
+ * {
1266
+ * "status": 401,
1267
+ * "error": "Unauthorized: Invalid or expired token"
1268
+ * }
1269
+ */
1270
+ Components.Responses.UnauthorizedError;
1271
+ export type $404 = /**
1272
+ * A generic error returned by the API
1273
+ * example:
1274
+ * {
1275
+ * "status": 404,
1276
+ * "error": "Not Found: File entity not found"
1277
+ * }
1278
+ */
1279
+ Components.Responses.NotFoundError;
1280
+ export type $500 = /**
1281
+ * A generic error returned by the API
1282
+ * example:
1283
+ * {
1284
+ * "status": 500,
1285
+ * "error": "Internal Server Error"
1286
+ * }
1287
+ */
1288
+ Components.Responses.InternalServerError;
1289
+ }
1290
+ }
1291
+ namespace GeneratePublicLink {
1292
+ namespace Parameters {
1293
+ export type Id = /**
1294
+ * example:
1295
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1296
+ */
1297
+ Components.Schemas.FileEntityId;
1298
+ }
1299
+ export interface PathParameters {
1300
+ id: Parameters.Id;
1301
+ }
1302
+ namespace Responses {
1303
+ /**
1304
+ * The public URL that can be shared externally
1305
+ */
1306
+ export type $201 = string;
1307
+ export type $401 = /**
1308
+ * A generic error returned by the API
1309
+ * example:
1310
+ * {
1311
+ * "status": 401,
1312
+ * "error": "Unauthorized: Invalid or expired token"
1313
+ * }
1314
+ */
1315
+ Components.Responses.UnauthorizedError;
1316
+ export type $403 = /**
1317
+ * A generic error returned by the API
1318
+ * example:
1319
+ * {
1320
+ * "status": 403,
1321
+ * "error": "Forbidden: You do not have permission to access this file"
1322
+ * }
1323
+ */
1324
+ Components.Responses.ForbiddenError;
1325
+ export type $404 = /**
1326
+ * A generic error returned by the API
1327
+ * example:
1328
+ * {
1329
+ * "status": 404,
1330
+ * "error": "Not Found: File entity not found"
1331
+ * }
1332
+ */
1333
+ Components.Responses.NotFoundError;
1334
+ export type $500 = /**
1335
+ * A generic error returned by the API
1336
+ * example:
1337
+ * {
1338
+ * "status": 500,
1339
+ * "error": "Internal Server Error"
1340
+ * }
1341
+ */
1342
+ Components.Responses.InternalServerError;
1343
+ }
1344
+ }
1345
+ namespace GetFile {
1346
+ namespace Parameters {
1347
+ export type Async = boolean;
1348
+ export type Id = /**
1349
+ * example:
1350
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1351
+ */
1352
+ Components.Schemas.FileEntityId;
1353
+ /**
1354
+ * Generate a source_url for the file entity, if it doesn't have one
1355
+ */
1356
+ export type SourceUrl = boolean;
1357
+ export type Strict = boolean;
1358
+ }
1359
+ export interface PathParameters {
1360
+ id: Parameters.Id;
1361
+ }
1362
+ export interface QueryParameters {
1363
+ source_url?: /* Generate a source_url for the file entity, if it doesn't have one */ Parameters.SourceUrl;
1364
+ strict?: Parameters.Strict;
1365
+ async?: Parameters.Async;
1366
+ }
1367
+ namespace Responses {
1368
+ export type $200 = Components.Schemas.FileEntity;
1369
+ export type $401 = /**
1370
+ * A generic error returned by the API
1371
+ * example:
1372
+ * {
1373
+ * "status": 401,
1374
+ * "error": "Unauthorized: Invalid or expired token"
1375
+ * }
1376
+ */
1377
+ Components.Responses.UnauthorizedError;
1378
+ export type $403 = /**
1379
+ * A generic error returned by the API
1380
+ * example:
1381
+ * {
1382
+ * "status": 403,
1383
+ * "error": "Forbidden: You do not have permission to access this file"
1384
+ * }
1385
+ */
1386
+ Components.Responses.ForbiddenError;
1387
+ export type $404 = /**
1388
+ * A generic error returned by the API
1389
+ * example:
1390
+ * {
1391
+ * "status": 404,
1392
+ * "error": "Not Found: File entity not found"
1393
+ * }
1394
+ */
1395
+ Components.Responses.NotFoundError;
1396
+ export type $500 = /**
1397
+ * A generic error returned by the API
1398
+ * example:
1399
+ * {
1400
+ * "status": 500,
1401
+ * "error": "Internal Server Error"
1402
+ * }
1403
+ */
1404
+ Components.Responses.InternalServerError;
1405
+ }
1406
+ }
1407
+ namespace GetFilesInCollection {
1408
+ namespace Parameters {
1409
+ export type CollectionSlug = string;
1410
+ export type Id = /**
1411
+ * example:
1412
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1413
+ */
1414
+ Components.Schemas.EntityId;
1415
+ }
1416
+ export interface PathParameters {
1417
+ id: Parameters.Id;
1418
+ collectionSlug: Parameters.CollectionSlug;
1419
+ }
1420
+ namespace Responses {
1421
+ export type $200 = Components.Schemas.FileEntity[];
1422
+ export type $401 = /**
1423
+ * A generic error returned by the API
1424
+ * example:
1425
+ * {
1426
+ * "status": 401,
1427
+ * "error": "Unauthorized: Invalid or expired token"
1428
+ * }
1429
+ */
1430
+ Components.Responses.UnauthorizedError;
1431
+ export type $403 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1432
+ export type $404 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1433
+ export type $500 = /**
1434
+ * A generic error returned by the API
1435
+ * example:
1436
+ * {
1437
+ * "status": 500,
1438
+ * "error": "Internal Server Error"
1439
+ * }
1440
+ */
1441
+ Components.Responses.InternalServerError;
1442
+ }
1443
+ }
1444
+ namespace GetGlobalFileCollections {
1445
+ namespace Parameters {
1446
+ export type SchemaSlug = string;
1447
+ }
1448
+ export interface PathParameters {
1449
+ schemaSlug: Parameters.SchemaSlug;
1450
+ }
1451
+ namespace Responses {
1452
+ export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
1453
+ export type $401 = /**
1454
+ * A generic error returned by the API
1455
+ * example:
1456
+ * {
1457
+ * "status": 401,
1458
+ * "error": "Unauthorized: Invalid or expired token"
1459
+ * }
1460
+ */
1461
+ Components.Responses.UnauthorizedError;
1462
+ export type $500 = /**
1463
+ * A generic error returned by the API
1464
+ * example:
1465
+ * {
1466
+ * "status": 500,
1467
+ * "error": "Internal Server Error"
1468
+ * }
1469
+ */
1470
+ Components.Responses.InternalServerError;
1471
+ }
1472
+ }
1473
+ namespace GetSession {
1474
+ namespace Responses {
1475
+ export interface $200 {
1476
+ }
1477
+ export type $401 = /**
1478
+ * A generic error returned by the API
1479
+ * example:
1480
+ * {
1481
+ * "status": 401,
1482
+ * "error": "Unauthorized: Invalid or expired token"
1483
+ * }
1484
+ */
1485
+ Components.Responses.UnauthorizedError;
1486
+ }
1487
+ }
1488
+ namespace GetUserSchemaFileCollections {
1489
+ namespace Parameters {
1490
+ export type Slug = string;
1491
+ }
1492
+ export interface PathParameters {
1493
+ slug: Parameters.Slug;
1494
+ }
1495
+ namespace Responses {
1496
+ export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
1497
+ export type $401 = /**
1498
+ * A generic error returned by the API
1499
+ * example:
1500
+ * {
1501
+ * "status": 401,
1502
+ * "error": "Unauthorized: Invalid or expired token"
1503
+ * }
1504
+ */
1505
+ Components.Responses.UnauthorizedError;
1506
+ export type $500 = /**
1507
+ * A generic error returned by the API
1508
+ * example:
1509
+ * {
1510
+ * "status": 500,
1511
+ * "error": "Internal Server Error"
1512
+ * }
1513
+ */
1514
+ Components.Responses.InternalServerError;
1515
+ }
1516
+ }
1517
+ namespace ListPublicLinksForFile {
1518
+ namespace Parameters {
1519
+ export type Id = string;
1520
+ }
1521
+ export interface PathParameters {
1522
+ id: Parameters.Id;
1523
+ }
1524
+ namespace Responses {
1525
+ export interface $200 {
1526
+ results?: Components.Schemas.PublicLink[];
1527
+ }
1528
+ export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1529
+ }
1530
+ }
1531
+ namespace PreviewFile {
1532
+ namespace Parameters {
1533
+ export type H = number;
1534
+ export type Id = /**
1535
+ * example:
1536
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1537
+ */
1538
+ Components.Schemas.FileEntityId;
1539
+ export type Version = number;
1540
+ export type W = number;
1541
+ }
1542
+ export interface PathParameters {
1543
+ id: Parameters.Id;
1544
+ }
1545
+ export interface QueryParameters {
1546
+ version?: Parameters.Version;
1547
+ w?: Parameters.W;
1548
+ h?: Parameters.H;
1549
+ }
1550
+ namespace Responses {
1551
+ export type $200 = string; // binary
1552
+ export type $401 = /**
1553
+ * A generic error returned by the API
1554
+ * example:
1555
+ * {
1556
+ * "status": 401,
1557
+ * "error": "Unauthorized: Invalid or expired token"
1558
+ * }
1559
+ */
1560
+ Components.Responses.UnauthorizedError;
1561
+ export type $404 = /**
1562
+ * A generic error returned by the API
1563
+ * example:
1564
+ * {
1565
+ * "status": 404,
1566
+ * "error": "Not Found: File entity not found"
1567
+ * }
1568
+ */
1569
+ Components.Responses.NotFoundError;
1570
+ export type $500 = /**
1571
+ * A generic error returned by the API
1572
+ * example:
1573
+ * {
1574
+ * "status": 500,
1575
+ * "error": "Internal Server Error"
1576
+ * }
1577
+ */
1578
+ Components.Responses.InternalServerError;
1579
+ }
1580
+ }
1581
+ namespace PreviewPublicFile {
1582
+ namespace Parameters {
1583
+ export type H = number;
1584
+ export type Id = /**
1585
+ * example:
1586
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1587
+ */
1588
+ Components.Schemas.FileEntityId;
1589
+ export type OrgId = string;
1590
+ export type Version = number;
1591
+ export type W = number;
1592
+ }
1593
+ export interface PathParameters {
1594
+ id: Parameters.Id;
1595
+ }
1596
+ export interface QueryParameters {
1597
+ version?: Parameters.Version;
1598
+ w?: Parameters.W;
1599
+ h?: Parameters.H;
1600
+ org_id?: Parameters.OrgId;
1601
+ }
1602
+ namespace Responses {
1603
+ export type $200 = string; // binary
1604
+ export type $403 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1605
+ export type $404 = /**
1606
+ * A generic error returned by the API
1607
+ * example:
1608
+ * {
1609
+ * "status": 404,
1610
+ * "error": "Not Found: File entity not found"
1611
+ * }
1612
+ */
1613
+ Components.Responses.NotFoundError;
1614
+ export type $500 = /**
1615
+ * A generic error returned by the API
1616
+ * example:
1617
+ * {
1618
+ * "status": 500,
1619
+ * "error": "Internal Server Error"
1620
+ * }
1621
+ */
1622
+ Components.Responses.InternalServerError;
1623
+ }
1624
+ }
1625
+ namespace PreviewS3File {
1626
+ namespace Parameters {
1627
+ export type H = number;
1628
+ export type W = number;
1629
+ }
1630
+ export interface QueryParameters {
1631
+ w?: Parameters.W;
1632
+ h?: Parameters.H;
1633
+ }
1634
+ export type RequestBody = Components.Schemas.S3Ref;
1635
+ namespace Responses {
1636
+ export type $200 = string; // binary
1637
+ export type $400 = /**
1638
+ * A generic error returned by the API
1639
+ * example:
1640
+ * {
1641
+ * "status": 400,
1642
+ * "error": "Bad Request: filename is required"
1643
+ * }
1644
+ */
1645
+ Components.Responses.BadRequestError;
1646
+ export type $401 = /**
1647
+ * A generic error returned by the API
1648
+ * example:
1649
+ * {
1650
+ * "status": 401,
1651
+ * "error": "Unauthorized: Invalid or expired token"
1652
+ * }
1653
+ */
1654
+ Components.Responses.UnauthorizedError;
1655
+ export type $404 = /**
1656
+ * A generic error returned by the API
1657
+ * example:
1658
+ * {
1659
+ * "status": 404,
1660
+ * "error": "Not Found: File entity not found"
1661
+ * }
1662
+ */
1663
+ Components.Responses.NotFoundError;
1664
+ export type $500 = /**
1665
+ * A generic error returned by the API
1666
+ * example:
1667
+ * {
1668
+ * "status": 500,
1669
+ * "error": "Internal Server Error"
1670
+ * }
1671
+ */
1672
+ Components.Responses.InternalServerError;
1673
+ }
1674
+ }
1675
+ namespace PreviewS3FileGet {
1676
+ namespace Parameters {
1677
+ export type Bucket = string;
1678
+ export type H = number;
1679
+ export type Key = string;
1680
+ export type W = number;
1681
+ }
1682
+ export interface QueryParameters {
1683
+ key: Parameters.Key;
1684
+ bucket: Parameters.Bucket;
1685
+ w?: Parameters.W;
1686
+ h?: Parameters.H;
1687
+ }
1688
+ namespace Responses {
1689
+ export type $200 = string; // binary
1690
+ export type $400 = /**
1691
+ * A generic error returned by the API
1692
+ * example:
1693
+ * {
1694
+ * "status": 400,
1695
+ * "error": "Bad Request: filename is required"
1696
+ * }
1697
+ */
1698
+ Components.Responses.BadRequestError;
1699
+ export type $401 = /**
1700
+ * A generic error returned by the API
1701
+ * example:
1702
+ * {
1703
+ * "status": 401,
1704
+ * "error": "Unauthorized: Invalid or expired token"
1705
+ * }
1706
+ */
1707
+ Components.Responses.UnauthorizedError;
1708
+ export type $404 = /**
1709
+ * A generic error returned by the API
1710
+ * example:
1711
+ * {
1712
+ * "status": 404,
1713
+ * "error": "Not Found: File entity not found"
1714
+ * }
1715
+ */
1716
+ Components.Responses.NotFoundError;
1717
+ export type $500 = /**
1718
+ * A generic error returned by the API
1719
+ * example:
1720
+ * {
1721
+ * "status": 500,
1722
+ * "error": "Internal Server Error"
1723
+ * }
1724
+ */
1725
+ Components.Responses.InternalServerError;
1726
+ }
1727
+ }
1728
+ namespace RevokePublicLink {
1729
+ namespace Parameters {
1730
+ export type Id = string;
1731
+ }
1732
+ export interface PathParameters {
1733
+ id: Parameters.Id;
1734
+ }
1735
+ namespace Responses {
1736
+ export interface $204 {
1737
+ }
1738
+ export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
1739
+ }
1740
+ }
1741
+ namespace SaveFile {
1742
+ namespace Parameters {
1743
+ export type ActivityId = /**
1744
+ * See https://github.com/ulid/spec
1745
+ * example:
1746
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
1747
+ */
1748
+ Components.Schemas.ActivityId /* ulid */;
1749
+ export type Async = boolean;
1750
+ export type VersionOnly = boolean;
1751
+ }
1752
+ export interface QueryParameters {
1753
+ activity_id?: Parameters.ActivityId;
1754
+ async?: Parameters.Async;
1755
+ version_only?: Parameters.VersionOnly;
1756
+ }
1757
+ export type RequestBody = Components.Schemas.SaveFilePayload;
1758
+ namespace Responses {
1759
+ export type $201 = Components.Schemas.FileEntity;
1760
+ export type $400 = /**
1761
+ * A generic error returned by the API
1762
+ * example:
1763
+ * {
1764
+ * "status": 400,
1765
+ * "error": "Bad Request: filename is required"
1766
+ * }
1767
+ */
1768
+ Components.Responses.BadRequestError;
1769
+ export type $401 = /**
1770
+ * A generic error returned by the API
1771
+ * example:
1772
+ * {
1773
+ * "status": 401,
1774
+ * "error": "Unauthorized: Invalid or expired token"
1775
+ * }
1776
+ */
1777
+ Components.Responses.UnauthorizedError;
1778
+ export type $500 = /**
1779
+ * A generic error returned by the API
1780
+ * example:
1781
+ * {
1782
+ * "status": 500,
1783
+ * "error": "Internal Server Error"
1784
+ * }
1785
+ */
1786
+ Components.Responses.InternalServerError;
1787
+ }
1788
+ }
1789
+ namespace SaveFileV2 {
1790
+ namespace Parameters {
1791
+ export type ActivityId = /**
1792
+ * See https://github.com/ulid/spec
1793
+ * example:
1794
+ * 01F130Q52Q6MWSNS8N2AVXV4JN
1795
+ */
1796
+ Components.Schemas.ActivityId /* ulid */;
1797
+ export type Async = boolean;
1798
+ export type DeleteTempFile = boolean;
1799
+ export type FillActivity = boolean;
1800
+ export type Strict = boolean;
1801
+ export type VersionOnly = boolean;
1802
+ }
1803
+ export interface QueryParameters {
1804
+ activity_id?: Parameters.ActivityId;
1805
+ fill_activity?: Parameters.FillActivity;
1806
+ strict?: Parameters.Strict;
1807
+ async?: Parameters.Async;
1808
+ delete_temp_file?: Parameters.DeleteTempFile;
1809
+ version_only?: Parameters.VersionOnly;
1810
+ }
1811
+ export type RequestBody = Components.Schemas.SaveFilePayloadV2 | [
1812
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload,
1813
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1814
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1815
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1816
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1817
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1818
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1819
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1820
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1821
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1822
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1823
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1824
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1825
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1826
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1827
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1828
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1829
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1830
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
1831
+ /* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?
1832
+ ];
1833
+ namespace Responses {
1834
+ export type $200 = Components.Schemas.FileEntity;
1835
+ export type $400 = /**
1836
+ * A generic error returned by the API
1837
+ * example:
1838
+ * {
1839
+ * "status": 400,
1840
+ * "error": "Bad Request: filename is required"
1841
+ * }
1842
+ */
1843
+ Components.Responses.BadRequestError;
1844
+ export type $401 = /**
1845
+ * A generic error returned by the API
1846
+ * example:
1847
+ * {
1848
+ * "status": 401,
1849
+ * "error": "Unauthorized: Invalid or expired token"
1850
+ * }
1851
+ */
1852
+ Components.Responses.UnauthorizedError;
1853
+ export type $404 = /**
1854
+ * A generic error returned by the API
1855
+ * example:
1856
+ * {
1857
+ * "status": 404,
1858
+ * "error": "Not Found: File entity not found"
1859
+ * }
1860
+ */
1861
+ Components.Responses.NotFoundError;
1862
+ export type $500 = /**
1863
+ * A generic error returned by the API
1864
+ * example:
1865
+ * {
1866
+ * "status": 500,
1867
+ * "error": "Internal Server Error"
1868
+ * }
1869
+ */
1870
+ Components.Responses.InternalServerError;
1871
+ }
1872
+ }
1873
+ namespace UpdateUserSchemaFileCollection {
1874
+ namespace Parameters {
1875
+ export type CollectionSlug = string;
1876
+ export type Slug = string;
1877
+ }
1878
+ export interface PathParameters {
1879
+ slug: Parameters.Slug;
1880
+ collectionSlug: Parameters.CollectionSlug;
1881
+ }
1882
+ export type RequestBody = Components.Schemas.FileCollectionAttributes;
1883
+ namespace Responses {
1884
+ export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
1885
+ export type $400 = /**
1886
+ * A generic error returned by the API
1887
+ * example:
1888
+ * {
1889
+ * "status": 400,
1890
+ * "error": "Bad Request: filename is required"
1891
+ * }
1892
+ */
1893
+ Components.Responses.BadRequestError;
1894
+ export type $401 = /**
1895
+ * A generic error returned by the API
1896
+ * example:
1897
+ * {
1898
+ * "status": 401,
1899
+ * "error": "Unauthorized: Invalid or expired token"
1900
+ * }
1901
+ */
1902
+ Components.Responses.UnauthorizedError;
1903
+ export type $404 = /**
1904
+ * A generic error returned by the API
1905
+ * example:
1906
+ * {
1907
+ * "status": 404,
1908
+ * "error": "Not Found: File entity not found"
1909
+ * }
1910
+ */
1911
+ Components.Responses.NotFoundError;
1912
+ export type $500 = /**
1913
+ * A generic error returned by the API
1914
+ * example:
1915
+ * {
1916
+ * "status": 500,
1917
+ * "error": "Internal Server Error"
1918
+ * }
1919
+ */
1920
+ Components.Responses.InternalServerError;
1921
+ }
1922
+ }
1923
+ namespace UploadFile {
1924
+ namespace Parameters {
1925
+ export type FileEntityId = /**
1926
+ * example:
1927
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
1928
+ */
1929
+ Components.Schemas.FileEntityId;
1930
+ }
1931
+ export interface QueryParameters {
1932
+ file_entity_id?: Parameters.FileEntityId;
1933
+ }
1934
+ export type RequestBody = Components.Schemas.UploadFilePayload;
1935
+ namespace Responses {
1936
+ export interface $201 {
1937
+ s3ref?: Components.Schemas.S3Reference;
1938
+ /**
1939
+ * example:
1940
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
1941
+ */
1942
+ upload_url?: string; // url
1943
+ /**
1944
+ * Returned only if file is permanent i.e. file_entity_id is passed
1945
+ * example:
1946
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf
1947
+ */
1948
+ public_url?: string; // url
1949
+ }
1950
+ export type $400 = /**
1951
+ * A generic error returned by the API
1952
+ * example:
1953
+ * {
1954
+ * "status": 400,
1955
+ * "error": "Bad Request: filename is required"
1956
+ * }
1957
+ */
1958
+ Components.Responses.BadRequestError;
1959
+ export type $401 = /**
1960
+ * A generic error returned by the API
1961
+ * example:
1962
+ * {
1963
+ * "status": 401,
1964
+ * "error": "Unauthorized: Invalid or expired token"
1965
+ * }
1966
+ */
1967
+ Components.Responses.UnauthorizedError;
1968
+ export type $500 = /**
1969
+ * A generic error returned by the API
1970
+ * example:
1971
+ * {
1972
+ * "status": 500,
1973
+ * "error": "Internal Server Error"
1974
+ * }
1975
+ */
1976
+ Components.Responses.InternalServerError;
1977
+ }
1978
+ }
1979
+ namespace UploadFilePublic {
1980
+ export type RequestBody = Components.Schemas.UploadFilePayload;
1981
+ namespace Responses {
1982
+ export interface $201 {
1983
+ s3ref?: Components.Schemas.S3Reference;
1984
+ /**
1985
+ * Pre-signed URL for uploading the file via PUT request
1986
+ * example:
1987
+ * https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
1988
+ */
1989
+ upload_url?: string; // url
1990
+ /**
1991
+ * Error message if the upload preparation failed
1992
+ * example:
1993
+ * File entity not found
1994
+ */
1995
+ error?: string;
1996
+ }
1997
+ export type $400 = /**
1998
+ * A generic error returned by the API
1999
+ * example:
2000
+ * {
2001
+ * "status": 400,
2002
+ * "error": "Bad Request: filename is required"
2003
+ * }
2004
+ */
2005
+ Components.Responses.BadRequestError;
2006
+ export type $500 = /**
2007
+ * A generic error returned by the API
2008
+ * example:
2009
+ * {
2010
+ * "status": 500,
2011
+ * "error": "Internal Server Error"
2012
+ * }
2013
+ */
2014
+ Components.Responses.InternalServerError;
2015
+ }
2016
+ }
2017
+ namespace UploadFileV2 {
2018
+ namespace Parameters {
2019
+ export type FileEntityId = /**
2020
+ * example:
2021
+ * ef7d985c-2385-44f4-9c71-ae06a52264f8
2022
+ */
2023
+ Components.Schemas.FileEntityId;
2024
+ }
2025
+ export interface QueryParameters {
2026
+ file_entity_id?: Parameters.FileEntityId;
2027
+ }
2028
+ export type RequestBody = Components.Schemas.UploadFilePayload;
2029
+ namespace Responses {
2030
+ export type $201 = Components.Schemas.FileUpload;
2031
+ export type $400 = /**
2032
+ * A generic error returned by the API
2033
+ * example:
2034
+ * {
2035
+ * "status": 400,
2036
+ * "error": "Bad Request: filename is required"
2037
+ * }
2038
+ */
2039
+ Components.Responses.BadRequestError;
2040
+ export type $401 = /**
2041
+ * A generic error returned by the API
2042
+ * example:
2043
+ * {
2044
+ * "status": 401,
2045
+ * "error": "Unauthorized: Invalid or expired token"
2046
+ * }
2047
+ */
2048
+ Components.Responses.UnauthorizedError;
2049
+ export type $500 = /**
2050
+ * A generic error returned by the API
2051
+ * example:
2052
+ * {
2053
+ * "status": 500,
2054
+ * "error": "Internal Server Error"
2055
+ * }
2056
+ */
2057
+ Components.Responses.InternalServerError;
2058
+ }
2059
+ }
2060
+ namespace VerifyCustomDownloadUrl {
2061
+ export type RequestBody = Components.Schemas.VerifyCustomDownloadUrlPayload;
2062
+ namespace Responses {
2063
+ export interface $200 {
2064
+ /**
2065
+ * Whether the URL is valid and not expired
2066
+ */
2067
+ valid?: boolean;
2068
+ }
2069
+ export type $400 = /**
2070
+ * A generic error returned by the API
2071
+ * example:
2072
+ * {
2073
+ * "status": 400,
2074
+ * "error": "Bad Request: filename is required"
2075
+ * }
2076
+ */
2077
+ Components.Responses.BadRequestError;
2078
+ export type $401 = /**
2079
+ * A generic error returned by the API
2080
+ * example:
2081
+ * {
2082
+ * "status": 401,
2083
+ * "error": "Unauthorized: Invalid or expired token"
2084
+ * }
2085
+ */
2086
+ Components.Responses.UnauthorizedError;
2087
+ export type $500 = /**
2088
+ * A generic error returned by the API
2089
+ * example:
2090
+ * {
2091
+ * "status": 500,
2092
+ * "error": "Internal Server Error"
2093
+ * }
2094
+ */
2095
+ Components.Responses.InternalServerError;
2096
+ }
2097
+ }
2098
+ }
2099
+
2100
+
2101
+ interface OperationMethods {
2102
+ /**
2103
+ * uploadFileV2 - uploadFileV2
2104
+ *
2105
+ * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
2106
+ *
2107
+ * Use the saveFileV2 operation to store file file permanently.
2108
+ *
2109
+ */
2110
+ 'uploadFileV2'(
2111
+ parameters?: Parameters<Paths.UploadFileV2.QueryParameters> | null,
2112
+ data?: Paths.UploadFileV2.RequestBody,
2113
+ config?: AxiosRequestConfig
2114
+ ): OperationResponse<Paths.UploadFileV2.Responses.$201>
2115
+ /**
2116
+ * saveFileV2 - saveFileV2
2117
+ *
2118
+ * Saves a permanent file entity. Updates an existing file entity when `_id` is passed.
2119
+ *
2120
+ * Saves metadata to file entity and stores a version when `s3ref` or `source_url` is passed.
2121
+ *
2122
+ */
2123
+ 'saveFileV2'(
2124
+ parameters?: Parameters<Paths.SaveFileV2.QueryParameters> | null,
2125
+ data?: Paths.SaveFileV2.RequestBody,
2126
+ config?: AxiosRequestConfig
2127
+ ): OperationResponse<Paths.SaveFileV2.Responses.$200>
2128
+ /**
2129
+ * uploadFile - uploadFile
2130
+ *
2131
+ * **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files/upload` instead.
2132
+ *
2133
+ * ## Migration Guide
2134
+ * Replace calls to this endpoint with `uploadFileV2`:
2135
+ *
2136
+ * | v1 Parameter | v2 Parameter | Notes |
2137
+ * |--------------|--------------|-------|
2138
+ * | `file_entity_id` | `file_entity_id` | No change |
2139
+ *
2140
+ * The v2 response includes the same fields with improved structure.
2141
+ *
2142
+ * ---
2143
+ *
2144
+ * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
2145
+ *
2146
+ * Use the saveFile operation to store file file permanently.
2147
+ *
2148
+ */
2149
+ 'uploadFile'(
2150
+ parameters?: Parameters<Paths.UploadFile.QueryParameters> | null,
2151
+ data?: Paths.UploadFile.RequestBody,
2152
+ config?: AxiosRequestConfig
2153
+ ): OperationResponse<Paths.UploadFile.Responses.$201>
2154
+ /**
2155
+ * saveFile - saveFile
2156
+ *
2157
+ * **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files` instead.
2158
+ *
2159
+ * ## Migration Guide
2160
+ * Replace calls to this endpoint with `saveFileV2`:
2161
+ *
2162
+ * | v1 Feature | v2 Feature | Notes |
2163
+ * |------------|------------|-------|
2164
+ * | `activity_id` param | `activity_id` param | No change |
2165
+ * | `async` param | `async` param | No change |
2166
+ * | - | `fill_activity` param | New in v2 |
2167
+ * | - | `strict` param | New in v2 |
2168
+ * | - | `delete_temp_file` param | New in v2, defaults to true |
2169
+ *
2170
+ * The v2 endpoint supports additional parameters for better control over file saving behavior.
2171
+ *
2172
+ * ---
2173
+ *
2174
+ * Create / Update a permanent File entity.
2175
+ *
2176
+ * Makes file object permanent and saves metadata to file entity.
2177
+ *
2178
+ */
2179
+ 'saveFile'(
2180
+ parameters?: Parameters<Paths.SaveFile.QueryParameters> | null,
2181
+ data?: Paths.SaveFile.RequestBody,
2182
+ config?: AxiosRequestConfig
2183
+ ): OperationResponse<Paths.SaveFile.Responses.$201>
2184
+ /**
2185
+ * getFile - getFile
2186
+ *
2187
+ * Get a file entity by id
2188
+ */
2189
+ 'getFile'(
2190
+ parameters?: Parameters<Paths.GetFile.QueryParameters & Paths.GetFile.PathParameters> | null,
2191
+ data?: any,
2192
+ config?: AxiosRequestConfig
2193
+ ): OperationResponse<Paths.GetFile.Responses.$200>
2194
+ /**
2195
+ * deleteFile - deleteFile
2196
+ *
2197
+ * Delete a file entity by id
2198
+ */
2199
+ 'deleteFile'(
2200
+ parameters?: Parameters<Paths.DeleteFile.QueryParameters & Paths.DeleteFile.PathParameters> | null,
2201
+ data?: any,
2202
+ config?: AxiosRequestConfig
2203
+ ): OperationResponse<Paths.DeleteFile.Responses.$200>
2204
+ /**
2205
+ * downloadFile - downloadFile
2206
+ *
2207
+ * Generate a pre-signed download URL for a file.
2208
+ *
2209
+ * The returned URL is valid for a limited time (typically 15 minutes) and can be used to download the file directly.
2210
+ *
2211
+ */
2212
+ 'downloadFile'(
2213
+ parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
2214
+ data?: any,
2215
+ config?: AxiosRequestConfig
2216
+ ): OperationResponse<Paths.DownloadFile.Responses.$200>
2217
+ /**
2218
+ * downloadS3File - downloadS3File
2219
+ *
2220
+ * Generate a pre-signed download URL for a file using its S3 reference.
2221
+ *
2222
+ * Use this endpoint when you have the S3 bucket and key but not the file entity ID.
2223
+ *
2224
+ */
2225
+ 'downloadS3File'(
2226
+ parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
2227
+ data?: any,
2228
+ config?: AxiosRequestConfig
2229
+ ): OperationResponse<Paths.DownloadS3File.Responses.$200>
2230
+ /**
2231
+ * downloadFiles - downloadFiles
2232
+ *
2233
+ * Bulk generate pre-signed download URLs for multiple files in a single request.
2234
+ *
2235
+ * This is more efficient than calling `downloadFile` multiple times when you need to download several files.
2236
+ *
2237
+ */
2238
+ 'downloadFiles'(
2239
+ parameters?: Parameters<UnknownParamsObject> | null,
2240
+ data?: Paths.DownloadFiles.RequestBody,
2241
+ config?: AxiosRequestConfig
2242
+ ): OperationResponse<Paths.DownloadFiles.Responses.$200>
2243
+ /**
2244
+ * previewFile - previewFile
2245
+ *
2246
+ * Generate a thumbnail preview for a file entity.
2247
+ *
2248
+ * Supported file types include images (PNG, JPEG, GIF, WebP), PDFs, and common document formats.
2249
+ * The preview is returned as an image (PNG or JPEG).
2250
+ *
2251
+ * **Tip:** Use with CookieAuth to embed previews directly in `<img>` tags.
2252
+ *
2253
+ */
2254
+ 'previewFile'(
2255
+ parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
2256
+ data?: any,
2257
+ config?: AxiosRequestConfig
2258
+ ): OperationResponse<Paths.PreviewFile.Responses.$200>
2259
+ /**
2260
+ * previewS3FileGet - previewS3FileGet
2261
+ *
2262
+ * Get a thumbnail preview from an S3 reference using query parameters.
2263
+ *
2264
+ * This GET variant is useful for embedding previews directly in `<img>` tags.
2265
+ *
2266
+ */
2267
+ 'previewS3FileGet'(
2268
+ parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
2269
+ data?: any,
2270
+ config?: AxiosRequestConfig
2271
+ ): OperationResponse<Paths.PreviewS3FileGet.Responses.$200>
2272
+ /**
2273
+ * previewS3File - previewS3File
2274
+ *
2275
+ * Generate a thumbnail preview from an S3 reference.
2276
+ *
2277
+ * Use this endpoint when you have the S3 bucket and key but not the file entity ID.
2278
+ *
2279
+ */
2280
+ 'previewS3File'(
2281
+ parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
2282
+ data?: Paths.PreviewS3File.RequestBody,
2283
+ config?: AxiosRequestConfig
2284
+ ): OperationResponse<Paths.PreviewS3File.Responses.$200>
2285
+ /**
2286
+ * previewPublicFile - previewPublicFile
2287
+ *
2288
+ * Generate a thumbnail preview for a public file entity.
2289
+ *
2290
+ * **No authentication required.** This endpoint only works for files with `access_control: public-read`.
2291
+ *
2292
+ */
2293
+ 'previewPublicFile'(
2294
+ parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
2295
+ data?: any,
2296
+ config?: AxiosRequestConfig
2297
+ ): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
2298
+ /**
2299
+ * getSession - getSession
2300
+ *
2301
+ * Start a browser session by converting a Bearer token into a server-side cookie.
2302
+ *
2303
+ * **Use case:** After calling this endpoint, you can use preview URLs directly in `<img>` tags
2304
+ * without needing to set the Authorization header manually.
2305
+ *
2306
+ * **Example flow:**
2307
+ * 1. Call this endpoint with your Bearer token: `GET /v1/files/session` with `Authorization: Bearer <token>`
2308
+ * 2. The server sets an HTTP-only cookie named `token`
2309
+ * 3. Use preview URLs directly: `<img src="https://file.sls.epilot.io/v1/files/{id}/preview" />`
2310
+ *
2311
+ */
2312
+ 'getSession'(
2313
+ parameters?: Parameters<UnknownParamsObject> | null,
2314
+ data?: any,
2315
+ config?: AxiosRequestConfig
2316
+ ): OperationResponse<Paths.GetSession.Responses.$200>
2317
+ /**
2318
+ * deleteSession - deleteSession
2319
+ *
2320
+ * End a browser session by deleting the token cookie.
2321
+ *
2322
+ * Call this endpoint to log out and clear the session cookie.
2323
+ *
2324
+ */
2325
+ 'deleteSession'(
2326
+ parameters?: Parameters<UnknownParamsObject> | null,
2327
+ data?: any,
2328
+ config?: AxiosRequestConfig
2329
+ ): OperationResponse<Paths.DeleteSession.Responses.$200>
2330
+ /**
2331
+ * listPublicLinksForFile - listPublicLinksForFile
2332
+ *
2333
+ * **Not yet implemented.**
2334
+ *
2335
+ * This endpoint will fetch all public links previously generated for a file.
2336
+ *
2337
+ */
2338
+ 'listPublicLinksForFile'(
2339
+ parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
2340
+ data?: any,
2341
+ config?: AxiosRequestConfig
2342
+ ): OperationResponse<Paths.ListPublicLinksForFile.Responses.$200>
2343
+ /**
2344
+ * generatePublicLink - generatePublicLink
2345
+ *
2346
+ * Generate a public link to share a private file externally.
2347
+ *
2348
+ * The generated link:
2349
+ * - Is permanent until explicitly revoked
2350
+ * - Includes the filename for user-friendly URLs
2351
+ * - Does not require authentication to access
2352
+ * - Redirects to a signed download URL when accessed
2353
+ *
2354
+ * **Use case:** Share invoices, contracts, or documents with external parties who don't have epilot accounts.
2355
+ *
2356
+ */
2357
+ 'generatePublicLink'(
2358
+ parameters?: Parameters<Paths.GeneratePublicLink.PathParameters> | null,
2359
+ data?: any,
2360
+ config?: AxiosRequestConfig
2361
+ ): OperationResponse<Paths.GeneratePublicLink.Responses.$201>
2362
+ /**
2363
+ * accessPublicLink - accessPublicLink
2364
+ *
2365
+ * Access a file via its public link.
2366
+ *
2367
+ * **No authentication required.** This endpoint redirects to a signed S3 URL for downloading the file.
2368
+ *
2369
+ * The filename in the URL is for user-friendliness and SEO; the actual file is identified by the link ID.
2370
+ *
2371
+ */
2372
+ 'accessPublicLink'(
2373
+ parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
2374
+ data?: any,
2375
+ config?: AxiosRequestConfig
2376
+ ): OperationResponse<any>
2377
+ /**
2378
+ * revokePublicLink - revokePublicLink
2379
+ *
2380
+ * **Not yet implemented.**
2381
+ *
2382
+ * This endpoint will revoke a public link, making the file inaccessible via that link.
2383
+ *
2384
+ */
2385
+ 'revokePublicLink'(
2386
+ parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
2387
+ data?: any,
2388
+ config?: AxiosRequestConfig
2389
+ ): OperationResponse<Paths.RevokePublicLink.Responses.$204>
2390
+ /**
2391
+ * verifyCustomDownloadUrl - verifyCustomDownloadUrl
2392
+ *
2393
+ * Verify that a custom download URL is valid and has not expired.
2394
+ *
2395
+ * Use this endpoint to validate custom download URLs before redirecting users.
2396
+ * Custom download URLs include a signature and expiration time for security.
2397
+ *
2398
+ */
2399
+ 'verifyCustomDownloadUrl'(
2400
+ parameters?: Parameters<UnknownParamsObject> | null,
2401
+ data?: Paths.VerifyCustomDownloadUrl.RequestBody,
2402
+ config?: AxiosRequestConfig
2403
+ ): OperationResponse<Paths.VerifyCustomDownloadUrl.Responses.$200>
2404
+ /**
2405
+ * uploadFilePublic - uploadFilePublic
2406
+ *
2407
+ * Create a pre-signed S3 URL for uploading a file without authentication.
2408
+ *
2409
+ * **No authentication required.** This endpoint is intended for public-facing forms and journeys
2410
+ * where end-users need to upload files without logging in.
2411
+ *
2412
+ * The uploaded file is stored temporarily (one week). Use `saveFileV2` with proper authentication
2413
+ * to store the file permanently.
2414
+ *
2415
+ * **Security note:** Files uploaded via this endpoint are temporary and require authenticated
2416
+ * access to be saved permanently.
2417
+ *
2418
+ */
2419
+ 'uploadFilePublic'(
2420
+ parameters?: Parameters<UnknownParamsObject> | null,
2421
+ data?: Paths.UploadFilePublic.RequestBody,
2422
+ config?: AxiosRequestConfig
2423
+ ): OperationResponse<Paths.UploadFilePublic.Responses.$201>
2424
+ /**
2425
+ * getUserSchemaFileCollections - getUserSchemaFileCollections
2426
+ *
2427
+ * Get all file collections for the current user within a specific schema.
2428
+ *
2429
+ * Collections help organize files into logical groups (e.g., "Contracts", "Invoices").
2430
+ * User collections are private to the creating user.
2431
+ *
2432
+ */
2433
+ 'getUserSchemaFileCollections'(
2434
+ parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
2435
+ data?: any,
2436
+ config?: AxiosRequestConfig
2437
+ ): OperationResponse<Paths.GetUserSchemaFileCollections.Responses.$200>
2438
+ /**
2439
+ * createUserSchemaFileCollection - createUserSchemaFileCollection
2440
+ *
2441
+ * Create a new file collection for the current user within a specific schema.
2442
+ *
2443
+ * The collection will be private to the creating user and associated with the specified schema.
2444
+ *
2445
+ */
2446
+ 'createUserSchemaFileCollection'(
2447
+ parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
2448
+ data?: Paths.CreateUserSchemaFileCollection.RequestBody,
2449
+ config?: AxiosRequestConfig
2450
+ ): OperationResponse<Paths.CreateUserSchemaFileCollection.Responses.$201>
2451
+ /**
2452
+ * updateUserSchemaFileCollection - updateUserSchemaFileCollection
2453
+ *
2454
+ * Update an existing file collection.
2455
+ *
2456
+ * You can update the name, parent relationships, starred status, and enabled locations/purposes.
2457
+ *
2458
+ */
2459
+ 'updateUserSchemaFileCollection'(
2460
+ parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
2461
+ data?: Paths.UpdateUserSchemaFileCollection.RequestBody,
2462
+ config?: AxiosRequestConfig
2463
+ ): OperationResponse<Paths.UpdateUserSchemaFileCollection.Responses.$200>
2464
+ /**
2465
+ * deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
2466
+ *
2467
+ * Delete a file collection.
2468
+ *
2469
+ * **Note:** Deleting a collection does not delete the files within it.
2470
+ * Files will remain but will no longer be associated with this collection.
2471
+ *
2472
+ */
2473
+ 'deleteUserSchemaFileCollection'(
2474
+ parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
2475
+ data?: any,
2476
+ config?: AxiosRequestConfig
2477
+ ): OperationResponse<Paths.DeleteUserSchemaFileCollection.Responses.$200>
2478
+ /**
2479
+ * getFilesInCollection - getFilesInCollection
2480
+ *
2481
+ * Get all files within a specific collection for an entity.
2482
+ *
2483
+ * The schema is automatically derived from the entity. This endpoint requires
2484
+ * view permission on the parent entity to access its files.
2485
+ *
2486
+ */
2487
+ 'getFilesInCollection'(
2488
+ parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
2489
+ data?: any,
2490
+ config?: AxiosRequestConfig
2491
+ ): OperationResponse<Paths.GetFilesInCollection.Responses.$200>
2492
+ /**
2493
+ * getGlobalFileCollections - getGlobalFileCollections
2494
+ *
2495
+ * Get all global file collections for a specific schema.
2496
+ *
2497
+ * Global collections are shared across all users in the organization for the specified schema.
2498
+ * Unlike user collections, these are visible to everyone with access to entities of that schema.
2499
+ *
2500
+ */
2501
+ 'getGlobalFileCollections'(
2502
+ parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,
2503
+ data?: any,
2504
+ config?: AxiosRequestConfig
2505
+ ): OperationResponse<Paths.GetGlobalFileCollections.Responses.$200>
2506
+ }
2507
+
2508
+ interface PathsDictionary {
2509
+ ['/v2/files/upload']: {
2510
+ /**
2511
+ * uploadFileV2 - uploadFileV2
2512
+ *
2513
+ * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
2514
+ *
2515
+ * Use the saveFileV2 operation to store file file permanently.
2516
+ *
2517
+ */
2518
+ 'post'(
2519
+ parameters?: Parameters<Paths.UploadFileV2.QueryParameters> | null,
2520
+ data?: Paths.UploadFileV2.RequestBody,
2521
+ config?: AxiosRequestConfig
2522
+ ): OperationResponse<Paths.UploadFileV2.Responses.$201>
2523
+ }
2524
+ ['/v2/files']: {
2525
+ /**
2526
+ * saveFileV2 - saveFileV2
2527
+ *
2528
+ * Saves a permanent file entity. Updates an existing file entity when `_id` is passed.
2529
+ *
2530
+ * Saves metadata to file entity and stores a version when `s3ref` or `source_url` is passed.
2531
+ *
2532
+ */
2533
+ 'post'(
2534
+ parameters?: Parameters<Paths.SaveFileV2.QueryParameters> | null,
2535
+ data?: Paths.SaveFileV2.RequestBody,
2536
+ config?: AxiosRequestConfig
2537
+ ): OperationResponse<Paths.SaveFileV2.Responses.$200>
2538
+ }
2539
+ ['/v1/files/upload']: {
2540
+ /**
2541
+ * uploadFile - uploadFile
2542
+ *
2543
+ * **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files/upload` instead.
2544
+ *
2545
+ * ## Migration Guide
2546
+ * Replace calls to this endpoint with `uploadFileV2`:
2547
+ *
2548
+ * | v1 Parameter | v2 Parameter | Notes |
2549
+ * |--------------|--------------|-------|
2550
+ * | `file_entity_id` | `file_entity_id` | No change |
2551
+ *
2552
+ * The v2 response includes the same fields with improved structure.
2553
+ *
2554
+ * ---
2555
+ *
2556
+ * Create pre-signed S3 URL to upload a file to keep temporarily (one week).
2557
+ *
2558
+ * Use the saveFile operation to store file file permanently.
2559
+ *
2560
+ */
2561
+ 'post'(
2562
+ parameters?: Parameters<Paths.UploadFile.QueryParameters> | null,
2563
+ data?: Paths.UploadFile.RequestBody,
2564
+ config?: AxiosRequestConfig
2565
+ ): OperationResponse<Paths.UploadFile.Responses.$201>
2566
+ }
2567
+ ['/v1/files']: {
2568
+ /**
2569
+ * saveFile - saveFile
2570
+ *
2571
+ * **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files` instead.
2572
+ *
2573
+ * ## Migration Guide
2574
+ * Replace calls to this endpoint with `saveFileV2`:
2575
+ *
2576
+ * | v1 Feature | v2 Feature | Notes |
2577
+ * |------------|------------|-------|
2578
+ * | `activity_id` param | `activity_id` param | No change |
2579
+ * | `async` param | `async` param | No change |
2580
+ * | - | `fill_activity` param | New in v2 |
2581
+ * | - | `strict` param | New in v2 |
2582
+ * | - | `delete_temp_file` param | New in v2, defaults to true |
2583
+ *
2584
+ * The v2 endpoint supports additional parameters for better control over file saving behavior.
2585
+ *
2586
+ * ---
2587
+ *
2588
+ * Create / Update a permanent File entity.
2589
+ *
2590
+ * Makes file object permanent and saves metadata to file entity.
2591
+ *
2592
+ */
2593
+ 'post'(
2594
+ parameters?: Parameters<Paths.SaveFile.QueryParameters> | null,
2595
+ data?: Paths.SaveFile.RequestBody,
2596
+ config?: AxiosRequestConfig
2597
+ ): OperationResponse<Paths.SaveFile.Responses.$201>
2598
+ }
2599
+ ['/v2/files/{id}']: {
2600
+ /**
2601
+ * getFile - getFile
2602
+ *
2603
+ * Get a file entity by id
2604
+ */
2605
+ 'get'(
2606
+ parameters?: Parameters<Paths.GetFile.QueryParameters & Paths.GetFile.PathParameters> | null,
2607
+ data?: any,
2608
+ config?: AxiosRequestConfig
2609
+ ): OperationResponse<Paths.GetFile.Responses.$200>
2610
+ /**
2611
+ * deleteFile - deleteFile
2612
+ *
2613
+ * Delete a file entity by id
2614
+ */
2615
+ 'delete'(
2616
+ parameters?: Parameters<Paths.DeleteFile.QueryParameters & Paths.DeleteFile.PathParameters> | null,
2617
+ data?: any,
2618
+ config?: AxiosRequestConfig
2619
+ ): OperationResponse<Paths.DeleteFile.Responses.$200>
2620
+ }
2621
+ ['/v1/files/{id}/download']: {
2622
+ /**
2623
+ * downloadFile - downloadFile
2624
+ *
2625
+ * Generate a pre-signed download URL for a file.
2626
+ *
2627
+ * The returned URL is valid for a limited time (typically 15 minutes) and can be used to download the file directly.
2628
+ *
2629
+ */
2630
+ 'get'(
2631
+ parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
2632
+ data?: any,
2633
+ config?: AxiosRequestConfig
2634
+ ): OperationResponse<Paths.DownloadFile.Responses.$200>
2635
+ }
2636
+ ['/v1/files:downloadS3']: {
2637
+ /**
2638
+ * downloadS3File - downloadS3File
2639
+ *
2640
+ * Generate a pre-signed download URL for a file using its S3 reference.
2641
+ *
2642
+ * Use this endpoint when you have the S3 bucket and key but not the file entity ID.
2643
+ *
2644
+ */
2645
+ 'post'(
2646
+ parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
2647
+ data?: any,
2648
+ config?: AxiosRequestConfig
2649
+ ): OperationResponse<Paths.DownloadS3File.Responses.$200>
2650
+ }
2651
+ ['/v1/files:downloadFiles']: {
2652
+ /**
2653
+ * downloadFiles - downloadFiles
2654
+ *
2655
+ * Bulk generate pre-signed download URLs for multiple files in a single request.
2656
+ *
2657
+ * This is more efficient than calling `downloadFile` multiple times when you need to download several files.
2658
+ *
2659
+ */
2660
+ 'post'(
2661
+ parameters?: Parameters<UnknownParamsObject> | null,
2662
+ data?: Paths.DownloadFiles.RequestBody,
2663
+ config?: AxiosRequestConfig
2664
+ ): OperationResponse<Paths.DownloadFiles.Responses.$200>
2665
+ }
2666
+ ['/v1/files/{id}/preview']: {
2667
+ /**
2668
+ * previewFile - previewFile
2669
+ *
2670
+ * Generate a thumbnail preview for a file entity.
2671
+ *
2672
+ * Supported file types include images (PNG, JPEG, GIF, WebP), PDFs, and common document formats.
2673
+ * The preview is returned as an image (PNG or JPEG).
2674
+ *
2675
+ * **Tip:** Use with CookieAuth to embed previews directly in `<img>` tags.
2676
+ *
2677
+ */
2678
+ 'get'(
2679
+ parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
2680
+ data?: any,
2681
+ config?: AxiosRequestConfig
2682
+ ): OperationResponse<Paths.PreviewFile.Responses.$200>
2683
+ }
2684
+ ['/v1/files:previewS3']: {
2685
+ /**
2686
+ * previewS3File - previewS3File
2687
+ *
2688
+ * Generate a thumbnail preview from an S3 reference.
2689
+ *
2690
+ * Use this endpoint when you have the S3 bucket and key but not the file entity ID.
2691
+ *
2692
+ */
2693
+ 'post'(
2694
+ parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
2695
+ data?: Paths.PreviewS3File.RequestBody,
2696
+ config?: AxiosRequestConfig
2697
+ ): OperationResponse<Paths.PreviewS3File.Responses.$200>
2698
+ /**
2699
+ * previewS3FileGet - previewS3FileGet
2700
+ *
2701
+ * Get a thumbnail preview from an S3 reference using query parameters.
2702
+ *
2703
+ * This GET variant is useful for embedding previews directly in `<img>` tags.
2704
+ *
2705
+ */
2706
+ 'get'(
2707
+ parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
2708
+ data?: any,
2709
+ config?: AxiosRequestConfig
2710
+ ): OperationResponse<Paths.PreviewS3FileGet.Responses.$200>
2711
+ }
2712
+ ['/v1/files/public/{id}/preview']: {
2713
+ /**
2714
+ * previewPublicFile - previewPublicFile
2715
+ *
2716
+ * Generate a thumbnail preview for a public file entity.
2717
+ *
2718
+ * **No authentication required.** This endpoint only works for files with `access_control: public-read`.
2719
+ *
2720
+ */
2721
+ 'get'(
2722
+ parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
2723
+ data?: any,
2724
+ config?: AxiosRequestConfig
2725
+ ): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
2726
+ }
2727
+ ['/v1/files/session']: {
2728
+ /**
2729
+ * getSession - getSession
2730
+ *
2731
+ * Start a browser session by converting a Bearer token into a server-side cookie.
2732
+ *
2733
+ * **Use case:** After calling this endpoint, you can use preview URLs directly in `<img>` tags
2734
+ * without needing to set the Authorization header manually.
2735
+ *
2736
+ * **Example flow:**
2737
+ * 1. Call this endpoint with your Bearer token: `GET /v1/files/session` with `Authorization: Bearer <token>`
2738
+ * 2. The server sets an HTTP-only cookie named `token`
2739
+ * 3. Use preview URLs directly: `<img src="https://file.sls.epilot.io/v1/files/{id}/preview" />`
2740
+ *
2741
+ */
2742
+ 'get'(
2743
+ parameters?: Parameters<UnknownParamsObject> | null,
2744
+ data?: any,
2745
+ config?: AxiosRequestConfig
2746
+ ): OperationResponse<Paths.GetSession.Responses.$200>
2747
+ /**
2748
+ * deleteSession - deleteSession
2749
+ *
2750
+ * End a browser session by deleting the token cookie.
2751
+ *
2752
+ * Call this endpoint to log out and clear the session cookie.
2753
+ *
2754
+ */
2755
+ 'delete'(
2756
+ parameters?: Parameters<UnknownParamsObject> | null,
2757
+ data?: any,
2758
+ config?: AxiosRequestConfig
2759
+ ): OperationResponse<Paths.DeleteSession.Responses.$200>
2760
+ }
2761
+ ['/v1/files/{id}/public/links']: {
2762
+ /**
2763
+ * generatePublicLink - generatePublicLink
2764
+ *
2765
+ * Generate a public link to share a private file externally.
2766
+ *
2767
+ * The generated link:
2768
+ * - Is permanent until explicitly revoked
2769
+ * - Includes the filename for user-friendly URLs
2770
+ * - Does not require authentication to access
2771
+ * - Redirects to a signed download URL when accessed
2772
+ *
2773
+ * **Use case:** Share invoices, contracts, or documents with external parties who don't have epilot accounts.
2774
+ *
2775
+ */
2776
+ 'post'(
2777
+ parameters?: Parameters<Paths.GeneratePublicLink.PathParameters> | null,
2778
+ data?: any,
2779
+ config?: AxiosRequestConfig
2780
+ ): OperationResponse<Paths.GeneratePublicLink.Responses.$201>
2781
+ /**
2782
+ * listPublicLinksForFile - listPublicLinksForFile
2783
+ *
2784
+ * **Not yet implemented.**
2785
+ *
2786
+ * This endpoint will fetch all public links previously generated for a file.
2787
+ *
2788
+ */
2789
+ 'get'(
2790
+ parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
2791
+ data?: any,
2792
+ config?: AxiosRequestConfig
2793
+ ): OperationResponse<Paths.ListPublicLinksForFile.Responses.$200>
2794
+ }
2795
+ ['/v1/files/public/links/{id}/{filename}']: {
2796
+ /**
2797
+ * accessPublicLink - accessPublicLink
2798
+ *
2799
+ * Access a file via its public link.
2800
+ *
2801
+ * **No authentication required.** This endpoint redirects to a signed S3 URL for downloading the file.
2802
+ *
2803
+ * The filename in the URL is for user-friendliness and SEO; the actual file is identified by the link ID.
2804
+ *
2805
+ */
2806
+ 'get'(
2807
+ parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
2808
+ data?: any,
2809
+ config?: AxiosRequestConfig
2810
+ ): OperationResponse<any>
2811
+ }
2812
+ ['/v1/files/public/links/{id}']: {
2813
+ /**
2814
+ * revokePublicLink - revokePublicLink
2815
+ *
2816
+ * **Not yet implemented.**
2817
+ *
2818
+ * This endpoint will revoke a public link, making the file inaccessible via that link.
2819
+ *
2820
+ */
2821
+ 'delete'(
2822
+ parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
2823
+ data?: any,
2824
+ config?: AxiosRequestConfig
2825
+ ): OperationResponse<Paths.RevokePublicLink.Responses.$204>
2826
+ }
2827
+ ['/v1/files/download:verify']: {
2828
+ /**
2829
+ * verifyCustomDownloadUrl - verifyCustomDownloadUrl
2830
+ *
2831
+ * Verify that a custom download URL is valid and has not expired.
2832
+ *
2833
+ * Use this endpoint to validate custom download URLs before redirecting users.
2834
+ * Custom download URLs include a signature and expiration time for security.
2835
+ *
2836
+ */
2837
+ 'post'(
2838
+ parameters?: Parameters<UnknownParamsObject> | null,
2839
+ data?: Paths.VerifyCustomDownloadUrl.RequestBody,
2840
+ config?: AxiosRequestConfig
2841
+ ): OperationResponse<Paths.VerifyCustomDownloadUrl.Responses.$200>
2842
+ }
2843
+ ['/v1/files/public/upload']: {
2844
+ /**
2845
+ * uploadFilePublic - uploadFilePublic
2846
+ *
2847
+ * Create a pre-signed S3 URL for uploading a file without authentication.
2848
+ *
2849
+ * **No authentication required.** This endpoint is intended for public-facing forms and journeys
2850
+ * where end-users need to upload files without logging in.
2851
+ *
2852
+ * The uploaded file is stored temporarily (one week). Use `saveFileV2` with proper authentication
2853
+ * to store the file permanently.
2854
+ *
2855
+ * **Security note:** Files uploaded via this endpoint are temporary and require authenticated
2856
+ * access to be saved permanently.
2857
+ *
2858
+ */
2859
+ 'post'(
2860
+ parameters?: Parameters<UnknownParamsObject> | null,
2861
+ data?: Paths.UploadFilePublic.RequestBody,
2862
+ config?: AxiosRequestConfig
2863
+ ): OperationResponse<Paths.UploadFilePublic.Responses.$201>
2864
+ }
2865
+ ['/v1/{slug}/collections']: {
2866
+ /**
2867
+ * getUserSchemaFileCollections - getUserSchemaFileCollections
2868
+ *
2869
+ * Get all file collections for the current user within a specific schema.
2870
+ *
2871
+ * Collections help organize files into logical groups (e.g., "Contracts", "Invoices").
2872
+ * User collections are private to the creating user.
2873
+ *
2874
+ */
2875
+ 'get'(
2876
+ parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
2877
+ data?: any,
2878
+ config?: AxiosRequestConfig
2879
+ ): OperationResponse<Paths.GetUserSchemaFileCollections.Responses.$200>
2880
+ /**
2881
+ * createUserSchemaFileCollection - createUserSchemaFileCollection
2882
+ *
2883
+ * Create a new file collection for the current user within a specific schema.
2884
+ *
2885
+ * The collection will be private to the creating user and associated with the specified schema.
2886
+ *
2887
+ */
2888
+ 'post'(
2889
+ parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
2890
+ data?: Paths.CreateUserSchemaFileCollection.RequestBody,
2891
+ config?: AxiosRequestConfig
2892
+ ): OperationResponse<Paths.CreateUserSchemaFileCollection.Responses.$201>
2893
+ }
2894
+ ['/v1/{slug}/collections/{collectionSlug}']: {
2895
+ /**
2896
+ * updateUserSchemaFileCollection - updateUserSchemaFileCollection
2897
+ *
2898
+ * Update an existing file collection.
2899
+ *
2900
+ * You can update the name, parent relationships, starred status, and enabled locations/purposes.
2901
+ *
2902
+ */
2903
+ 'put'(
2904
+ parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
2905
+ data?: Paths.UpdateUserSchemaFileCollection.RequestBody,
2906
+ config?: AxiosRequestConfig
2907
+ ): OperationResponse<Paths.UpdateUserSchemaFileCollection.Responses.$200>
2908
+ /**
2909
+ * deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
2910
+ *
2911
+ * Delete a file collection.
2912
+ *
2913
+ * **Note:** Deleting a collection does not delete the files within it.
2914
+ * Files will remain but will no longer be associated with this collection.
2915
+ *
2916
+ */
2917
+ 'delete'(
2918
+ parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
2919
+ data?: any,
2920
+ config?: AxiosRequestConfig
2921
+ ): OperationResponse<Paths.DeleteUserSchemaFileCollection.Responses.$200>
2922
+ }
2923
+ ['/v1/entity/{id}/collections/{collectionSlug}/files']: {
2924
+ /**
2925
+ * getFilesInCollection - getFilesInCollection
2926
+ *
2927
+ * Get all files within a specific collection for an entity.
2928
+ *
2929
+ * The schema is automatically derived from the entity. This endpoint requires
2930
+ * view permission on the parent entity to access its files.
2931
+ *
2932
+ */
2933
+ 'get'(
2934
+ parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
2935
+ data?: any,
2936
+ config?: AxiosRequestConfig
2937
+ ): OperationResponse<Paths.GetFilesInCollection.Responses.$200>
2938
+ }
2939
+ ['/v1/collections/{schemaSlug}']: {
2940
+ /**
2941
+ * getGlobalFileCollections - getGlobalFileCollections
2942
+ *
2943
+ * Get all global file collections for a specific schema.
2944
+ *
2945
+ * Global collections are shared across all users in the organization for the specified schema.
2946
+ * Unlike user collections, these are visible to everyone with access to entities of that schema.
2947
+ *
2948
+ */
2949
+ 'get'(
2950
+ parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,
2951
+ data?: any,
2952
+ config?: AxiosRequestConfig
2953
+ ): OperationResponse<Paths.GetGlobalFileCollections.Responses.$200>
2954
+ }
2955
+ }
2956
+
2957
+ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
2958
+
2959
+
2960
+ type ActivityId = Components.Schemas.ActivityId;
2961
+ type BaseEntityAcl = Components.Schemas.BaseEntityAcl;
2962
+ type BaseEntityOwner = Components.Schemas.BaseEntityOwner;
2963
+ type BatchSaveFileVersionPayload = Components.Schemas.BatchSaveFileVersionPayload;
2964
+ type CommonSaveFilePayload = Components.Schemas.CommonSaveFilePayload;
2965
+ type CustomDownloadUrl = Components.Schemas.CustomDownloadUrl;
2966
+ type DownloadFilesPayload = Components.Schemas.DownloadFilesPayload;
2967
+ type EntityId = Components.Schemas.EntityId;
2968
+ type EntitySlug = Components.Schemas.EntitySlug;
2969
+ type ErrorObject = Components.Schemas.ErrorObject;
2970
+ type FileAttributes = Components.Schemas.FileAttributes;
2971
+ type FileCollectionAttributes = Components.Schemas.FileCollectionAttributes;
2972
+ type FileCollectionCreateRequest = Components.Schemas.FileCollectionCreateRequest;
2973
+ type FileCollectionId = Components.Schemas.FileCollectionId;
2974
+ type FileCollectionItem = Components.Schemas.FileCollectionItem;
2975
+ type FileEntity = Components.Schemas.FileEntity;
2976
+ type FileEntityId = Components.Schemas.FileEntityId;
2977
+ type FileItem = Components.Schemas.FileItem;
2978
+ type FileRelationItem = Components.Schemas.FileRelationItem;
2979
+ type FileType = Components.Schemas.FileType;
2980
+ type FileUpload = Components.Schemas.FileUpload;
2981
+ type PublicLink = Components.Schemas.PublicLink;
2982
+ type S3Ref = Components.Schemas.S3Ref;
2983
+ type S3Reference = Components.Schemas.S3Reference;
2984
+ type SaveCustomFilePayload = Components.Schemas.SaveCustomFilePayload;
2985
+ type SaveFileFromSourceURLPayload = Components.Schemas.SaveFileFromSourceURLPayload;
2986
+ type SaveFilePayload = Components.Schemas.SaveFilePayload;
2987
+ type SaveFilePayloadV2 = Components.Schemas.SaveFilePayloadV2;
2988
+ type SaveS3FilePayload = Components.Schemas.SaveS3FilePayload;
2989
+ type UploadFilePayload = Components.Schemas.UploadFilePayload;
2990
+ type VerifyCustomDownloadUrlPayload = Components.Schemas.VerifyCustomDownloadUrlPayload;
2991
+
2992
+ export { type ActivityId as A, type BaseEntityAcl as B, type Client as C, type DownloadFilesPayload as D, type EntityId as E, type FileAttributes as F, type OperationMethods as O, Paths as P, type S3Ref as S, type UploadFilePayload as U, type VerifyCustomDownloadUrlPayload as V, Components as a, type PathsDictionary as b, type BaseEntityOwner as c, type BatchSaveFileVersionPayload as d, type CommonSaveFilePayload as e, type CustomDownloadUrl as f, type EntitySlug as g, type ErrorObject as h, type FileCollectionAttributes as i, type FileCollectionCreateRequest as j, type FileCollectionId as k, type FileCollectionItem as l, type FileEntity as m, type FileEntityId as n, type FileItem as o, type FileRelationItem as p, type FileType as q, type FileUpload as r, type PublicLink as s, type S3Reference as t, type SaveCustomFilePayload as u, type SaveFileFromSourceURLPayload as v, type SaveFilePayload as w, type SaveFilePayloadV2 as x, type SaveS3FilePayload as y };