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
|
@@ -34,11 +34,11 @@ export class FilesClient {
|
|
|
34
34
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* Create new file under parent folder through remote upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
38
38
|
*
|
|
39
39
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
40
40
|
* @param {Frameio.FrameOrAdobeId} folder_id
|
|
41
|
-
* @param {Frameio.
|
|
41
|
+
* @param {Frameio.FileCreateRemoteUploadParams} request
|
|
42
42
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
43
43
|
*
|
|
44
44
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -50,35 +50,29 @@ export class FilesClient {
|
|
|
50
50
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
51
51
|
*
|
|
52
52
|
* @example
|
|
53
|
-
* await client.files.
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
* include_total_count: false
|
|
53
|
+
* await client.files.createRemoteUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
54
|
+
* data: {
|
|
55
|
+
* name: "asset.png",
|
|
56
|
+
* source_url: "https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png"
|
|
57
|
+
* }
|
|
59
58
|
* })
|
|
60
59
|
*/
|
|
61
|
-
|
|
62
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
60
|
+
createRemoteUpload(account_id, folder_id, request, requestOptions) {
|
|
61
|
+
return core.HttpResponsePromise.fromPromise(this.__createRemoteUpload(account_id, folder_id, request, requestOptions));
|
|
63
62
|
}
|
|
64
|
-
|
|
65
|
-
return __awaiter(this,
|
|
63
|
+
__createRemoteUpload(account_id, folder_id, request, requestOptions) {
|
|
64
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
66
65
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
67
|
-
const { include, sort, after, page_size: pageSize, include_total_count: includeTotalCount } = request;
|
|
68
|
-
const _queryParams = {
|
|
69
|
-
include: include != null ? include : undefined,
|
|
70
|
-
sort: sort != null ? sort : undefined,
|
|
71
|
-
after,
|
|
72
|
-
page_size: pageSize,
|
|
73
|
-
include_total_count: includeTotalCount,
|
|
74
|
-
};
|
|
75
66
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
76
67
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
77
68
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
78
|
-
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`),
|
|
79
|
-
method: "
|
|
69
|
+
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`),
|
|
70
|
+
method: "POST",
|
|
80
71
|
headers: _headers,
|
|
81
|
-
|
|
72
|
+
contentType: "application/json",
|
|
73
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
74
|
+
requestType: "json",
|
|
75
|
+
body: request,
|
|
82
76
|
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,
|
|
83
77
|
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,
|
|
84
78
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -86,10 +80,7 @@ export class FilesClient {
|
|
|
86
80
|
logging: this._options.logging,
|
|
87
81
|
});
|
|
88
82
|
if (_response.ok) {
|
|
89
|
-
return {
|
|
90
|
-
data: _response.body,
|
|
91
|
-
rawResponse: _response.rawResponse,
|
|
92
|
-
};
|
|
83
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
93
84
|
}
|
|
94
85
|
if (_response.error.reason === "status-code") {
|
|
95
86
|
switch (_response.error.statusCode) {
|
|
@@ -115,17 +106,15 @@ export class FilesClient {
|
|
|
115
106
|
});
|
|
116
107
|
}
|
|
117
108
|
}
|
|
118
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
109
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files/remote_upload");
|
|
119
110
|
});
|
|
120
111
|
}
|
|
121
112
|
/**
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
* 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
|
|
113
|
+
* Create new file under parent folder through local upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
125
114
|
*
|
|
126
115
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
127
116
|
* @param {Frameio.FrameOrAdobeId} folder_id
|
|
128
|
-
* @param {Frameio.
|
|
117
|
+
* @param {Frameio.FileCreateLocalUploadParams} request
|
|
129
118
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
130
119
|
*
|
|
131
120
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -137,24 +126,23 @@ export class FilesClient {
|
|
|
137
126
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
138
127
|
*
|
|
139
128
|
* @example
|
|
140
|
-
* await client.files.
|
|
129
|
+
* await client.files.createLocalUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
141
130
|
* data: {
|
|
142
131
|
* file_size: 1137444,
|
|
143
|
-
* media_type: "image/png",
|
|
144
132
|
* name: "asset.png"
|
|
145
133
|
* }
|
|
146
134
|
* })
|
|
147
135
|
*/
|
|
148
|
-
|
|
149
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
136
|
+
createLocalUpload(account_id, folder_id, request, requestOptions) {
|
|
137
|
+
return core.HttpResponsePromise.fromPromise(this.__createLocalUpload(account_id, folder_id, request, requestOptions));
|
|
150
138
|
}
|
|
151
|
-
|
|
139
|
+
__createLocalUpload(account_id, folder_id, request, requestOptions) {
|
|
152
140
|
return __awaiter(this, void 0, void 0, function* () {
|
|
153
141
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
154
142
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
155
143
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
156
144
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
157
|
-
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`),
|
|
145
|
+
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`),
|
|
158
146
|
method: "POST",
|
|
159
147
|
headers: _headers,
|
|
160
148
|
contentType: "application/json",
|
|
@@ -194,27 +182,14 @@ export class FilesClient {
|
|
|
194
182
|
});
|
|
195
183
|
}
|
|
196
184
|
}
|
|
197
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files");
|
|
185
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files/local_upload");
|
|
198
186
|
});
|
|
199
187
|
}
|
|
200
188
|
/**
|
|
201
|
-
* Show file details.
|
|
202
|
-
* <br/>
|
|
203
|
-
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
204
|
-
* <br/>
|
|
205
|
-
* Note: if you include `media_links.original` and the user does not have permission to download the file
|
|
206
|
-
* then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
|
|
207
|
-
* watermarking is required for this user and isn't supported by the requested media_links, then the request will
|
|
208
|
-
* succeed but the unsupported media links will be set to null.
|
|
209
|
-
* Similarly, if a requested transcode link does not exist for a particular file (e.g. including
|
|
210
|
-
* `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
|
|
211
|
-
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
|
|
212
|
-
* the response payload. In short, the client must handle null media links gracefully.
|
|
213
|
-
* <br/>Rate Limits: 10 calls per 1 second(s) per account_user
|
|
189
|
+
* Show file upload status details. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
214
190
|
*
|
|
215
191
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
216
192
|
* @param {Frameio.FrameOrAdobeId} file_id
|
|
217
|
-
* @param {Frameio.FilesShowRequest} request
|
|
218
193
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
219
194
|
*
|
|
220
195
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -226,27 +201,21 @@ export class FilesClient {
|
|
|
226
201
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
227
202
|
*
|
|
228
203
|
* @example
|
|
229
|
-
* await client.files.
|
|
230
|
-
* include: "media_links.original"
|
|
231
|
-
* })
|
|
204
|
+
* await client.files.showFileUploadStatus("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
|
|
232
205
|
*/
|
|
233
|
-
|
|
234
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
206
|
+
showFileUploadStatus(account_id, file_id, requestOptions) {
|
|
207
|
+
return core.HttpResponsePromise.fromPromise(this.__showFileUploadStatus(account_id, file_id, requestOptions));
|
|
235
208
|
}
|
|
236
|
-
|
|
237
|
-
return __awaiter(this,
|
|
209
|
+
__showFileUploadStatus(account_id, file_id, requestOptions) {
|
|
210
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
238
211
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
239
|
-
const { include } = request;
|
|
240
|
-
const _queryParams = {
|
|
241
|
-
include: include != null ? include : undefined,
|
|
242
|
-
};
|
|
243
212
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
244
213
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
245
214
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
246
|
-
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)}`),
|
|
215
|
+
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`),
|
|
247
216
|
method: "GET",
|
|
248
217
|
headers: _headers,
|
|
249
|
-
queryParameters:
|
|
218
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
250
219
|
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,
|
|
251
220
|
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,
|
|
252
221
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -280,14 +249,15 @@ export class FilesClient {
|
|
|
280
249
|
});
|
|
281
250
|
}
|
|
282
251
|
}
|
|
283
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/files/{file_id}");
|
|
252
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/files/{file_id}/status");
|
|
284
253
|
});
|
|
285
254
|
}
|
|
286
255
|
/**
|
|
287
|
-
*
|
|
256
|
+
* Move file to a folder or version_stack. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
288
257
|
*
|
|
289
258
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
290
259
|
* @param {Frameio.FrameOrAdobeId} file_id
|
|
260
|
+
* @param {Frameio.FileMoveParams} request
|
|
291
261
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
292
262
|
*
|
|
293
263
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -299,21 +269,28 @@ export class FilesClient {
|
|
|
299
269
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
300
270
|
*
|
|
301
271
|
* @example
|
|
302
|
-
* await client.files.
|
|
272
|
+
* await client.files.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
273
|
+
* data: {
|
|
274
|
+
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
275
|
+
* }
|
|
276
|
+
* })
|
|
303
277
|
*/
|
|
304
|
-
|
|
305
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
278
|
+
move(account_id, file_id, request, requestOptions) {
|
|
279
|
+
return core.HttpResponsePromise.fromPromise(this.__move(account_id, file_id, request, requestOptions));
|
|
306
280
|
}
|
|
307
|
-
|
|
281
|
+
__move(account_id, file_id, request, requestOptions) {
|
|
308
282
|
return __awaiter(this, void 0, void 0, function* () {
|
|
309
283
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
310
284
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
311
285
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
312
286
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
313
|
-
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)}`),
|
|
314
|
-
method: "
|
|
287
|
+
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`),
|
|
288
|
+
method: "PATCH",
|
|
315
289
|
headers: _headers,
|
|
290
|
+
contentType: "application/json",
|
|
316
291
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
292
|
+
requestType: "json",
|
|
293
|
+
body: request,
|
|
317
294
|
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,
|
|
318
295
|
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,
|
|
319
296
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -321,7 +298,7 @@ export class FilesClient {
|
|
|
321
298
|
logging: this._options.logging,
|
|
322
299
|
});
|
|
323
300
|
if (_response.ok) {
|
|
324
|
-
return { data:
|
|
301
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
325
302
|
}
|
|
326
303
|
if (_response.error.reason === "status-code") {
|
|
327
304
|
switch (_response.error.statusCode) {
|
|
@@ -347,15 +324,15 @@ export class FilesClient {
|
|
|
347
324
|
});
|
|
348
325
|
}
|
|
349
326
|
}
|
|
350
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
327
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/v4/accounts/{account_id}/files/{file_id}/move");
|
|
351
328
|
});
|
|
352
329
|
}
|
|
353
330
|
/**
|
|
354
|
-
*
|
|
331
|
+
* Import a file from a storage location configured on the account. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
355
332
|
*
|
|
356
333
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
357
|
-
* @param {Frameio.FrameOrAdobeId}
|
|
358
|
-
* @param {Frameio.
|
|
334
|
+
* @param {Frameio.FrameOrAdobeId} folder_id
|
|
335
|
+
* @param {Frameio.FileImportParams} request
|
|
359
336
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
360
337
|
*
|
|
361
338
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -367,23 +344,25 @@ export class FilesClient {
|
|
|
367
344
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
368
345
|
*
|
|
369
346
|
* @example
|
|
370
|
-
* await client.files.
|
|
347
|
+
* await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
371
348
|
* data: {
|
|
372
|
-
*
|
|
349
|
+
* key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
|
|
350
|
+
* name: "asset.png",
|
|
351
|
+
* storage_location: "123e4567-e89b-12d3-a456-426614174000"
|
|
373
352
|
* }
|
|
374
353
|
* })
|
|
375
354
|
*/
|
|
376
|
-
|
|
377
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
355
|
+
importFile(account_id, folder_id, request, requestOptions) {
|
|
356
|
+
return core.HttpResponsePromise.fromPromise(this.__importFile(account_id, folder_id, request, requestOptions));
|
|
378
357
|
}
|
|
379
|
-
|
|
358
|
+
__importFile(account_id, folder_id, request, requestOptions) {
|
|
380
359
|
return __awaiter(this, void 0, void 0, function* () {
|
|
381
360
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
382
361
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
383
362
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
384
363
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
385
|
-
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)}/
|
|
386
|
-
method: "
|
|
364
|
+
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`),
|
|
365
|
+
method: "POST",
|
|
387
366
|
headers: _headers,
|
|
388
367
|
contentType: "application/json",
|
|
389
368
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
@@ -422,15 +401,27 @@ export class FilesClient {
|
|
|
422
401
|
});
|
|
423
402
|
}
|
|
424
403
|
}
|
|
425
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
404
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files/import");
|
|
426
405
|
});
|
|
427
406
|
}
|
|
428
407
|
/**
|
|
429
|
-
*
|
|
408
|
+
* Show file details.
|
|
409
|
+
* <br/>
|
|
410
|
+
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
411
|
+
* <br/>
|
|
412
|
+
* Note: if you include `media_links.original` and the user does not have permission to download the file
|
|
413
|
+
* then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
|
|
414
|
+
* watermarking is required for this user and isn't supported by the requested media_links, then the request will
|
|
415
|
+
* succeed but the unsupported media links will be set to null.
|
|
416
|
+
* Similarly, if a requested transcode link does not exist for a particular file (e.g. including
|
|
417
|
+
* `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
|
|
418
|
+
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
|
|
419
|
+
* the response payload. In short, the client must handle null media links gracefully.
|
|
420
|
+
* <br/>Rate Limits: 10 calls per 1 second(s) per account_user
|
|
430
421
|
*
|
|
431
422
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
432
423
|
* @param {Frameio.FrameOrAdobeId} file_id
|
|
433
|
-
* @param {Frameio.
|
|
424
|
+
* @param {Frameio.FilesShowRequest} request
|
|
434
425
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
435
426
|
*
|
|
436
427
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -442,35 +433,27 @@ export class FilesClient {
|
|
|
442
433
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
443
434
|
*
|
|
444
435
|
* @example
|
|
445
|
-
* await client.files.
|
|
446
|
-
*
|
|
447
|
-
* copy_comments: "none",
|
|
448
|
-
* data: {
|
|
449
|
-
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
450
|
-
* }
|
|
436
|
+
* await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
437
|
+
* include: "media_links.original"
|
|
451
438
|
* })
|
|
452
439
|
*/
|
|
453
|
-
|
|
454
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
440
|
+
show(account_id, file_id, request = {}, requestOptions) {
|
|
441
|
+
return core.HttpResponsePromise.fromPromise(this.__show(account_id, file_id, request, requestOptions));
|
|
455
442
|
}
|
|
456
|
-
|
|
443
|
+
__show(account_id_1, file_id_1) {
|
|
457
444
|
return __awaiter(this, arguments, void 0, function* (account_id, file_id, request = {}, requestOptions) {
|
|
458
445
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
459
|
-
const {
|
|
446
|
+
const { include } = request;
|
|
460
447
|
const _queryParams = {
|
|
461
|
-
|
|
462
|
-
copy_comments: copyComments != null ? copyComments : undefined,
|
|
448
|
+
include: include != null ? include : undefined,
|
|
463
449
|
};
|
|
464
450
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
465
451
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
466
452
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
467
|
-
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)}
|
|
468
|
-
method: "
|
|
453
|
+
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)}`),
|
|
454
|
+
method: "GET",
|
|
469
455
|
headers: _headers,
|
|
470
|
-
contentType: "application/json",
|
|
471
456
|
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
472
|
-
requestType: "json",
|
|
473
|
-
body: _body,
|
|
474
457
|
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,
|
|
475
458
|
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,
|
|
476
459
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -504,15 +487,14 @@ export class FilesClient {
|
|
|
504
487
|
});
|
|
505
488
|
}
|
|
506
489
|
}
|
|
507
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
490
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/files/{file_id}");
|
|
508
491
|
});
|
|
509
492
|
}
|
|
510
493
|
/**
|
|
511
|
-
*
|
|
494
|
+
* Delete file by ID. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
512
495
|
*
|
|
513
496
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
514
|
-
* @param {Frameio.FrameOrAdobeId}
|
|
515
|
-
* @param {Frameio.FileCreateRemoteUploadParams} request
|
|
497
|
+
* @param {Frameio.FrameOrAdobeId} file_id
|
|
516
498
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
517
499
|
*
|
|
518
500
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -524,29 +506,21 @@ export class FilesClient {
|
|
|
524
506
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
525
507
|
*
|
|
526
508
|
* @example
|
|
527
|
-
* await client.files.
|
|
528
|
-
* data: {
|
|
529
|
-
* name: "asset.png",
|
|
530
|
-
* source_url: "https://upload.wikimedia.org/wikipedia/commons/e/e1/White_Pixel_1x1.png"
|
|
531
|
-
* }
|
|
532
|
-
* })
|
|
509
|
+
* await client.files.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b")
|
|
533
510
|
*/
|
|
534
|
-
|
|
535
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
511
|
+
delete(account_id, file_id, requestOptions) {
|
|
512
|
+
return core.HttpResponsePromise.fromPromise(this.__delete(account_id, file_id, requestOptions));
|
|
536
513
|
}
|
|
537
|
-
|
|
514
|
+
__delete(account_id, file_id, requestOptions) {
|
|
538
515
|
return __awaiter(this, void 0, void 0, function* () {
|
|
539
516
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
540
517
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
541
518
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
542
519
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
543
|
-
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)}/
|
|
544
|
-
method: "
|
|
520
|
+
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)}`),
|
|
521
|
+
method: "DELETE",
|
|
545
522
|
headers: _headers,
|
|
546
|
-
contentType: "application/json",
|
|
547
523
|
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
548
|
-
requestType: "json",
|
|
549
|
-
body: request,
|
|
550
524
|
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,
|
|
551
525
|
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,
|
|
552
526
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -554,7 +528,7 @@ export class FilesClient {
|
|
|
554
528
|
logging: this._options.logging,
|
|
555
529
|
});
|
|
556
530
|
if (_response.ok) {
|
|
557
|
-
return { data:
|
|
531
|
+
return { data: undefined, rawResponse: _response.rawResponse };
|
|
558
532
|
}
|
|
559
533
|
if (_response.error.reason === "status-code") {
|
|
560
534
|
switch (_response.error.statusCode) {
|
|
@@ -580,15 +554,15 @@ export class FilesClient {
|
|
|
580
554
|
});
|
|
581
555
|
}
|
|
582
556
|
}
|
|
583
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
557
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/v4/accounts/{account_id}/files/{file_id}");
|
|
584
558
|
});
|
|
585
559
|
}
|
|
586
560
|
/**
|
|
587
|
-
*
|
|
561
|
+
* Update file details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
588
562
|
*
|
|
589
563
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
590
564
|
* @param {Frameio.FrameOrAdobeId} file_id
|
|
591
|
-
* @param {Frameio.
|
|
565
|
+
* @param {Frameio.FileUpdateParams} request
|
|
592
566
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
593
567
|
*
|
|
594
568
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -600,22 +574,22 @@ export class FilesClient {
|
|
|
600
574
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
601
575
|
*
|
|
602
576
|
* @example
|
|
603
|
-
* await client.files.
|
|
577
|
+
* await client.files.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
604
578
|
* data: {
|
|
605
|
-
*
|
|
579
|
+
* name: "asset.png"
|
|
606
580
|
* }
|
|
607
581
|
* })
|
|
608
582
|
*/
|
|
609
|
-
|
|
610
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
583
|
+
update(account_id, file_id, request, requestOptions) {
|
|
584
|
+
return core.HttpResponsePromise.fromPromise(this.__update(account_id, file_id, request, requestOptions));
|
|
611
585
|
}
|
|
612
|
-
|
|
586
|
+
__update(account_id, file_id, request, requestOptions) {
|
|
613
587
|
return __awaiter(this, void 0, void 0, function* () {
|
|
614
588
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
615
589
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
616
590
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
617
591
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
618
|
-
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)}
|
|
592
|
+
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)}`),
|
|
619
593
|
method: "PATCH",
|
|
620
594
|
headers: _headers,
|
|
621
595
|
contentType: "application/json",
|
|
@@ -655,15 +629,15 @@ export class FilesClient {
|
|
|
655
629
|
});
|
|
656
630
|
}
|
|
657
631
|
}
|
|
658
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/v4/accounts/{account_id}/files/{file_id}
|
|
632
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "PATCH", "/v4/accounts/{account_id}/files/{file_id}");
|
|
659
633
|
});
|
|
660
634
|
}
|
|
661
635
|
/**
|
|
662
|
-
*
|
|
636
|
+
* List files in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
663
637
|
*
|
|
664
638
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
665
639
|
* @param {Frameio.FrameOrAdobeId} folder_id
|
|
666
|
-
* @param {Frameio.
|
|
640
|
+
* @param {Frameio.FilesListRequest} request
|
|
667
641
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
668
642
|
*
|
|
669
643
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -675,29 +649,35 @@ export class FilesClient {
|
|
|
675
649
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
676
650
|
*
|
|
677
651
|
* @example
|
|
678
|
-
* await client.files.
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
-
*
|
|
682
|
-
*
|
|
652
|
+
* await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
653
|
+
* include: "media_links.original",
|
|
654
|
+
* sort: "name_asc",
|
|
655
|
+
* after: "<opaque_cursor>",
|
|
656
|
+
* page_size: 10,
|
|
657
|
+
* include_total_count: false
|
|
683
658
|
* })
|
|
684
659
|
*/
|
|
685
|
-
|
|
686
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
660
|
+
list(account_id, folder_id, request = {}, requestOptions) {
|
|
661
|
+
return core.HttpResponsePromise.fromPromise(this.__list(account_id, folder_id, request, requestOptions));
|
|
687
662
|
}
|
|
688
|
-
|
|
689
|
-
return __awaiter(this,
|
|
663
|
+
__list(account_id_1, folder_id_1) {
|
|
664
|
+
return __awaiter(this, arguments, void 0, function* (account_id, folder_id, request = {}, requestOptions) {
|
|
690
665
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
666
|
+
const { include, sort, after, page_size: pageSize, include_total_count: includeTotalCount } = request;
|
|
667
|
+
const _queryParams = {
|
|
668
|
+
include: include != null ? include : undefined,
|
|
669
|
+
sort: sort != null ? sort : undefined,
|
|
670
|
+
after,
|
|
671
|
+
page_size: pageSize,
|
|
672
|
+
include_total_count: includeTotalCount,
|
|
673
|
+
};
|
|
691
674
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
692
675
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
693
676
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
694
|
-
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
|
|
695
|
-
method: "
|
|
677
|
+
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`),
|
|
678
|
+
method: "GET",
|
|
696
679
|
headers: _headers,
|
|
697
|
-
|
|
698
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
699
|
-
requestType: "json",
|
|
700
|
-
body: request,
|
|
680
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
701
681
|
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,
|
|
702
682
|
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,
|
|
703
683
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -705,7 +685,10 @@ export class FilesClient {
|
|
|
705
685
|
logging: this._options.logging,
|
|
706
686
|
});
|
|
707
687
|
if (_response.ok) {
|
|
708
|
-
return {
|
|
688
|
+
return {
|
|
689
|
+
data: _response.body,
|
|
690
|
+
rawResponse: _response.rawResponse,
|
|
691
|
+
};
|
|
709
692
|
}
|
|
710
693
|
if (_response.error.reason === "status-code") {
|
|
711
694
|
switch (_response.error.statusCode) {
|
|
@@ -731,15 +714,17 @@ export class FilesClient {
|
|
|
731
714
|
});
|
|
732
715
|
}
|
|
733
716
|
}
|
|
734
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
717
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/folders/{folder_id}/files");
|
|
735
718
|
});
|
|
736
719
|
}
|
|
737
720
|
/**
|
|
738
|
-
*
|
|
721
|
+
* @deprecated
|
|
722
|
+
*
|
|
723
|
+
* 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
|
|
739
724
|
*
|
|
740
725
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
741
726
|
* @param {Frameio.FrameOrAdobeId} folder_id
|
|
742
|
-
* @param {Frameio.
|
|
727
|
+
* @param {Frameio.FileCreateParams} request
|
|
743
728
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
744
729
|
*
|
|
745
730
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -751,24 +736,24 @@ export class FilesClient {
|
|
|
751
736
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
752
737
|
*
|
|
753
738
|
* @example
|
|
754
|
-
* await client.files.
|
|
739
|
+
* await client.files.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
755
740
|
* data: {
|
|
756
|
-
*
|
|
757
|
-
*
|
|
758
|
-
*
|
|
741
|
+
* file_size: 1137444,
|
|
742
|
+
* media_type: "image/png",
|
|
743
|
+
* name: "asset.png"
|
|
759
744
|
* }
|
|
760
745
|
* })
|
|
761
746
|
*/
|
|
762
|
-
|
|
763
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
747
|
+
create(account_id, folder_id, request, requestOptions) {
|
|
748
|
+
return core.HttpResponsePromise.fromPromise(this.__create(account_id, folder_id, request, requestOptions));
|
|
764
749
|
}
|
|
765
|
-
|
|
750
|
+
__create(account_id, folder_id, request, requestOptions) {
|
|
766
751
|
return __awaiter(this, void 0, void 0, function* () {
|
|
767
752
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
768
753
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
769
754
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
770
755
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
771
|
-
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
|
|
756
|
+
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`),
|
|
772
757
|
method: "POST",
|
|
773
758
|
headers: _headers,
|
|
774
759
|
contentType: "application/json",
|
|
@@ -808,14 +793,15 @@ export class FilesClient {
|
|
|
808
793
|
});
|
|
809
794
|
}
|
|
810
795
|
}
|
|
811
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files
|
|
796
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/folders/{folder_id}/files");
|
|
812
797
|
});
|
|
813
798
|
}
|
|
814
799
|
/**
|
|
815
|
-
*
|
|
800
|
+
* Copy file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
816
801
|
*
|
|
817
802
|
* @param {Frameio.FrameOrAdobeId} account_id
|
|
818
803
|
* @param {Frameio.FrameOrAdobeId} file_id
|
|
804
|
+
* @param {Frameio.FileCopyParams} request
|
|
819
805
|
* @param {FilesClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
820
806
|
*
|
|
821
807
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -827,21 +813,35 @@ export class FilesClient {
|
|
|
827
813
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
828
814
|
*
|
|
829
815
|
* @example
|
|
830
|
-
* await client.files.
|
|
816
|
+
* await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
817
|
+
* copy_metadata: true,
|
|
818
|
+
* copy_comments: "none",
|
|
819
|
+
* data: {
|
|
820
|
+
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
821
|
+
* }
|
|
822
|
+
* })
|
|
831
823
|
*/
|
|
832
|
-
|
|
833
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
824
|
+
copy(account_id, file_id, request = {}, requestOptions) {
|
|
825
|
+
return core.HttpResponsePromise.fromPromise(this.__copy(account_id, file_id, request, requestOptions));
|
|
834
826
|
}
|
|
835
|
-
|
|
836
|
-
return __awaiter(this,
|
|
827
|
+
__copy(account_id_1, file_id_1) {
|
|
828
|
+
return __awaiter(this, arguments, void 0, function* (account_id, file_id, request = {}, requestOptions) {
|
|
837
829
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
830
|
+
const { copy_metadata: copyMetadata, copy_comments: copyComments } = request, _body = __rest(request, ["copy_metadata", "copy_comments"]);
|
|
831
|
+
const _queryParams = {
|
|
832
|
+
copy_metadata: copyMetadata,
|
|
833
|
+
copy_comments: copyComments != null ? copyComments : undefined,
|
|
834
|
+
};
|
|
838
835
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
839
836
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, 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);
|
|
840
837
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
841
|
-
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)}/
|
|
842
|
-
method: "
|
|
838
|
+
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`),
|
|
839
|
+
method: "POST",
|
|
843
840
|
headers: _headers,
|
|
844
|
-
|
|
841
|
+
contentType: "application/json",
|
|
842
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
843
|
+
requestType: "json",
|
|
844
|
+
body: _body,
|
|
845
845
|
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,
|
|
846
846
|
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,
|
|
847
847
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -875,7 +875,7 @@ export class FilesClient {
|
|
|
875
875
|
});
|
|
876
876
|
}
|
|
877
877
|
}
|
|
878
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "
|
|
878
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v4/accounts/{account_id}/files/{file_id}/copy");
|
|
879
879
|
});
|
|
880
880
|
}
|
|
881
881
|
}
|