@epilot/file-client 1.21.0 → 1.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/definition.js +1 -1
- package/dist/openapi-runtime.json +31 -0
- package/dist/openapi.d.ts +1122 -214
- package/dist/openapi.json +820 -164
- package/package.json +1 -1
package/dist/openapi.d.ts
CHANGED
|
@@ -25,6 +25,7 @@ declare namespace Components {
|
|
|
25
25
|
Schemas.EntityId;
|
|
26
26
|
export type FillActivityQueryParam = boolean;
|
|
27
27
|
export type StrictQueryParam = boolean;
|
|
28
|
+
export type VersionOnlyQueryParam = boolean;
|
|
28
29
|
}
|
|
29
30
|
export interface PathParameters {
|
|
30
31
|
EntityIdPathParam?: Parameters.EntityIdPathParam;
|
|
@@ -35,14 +36,81 @@ declare namespace Components {
|
|
|
35
36
|
FillActivityQueryParam?: Parameters.FillActivityQueryParam;
|
|
36
37
|
AsyncOperationQueryParam?: Parameters.AsyncOperationQueryParam;
|
|
37
38
|
DeleteTempFileQueryParam?: Parameters.DeleteTempFileQueryParam;
|
|
39
|
+
VersionOnlyQueryParam?: Parameters.VersionOnlyQueryParam;
|
|
38
40
|
}
|
|
39
41
|
namespace Responses {
|
|
42
|
+
/**
|
|
43
|
+
* A generic error returned by the API
|
|
44
|
+
* example:
|
|
45
|
+
* {
|
|
46
|
+
* "status": 400,
|
|
47
|
+
* "error": "Bad Request: filename is required"
|
|
48
|
+
* }
|
|
49
|
+
*/
|
|
50
|
+
export interface BadRequestError {
|
|
51
|
+
/**
|
|
52
|
+
* The HTTP status code of the error
|
|
53
|
+
* example:
|
|
54
|
+
* 400
|
|
55
|
+
*/
|
|
56
|
+
status?: number;
|
|
57
|
+
/**
|
|
58
|
+
* The error message
|
|
59
|
+
* example:
|
|
60
|
+
* Bad Request
|
|
61
|
+
*/
|
|
62
|
+
error?: string;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* A generic error returned by the API
|
|
66
|
+
* example:
|
|
67
|
+
* {
|
|
68
|
+
* "status": 403,
|
|
69
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
70
|
+
* }
|
|
71
|
+
*/
|
|
72
|
+
export interface ForbiddenError {
|
|
73
|
+
/**
|
|
74
|
+
* The HTTP status code of the error
|
|
75
|
+
* example:
|
|
76
|
+
* 400
|
|
77
|
+
*/
|
|
78
|
+
status?: number;
|
|
79
|
+
/**
|
|
80
|
+
* The error message
|
|
81
|
+
* example:
|
|
82
|
+
* Bad Request
|
|
83
|
+
*/
|
|
84
|
+
error?: string;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* A generic error returned by the API
|
|
88
|
+
* example:
|
|
89
|
+
* {
|
|
90
|
+
* "status": 500,
|
|
91
|
+
* "error": "Internal Server Error"
|
|
92
|
+
* }
|
|
93
|
+
*/
|
|
94
|
+
export interface InternalServerError {
|
|
95
|
+
/**
|
|
96
|
+
* The HTTP status code of the error
|
|
97
|
+
* example:
|
|
98
|
+
* 400
|
|
99
|
+
*/
|
|
100
|
+
status?: number;
|
|
101
|
+
/**
|
|
102
|
+
* The error message
|
|
103
|
+
* example:
|
|
104
|
+
* Bad Request
|
|
105
|
+
*/
|
|
106
|
+
error?: string;
|
|
107
|
+
}
|
|
40
108
|
/**
|
|
41
109
|
* A generic error returned by the API
|
|
42
110
|
* example:
|
|
43
111
|
* {
|
|
44
112
|
* "status": 404,
|
|
45
|
-
* "error": "Not Found"
|
|
113
|
+
* "error": "Not Found: File entity not found"
|
|
46
114
|
* }
|
|
47
115
|
*/
|
|
48
116
|
export interface NotFoundError {
|
|
@@ -59,6 +127,28 @@ declare namespace Components {
|
|
|
59
127
|
*/
|
|
60
128
|
error?: string;
|
|
61
129
|
}
|
|
130
|
+
/**
|
|
131
|
+
* A generic error returned by the API
|
|
132
|
+
* example:
|
|
133
|
+
* {
|
|
134
|
+
* "status": 401,
|
|
135
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
136
|
+
* }
|
|
137
|
+
*/
|
|
138
|
+
export interface UnauthorizedError {
|
|
139
|
+
/**
|
|
140
|
+
* The HTTP status code of the error
|
|
141
|
+
* example:
|
|
142
|
+
* 400
|
|
143
|
+
*/
|
|
144
|
+
status?: number;
|
|
145
|
+
/**
|
|
146
|
+
* The error message
|
|
147
|
+
* example:
|
|
148
|
+
* Bad Request
|
|
149
|
+
*/
|
|
150
|
+
error?: string;
|
|
151
|
+
}
|
|
62
152
|
}
|
|
63
153
|
namespace Schemas {
|
|
64
154
|
/**
|
|
@@ -93,6 +183,38 @@ declare namespace Components {
|
|
|
93
183
|
*/
|
|
94
184
|
user_id?: string;
|
|
95
185
|
}
|
|
186
|
+
/**
|
|
187
|
+
* Payload for batch version save. Only s3ref payloads are supported.
|
|
188
|
+
*/
|
|
189
|
+
export interface BatchSaveFileVersionPayload {
|
|
190
|
+
/**
|
|
191
|
+
* Target file entity to add version to
|
|
192
|
+
* example:
|
|
193
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
194
|
+
*/
|
|
195
|
+
_id?: /**
|
|
196
|
+
* Target file entity to add version to
|
|
197
|
+
* example:
|
|
198
|
+
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
199
|
+
*/
|
|
200
|
+
string | string /* uuid */;
|
|
201
|
+
/**
|
|
202
|
+
* Deprecated, use _id instead
|
|
203
|
+
*/
|
|
204
|
+
file_entity_id?: string;
|
|
205
|
+
/**
|
|
206
|
+
* example:
|
|
207
|
+
* document.pdf
|
|
208
|
+
*/
|
|
209
|
+
filename?: string;
|
|
210
|
+
/**
|
|
211
|
+
* example:
|
|
212
|
+
* application/pdf
|
|
213
|
+
*/
|
|
214
|
+
mime_type?: string;
|
|
215
|
+
access_control?: "private" | "public-read";
|
|
216
|
+
s3ref: S3Ref;
|
|
217
|
+
}
|
|
96
218
|
export interface CommonSaveFilePayload {
|
|
97
219
|
[name: string]: any;
|
|
98
220
|
/**
|
|
@@ -327,8 +449,8 @@ declare namespace Components {
|
|
|
327
449
|
* List of purpose slugs where the collection is enabled. If empty, enabled for all.
|
|
328
450
|
* example:
|
|
329
451
|
* [
|
|
330
|
-
* "
|
|
331
|
-
* "
|
|
452
|
+
* "9eefcb98-93cf-4c5b-a040-f1d26d57c177",
|
|
453
|
+
* "5c544c09-a691-43ed-a7fa-0a8b44b5b161"
|
|
332
454
|
* ]
|
|
333
455
|
*/
|
|
334
456
|
enabled_purposes?: string[];
|
|
@@ -824,63 +946,69 @@ declare namespace Components {
|
|
|
824
946
|
declare namespace Paths {
|
|
825
947
|
namespace AccessPublicLink {
|
|
826
948
|
namespace Parameters {
|
|
827
|
-
/**
|
|
828
|
-
* Name of the file
|
|
829
|
-
* example:
|
|
830
|
-
* invoice-2023-12.pdf
|
|
831
|
-
*/
|
|
832
949
|
export type Filename = string;
|
|
833
|
-
/**
|
|
834
|
-
* An optional cache-busting hash for the file
|
|
835
|
-
*/
|
|
836
950
|
export type Hash = string;
|
|
837
|
-
/**
|
|
838
|
-
* Id of the publicly generated link
|
|
839
|
-
* example:
|
|
840
|
-
* 13d22918-36bd-4227-9ad4-2cb978788c8d
|
|
841
|
-
*/
|
|
842
951
|
export type Id = string;
|
|
843
952
|
}
|
|
844
953
|
export interface PathParameters {
|
|
845
|
-
id:
|
|
846
|
-
|
|
847
|
-
* example:
|
|
848
|
-
* 13d22918-36bd-4227-9ad4-2cb978788c8d
|
|
849
|
-
*/
|
|
850
|
-
Parameters.Id;
|
|
851
|
-
filename: /**
|
|
852
|
-
* Name of the file
|
|
853
|
-
* example:
|
|
854
|
-
* invoice-2023-12.pdf
|
|
855
|
-
*/
|
|
856
|
-
Parameters.Filename;
|
|
954
|
+
id: Parameters.Id;
|
|
955
|
+
filename: Parameters.Filename;
|
|
857
956
|
}
|
|
858
957
|
export interface QueryParameters {
|
|
859
|
-
hash?:
|
|
958
|
+
hash?: Parameters.Hash;
|
|
860
959
|
}
|
|
861
960
|
namespace Responses {
|
|
862
961
|
export interface $302 {
|
|
863
962
|
}
|
|
963
|
+
export type $404 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
964
|
+
export type $500 = /**
|
|
965
|
+
* A generic error returned by the API
|
|
966
|
+
* example:
|
|
967
|
+
* {
|
|
968
|
+
* "status": 500,
|
|
969
|
+
* "error": "Internal Server Error"
|
|
970
|
+
* }
|
|
971
|
+
*/
|
|
972
|
+
Components.Responses.InternalServerError;
|
|
864
973
|
}
|
|
865
974
|
}
|
|
866
975
|
namespace CreateUserSchemaFileCollection {
|
|
867
976
|
namespace Parameters {
|
|
868
|
-
/**
|
|
869
|
-
* example:
|
|
870
|
-
* opportunity
|
|
871
|
-
*/
|
|
872
977
|
export type Slug = string;
|
|
873
978
|
}
|
|
874
979
|
export interface PathParameters {
|
|
875
|
-
slug:
|
|
876
|
-
* example:
|
|
877
|
-
* opportunity
|
|
878
|
-
*/
|
|
879
|
-
Parameters.Slug;
|
|
980
|
+
slug: Parameters.Slug;
|
|
880
981
|
}
|
|
881
982
|
export type RequestBody = /* Request body for creating a file collection */ Components.Schemas.FileCollectionCreateRequest;
|
|
882
983
|
namespace Responses {
|
|
883
984
|
export type $201 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
|
|
985
|
+
export type $400 = /**
|
|
986
|
+
* A generic error returned by the API
|
|
987
|
+
* example:
|
|
988
|
+
* {
|
|
989
|
+
* "status": 400,
|
|
990
|
+
* "error": "Bad Request: filename is required"
|
|
991
|
+
* }
|
|
992
|
+
*/
|
|
993
|
+
Components.Responses.BadRequestError;
|
|
994
|
+
export type $401 = /**
|
|
995
|
+
* A generic error returned by the API
|
|
996
|
+
* example:
|
|
997
|
+
* {
|
|
998
|
+
* "status": 401,
|
|
999
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1000
|
+
* }
|
|
1001
|
+
*/
|
|
1002
|
+
Components.Responses.UnauthorizedError;
|
|
1003
|
+
export type $500 = /**
|
|
1004
|
+
* A generic error returned by the API
|
|
1005
|
+
* example:
|
|
1006
|
+
* {
|
|
1007
|
+
* "status": 500,
|
|
1008
|
+
* "error": "Internal Server Error"
|
|
1009
|
+
* }
|
|
1010
|
+
*/
|
|
1011
|
+
Components.Responses.InternalServerError;
|
|
884
1012
|
}
|
|
885
1013
|
}
|
|
886
1014
|
namespace DeleteFile {
|
|
@@ -912,6 +1040,42 @@ declare namespace Paths {
|
|
|
912
1040
|
}
|
|
913
1041
|
namespace Responses {
|
|
914
1042
|
export type $200 = Components.Schemas.FileEntity;
|
|
1043
|
+
export type $401 = /**
|
|
1044
|
+
* A generic error returned by the API
|
|
1045
|
+
* example:
|
|
1046
|
+
* {
|
|
1047
|
+
* "status": 401,
|
|
1048
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1049
|
+
* }
|
|
1050
|
+
*/
|
|
1051
|
+
Components.Responses.UnauthorizedError;
|
|
1052
|
+
export type $403 = /**
|
|
1053
|
+
* A generic error returned by the API
|
|
1054
|
+
* example:
|
|
1055
|
+
* {
|
|
1056
|
+
* "status": 403,
|
|
1057
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
1058
|
+
* }
|
|
1059
|
+
*/
|
|
1060
|
+
Components.Responses.ForbiddenError;
|
|
1061
|
+
export type $404 = /**
|
|
1062
|
+
* A generic error returned by the API
|
|
1063
|
+
* example:
|
|
1064
|
+
* {
|
|
1065
|
+
* "status": 404,
|
|
1066
|
+
* "error": "Not Found: File entity not found"
|
|
1067
|
+
* }
|
|
1068
|
+
*/
|
|
1069
|
+
Components.Responses.NotFoundError;
|
|
1070
|
+
export type $500 = /**
|
|
1071
|
+
* A generic error returned by the API
|
|
1072
|
+
* example:
|
|
1073
|
+
* {
|
|
1074
|
+
* "status": 500,
|
|
1075
|
+
* "error": "Internal Server Error"
|
|
1076
|
+
* }
|
|
1077
|
+
*/
|
|
1078
|
+
Components.Responses.InternalServerError;
|
|
915
1079
|
}
|
|
916
1080
|
}
|
|
917
1081
|
namespace DeleteSession {
|
|
@@ -922,41 +1086,43 @@ declare namespace Paths {
|
|
|
922
1086
|
}
|
|
923
1087
|
namespace DeleteUserSchemaFileCollection {
|
|
924
1088
|
namespace Parameters {
|
|
925
|
-
/**
|
|
926
|
-
* example:
|
|
927
|
-
* documents
|
|
928
|
-
*/
|
|
929
1089
|
export type CollectionSlug = string;
|
|
930
|
-
/**
|
|
931
|
-
* example:
|
|
932
|
-
* opportunity
|
|
933
|
-
*/
|
|
934
1090
|
export type Slug = string;
|
|
935
1091
|
}
|
|
936
1092
|
export interface PathParameters {
|
|
937
|
-
slug:
|
|
938
|
-
|
|
939
|
-
* opportunity
|
|
940
|
-
*/
|
|
941
|
-
Parameters.Slug;
|
|
942
|
-
collectionSlug: /**
|
|
943
|
-
* example:
|
|
944
|
-
* documents
|
|
945
|
-
*/
|
|
946
|
-
Parameters.CollectionSlug;
|
|
1093
|
+
slug: Parameters.Slug;
|
|
1094
|
+
collectionSlug: Parameters.CollectionSlug;
|
|
947
1095
|
}
|
|
948
1096
|
namespace Responses {
|
|
949
1097
|
export interface $200 {
|
|
950
1098
|
}
|
|
1099
|
+
export type $401 = /**
|
|
1100
|
+
* A generic error returned by the API
|
|
1101
|
+
* example:
|
|
1102
|
+
* {
|
|
1103
|
+
* "status": 401,
|
|
1104
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1105
|
+
* }
|
|
1106
|
+
*/
|
|
1107
|
+
Components.Responses.UnauthorizedError;
|
|
951
1108
|
export type $404 = /**
|
|
952
1109
|
* A generic error returned by the API
|
|
953
1110
|
* example:
|
|
954
1111
|
* {
|
|
955
1112
|
* "status": 404,
|
|
956
|
-
* "error": "Not Found"
|
|
1113
|
+
* "error": "Not Found: File entity not found"
|
|
957
1114
|
* }
|
|
958
1115
|
*/
|
|
959
1116
|
Components.Responses.NotFoundError;
|
|
1117
|
+
export type $500 = /**
|
|
1118
|
+
* A generic error returned by the API
|
|
1119
|
+
* example:
|
|
1120
|
+
* {
|
|
1121
|
+
* "status": 500,
|
|
1122
|
+
* "error": "Internal Server Error"
|
|
1123
|
+
* }
|
|
1124
|
+
*/
|
|
1125
|
+
Components.Responses.InternalServerError;
|
|
960
1126
|
}
|
|
961
1127
|
}
|
|
962
1128
|
namespace DownloadFile {
|
|
@@ -979,11 +1145,48 @@ declare namespace Paths {
|
|
|
979
1145
|
namespace Responses {
|
|
980
1146
|
export interface $200 {
|
|
981
1147
|
/**
|
|
1148
|
+
* Pre-signed S3 URL valid for downloading the file
|
|
982
1149
|
* example:
|
|
983
1150
|
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
984
1151
|
*/
|
|
985
1152
|
download_url?: string; // uri
|
|
986
1153
|
}
|
|
1154
|
+
export type $401 = /**
|
|
1155
|
+
* A generic error returned by the API
|
|
1156
|
+
* example:
|
|
1157
|
+
* {
|
|
1158
|
+
* "status": 401,
|
|
1159
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1160
|
+
* }
|
|
1161
|
+
*/
|
|
1162
|
+
Components.Responses.UnauthorizedError;
|
|
1163
|
+
export type $403 = /**
|
|
1164
|
+
* A generic error returned by the API
|
|
1165
|
+
* example:
|
|
1166
|
+
* {
|
|
1167
|
+
* "status": 403,
|
|
1168
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
1169
|
+
* }
|
|
1170
|
+
*/
|
|
1171
|
+
Components.Responses.ForbiddenError;
|
|
1172
|
+
export type $404 = /**
|
|
1173
|
+
* A generic error returned by the API
|
|
1174
|
+
* example:
|
|
1175
|
+
* {
|
|
1176
|
+
* "status": 404,
|
|
1177
|
+
* "error": "Not Found: File entity not found"
|
|
1178
|
+
* }
|
|
1179
|
+
*/
|
|
1180
|
+
Components.Responses.NotFoundError;
|
|
1181
|
+
export type $500 = /**
|
|
1182
|
+
* A generic error returned by the API
|
|
1183
|
+
* example:
|
|
1184
|
+
* {
|
|
1185
|
+
* "status": 500,
|
|
1186
|
+
* "error": "Internal Server Error"
|
|
1187
|
+
* }
|
|
1188
|
+
*/
|
|
1189
|
+
Components.Responses.InternalServerError;
|
|
987
1190
|
}
|
|
988
1191
|
}
|
|
989
1192
|
namespace DownloadFiles {
|
|
@@ -991,12 +1194,43 @@ declare namespace Paths {
|
|
|
991
1194
|
namespace Responses {
|
|
992
1195
|
export type $200 = {
|
|
993
1196
|
/**
|
|
1197
|
+
* Pre-signed S3 URL for downloading the file
|
|
994
1198
|
* example:
|
|
995
1199
|
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
996
1200
|
*/
|
|
997
1201
|
download_url?: string; // uri
|
|
1202
|
+
/**
|
|
1203
|
+
* The file entity ID (matches the requested ID)
|
|
1204
|
+
*/
|
|
998
1205
|
file_entity_id?: string; // uuid
|
|
999
1206
|
}[];
|
|
1207
|
+
export type $400 = /**
|
|
1208
|
+
* A generic error returned by the API
|
|
1209
|
+
* example:
|
|
1210
|
+
* {
|
|
1211
|
+
* "status": 400,
|
|
1212
|
+
* "error": "Bad Request: filename is required"
|
|
1213
|
+
* }
|
|
1214
|
+
*/
|
|
1215
|
+
Components.Responses.BadRequestError;
|
|
1216
|
+
export type $401 = /**
|
|
1217
|
+
* A generic error returned by the API
|
|
1218
|
+
* example:
|
|
1219
|
+
* {
|
|
1220
|
+
* "status": 401,
|
|
1221
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1222
|
+
* }
|
|
1223
|
+
*/
|
|
1224
|
+
Components.Responses.UnauthorizedError;
|
|
1225
|
+
export type $500 = /**
|
|
1226
|
+
* A generic error returned by the API
|
|
1227
|
+
* example:
|
|
1228
|
+
* {
|
|
1229
|
+
* "status": 500,
|
|
1230
|
+
* "error": "Internal Server Error"
|
|
1231
|
+
* }
|
|
1232
|
+
*/
|
|
1233
|
+
Components.Responses.InternalServerError;
|
|
1000
1234
|
}
|
|
1001
1235
|
}
|
|
1002
1236
|
namespace DownloadS3File {
|
|
@@ -1013,11 +1247,48 @@ declare namespace Paths {
|
|
|
1013
1247
|
namespace Responses {
|
|
1014
1248
|
export interface $200 {
|
|
1015
1249
|
/**
|
|
1250
|
+
* Pre-signed S3 URL valid for downloading the file
|
|
1016
1251
|
* example:
|
|
1017
1252
|
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
1018
1253
|
*/
|
|
1019
1254
|
download_url?: string; // uri
|
|
1020
1255
|
}
|
|
1256
|
+
export type $400 = /**
|
|
1257
|
+
* A generic error returned by the API
|
|
1258
|
+
* example:
|
|
1259
|
+
* {
|
|
1260
|
+
* "status": 400,
|
|
1261
|
+
* "error": "Bad Request: filename is required"
|
|
1262
|
+
* }
|
|
1263
|
+
*/
|
|
1264
|
+
Components.Responses.BadRequestError;
|
|
1265
|
+
export type $401 = /**
|
|
1266
|
+
* A generic error returned by the API
|
|
1267
|
+
* example:
|
|
1268
|
+
* {
|
|
1269
|
+
* "status": 401,
|
|
1270
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1271
|
+
* }
|
|
1272
|
+
*/
|
|
1273
|
+
Components.Responses.UnauthorizedError;
|
|
1274
|
+
export type $404 = /**
|
|
1275
|
+
* A generic error returned by the API
|
|
1276
|
+
* example:
|
|
1277
|
+
* {
|
|
1278
|
+
* "status": 404,
|
|
1279
|
+
* "error": "Not Found: File entity not found"
|
|
1280
|
+
* }
|
|
1281
|
+
*/
|
|
1282
|
+
Components.Responses.NotFoundError;
|
|
1283
|
+
export type $500 = /**
|
|
1284
|
+
* A generic error returned by the API
|
|
1285
|
+
* example:
|
|
1286
|
+
* {
|
|
1287
|
+
* "status": 500,
|
|
1288
|
+
* "error": "Internal Server Error"
|
|
1289
|
+
* }
|
|
1290
|
+
*/
|
|
1291
|
+
Components.Responses.InternalServerError;
|
|
1021
1292
|
}
|
|
1022
1293
|
}
|
|
1023
1294
|
namespace GeneratePublicLink {
|
|
@@ -1033,16 +1304,51 @@ declare namespace Paths {
|
|
|
1033
1304
|
}
|
|
1034
1305
|
namespace Responses {
|
|
1035
1306
|
/**
|
|
1036
|
-
*
|
|
1037
|
-
* https://file.sls.epilot.io/v1/files/public/links/3ef5c6d9-818d-45e6-8efb-b1de59079a1c/invoice-2023-12.pdf
|
|
1307
|
+
* The public URL that can be shared externally
|
|
1038
1308
|
*/
|
|
1039
1309
|
export type $201 = string;
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1310
|
+
export type $401 = /**
|
|
1311
|
+
* A generic error returned by the API
|
|
1312
|
+
* example:
|
|
1313
|
+
* {
|
|
1314
|
+
* "status": 401,
|
|
1315
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1316
|
+
* }
|
|
1317
|
+
*/
|
|
1318
|
+
Components.Responses.UnauthorizedError;
|
|
1319
|
+
export type $403 = /**
|
|
1320
|
+
* A generic error returned by the API
|
|
1321
|
+
* example:
|
|
1322
|
+
* {
|
|
1323
|
+
* "status": 403,
|
|
1324
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
1325
|
+
* }
|
|
1326
|
+
*/
|
|
1327
|
+
Components.Responses.ForbiddenError;
|
|
1328
|
+
export type $404 = /**
|
|
1329
|
+
* A generic error returned by the API
|
|
1330
|
+
* example:
|
|
1331
|
+
* {
|
|
1332
|
+
* "status": 404,
|
|
1333
|
+
* "error": "Not Found: File entity not found"
|
|
1334
|
+
* }
|
|
1335
|
+
*/
|
|
1336
|
+
Components.Responses.NotFoundError;
|
|
1337
|
+
export type $500 = /**
|
|
1338
|
+
* A generic error returned by the API
|
|
1339
|
+
* example:
|
|
1340
|
+
* {
|
|
1341
|
+
* "status": 500,
|
|
1342
|
+
* "error": "Internal Server Error"
|
|
1343
|
+
* }
|
|
1344
|
+
*/
|
|
1345
|
+
Components.Responses.InternalServerError;
|
|
1346
|
+
}
|
|
1347
|
+
}
|
|
1348
|
+
namespace GetFile {
|
|
1349
|
+
namespace Parameters {
|
|
1350
|
+
export type Async = boolean;
|
|
1351
|
+
export type Id = /**
|
|
1046
1352
|
* example:
|
|
1047
1353
|
* ef7d985c-2385-44f4-9c71-ae06a52264f8
|
|
1048
1354
|
*/
|
|
@@ -1063,14 +1369,46 @@ declare namespace Paths {
|
|
|
1063
1369
|
}
|
|
1064
1370
|
namespace Responses {
|
|
1065
1371
|
export type $200 = Components.Schemas.FileEntity;
|
|
1372
|
+
export type $401 = /**
|
|
1373
|
+
* A generic error returned by the API
|
|
1374
|
+
* example:
|
|
1375
|
+
* {
|
|
1376
|
+
* "status": 401,
|
|
1377
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1378
|
+
* }
|
|
1379
|
+
*/
|
|
1380
|
+
Components.Responses.UnauthorizedError;
|
|
1381
|
+
export type $403 = /**
|
|
1382
|
+
* A generic error returned by the API
|
|
1383
|
+
* example:
|
|
1384
|
+
* {
|
|
1385
|
+
* "status": 403,
|
|
1386
|
+
* "error": "Forbidden: You do not have permission to access this file"
|
|
1387
|
+
* }
|
|
1388
|
+
*/
|
|
1389
|
+
Components.Responses.ForbiddenError;
|
|
1390
|
+
export type $404 = /**
|
|
1391
|
+
* A generic error returned by the API
|
|
1392
|
+
* example:
|
|
1393
|
+
* {
|
|
1394
|
+
* "status": 404,
|
|
1395
|
+
* "error": "Not Found: File entity not found"
|
|
1396
|
+
* }
|
|
1397
|
+
*/
|
|
1398
|
+
Components.Responses.NotFoundError;
|
|
1399
|
+
export type $500 = /**
|
|
1400
|
+
* A generic error returned by the API
|
|
1401
|
+
* example:
|
|
1402
|
+
* {
|
|
1403
|
+
* "status": 500,
|
|
1404
|
+
* "error": "Internal Server Error"
|
|
1405
|
+
* }
|
|
1406
|
+
*/
|
|
1407
|
+
Components.Responses.InternalServerError;
|
|
1066
1408
|
}
|
|
1067
1409
|
}
|
|
1068
1410
|
namespace GetFilesInCollection {
|
|
1069
1411
|
namespace Parameters {
|
|
1070
|
-
/**
|
|
1071
|
-
* example:
|
|
1072
|
-
* documents
|
|
1073
|
-
*/
|
|
1074
1412
|
export type CollectionSlug = string;
|
|
1075
1413
|
export type Id = /**
|
|
1076
1414
|
* example:
|
|
@@ -1080,95 +1418,117 @@ declare namespace Paths {
|
|
|
1080
1418
|
}
|
|
1081
1419
|
export interface PathParameters {
|
|
1082
1420
|
id: Parameters.Id;
|
|
1083
|
-
collectionSlug:
|
|
1084
|
-
* example:
|
|
1085
|
-
* documents
|
|
1086
|
-
*/
|
|
1087
|
-
Parameters.CollectionSlug;
|
|
1421
|
+
collectionSlug: Parameters.CollectionSlug;
|
|
1088
1422
|
}
|
|
1089
1423
|
namespace Responses {
|
|
1090
1424
|
export type $200 = Components.Schemas.FileEntity[];
|
|
1091
|
-
export
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1425
|
+
export type $401 = /**
|
|
1426
|
+
* A generic error returned by the API
|
|
1427
|
+
* example:
|
|
1428
|
+
* {
|
|
1429
|
+
* "status": 401,
|
|
1430
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1431
|
+
* }
|
|
1432
|
+
*/
|
|
1433
|
+
Components.Responses.UnauthorizedError;
|
|
1434
|
+
export type $403 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
1435
|
+
export type $404 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
1436
|
+
export type $500 = /**
|
|
1437
|
+
* A generic error returned by the API
|
|
1438
|
+
* example:
|
|
1439
|
+
* {
|
|
1440
|
+
* "status": 500,
|
|
1441
|
+
* "error": "Internal Server Error"
|
|
1442
|
+
* }
|
|
1443
|
+
*/
|
|
1444
|
+
Components.Responses.InternalServerError;
|
|
1105
1445
|
}
|
|
1106
1446
|
}
|
|
1107
1447
|
namespace GetGlobalFileCollections {
|
|
1108
1448
|
namespace Parameters {
|
|
1109
|
-
/**
|
|
1110
|
-
* example:
|
|
1111
|
-
* order
|
|
1112
|
-
*/
|
|
1113
1449
|
export type SchemaSlug = string;
|
|
1114
1450
|
}
|
|
1115
1451
|
export interface PathParameters {
|
|
1116
|
-
schemaSlug:
|
|
1117
|
-
* example:
|
|
1118
|
-
* order
|
|
1119
|
-
*/
|
|
1120
|
-
Parameters.SchemaSlug;
|
|
1452
|
+
schemaSlug: Parameters.SchemaSlug;
|
|
1121
1453
|
}
|
|
1122
1454
|
namespace Responses {
|
|
1123
1455
|
export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
|
|
1456
|
+
export type $401 = /**
|
|
1457
|
+
* A generic error returned by the API
|
|
1458
|
+
* example:
|
|
1459
|
+
* {
|
|
1460
|
+
* "status": 401,
|
|
1461
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1462
|
+
* }
|
|
1463
|
+
*/
|
|
1464
|
+
Components.Responses.UnauthorizedError;
|
|
1465
|
+
export type $500 = /**
|
|
1466
|
+
* A generic error returned by the API
|
|
1467
|
+
* example:
|
|
1468
|
+
* {
|
|
1469
|
+
* "status": 500,
|
|
1470
|
+
* "error": "Internal Server Error"
|
|
1471
|
+
* }
|
|
1472
|
+
*/
|
|
1473
|
+
Components.Responses.InternalServerError;
|
|
1124
1474
|
}
|
|
1125
1475
|
}
|
|
1126
1476
|
namespace GetSession {
|
|
1127
1477
|
namespace Responses {
|
|
1128
1478
|
export interface $200 {
|
|
1129
1479
|
}
|
|
1480
|
+
export type $401 = /**
|
|
1481
|
+
* A generic error returned by the API
|
|
1482
|
+
* example:
|
|
1483
|
+
* {
|
|
1484
|
+
* "status": 401,
|
|
1485
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1486
|
+
* }
|
|
1487
|
+
*/
|
|
1488
|
+
Components.Responses.UnauthorizedError;
|
|
1130
1489
|
}
|
|
1131
1490
|
}
|
|
1132
1491
|
namespace GetUserSchemaFileCollections {
|
|
1133
1492
|
namespace Parameters {
|
|
1134
|
-
/**
|
|
1135
|
-
* example:
|
|
1136
|
-
* opportunity
|
|
1137
|
-
*/
|
|
1138
1493
|
export type Slug = string;
|
|
1139
1494
|
}
|
|
1140
1495
|
export interface PathParameters {
|
|
1141
|
-
slug:
|
|
1142
|
-
* example:
|
|
1143
|
-
* opportunity
|
|
1144
|
-
*/
|
|
1145
|
-
Parameters.Slug;
|
|
1496
|
+
slug: Parameters.Slug;
|
|
1146
1497
|
}
|
|
1147
1498
|
namespace Responses {
|
|
1148
1499
|
export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem[];
|
|
1500
|
+
export type $401 = /**
|
|
1501
|
+
* A generic error returned by the API
|
|
1502
|
+
* example:
|
|
1503
|
+
* {
|
|
1504
|
+
* "status": 401,
|
|
1505
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1506
|
+
* }
|
|
1507
|
+
*/
|
|
1508
|
+
Components.Responses.UnauthorizedError;
|
|
1509
|
+
export type $500 = /**
|
|
1510
|
+
* A generic error returned by the API
|
|
1511
|
+
* example:
|
|
1512
|
+
* {
|
|
1513
|
+
* "status": 500,
|
|
1514
|
+
* "error": "Internal Server Error"
|
|
1515
|
+
* }
|
|
1516
|
+
*/
|
|
1517
|
+
Components.Responses.InternalServerError;
|
|
1149
1518
|
}
|
|
1150
1519
|
}
|
|
1151
1520
|
namespace ListPublicLinksForFile {
|
|
1152
1521
|
namespace Parameters {
|
|
1153
|
-
/**
|
|
1154
|
-
* ID of the file entity
|
|
1155
|
-
* example:
|
|
1156
|
-
* 13d22918-36bd-4227-9ad4-2cb978788c8d
|
|
1157
|
-
*/
|
|
1158
1522
|
export type Id = string;
|
|
1159
1523
|
}
|
|
1160
1524
|
export interface PathParameters {
|
|
1161
|
-
id:
|
|
1162
|
-
* ID of the file entity
|
|
1163
|
-
* example:
|
|
1164
|
-
* 13d22918-36bd-4227-9ad4-2cb978788c8d
|
|
1165
|
-
*/
|
|
1166
|
-
Parameters.Id;
|
|
1525
|
+
id: Parameters.Id;
|
|
1167
1526
|
}
|
|
1168
1527
|
namespace Responses {
|
|
1169
1528
|
export interface $200 {
|
|
1170
1529
|
results?: Components.Schemas.PublicLink[];
|
|
1171
1530
|
}
|
|
1531
|
+
export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
1172
1532
|
}
|
|
1173
1533
|
}
|
|
1174
1534
|
namespace PreviewFile {
|
|
@@ -1190,6 +1550,36 @@ declare namespace Paths {
|
|
|
1190
1550
|
w?: Parameters.W;
|
|
1191
1551
|
h?: Parameters.H;
|
|
1192
1552
|
}
|
|
1553
|
+
namespace Responses {
|
|
1554
|
+
export type $200 = string; // binary
|
|
1555
|
+
export type $401 = /**
|
|
1556
|
+
* A generic error returned by the API
|
|
1557
|
+
* example:
|
|
1558
|
+
* {
|
|
1559
|
+
* "status": 401,
|
|
1560
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1561
|
+
* }
|
|
1562
|
+
*/
|
|
1563
|
+
Components.Responses.UnauthorizedError;
|
|
1564
|
+
export type $404 = /**
|
|
1565
|
+
* A generic error returned by the API
|
|
1566
|
+
* example:
|
|
1567
|
+
* {
|
|
1568
|
+
* "status": 404,
|
|
1569
|
+
* "error": "Not Found: File entity not found"
|
|
1570
|
+
* }
|
|
1571
|
+
*/
|
|
1572
|
+
Components.Responses.NotFoundError;
|
|
1573
|
+
export type $500 = /**
|
|
1574
|
+
* A generic error returned by the API
|
|
1575
|
+
* example:
|
|
1576
|
+
* {
|
|
1577
|
+
* "status": 500,
|
|
1578
|
+
* "error": "Internal Server Error"
|
|
1579
|
+
* }
|
|
1580
|
+
*/
|
|
1581
|
+
Components.Responses.InternalServerError;
|
|
1582
|
+
}
|
|
1193
1583
|
}
|
|
1194
1584
|
namespace PreviewPublicFile {
|
|
1195
1585
|
namespace Parameters {
|
|
@@ -1212,6 +1602,28 @@ declare namespace Paths {
|
|
|
1212
1602
|
h?: Parameters.H;
|
|
1213
1603
|
org_id?: Parameters.OrgId;
|
|
1214
1604
|
}
|
|
1605
|
+
namespace Responses {
|
|
1606
|
+
export type $200 = string; // binary
|
|
1607
|
+
export type $403 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
1608
|
+
export type $404 = /**
|
|
1609
|
+
* A generic error returned by the API
|
|
1610
|
+
* example:
|
|
1611
|
+
* {
|
|
1612
|
+
* "status": 404,
|
|
1613
|
+
* "error": "Not Found: File entity not found"
|
|
1614
|
+
* }
|
|
1615
|
+
*/
|
|
1616
|
+
Components.Responses.NotFoundError;
|
|
1617
|
+
export type $500 = /**
|
|
1618
|
+
* A generic error returned by the API
|
|
1619
|
+
* example:
|
|
1620
|
+
* {
|
|
1621
|
+
* "status": 500,
|
|
1622
|
+
* "error": "Internal Server Error"
|
|
1623
|
+
* }
|
|
1624
|
+
*/
|
|
1625
|
+
Components.Responses.InternalServerError;
|
|
1626
|
+
}
|
|
1215
1627
|
}
|
|
1216
1628
|
namespace PreviewS3File {
|
|
1217
1629
|
namespace Parameters {
|
|
@@ -1223,6 +1635,45 @@ declare namespace Paths {
|
|
|
1223
1635
|
h?: Parameters.H;
|
|
1224
1636
|
}
|
|
1225
1637
|
export type RequestBody = Components.Schemas.S3Ref;
|
|
1638
|
+
namespace Responses {
|
|
1639
|
+
export type $200 = string; // binary
|
|
1640
|
+
export type $400 = /**
|
|
1641
|
+
* A generic error returned by the API
|
|
1642
|
+
* example:
|
|
1643
|
+
* {
|
|
1644
|
+
* "status": 400,
|
|
1645
|
+
* "error": "Bad Request: filename is required"
|
|
1646
|
+
* }
|
|
1647
|
+
*/
|
|
1648
|
+
Components.Responses.BadRequestError;
|
|
1649
|
+
export type $401 = /**
|
|
1650
|
+
* A generic error returned by the API
|
|
1651
|
+
* example:
|
|
1652
|
+
* {
|
|
1653
|
+
* "status": 401,
|
|
1654
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1655
|
+
* }
|
|
1656
|
+
*/
|
|
1657
|
+
Components.Responses.UnauthorizedError;
|
|
1658
|
+
export type $404 = /**
|
|
1659
|
+
* A generic error returned by the API
|
|
1660
|
+
* example:
|
|
1661
|
+
* {
|
|
1662
|
+
* "status": 404,
|
|
1663
|
+
* "error": "Not Found: File entity not found"
|
|
1664
|
+
* }
|
|
1665
|
+
*/
|
|
1666
|
+
Components.Responses.NotFoundError;
|
|
1667
|
+
export type $500 = /**
|
|
1668
|
+
* A generic error returned by the API
|
|
1669
|
+
* example:
|
|
1670
|
+
* {
|
|
1671
|
+
* "status": 500,
|
|
1672
|
+
* "error": "Internal Server Error"
|
|
1673
|
+
* }
|
|
1674
|
+
*/
|
|
1675
|
+
Components.Responses.InternalServerError;
|
|
1676
|
+
}
|
|
1226
1677
|
}
|
|
1227
1678
|
namespace PreviewS3FileGet {
|
|
1228
1679
|
namespace Parameters {
|
|
@@ -1237,30 +1688,57 @@ declare namespace Paths {
|
|
|
1237
1688
|
w?: Parameters.W;
|
|
1238
1689
|
h?: Parameters.H;
|
|
1239
1690
|
}
|
|
1691
|
+
namespace Responses {
|
|
1692
|
+
export type $200 = string; // binary
|
|
1693
|
+
export type $400 = /**
|
|
1694
|
+
* A generic error returned by the API
|
|
1695
|
+
* example:
|
|
1696
|
+
* {
|
|
1697
|
+
* "status": 400,
|
|
1698
|
+
* "error": "Bad Request: filename is required"
|
|
1699
|
+
* }
|
|
1700
|
+
*/
|
|
1701
|
+
Components.Responses.BadRequestError;
|
|
1702
|
+
export type $401 = /**
|
|
1703
|
+
* A generic error returned by the API
|
|
1704
|
+
* example:
|
|
1705
|
+
* {
|
|
1706
|
+
* "status": 401,
|
|
1707
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1708
|
+
* }
|
|
1709
|
+
*/
|
|
1710
|
+
Components.Responses.UnauthorizedError;
|
|
1711
|
+
export type $404 = /**
|
|
1712
|
+
* A generic error returned by the API
|
|
1713
|
+
* example:
|
|
1714
|
+
* {
|
|
1715
|
+
* "status": 404,
|
|
1716
|
+
* "error": "Not Found: File entity not found"
|
|
1717
|
+
* }
|
|
1718
|
+
*/
|
|
1719
|
+
Components.Responses.NotFoundError;
|
|
1720
|
+
export type $500 = /**
|
|
1721
|
+
* A generic error returned by the API
|
|
1722
|
+
* example:
|
|
1723
|
+
* {
|
|
1724
|
+
* "status": 500,
|
|
1725
|
+
* "error": "Internal Server Error"
|
|
1726
|
+
* }
|
|
1727
|
+
*/
|
|
1728
|
+
Components.Responses.InternalServerError;
|
|
1729
|
+
}
|
|
1240
1730
|
}
|
|
1241
1731
|
namespace RevokePublicLink {
|
|
1242
1732
|
namespace Parameters {
|
|
1243
|
-
/**
|
|
1244
|
-
* Id of the publicly generated link
|
|
1245
|
-
* example:
|
|
1246
|
-
* 13d22918-36bd-4227-9ad4-2cb978788c8d
|
|
1247
|
-
*/
|
|
1248
1733
|
export type Id = string;
|
|
1249
1734
|
}
|
|
1250
1735
|
export interface PathParameters {
|
|
1251
|
-
id:
|
|
1252
|
-
* Id of the publicly generated link
|
|
1253
|
-
* example:
|
|
1254
|
-
* 13d22918-36bd-4227-9ad4-2cb978788c8d
|
|
1255
|
-
*/
|
|
1256
|
-
Parameters.Id;
|
|
1736
|
+
id: Parameters.Id;
|
|
1257
1737
|
}
|
|
1258
1738
|
namespace Responses {
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
*/
|
|
1263
|
-
export type $204 = string;
|
|
1739
|
+
export interface $204 {
|
|
1740
|
+
}
|
|
1741
|
+
export type $501 = /* A generic error returned by the API */ Components.Schemas.ErrorObject;
|
|
1264
1742
|
}
|
|
1265
1743
|
}
|
|
1266
1744
|
namespace SaveFile {
|
|
@@ -1272,14 +1750,43 @@ declare namespace Paths {
|
|
|
1272
1750
|
*/
|
|
1273
1751
|
Components.Schemas.ActivityId /* ulid */;
|
|
1274
1752
|
export type Async = boolean;
|
|
1753
|
+
export type VersionOnly = boolean;
|
|
1275
1754
|
}
|
|
1276
1755
|
export interface QueryParameters {
|
|
1277
1756
|
activity_id?: Parameters.ActivityId;
|
|
1278
1757
|
async?: Parameters.Async;
|
|
1758
|
+
version_only?: Parameters.VersionOnly;
|
|
1279
1759
|
}
|
|
1280
1760
|
export type RequestBody = Components.Schemas.SaveFilePayload;
|
|
1281
1761
|
namespace Responses {
|
|
1282
1762
|
export type $201 = Components.Schemas.FileEntity;
|
|
1763
|
+
export type $400 = /**
|
|
1764
|
+
* A generic error returned by the API
|
|
1765
|
+
* example:
|
|
1766
|
+
* {
|
|
1767
|
+
* "status": 400,
|
|
1768
|
+
* "error": "Bad Request: filename is required"
|
|
1769
|
+
* }
|
|
1770
|
+
*/
|
|
1771
|
+
Components.Responses.BadRequestError;
|
|
1772
|
+
export type $401 = /**
|
|
1773
|
+
* A generic error returned by the API
|
|
1774
|
+
* example:
|
|
1775
|
+
* {
|
|
1776
|
+
* "status": 401,
|
|
1777
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1778
|
+
* }
|
|
1779
|
+
*/
|
|
1780
|
+
Components.Responses.UnauthorizedError;
|
|
1781
|
+
export type $500 = /**
|
|
1782
|
+
* A generic error returned by the API
|
|
1783
|
+
* example:
|
|
1784
|
+
* {
|
|
1785
|
+
* "status": 500,
|
|
1786
|
+
* "error": "Internal Server Error"
|
|
1787
|
+
* }
|
|
1788
|
+
*/
|
|
1789
|
+
Components.Responses.InternalServerError;
|
|
1283
1790
|
}
|
|
1284
1791
|
}
|
|
1285
1792
|
namespace SaveFileV2 {
|
|
@@ -1294,6 +1801,7 @@ declare namespace Paths {
|
|
|
1294
1801
|
export type DeleteTempFile = boolean;
|
|
1295
1802
|
export type FillActivity = boolean;
|
|
1296
1803
|
export type Strict = boolean;
|
|
1804
|
+
export type VersionOnly = boolean;
|
|
1297
1805
|
}
|
|
1298
1806
|
export interface QueryParameters {
|
|
1299
1807
|
activity_id?: Parameters.ActivityId;
|
|
@@ -1301,49 +1809,118 @@ declare namespace Paths {
|
|
|
1301
1809
|
strict?: Parameters.Strict;
|
|
1302
1810
|
async?: Parameters.Async;
|
|
1303
1811
|
delete_temp_file?: Parameters.DeleteTempFile;
|
|
1304
|
-
|
|
1305
|
-
|
|
1812
|
+
version_only?: Parameters.VersionOnly;
|
|
1813
|
+
}
|
|
1814
|
+
export type RequestBody = Components.Schemas.SaveFilePayloadV2 | [
|
|
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
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1833
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?,
|
|
1834
|
+
/* Payload for batch version save. Only s3ref payloads are supported. */ Components.Schemas.BatchSaveFileVersionPayload?
|
|
1835
|
+
];
|
|
1306
1836
|
namespace Responses {
|
|
1307
1837
|
export type $200 = Components.Schemas.FileEntity;
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
namespace UpdateUserSchemaFileCollection {
|
|
1311
|
-
namespace Parameters {
|
|
1312
|
-
/**
|
|
1838
|
+
export type $400 = /**
|
|
1839
|
+
* A generic error returned by the API
|
|
1313
1840
|
* example:
|
|
1314
|
-
*
|
|
1841
|
+
* {
|
|
1842
|
+
* "status": 400,
|
|
1843
|
+
* "error": "Bad Request: filename is required"
|
|
1844
|
+
* }
|
|
1315
1845
|
*/
|
|
1316
|
-
|
|
1317
|
-
/**
|
|
1846
|
+
Components.Responses.BadRequestError;
|
|
1847
|
+
export type $401 = /**
|
|
1848
|
+
* A generic error returned by the API
|
|
1318
1849
|
* example:
|
|
1319
|
-
*
|
|
1850
|
+
* {
|
|
1851
|
+
* "status": 401,
|
|
1852
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1853
|
+
* }
|
|
1320
1854
|
*/
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
slug: /**
|
|
1855
|
+
Components.Responses.UnauthorizedError;
|
|
1856
|
+
export type $404 = /**
|
|
1857
|
+
* A generic error returned by the API
|
|
1325
1858
|
* example:
|
|
1326
|
-
*
|
|
1859
|
+
* {
|
|
1860
|
+
* "status": 404,
|
|
1861
|
+
* "error": "Not Found: File entity not found"
|
|
1862
|
+
* }
|
|
1327
1863
|
*/
|
|
1328
|
-
|
|
1329
|
-
|
|
1864
|
+
Components.Responses.NotFoundError;
|
|
1865
|
+
export type $500 = /**
|
|
1866
|
+
* A generic error returned by the API
|
|
1330
1867
|
* example:
|
|
1331
|
-
*
|
|
1868
|
+
* {
|
|
1869
|
+
* "status": 500,
|
|
1870
|
+
* "error": "Internal Server Error"
|
|
1871
|
+
* }
|
|
1332
1872
|
*/
|
|
1333
|
-
|
|
1873
|
+
Components.Responses.InternalServerError;
|
|
1874
|
+
}
|
|
1875
|
+
}
|
|
1876
|
+
namespace UpdateUserSchemaFileCollection {
|
|
1877
|
+
namespace Parameters {
|
|
1878
|
+
export type CollectionSlug = string;
|
|
1879
|
+
export type Slug = string;
|
|
1880
|
+
}
|
|
1881
|
+
export interface PathParameters {
|
|
1882
|
+
slug: Parameters.Slug;
|
|
1883
|
+
collectionSlug: Parameters.CollectionSlug;
|
|
1334
1884
|
}
|
|
1335
1885
|
export type RequestBody = Components.Schemas.FileCollectionAttributes;
|
|
1336
1886
|
namespace Responses {
|
|
1337
1887
|
export type $200 = /* A file collection with identifiers and timestamps */ Components.Schemas.FileCollectionItem;
|
|
1888
|
+
export type $400 = /**
|
|
1889
|
+
* A generic error returned by the API
|
|
1890
|
+
* example:
|
|
1891
|
+
* {
|
|
1892
|
+
* "status": 400,
|
|
1893
|
+
* "error": "Bad Request: filename is required"
|
|
1894
|
+
* }
|
|
1895
|
+
*/
|
|
1896
|
+
Components.Responses.BadRequestError;
|
|
1897
|
+
export type $401 = /**
|
|
1898
|
+
* A generic error returned by the API
|
|
1899
|
+
* example:
|
|
1900
|
+
* {
|
|
1901
|
+
* "status": 401,
|
|
1902
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1903
|
+
* }
|
|
1904
|
+
*/
|
|
1905
|
+
Components.Responses.UnauthorizedError;
|
|
1338
1906
|
export type $404 = /**
|
|
1339
1907
|
* A generic error returned by the API
|
|
1340
1908
|
* example:
|
|
1341
1909
|
* {
|
|
1342
1910
|
* "status": 404,
|
|
1343
|
-
* "error": "Not Found"
|
|
1911
|
+
* "error": "Not Found: File entity not found"
|
|
1344
1912
|
* }
|
|
1345
1913
|
*/
|
|
1346
1914
|
Components.Responses.NotFoundError;
|
|
1915
|
+
export type $500 = /**
|
|
1916
|
+
* A generic error returned by the API
|
|
1917
|
+
* example:
|
|
1918
|
+
* {
|
|
1919
|
+
* "status": 500,
|
|
1920
|
+
* "error": "Internal Server Error"
|
|
1921
|
+
* }
|
|
1922
|
+
*/
|
|
1923
|
+
Components.Responses.InternalServerError;
|
|
1347
1924
|
}
|
|
1348
1925
|
}
|
|
1349
1926
|
namespace UploadFile {
|
|
@@ -1373,6 +1950,33 @@ declare namespace Paths {
|
|
|
1373
1950
|
*/
|
|
1374
1951
|
public_url?: string; // url
|
|
1375
1952
|
}
|
|
1953
|
+
export type $400 = /**
|
|
1954
|
+
* A generic error returned by the API
|
|
1955
|
+
* example:
|
|
1956
|
+
* {
|
|
1957
|
+
* "status": 400,
|
|
1958
|
+
* "error": "Bad Request: filename is required"
|
|
1959
|
+
* }
|
|
1960
|
+
*/
|
|
1961
|
+
Components.Responses.BadRequestError;
|
|
1962
|
+
export type $401 = /**
|
|
1963
|
+
* A generic error returned by the API
|
|
1964
|
+
* example:
|
|
1965
|
+
* {
|
|
1966
|
+
* "status": 401,
|
|
1967
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
1968
|
+
* }
|
|
1969
|
+
*/
|
|
1970
|
+
Components.Responses.UnauthorizedError;
|
|
1971
|
+
export type $500 = /**
|
|
1972
|
+
* A generic error returned by the API
|
|
1973
|
+
* example:
|
|
1974
|
+
* {
|
|
1975
|
+
* "status": 500,
|
|
1976
|
+
* "error": "Internal Server Error"
|
|
1977
|
+
* }
|
|
1978
|
+
*/
|
|
1979
|
+
Components.Responses.InternalServerError;
|
|
1376
1980
|
}
|
|
1377
1981
|
}
|
|
1378
1982
|
namespace UploadFilePublic {
|
|
@@ -1381,16 +1985,36 @@ declare namespace Paths {
|
|
|
1381
1985
|
export interface $201 {
|
|
1382
1986
|
s3ref?: Components.Schemas.S3Reference;
|
|
1383
1987
|
/**
|
|
1988
|
+
* Pre-signed URL for uploading the file via PUT request
|
|
1384
1989
|
* example:
|
|
1385
1990
|
* https://epilot-prod-user-content.s3.eu-central-1.amazonaws.com/123/temp/4d689aeb-1497-4410-a9fe-b36ca9ac4389/document.pdf?AWSParams=123
|
|
1386
1991
|
*/
|
|
1387
1992
|
upload_url?: string; // url
|
|
1388
1993
|
/**
|
|
1994
|
+
* Error message if the upload preparation failed
|
|
1389
1995
|
* example:
|
|
1390
1996
|
* File entity not found
|
|
1391
1997
|
*/
|
|
1392
1998
|
error?: string;
|
|
1393
1999
|
}
|
|
2000
|
+
export type $400 = /**
|
|
2001
|
+
* A generic error returned by the API
|
|
2002
|
+
* example:
|
|
2003
|
+
* {
|
|
2004
|
+
* "status": 400,
|
|
2005
|
+
* "error": "Bad Request: filename is required"
|
|
2006
|
+
* }
|
|
2007
|
+
*/
|
|
2008
|
+
Components.Responses.BadRequestError;
|
|
2009
|
+
export type $500 = /**
|
|
2010
|
+
* A generic error returned by the API
|
|
2011
|
+
* example:
|
|
2012
|
+
* {
|
|
2013
|
+
* "status": 500,
|
|
2014
|
+
* "error": "Internal Server Error"
|
|
2015
|
+
* }
|
|
2016
|
+
*/
|
|
2017
|
+
Components.Responses.InternalServerError;
|
|
1394
2018
|
}
|
|
1395
2019
|
}
|
|
1396
2020
|
namespace UploadFileV2 {
|
|
@@ -1407,14 +2031,71 @@ declare namespace Paths {
|
|
|
1407
2031
|
export type RequestBody = Components.Schemas.UploadFilePayload;
|
|
1408
2032
|
namespace Responses {
|
|
1409
2033
|
export type $201 = Components.Schemas.FileUpload;
|
|
2034
|
+
export type $400 = /**
|
|
2035
|
+
* A generic error returned by the API
|
|
2036
|
+
* example:
|
|
2037
|
+
* {
|
|
2038
|
+
* "status": 400,
|
|
2039
|
+
* "error": "Bad Request: filename is required"
|
|
2040
|
+
* }
|
|
2041
|
+
*/
|
|
2042
|
+
Components.Responses.BadRequestError;
|
|
2043
|
+
export type $401 = /**
|
|
2044
|
+
* A generic error returned by the API
|
|
2045
|
+
* example:
|
|
2046
|
+
* {
|
|
2047
|
+
* "status": 401,
|
|
2048
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
2049
|
+
* }
|
|
2050
|
+
*/
|
|
2051
|
+
Components.Responses.UnauthorizedError;
|
|
2052
|
+
export type $500 = /**
|
|
2053
|
+
* A generic error returned by the API
|
|
2054
|
+
* example:
|
|
2055
|
+
* {
|
|
2056
|
+
* "status": 500,
|
|
2057
|
+
* "error": "Internal Server Error"
|
|
2058
|
+
* }
|
|
2059
|
+
*/
|
|
2060
|
+
Components.Responses.InternalServerError;
|
|
1410
2061
|
}
|
|
1411
2062
|
}
|
|
1412
2063
|
namespace VerifyCustomDownloadUrl {
|
|
1413
2064
|
export type RequestBody = Components.Schemas.VerifyCustomDownloadUrlPayload;
|
|
1414
2065
|
namespace Responses {
|
|
1415
2066
|
export interface $200 {
|
|
2067
|
+
/**
|
|
2068
|
+
* Whether the URL is valid and not expired
|
|
2069
|
+
*/
|
|
1416
2070
|
valid?: boolean;
|
|
1417
2071
|
}
|
|
2072
|
+
export type $400 = /**
|
|
2073
|
+
* A generic error returned by the API
|
|
2074
|
+
* example:
|
|
2075
|
+
* {
|
|
2076
|
+
* "status": 400,
|
|
2077
|
+
* "error": "Bad Request: filename is required"
|
|
2078
|
+
* }
|
|
2079
|
+
*/
|
|
2080
|
+
Components.Responses.BadRequestError;
|
|
2081
|
+
export type $401 = /**
|
|
2082
|
+
* A generic error returned by the API
|
|
2083
|
+
* example:
|
|
2084
|
+
* {
|
|
2085
|
+
* "status": 401,
|
|
2086
|
+
* "error": "Unauthorized: Invalid or expired token"
|
|
2087
|
+
* }
|
|
2088
|
+
*/
|
|
2089
|
+
Components.Responses.UnauthorizedError;
|
|
2090
|
+
export type $500 = /**
|
|
2091
|
+
* A generic error returned by the API
|
|
2092
|
+
* example:
|
|
2093
|
+
* {
|
|
2094
|
+
* "status": 500,
|
|
2095
|
+
* "error": "Internal Server Error"
|
|
2096
|
+
* }
|
|
2097
|
+
*/
|
|
2098
|
+
Components.Responses.InternalServerError;
|
|
1418
2099
|
}
|
|
1419
2100
|
}
|
|
1420
2101
|
}
|
|
@@ -1450,6 +2131,19 @@ export interface OperationMethods {
|
|
|
1450
2131
|
/**
|
|
1451
2132
|
* uploadFile - uploadFile
|
|
1452
2133
|
*
|
|
2134
|
+
* **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files/upload` instead.
|
|
2135
|
+
*
|
|
2136
|
+
* ## Migration Guide
|
|
2137
|
+
* Replace calls to this endpoint with `uploadFileV2`:
|
|
2138
|
+
*
|
|
2139
|
+
* | v1 Parameter | v2 Parameter | Notes |
|
|
2140
|
+
* |--------------|--------------|-------|
|
|
2141
|
+
* | `file_entity_id` | `file_entity_id` | No change |
|
|
2142
|
+
*
|
|
2143
|
+
* The v2 response includes the same fields with improved structure.
|
|
2144
|
+
*
|
|
2145
|
+
* ---
|
|
2146
|
+
*
|
|
1453
2147
|
* Create pre-signed S3 URL to upload a file to keep temporarily (one week).
|
|
1454
2148
|
*
|
|
1455
2149
|
* Use the saveFile operation to store file file permanently.
|
|
@@ -1463,11 +2157,26 @@ export interface OperationMethods {
|
|
|
1463
2157
|
/**
|
|
1464
2158
|
* saveFile - saveFile
|
|
1465
2159
|
*
|
|
1466
|
-
*
|
|
2160
|
+
* **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files` instead.
|
|
2161
|
+
*
|
|
2162
|
+
* ## Migration Guide
|
|
2163
|
+
* Replace calls to this endpoint with `saveFileV2`:
|
|
2164
|
+
*
|
|
2165
|
+
* | v1 Feature | v2 Feature | Notes |
|
|
2166
|
+
* |------------|------------|-------|
|
|
2167
|
+
* | `activity_id` param | `activity_id` param | No change |
|
|
2168
|
+
* | `async` param | `async` param | No change |
|
|
2169
|
+
* | - | `fill_activity` param | New in v2 |
|
|
2170
|
+
* | - | `strict` param | New in v2 |
|
|
2171
|
+
* | - | `delete_temp_file` param | New in v2, defaults to true |
|
|
1467
2172
|
*
|
|
1468
|
-
*
|
|
2173
|
+
* The v2 endpoint supports additional parameters for better control over file saving behavior.
|
|
1469
2174
|
*
|
|
1470
|
-
*
|
|
2175
|
+
* ---
|
|
2176
|
+
*
|
|
2177
|
+
* Create / Update a permanent File entity.
|
|
2178
|
+
*
|
|
2179
|
+
* Makes file object permanent and saves metadata to file entity.
|
|
1471
2180
|
*
|
|
1472
2181
|
*/
|
|
1473
2182
|
'saveFile'(
|
|
@@ -1498,7 +2207,10 @@ export interface OperationMethods {
|
|
|
1498
2207
|
/**
|
|
1499
2208
|
* downloadFile - downloadFile
|
|
1500
2209
|
*
|
|
1501
|
-
* Generate pre-signed download
|
|
2210
|
+
* Generate a pre-signed download URL for a file.
|
|
2211
|
+
*
|
|
2212
|
+
* The returned URL is valid for a limited time (typically 15 minutes) and can be used to download the file directly.
|
|
2213
|
+
*
|
|
1502
2214
|
*/
|
|
1503
2215
|
'downloadFile'(
|
|
1504
2216
|
parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
|
|
@@ -1508,7 +2220,10 @@ export interface OperationMethods {
|
|
|
1508
2220
|
/**
|
|
1509
2221
|
* downloadS3File - downloadS3File
|
|
1510
2222
|
*
|
|
1511
|
-
* Generate pre-signed download
|
|
2223
|
+
* Generate a pre-signed download URL for a file using its S3 reference.
|
|
2224
|
+
*
|
|
2225
|
+
* Use this endpoint when you have the S3 bucket and key but not the file entity ID.
|
|
2226
|
+
*
|
|
1512
2227
|
*/
|
|
1513
2228
|
'downloadS3File'(
|
|
1514
2229
|
parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
|
|
@@ -1518,7 +2233,10 @@ export interface OperationMethods {
|
|
|
1518
2233
|
/**
|
|
1519
2234
|
* downloadFiles - downloadFiles
|
|
1520
2235
|
*
|
|
1521
|
-
* Bulk generate pre-signed download
|
|
2236
|
+
* Bulk generate pre-signed download URLs for multiple files in a single request.
|
|
2237
|
+
*
|
|
2238
|
+
* This is more efficient than calling `downloadFile` multiple times when you need to download several files.
|
|
2239
|
+
*
|
|
1522
2240
|
*/
|
|
1523
2241
|
'downloadFiles'(
|
|
1524
2242
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -1528,49 +2246,70 @@ export interface OperationMethods {
|
|
|
1528
2246
|
/**
|
|
1529
2247
|
* previewFile - previewFile
|
|
1530
2248
|
*
|
|
1531
|
-
* Generate thumbnail preview for a file entity
|
|
2249
|
+
* Generate a thumbnail preview for a file entity.
|
|
2250
|
+
*
|
|
2251
|
+
* Supported file types include images (PNG, JPEG, GIF, WebP), PDFs, and common document formats.
|
|
2252
|
+
* The preview is returned as an image (PNG or JPEG).
|
|
2253
|
+
*
|
|
2254
|
+
* **Tip:** Use with CookieAuth to embed previews directly in `<img>` tags.
|
|
2255
|
+
*
|
|
1532
2256
|
*/
|
|
1533
2257
|
'previewFile'(
|
|
1534
2258
|
parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
|
|
1535
2259
|
data?: any,
|
|
1536
2260
|
config?: AxiosRequestConfig
|
|
1537
|
-
): OperationResponse<
|
|
2261
|
+
): OperationResponse<Paths.PreviewFile.Responses.$200>
|
|
1538
2262
|
/**
|
|
1539
2263
|
* previewS3FileGet - previewS3FileGet
|
|
1540
2264
|
*
|
|
1541
|
-
* Get thumbnail preview from an
|
|
2265
|
+
* Get a thumbnail preview from an S3 reference using query parameters.
|
|
2266
|
+
*
|
|
2267
|
+
* This GET variant is useful for embedding previews directly in `<img>` tags.
|
|
2268
|
+
*
|
|
1542
2269
|
*/
|
|
1543
2270
|
'previewS3FileGet'(
|
|
1544
2271
|
parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
|
|
1545
2272
|
data?: any,
|
|
1546
2273
|
config?: AxiosRequestConfig
|
|
1547
|
-
): OperationResponse<
|
|
2274
|
+
): OperationResponse<Paths.PreviewS3FileGet.Responses.$200>
|
|
1548
2275
|
/**
|
|
1549
2276
|
* previewS3File - previewS3File
|
|
1550
2277
|
*
|
|
1551
|
-
* Generate thumbnail preview from an
|
|
2278
|
+
* Generate a thumbnail preview from an S3 reference.
|
|
2279
|
+
*
|
|
2280
|
+
* Use this endpoint when you have the S3 bucket and key but not the file entity ID.
|
|
2281
|
+
*
|
|
1552
2282
|
*/
|
|
1553
2283
|
'previewS3File'(
|
|
1554
2284
|
parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
|
|
1555
2285
|
data?: Paths.PreviewS3File.RequestBody,
|
|
1556
2286
|
config?: AxiosRequestConfig
|
|
1557
|
-
): OperationResponse<
|
|
2287
|
+
): OperationResponse<Paths.PreviewS3File.Responses.$200>
|
|
1558
2288
|
/**
|
|
1559
2289
|
* previewPublicFile - previewPublicFile
|
|
1560
2290
|
*
|
|
1561
|
-
* Generate thumbnail preview for a public file entity
|
|
2291
|
+
* Generate a thumbnail preview for a public file entity.
|
|
2292
|
+
*
|
|
2293
|
+
* **No authentication required.** This endpoint only works for files with `access_control: public-read`.
|
|
2294
|
+
*
|
|
1562
2295
|
*/
|
|
1563
2296
|
'previewPublicFile'(
|
|
1564
2297
|
parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
|
|
1565
2298
|
data?: any,
|
|
1566
2299
|
config?: AxiosRequestConfig
|
|
1567
|
-
): OperationResponse<
|
|
2300
|
+
): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
|
|
1568
2301
|
/**
|
|
1569
2302
|
* getSession - getSession
|
|
1570
2303
|
*
|
|
1571
|
-
* Start a browser session by
|
|
2304
|
+
* Start a browser session by converting a Bearer token into a server-side cookie.
|
|
2305
|
+
*
|
|
2306
|
+
* **Use case:** After calling this endpoint, you can use preview URLs directly in `<img>` tags
|
|
2307
|
+
* without needing to set the Authorization header manually.
|
|
1572
2308
|
*
|
|
1573
|
-
*
|
|
2309
|
+
* **Example flow:**
|
|
2310
|
+
* 1. Call this endpoint with your Bearer token: `GET /v1/files/session` with `Authorization: Bearer <token>`
|
|
2311
|
+
* 2. The server sets an HTTP-only cookie named `token`
|
|
2312
|
+
* 3. Use preview URLs directly: `<img src="https://file.sls.epilot.io/v1/files/{id}/preview" />`
|
|
1574
2313
|
*
|
|
1575
2314
|
*/
|
|
1576
2315
|
'getSession'(
|
|
@@ -1581,7 +2320,10 @@ export interface OperationMethods {
|
|
|
1581
2320
|
/**
|
|
1582
2321
|
* deleteSession - deleteSession
|
|
1583
2322
|
*
|
|
1584
|
-
* End browser session by deleting token cookie
|
|
2323
|
+
* End a browser session by deleting the token cookie.
|
|
2324
|
+
*
|
|
2325
|
+
* Call this endpoint to log out and clear the session cookie.
|
|
2326
|
+
*
|
|
1585
2327
|
*/
|
|
1586
2328
|
'deleteSession'(
|
|
1587
2329
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -1591,7 +2333,10 @@ export interface OperationMethods {
|
|
|
1591
2333
|
/**
|
|
1592
2334
|
* listPublicLinksForFile - listPublicLinksForFile
|
|
1593
2335
|
*
|
|
1594
|
-
* Not yet implemented
|
|
2336
|
+
* **Not yet implemented.**
|
|
2337
|
+
*
|
|
2338
|
+
* This endpoint will fetch all public links previously generated for a file.
|
|
2339
|
+
*
|
|
1595
2340
|
*/
|
|
1596
2341
|
'listPublicLinksForFile'(
|
|
1597
2342
|
parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
|
|
@@ -1601,7 +2346,15 @@ export interface OperationMethods {
|
|
|
1601
2346
|
/**
|
|
1602
2347
|
* generatePublicLink - generatePublicLink
|
|
1603
2348
|
*
|
|
1604
|
-
*
|
|
2349
|
+
* Generate a public link to share a private file externally.
|
|
2350
|
+
*
|
|
2351
|
+
* The generated link:
|
|
2352
|
+
* - Is permanent until explicitly revoked
|
|
2353
|
+
* - Includes the filename for user-friendly URLs
|
|
2354
|
+
* - Does not require authentication to access
|
|
2355
|
+
* - Redirects to a signed download URL when accessed
|
|
2356
|
+
*
|
|
2357
|
+
* **Use case:** Share invoices, contracts, or documents with external parties who don't have epilot accounts.
|
|
1605
2358
|
*
|
|
1606
2359
|
*/
|
|
1607
2360
|
'generatePublicLink'(
|
|
@@ -1612,7 +2365,12 @@ export interface OperationMethods {
|
|
|
1612
2365
|
/**
|
|
1613
2366
|
* accessPublicLink - accessPublicLink
|
|
1614
2367
|
*
|
|
1615
|
-
*
|
|
2368
|
+
* Access a file via its public link.
|
|
2369
|
+
*
|
|
2370
|
+
* **No authentication required.** This endpoint redirects to a signed S3 URL for downloading the file.
|
|
2371
|
+
*
|
|
2372
|
+
* The filename in the URL is for user-friendliness and SEO; the actual file is identified by the link ID.
|
|
2373
|
+
*
|
|
1616
2374
|
*/
|
|
1617
2375
|
'accessPublicLink'(
|
|
1618
2376
|
parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
|
|
@@ -1622,7 +2380,10 @@ export interface OperationMethods {
|
|
|
1622
2380
|
/**
|
|
1623
2381
|
* revokePublicLink - revokePublicLink
|
|
1624
2382
|
*
|
|
1625
|
-
* Not yet implemented
|
|
2383
|
+
* **Not yet implemented.**
|
|
2384
|
+
*
|
|
2385
|
+
* This endpoint will revoke a public link, making the file inaccessible via that link.
|
|
2386
|
+
*
|
|
1626
2387
|
*/
|
|
1627
2388
|
'revokePublicLink'(
|
|
1628
2389
|
parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
|
|
@@ -1632,7 +2393,11 @@ export interface OperationMethods {
|
|
|
1632
2393
|
/**
|
|
1633
2394
|
* verifyCustomDownloadUrl - verifyCustomDownloadUrl
|
|
1634
2395
|
*
|
|
1635
|
-
* Verify a
|
|
2396
|
+
* Verify that a custom download URL is valid and has not expired.
|
|
2397
|
+
*
|
|
2398
|
+
* Use this endpoint to validate custom download URLs before redirecting users.
|
|
2399
|
+
* Custom download URLs include a signature and expiration time for security.
|
|
2400
|
+
*
|
|
1636
2401
|
*/
|
|
1637
2402
|
'verifyCustomDownloadUrl'(
|
|
1638
2403
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -1642,9 +2407,16 @@ export interface OperationMethods {
|
|
|
1642
2407
|
/**
|
|
1643
2408
|
* uploadFilePublic - uploadFilePublic
|
|
1644
2409
|
*
|
|
1645
|
-
* Create pre-signed S3 URL
|
|
2410
|
+
* Create a pre-signed S3 URL for uploading a file without authentication.
|
|
1646
2411
|
*
|
|
1647
|
-
*
|
|
2412
|
+
* **No authentication required.** This endpoint is intended for public-facing forms and journeys
|
|
2413
|
+
* where end-users need to upload files without logging in.
|
|
2414
|
+
*
|
|
2415
|
+
* The uploaded file is stored temporarily (one week). Use `saveFileV2` with proper authentication
|
|
2416
|
+
* to store the file permanently.
|
|
2417
|
+
*
|
|
2418
|
+
* **Security note:** Files uploaded via this endpoint are temporary and require authenticated
|
|
2419
|
+
* access to be saved permanently.
|
|
1648
2420
|
*
|
|
1649
2421
|
*/
|
|
1650
2422
|
'uploadFilePublic'(
|
|
@@ -1655,7 +2427,11 @@ export interface OperationMethods {
|
|
|
1655
2427
|
/**
|
|
1656
2428
|
* getUserSchemaFileCollections - getUserSchemaFileCollections
|
|
1657
2429
|
*
|
|
1658
|
-
*
|
|
2430
|
+
* Get all file collections for the current user within a specific schema.
|
|
2431
|
+
*
|
|
2432
|
+
* Collections help organize files into logical groups (e.g., "Contracts", "Invoices").
|
|
2433
|
+
* User collections are private to the creating user.
|
|
2434
|
+
*
|
|
1659
2435
|
*/
|
|
1660
2436
|
'getUserSchemaFileCollections'(
|
|
1661
2437
|
parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
|
|
@@ -1665,7 +2441,10 @@ export interface OperationMethods {
|
|
|
1665
2441
|
/**
|
|
1666
2442
|
* createUserSchemaFileCollection - createUserSchemaFileCollection
|
|
1667
2443
|
*
|
|
1668
|
-
*
|
|
2444
|
+
* Create a new file collection for the current user within a specific schema.
|
|
2445
|
+
*
|
|
2446
|
+
* The collection will be private to the creating user and associated with the specified schema.
|
|
2447
|
+
*
|
|
1669
2448
|
*/
|
|
1670
2449
|
'createUserSchemaFileCollection'(
|
|
1671
2450
|
parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
|
|
@@ -1675,7 +2454,10 @@ export interface OperationMethods {
|
|
|
1675
2454
|
/**
|
|
1676
2455
|
* updateUserSchemaFileCollection - updateUserSchemaFileCollection
|
|
1677
2456
|
*
|
|
1678
|
-
*
|
|
2457
|
+
* Update an existing file collection.
|
|
2458
|
+
*
|
|
2459
|
+
* You can update the name, parent relationships, starred status, and enabled locations/purposes.
|
|
2460
|
+
*
|
|
1679
2461
|
*/
|
|
1680
2462
|
'updateUserSchemaFileCollection'(
|
|
1681
2463
|
parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
|
|
@@ -1685,7 +2467,11 @@ export interface OperationMethods {
|
|
|
1685
2467
|
/**
|
|
1686
2468
|
* deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
|
|
1687
2469
|
*
|
|
1688
|
-
*
|
|
2470
|
+
* Delete a file collection.
|
|
2471
|
+
*
|
|
2472
|
+
* **Note:** Deleting a collection does not delete the files within it.
|
|
2473
|
+
* Files will remain but will no longer be associated with this collection.
|
|
2474
|
+
*
|
|
1689
2475
|
*/
|
|
1690
2476
|
'deleteUserSchemaFileCollection'(
|
|
1691
2477
|
parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
|
|
@@ -1695,7 +2481,11 @@ export interface OperationMethods {
|
|
|
1695
2481
|
/**
|
|
1696
2482
|
* getFilesInCollection - getFilesInCollection
|
|
1697
2483
|
*
|
|
1698
|
-
*
|
|
2484
|
+
* Get all files within a specific collection for an entity.
|
|
2485
|
+
*
|
|
2486
|
+
* The schema is automatically derived from the entity. This endpoint requires
|
|
2487
|
+
* view permission on the parent entity to access its files.
|
|
2488
|
+
*
|
|
1699
2489
|
*/
|
|
1700
2490
|
'getFilesInCollection'(
|
|
1701
2491
|
parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
|
|
@@ -1705,7 +2495,11 @@ export interface OperationMethods {
|
|
|
1705
2495
|
/**
|
|
1706
2496
|
* getGlobalFileCollections - getGlobalFileCollections
|
|
1707
2497
|
*
|
|
1708
|
-
*
|
|
2498
|
+
* Get all global file collections for a specific schema.
|
|
2499
|
+
*
|
|
2500
|
+
* Global collections are shared across all users in the organization for the specified schema.
|
|
2501
|
+
* Unlike user collections, these are visible to everyone with access to entities of that schema.
|
|
2502
|
+
*
|
|
1709
2503
|
*/
|
|
1710
2504
|
'getGlobalFileCollections'(
|
|
1711
2505
|
parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,
|
|
@@ -1749,6 +2543,19 @@ export interface PathsDictionary {
|
|
|
1749
2543
|
/**
|
|
1750
2544
|
* uploadFile - uploadFile
|
|
1751
2545
|
*
|
|
2546
|
+
* **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files/upload` instead.
|
|
2547
|
+
*
|
|
2548
|
+
* ## Migration Guide
|
|
2549
|
+
* Replace calls to this endpoint with `uploadFileV2`:
|
|
2550
|
+
*
|
|
2551
|
+
* | v1 Parameter | v2 Parameter | Notes |
|
|
2552
|
+
* |--------------|--------------|-------|
|
|
2553
|
+
* | `file_entity_id` | `file_entity_id` | No change |
|
|
2554
|
+
*
|
|
2555
|
+
* The v2 response includes the same fields with improved structure.
|
|
2556
|
+
*
|
|
2557
|
+
* ---
|
|
2558
|
+
*
|
|
1752
2559
|
* Create pre-signed S3 URL to upload a file to keep temporarily (one week).
|
|
1753
2560
|
*
|
|
1754
2561
|
* Use the saveFile operation to store file file permanently.
|
|
@@ -1764,11 +2571,26 @@ export interface PathsDictionary {
|
|
|
1764
2571
|
/**
|
|
1765
2572
|
* saveFile - saveFile
|
|
1766
2573
|
*
|
|
1767
|
-
*
|
|
2574
|
+
* **DEPRECATED** - Will be removed on **2025-06-30**. Use `POST /v2/files` instead.
|
|
2575
|
+
*
|
|
2576
|
+
* ## Migration Guide
|
|
2577
|
+
* Replace calls to this endpoint with `saveFileV2`:
|
|
2578
|
+
*
|
|
2579
|
+
* | v1 Feature | v2 Feature | Notes |
|
|
2580
|
+
* |------------|------------|-------|
|
|
2581
|
+
* | `activity_id` param | `activity_id` param | No change |
|
|
2582
|
+
* | `async` param | `async` param | No change |
|
|
2583
|
+
* | - | `fill_activity` param | New in v2 |
|
|
2584
|
+
* | - | `strict` param | New in v2 |
|
|
2585
|
+
* | - | `delete_temp_file` param | New in v2, defaults to true |
|
|
2586
|
+
*
|
|
2587
|
+
* The v2 endpoint supports additional parameters for better control over file saving behavior.
|
|
2588
|
+
*
|
|
2589
|
+
* ---
|
|
1768
2590
|
*
|
|
1769
|
-
*
|
|
2591
|
+
* Create / Update a permanent File entity.
|
|
1770
2592
|
*
|
|
1771
|
-
*
|
|
2593
|
+
* Makes file object permanent and saves metadata to file entity.
|
|
1772
2594
|
*
|
|
1773
2595
|
*/
|
|
1774
2596
|
'post'(
|
|
@@ -1803,7 +2625,10 @@ export interface PathsDictionary {
|
|
|
1803
2625
|
/**
|
|
1804
2626
|
* downloadFile - downloadFile
|
|
1805
2627
|
*
|
|
1806
|
-
* Generate pre-signed download
|
|
2628
|
+
* Generate a pre-signed download URL for a file.
|
|
2629
|
+
*
|
|
2630
|
+
* The returned URL is valid for a limited time (typically 15 minutes) and can be used to download the file directly.
|
|
2631
|
+
*
|
|
1807
2632
|
*/
|
|
1808
2633
|
'get'(
|
|
1809
2634
|
parameters?: Parameters<Paths.DownloadFile.QueryParameters & Paths.DownloadFile.PathParameters> | null,
|
|
@@ -1815,7 +2640,10 @@ export interface PathsDictionary {
|
|
|
1815
2640
|
/**
|
|
1816
2641
|
* downloadS3File - downloadS3File
|
|
1817
2642
|
*
|
|
1818
|
-
* Generate pre-signed download
|
|
2643
|
+
* Generate a pre-signed download URL for a file using its S3 reference.
|
|
2644
|
+
*
|
|
2645
|
+
* Use this endpoint when you have the S3 bucket and key but not the file entity ID.
|
|
2646
|
+
*
|
|
1819
2647
|
*/
|
|
1820
2648
|
'post'(
|
|
1821
2649
|
parameters?: Parameters<Paths.DownloadS3File.QueryParameters> | null,
|
|
@@ -1827,7 +2655,10 @@ export interface PathsDictionary {
|
|
|
1827
2655
|
/**
|
|
1828
2656
|
* downloadFiles - downloadFiles
|
|
1829
2657
|
*
|
|
1830
|
-
* Bulk generate pre-signed download
|
|
2658
|
+
* Bulk generate pre-signed download URLs for multiple files in a single request.
|
|
2659
|
+
*
|
|
2660
|
+
* This is more efficient than calling `downloadFile` multiple times when you need to download several files.
|
|
2661
|
+
*
|
|
1831
2662
|
*/
|
|
1832
2663
|
'post'(
|
|
1833
2664
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -1839,55 +2670,76 @@ export interface PathsDictionary {
|
|
|
1839
2670
|
/**
|
|
1840
2671
|
* previewFile - previewFile
|
|
1841
2672
|
*
|
|
1842
|
-
* Generate thumbnail preview for a file entity
|
|
2673
|
+
* Generate a thumbnail preview for a file entity.
|
|
2674
|
+
*
|
|
2675
|
+
* Supported file types include images (PNG, JPEG, GIF, WebP), PDFs, and common document formats.
|
|
2676
|
+
* The preview is returned as an image (PNG or JPEG).
|
|
2677
|
+
*
|
|
2678
|
+
* **Tip:** Use with CookieAuth to embed previews directly in `<img>` tags.
|
|
2679
|
+
*
|
|
1843
2680
|
*/
|
|
1844
2681
|
'get'(
|
|
1845
2682
|
parameters?: Parameters<Paths.PreviewFile.QueryParameters & Paths.PreviewFile.PathParameters> | null,
|
|
1846
2683
|
data?: any,
|
|
1847
2684
|
config?: AxiosRequestConfig
|
|
1848
|
-
): OperationResponse<
|
|
2685
|
+
): OperationResponse<Paths.PreviewFile.Responses.$200>
|
|
1849
2686
|
}
|
|
1850
2687
|
['/v1/files:previewS3']: {
|
|
1851
2688
|
/**
|
|
1852
2689
|
* previewS3File - previewS3File
|
|
1853
2690
|
*
|
|
1854
|
-
* Generate thumbnail preview from an
|
|
2691
|
+
* Generate a thumbnail preview from an S3 reference.
|
|
2692
|
+
*
|
|
2693
|
+
* Use this endpoint when you have the S3 bucket and key but not the file entity ID.
|
|
2694
|
+
*
|
|
1855
2695
|
*/
|
|
1856
2696
|
'post'(
|
|
1857
2697
|
parameters?: Parameters<Paths.PreviewS3File.QueryParameters> | null,
|
|
1858
2698
|
data?: Paths.PreviewS3File.RequestBody,
|
|
1859
2699
|
config?: AxiosRequestConfig
|
|
1860
|
-
): OperationResponse<
|
|
2700
|
+
): OperationResponse<Paths.PreviewS3File.Responses.$200>
|
|
1861
2701
|
/**
|
|
1862
2702
|
* previewS3FileGet - previewS3FileGet
|
|
1863
2703
|
*
|
|
1864
|
-
* Get thumbnail preview from an
|
|
2704
|
+
* Get a thumbnail preview from an S3 reference using query parameters.
|
|
2705
|
+
*
|
|
2706
|
+
* This GET variant is useful for embedding previews directly in `<img>` tags.
|
|
2707
|
+
*
|
|
1865
2708
|
*/
|
|
1866
2709
|
'get'(
|
|
1867
2710
|
parameters?: Parameters<Paths.PreviewS3FileGet.QueryParameters> | null,
|
|
1868
2711
|
data?: any,
|
|
1869
2712
|
config?: AxiosRequestConfig
|
|
1870
|
-
): OperationResponse<
|
|
2713
|
+
): OperationResponse<Paths.PreviewS3FileGet.Responses.$200>
|
|
1871
2714
|
}
|
|
1872
2715
|
['/v1/files/public/{id}/preview']: {
|
|
1873
2716
|
/**
|
|
1874
2717
|
* previewPublicFile - previewPublicFile
|
|
1875
2718
|
*
|
|
1876
|
-
* Generate thumbnail preview for a public file entity
|
|
2719
|
+
* Generate a thumbnail preview for a public file entity.
|
|
2720
|
+
*
|
|
2721
|
+
* **No authentication required.** This endpoint only works for files with `access_control: public-read`.
|
|
2722
|
+
*
|
|
1877
2723
|
*/
|
|
1878
2724
|
'get'(
|
|
1879
2725
|
parameters?: Parameters<Paths.PreviewPublicFile.QueryParameters & Paths.PreviewPublicFile.PathParameters> | null,
|
|
1880
2726
|
data?: any,
|
|
1881
2727
|
config?: AxiosRequestConfig
|
|
1882
|
-
): OperationResponse<
|
|
2728
|
+
): OperationResponse<Paths.PreviewPublicFile.Responses.$200>
|
|
1883
2729
|
}
|
|
1884
2730
|
['/v1/files/session']: {
|
|
1885
2731
|
/**
|
|
1886
2732
|
* getSession - getSession
|
|
1887
2733
|
*
|
|
1888
|
-
* Start a browser session by
|
|
2734
|
+
* Start a browser session by converting a Bearer token into a server-side cookie.
|
|
2735
|
+
*
|
|
2736
|
+
* **Use case:** After calling this endpoint, you can use preview URLs directly in `<img>` tags
|
|
2737
|
+
* without needing to set the Authorization header manually.
|
|
1889
2738
|
*
|
|
1890
|
-
*
|
|
2739
|
+
* **Example flow:**
|
|
2740
|
+
* 1. Call this endpoint with your Bearer token: `GET /v1/files/session` with `Authorization: Bearer <token>`
|
|
2741
|
+
* 2. The server sets an HTTP-only cookie named `token`
|
|
2742
|
+
* 3. Use preview URLs directly: `<img src="https://file.sls.epilot.io/v1/files/{id}/preview" />`
|
|
1891
2743
|
*
|
|
1892
2744
|
*/
|
|
1893
2745
|
'get'(
|
|
@@ -1898,7 +2750,10 @@ export interface PathsDictionary {
|
|
|
1898
2750
|
/**
|
|
1899
2751
|
* deleteSession - deleteSession
|
|
1900
2752
|
*
|
|
1901
|
-
* End browser session by deleting token cookie
|
|
2753
|
+
* End a browser session by deleting the token cookie.
|
|
2754
|
+
*
|
|
2755
|
+
* Call this endpoint to log out and clear the session cookie.
|
|
2756
|
+
*
|
|
1902
2757
|
*/
|
|
1903
2758
|
'delete'(
|
|
1904
2759
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -1910,7 +2765,15 @@ export interface PathsDictionary {
|
|
|
1910
2765
|
/**
|
|
1911
2766
|
* generatePublicLink - generatePublicLink
|
|
1912
2767
|
*
|
|
1913
|
-
*
|
|
2768
|
+
* Generate a public link to share a private file externally.
|
|
2769
|
+
*
|
|
2770
|
+
* The generated link:
|
|
2771
|
+
* - Is permanent until explicitly revoked
|
|
2772
|
+
* - Includes the filename for user-friendly URLs
|
|
2773
|
+
* - Does not require authentication to access
|
|
2774
|
+
* - Redirects to a signed download URL when accessed
|
|
2775
|
+
*
|
|
2776
|
+
* **Use case:** Share invoices, contracts, or documents with external parties who don't have epilot accounts.
|
|
1914
2777
|
*
|
|
1915
2778
|
*/
|
|
1916
2779
|
'post'(
|
|
@@ -1921,7 +2784,10 @@ export interface PathsDictionary {
|
|
|
1921
2784
|
/**
|
|
1922
2785
|
* listPublicLinksForFile - listPublicLinksForFile
|
|
1923
2786
|
*
|
|
1924
|
-
* Not yet implemented
|
|
2787
|
+
* **Not yet implemented.**
|
|
2788
|
+
*
|
|
2789
|
+
* This endpoint will fetch all public links previously generated for a file.
|
|
2790
|
+
*
|
|
1925
2791
|
*/
|
|
1926
2792
|
'get'(
|
|
1927
2793
|
parameters?: Parameters<Paths.ListPublicLinksForFile.PathParameters> | null,
|
|
@@ -1933,7 +2799,12 @@ export interface PathsDictionary {
|
|
|
1933
2799
|
/**
|
|
1934
2800
|
* accessPublicLink - accessPublicLink
|
|
1935
2801
|
*
|
|
1936
|
-
*
|
|
2802
|
+
* Access a file via its public link.
|
|
2803
|
+
*
|
|
2804
|
+
* **No authentication required.** This endpoint redirects to a signed S3 URL for downloading the file.
|
|
2805
|
+
*
|
|
2806
|
+
* The filename in the URL is for user-friendliness and SEO; the actual file is identified by the link ID.
|
|
2807
|
+
*
|
|
1937
2808
|
*/
|
|
1938
2809
|
'get'(
|
|
1939
2810
|
parameters?: Parameters<Paths.AccessPublicLink.QueryParameters & Paths.AccessPublicLink.PathParameters> | null,
|
|
@@ -1945,7 +2816,10 @@ export interface PathsDictionary {
|
|
|
1945
2816
|
/**
|
|
1946
2817
|
* revokePublicLink - revokePublicLink
|
|
1947
2818
|
*
|
|
1948
|
-
* Not yet implemented
|
|
2819
|
+
* **Not yet implemented.**
|
|
2820
|
+
*
|
|
2821
|
+
* This endpoint will revoke a public link, making the file inaccessible via that link.
|
|
2822
|
+
*
|
|
1949
2823
|
*/
|
|
1950
2824
|
'delete'(
|
|
1951
2825
|
parameters?: Parameters<Paths.RevokePublicLink.PathParameters> | null,
|
|
@@ -1957,7 +2831,11 @@ export interface PathsDictionary {
|
|
|
1957
2831
|
/**
|
|
1958
2832
|
* verifyCustomDownloadUrl - verifyCustomDownloadUrl
|
|
1959
2833
|
*
|
|
1960
|
-
* Verify a
|
|
2834
|
+
* Verify that a custom download URL is valid and has not expired.
|
|
2835
|
+
*
|
|
2836
|
+
* Use this endpoint to validate custom download URLs before redirecting users.
|
|
2837
|
+
* Custom download URLs include a signature and expiration time for security.
|
|
2838
|
+
*
|
|
1961
2839
|
*/
|
|
1962
2840
|
'post'(
|
|
1963
2841
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -1969,9 +2847,16 @@ export interface PathsDictionary {
|
|
|
1969
2847
|
/**
|
|
1970
2848
|
* uploadFilePublic - uploadFilePublic
|
|
1971
2849
|
*
|
|
1972
|
-
* Create pre-signed S3 URL
|
|
2850
|
+
* Create a pre-signed S3 URL for uploading a file without authentication.
|
|
1973
2851
|
*
|
|
1974
|
-
*
|
|
2852
|
+
* **No authentication required.** This endpoint is intended for public-facing forms and journeys
|
|
2853
|
+
* where end-users need to upload files without logging in.
|
|
2854
|
+
*
|
|
2855
|
+
* The uploaded file is stored temporarily (one week). Use `saveFileV2` with proper authentication
|
|
2856
|
+
* to store the file permanently.
|
|
2857
|
+
*
|
|
2858
|
+
* **Security note:** Files uploaded via this endpoint are temporary and require authenticated
|
|
2859
|
+
* access to be saved permanently.
|
|
1975
2860
|
*
|
|
1976
2861
|
*/
|
|
1977
2862
|
'post'(
|
|
@@ -1984,7 +2869,11 @@ export interface PathsDictionary {
|
|
|
1984
2869
|
/**
|
|
1985
2870
|
* getUserSchemaFileCollections - getUserSchemaFileCollections
|
|
1986
2871
|
*
|
|
1987
|
-
*
|
|
2872
|
+
* Get all file collections for the current user within a specific schema.
|
|
2873
|
+
*
|
|
2874
|
+
* Collections help organize files into logical groups (e.g., "Contracts", "Invoices").
|
|
2875
|
+
* User collections are private to the creating user.
|
|
2876
|
+
*
|
|
1988
2877
|
*/
|
|
1989
2878
|
'get'(
|
|
1990
2879
|
parameters?: Parameters<Paths.GetUserSchemaFileCollections.PathParameters> | null,
|
|
@@ -1994,7 +2883,10 @@ export interface PathsDictionary {
|
|
|
1994
2883
|
/**
|
|
1995
2884
|
* createUserSchemaFileCollection - createUserSchemaFileCollection
|
|
1996
2885
|
*
|
|
1997
|
-
*
|
|
2886
|
+
* Create a new file collection for the current user within a specific schema.
|
|
2887
|
+
*
|
|
2888
|
+
* The collection will be private to the creating user and associated with the specified schema.
|
|
2889
|
+
*
|
|
1998
2890
|
*/
|
|
1999
2891
|
'post'(
|
|
2000
2892
|
parameters?: Parameters<Paths.CreateUserSchemaFileCollection.PathParameters> | null,
|
|
@@ -2006,7 +2898,10 @@ export interface PathsDictionary {
|
|
|
2006
2898
|
/**
|
|
2007
2899
|
* updateUserSchemaFileCollection - updateUserSchemaFileCollection
|
|
2008
2900
|
*
|
|
2009
|
-
*
|
|
2901
|
+
* Update an existing file collection.
|
|
2902
|
+
*
|
|
2903
|
+
* You can update the name, parent relationships, starred status, and enabled locations/purposes.
|
|
2904
|
+
*
|
|
2010
2905
|
*/
|
|
2011
2906
|
'put'(
|
|
2012
2907
|
parameters?: Parameters<Paths.UpdateUserSchemaFileCollection.PathParameters> | null,
|
|
@@ -2016,7 +2911,11 @@ export interface PathsDictionary {
|
|
|
2016
2911
|
/**
|
|
2017
2912
|
* deleteUserSchemaFileCollection - deleteUserSchemaFileCollection
|
|
2018
2913
|
*
|
|
2019
|
-
*
|
|
2914
|
+
* Delete a file collection.
|
|
2915
|
+
*
|
|
2916
|
+
* **Note:** Deleting a collection does not delete the files within it.
|
|
2917
|
+
* Files will remain but will no longer be associated with this collection.
|
|
2918
|
+
*
|
|
2020
2919
|
*/
|
|
2021
2920
|
'delete'(
|
|
2022
2921
|
parameters?: Parameters<Paths.DeleteUserSchemaFileCollection.PathParameters> | null,
|
|
@@ -2028,7 +2927,11 @@ export interface PathsDictionary {
|
|
|
2028
2927
|
/**
|
|
2029
2928
|
* getFilesInCollection - getFilesInCollection
|
|
2030
2929
|
*
|
|
2031
|
-
*
|
|
2930
|
+
* Get all files within a specific collection for an entity.
|
|
2931
|
+
*
|
|
2932
|
+
* The schema is automatically derived from the entity. This endpoint requires
|
|
2933
|
+
* view permission on the parent entity to access its files.
|
|
2934
|
+
*
|
|
2032
2935
|
*/
|
|
2033
2936
|
'get'(
|
|
2034
2937
|
parameters?: Parameters<Paths.GetFilesInCollection.PathParameters> | null,
|
|
@@ -2040,7 +2943,11 @@ export interface PathsDictionary {
|
|
|
2040
2943
|
/**
|
|
2041
2944
|
* getGlobalFileCollections - getGlobalFileCollections
|
|
2042
2945
|
*
|
|
2043
|
-
*
|
|
2946
|
+
* Get all global file collections for a specific schema.
|
|
2947
|
+
*
|
|
2948
|
+
* Global collections are shared across all users in the organization for the specified schema.
|
|
2949
|
+
* Unlike user collections, these are visible to everyone with access to entities of that schema.
|
|
2950
|
+
*
|
|
2044
2951
|
*/
|
|
2045
2952
|
'get'(
|
|
2046
2953
|
parameters?: Parameters<Paths.GetGlobalFileCollections.PathParameters> | null,
|
|
@@ -2056,6 +2963,7 @@ export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
|
2056
2963
|
export type ActivityId = Components.Schemas.ActivityId;
|
|
2057
2964
|
export type BaseEntityAcl = Components.Schemas.BaseEntityAcl;
|
|
2058
2965
|
export type BaseEntityOwner = Components.Schemas.BaseEntityOwner;
|
|
2966
|
+
export type BatchSaveFileVersionPayload = Components.Schemas.BatchSaveFileVersionPayload;
|
|
2059
2967
|
export type CommonSaveFilePayload = Components.Schemas.CommonSaveFilePayload;
|
|
2060
2968
|
export type CustomDownloadUrl = Components.Schemas.CustomDownloadUrl;
|
|
2061
2969
|
export type DownloadFilesPayload = Components.Schemas.DownloadFilesPayload;
|