frameio 4.2.2 → 4.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +30 -30
- package/dist/cjs/Client.js +38 -38
- package/dist/cjs/api/resources/collections/client/Client.d.ts +17 -17
- package/dist/cjs/api/resources/collections/client/Client.js +30 -30
- package/dist/cjs/api/resources/files/client/Client.d.ts +96 -96
- package/dist/cjs/api/resources/files/client/Client.js +175 -175
- package/dist/cjs/api/resources/folders/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/folders/client/Client.js +29 -29
- package/dist/cjs/api/resources/metadata/client/Client.d.ts +27 -27
- package/dist/cjs/api/resources/metadata/client/Client.js +50 -50
- package/dist/cjs/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.ts +4 -4
- package/dist/cjs/api/resources/projectPermissions/client/Client.d.ts +24 -24
- package/dist/cjs/api/resources/projectPermissions/client/Client.js +87 -87
- package/dist/cjs/api/resources/projects/client/Client.d.ts +56 -0
- package/dist/cjs/api/resources/projects/client/Client.js +166 -0
- package/dist/cjs/api/resources/projects/client/requests/AccountProjectsIndexRequest.d.ts +24 -0
- package/dist/cjs/api/resources/projects/client/requests/AccountProjectsIndexRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/InvitedProjectsIndexRequest.d.ts +24 -0
- package/dist/cjs/api/resources/projects/client/requests/InvitedProjectsIndexRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/projects/types/AccountProjectsIndexRequestSort.d.ts +8 -0
- package/dist/cjs/api/resources/projects/types/AccountProjectsIndexRequestSort.js +11 -0
- package/dist/cjs/api/resources/projects/types/InvitedProjectsIndexRequestSort.d.ts +8 -0
- package/dist/cjs/api/resources/projects/types/InvitedProjectsIndexRequestSort.js +11 -0
- package/dist/cjs/api/resources/projects/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/projects/types/index.js +2 -0
- package/dist/cjs/api/resources/shares/client/Client.d.ts +49 -49
- package/dist/cjs/api/resources/shares/client/Client.js +146 -146
- package/dist/cjs/api/resources/shares/client/requests/AddAssetParams.d.ts +1 -1
- package/dist/cjs/api/resources/shares/client/requests/CreateShareParams.d.ts +2 -2
- package/dist/cjs/api/resources/shares/client/requests/UpdateShareParams.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/client/Client.d.ts +64 -64
- package/dist/cjs/api/resources/versionStacks/client/Client.js +121 -121
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts +1 -1
- package/dist/cjs/api/resources/workspacePermissions/client/Client.d.ts +24 -24
- package/dist/cjs/api/resources/workspacePermissions/client/Client.js +87 -87
- package/dist/cjs/api/resources/workspaces/client/Client.d.ts +34 -34
- package/dist/cjs/api/resources/workspaces/client/Client.js +141 -141
- package/dist/cjs/api/types/AuditLogwithIncludes.d.ts +6 -0
- package/dist/cjs/api/types/AuditLogwithIncludes.js +6 -0
- package/dist/cjs/api/types/Filters.d.ts +6 -0
- package/dist/cjs/api/types/Filters.js +6 -0
- package/dist/cjs/api/types/LongTextDefinition.d.ts +0 -16
- package/dist/cjs/api/types/LongTextDefinition.js +0 -17
- package/dist/cjs/api/types/NumberDefinition.d.ts +16 -0
- package/dist/cjs/api/types/NumberDefinition.js +13 -0
- package/dist/cjs/api/types/TextDefinition.d.ts +0 -16
- package/dist/cjs/api/types/TextDefinition.js +0 -17
- package/dist/cjs/api/types/ToggleDefinition.d.ts +16 -0
- package/dist/cjs/api/types/ToggleDefinition.js +17 -0
- package/dist/cjs/api/types/UserSingleDefinition.d.ts +0 -16
- package/dist/cjs/api/types/UserSingleDefinition.js +0 -13
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +30 -30
- package/dist/esm/Client.mjs +38 -38
- package/dist/esm/api/resources/collections/client/Client.d.mts +17 -17
- package/dist/esm/api/resources/collections/client/Client.mjs +30 -30
- package/dist/esm/api/resources/files/client/Client.d.mts +96 -96
- package/dist/esm/api/resources/files/client/Client.mjs +175 -175
- package/dist/esm/api/resources/folders/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/folders/client/Client.mjs +29 -29
- package/dist/esm/api/resources/metadata/client/Client.d.mts +27 -27
- package/dist/esm/api/resources/metadata/client/Client.mjs +50 -50
- package/dist/esm/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.mts +4 -4
- package/dist/esm/api/resources/projectPermissions/client/Client.d.mts +24 -24
- package/dist/esm/api/resources/projectPermissions/client/Client.mjs +87 -87
- package/dist/esm/api/resources/projects/client/Client.d.mts +56 -0
- package/dist/esm/api/resources/projects/client/Client.mjs +166 -0
- package/dist/esm/api/resources/projects/client/requests/AccountProjectsIndexRequest.d.mts +24 -0
- package/dist/esm/api/resources/projects/client/requests/AccountProjectsIndexRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/InvitedProjectsIndexRequest.d.mts +24 -0
- package/dist/esm/api/resources/projects/client/requests/InvitedProjectsIndexRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/projects/types/AccountProjectsIndexRequestSort.d.mts +8 -0
- package/dist/esm/api/resources/projects/types/AccountProjectsIndexRequestSort.mjs +8 -0
- package/dist/esm/api/resources/projects/types/InvitedProjectsIndexRequestSort.d.mts +8 -0
- package/dist/esm/api/resources/projects/types/InvitedProjectsIndexRequestSort.mjs +8 -0
- package/dist/esm/api/resources/projects/types/index.d.mts +2 -0
- package/dist/esm/api/resources/projects/types/index.mjs +2 -0
- package/dist/esm/api/resources/shares/client/Client.d.mts +49 -49
- package/dist/esm/api/resources/shares/client/Client.mjs +146 -146
- package/dist/esm/api/resources/shares/client/requests/AddAssetParams.d.mts +1 -1
- package/dist/esm/api/resources/shares/client/requests/CreateShareParams.d.mts +2 -2
- package/dist/esm/api/resources/shares/client/requests/UpdateShareParams.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/client/Client.d.mts +64 -64
- package/dist/esm/api/resources/versionStacks/client/Client.mjs +121 -121
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.mts +1 -1
- package/dist/esm/api/resources/workspacePermissions/client/Client.d.mts +24 -24
- package/dist/esm/api/resources/workspacePermissions/client/Client.mjs +87 -87
- package/dist/esm/api/resources/workspaces/client/Client.d.mts +34 -34
- package/dist/esm/api/resources/workspaces/client/Client.mjs +141 -141
- package/dist/esm/api/types/AuditLogwithIncludes.d.mts +6 -0
- package/dist/esm/api/types/AuditLogwithIncludes.mjs +6 -0
- package/dist/esm/api/types/Filters.d.mts +6 -0
- package/dist/esm/api/types/Filters.mjs +6 -0
- package/dist/esm/api/types/LongTextDefinition.d.mts +0 -16
- package/dist/esm/api/types/LongTextDefinition.mjs +1 -16
- package/dist/esm/api/types/NumberDefinition.d.mts +16 -0
- package/dist/esm/api/types/NumberDefinition.mjs +13 -0
- package/dist/esm/api/types/TextDefinition.d.mts +0 -16
- package/dist/esm/api/types/TextDefinition.mjs +1 -16
- package/dist/esm/api/types/ToggleDefinition.d.mts +16 -0
- package/dist/esm/api/types/ToggleDefinition.mjs +16 -1
- package/dist/esm/api/types/UserSingleDefinition.d.mts +0 -16
- package/dist/esm/api/types/UserSingleDefinition.mjs +0 -13
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +112 -112
- package/reference.md +1392 -1234
|
@@ -70,11 +70,11 @@ class FilesClient {
|
|
|
70
70
|
this._options = (0, BaseClient_js_1.normalizeClientOptionsWithAuth)(options);
|
|
71
71
|
}
|
|
72
72
|
/**
|
|
73
|
-
*
|
|
73
|
+
* Create new file under parent folder through remote upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
74
74
|
*
|
|
75
75
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
76
76
|
* @param {Frameio.FrameOrAdobeId} folder_id
|
|
77
|
-
* @param {Frameio.
|
|
77
|
+
* @param {Frameio.FileCreateRemoteUploadParams} request
|
|
78
78
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -86,35 +86,29 @@ class FilesClient {
|
|
|
86
86
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
87
87
|
*
|
|
88
88
|
* @example
|
|
89
|
-
* await client.files.
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
* include_total_count: false
|
|
89
|
+
* await client.files.createRemoteUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
90
|
+
* data: {
|
|
91
|
+
* name: "asset.png",
|
|
92
|
+
* source_url: "https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png"
|
|
93
|
+
* }
|
|
95
94
|
* })
|
|
96
95
|
*/
|
|
97
|
-
|
|
98
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
96
|
+
createRemoteUpload(account_id, folder_id, request, requestOptions) {
|
|
97
|
+
return core.HttpResponsePromise.fromPromise(this.__createRemoteUpload(account_id, folder_id, request, requestOptions));
|
|
99
98
|
}
|
|
100
|
-
|
|
101
|
-
return __awaiter(this,
|
|
99
|
+
__createRemoteUpload(account_id, folder_id, request, requestOptions) {
|
|
100
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
102
101
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
103
|
-
const { include, sort, after, page_size: pageSize, include_total_count: includeTotalCount } = request;
|
|
104
|
-
const _queryParams = {
|
|
105
|
-
include: include != null ? include : undefined,
|
|
106
|
-
sort: sort != null ? sort : undefined,
|
|
107
|
-
after,
|
|
108
|
-
page_size: pageSize,
|
|
109
|
-
include_total_count: includeTotalCount,
|
|
110
|
-
};
|
|
111
102
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
112
103
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
113
104
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
114
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/files`),
|
|
115
|
-
method: "
|
|
105
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/files/remote_upload`),
|
|
106
|
+
method: "POST",
|
|
116
107
|
headers: _headers,
|
|
117
|
-
|
|
108
|
+
contentType: "application/json",
|
|
109
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
110
|
+
requestType: "json",
|
|
111
|
+
body: request,
|
|
118
112
|
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
|
|
119
113
|
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
120
114
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -122,10 +116,7 @@ class FilesClient {
|
|
|
122
116
|
logging: this._options.logging,
|
|
123
117
|
});
|
|
124
118
|
if (_response.ok) {
|
|
125
|
-
return {
|
|
126
|
-
data: _response.body,
|
|
127
|
-
rawResponse: _response.rawResponse,
|
|
128
|
-
};
|
|
119
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
129
120
|
}
|
|
130
121
|
if (_response.error.reason === "status-code") {
|
|
131
122
|
switch (_response.error.statusCode) {
|
|
@@ -151,17 +142,15 @@ class FilesClient {
|
|
|
151
142
|
});
|
|
152
143
|
}
|
|
153
144
|
}
|
|
154
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "
|
|
145
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files/remote_upload");
|
|
155
146
|
});
|
|
156
147
|
}
|
|
157
148
|
/**
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
* Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
149
|
+
* Create new file under parent folder through local upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
161
150
|
*
|
|
162
151
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
163
152
|
* @param {Frameio.FrameOrAdobeId} folder_id
|
|
164
|
-
* @param {Frameio.
|
|
153
|
+
* @param {Frameio.FileCreateLocalUploadParams} request
|
|
165
154
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
166
155
|
*
|
|
167
156
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -173,24 +162,23 @@ class FilesClient {
|
|
|
173
162
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
174
163
|
*
|
|
175
164
|
* @example
|
|
176
|
-
* await client.files.
|
|
165
|
+
* await client.files.createLocalUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
177
166
|
* data: {
|
|
178
167
|
* file_size: 1137444,
|
|
179
|
-
* media_type: "image/png",
|
|
180
168
|
* name: "asset.png"
|
|
181
169
|
* }
|
|
182
170
|
* })
|
|
183
171
|
*/
|
|
184
|
-
|
|
185
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
172
|
+
createLocalUpload(account_id, folder_id, request, requestOptions) {
|
|
173
|
+
return core.HttpResponsePromise.fromPromise(this.__createLocalUpload(account_id, folder_id, request, requestOptions));
|
|
186
174
|
}
|
|
187
|
-
|
|
175
|
+
__createLocalUpload(account_id, folder_id, request, requestOptions) {
|
|
188
176
|
return __awaiter(this, void 0, void 0, function* () {
|
|
189
177
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
190
178
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
191
179
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
192
180
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
193
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/files`),
|
|
181
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/files/local_upload`),
|
|
194
182
|
method: "POST",
|
|
195
183
|
headers: _headers,
|
|
196
184
|
contentType: "application/json",
|
|
@@ -230,27 +218,14 @@ class FilesClient {
|
|
|
230
218
|
});
|
|
231
219
|
}
|
|
232
220
|
}
|
|
233
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files");
|
|
221
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files/local_upload");
|
|
234
222
|
});
|
|
235
223
|
}
|
|
236
224
|
/**
|
|
237
|
-
* Show file details.
|
|
238
|
-
* <br/>
|
|
239
|
-
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
240
|
-
* <br/>
|
|
241
|
-
* Note: if you include `media_links.original` and the user does not have permission to download the file
|
|
242
|
-
* then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
|
|
243
|
-
* watermarking is required for this user and isn't supported by the requested media_links, then the request will
|
|
244
|
-
* succeed but the unsupported media links will be set to null.
|
|
245
|
-
* Similarly, if a requested transcode link does not exist for a particular file (e.g. including
|
|
246
|
-
* `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
|
|
247
|
-
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
|
|
248
|
-
* the response payload. In short, the client must handle null media links gracefully.
|
|
249
|
-
* <br/>Rate Limits: 10 calls per 1 second(s) per account_user
|
|
225
|
+
* Show file upload status details. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
250
226
|
*
|
|
251
227
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
252
228
|
* @param {Frameio.FrameOrAdobeId} file_id
|
|
253
|
-
* @param {Frameio.FilesShowRequest} request
|
|
254
229
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
255
230
|
*
|
|
256
231
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -262,27 +237,21 @@ class FilesClient {
|
|
|
262
237
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
263
238
|
*
|
|
264
239
|
* @example
|
|
265
|
-
* await client.files.
|
|
266
|
-
* include: "media_links.original"
|
|
267
|
-
* })
|
|
240
|
+
* await client.files.showFileUploadStatus("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
|
|
268
241
|
*/
|
|
269
|
-
|
|
270
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
242
|
+
showFileUploadStatus(account_id, file_id, requestOptions) {
|
|
243
|
+
return core.HttpResponsePromise.fromPromise(this.__showFileUploadStatus(account_id, file_id, requestOptions));
|
|
271
244
|
}
|
|
272
|
-
|
|
273
|
-
return __awaiter(this,
|
|
245
|
+
__showFileUploadStatus(account_id, file_id, requestOptions) {
|
|
246
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
274
247
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
275
|
-
const { include } = request;
|
|
276
|
-
const _queryParams = {
|
|
277
|
-
include: include != null ? include : undefined,
|
|
278
|
-
};
|
|
279
248
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
280
249
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
281
250
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
282
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/files/${core.url.encodePathParam(file_id)}`),
|
|
251
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/files/${core.url.encodePathParam(file_id)}/status`),
|
|
283
252
|
method: "GET",
|
|
284
253
|
headers: _headers,
|
|
285
|
-
queryParameters:
|
|
254
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
286
255
|
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
|
|
287
256
|
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
288
257
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -316,14 +285,15 @@ class FilesClient {
|
|
|
316
285
|
});
|
|
317
286
|
}
|
|
318
287
|
}
|
|
319
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/files/{file_id}");
|
|
288
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/files/{file_id}/status");
|
|
320
289
|
});
|
|
321
290
|
}
|
|
322
291
|
/**
|
|
323
|
-
*
|
|
292
|
+
* Move file to a folder or version_stack. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
324
293
|
*
|
|
325
294
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
326
295
|
* @param {Frameio.FrameOrAdobeId} file_id
|
|
296
|
+
* @param {Frameio.FileMoveParams} request
|
|
327
297
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
328
298
|
*
|
|
329
299
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -335,21 +305,28 @@ class FilesClient {
|
|
|
335
305
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
336
306
|
*
|
|
337
307
|
* @example
|
|
338
|
-
* await client.files.
|
|
308
|
+
* await client.files.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
309
|
+
* data: {
|
|
310
|
+
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
311
|
+
* }
|
|
312
|
+
* })
|
|
339
313
|
*/
|
|
340
|
-
|
|
341
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
314
|
+
move(account_id, file_id, request, requestOptions) {
|
|
315
|
+
return core.HttpResponsePromise.fromPromise(this.__move(account_id, file_id, request, requestOptions));
|
|
342
316
|
}
|
|
343
|
-
|
|
317
|
+
__move(account_id, file_id, request, requestOptions) {
|
|
344
318
|
return __awaiter(this, void 0, void 0, function* () {
|
|
345
319
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
346
320
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
347
321
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
348
322
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
349
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/files/${core.url.encodePathParam(file_id)}`),
|
|
350
|
-
method: "
|
|
323
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/files/${core.url.encodePathParam(file_id)}/move`),
|
|
324
|
+
method: "PATCH",
|
|
351
325
|
headers: _headers,
|
|
326
|
+
contentType: "application/json",
|
|
352
327
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
328
|
+
requestType: "json",
|
|
329
|
+
body: request,
|
|
353
330
|
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
|
|
354
331
|
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
355
332
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -357,7 +334,7 @@ class FilesClient {
|
|
|
357
334
|
logging: this._options.logging,
|
|
358
335
|
});
|
|
359
336
|
if (_response.ok) {
|
|
360
|
-
return { data:
|
|
337
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
361
338
|
}
|
|
362
339
|
if (_response.error.reason === "status-code") {
|
|
363
340
|
switch (_response.error.statusCode) {
|
|
@@ -383,15 +360,15 @@ class FilesClient {
|
|
|
383
360
|
});
|
|
384
361
|
}
|
|
385
362
|
}
|
|
386
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "
|
|
363
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/v4/accounts/{account_id}/files/{file_id}/move");
|
|
387
364
|
});
|
|
388
365
|
}
|
|
389
366
|
/**
|
|
390
|
-
*
|
|
367
|
+
* Import a file from a storage location configured on the account. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
391
368
|
*
|
|
392
369
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
393
|
-
* @param {Frameio.FrameOrAdobeId}
|
|
394
|
-
* @param {Frameio.
|
|
370
|
+
* @param {Frameio.FrameOrAdobeId} folder_id
|
|
371
|
+
* @param {Frameio.FileImportParams} request
|
|
395
372
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
396
373
|
*
|
|
397
374
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -403,23 +380,25 @@ class FilesClient {
|
|
|
403
380
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
404
381
|
*
|
|
405
382
|
* @example
|
|
406
|
-
* await client.files.
|
|
383
|
+
* await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
407
384
|
* data: {
|
|
408
|
-
*
|
|
385
|
+
* key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
|
|
386
|
+
* name: "asset.png",
|
|
387
|
+
* storage_location: "123e4567-e89b-12d3-a456-426614174000"
|
|
409
388
|
* }
|
|
410
389
|
* })
|
|
411
390
|
*/
|
|
412
|
-
|
|
413
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
391
|
+
importFile(account_id, folder_id, request, requestOptions) {
|
|
392
|
+
return core.HttpResponsePromise.fromPromise(this.__importFile(account_id, folder_id, request, requestOptions));
|
|
414
393
|
}
|
|
415
|
-
|
|
394
|
+
__importFile(account_id, folder_id, request, requestOptions) {
|
|
416
395
|
return __awaiter(this, void 0, void 0, function* () {
|
|
417
396
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
418
397
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
419
398
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
420
399
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
421
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/
|
|
422
|
-
method: "
|
|
400
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/files/import`),
|
|
401
|
+
method: "POST",
|
|
423
402
|
headers: _headers,
|
|
424
403
|
contentType: "application/json",
|
|
425
404
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -458,15 +437,27 @@ class FilesClient {
|
|
|
458
437
|
});
|
|
459
438
|
}
|
|
460
439
|
}
|
|
461
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "
|
|
440
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files/import");
|
|
462
441
|
});
|
|
463
442
|
}
|
|
464
443
|
/**
|
|
465
|
-
*
|
|
444
|
+
* Show file details.
|
|
445
|
+
* <br/>
|
|
446
|
+
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
447
|
+
* <br/>
|
|
448
|
+
* Note: if you include `media_links.original` and the user does not have permission to download the file
|
|
449
|
+
* then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
|
|
450
|
+
* watermarking is required for this user and isn't supported by the requested media_links, then the request will
|
|
451
|
+
* succeed but the unsupported media links will be set to null.
|
|
452
|
+
* Similarly, if a requested transcode link does not exist for a particular file (e.g. including
|
|
453
|
+
* `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
|
|
454
|
+
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
|
|
455
|
+
* the response payload. In short, the client must handle null media links gracefully.
|
|
456
|
+
* <br/>Rate Limits: 10 calls per 1 second(s) per account_user
|
|
466
457
|
*
|
|
467
458
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
468
459
|
* @param {Frameio.FrameOrAdobeId} file_id
|
|
469
|
-
* @param {Frameio.
|
|
460
|
+
* @param {Frameio.FilesShowRequest} request
|
|
470
461
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
471
462
|
*
|
|
472
463
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -478,35 +469,27 @@ class FilesClient {
|
|
|
478
469
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
479
470
|
*
|
|
480
471
|
* @example
|
|
481
|
-
* await client.files.
|
|
482
|
-
*
|
|
483
|
-
* copy_comments: "none",
|
|
484
|
-
* data: {
|
|
485
|
-
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
486
|
-
* }
|
|
472
|
+
* await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
473
|
+
* include: "media_links.original"
|
|
487
474
|
* })
|
|
488
475
|
*/
|
|
489
|
-
|
|
490
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
476
|
+
show(account_id, file_id, request = {}, requestOptions) {
|
|
477
|
+
return core.HttpResponsePromise.fromPromise(this.__show(account_id, file_id, request, requestOptions));
|
|
491
478
|
}
|
|
492
|
-
|
|
479
|
+
__show(account_id_1, file_id_1) {
|
|
493
480
|
return __awaiter(this, arguments, void 0, function* (account_id, file_id, request = {}, requestOptions) {
|
|
494
481
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
495
|
-
const {
|
|
482
|
+
const { include } = request;
|
|
496
483
|
const _queryParams = {
|
|
497
|
-
|
|
498
|
-
copy_comments: copyComments != null ? copyComments : undefined,
|
|
484
|
+
include: include != null ? include : undefined,
|
|
499
485
|
};
|
|
500
486
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
501
487
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
502
488
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
503
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/files/${core.url.encodePathParam(file_id)}
|
|
504
|
-
method: "
|
|
489
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/files/${core.url.encodePathParam(file_id)}`),
|
|
490
|
+
method: "GET",
|
|
505
491
|
headers: _headers,
|
|
506
|
-
contentType: "application/json",
|
|
507
492
|
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
508
|
-
requestType: "json",
|
|
509
|
-
body: _body,
|
|
510
493
|
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
|
|
511
494
|
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
512
495
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -540,15 +523,14 @@ class FilesClient {
|
|
|
540
523
|
});
|
|
541
524
|
}
|
|
542
525
|
}
|
|
543
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "
|
|
526
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/files/{file_id}");
|
|
544
527
|
});
|
|
545
528
|
}
|
|
546
529
|
/**
|
|
547
|
-
*
|
|
530
|
+
* Delete file by ID. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
548
531
|
*
|
|
549
532
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
550
|
-
* @param {Frameio.FrameOrAdobeId}
|
|
551
|
-
* @param {Frameio.FileCreateRemoteUploadParams} request
|
|
533
|
+
* @param {Frameio.FrameOrAdobeId} file_id
|
|
552
534
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
553
535
|
*
|
|
554
536
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -560,29 +542,21 @@ class FilesClient {
|
|
|
560
542
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
561
543
|
*
|
|
562
544
|
* @example
|
|
563
|
-
* await client.files.
|
|
564
|
-
* data: {
|
|
565
|
-
* name: "asset.png",
|
|
566
|
-
* source_url: "https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png"
|
|
567
|
-
* }
|
|
568
|
-
* })
|
|
545
|
+
* await client.files.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
|
|
569
546
|
*/
|
|
570
|
-
|
|
571
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
547
|
+
delete(account_id, file_id, requestOptions) {
|
|
548
|
+
return core.HttpResponsePromise.fromPromise(this.__delete(account_id, file_id, requestOptions));
|
|
572
549
|
}
|
|
573
|
-
|
|
550
|
+
__delete(account_id, file_id, requestOptions) {
|
|
574
551
|
return __awaiter(this, void 0, void 0, function* () {
|
|
575
552
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
576
553
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
577
554
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
578
555
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
579
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/
|
|
580
|
-
method: "
|
|
556
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/files/${core.url.encodePathParam(file_id)}`),
|
|
557
|
+
method: "DELETE",
|
|
581
558
|
headers: _headers,
|
|
582
|
-
contentType: "application/json",
|
|
583
559
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
584
|
-
requestType: "json",
|
|
585
|
-
body: request,
|
|
586
560
|
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
|
|
587
561
|
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
588
562
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -590,7 +564,7 @@ class FilesClient {
|
|
|
590
564
|
logging: this._options.logging,
|
|
591
565
|
});
|
|
592
566
|
if (_response.ok) {
|
|
593
|
-
return { data:
|
|
567
|
+
return { data: undefined, rawResponse: _response.rawResponse };
|
|
594
568
|
}
|
|
595
569
|
if (_response.error.reason === "status-code") {
|
|
596
570
|
switch (_response.error.statusCode) {
|
|
@@ -616,15 +590,15 @@ class FilesClient {
|
|
|
616
590
|
});
|
|
617
591
|
}
|
|
618
592
|
}
|
|
619
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "
|
|
593
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "DELETE", "/v4/accounts/{account_id}/files/{file_id}");
|
|
620
594
|
});
|
|
621
595
|
}
|
|
622
596
|
/**
|
|
623
|
-
*
|
|
597
|
+
* Update file details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
624
598
|
*
|
|
625
599
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
626
600
|
* @param {Frameio.FrameOrAdobeId} file_id
|
|
627
|
-
* @param {Frameio.
|
|
601
|
+
* @param {Frameio.FileUpdateParams} request
|
|
628
602
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
629
603
|
*
|
|
630
604
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -636,22 +610,22 @@ class FilesClient {
|
|
|
636
610
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
637
611
|
*
|
|
638
612
|
* @example
|
|
639
|
-
* await client.files.
|
|
613
|
+
* await client.files.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
640
614
|
* data: {
|
|
641
|
-
*
|
|
615
|
+
* name: "asset.png"
|
|
642
616
|
* }
|
|
643
617
|
* })
|
|
644
618
|
*/
|
|
645
|
-
|
|
646
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
619
|
+
update(account_id, file_id, request, requestOptions) {
|
|
620
|
+
return core.HttpResponsePromise.fromPromise(this.__update(account_id, file_id, request, requestOptions));
|
|
647
621
|
}
|
|
648
|
-
|
|
622
|
+
__update(account_id, file_id, request, requestOptions) {
|
|
649
623
|
return __awaiter(this, void 0, void 0, function* () {
|
|
650
624
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
651
625
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
652
626
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
653
627
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
654
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/files/${core.url.encodePathParam(file_id)}
|
|
628
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/files/${core.url.encodePathParam(file_id)}`),
|
|
655
629
|
method: "PATCH",
|
|
656
630
|
headers: _headers,
|
|
657
631
|
contentType: "application/json",
|
|
@@ -691,15 +665,15 @@ class FilesClient {
|
|
|
691
665
|
});
|
|
692
666
|
}
|
|
693
667
|
}
|
|
694
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/v4/accounts/{account_id}/files/{file_id}
|
|
668
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "PATCH", "/v4/accounts/{account_id}/files/{file_id}");
|
|
695
669
|
});
|
|
696
670
|
}
|
|
697
671
|
/**
|
|
698
|
-
*
|
|
672
|
+
* List files in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
699
673
|
*
|
|
700
674
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
701
675
|
* @param {Frameio.FrameOrAdobeId} folder_id
|
|
702
|
-
* @param {Frameio.
|
|
676
|
+
* @param {Frameio.FilesListRequest} request
|
|
703
677
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
704
678
|
*
|
|
705
679
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -711,29 +685,35 @@ class FilesClient {
|
|
|
711
685
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
712
686
|
*
|
|
713
687
|
* @example
|
|
714
|
-
* await client.files.
|
|
715
|
-
*
|
|
716
|
-
*
|
|
717
|
-
*
|
|
718
|
-
*
|
|
688
|
+
* await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
689
|
+
* include: "media_links.original",
|
|
690
|
+
* sort: "name_asc",
|
|
691
|
+
* after: "<opaque_cursor>",
|
|
692
|
+
* page_size: 10,
|
|
693
|
+
* include_total_count: false
|
|
719
694
|
* })
|
|
720
695
|
*/
|
|
721
|
-
|
|
722
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
696
|
+
list(account_id, folder_id, request = {}, requestOptions) {
|
|
697
|
+
return core.HttpResponsePromise.fromPromise(this.__list(account_id, folder_id, request, requestOptions));
|
|
723
698
|
}
|
|
724
|
-
|
|
725
|
-
return __awaiter(this,
|
|
699
|
+
__list(account_id_1, folder_id_1) {
|
|
700
|
+
return __awaiter(this, arguments, void 0, function* (account_id, folder_id, request = {}, requestOptions) {
|
|
726
701
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
702
|
+
const { include, sort, after, page_size: pageSize, include_total_count: includeTotalCount } = request;
|
|
703
|
+
const _queryParams = {
|
|
704
|
+
include: include != null ? include : undefined,
|
|
705
|
+
sort: sort != null ? sort : undefined,
|
|
706
|
+
after,
|
|
707
|
+
page_size: pageSize,
|
|
708
|
+
include_total_count: includeTotalCount,
|
|
709
|
+
};
|
|
727
710
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
728
711
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
729
712
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
730
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/files
|
|
731
|
-
method: "
|
|
713
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/files`),
|
|
714
|
+
method: "GET",
|
|
732
715
|
headers: _headers,
|
|
733
|
-
|
|
734
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
735
|
-
requestType: "json",
|
|
736
|
-
body: request,
|
|
716
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
737
717
|
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
|
|
738
718
|
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
739
719
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -741,7 +721,10 @@ class FilesClient {
|
|
|
741
721
|
logging: this._options.logging,
|
|
742
722
|
});
|
|
743
723
|
if (_response.ok) {
|
|
744
|
-
return {
|
|
724
|
+
return {
|
|
725
|
+
data: _response.body,
|
|
726
|
+
rawResponse: _response.rawResponse,
|
|
727
|
+
};
|
|
745
728
|
}
|
|
746
729
|
if (_response.error.reason === "status-code") {
|
|
747
730
|
switch (_response.error.statusCode) {
|
|
@@ -767,15 +750,17 @@ class FilesClient {
|
|
|
767
750
|
});
|
|
768
751
|
}
|
|
769
752
|
}
|
|
770
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "
|
|
753
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/folders/{folder_id}/files");
|
|
771
754
|
});
|
|
772
755
|
}
|
|
773
756
|
/**
|
|
774
|
-
*
|
|
757
|
+
* @deprecated
|
|
758
|
+
*
|
|
759
|
+
* Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
775
760
|
*
|
|
776
761
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
777
762
|
* @param {Frameio.FrameOrAdobeId} folder_id
|
|
778
|
-
* @param {Frameio.
|
|
763
|
+
* @param {Frameio.FileCreateParams} request
|
|
779
764
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
780
765
|
*
|
|
781
766
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -787,24 +772,24 @@ class FilesClient {
|
|
|
787
772
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
788
773
|
*
|
|
789
774
|
* @example
|
|
790
|
-
* await client.files.
|
|
775
|
+
* await client.files.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
791
776
|
* data: {
|
|
792
|
-
*
|
|
793
|
-
*
|
|
794
|
-
*
|
|
777
|
+
* file_size: 1137444,
|
|
778
|
+
* media_type: "image/png",
|
|
779
|
+
* name: "asset.png"
|
|
795
780
|
* }
|
|
796
781
|
* })
|
|
797
782
|
*/
|
|
798
|
-
|
|
799
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
783
|
+
create(account_id, folder_id, request, requestOptions) {
|
|
784
|
+
return core.HttpResponsePromise.fromPromise(this.__create(account_id, folder_id, request, requestOptions));
|
|
800
785
|
}
|
|
801
|
-
|
|
786
|
+
__create(account_id, folder_id, request, requestOptions) {
|
|
802
787
|
return __awaiter(this, void 0, void 0, function* () {
|
|
803
788
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
804
789
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
805
790
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
806
791
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
807
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/files
|
|
792
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/folders/${core.url.encodePathParam(folder_id)}/files`),
|
|
808
793
|
method: "POST",
|
|
809
794
|
headers: _headers,
|
|
810
795
|
contentType: "application/json",
|
|
@@ -844,14 +829,15 @@ class FilesClient {
|
|
|
844
829
|
});
|
|
845
830
|
}
|
|
846
831
|
}
|
|
847
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files
|
|
832
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files");
|
|
848
833
|
});
|
|
849
834
|
}
|
|
850
835
|
/**
|
|
851
|
-
*
|
|
836
|
+
* Copy file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
852
837
|
*
|
|
853
838
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
854
839
|
* @param {Frameio.FrameOrAdobeId} file_id
|
|
840
|
+
* @param {Frameio.FileCopyParams} request
|
|
855
841
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
856
842
|
*
|
|
857
843
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -863,21 +849,35 @@ class FilesClient {
|
|
|
863
849
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
864
850
|
*
|
|
865
851
|
* @example
|
|
866
|
-
* await client.files.
|
|
852
|
+
* await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
853
|
+
* copy_metadata: true,
|
|
854
|
+
* copy_comments: "none",
|
|
855
|
+
* data: {
|
|
856
|
+
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
857
|
+
* }
|
|
858
|
+
* })
|
|
867
859
|
*/
|
|
868
|
-
|
|
869
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
860
|
+
copy(account_id, file_id, request = {}, requestOptions) {
|
|
861
|
+
return core.HttpResponsePromise.fromPromise(this.__copy(account_id, file_id, request, requestOptions));
|
|
870
862
|
}
|
|
871
|
-
|
|
872
|
-
return __awaiter(this,
|
|
863
|
+
__copy(account_id_1, file_id_1) {
|
|
864
|
+
return __awaiter(this, arguments, void 0, function* (account_id, file_id, request = {}, requestOptions) {
|
|
873
865
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
866
|
+
const { copy_metadata: copyMetadata, copy_comments: copyComments } = request, _body = __rest(request, ["copy_metadata", "copy_comments"]);
|
|
867
|
+
const _queryParams = {
|
|
868
|
+
copy_metadata: copyMetadata,
|
|
869
|
+
copy_comments: copyComments != null ? copyComments : undefined,
|
|
870
|
+
};
|
|
874
871
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
875
872
|
const _headers = (0, headers_js_1.mergeHeaders)(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
876
873
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
877
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/files/${core.url.encodePathParam(file_id)}/
|
|
878
|
-
method: "
|
|
874
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/files/${core.url.encodePathParam(file_id)}/copy`),
|
|
875
|
+
method: "POST",
|
|
879
876
|
headers: _headers,
|
|
880
|
-
|
|
877
|
+
contentType: "application/json",
|
|
878
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
879
|
+
requestType: "json",
|
|
880
|
+
body: _body,
|
|
881
881
|
timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
|
|
882
882
|
maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
|
|
883
883
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -911,7 +911,7 @@ class FilesClient {
|
|
|
911
911
|
});
|
|
912
912
|
}
|
|
913
913
|
}
|
|
914
|
-
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "
|
|
914
|
+
return (0, handleNonStatusCodeError_js_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/files/{file_id}/copy");
|
|
915
915
|
});
|
|
916
916
|
}
|
|
917
917
|
}
|