frameio 1.3.1 → 1.3.2
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/Client.js +2 -2
- package/dist/cjs/api/resources/files/client/Client.d.ts +27 -0
- package/dist/cjs/api/resources/files/client/Client.js +88 -0
- package/dist/cjs/api/resources/files/client/requests/FileImportParams.d.ts +23 -0
- package/dist/cjs/api/resources/files/client/requests/FileImportParams.js +3 -0
- package/dist/cjs/api/resources/files/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/files/types/FilesListRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/files/types/FilesListRequestInclude.js +1 -0
- package/dist/cjs/api/resources/files/types/FilesShowRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/files/types/FilesShowRequestInclude.js +1 -0
- package/dist/cjs/api/resources/folders/types/FoldersIndexRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/folders/types/FoldersIndexRequestInclude.js +1 -0
- package/dist/cjs/api/resources/metadata/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/metadata/client/Client.js +4 -4
- package/dist/cjs/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.ts +4 -4
- package/dist/cjs/api/resources/shares/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/shares/client/Client.js +4 -4
- 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 +1 -1
- package/dist/cjs/api/resources/versionStacks/client/Client.js +1 -1
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.js +1 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksListRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksListRequestInclude.js +1 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.js +1 -0
- package/dist/cjs/api/types/AuditLogwithIncludes.d.ts +1 -0
- package/dist/cjs/api/types/AuditLogwithIncludes.js +1 -0
- package/dist/cjs/api/types/FileWithMediaLinksInclude.d.ts +1 -0
- package/dist/cjs/api/types/FileWithMediaLinksInclude.js +1 -0
- package/dist/cjs/api/types/Filters.d.ts +1 -0
- package/dist/cjs/api/types/Filters.js +1 -0
- package/dist/cjs/api/types/MediaLinksCollection.d.ts +1 -0
- package/dist/cjs/api/types/VersionStackWithIncludes.d.ts +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/files/client/Client.d.mts +27 -0
- package/dist/esm/api/resources/files/client/Client.mjs +88 -0
- package/dist/esm/api/resources/files/client/requests/FileImportParams.d.mts +23 -0
- package/dist/esm/api/resources/files/client/requests/FileImportParams.mjs +2 -0
- package/dist/esm/api/resources/files/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/files/types/FilesListRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/files/types/FilesListRequestInclude.mjs +1 -0
- package/dist/esm/api/resources/files/types/FilesShowRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/files/types/FilesShowRequestInclude.mjs +1 -0
- package/dist/esm/api/resources/folders/types/FoldersIndexRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/folders/types/FoldersIndexRequestInclude.mjs +1 -0
- package/dist/esm/api/resources/metadata/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/metadata/client/Client.mjs +4 -4
- package/dist/esm/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.mts +4 -4
- package/dist/esm/api/resources/shares/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/shares/client/Client.mjs +4 -4
- 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 +1 -1
- package/dist/esm/api/resources/versionStacks/client/Client.mjs +1 -1
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.mjs +1 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksListRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksListRequestInclude.mjs +1 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.mjs +1 -0
- package/dist/esm/api/types/AuditLogwithIncludes.d.mts +1 -0
- package/dist/esm/api/types/AuditLogwithIncludes.mjs +1 -0
- package/dist/esm/api/types/FileWithMediaLinksInclude.d.mts +1 -0
- package/dist/esm/api/types/FileWithMediaLinksInclude.mjs +1 -0
- package/dist/esm/api/types/Filters.d.mts +1 -0
- package/dist/esm/api/types/Filters.mjs +1 -0
- package/dist/esm/api/types/MediaLinksCollection.d.mts +1 -0
- package/dist/esm/api/types/VersionStackWithIncludes.d.mts +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +94 -9
package/dist/cjs/Client.js
CHANGED
|
@@ -57,8 +57,8 @@ class FrameioClient {
|
|
|
57
57
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
58
58
|
"X-Fern-Language": "JavaScript",
|
|
59
59
|
"X-Fern-SDK-Name": "frameio",
|
|
60
|
-
"X-Fern-SDK-Version": "1.3.
|
|
61
|
-
"User-Agent": "frameio/1.3.
|
|
60
|
+
"X-Fern-SDK-Version": "1.3.2",
|
|
61
|
+
"User-Agent": "frameio/1.3.2",
|
|
62
62
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
63
63
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
64
64
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -268,6 +268,33 @@ export declare class Files {
|
|
|
268
268
|
*/
|
|
269
269
|
createLocalUpload(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateLocalUploadParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
|
|
270
270
|
private __createLocalUpload;
|
|
271
|
+
/**
|
|
272
|
+
* Import a file from a storage location configured on the account. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
273
|
+
*
|
|
274
|
+
* @param {Frameio.Uuid} accountId -
|
|
275
|
+
* @param {Frameio.Uuid} folderId -
|
|
276
|
+
* @param {Frameio.FileImportParams} request
|
|
277
|
+
* @param {Files.RequestOptions} requestOptions - Request-specific configuration.
|
|
278
|
+
*
|
|
279
|
+
* @throws {@link Frameio.BadRequestError}
|
|
280
|
+
* @throws {@link Frameio.UnauthorizedError}
|
|
281
|
+
* @throws {@link Frameio.ForbiddenError}
|
|
282
|
+
* @throws {@link Frameio.NotFoundError}
|
|
283
|
+
* @throws {@link Frameio.ConflictError}
|
|
284
|
+
* @throws {@link Frameio.UnprocessableEntityError}
|
|
285
|
+
* @throws {@link Frameio.TooManyRequestsError}
|
|
286
|
+
*
|
|
287
|
+
* @example
|
|
288
|
+
* await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
289
|
+
* data: {
|
|
290
|
+
* key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
|
|
291
|
+
* name: "asset.png",
|
|
292
|
+
* storage_location: "123e4567-e89b-12d3-a456-426614174000"
|
|
293
|
+
* }
|
|
294
|
+
* })
|
|
295
|
+
*/
|
|
296
|
+
importFile(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileImportParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
|
|
297
|
+
private __importFile;
|
|
271
298
|
/**
|
|
272
299
|
* Show file upload status details. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
273
300
|
*
|
|
@@ -878,6 +878,94 @@ class Files {
|
|
|
878
878
|
}
|
|
879
879
|
});
|
|
880
880
|
}
|
|
881
|
+
/**
|
|
882
|
+
* Import a file from a storage location configured on the account. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
883
|
+
*
|
|
884
|
+
* @param {Frameio.Uuid} accountId -
|
|
885
|
+
* @param {Frameio.Uuid} folderId -
|
|
886
|
+
* @param {Frameio.FileImportParams} request
|
|
887
|
+
* @param {Files.RequestOptions} requestOptions - Request-specific configuration.
|
|
888
|
+
*
|
|
889
|
+
* @throws {@link Frameio.BadRequestError}
|
|
890
|
+
* @throws {@link Frameio.UnauthorizedError}
|
|
891
|
+
* @throws {@link Frameio.ForbiddenError}
|
|
892
|
+
* @throws {@link Frameio.NotFoundError}
|
|
893
|
+
* @throws {@link Frameio.ConflictError}
|
|
894
|
+
* @throws {@link Frameio.UnprocessableEntityError}
|
|
895
|
+
* @throws {@link Frameio.TooManyRequestsError}
|
|
896
|
+
*
|
|
897
|
+
* @example
|
|
898
|
+
* await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
899
|
+
* data: {
|
|
900
|
+
* key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
|
|
901
|
+
* name: "asset.png",
|
|
902
|
+
* storage_location: "123e4567-e89b-12d3-a456-426614174000"
|
|
903
|
+
* }
|
|
904
|
+
* })
|
|
905
|
+
*/
|
|
906
|
+
importFile(accountId, folderId, request, requestOptions) {
|
|
907
|
+
return core.HttpResponsePromise.fromPromise(this.__importFile(accountId, folderId, request, requestOptions));
|
|
908
|
+
}
|
|
909
|
+
__importFile(accountId, folderId, request, requestOptions) {
|
|
910
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
911
|
+
var _a, _b, _c, _d;
|
|
912
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
913
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
914
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.FrameioEnvironment.Default, `v4/accounts/${encodeURIComponent(accountId)}/folders/${encodeURIComponent(folderId)}/files/import`),
|
|
915
|
+
method: "POST",
|
|
916
|
+
headers: _headers,
|
|
917
|
+
contentType: "application/json",
|
|
918
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
919
|
+
requestType: "json",
|
|
920
|
+
body: request,
|
|
921
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
922
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
923
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
924
|
+
});
|
|
925
|
+
if (_response.ok) {
|
|
926
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
927
|
+
}
|
|
928
|
+
if (_response.error.reason === "status-code") {
|
|
929
|
+
switch (_response.error.statusCode) {
|
|
930
|
+
case 400:
|
|
931
|
+
throw new Frameio.BadRequestError(_response.error.body, _response.rawResponse);
|
|
932
|
+
case 401:
|
|
933
|
+
throw new Frameio.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
934
|
+
case 403:
|
|
935
|
+
throw new Frameio.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
936
|
+
case 404:
|
|
937
|
+
throw new Frameio.NotFoundError(_response.error.body, _response.rawResponse);
|
|
938
|
+
case 409:
|
|
939
|
+
throw new Frameio.ConflictError(_response.error.body, _response.rawResponse);
|
|
940
|
+
case 422:
|
|
941
|
+
throw new Frameio.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
942
|
+
case 429:
|
|
943
|
+
throw new Frameio.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
944
|
+
default:
|
|
945
|
+
throw new errors.FrameioError({
|
|
946
|
+
statusCode: _response.error.statusCode,
|
|
947
|
+
body: _response.error.body,
|
|
948
|
+
rawResponse: _response.rawResponse,
|
|
949
|
+
});
|
|
950
|
+
}
|
|
951
|
+
}
|
|
952
|
+
switch (_response.error.reason) {
|
|
953
|
+
case "non-json":
|
|
954
|
+
throw new errors.FrameioError({
|
|
955
|
+
statusCode: _response.error.statusCode,
|
|
956
|
+
body: _response.error.rawBody,
|
|
957
|
+
rawResponse: _response.rawResponse,
|
|
958
|
+
});
|
|
959
|
+
case "timeout":
|
|
960
|
+
throw new errors.FrameioTimeoutError("Timeout exceeded when calling POST /v4/accounts/{account_id}/folders/{folder_id}/files/import.");
|
|
961
|
+
case "unknown":
|
|
962
|
+
throw new errors.FrameioError({
|
|
963
|
+
message: _response.error.errorMessage,
|
|
964
|
+
rawResponse: _response.rawResponse,
|
|
965
|
+
});
|
|
966
|
+
}
|
|
967
|
+
});
|
|
968
|
+
}
|
|
881
969
|
/**
|
|
882
970
|
* Show file upload status details. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
883
971
|
*
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* data: {
|
|
5
|
+
* key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
|
|
6
|
+
* name: "asset.png",
|
|
7
|
+
* storage_location: "123e4567-e89b-12d3-a456-426614174000"
|
|
8
|
+
* }
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface FileImportParams {
|
|
12
|
+
data: FileImportParams.Data;
|
|
13
|
+
}
|
|
14
|
+
export declare namespace FileImportParams {
|
|
15
|
+
interface Data {
|
|
16
|
+
/** File key/path within the filespace */
|
|
17
|
+
key: string;
|
|
18
|
+
/** File name */
|
|
19
|
+
name: string;
|
|
20
|
+
/** Storage location with account UUID as the value or prefix. Applies to accounts with Storage Connect */
|
|
21
|
+
storage_location: string;
|
|
22
|
+
}
|
|
23
|
+
}
|
|
@@ -6,3 +6,4 @@ export { type FileCopyParams } from "./FileCopyParams.js";
|
|
|
6
6
|
export { type FileCreateRemoteUploadParams } from "./FileCreateRemoteUploadParams.js";
|
|
7
7
|
export { type FileMoveParams } from "./FileMoveParams.js";
|
|
8
8
|
export { type FileCreateLocalUploadParams } from "./FileCreateLocalUploadParams.js";
|
|
9
|
+
export { type FileImportParams } from "./FileImportParams.js";
|
|
@@ -7,6 +7,7 @@ export declare const FilesListRequestInclude: {
|
|
|
7
7
|
readonly MediaLinksVideoH264180: "media_links.video_h264_180";
|
|
8
8
|
readonly MediaLinksHighQuality: "media_links.high_quality";
|
|
9
9
|
readonly MediaLinksEfficient: "media_links.efficient";
|
|
10
|
+
readonly MediaLinksScrubSheet: "media_links.scrub_sheet";
|
|
10
11
|
readonly Creator: "creator";
|
|
11
12
|
readonly Project: "project";
|
|
12
13
|
readonly ProjectOwner: "project.owner";
|
|
@@ -11,6 +11,7 @@ exports.FilesListRequestInclude = {
|
|
|
11
11
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
12
12
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
13
13
|
MediaLinksEfficient: "media_links.efficient",
|
|
14
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
14
15
|
Creator: "creator",
|
|
15
16
|
Project: "project",
|
|
16
17
|
ProjectOwner: "project.owner",
|
|
@@ -7,6 +7,7 @@ export declare const FilesShowRequestInclude: {
|
|
|
7
7
|
readonly MediaLinksVideoH264180: "media_links.video_h264_180";
|
|
8
8
|
readonly MediaLinksHighQuality: "media_links.high_quality";
|
|
9
9
|
readonly MediaLinksEfficient: "media_links.efficient";
|
|
10
|
+
readonly MediaLinksScrubSheet: "media_links.scrub_sheet";
|
|
10
11
|
readonly Creator: "creator";
|
|
11
12
|
readonly Project: "project";
|
|
12
13
|
readonly ProjectOwner: "project.owner";
|
|
@@ -11,6 +11,7 @@ exports.FilesShowRequestInclude = {
|
|
|
11
11
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
12
12
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
13
13
|
MediaLinksEfficient: "media_links.efficient",
|
|
14
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
14
15
|
Creator: "creator",
|
|
15
16
|
Project: "project",
|
|
16
17
|
ProjectOwner: "project.owner",
|
|
@@ -7,6 +7,7 @@ export declare const FoldersIndexRequestInclude: {
|
|
|
7
7
|
readonly MediaLinksVideoH264180: "media_links.video_h264_180";
|
|
8
8
|
readonly MediaLinksHighQuality: "media_links.high_quality";
|
|
9
9
|
readonly MediaLinksEfficient: "media_links.efficient";
|
|
10
|
+
readonly MediaLinksScrubSheet: "media_links.scrub_sheet";
|
|
10
11
|
readonly Creator: "creator";
|
|
11
12
|
readonly Project: "project";
|
|
12
13
|
readonly ProjectOwner: "project.owner";
|
|
@@ -11,6 +11,7 @@ exports.FoldersIndexRequestInclude = {
|
|
|
11
11
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
12
12
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
13
13
|
MediaLinksEfficient: "media_links.efficient",
|
|
14
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
14
15
|
Creator: "creator",
|
|
15
16
|
Project: "project",
|
|
16
17
|
ProjectOwner: "project.owner",
|
|
@@ -49,16 +49,16 @@ export declare class Metadata {
|
|
|
49
49
|
* @example
|
|
50
50
|
* await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
51
51
|
* data: {
|
|
52
|
-
* file_ids: ["
|
|
52
|
+
* file_ids: ["340a5466-cc97-4290-888e-45e02d965a5c", "272a22d6-199f-4f0e-b6c3-c1b2afc0d20d"],
|
|
53
53
|
* values: [{
|
|
54
|
-
* field_definition_id: "
|
|
54
|
+
* field_definition_id: "d45c5c1c-8405-4b99-adb9-46a468433a93",
|
|
55
55
|
* value: [
|
|
56
56
|
* {
|
|
57
|
-
* "id": "
|
|
57
|
+
* "id": "0910d770-1742-44f5-bd63-91653a8d0999",
|
|
58
58
|
* "type": "user"
|
|
59
59
|
* },
|
|
60
60
|
* {
|
|
61
|
-
* "id": "
|
|
61
|
+
* "id": "2952a0ad-f70a-4aca-990f-cc34a8bb053c",
|
|
62
62
|
* "type": "account_user_group"
|
|
63
63
|
* }
|
|
64
64
|
* ]
|
|
@@ -75,16 +75,16 @@ class Metadata {
|
|
|
75
75
|
* @example
|
|
76
76
|
* await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
77
77
|
* data: {
|
|
78
|
-
* file_ids: ["
|
|
78
|
+
* file_ids: ["340a5466-cc97-4290-888e-45e02d965a5c", "272a22d6-199f-4f0e-b6c3-c1b2afc0d20d"],
|
|
79
79
|
* values: [{
|
|
80
|
-
* field_definition_id: "
|
|
80
|
+
* field_definition_id: "d45c5c1c-8405-4b99-adb9-46a468433a93",
|
|
81
81
|
* value: [
|
|
82
82
|
* {
|
|
83
|
-
* "id": "
|
|
83
|
+
* "id": "0910d770-1742-44f5-bd63-91653a8d0999",
|
|
84
84
|
* "type": "user"
|
|
85
85
|
* },
|
|
86
86
|
* {
|
|
87
|
-
* "id": "
|
|
87
|
+
* "id": "2952a0ad-f70a-4aca-990f-cc34a8bb053c",
|
|
88
88
|
* "type": "account_user_group"
|
|
89
89
|
* }
|
|
90
90
|
* ]
|
|
@@ -3,16 +3,16 @@ import * as Frameio from "../../../../index.js";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* data: {
|
|
6
|
-
* file_ids: ["
|
|
6
|
+
* file_ids: ["340a5466-cc97-4290-888e-45e02d965a5c", "272a22d6-199f-4f0e-b6c3-c1b2afc0d20d"],
|
|
7
7
|
* values: [{
|
|
8
|
-
* field_definition_id: "
|
|
8
|
+
* field_definition_id: "d45c5c1c-8405-4b99-adb9-46a468433a93",
|
|
9
9
|
* value: [
|
|
10
10
|
* {
|
|
11
|
-
* "id": "
|
|
11
|
+
* "id": "0910d770-1742-44f5-bd63-91653a8d0999",
|
|
12
12
|
* "type": "user"
|
|
13
13
|
* },
|
|
14
14
|
* {
|
|
15
|
-
* "id": "
|
|
15
|
+
* "id": "2952a0ad-f70a-4aca-990f-cc34a8bb053c",
|
|
16
16
|
* "type": "account_user_group"
|
|
17
17
|
* }
|
|
18
18
|
* ]
|
|
@@ -92,7 +92,7 @@ export declare class Shares {
|
|
|
92
92
|
* access: "public",
|
|
93
93
|
* description: "A descriptive summary of the share",
|
|
94
94
|
* downloading_enabled: true,
|
|
95
|
-
* expiration: "2026-
|
|
95
|
+
* expiration: "2026-02-18T00:54:56Z",
|
|
96
96
|
* name: "Share Name",
|
|
97
97
|
* passphrase: "as!dfj39sd(*"
|
|
98
98
|
* }
|
|
@@ -228,7 +228,7 @@ export declare class Shares {
|
|
|
228
228
|
* @example
|
|
229
229
|
* await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
230
230
|
* data: {
|
|
231
|
-
* asset_id: "
|
|
231
|
+
* asset_id: "95ea9fe2-2fdd-4d3d-9d7f-d6c8f01af204"
|
|
232
232
|
* }
|
|
233
233
|
* })
|
|
234
234
|
*/
|
|
@@ -280,9 +280,9 @@ export declare class Shares {
|
|
|
280
280
|
* data: {
|
|
281
281
|
* type: "asset",
|
|
282
282
|
* access: "public",
|
|
283
|
-
* asset_ids: ["
|
|
283
|
+
* asset_ids: ["c8b416a0-af84-420b-b322-a9339873b974", "094fd8cf-647a-4a64-8a9d-876cff04d75b"],
|
|
284
284
|
* downloading_enabled: true,
|
|
285
|
-
* expiration: "2026-
|
|
285
|
+
* expiration: "2026-02-18T00:54:56Z",
|
|
286
286
|
* name: "Share Name",
|
|
287
287
|
* passphrase: "as!dfj39sd(*"
|
|
288
288
|
* }
|
|
@@ -234,7 +234,7 @@ class Shares {
|
|
|
234
234
|
* access: "public",
|
|
235
235
|
* description: "A descriptive summary of the share",
|
|
236
236
|
* downloading_enabled: true,
|
|
237
|
-
* expiration: "2026-
|
|
237
|
+
* expiration: "2026-02-18T00:54:56Z",
|
|
238
238
|
* name: "Share Name",
|
|
239
239
|
* passphrase: "as!dfj39sd(*"
|
|
240
240
|
* }
|
|
@@ -680,7 +680,7 @@ class Shares {
|
|
|
680
680
|
* @example
|
|
681
681
|
* await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
682
682
|
* data: {
|
|
683
|
-
* asset_id: "
|
|
683
|
+
* asset_id: "95ea9fe2-2fdd-4d3d-9d7f-d6c8f01af204"
|
|
684
684
|
* }
|
|
685
685
|
* })
|
|
686
686
|
*/
|
|
@@ -862,9 +862,9 @@ class Shares {
|
|
|
862
862
|
* data: {
|
|
863
863
|
* type: "asset",
|
|
864
864
|
* access: "public",
|
|
865
|
-
* asset_ids: ["
|
|
865
|
+
* asset_ids: ["c8b416a0-af84-420b-b322-a9339873b974", "094fd8cf-647a-4a64-8a9d-876cff04d75b"],
|
|
866
866
|
* downloading_enabled: true,
|
|
867
|
-
* expiration: "2026-
|
|
867
|
+
* expiration: "2026-02-18T00:54:56Z",
|
|
868
868
|
* name: "Share Name",
|
|
869
869
|
* passphrase: "as!dfj39sd(*"
|
|
870
870
|
* }
|
|
@@ -5,9 +5,9 @@ import * as Frameio from "../../../../index.js";
|
|
|
5
5
|
* data: {
|
|
6
6
|
* type: "asset",
|
|
7
7
|
* access: "public",
|
|
8
|
-
* asset_ids: ["
|
|
8
|
+
* asset_ids: ["c8b416a0-af84-420b-b322-a9339873b974", "094fd8cf-647a-4a64-8a9d-876cff04d75b"],
|
|
9
9
|
* downloading_enabled: true,
|
|
10
|
-
* expiration: "2026-
|
|
10
|
+
* expiration: "2026-02-18T00:54:56Z",
|
|
11
11
|
* name: "Share Name",
|
|
12
12
|
* passphrase: "as!dfj39sd(*"
|
|
13
13
|
* }
|
|
@@ -162,7 +162,7 @@ export declare class VersionStacks {
|
|
|
162
162
|
* @example
|
|
163
163
|
* await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
164
164
|
* data: {
|
|
165
|
-
* file_ids: ["
|
|
165
|
+
* file_ids: ["b26bface-a5e6-4bef-8dab-79497f55f6cd", "91aac164-64de-4c36-89e0-e7b8a47f9efd"]
|
|
166
166
|
* }
|
|
167
167
|
* })
|
|
168
168
|
*/
|
|
@@ -481,7 +481,7 @@ class VersionStacks {
|
|
|
481
481
|
* @example
|
|
482
482
|
* await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
483
483
|
* data: {
|
|
484
|
-
* file_ids: ["
|
|
484
|
+
* file_ids: ["b26bface-a5e6-4bef-8dab-79497f55f6cd", "91aac164-64de-4c36-89e0-e7b8a47f9efd"]
|
|
485
485
|
* }
|
|
486
486
|
* })
|
|
487
487
|
*/
|
|
@@ -7,6 +7,7 @@ export declare const VersionStacksIndexRequestInclude: {
|
|
|
7
7
|
readonly MediaLinksVideoH264180: "media_links.video_h264_180";
|
|
8
8
|
readonly MediaLinksHighQuality: "media_links.high_quality";
|
|
9
9
|
readonly MediaLinksEfficient: "media_links.efficient";
|
|
10
|
+
readonly MediaLinksScrubSheet: "media_links.scrub_sheet";
|
|
10
11
|
readonly Creator: "creator";
|
|
11
12
|
readonly Project: "project";
|
|
12
13
|
readonly ProjectOwner: "project.owner";
|
|
@@ -11,6 +11,7 @@ exports.VersionStacksIndexRequestInclude = {
|
|
|
11
11
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
12
12
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
13
13
|
MediaLinksEfficient: "media_links.efficient",
|
|
14
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
14
15
|
Creator: "creator",
|
|
15
16
|
Project: "project",
|
|
16
17
|
ProjectOwner: "project.owner",
|
|
@@ -7,6 +7,7 @@ export declare const VersionStacksListRequestInclude: {
|
|
|
7
7
|
readonly MediaLinksVideoH264180: "media_links.video_h264_180";
|
|
8
8
|
readonly MediaLinksHighQuality: "media_links.high_quality";
|
|
9
9
|
readonly MediaLinksEfficient: "media_links.efficient";
|
|
10
|
+
readonly MediaLinksScrubSheet: "media_links.scrub_sheet";
|
|
10
11
|
readonly Creator: "creator";
|
|
11
12
|
readonly Project: "project";
|
|
12
13
|
readonly ProjectOwner: "project.owner";
|
|
@@ -11,6 +11,7 @@ exports.VersionStacksListRequestInclude = {
|
|
|
11
11
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
12
12
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
13
13
|
MediaLinksEfficient: "media_links.efficient",
|
|
14
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
14
15
|
Creator: "creator",
|
|
15
16
|
Project: "project",
|
|
16
17
|
ProjectOwner: "project.owner",
|
|
@@ -7,6 +7,7 @@ export declare const VersionStacksShowRequestInclude: {
|
|
|
7
7
|
readonly MediaLinksVideoH264180: "media_links.video_h264_180";
|
|
8
8
|
readonly MediaLinksHighQuality: "media_links.high_quality";
|
|
9
9
|
readonly MediaLinksEfficient: "media_links.efficient";
|
|
10
|
+
readonly MediaLinksScrubSheet: "media_links.scrub_sheet";
|
|
10
11
|
readonly Creator: "creator";
|
|
11
12
|
readonly Project: "project";
|
|
12
13
|
readonly ProjectOwner: "project.owner";
|
|
@@ -11,6 +11,7 @@ exports.VersionStacksShowRequestInclude = {
|
|
|
11
11
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
12
12
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
13
13
|
MediaLinksEfficient: "media_links.efficient",
|
|
14
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
14
15
|
Creator: "creator",
|
|
15
16
|
Project: "project",
|
|
16
17
|
ProjectOwner: "project.owner",
|
|
@@ -217,6 +217,7 @@ export declare namespace AuditLogwithIncludes {
|
|
|
217
217
|
readonly UserTokenUpdated: "user_token_updated";
|
|
218
218
|
readonly UserUpdated: "user_updated";
|
|
219
219
|
readonly V4PlannedMigrationCreationFailed: "v4_planned_migration_creation_failed";
|
|
220
|
+
readonly V4PlannedMigrationDateUpdated: "v4_planned_migration_date_updated";
|
|
220
221
|
readonly WebhookCreated: "webhook_created";
|
|
221
222
|
readonly WebhookDeleted: "webhook_deleted";
|
|
222
223
|
readonly WebhookUpdated: "webhook_updated";
|
|
@@ -206,6 +206,7 @@ var AuditLogwithIncludes;
|
|
|
206
206
|
UserTokenUpdated: "user_token_updated",
|
|
207
207
|
UserUpdated: "user_updated",
|
|
208
208
|
V4PlannedMigrationCreationFailed: "v4_planned_migration_creation_failed",
|
|
209
|
+
V4PlannedMigrationDateUpdated: "v4_planned_migration_date_updated",
|
|
209
210
|
WebhookCreated: "webhook_created",
|
|
210
211
|
WebhookDeleted: "webhook_deleted",
|
|
211
212
|
WebhookUpdated: "webhook_updated",
|
|
@@ -7,6 +7,7 @@ export declare const FileWithMediaLinksInclude: {
|
|
|
7
7
|
readonly MediaLinksVideoH264180: "media_links.video_h264_180";
|
|
8
8
|
readonly MediaLinksHighQuality: "media_links.high_quality";
|
|
9
9
|
readonly MediaLinksEfficient: "media_links.efficient";
|
|
10
|
+
readonly MediaLinksScrubSheet: "media_links.scrub_sheet";
|
|
10
11
|
readonly Creator: "creator";
|
|
11
12
|
readonly Project: "project";
|
|
12
13
|
readonly ProjectOwner: "project.owner";
|
|
@@ -11,6 +11,7 @@ exports.FileWithMediaLinksInclude = {
|
|
|
11
11
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
12
12
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
13
13
|
MediaLinksEfficient: "media_links.efficient",
|
|
14
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
14
15
|
Creator: "creator",
|
|
15
16
|
Project: "project",
|
|
16
17
|
ProjectOwner: "project.owner",
|
|
@@ -225,6 +225,7 @@ export declare namespace Filters {
|
|
|
225
225
|
readonly UserTokenUpdated: "user_token_updated";
|
|
226
226
|
readonly UserUpdated: "user_updated";
|
|
227
227
|
readonly V4PlannedMigrationCreationFailed: "v4_planned_migration_creation_failed";
|
|
228
|
+
readonly V4PlannedMigrationDateUpdated: "v4_planned_migration_date_updated";
|
|
228
229
|
readonly WebhookCreated: "webhook_created";
|
|
229
230
|
readonly WebhookDeleted: "webhook_deleted";
|
|
230
231
|
readonly WebhookUpdated: "webhook_updated";
|
|
@@ -207,6 +207,7 @@ var Filters;
|
|
|
207
207
|
UserTokenUpdated: "user_token_updated",
|
|
208
208
|
UserUpdated: "user_updated",
|
|
209
209
|
V4PlannedMigrationCreationFailed: "v4_planned_migration_creation_failed",
|
|
210
|
+
V4PlannedMigrationDateUpdated: "v4_planned_migration_date_updated",
|
|
210
211
|
WebhookCreated: "webhook_created",
|
|
211
212
|
WebhookDeleted: "webhook_deleted",
|
|
212
213
|
WebhookUpdated: "webhook_updated",
|
|
@@ -3,6 +3,7 @@ export interface MediaLinksCollection {
|
|
|
3
3
|
efficient?: Frameio.MediaLinkCommon;
|
|
4
4
|
high_quality?: Frameio.MediaLinkCommon;
|
|
5
5
|
original?: Frameio.OriginalMediaLink;
|
|
6
|
+
scrub_sheet?: Frameio.RenditionMediaLink;
|
|
6
7
|
thumbnail?: Frameio.RenditionMediaLink;
|
|
7
8
|
thumbnail_high_quality?: Frameio.RenditionMediaLink;
|
|
8
9
|
video_h264_180?: Frameio.RenditionMediaLink;
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.3.
|
|
1
|
+
export declare const SDK_VERSION = "1.3.2";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.mjs
CHANGED
|
@@ -21,8 +21,8 @@ export class FrameioClient {
|
|
|
21
21
|
this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
|
|
22
22
|
"X-Fern-Language": "JavaScript",
|
|
23
23
|
"X-Fern-SDK-Name": "frameio",
|
|
24
|
-
"X-Fern-SDK-Version": "1.3.
|
|
25
|
-
"User-Agent": "frameio/1.3.
|
|
24
|
+
"X-Fern-SDK-Version": "1.3.2",
|
|
25
|
+
"User-Agent": "frameio/1.3.2",
|
|
26
26
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
27
27
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
28
28
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -268,6 +268,33 @@ export declare class Files {
|
|
|
268
268
|
*/
|
|
269
269
|
createLocalUpload(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateLocalUploadParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
|
|
270
270
|
private __createLocalUpload;
|
|
271
|
+
/**
|
|
272
|
+
* Import a file from a storage location configured on the account. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
273
|
+
*
|
|
274
|
+
* @param {Frameio.Uuid} accountId -
|
|
275
|
+
* @param {Frameio.Uuid} folderId -
|
|
276
|
+
* @param {Frameio.FileImportParams} request
|
|
277
|
+
* @param {Files.RequestOptions} requestOptions - Request-specific configuration.
|
|
278
|
+
*
|
|
279
|
+
* @throws {@link Frameio.BadRequestError}
|
|
280
|
+
* @throws {@link Frameio.UnauthorizedError}
|
|
281
|
+
* @throws {@link Frameio.ForbiddenError}
|
|
282
|
+
* @throws {@link Frameio.NotFoundError}
|
|
283
|
+
* @throws {@link Frameio.ConflictError}
|
|
284
|
+
* @throws {@link Frameio.UnprocessableEntityError}
|
|
285
|
+
* @throws {@link Frameio.TooManyRequestsError}
|
|
286
|
+
*
|
|
287
|
+
* @example
|
|
288
|
+
* await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
289
|
+
* data: {
|
|
290
|
+
* key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
|
|
291
|
+
* name: "asset.png",
|
|
292
|
+
* storage_location: "123e4567-e89b-12d3-a456-426614174000"
|
|
293
|
+
* }
|
|
294
|
+
* })
|
|
295
|
+
*/
|
|
296
|
+
importFile(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileImportParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
|
|
297
|
+
private __importFile;
|
|
271
298
|
/**
|
|
272
299
|
* Show file upload status details. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
273
300
|
*
|