frameio 1.3.0 → 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 +3 -3
- 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/AssetShareParams.d.ts +3 -2
- 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/Share.d.ts +1 -1
- 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 +3 -3
- 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/AssetShareParams.d.mts +3 -2
- 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/Share.d.mts +1 -1
- 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/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
|
*
|
|
@@ -842,6 +842,94 @@ export class Files {
|
|
|
842
842
|
}
|
|
843
843
|
});
|
|
844
844
|
}
|
|
845
|
+
/**
|
|
846
|
+
* Import a file from a storage location configured on the account. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
847
|
+
*
|
|
848
|
+
* @param {Frameio.Uuid} accountId -
|
|
849
|
+
* @param {Frameio.Uuid} folderId -
|
|
850
|
+
* @param {Frameio.FileImportParams} request
|
|
851
|
+
* @param {Files.RequestOptions} requestOptions - Request-specific configuration.
|
|
852
|
+
*
|
|
853
|
+
* @throws {@link Frameio.BadRequestError}
|
|
854
|
+
* @throws {@link Frameio.UnauthorizedError}
|
|
855
|
+
* @throws {@link Frameio.ForbiddenError}
|
|
856
|
+
* @throws {@link Frameio.NotFoundError}
|
|
857
|
+
* @throws {@link Frameio.ConflictError}
|
|
858
|
+
* @throws {@link Frameio.UnprocessableEntityError}
|
|
859
|
+
* @throws {@link Frameio.TooManyRequestsError}
|
|
860
|
+
*
|
|
861
|
+
* @example
|
|
862
|
+
* await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
863
|
+
* data: {
|
|
864
|
+
* key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
|
|
865
|
+
* name: "asset.png",
|
|
866
|
+
* storage_location: "123e4567-e89b-12d3-a456-426614174000"
|
|
867
|
+
* }
|
|
868
|
+
* })
|
|
869
|
+
*/
|
|
870
|
+
importFile(accountId, folderId, request, requestOptions) {
|
|
871
|
+
return core.HttpResponsePromise.fromPromise(this.__importFile(accountId, folderId, request, requestOptions));
|
|
872
|
+
}
|
|
873
|
+
__importFile(accountId, folderId, request, requestOptions) {
|
|
874
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
875
|
+
var _a, _b, _c, _d;
|
|
876
|
+
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
877
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
878
|
+
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`),
|
|
879
|
+
method: "POST",
|
|
880
|
+
headers: _headers,
|
|
881
|
+
contentType: "application/json",
|
|
882
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
883
|
+
requestType: "json",
|
|
884
|
+
body: request,
|
|
885
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
886
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
887
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
888
|
+
});
|
|
889
|
+
if (_response.ok) {
|
|
890
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
891
|
+
}
|
|
892
|
+
if (_response.error.reason === "status-code") {
|
|
893
|
+
switch (_response.error.statusCode) {
|
|
894
|
+
case 400:
|
|
895
|
+
throw new Frameio.BadRequestError(_response.error.body, _response.rawResponse);
|
|
896
|
+
case 401:
|
|
897
|
+
throw new Frameio.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
898
|
+
case 403:
|
|
899
|
+
throw new Frameio.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
900
|
+
case 404:
|
|
901
|
+
throw new Frameio.NotFoundError(_response.error.body, _response.rawResponse);
|
|
902
|
+
case 409:
|
|
903
|
+
throw new Frameio.ConflictError(_response.error.body, _response.rawResponse);
|
|
904
|
+
case 422:
|
|
905
|
+
throw new Frameio.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
906
|
+
case 429:
|
|
907
|
+
throw new Frameio.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
908
|
+
default:
|
|
909
|
+
throw new errors.FrameioError({
|
|
910
|
+
statusCode: _response.error.statusCode,
|
|
911
|
+
body: _response.error.body,
|
|
912
|
+
rawResponse: _response.rawResponse,
|
|
913
|
+
});
|
|
914
|
+
}
|
|
915
|
+
}
|
|
916
|
+
switch (_response.error.reason) {
|
|
917
|
+
case "non-json":
|
|
918
|
+
throw new errors.FrameioError({
|
|
919
|
+
statusCode: _response.error.statusCode,
|
|
920
|
+
body: _response.error.rawBody,
|
|
921
|
+
rawResponse: _response.rawResponse,
|
|
922
|
+
});
|
|
923
|
+
case "timeout":
|
|
924
|
+
throw new errors.FrameioTimeoutError("Timeout exceeded when calling POST /v4/accounts/{account_id}/folders/{folder_id}/files/import.");
|
|
925
|
+
case "unknown":
|
|
926
|
+
throw new errors.FrameioError({
|
|
927
|
+
message: _response.error.errorMessage,
|
|
928
|
+
rawResponse: _response.rawResponse,
|
|
929
|
+
});
|
|
930
|
+
}
|
|
931
|
+
});
|
|
932
|
+
}
|
|
845
933
|
/**
|
|
846
934
|
* Show file upload status details. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
847
935
|
*
|
|
@@ -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.mjs";
|
|
|
6
6
|
export { type FileCreateRemoteUploadParams } from "./FileCreateRemoteUploadParams.mjs";
|
|
7
7
|
export { type FileMoveParams } from "./FileMoveParams.mjs";
|
|
8
8
|
export { type FileCreateLocalUploadParams } from "./FileCreateLocalUploadParams.mjs";
|
|
9
|
+
export { type FileImportParams } from "./FileImportParams.mjs";
|
|
@@ -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";
|
|
@@ -8,6 +8,7 @@ export const FilesListRequestInclude = {
|
|
|
8
8
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
9
9
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
10
10
|
MediaLinksEfficient: "media_links.efficient",
|
|
11
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
11
12
|
Creator: "creator",
|
|
12
13
|
Project: "project",
|
|
13
14
|
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";
|
|
@@ -8,6 +8,7 @@ export const FilesShowRequestInclude = {
|
|
|
8
8
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
9
9
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
10
10
|
MediaLinksEfficient: "media_links.efficient",
|
|
11
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
11
12
|
Creator: "creator",
|
|
12
13
|
Project: "project",
|
|
13
14
|
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";
|
|
@@ -8,6 +8,7 @@ export const FoldersIndexRequestInclude = {
|
|
|
8
8
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
9
9
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
10
10
|
MediaLinksEfficient: "media_links.efficient",
|
|
11
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
11
12
|
Creator: "creator",
|
|
12
13
|
Project: "project",
|
|
13
14
|
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
|
* ]
|
|
@@ -39,16 +39,16 @@ export class Metadata {
|
|
|
39
39
|
* @example
|
|
40
40
|
* await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
41
41
|
* data: {
|
|
42
|
-
* file_ids: ["
|
|
42
|
+
* file_ids: ["340a5466-cc97-4290-888e-45e02d965a5c", "272a22d6-199f-4f0e-b6c3-c1b2afc0d20d"],
|
|
43
43
|
* values: [{
|
|
44
|
-
* field_definition_id: "
|
|
44
|
+
* field_definition_id: "d45c5c1c-8405-4b99-adb9-46a468433a93",
|
|
45
45
|
* value: [
|
|
46
46
|
* {
|
|
47
|
-
* "id": "
|
|
47
|
+
* "id": "0910d770-1742-44f5-bd63-91653a8d0999",
|
|
48
48
|
* "type": "user"
|
|
49
49
|
* },
|
|
50
50
|
* {
|
|
51
|
-
* "id": "
|
|
51
|
+
* "id": "2952a0ad-f70a-4aca-990f-cc34a8bb053c",
|
|
52
52
|
* "type": "account_user_group"
|
|
53
53
|
* }
|
|
54
54
|
* ]
|
|
@@ -3,16 +3,16 @@ import * as Frameio from "../../../../index.mjs";
|
|
|
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
|
* }
|
|
@@ -198,7 +198,7 @@ export class Shares {
|
|
|
198
198
|
* access: "public",
|
|
199
199
|
* description: "A descriptive summary of the share",
|
|
200
200
|
* downloading_enabled: true,
|
|
201
|
-
* expiration: "2026-
|
|
201
|
+
* expiration: "2026-02-18T00:54:56Z",
|
|
202
202
|
* name: "Share Name",
|
|
203
203
|
* passphrase: "as!dfj39sd(*"
|
|
204
204
|
* }
|
|
@@ -644,7 +644,7 @@ export class Shares {
|
|
|
644
644
|
* @example
|
|
645
645
|
* await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
646
646
|
* data: {
|
|
647
|
-
* asset_id: "
|
|
647
|
+
* asset_id: "95ea9fe2-2fdd-4d3d-9d7f-d6c8f01af204"
|
|
648
648
|
* }
|
|
649
649
|
* })
|
|
650
650
|
*/
|
|
@@ -826,9 +826,9 @@ export class Shares {
|
|
|
826
826
|
* data: {
|
|
827
827
|
* type: "asset",
|
|
828
828
|
* access: "public",
|
|
829
|
-
* asset_ids: ["
|
|
829
|
+
* asset_ids: ["c8b416a0-af84-420b-b322-a9339873b974", "094fd8cf-647a-4a64-8a9d-876cff04d75b"],
|
|
830
830
|
* downloading_enabled: true,
|
|
831
|
-
* expiration: "2026-
|
|
831
|
+
* expiration: "2026-02-18T00:54:56Z",
|
|
832
832
|
* name: "Share Name",
|
|
833
833
|
* passphrase: "as!dfj39sd(*"
|
|
834
834
|
* }
|
|
@@ -5,9 +5,9 @@ import * as Frameio from "../../../../index.mjs";
|
|
|
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
|
* }
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* access: "public",
|
|
6
6
|
* description: "A descriptive summary of the share",
|
|
7
7
|
* downloading_enabled: true,
|
|
8
|
-
* expiration: "2026-
|
|
8
|
+
* expiration: "2026-02-18T00:54:56Z",
|
|
9
9
|
* name: "Share Name",
|
|
10
10
|
* passphrase: "as!dfj39sd(*"
|
|
11
11
|
* }
|
|
@@ -17,14 +17,14 @@ export interface UpdateShareParams {
|
|
|
17
17
|
export declare namespace UpdateShareParams {
|
|
18
18
|
interface Data {
|
|
19
19
|
access?: Data.Access;
|
|
20
|
-
/** Share description
|
|
20
|
+
/** Share description. NOTE: Requires a Pro, Team, or Enterprise plan */
|
|
21
21
|
description?: string;
|
|
22
22
|
downloading_enabled?: boolean;
|
|
23
23
|
/** Expiration timestamp */
|
|
24
24
|
expiration?: string;
|
|
25
25
|
/** Share Name (must include at least one non-whitespace character and no line breaks) */
|
|
26
26
|
name?: string;
|
|
27
|
-
/** Passphrase to access share
|
|
27
|
+
/** Passphrase to access share */
|
|
28
28
|
passphrase?: string;
|
|
29
29
|
}
|
|
30
30
|
namespace Data {
|
|
@@ -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
|
*/
|
|
@@ -445,7 +445,7 @@ export class VersionStacks {
|
|
|
445
445
|
* @example
|
|
446
446
|
* await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
447
447
|
* data: {
|
|
448
|
-
* file_ids: ["
|
|
448
|
+
* file_ids: ["b26bface-a5e6-4bef-8dab-79497f55f6cd", "91aac164-64de-4c36-89e0-e7b8a47f9efd"]
|
|
449
449
|
* }
|
|
450
450
|
* })
|
|
451
451
|
*/
|
|
@@ -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";
|
|
@@ -8,6 +8,7 @@ export const VersionStacksIndexRequestInclude = {
|
|
|
8
8
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
9
9
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
10
10
|
MediaLinksEfficient: "media_links.efficient",
|
|
11
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
11
12
|
Creator: "creator",
|
|
12
13
|
Project: "project",
|
|
13
14
|
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";
|
|
@@ -8,6 +8,7 @@ export const VersionStacksListRequestInclude = {
|
|
|
8
8
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
9
9
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
10
10
|
MediaLinksEfficient: "media_links.efficient",
|
|
11
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
11
12
|
Creator: "creator",
|
|
12
13
|
Project: "project",
|
|
13
14
|
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";
|
|
@@ -8,6 +8,7 @@ export const VersionStacksShowRequestInclude = {
|
|
|
8
8
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
9
9
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
10
10
|
MediaLinksEfficient: "media_links.efficient",
|
|
11
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
11
12
|
Creator: "creator",
|
|
12
13
|
Project: "project",
|
|
13
14
|
ProjectOwner: "project.owner",
|
|
@@ -2,14 +2,15 @@ export interface AssetShareParams {
|
|
|
2
2
|
access: AssetShareParams.Access;
|
|
3
3
|
/** Asset IDs (File, folder, and/or version stack IDs) */
|
|
4
4
|
asset_ids?: string[];
|
|
5
|
-
/** Share description - NOTE: Requires
|
|
5
|
+
/** Share description - NOTE: Requires a Pro, Team, or Enterprise plan */
|
|
6
6
|
description?: string;
|
|
7
|
+
/** NOTE: Requires a Pro, Team, or Enterprise plan */
|
|
7
8
|
downloading_enabled?: boolean;
|
|
8
9
|
/** Expiration timestamp */
|
|
9
10
|
expiration?: string;
|
|
10
11
|
/** Share Name (must include at least one non-whitespace character and no line breaks) */
|
|
11
12
|
name: string;
|
|
12
|
-
/** Passphrase to access share
|
|
13
|
+
/** Passphrase to access share. */
|
|
13
14
|
passphrase?: string;
|
|
14
15
|
}
|
|
15
16
|
export declare namespace AssetShareParams {
|
|
@@ -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";
|
|
@@ -203,6 +203,7 @@ export var AuditLogwithIncludes;
|
|
|
203
203
|
UserTokenUpdated: "user_token_updated",
|
|
204
204
|
UserUpdated: "user_updated",
|
|
205
205
|
V4PlannedMigrationCreationFailed: "v4_planned_migration_creation_failed",
|
|
206
|
+
V4PlannedMigrationDateUpdated: "v4_planned_migration_date_updated",
|
|
206
207
|
WebhookCreated: "webhook_created",
|
|
207
208
|
WebhookDeleted: "webhook_deleted",
|
|
208
209
|
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";
|
|
@@ -8,6 +8,7 @@ export const FileWithMediaLinksInclude = {
|
|
|
8
8
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
9
9
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
10
10
|
MediaLinksEfficient: "media_links.efficient",
|
|
11
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
11
12
|
Creator: "creator",
|
|
12
13
|
Project: "project",
|
|
13
14
|
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";
|
|
@@ -204,6 +204,7 @@ export var Filters;
|
|
|
204
204
|
UserTokenUpdated: "user_token_updated",
|
|
205
205
|
UserUpdated: "user_updated",
|
|
206
206
|
V4PlannedMigrationCreationFailed: "v4_planned_migration_creation_failed",
|
|
207
|
+
V4PlannedMigrationDateUpdated: "v4_planned_migration_date_updated",
|
|
207
208
|
WebhookCreated: "webhook_created",
|
|
208
209
|
WebhookDeleted: "webhook_deleted",
|
|
209
210
|
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;
|
|
@@ -17,7 +17,7 @@ export interface Share {
|
|
|
17
17
|
last_viewed_at?: string;
|
|
18
18
|
/** Share name */
|
|
19
19
|
name?: string;
|
|
20
|
-
/** Passphrase to access share
|
|
20
|
+
/** Passphrase to access share. */
|
|
21
21
|
passphrase?: string;
|
|
22
22
|
/** Share URL */
|
|
23
23
|
short_url?: string;
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.3.
|
|
1
|
+
export declare const SDK_VERSION = "1.3.2";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "1.3.
|
|
1
|
+
export const SDK_VERSION = "1.3.2";
|