frameio 0.1.0 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -1
- package/dist/cjs/Client.d.ts +2 -2
- package/dist/cjs/Client.js +3 -3
- package/dist/cjs/api/resources/accountPermissions/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/accountPermissions/client/Client.js +3 -7
- package/dist/cjs/api/resources/accounts/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/accounts/client/Client.js +3 -7
- package/dist/cjs/api/resources/comments/client/Client.d.ts +16 -9
- package/dist/cjs/api/resources/comments/client/Client.js +40 -16
- package/dist/cjs/api/resources/comments/client/requests/CommentsShowRequest.d.ts +1 -1
- package/dist/cjs/api/resources/comments/client/requests/CreateCommentParams.d.ts +13 -3
- package/dist/cjs/api/resources/comments/client/requests/UpdateCommentParams.d.ts +11 -2
- package/dist/cjs/api/resources/comments/index.d.ts +1 -0
- package/dist/cjs/api/resources/comments/index.js +1 -0
- package/dist/cjs/api/resources/comments/types/CommentsShowRequestInclude.d.ts +6 -0
- package/dist/cjs/api/resources/comments/types/CommentsShowRequestInclude.js +9 -0
- package/dist/cjs/api/resources/comments/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/comments/types/index.js +17 -0
- package/dist/cjs/api/resources/files/client/Client.d.ts +16 -15
- package/dist/cjs/api/resources/files/client/Client.js +33 -20
- package/dist/cjs/api/resources/files/client/requests/FileCopyParams.d.ts +3 -0
- package/dist/cjs/api/resources/folders/client/Client.d.ts +14 -12
- package/dist/cjs/api/resources/folders/client/Client.js +31 -17
- package/dist/cjs/api/resources/folders/client/requests/FolderCopyParams.d.ts +3 -0
- package/dist/cjs/api/resources/index.d.ts +4 -2
- package/dist/cjs/api/resources/index.js +5 -3
- package/dist/cjs/api/resources/metadata/client/Client.d.ts +17 -14
- package/dist/cjs/api/resources/metadata/client/Client.js +16 -17
- package/dist/cjs/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.ts +13 -10
- package/dist/cjs/api/resources/metadataFields/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/metadataFields/client/Client.js +6 -10
- package/dist/cjs/api/resources/projectPermissions/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/projectPermissions/client/Client.js +5 -9
- package/dist/cjs/api/resources/projects/client/Client.d.ts +15 -12
- package/dist/cjs/api/resources/projects/client/Client.js +13 -14
- package/dist/cjs/api/resources/projects/client/requests/ProjectParams.d.ts +20 -0
- package/dist/cjs/api/resources/projects/client/requests/ProjectUpdateParams.d.ts +31 -0
- package/dist/cjs/api/resources/projects/client/requests/ProjectUpdateParams.js +15 -0
- package/dist/cjs/api/resources/projects/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shares/client/Client.d.ts +22 -20
- package/dist/cjs/api/resources/shares/client/Client.js +21 -23
- package/dist/cjs/api/resources/shares/client/requests/AddAssetParams.d.ts +1 -1
- package/dist/cjs/api/resources/shares/client/requests/CreateShareParams.d.ts +3 -2
- package/dist/cjs/api/resources/shares/client/requests/UpdateShareParams.d.ts +3 -1
- package/dist/cjs/api/resources/users/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/users/client/Client.js +3 -7
- package/dist/cjs/api/resources/versionStacks/client/Client.d.ts +34 -10
- package/dist/cjs/api/resources/versionStacks/client/Client.js +115 -15
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCopyParams.d.ts +3 -0
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts +2 -2
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStacksShowRequest.d.ts +11 -0
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStacksShowRequest.js +3 -0
- package/dist/cjs/api/resources/versionStacks/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/versionStacks/index.d.ts +1 -0
- package/dist/cjs/api/resources/versionStacks/index.js +1 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.ts +13 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.js +16 -0
- package/dist/cjs/api/resources/versionStacks/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/versionStacks/types/index.js +17 -0
- package/dist/cjs/api/resources/webhooks/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/webhooks/client/Client.js +6 -10
- package/dist/cjs/api/resources/workspacePermissions/client/Client.d.ts +6 -6
- package/dist/cjs/api/resources/workspacePermissions/client/Client.js +5 -9
- package/dist/cjs/api/resources/workspaces/client/Client.d.ts +8 -8
- package/dist/cjs/api/resources/workspaces/client/Client.js +7 -11
- package/dist/cjs/api/types/AssetCommonWithIncludes.d.ts +9 -0
- package/dist/cjs/api/types/AssetCommonWithIncludes.js +9 -0
- package/dist/cjs/api/types/AssetShareParams.d.ts +1 -0
- package/dist/cjs/api/types/Comment.d.ts +6 -2
- package/dist/cjs/api/types/DateDefinition.d.ts +16 -0
- package/dist/cjs/api/types/DateDefinition.js +13 -0
- package/dist/cjs/api/types/EmptyJson.d.ts +4 -0
- package/dist/cjs/api/types/EmptyJson.js +3 -0
- package/dist/cjs/api/types/FileWithMediaLinksInclude.d.ts +0 -1
- package/dist/cjs/api/types/FileWithMediaLinksInclude.js +0 -1
- package/dist/cjs/api/types/FolderWithIncludes.d.ts +9 -0
- package/dist/cjs/api/types/FolderWithIncludes.js +9 -0
- package/dist/cjs/api/types/LongTextDefinition.d.ts +16 -0
- package/dist/cjs/api/types/LongTextDefinition.js +17 -0
- package/dist/cjs/api/types/MultiUserValue.d.ts +1 -1
- package/dist/cjs/api/types/Project.d.ts +12 -0
- package/dist/cjs/api/types/Project.js +9 -0
- package/dist/cjs/api/types/SelectMultiDefinition.d.ts +16 -0
- package/dist/cjs/api/types/SelectMultiDefinition.js +17 -0
- package/dist/cjs/api/types/TextDefinition.d.ts +16 -0
- package/dist/cjs/api/types/TextDefinition.js +17 -0
- package/dist/cjs/api/types/TimeStamp.d.ts +7 -0
- package/dist/cjs/api/types/TimeStamp.js +3 -0
- package/dist/cjs/api/types/UserMultiDefinition.d.ts +16 -0
- package/dist/cjs/api/types/UserMultiDefinition.js +13 -0
- package/dist/cjs/api/types/UserSingleDefinition.d.ts +16 -0
- package/dist/cjs/api/types/UserSingleDefinition.js +13 -0
- package/dist/cjs/api/types/VersionStackWithIncludes.d.ts +9 -0
- package/dist/cjs/api/types/VersionStackWithIncludes.js +9 -0
- package/dist/cjs/api/types/index.d.ts +3 -2
- package/dist/cjs/api/types/index.js +3 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +2 -2
- package/dist/esm/Client.mjs +3 -3
- package/dist/esm/api/resources/accountPermissions/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/accountPermissions/client/Client.mjs +3 -7
- package/dist/esm/api/resources/accounts/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/accounts/client/Client.mjs +3 -7
- package/dist/esm/api/resources/comments/client/Client.d.mts +16 -9
- package/dist/esm/api/resources/comments/client/Client.mjs +40 -16
- package/dist/esm/api/resources/comments/client/requests/CommentsShowRequest.d.mts +1 -1
- package/dist/esm/api/resources/comments/client/requests/CreateCommentParams.d.mts +13 -3
- package/dist/esm/api/resources/comments/client/requests/UpdateCommentParams.d.mts +11 -2
- package/dist/esm/api/resources/comments/index.d.mts +1 -0
- package/dist/esm/api/resources/comments/index.mjs +1 -0
- package/dist/esm/api/resources/comments/types/CommentsShowRequestInclude.d.mts +6 -0
- package/dist/esm/api/resources/comments/types/CommentsShowRequestInclude.mjs +6 -0
- package/dist/esm/api/resources/comments/types/index.d.mts +1 -0
- package/dist/esm/api/resources/comments/types/index.mjs +1 -0
- package/dist/esm/api/resources/files/client/Client.d.mts +16 -15
- package/dist/esm/api/resources/files/client/Client.mjs +33 -20
- package/dist/esm/api/resources/files/client/requests/FileCopyParams.d.mts +3 -0
- package/dist/esm/api/resources/folders/client/Client.d.mts +14 -12
- package/dist/esm/api/resources/folders/client/Client.mjs +31 -17
- package/dist/esm/api/resources/folders/client/requests/FolderCopyParams.d.mts +3 -0
- package/dist/esm/api/resources/index.d.mts +4 -2
- package/dist/esm/api/resources/index.mjs +4 -2
- package/dist/esm/api/resources/metadata/client/Client.d.mts +17 -14
- package/dist/esm/api/resources/metadata/client/Client.mjs +16 -17
- package/dist/esm/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.mts +13 -10
- package/dist/esm/api/resources/metadataFields/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/metadataFields/client/Client.mjs +6 -10
- package/dist/esm/api/resources/projectPermissions/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/projectPermissions/client/Client.mjs +5 -9
- package/dist/esm/api/resources/projects/client/Client.d.mts +15 -12
- package/dist/esm/api/resources/projects/client/Client.mjs +13 -14
- package/dist/esm/api/resources/projects/client/requests/ProjectParams.d.mts +20 -0
- package/dist/esm/api/resources/projects/client/requests/ProjectUpdateParams.d.mts +31 -0
- package/dist/esm/api/resources/projects/client/requests/ProjectUpdateParams.mjs +12 -0
- package/dist/esm/api/resources/projects/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shares/client/Client.d.mts +22 -20
- package/dist/esm/api/resources/shares/client/Client.mjs +21 -23
- package/dist/esm/api/resources/shares/client/requests/AddAssetParams.d.mts +1 -1
- package/dist/esm/api/resources/shares/client/requests/CreateShareParams.d.mts +3 -2
- package/dist/esm/api/resources/shares/client/requests/UpdateShareParams.d.mts +3 -1
- package/dist/esm/api/resources/users/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/users/client/Client.mjs +3 -7
- package/dist/esm/api/resources/versionStacks/client/Client.d.mts +34 -10
- package/dist/esm/api/resources/versionStacks/client/Client.mjs +115 -15
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCopyParams.d.mts +3 -0
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.mts +2 -2
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStacksShowRequest.d.mts +11 -0
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStacksShowRequest.mjs +2 -0
- package/dist/esm/api/resources/versionStacks/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/versionStacks/index.d.mts +1 -0
- package/dist/esm/api/resources/versionStacks/index.mjs +1 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.mts +13 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.mjs +13 -0
- package/dist/esm/api/resources/versionStacks/types/index.d.mts +1 -0
- package/dist/esm/api/resources/versionStacks/types/index.mjs +1 -0
- package/dist/esm/api/resources/webhooks/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/webhooks/client/Client.mjs +6 -10
- package/dist/esm/api/resources/workspacePermissions/client/Client.d.mts +6 -6
- package/dist/esm/api/resources/workspacePermissions/client/Client.mjs +5 -9
- package/dist/esm/api/resources/workspaces/client/Client.d.mts +8 -8
- package/dist/esm/api/resources/workspaces/client/Client.mjs +7 -11
- package/dist/esm/api/types/AssetCommonWithIncludes.d.mts +9 -0
- package/dist/esm/api/types/AssetCommonWithIncludes.mjs +8 -1
- package/dist/esm/api/types/AssetShareParams.d.mts +1 -0
- package/dist/esm/api/types/Comment.d.mts +6 -2
- package/dist/esm/api/types/DateDefinition.d.mts +16 -0
- package/dist/esm/api/types/DateDefinition.mjs +13 -0
- package/dist/esm/api/types/EmptyJson.d.mts +4 -0
- package/dist/esm/api/types/EmptyJson.mjs +2 -0
- package/dist/esm/api/types/FileWithMediaLinksInclude.d.mts +0 -1
- package/dist/esm/api/types/FileWithMediaLinksInclude.mjs +0 -1
- package/dist/esm/api/types/FolderWithIncludes.d.mts +9 -0
- package/dist/esm/api/types/FolderWithIncludes.mjs +8 -1
- package/dist/esm/api/types/LongTextDefinition.d.mts +16 -0
- package/dist/esm/api/types/LongTextDefinition.mjs +16 -1
- package/dist/esm/api/types/MultiUserValue.d.mts +1 -1
- package/dist/esm/api/types/Project.d.mts +12 -0
- package/dist/esm/api/types/Project.mjs +8 -1
- package/dist/esm/api/types/SelectMultiDefinition.d.mts +16 -0
- package/dist/esm/api/types/SelectMultiDefinition.mjs +16 -1
- package/dist/esm/api/types/TextDefinition.d.mts +16 -0
- package/dist/esm/api/types/TextDefinition.mjs +16 -1
- package/dist/esm/api/types/TimeStamp.d.mts +7 -0
- package/dist/esm/api/types/TimeStamp.mjs +2 -0
- package/dist/esm/api/types/UserMultiDefinition.d.mts +16 -0
- package/dist/esm/api/types/UserMultiDefinition.mjs +13 -0
- package/dist/esm/api/types/UserSingleDefinition.d.mts +16 -0
- package/dist/esm/api/types/UserSingleDefinition.mjs +13 -0
- package/dist/esm/api/types/VersionStackWithIncludes.d.mts +9 -0
- package/dist/esm/api/types/VersionStackWithIncludes.mjs +8 -1
- package/dist/esm/api/types/index.d.mts +3 -2
- package/dist/esm/api/types/index.mjs +3 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +384 -110
- package/dist/cjs/api/types/ProjectParams.d.ts +0 -12
- package/dist/esm/api/types/ProjectParams.d.mts +0 -12
- /package/dist/cjs/api/{types → resources/projects/client/requests}/ProjectParams.js +0 -0
- /package/dist/esm/api/{types → resources/projects/client/requests}/ProjectParams.mjs +0 -0
|
@@ -6,7 +6,7 @@ export declare namespace Files {
|
|
|
6
6
|
environment?: core.Supplier<environments.FrameioEnvironment | string>;
|
|
7
7
|
/** Specify a custom URL to connect the client to. */
|
|
8
8
|
baseUrl?: core.Supplier<string>;
|
|
9
|
-
token
|
|
9
|
+
token: core.Supplier<core.BearerToken>;
|
|
10
10
|
/** Additional headers to include in requests. */
|
|
11
11
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
12
12
|
}
|
|
@@ -28,9 +28,9 @@ export declare namespace Files {
|
|
|
28
28
|
*/
|
|
29
29
|
export declare class Files {
|
|
30
30
|
protected readonly _options: Files.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options: Files.Options);
|
|
32
32
|
/**
|
|
33
|
-
* List files in a given folder. <br
|
|
33
|
+
* List files in a given folder. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
34
34
|
*
|
|
35
35
|
* @param {Frameio.Uuid} accountId -
|
|
36
36
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -55,7 +55,7 @@ export declare class Files {
|
|
|
55
55
|
list(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FilesListRequest, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.AssetsWithIncludesResponse>;
|
|
56
56
|
private __list;
|
|
57
57
|
/**
|
|
58
|
-
* Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br
|
|
58
|
+
* Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
59
59
|
*
|
|
60
60
|
* @param {Frameio.Uuid} accountId -
|
|
61
61
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -82,9 +82,9 @@ export declare class Files {
|
|
|
82
82
|
private __create;
|
|
83
83
|
/**
|
|
84
84
|
* Show file details.
|
|
85
|
-
* <br
|
|
85
|
+
* <br>
|
|
86
86
|
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
87
|
-
* <br
|
|
87
|
+
* <br>
|
|
88
88
|
* Note: if you include `media_links.original` and the user does not have permission to download the file
|
|
89
89
|
* then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
|
|
90
90
|
* watermarking is required for this user and isn't supported by the requested media_links, then the request will
|
|
@@ -93,7 +93,7 @@ export declare class Files {
|
|
|
93
93
|
* `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
|
|
94
94
|
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
|
|
95
95
|
* the response payload. In short, the client must handle null media links gracefully.
|
|
96
|
-
* <br
|
|
96
|
+
* <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
97
97
|
*
|
|
98
98
|
* @param {Frameio.Uuid} accountId -
|
|
99
99
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -115,7 +115,7 @@ export declare class Files {
|
|
|
115
115
|
show(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request?: Frameio.FilesShowRequest, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithIncludesResponse>;
|
|
116
116
|
private __show;
|
|
117
117
|
/**
|
|
118
|
-
* Delete file by ID. <br
|
|
118
|
+
* Delete file by ID. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
119
119
|
*
|
|
120
120
|
* @param {Frameio.Uuid} accountId -
|
|
121
121
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -134,7 +134,7 @@ export declare class Files {
|
|
|
134
134
|
delete(accountId: Frameio.Uuid, fileId: Frameio.Uuid, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<void>;
|
|
135
135
|
private __delete;
|
|
136
136
|
/**
|
|
137
|
-
* Update file details. <br
|
|
137
|
+
* Update file details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
138
138
|
*
|
|
139
139
|
* @param {Frameio.Uuid} accountId -
|
|
140
140
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -158,7 +158,7 @@ export declare class Files {
|
|
|
158
158
|
update(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request: Frameio.FileUpdateParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
|
|
159
159
|
private __update;
|
|
160
160
|
/**
|
|
161
|
-
* Copy file. <br
|
|
161
|
+
* Copy file. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
162
162
|
*
|
|
163
163
|
* @param {Frameio.Uuid} accountId -
|
|
164
164
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -174,6 +174,7 @@ export declare class Files {
|
|
|
174
174
|
*
|
|
175
175
|
* @example
|
|
176
176
|
* await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
177
|
+
* copy_metadata: true,
|
|
177
178
|
* data: {
|
|
178
179
|
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
179
180
|
* }
|
|
@@ -182,7 +183,7 @@ export declare class Files {
|
|
|
182
183
|
copy(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request?: Frameio.FileCopyParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileCopyResponse>;
|
|
183
184
|
private __copy;
|
|
184
185
|
/**
|
|
185
|
-
* Create new file under parent folder through remote upload. <br
|
|
186
|
+
* Create new file under parent folder through remote upload. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
186
187
|
*
|
|
187
188
|
* @param {Frameio.Uuid} accountId -
|
|
188
189
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -207,7 +208,7 @@ export declare class Files {
|
|
|
207
208
|
createRemoteUpload(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateRemoteUploadParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileRemoteUploadResponse>;
|
|
208
209
|
private __createRemoteUpload;
|
|
209
210
|
/**
|
|
210
|
-
* Move file to a folder or version_stack. <br
|
|
211
|
+
* Move file to a folder or version_stack. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
211
212
|
*
|
|
212
213
|
* @param {Frameio.Uuid} accountId -
|
|
213
214
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -231,7 +232,7 @@ export declare class Files {
|
|
|
231
232
|
move(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request: Frameio.FileMoveParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
|
|
232
233
|
private __move;
|
|
233
234
|
/**
|
|
234
|
-
* Create new file under parent folder through local upload. <br
|
|
235
|
+
* Create new file under parent folder through local upload. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
235
236
|
*
|
|
236
237
|
* @param {Frameio.Uuid} accountId -
|
|
237
238
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -256,7 +257,7 @@ export declare class Files {
|
|
|
256
257
|
createLocalUpload(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateLocalUploadParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
|
|
257
258
|
private __createLocalUpload;
|
|
258
259
|
/**
|
|
259
|
-
* Show file upload status details. <br
|
|
260
|
+
* Show file upload status details. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
260
261
|
*
|
|
261
262
|
* @param {Frameio.Uuid} accountId -
|
|
262
263
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -274,5 +275,5 @@ export declare class Files {
|
|
|
274
275
|
*/
|
|
275
276
|
showFileUploadStatus(accountId: Frameio.Uuid, fileId: Frameio.Uuid, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileUploadStatusResponse>;
|
|
276
277
|
private __showFileUploadStatus;
|
|
277
|
-
protected _getAuthorizationHeader(): Promise<string
|
|
278
|
+
protected _getAuthorizationHeader(): Promise<string>;
|
|
278
279
|
}
|
|
@@ -42,6 +42,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
42
42
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
43
43
|
});
|
|
44
44
|
};
|
|
45
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
46
|
+
var t = {};
|
|
47
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
48
|
+
t[p] = s[p];
|
|
49
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
50
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
51
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
52
|
+
t[p[i]] = s[p[i]];
|
|
53
|
+
}
|
|
54
|
+
return t;
|
|
55
|
+
};
|
|
45
56
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
46
57
|
exports.Files = void 0;
|
|
47
58
|
const environments = __importStar(require("../../../../environments.js"));
|
|
@@ -53,11 +64,11 @@ const errors = __importStar(require("../../../../errors/index.js"));
|
|
|
53
64
|
* Manage Files and related operations.
|
|
54
65
|
*/
|
|
55
66
|
class Files {
|
|
56
|
-
constructor(_options
|
|
67
|
+
constructor(_options) {
|
|
57
68
|
this._options = _options;
|
|
58
69
|
}
|
|
59
70
|
/**
|
|
60
|
-
* List files in a given folder. <br
|
|
71
|
+
* List files in a given folder. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
61
72
|
*
|
|
62
73
|
* @param {Frameio.Uuid} accountId -
|
|
63
74
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -152,7 +163,7 @@ class Files {
|
|
|
152
163
|
});
|
|
153
164
|
}
|
|
154
165
|
/**
|
|
155
|
-
* Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br
|
|
166
|
+
* Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
156
167
|
*
|
|
157
168
|
* @param {Frameio.Uuid} accountId -
|
|
158
169
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -238,9 +249,9 @@ class Files {
|
|
|
238
249
|
}
|
|
239
250
|
/**
|
|
240
251
|
* Show file details.
|
|
241
|
-
* <br
|
|
252
|
+
* <br>
|
|
242
253
|
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
243
|
-
* <br
|
|
254
|
+
* <br>
|
|
244
255
|
* Note: if you include `media_links.original` and the user does not have permission to download the file
|
|
245
256
|
* then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
|
|
246
257
|
* watermarking is required for this user and isn't supported by the requested media_links, then the request will
|
|
@@ -249,7 +260,7 @@ class Files {
|
|
|
249
260
|
* `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
|
|
250
261
|
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
|
|
251
262
|
* the response payload. In short, the client must handle null media links gracefully.
|
|
252
|
-
* <br
|
|
263
|
+
* <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
253
264
|
*
|
|
254
265
|
* @param {Frameio.Uuid} accountId -
|
|
255
266
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -332,7 +343,7 @@ class Files {
|
|
|
332
343
|
});
|
|
333
344
|
}
|
|
334
345
|
/**
|
|
335
|
-
* Delete file by ID. <br
|
|
346
|
+
* Delete file by ID. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
336
347
|
*
|
|
337
348
|
* @param {Frameio.Uuid} accountId -
|
|
338
349
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -407,7 +418,7 @@ class Files {
|
|
|
407
418
|
});
|
|
408
419
|
}
|
|
409
420
|
/**
|
|
410
|
-
* Update file details. <br
|
|
421
|
+
* Update file details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
411
422
|
*
|
|
412
423
|
* @param {Frameio.Uuid} accountId -
|
|
413
424
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -490,7 +501,7 @@ class Files {
|
|
|
490
501
|
});
|
|
491
502
|
}
|
|
492
503
|
/**
|
|
493
|
-
* Copy file. <br
|
|
504
|
+
* Copy file. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
494
505
|
*
|
|
495
506
|
* @param {Frameio.Uuid} accountId -
|
|
496
507
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -506,6 +517,7 @@ class Files {
|
|
|
506
517
|
*
|
|
507
518
|
* @example
|
|
508
519
|
* await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
520
|
+
* copy_metadata: true,
|
|
509
521
|
* data: {
|
|
510
522
|
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
511
523
|
* }
|
|
@@ -517,15 +529,20 @@ class Files {
|
|
|
517
529
|
__copy(accountId_1, fileId_1) {
|
|
518
530
|
return __awaiter(this, arguments, void 0, function* (accountId, fileId, request = {}, requestOptions) {
|
|
519
531
|
var _a, _b, _c;
|
|
532
|
+
const { copy_metadata: copyMetadata } = request, _body = __rest(request, ["copy_metadata"]);
|
|
533
|
+
const _queryParams = {};
|
|
534
|
+
if (copyMetadata != null) {
|
|
535
|
+
_queryParams["copy_metadata"] = copyMetadata.toString();
|
|
536
|
+
}
|
|
520
537
|
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);
|
|
521
538
|
const _response = yield core.fetcher({
|
|
522
539
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.FrameioEnvironment.Default, `v4/accounts/${encodeURIComponent(accountId)}/files/${encodeURIComponent(fileId)}/copy`),
|
|
523
540
|
method: "POST",
|
|
524
541
|
headers: _headers,
|
|
525
542
|
contentType: "application/json",
|
|
526
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
543
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
527
544
|
requestType: "json",
|
|
528
|
-
body:
|
|
545
|
+
body: _body,
|
|
529
546
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
530
547
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
531
548
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -573,7 +590,7 @@ class Files {
|
|
|
573
590
|
});
|
|
574
591
|
}
|
|
575
592
|
/**
|
|
576
|
-
* Create new file under parent folder through remote upload. <br
|
|
593
|
+
* Create new file under parent folder through remote upload. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
577
594
|
*
|
|
578
595
|
* @param {Frameio.Uuid} accountId -
|
|
579
596
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -657,7 +674,7 @@ class Files {
|
|
|
657
674
|
});
|
|
658
675
|
}
|
|
659
676
|
/**
|
|
660
|
-
* Move file to a folder or version_stack. <br
|
|
677
|
+
* Move file to a folder or version_stack. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
661
678
|
*
|
|
662
679
|
* @param {Frameio.Uuid} accountId -
|
|
663
680
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -740,7 +757,7 @@ class Files {
|
|
|
740
757
|
});
|
|
741
758
|
}
|
|
742
759
|
/**
|
|
743
|
-
* Create new file under parent folder through local upload. <br
|
|
760
|
+
* Create new file under parent folder through local upload. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
744
761
|
*
|
|
745
762
|
* @param {Frameio.Uuid} accountId -
|
|
746
763
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -824,7 +841,7 @@ class Files {
|
|
|
824
841
|
});
|
|
825
842
|
}
|
|
826
843
|
/**
|
|
827
|
-
* Show file upload status details. <br
|
|
844
|
+
* Show file upload status details. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
828
845
|
*
|
|
829
846
|
* @param {Frameio.Uuid} accountId -
|
|
830
847
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -900,11 +917,7 @@ class Files {
|
|
|
900
917
|
}
|
|
901
918
|
_getAuthorizationHeader() {
|
|
902
919
|
return __awaiter(this, void 0, void 0, function* () {
|
|
903
|
-
|
|
904
|
-
if (bearer != null) {
|
|
905
|
-
return `Bearer ${bearer}`;
|
|
906
|
-
}
|
|
907
|
-
return undefined;
|
|
920
|
+
return `Bearer ${yield core.Supplier.get(this._options.token)}`;
|
|
908
921
|
});
|
|
909
922
|
}
|
|
910
923
|
}
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @example
|
|
3
3
|
* {
|
|
4
|
+
* copy_metadata: true,
|
|
4
5
|
* data: {
|
|
5
6
|
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
6
7
|
* }
|
|
7
8
|
* }
|
|
8
9
|
*/
|
|
9
10
|
export interface FileCopyParams {
|
|
11
|
+
/** Whether to copy metadata values along with the file */
|
|
12
|
+
copy_metadata?: boolean;
|
|
10
13
|
data?: FileCopyParams.Data;
|
|
11
14
|
}
|
|
12
15
|
export declare namespace FileCopyParams {
|
|
@@ -6,7 +6,7 @@ export declare namespace Folders {
|
|
|
6
6
|
environment?: core.Supplier<environments.FrameioEnvironment | string>;
|
|
7
7
|
/** Specify a custom URL to connect the client to. */
|
|
8
8
|
baseUrl?: core.Supplier<string>;
|
|
9
|
-
token
|
|
9
|
+
token: core.Supplier<core.BearerToken>;
|
|
10
10
|
/** Additional headers to include in requests. */
|
|
11
11
|
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
|
|
12
12
|
}
|
|
@@ -28,9 +28,9 @@ export declare namespace Folders {
|
|
|
28
28
|
*/
|
|
29
29
|
export declare class Folders {
|
|
30
30
|
protected readonly _options: Folders.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options: Folders.Options);
|
|
32
32
|
/**
|
|
33
|
-
* Show folder details. <br
|
|
33
|
+
* Show folder details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
34
34
|
*
|
|
35
35
|
* @param {Frameio.Uuid} accountId -
|
|
36
36
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -52,7 +52,7 @@ export declare class Folders {
|
|
|
52
52
|
show(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FoldersShowRequest, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FolderWithIncludesResponse>;
|
|
53
53
|
private __show;
|
|
54
54
|
/**
|
|
55
|
-
* Delete folder by id.
|
|
55
|
+
* Delete folder by id. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
56
56
|
*
|
|
57
57
|
* @param {Frameio.Uuid} accountId -
|
|
58
58
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -71,7 +71,7 @@ export declare class Folders {
|
|
|
71
71
|
delete(accountId: Frameio.Uuid, folderId: Frameio.Uuid, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<void>;
|
|
72
72
|
private __delete;
|
|
73
73
|
/**
|
|
74
|
-
* Update folder details.
|
|
74
|
+
* Update folder details. <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} folderId -
|
|
@@ -96,9 +96,9 @@ export declare class Folders {
|
|
|
96
96
|
private __update;
|
|
97
97
|
/**
|
|
98
98
|
* List the children in the given folder.
|
|
99
|
-
* <br
|
|
99
|
+
* <br>
|
|
100
100
|
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
101
|
-
* <br
|
|
101
|
+
* <br>
|
|
102
102
|
* Note: if you include `media_links.original` and the user does not have permission to download files
|
|
103
103
|
* in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
|
|
104
104
|
* If the content is inaccessible because watermarking is required for this user and isn't supported by
|
|
@@ -107,6 +107,7 @@ export declare class Folders {
|
|
|
107
107
|
* `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
|
|
108
108
|
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
|
|
109
109
|
* null in the response payload. In short, the client must handle null media links gracefully.
|
|
110
|
+
* <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
110
111
|
*
|
|
111
112
|
* @param {Frameio.Uuid} accountId -
|
|
112
113
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -132,7 +133,7 @@ export declare class Folders {
|
|
|
132
133
|
index(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FoldersIndexRequest, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.AssetsWithIncludesResponse>;
|
|
133
134
|
private __index;
|
|
134
135
|
/**
|
|
135
|
-
* Copy folder. <br
|
|
136
|
+
* Copy folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
136
137
|
*
|
|
137
138
|
* @param {Frameio.Uuid} accountId -
|
|
138
139
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -148,6 +149,7 @@ export declare class Folders {
|
|
|
148
149
|
*
|
|
149
150
|
* @example
|
|
150
151
|
* await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
152
|
+
* copy_metadata: true,
|
|
151
153
|
* data: {
|
|
152
154
|
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
153
155
|
* }
|
|
@@ -156,7 +158,7 @@ export declare class Folders {
|
|
|
156
158
|
copy(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FolderCopyParams, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FolderCopyResponse>;
|
|
157
159
|
private __copy;
|
|
158
160
|
/**
|
|
159
|
-
* List folders in a given folder. <br
|
|
161
|
+
* List folders in a given folder. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
160
162
|
*
|
|
161
163
|
* @param {Frameio.Uuid} accountId -
|
|
162
164
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -181,7 +183,7 @@ export declare class Folders {
|
|
|
181
183
|
list(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FoldersListRequest, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FoldersWithIncludesResponse>;
|
|
182
184
|
private __list;
|
|
183
185
|
/**
|
|
184
|
-
* Create a new folder inside the given <i>folder_id</i> path param. <br
|
|
186
|
+
* 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
|
|
185
187
|
*
|
|
186
188
|
* @param {Frameio.Uuid} accountId -
|
|
187
189
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -205,7 +207,7 @@ export declare class Folders {
|
|
|
205
207
|
create(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FolderCreateParams, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FolderResponse>;
|
|
206
208
|
private __create;
|
|
207
209
|
/**
|
|
208
|
-
* Move folder to a folder. <br
|
|
210
|
+
* Move folder to a folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
209
211
|
*
|
|
210
212
|
* @param {Frameio.Uuid} accountId -
|
|
211
213
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -228,5 +230,5 @@ export declare class Folders {
|
|
|
228
230
|
*/
|
|
229
231
|
move(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FolderMoveParams, requestOptions?: Folders.RequestOptions): core.HttpResponsePromise<Frameio.FolderResponse>;
|
|
230
232
|
private __move;
|
|
231
|
-
protected _getAuthorizationHeader(): Promise<string
|
|
233
|
+
protected _getAuthorizationHeader(): Promise<string>;
|
|
232
234
|
}
|
|
@@ -42,6 +42,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
42
42
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
43
43
|
});
|
|
44
44
|
};
|
|
45
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
46
|
+
var t = {};
|
|
47
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
48
|
+
t[p] = s[p];
|
|
49
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
50
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
51
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
52
|
+
t[p[i]] = s[p[i]];
|
|
53
|
+
}
|
|
54
|
+
return t;
|
|
55
|
+
};
|
|
45
56
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
46
57
|
exports.Folders = void 0;
|
|
47
58
|
const environments = __importStar(require("../../../../environments.js"));
|
|
@@ -53,11 +64,11 @@ const errors = __importStar(require("../../../../errors/index.js"));
|
|
|
53
64
|
* Manage Folders and related operations.
|
|
54
65
|
*/
|
|
55
66
|
class Folders {
|
|
56
|
-
constructor(_options
|
|
67
|
+
constructor(_options) {
|
|
57
68
|
this._options = _options;
|
|
58
69
|
}
|
|
59
70
|
/**
|
|
60
|
-
* Show folder details. <br
|
|
71
|
+
* Show folder details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
61
72
|
*
|
|
62
73
|
* @param {Frameio.Uuid} accountId -
|
|
63
74
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -140,7 +151,7 @@ class Folders {
|
|
|
140
151
|
});
|
|
141
152
|
}
|
|
142
153
|
/**
|
|
143
|
-
* Delete folder by id.
|
|
154
|
+
* Delete folder by id. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
144
155
|
*
|
|
145
156
|
* @param {Frameio.Uuid} accountId -
|
|
146
157
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -215,7 +226,7 @@ class Folders {
|
|
|
215
226
|
});
|
|
216
227
|
}
|
|
217
228
|
/**
|
|
218
|
-
* Update folder details.
|
|
229
|
+
* Update folder details. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
219
230
|
*
|
|
220
231
|
* @param {Frameio.Uuid} accountId -
|
|
221
232
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -299,9 +310,9 @@ class Folders {
|
|
|
299
310
|
}
|
|
300
311
|
/**
|
|
301
312
|
* List the children in the given folder.
|
|
302
|
-
* <br
|
|
313
|
+
* <br>
|
|
303
314
|
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
304
|
-
* <br
|
|
315
|
+
* <br>
|
|
305
316
|
* Note: if you include `media_links.original` and the user does not have permission to download files
|
|
306
317
|
* in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
|
|
307
318
|
* If the content is inaccessible because watermarking is required for this user and isn't supported by
|
|
@@ -310,6 +321,7 @@ class Folders {
|
|
|
310
321
|
* `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
|
|
311
322
|
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
|
|
312
323
|
* null in the response payload. In short, the client must handle null media links gracefully.
|
|
324
|
+
* <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
313
325
|
*
|
|
314
326
|
* @param {Frameio.Uuid} accountId -
|
|
315
327
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -408,7 +420,7 @@ class Folders {
|
|
|
408
420
|
});
|
|
409
421
|
}
|
|
410
422
|
/**
|
|
411
|
-
* Copy folder. <br
|
|
423
|
+
* Copy folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
412
424
|
*
|
|
413
425
|
* @param {Frameio.Uuid} accountId -
|
|
414
426
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -424,6 +436,7 @@ class Folders {
|
|
|
424
436
|
*
|
|
425
437
|
* @example
|
|
426
438
|
* await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
439
|
+
* copy_metadata: true,
|
|
427
440
|
* data: {
|
|
428
441
|
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
429
442
|
* }
|
|
@@ -435,15 +448,20 @@ class Folders {
|
|
|
435
448
|
__copy(accountId_1, folderId_1) {
|
|
436
449
|
return __awaiter(this, arguments, void 0, function* (accountId, folderId, request = {}, requestOptions) {
|
|
437
450
|
var _a, _b, _c;
|
|
451
|
+
const { copy_metadata: copyMetadata } = request, _body = __rest(request, ["copy_metadata"]);
|
|
452
|
+
const _queryParams = {};
|
|
453
|
+
if (copyMetadata != null) {
|
|
454
|
+
_queryParams["copy_metadata"] = copyMetadata.toString();
|
|
455
|
+
}
|
|
438
456
|
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);
|
|
439
457
|
const _response = yield core.fetcher({
|
|
440
458
|
url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.FrameioEnvironment.Default, `v4/accounts/${encodeURIComponent(accountId)}/folders/${encodeURIComponent(folderId)}/copy`),
|
|
441
459
|
method: "POST",
|
|
442
460
|
headers: _headers,
|
|
443
461
|
contentType: "application/json",
|
|
444
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
462
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
445
463
|
requestType: "json",
|
|
446
|
-
body:
|
|
464
|
+
body: _body,
|
|
447
465
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
448
466
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
449
467
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -491,7 +509,7 @@ class Folders {
|
|
|
491
509
|
});
|
|
492
510
|
}
|
|
493
511
|
/**
|
|
494
|
-
* List folders in a given folder. <br
|
|
512
|
+
* List folders in a given folder. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
495
513
|
*
|
|
496
514
|
* @param {Frameio.Uuid} accountId -
|
|
497
515
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -586,7 +604,7 @@ class Folders {
|
|
|
586
604
|
});
|
|
587
605
|
}
|
|
588
606
|
/**
|
|
589
|
-
* Create a new folder inside the given <i>folder_id</i> path param. <br
|
|
607
|
+
* 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
|
|
590
608
|
*
|
|
591
609
|
* @param {Frameio.Uuid} accountId -
|
|
592
610
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -669,7 +687,7 @@ class Folders {
|
|
|
669
687
|
});
|
|
670
688
|
}
|
|
671
689
|
/**
|
|
672
|
-
* Move folder to a folder. <br
|
|
690
|
+
* Move folder to a folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
673
691
|
*
|
|
674
692
|
* @param {Frameio.Uuid} accountId -
|
|
675
693
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -753,11 +771,7 @@ class Folders {
|
|
|
753
771
|
}
|
|
754
772
|
_getAuthorizationHeader() {
|
|
755
773
|
return __awaiter(this, void 0, void 0, function* () {
|
|
756
|
-
|
|
757
|
-
if (bearer != null) {
|
|
758
|
-
return `Bearer ${bearer}`;
|
|
759
|
-
}
|
|
760
|
-
return undefined;
|
|
774
|
+
return `Bearer ${yield core.Supplier.get(this._options.token)}`;
|
|
761
775
|
});
|
|
762
776
|
}
|
|
763
777
|
}
|
|
@@ -1,12 +1,15 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @example
|
|
3
3
|
* {
|
|
4
|
+
* copy_metadata: true,
|
|
4
5
|
* data: {
|
|
5
6
|
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
6
7
|
* }
|
|
7
8
|
* }
|
|
8
9
|
*/
|
|
9
10
|
export interface FolderCopyParams {
|
|
11
|
+
/** Whether to copy metadata values along with the folder */
|
|
12
|
+
copy_metadata?: boolean;
|
|
10
13
|
data?: FolderCopyParams.Data;
|
|
11
14
|
}
|
|
12
15
|
export declare namespace FolderCopyParams {
|
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
export * as metadataFields from "./metadataFields/index.js";
|
|
2
2
|
export * from "./metadataFields/types/index.js";
|
|
3
|
+
export * as versionStacks from "./versionStacks/index.js";
|
|
4
|
+
export * from "./versionStacks/types/index.js";
|
|
5
|
+
export * as comments from "./comments/index.js";
|
|
6
|
+
export * from "./comments/types/index.js";
|
|
3
7
|
export * as shares from "./shares/index.js";
|
|
4
8
|
export * from "./shares/types/index.js";
|
|
5
9
|
export * as projectPermissions from "./projectPermissions/index.js";
|
|
6
10
|
export * as folders from "./folders/index.js";
|
|
7
|
-
export * as versionStacks from "./versionStacks/index.js";
|
|
8
11
|
export * as accountPermissions from "./accountPermissions/index.js";
|
|
9
12
|
export * as accounts from "./accounts/index.js";
|
|
10
|
-
export * as comments from "./comments/index.js";
|
|
11
13
|
export * as webhooks from "./webhooks/index.js";
|
|
12
14
|
export * as workspacePermissions from "./workspacePermissions/index.js";
|
|
13
15
|
export * as metadata from "./metadata/index.js";
|
|
@@ -36,17 +36,19 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
36
36
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
37
37
|
};
|
|
38
38
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
39
|
-
exports.workspaces = exports.projects = exports.users = exports.files = exports.metadata = exports.workspacePermissions = exports.webhooks = exports.
|
|
39
|
+
exports.workspaces = exports.projects = exports.users = exports.files = exports.metadata = exports.workspacePermissions = exports.webhooks = exports.accounts = exports.accountPermissions = exports.folders = exports.projectPermissions = exports.shares = exports.comments = exports.versionStacks = exports.metadataFields = void 0;
|
|
40
40
|
exports.metadataFields = __importStar(require("./metadataFields/index.js"));
|
|
41
41
|
__exportStar(require("./metadataFields/types/index.js"), exports);
|
|
42
|
+
exports.versionStacks = __importStar(require("./versionStacks/index.js"));
|
|
43
|
+
__exportStar(require("./versionStacks/types/index.js"), exports);
|
|
44
|
+
exports.comments = __importStar(require("./comments/index.js"));
|
|
45
|
+
__exportStar(require("./comments/types/index.js"), exports);
|
|
42
46
|
exports.shares = __importStar(require("./shares/index.js"));
|
|
43
47
|
__exportStar(require("./shares/types/index.js"), exports);
|
|
44
48
|
exports.projectPermissions = __importStar(require("./projectPermissions/index.js"));
|
|
45
49
|
exports.folders = __importStar(require("./folders/index.js"));
|
|
46
|
-
exports.versionStacks = __importStar(require("./versionStacks/index.js"));
|
|
47
50
|
exports.accountPermissions = __importStar(require("./accountPermissions/index.js"));
|
|
48
51
|
exports.accounts = __importStar(require("./accounts/index.js"));
|
|
49
|
-
exports.comments = __importStar(require("./comments/index.js"));
|
|
50
52
|
exports.webhooks = __importStar(require("./webhooks/index.js"));
|
|
51
53
|
exports.workspacePermissions = __importStar(require("./workspacePermissions/index.js"));
|
|
52
54
|
exports.metadata = __importStar(require("./metadata/index.js"));
|