frameio 1.3.2 → 1.3.6
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/accountPermissions/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/accountPermissions/client/Client.js +1 -1
- package/dist/cjs/api/resources/accounts/client/Client.d.ts +2 -2
- package/dist/cjs/api/resources/accounts/client/Client.js +2 -2
- package/dist/cjs/api/resources/comments/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/comments/client/Client.js +5 -5
- package/dist/cjs/api/resources/files/client/Client.d.ts +15 -15
- package/dist/cjs/api/resources/files/client/Client.js +15 -15
- package/dist/cjs/api/resources/files/client/requests/FilesListRequest.d.ts +1 -1
- package/dist/cjs/api/resources/files/client/requests/FilesShowRequest.d.ts +1 -1
- package/dist/cjs/api/resources/files/types/FilesListRequestInclude.d.ts +0 -1
- package/dist/cjs/api/resources/files/types/FilesListRequestInclude.js +0 -1
- package/dist/cjs/api/resources/files/types/FilesShowRequestInclude.d.ts +0 -1
- package/dist/cjs/api/resources/files/types/FilesShowRequestInclude.js +0 -1
- package/dist/cjs/api/resources/folders/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/folders/client/Client.js +11 -11
- package/dist/cjs/api/resources/folders/client/requests/FoldersIndexRequest.d.ts +1 -1
- package/dist/cjs/api/resources/folders/types/FoldersIndexRequestInclude.d.ts +0 -1
- package/dist/cjs/api/resources/folders/types/FoldersIndexRequestInclude.js +0 -1
- package/dist/cjs/api/resources/metadata/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/metadata/client/Client.js +6 -6
- package/dist/cjs/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.ts +4 -4
- package/dist/cjs/api/resources/metadataFields/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/metadataFields/client/Client.js +4 -4
- package/dist/cjs/api/resources/projectPermissions/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/projectPermissions/client/Client.js +3 -3
- package/dist/cjs/api/resources/projects/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/projects/client/Client.js +5 -5
- package/dist/cjs/api/resources/shares/client/Client.d.ts +17 -17
- package/dist/cjs/api/resources/shares/client/Client.js +17 -17
- 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/users/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/users/client/Client.js +1 -1
- package/dist/cjs/api/resources/versionStacks/client/Client.d.ts +12 -12
- package/dist/cjs/api/resources/versionStacks/client/Client.js +12 -12
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStacksIndexRequest.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStacksListRequest.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStacksShowRequest.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.d.ts +0 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.js +0 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksListRequestInclude.d.ts +0 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksListRequestInclude.js +0 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.ts +0 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.js +0 -1
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/webhooks/client/Client.js +5 -5
- package/dist/cjs/api/resources/workspacePermissions/client/Client.d.ts +3 -3
- package/dist/cjs/api/resources/workspacePermissions/client/Client.js +3 -3
- package/dist/cjs/api/resources/workspaces/client/Client.d.ts +5 -5
- package/dist/cjs/api/resources/workspaces/client/Client.js +5 -5
- package/dist/cjs/api/types/AssetShareParams.d.ts +2 -3
- package/dist/cjs/api/types/FileWithMediaLinksInclude.d.ts +0 -1
- package/dist/cjs/api/types/FileWithMediaLinksInclude.js +0 -1
- package/dist/cjs/api/types/MediaLinkCommon.d.ts +3 -3
- package/dist/cjs/api/types/OriginalMediaLink.d.ts +2 -2
- package/dist/cjs/api/types/RenditionMediaLink.d.ts +2 -2
- package/dist/cjs/api/types/Share.d.ts +1 -1
- package/dist/cjs/api/types/{UnprocessableEntity.d.ts → UnprocessableContent.d.ts} +3 -3
- package/dist/cjs/api/types/index.d.ts +1 -1
- package/dist/cjs/api/types/index.js +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/accountPermissions/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/accountPermissions/client/Client.mjs +1 -1
- package/dist/esm/api/resources/accounts/client/Client.d.mts +2 -2
- package/dist/esm/api/resources/accounts/client/Client.mjs +2 -2
- package/dist/esm/api/resources/comments/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/comments/client/Client.mjs +5 -5
- package/dist/esm/api/resources/files/client/Client.d.mts +15 -15
- package/dist/esm/api/resources/files/client/Client.mjs +15 -15
- package/dist/esm/api/resources/files/client/requests/FilesListRequest.d.mts +1 -1
- package/dist/esm/api/resources/files/client/requests/FilesShowRequest.d.mts +1 -1
- package/dist/esm/api/resources/files/types/FilesListRequestInclude.d.mts +0 -1
- package/dist/esm/api/resources/files/types/FilesListRequestInclude.mjs +0 -1
- package/dist/esm/api/resources/files/types/FilesShowRequestInclude.d.mts +0 -1
- package/dist/esm/api/resources/files/types/FilesShowRequestInclude.mjs +0 -1
- package/dist/esm/api/resources/folders/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/folders/client/Client.mjs +11 -11
- package/dist/esm/api/resources/folders/client/requests/FoldersIndexRequest.d.mts +1 -1
- package/dist/esm/api/resources/folders/types/FoldersIndexRequestInclude.d.mts +0 -1
- package/dist/esm/api/resources/folders/types/FoldersIndexRequestInclude.mjs +0 -1
- package/dist/esm/api/resources/metadata/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/metadata/client/Client.mjs +6 -6
- package/dist/esm/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.mts +4 -4
- package/dist/esm/api/resources/metadataFields/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/metadataFields/client/Client.mjs +4 -4
- package/dist/esm/api/resources/projectPermissions/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/projectPermissions/client/Client.mjs +3 -3
- package/dist/esm/api/resources/projects/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/projects/client/Client.mjs +5 -5
- package/dist/esm/api/resources/shares/client/Client.d.mts +17 -17
- package/dist/esm/api/resources/shares/client/Client.mjs +17 -17
- 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/users/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/users/client/Client.mjs +1 -1
- package/dist/esm/api/resources/versionStacks/client/Client.d.mts +12 -12
- package/dist/esm/api/resources/versionStacks/client/Client.mjs +12 -12
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStacksIndexRequest.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStacksListRequest.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStacksShowRequest.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.d.mts +0 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.mjs +0 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksListRequestInclude.d.mts +0 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksListRequestInclude.mjs +0 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.mts +0 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.mjs +0 -1
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/webhooks/client/Client.mjs +5 -5
- package/dist/esm/api/resources/workspacePermissions/client/Client.d.mts +3 -3
- package/dist/esm/api/resources/workspacePermissions/client/Client.mjs +3 -3
- package/dist/esm/api/resources/workspaces/client/Client.d.mts +5 -5
- package/dist/esm/api/resources/workspaces/client/Client.mjs +5 -5
- package/dist/esm/api/types/AssetShareParams.d.mts +2 -3
- package/dist/esm/api/types/FileWithMediaLinksInclude.d.mts +0 -1
- package/dist/esm/api/types/FileWithMediaLinksInclude.mjs +0 -1
- package/dist/esm/api/types/MediaLinkCommon.d.mts +3 -3
- package/dist/esm/api/types/OriginalMediaLink.d.mts +2 -2
- package/dist/esm/api/types/RenditionMediaLink.d.mts +2 -2
- package/dist/esm/api/types/Share.d.mts +1 -1
- package/dist/esm/api/types/{UnprocessableEntity.d.mts → UnprocessableContent.d.mts} +3 -3
- package/dist/esm/api/types/index.d.mts +1 -1
- package/dist/esm/api/types/index.mjs +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 +95 -95
- /package/dist/cjs/api/types/{UnprocessableEntity.js → UnprocessableContent.js} +0 -0
- /package/dist/esm/api/types/{UnprocessableEntity.mjs → UnprocessableContent.mjs} +0 -0
|
@@ -32,7 +32,7 @@ export class Folders {
|
|
|
32
32
|
this._options = _options;
|
|
33
33
|
}
|
|
34
34
|
/**
|
|
35
|
-
* Show folder details. <br
|
|
35
|
+
* Show folder details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
36
36
|
*
|
|
37
37
|
* @param {Frameio.Uuid} accountId -
|
|
38
38
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -118,7 +118,7 @@ export class Folders {
|
|
|
118
118
|
});
|
|
119
119
|
}
|
|
120
120
|
/**
|
|
121
|
-
* Delete folder by id. <br
|
|
121
|
+
* Delete folder by id. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
122
122
|
*
|
|
123
123
|
* @param {Frameio.Uuid} accountId -
|
|
124
124
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -196,7 +196,7 @@ export class Folders {
|
|
|
196
196
|
});
|
|
197
197
|
}
|
|
198
198
|
/**
|
|
199
|
-
* Update folder details. <br
|
|
199
|
+
* Update folder details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
200
200
|
*
|
|
201
201
|
* @param {Frameio.Uuid} accountId -
|
|
202
202
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -283,9 +283,9 @@ export class Folders {
|
|
|
283
283
|
}
|
|
284
284
|
/**
|
|
285
285
|
* List the children in the given folder.
|
|
286
|
-
* <br
|
|
286
|
+
* <br/>
|
|
287
287
|
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
288
|
-
* <br
|
|
288
|
+
* <br/>
|
|
289
289
|
* Note: if you include `media_links.original` and the user does not have permission to download files
|
|
290
290
|
* in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
|
|
291
291
|
* If the content is inaccessible because watermarking is required for this user and isn't supported by
|
|
@@ -294,7 +294,7 @@ export class Folders {
|
|
|
294
294
|
* `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
|
|
295
295
|
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
|
|
296
296
|
* null in the response payload. In short, the client must handle null media links gracefully.
|
|
297
|
-
* <br
|
|
297
|
+
* <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
298
298
|
*
|
|
299
299
|
* @param {Frameio.Uuid} accountId -
|
|
300
300
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -311,7 +311,7 @@ export class Folders {
|
|
|
311
311
|
*
|
|
312
312
|
* @example
|
|
313
313
|
* await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
314
|
-
* include: "media_links",
|
|
314
|
+
* include: "media_links.original",
|
|
315
315
|
* type: "file,folder,version_stack",
|
|
316
316
|
* after: "<opaque_cursor>",
|
|
317
317
|
* page_size: 10,
|
|
@@ -399,7 +399,7 @@ export class Folders {
|
|
|
399
399
|
});
|
|
400
400
|
}
|
|
401
401
|
/**
|
|
402
|
-
* Copy folder. <br
|
|
402
|
+
* Copy folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
403
403
|
*
|
|
404
404
|
* @param {Frameio.Uuid} accountId -
|
|
405
405
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -491,7 +491,7 @@ export class Folders {
|
|
|
491
491
|
});
|
|
492
492
|
}
|
|
493
493
|
/**
|
|
494
|
-
* List folders in a given folder. <br
|
|
494
|
+
* List folders in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
495
495
|
*
|
|
496
496
|
* @param {Frameio.Uuid} accountId -
|
|
497
497
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -589,7 +589,7 @@ export class Folders {
|
|
|
589
589
|
});
|
|
590
590
|
}
|
|
591
591
|
/**
|
|
592
|
-
* Create a new folder inside the given <i>folder_id</i> path param. <br
|
|
592
|
+
* Create a new folder inside the given <i>folder_id</i> path param. <br/>Rate Limits: 3 calls per 1 second(s) per account_user
|
|
593
593
|
*
|
|
594
594
|
* @param {Frameio.Uuid} accountId -
|
|
595
595
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -675,7 +675,7 @@ export class Folders {
|
|
|
675
675
|
});
|
|
676
676
|
}
|
|
677
677
|
/**
|
|
678
|
-
* Move folder to a folder. <br
|
|
678
|
+
* Move folder to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
679
679
|
*
|
|
680
680
|
* @param {Frameio.Uuid} accountId -
|
|
681
681
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
2
2
|
export declare const FoldersIndexRequestInclude: {
|
|
3
|
-
readonly MediaLinks: "media_links";
|
|
4
3
|
readonly MediaLinksOriginal: "media_links.original";
|
|
5
4
|
readonly MediaLinksThumbnail: "media_links.thumbnail";
|
|
6
5
|
readonly MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality";
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
2
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
3
3
|
export const FoldersIndexRequestInclude = {
|
|
4
|
-
MediaLinks: "media_links",
|
|
5
4
|
MediaLinksOriginal: "media_links.original",
|
|
6
5
|
MediaLinksThumbnail: "media_links.thumbnail",
|
|
7
6
|
MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality",
|
|
@@ -31,7 +31,7 @@ export declare class Metadata {
|
|
|
31
31
|
protected readonly _options: Metadata.Options;
|
|
32
32
|
constructor(_options: Metadata.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Update metadata values across multiple files. <br
|
|
34
|
+
* Update metadata values across multiple files. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
35
35
|
*
|
|
36
36
|
* @param {Frameio.Uuid} accountId -
|
|
37
37
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -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: ["1c072284-09bf-4067-b47d-e3dc9eb19e42", "f41e89a9-f338-43fe-9485-628d38cd5870"],
|
|
53
53
|
* values: [{
|
|
54
|
-
* field_definition_id: "
|
|
54
|
+
* field_definition_id: "cb90501e-d6fe-472e-b189-3e81d41dfff8",
|
|
55
55
|
* value: [
|
|
56
56
|
* {
|
|
57
|
-
* "id": "
|
|
57
|
+
* "id": "a0da7633-6ed3-489b-87a4-4dd39395fb65",
|
|
58
58
|
* "type": "user"
|
|
59
59
|
* },
|
|
60
60
|
* {
|
|
61
|
-
* "id": "
|
|
61
|
+
* "id": "96fbf6fb-ba96-4289-8adf-03241cb1f1f2",
|
|
62
62
|
* "type": "account_user_group"
|
|
63
63
|
* }
|
|
64
64
|
* ]
|
|
@@ -69,7 +69,7 @@ export declare class Metadata {
|
|
|
69
69
|
bulkUpdate(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request: Frameio.BulkUpdateMetadataParams, requestOptions?: Metadata.RequestOptions): core.HttpResponsePromise<void>;
|
|
70
70
|
private __bulkUpdate;
|
|
71
71
|
/**
|
|
72
|
-
* Show the metadata of a file. <br
|
|
72
|
+
* Show the metadata of a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
73
73
|
*
|
|
74
74
|
* @param {Frameio.Uuid} accountId -
|
|
75
75
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -21,7 +21,7 @@ export class Metadata {
|
|
|
21
21
|
this._options = _options;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* Update metadata values across multiple files. <br
|
|
24
|
+
* Update metadata values across multiple files. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
25
25
|
*
|
|
26
26
|
* @param {Frameio.Uuid} accountId -
|
|
27
27
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -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: ["1c072284-09bf-4067-b47d-e3dc9eb19e42", "f41e89a9-f338-43fe-9485-628d38cd5870"],
|
|
43
43
|
* values: [{
|
|
44
|
-
* field_definition_id: "
|
|
44
|
+
* field_definition_id: "cb90501e-d6fe-472e-b189-3e81d41dfff8",
|
|
45
45
|
* value: [
|
|
46
46
|
* {
|
|
47
|
-
* "id": "
|
|
47
|
+
* "id": "a0da7633-6ed3-489b-87a4-4dd39395fb65",
|
|
48
48
|
* "type": "user"
|
|
49
49
|
* },
|
|
50
50
|
* {
|
|
51
|
-
* "id": "
|
|
51
|
+
* "id": "96fbf6fb-ba96-4289-8adf-03241cb1f1f2",
|
|
52
52
|
* "type": "account_user_group"
|
|
53
53
|
* }
|
|
54
54
|
* ]
|
|
@@ -120,7 +120,7 @@ export class Metadata {
|
|
|
120
120
|
});
|
|
121
121
|
}
|
|
122
122
|
/**
|
|
123
|
-
* Show the metadata of a file. <br
|
|
123
|
+
* Show the metadata of a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
124
124
|
*
|
|
125
125
|
* @param {Frameio.Uuid} accountId -
|
|
126
126
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -3,16 +3,16 @@ import * as Frameio from "../../../../index.mjs";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* data: {
|
|
6
|
-
* file_ids: ["
|
|
6
|
+
* file_ids: ["1c072284-09bf-4067-b47d-e3dc9eb19e42", "f41e89a9-f338-43fe-9485-628d38cd5870"],
|
|
7
7
|
* values: [{
|
|
8
|
-
* field_definition_id: "
|
|
8
|
+
* field_definition_id: "cb90501e-d6fe-472e-b189-3e81d41dfff8",
|
|
9
9
|
* value: [
|
|
10
10
|
* {
|
|
11
|
-
* "id": "
|
|
11
|
+
* "id": "a0da7633-6ed3-489b-87a4-4dd39395fb65",
|
|
12
12
|
* "type": "user"
|
|
13
13
|
* },
|
|
14
14
|
* {
|
|
15
|
-
* "id": "
|
|
15
|
+
* "id": "96fbf6fb-ba96-4289-8adf-03241cb1f1f2",
|
|
16
16
|
* "type": "account_user_group"
|
|
17
17
|
* }
|
|
18
18
|
* ]
|
|
@@ -31,7 +31,7 @@ export declare class MetadataFields {
|
|
|
31
31
|
protected readonly _options: MetadataFields.Options;
|
|
32
32
|
constructor(_options: MetadataFields.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Delete account level custom field definitions. <br
|
|
34
|
+
* Delete account level custom field definitions. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
35
35
|
*
|
|
36
36
|
* @param {Frameio.Uuid} accountId -
|
|
37
37
|
* @param {Frameio.Uuid} fieldDefinitionId -
|
|
@@ -51,7 +51,7 @@ export declare class MetadataFields {
|
|
|
51
51
|
metadataFieldDefinitionsDelete(accountId: Frameio.Uuid, fieldDefinitionId: Frameio.Uuid, requestOptions?: MetadataFields.RequestOptions): core.HttpResponsePromise<void>;
|
|
52
52
|
private __metadataFieldDefinitionsDelete;
|
|
53
53
|
/**
|
|
54
|
-
* Update account level custom field definitions. <br
|
|
54
|
+
* Update account level custom field definitions. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
55
55
|
*
|
|
56
56
|
* @param {Frameio.Uuid} accountId -
|
|
57
57
|
* @param {Frameio.Uuid} fieldDefinitionId -
|
|
@@ -85,7 +85,7 @@ export declare class MetadataFields {
|
|
|
85
85
|
metadataFieldDefinitionsUpdate(accountId: Frameio.Uuid, fieldDefinitionId: Frameio.Uuid, request?: Frameio.UpdateFieldDefinitionParams, requestOptions?: MetadataFields.RequestOptions): core.HttpResponsePromise<Frameio.FieldDefinitionResponse>;
|
|
86
86
|
private __metadataFieldDefinitionsUpdate;
|
|
87
87
|
/**
|
|
88
|
-
* List account level field definitions. <br
|
|
88
|
+
* List account level field definitions. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
89
89
|
*
|
|
90
90
|
* @param {Frameio.Uuid} accountId -
|
|
91
91
|
* @param {Frameio.MetadataFieldDefinitionsIndexRequest} request
|
|
@@ -110,7 +110,7 @@ export declare class MetadataFields {
|
|
|
110
110
|
metadataFieldDefinitionsIndex(accountId: Frameio.Uuid, request?: Frameio.MetadataFieldDefinitionsIndexRequest, requestOptions?: MetadataFields.RequestOptions): core.HttpResponsePromise<Frameio.FieldDefinitionsWithIncludesResponse>;
|
|
111
111
|
private __metadataFieldDefinitionsIndex;
|
|
112
112
|
/**
|
|
113
|
-
* Create account level field definitions. <br
|
|
113
|
+
* Create account level field definitions. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
114
114
|
*
|
|
115
115
|
* @param {Frameio.Uuid} accountId -
|
|
116
116
|
* @param {Frameio.CreateFieldDefinitionParams} request
|
|
@@ -21,7 +21,7 @@ export class MetadataFields {
|
|
|
21
21
|
this._options = _options;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* Delete account level custom field definitions. <br
|
|
24
|
+
* Delete account level custom field definitions. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
25
25
|
*
|
|
26
26
|
* @param {Frameio.Uuid} accountId -
|
|
27
27
|
* @param {Frameio.Uuid} fieldDefinitionId -
|
|
@@ -99,7 +99,7 @@ export class MetadataFields {
|
|
|
99
99
|
});
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* Update account level custom field definitions. <br
|
|
102
|
+
* Update account level custom field definitions. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
103
103
|
*
|
|
104
104
|
* @param {Frameio.Uuid} accountId -
|
|
105
105
|
* @param {Frameio.Uuid} fieldDefinitionId -
|
|
@@ -194,7 +194,7 @@ export class MetadataFields {
|
|
|
194
194
|
});
|
|
195
195
|
}
|
|
196
196
|
/**
|
|
197
|
-
* List account level field definitions. <br
|
|
197
|
+
* List account level field definitions. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
198
198
|
*
|
|
199
199
|
* @param {Frameio.Uuid} accountId -
|
|
200
200
|
* @param {Frameio.MetadataFieldDefinitionsIndexRequest} request
|
|
@@ -294,7 +294,7 @@ export class MetadataFields {
|
|
|
294
294
|
});
|
|
295
295
|
}
|
|
296
296
|
/**
|
|
297
|
-
* Create account level field definitions. <br
|
|
297
|
+
* Create account level field definitions. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
298
298
|
*
|
|
299
299
|
* @param {Frameio.Uuid} accountId -
|
|
300
300
|
* @param {Frameio.CreateFieldDefinitionParams} request
|
|
@@ -31,7 +31,7 @@ export declare class ProjectPermissions {
|
|
|
31
31
|
protected readonly _options: ProjectPermissions.Options;
|
|
32
32
|
constructor(_options: ProjectPermissions.Options);
|
|
33
33
|
/**
|
|
34
|
-
* List user roles for a given project. <br
|
|
34
|
+
* List user roles for a given project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
35
35
|
*
|
|
36
36
|
* @param {Frameio.Uuid} accountId -
|
|
37
37
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -57,7 +57,7 @@ export declare class ProjectPermissions {
|
|
|
57
57
|
index(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request?: Frameio.ProjectPermissionsIndexRequest, requestOptions?: ProjectPermissions.RequestOptions): core.HttpResponsePromise<Frameio.ProjectUserRolesResponse>;
|
|
58
58
|
private __index;
|
|
59
59
|
/**
|
|
60
|
-
* Remove a user from a given project. <br
|
|
60
|
+
* Remove a user from a given project. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
61
61
|
*
|
|
62
62
|
* @param {Frameio.Uuid} accountId -
|
|
63
63
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -79,7 +79,7 @@ export declare class ProjectPermissions {
|
|
|
79
79
|
private __delete;
|
|
80
80
|
/**
|
|
81
81
|
* Update user roles for the given project if the user is already added to the project. If the user is
|
|
82
|
-
* not added to the project, the user will be added with the given role. <br
|
|
82
|
+
* not added to the project, the user will be added with the given role. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
83
83
|
*
|
|
84
84
|
* @param {Frameio.Uuid} accountId -
|
|
85
85
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -21,7 +21,7 @@ export class ProjectPermissions {
|
|
|
21
21
|
this._options = _options;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* List user roles for a given project. <br
|
|
24
|
+
* List user roles for a given project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
25
25
|
*
|
|
26
26
|
* @param {Frameio.Uuid} accountId -
|
|
27
27
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -119,7 +119,7 @@ export class ProjectPermissions {
|
|
|
119
119
|
});
|
|
120
120
|
}
|
|
121
121
|
/**
|
|
122
|
-
* Remove a user from a given project. <br
|
|
122
|
+
* Remove a user from a given project. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
123
123
|
*
|
|
124
124
|
* @param {Frameio.Uuid} accountId -
|
|
125
125
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -199,7 +199,7 @@ export class ProjectPermissions {
|
|
|
199
199
|
}
|
|
200
200
|
/**
|
|
201
201
|
* Update user roles for the given project if the user is already added to the project. If the user is
|
|
202
|
-
* not added to the project, the user will be added with the given role. <br
|
|
202
|
+
* not added to the project, the user will be added with the given role. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
203
203
|
*
|
|
204
204
|
* @param {Frameio.Uuid} accountId -
|
|
205
205
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -31,7 +31,7 @@ export declare class Projects {
|
|
|
31
31
|
protected readonly _options: Projects.Options;
|
|
32
32
|
constructor(_options: Projects.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Show project details. <br
|
|
34
|
+
* Show project details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
35
35
|
*
|
|
36
36
|
* @param {Frameio.Uuid} accountId -
|
|
37
37
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -54,7 +54,7 @@ export declare class Projects {
|
|
|
54
54
|
show(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request?: Frameio.ProjectsShowRequest, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Frameio.ProjectWithIncludesResponse>;
|
|
55
55
|
private __show;
|
|
56
56
|
/**
|
|
57
|
-
* Delete a project. <br
|
|
57
|
+
* Delete a project. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
58
58
|
*
|
|
59
59
|
* @param {Frameio.Uuid} accountId -
|
|
60
60
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -74,7 +74,7 @@ export declare class Projects {
|
|
|
74
74
|
delete(accountId: Frameio.Uuid, projectId: Frameio.Uuid, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<void>;
|
|
75
75
|
private __delete;
|
|
76
76
|
/**
|
|
77
|
-
* Update project details. <br
|
|
77
|
+
* Update project details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
78
78
|
*
|
|
79
79
|
* @param {Frameio.Uuid} accountId -
|
|
80
80
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -101,7 +101,7 @@ export declare class Projects {
|
|
|
101
101
|
update(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request: Frameio.ProjectUpdateParams, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Frameio.ProjectResponse>;
|
|
102
102
|
private __update;
|
|
103
103
|
/**
|
|
104
|
-
* List projects in a given workspace. <br
|
|
104
|
+
* List projects in a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
105
105
|
*
|
|
106
106
|
* @param {Frameio.Uuid} accountId -
|
|
107
107
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -127,7 +127,7 @@ export declare class Projects {
|
|
|
127
127
|
index(accountId: Frameio.Uuid, workspaceId: Frameio.Uuid, request?: Frameio.ProjectsIndexRequest, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Frameio.ProjectsWithIncludesResponse>;
|
|
128
128
|
private __index;
|
|
129
129
|
/**
|
|
130
|
-
* Create project in a given workspace. <br
|
|
130
|
+
* Create project in a given workspace. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
131
131
|
*
|
|
132
132
|
* @param {Frameio.Uuid} accountId -
|
|
133
133
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -21,7 +21,7 @@ export class Projects {
|
|
|
21
21
|
this._options = _options;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* Show project details. <br
|
|
24
|
+
* Show project details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
25
25
|
*
|
|
26
26
|
* @param {Frameio.Uuid} accountId -
|
|
27
27
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -107,7 +107,7 @@ export class Projects {
|
|
|
107
107
|
});
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
110
|
-
* Delete a project. <br
|
|
110
|
+
* Delete a project. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
111
111
|
*
|
|
112
112
|
* @param {Frameio.Uuid} accountId -
|
|
113
113
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -185,7 +185,7 @@ export class Projects {
|
|
|
185
185
|
});
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
188
|
-
* Update project details. <br
|
|
188
|
+
* Update project details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
189
189
|
*
|
|
190
190
|
* @param {Frameio.Uuid} accountId -
|
|
191
191
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -273,7 +273,7 @@ export class Projects {
|
|
|
273
273
|
});
|
|
274
274
|
}
|
|
275
275
|
/**
|
|
276
|
-
* List projects in a given workspace. <br
|
|
276
|
+
* List projects in a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
277
277
|
*
|
|
278
278
|
* @param {Frameio.Uuid} accountId -
|
|
279
279
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -371,7 +371,7 @@ export class Projects {
|
|
|
371
371
|
});
|
|
372
372
|
}
|
|
373
373
|
/**
|
|
374
|
-
* Create project in a given workspace. <br
|
|
374
|
+
* Create project in a given workspace. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
375
375
|
*
|
|
376
376
|
* @param {Frameio.Uuid} accountId -
|
|
377
377
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -31,7 +31,7 @@ export declare class Shares {
|
|
|
31
31
|
protected readonly _options: Shares.Options;
|
|
32
32
|
constructor(_options: Shares.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Show a single Share. <br
|
|
34
|
+
* Show a single Share. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
35
35
|
*
|
|
36
36
|
* @param {Frameio.Uuid} accountId -
|
|
37
37
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -51,7 +51,7 @@ export declare class Shares {
|
|
|
51
51
|
show(accountId: Frameio.Uuid, shareId: Frameio.Uuid, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.ShareResponse>;
|
|
52
52
|
private __show;
|
|
53
53
|
/**
|
|
54
|
-
* Delete a share. <br
|
|
54
|
+
* Delete a share. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
55
55
|
*
|
|
56
56
|
* @param {Frameio.Uuid} accountId -
|
|
57
57
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -71,7 +71,7 @@ export declare class Shares {
|
|
|
71
71
|
delete(accountId: Frameio.Uuid, shareId: Frameio.Uuid, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<void>;
|
|
72
72
|
private __delete;
|
|
73
73
|
/**
|
|
74
|
-
* Update share. <br
|
|
74
|
+
* Update share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
75
75
|
*
|
|
76
76
|
* @param {Frameio.Uuid} accountId -
|
|
77
77
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -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-03-02T23:37:00Z",
|
|
96
96
|
* name: "Share Name",
|
|
97
97
|
* passphrase: "as!dfj39sd(*"
|
|
98
98
|
* }
|
|
@@ -101,7 +101,7 @@ export declare class Shares {
|
|
|
101
101
|
update(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request: Frameio.UpdateShareParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.ShareResponse>;
|
|
102
102
|
private __update;
|
|
103
103
|
/**
|
|
104
|
-
* List share reviewers. <br
|
|
104
|
+
* List share reviewers. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
105
105
|
*
|
|
106
106
|
* @param {Frameio.Uuid} accountId -
|
|
107
107
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -127,11 +127,11 @@ export declare class Shares {
|
|
|
127
127
|
private __listReviewers;
|
|
128
128
|
/**
|
|
129
129
|
* Add reviewers to secure share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
|
|
130
|
-
* <br
|
|
130
|
+
* <br/>
|
|
131
131
|
* A request can only include one identifier type parameter.
|
|
132
|
-
* <br
|
|
132
|
+
* <br/>
|
|
133
133
|
* `email` is the only identifier able to add reviewers to a Share who don't have a Frame account member on the account where the Share belongs.
|
|
134
|
-
* <br
|
|
134
|
+
* <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
135
135
|
*
|
|
136
136
|
* @param {Frameio.Uuid} accountId -
|
|
137
137
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -160,9 +160,9 @@ export declare class Shares {
|
|
|
160
160
|
private __addReviewers;
|
|
161
161
|
/**
|
|
162
162
|
* Removes reviewers from secure Share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
|
|
163
|
-
* <br
|
|
163
|
+
* <br/>
|
|
164
164
|
* A request can only include one identifier type parameter.
|
|
165
|
-
* <br
|
|
165
|
+
* <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
166
166
|
*
|
|
167
167
|
* @param {Frameio.Uuid} accountId -
|
|
168
168
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -189,7 +189,7 @@ export declare class Shares {
|
|
|
189
189
|
removeReviewers(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request: Frameio.RemoveReviewerParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<void>;
|
|
190
190
|
private __removeReviewers;
|
|
191
191
|
/**
|
|
192
|
-
* Remove an asset currently in the share from that share. <br
|
|
192
|
+
* Remove an asset currently in the share from that share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
193
193
|
*
|
|
194
194
|
* @param {Frameio.Uuid} accountId -
|
|
195
195
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -210,7 +210,7 @@ export declare class Shares {
|
|
|
210
210
|
removeAsset(accountId: Frameio.Uuid, shareId: Frameio.Uuid, assetId: Frameio.Uuid, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.RemoveAssetResponse>;
|
|
211
211
|
private __removeAsset;
|
|
212
212
|
/**
|
|
213
|
-
* Add new asset share. <br
|
|
213
|
+
* Add new asset share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
214
214
|
*
|
|
215
215
|
* @param {Frameio.Uuid} accountId -
|
|
216
216
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -228,14 +228,14 @@ 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: "0874135d-c18e-4963-a7ca-f934a78e22a8"
|
|
232
232
|
* }
|
|
233
233
|
* })
|
|
234
234
|
*/
|
|
235
235
|
addAsset(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request: Frameio.AddAssetParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.AddAssetResponse>;
|
|
236
236
|
private __addAsset;
|
|
237
237
|
/**
|
|
238
|
-
* List shares on a project. <br
|
|
238
|
+
* List shares on a project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
239
239
|
*
|
|
240
240
|
* @param {Frameio.Uuid} accountId -
|
|
241
241
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -260,7 +260,7 @@ export declare class Shares {
|
|
|
260
260
|
index(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request?: Frameio.SharesIndexRequest, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.SharesResponse>;
|
|
261
261
|
private __index;
|
|
262
262
|
/**
|
|
263
|
-
* Create share. <br
|
|
263
|
+
* Create share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
264
264
|
*
|
|
265
265
|
* @param {Frameio.Uuid} accountId -
|
|
266
266
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -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: ["991a9e84-ed04-4aee-9672-4ab34e64057a", "8bacca0d-18d6-4d9c-9a13-d2399e6b24a2"],
|
|
284
284
|
* downloading_enabled: true,
|
|
285
|
-
* expiration: "2026-
|
|
285
|
+
* expiration: "2026-03-02T23:37:00Z",
|
|
286
286
|
* name: "Share Name",
|
|
287
287
|
* passphrase: "as!dfj39sd(*"
|
|
288
288
|
* }
|