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
package/reference.md
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
<dl>
|
|
15
15
|
<dd>
|
|
16
16
|
|
|
17
|
-
Delete account level custom field definitions. <br
|
|
17
|
+
Delete account level custom field definitions. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
18
18
|
|
|
19
19
|
</dd>
|
|
20
20
|
</dl>
|
|
@@ -88,7 +88,7 @@ await client.metadataFields.metadataFieldDefinitionsDelete(
|
|
|
88
88
|
<dl>
|
|
89
89
|
<dd>
|
|
90
90
|
|
|
91
|
-
Update account level custom field definitions. <br
|
|
91
|
+
Update account level custom field definitions. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
92
92
|
|
|
93
93
|
</dd>
|
|
94
94
|
</dl>
|
|
@@ -187,7 +187,7 @@ await client.metadataFields.metadataFieldDefinitionsUpdate(
|
|
|
187
187
|
<dl>
|
|
188
188
|
<dd>
|
|
189
189
|
|
|
190
|
-
List account level field definitions. <br
|
|
190
|
+
List account level field definitions. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
191
191
|
|
|
192
192
|
</dd>
|
|
193
193
|
</dl>
|
|
@@ -263,7 +263,7 @@ await client.metadataFields.metadataFieldDefinitionsIndex("b2702c44-c6da-4bb6-8b
|
|
|
263
263
|
<dl>
|
|
264
264
|
<dd>
|
|
265
265
|
|
|
266
|
-
Create account level field definitions. <br
|
|
266
|
+
Create account level field definitions. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
267
267
|
|
|
268
268
|
</dd>
|
|
269
269
|
</dl>
|
|
@@ -352,7 +352,7 @@ await client.metadataFields.metadataFieldDefinitionsCreate("b2702c44-c6da-4bb6-8
|
|
|
352
352
|
<dl>
|
|
353
353
|
<dd>
|
|
354
354
|
|
|
355
|
-
List user roles for a given project. <br
|
|
355
|
+
List user roles for a given project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
356
356
|
|
|
357
357
|
</dd>
|
|
358
358
|
</dl>
|
|
@@ -436,7 +436,7 @@ await client.projectPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b
|
|
|
436
436
|
<dl>
|
|
437
437
|
<dd>
|
|
438
438
|
|
|
439
|
-
Remove a user from a given project. <br
|
|
439
|
+
Remove a user from a given project. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
440
440
|
|
|
441
441
|
</dd>
|
|
442
442
|
</dl>
|
|
@@ -520,7 +520,7 @@ await client.projectPermissions.delete(
|
|
|
520
520
|
<dd>
|
|
521
521
|
|
|
522
522
|
Update user roles for the given project if the user is already added to the project. If the user is
|
|
523
|
-
not added to the project, the user will be added with the given role. <br
|
|
523
|
+
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
|
|
524
524
|
|
|
525
525
|
</dd>
|
|
526
526
|
</dl>
|
|
@@ -618,7 +618,7 @@ await client.projectPermissions.projectUserRolesUpdate(
|
|
|
618
618
|
<dl>
|
|
619
619
|
<dd>
|
|
620
620
|
|
|
621
|
-
Show folder details. <br
|
|
621
|
+
Show folder details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
622
622
|
|
|
623
623
|
</dd>
|
|
624
624
|
</dl>
|
|
@@ -699,7 +699,7 @@ await client.folders.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
|
|
|
699
699
|
<dl>
|
|
700
700
|
<dd>
|
|
701
701
|
|
|
702
|
-
Delete folder by id. <br
|
|
702
|
+
Delete folder by id. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
703
703
|
|
|
704
704
|
</dd>
|
|
705
705
|
</dl>
|
|
@@ -770,7 +770,7 @@ await client.folders.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
|
|
|
770
770
|
<dl>
|
|
771
771
|
<dd>
|
|
772
772
|
|
|
773
|
-
Update folder details. <br
|
|
773
|
+
Update folder details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
774
774
|
|
|
775
775
|
</dd>
|
|
776
776
|
</dl>
|
|
@@ -854,9 +854,9 @@ await client.folders.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
|
|
|
854
854
|
<dd>
|
|
855
855
|
|
|
856
856
|
List the children in the given folder.
|
|
857
|
-
<br
|
|
857
|
+
<br/>
|
|
858
858
|
Use the `include` query parameter to selectively include additional properties in the response.
|
|
859
|
-
<br
|
|
859
|
+
<br/>
|
|
860
860
|
Note: if you include `media_links.original` and the user does not have permission to download files
|
|
861
861
|
in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
|
|
862
862
|
If the content is inaccessible because watermarking is required for this user and isn't supported by
|
|
@@ -865,7 +865,7 @@ Similarly, if a requested transcode link does not exist for a particular file (e
|
|
|
865
865
|
`media_links.video_h264_180` on a static image file) or transoding process hasn't finished
|
|
866
866
|
(i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
|
|
867
867
|
null in the response payload. In short, the client must handle null media links gracefully.
|
|
868
|
-
<br
|
|
868
|
+
<br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
869
869
|
|
|
870
870
|
</dd>
|
|
871
871
|
</dl>
|
|
@@ -882,7 +882,7 @@ null in the response payload. In short, the client must handle null media links
|
|
|
882
882
|
|
|
883
883
|
```typescript
|
|
884
884
|
await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
885
|
-
include: "media_links",
|
|
885
|
+
include: "media_links.original",
|
|
886
886
|
type: "file,folder,version_stack",
|
|
887
887
|
after: "<opaque_cursor>",
|
|
888
888
|
page_size: 10,
|
|
@@ -950,7 +950,7 @@ await client.folders.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
|
|
|
950
950
|
<dl>
|
|
951
951
|
<dd>
|
|
952
952
|
|
|
953
|
-
Copy folder. <br
|
|
953
|
+
Copy folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
954
954
|
|
|
955
955
|
</dd>
|
|
956
956
|
</dl>
|
|
@@ -1034,7 +1034,7 @@ await client.folders.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
|
|
|
1034
1034
|
<dl>
|
|
1035
1035
|
<dd>
|
|
1036
1036
|
|
|
1037
|
-
List folders in a given folder. <br
|
|
1037
|
+
List folders in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
1038
1038
|
|
|
1039
1039
|
</dd>
|
|
1040
1040
|
</dl>
|
|
@@ -1118,7 +1118,7 @@ await client.folders.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
|
|
|
1118
1118
|
<dl>
|
|
1119
1119
|
<dd>
|
|
1120
1120
|
|
|
1121
|
-
Create a new folder inside the given <i>folder_id</i> path param. <br
|
|
1121
|
+
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
|
|
1122
1122
|
|
|
1123
1123
|
</dd>
|
|
1124
1124
|
</dl>
|
|
@@ -1201,7 +1201,7 @@ await client.folders.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
|
|
|
1201
1201
|
<dl>
|
|
1202
1202
|
<dd>
|
|
1203
1203
|
|
|
1204
|
-
Move folder to a folder. <br
|
|
1204
|
+
Move folder to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
1205
1205
|
|
|
1206
1206
|
</dd>
|
|
1207
1207
|
</dl>
|
|
@@ -1287,9 +1287,9 @@ await client.folders.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
|
|
|
1287
1287
|
<dd>
|
|
1288
1288
|
|
|
1289
1289
|
List the children (files) in a given version stack.
|
|
1290
|
-
<br
|
|
1290
|
+
<br/>
|
|
1291
1291
|
Use the `include` query parameter to selectively include additional properties in the response.
|
|
1292
|
-
<br
|
|
1292
|
+
<br/>
|
|
1293
1293
|
Note: if you include `media_links.original` and the user does not have permission to download files
|
|
1294
1294
|
in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
|
|
1295
1295
|
If the content is inaccessible because watermarking is required for this user and isn't supported by
|
|
@@ -1298,7 +1298,7 @@ Similarly, if a requested transcode link does not exist for a particular file (e
|
|
|
1298
1298
|
`media_links.video_h264_180` on a static image file) or transoding process hasn't finished
|
|
1299
1299
|
(i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
|
|
1300
1300
|
null in the response payload. In short, the client must handle null media links gracefully.
|
|
1301
|
-
<br
|
|
1301
|
+
<br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
1302
1302
|
|
|
1303
1303
|
</dd>
|
|
1304
1304
|
</dl>
|
|
@@ -1315,7 +1315,7 @@ null in the response payload. In short, the client must handle null media links
|
|
|
1315
1315
|
|
|
1316
1316
|
```typescript
|
|
1317
1317
|
await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
1318
|
-
include: "media_links",
|
|
1318
|
+
include: "media_links.original",
|
|
1319
1319
|
after: "<opaque_cursor>",
|
|
1320
1320
|
page_size: 10,
|
|
1321
1321
|
include_total_count: false,
|
|
@@ -1382,7 +1382,7 @@ await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
|
|
|
1382
1382
|
<dl>
|
|
1383
1383
|
<dd>
|
|
1384
1384
|
|
|
1385
|
-
Show version stack details. <br
|
|
1385
|
+
Show version stack details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
1386
1386
|
|
|
1387
1387
|
</dd>
|
|
1388
1388
|
</dl>
|
|
@@ -1399,7 +1399,7 @@ Show version stack details. <br>Rate Limits: 100 calls per 1.00 minute(s) per ac
|
|
|
1399
1399
|
|
|
1400
1400
|
```typescript
|
|
1401
1401
|
await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
1402
|
-
include: "media_links",
|
|
1402
|
+
include: "media_links.original",
|
|
1403
1403
|
});
|
|
1404
1404
|
```
|
|
1405
1405
|
|
|
@@ -1463,7 +1463,7 @@ await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
|
|
|
1463
1463
|
<dl>
|
|
1464
1464
|
<dd>
|
|
1465
1465
|
|
|
1466
|
-
Copy version stack. <br
|
|
1466
|
+
Copy version stack. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
1467
1467
|
|
|
1468
1468
|
</dd>
|
|
1469
1469
|
</dl>
|
|
@@ -1547,7 +1547,7 @@ await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
|
|
|
1547
1547
|
<dl>
|
|
1548
1548
|
<dd>
|
|
1549
1549
|
|
|
1550
|
-
List version stacks in a given folder. <br
|
|
1550
|
+
List version stacks in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
1551
1551
|
|
|
1552
1552
|
</dd>
|
|
1553
1553
|
</dl>
|
|
@@ -1564,7 +1564,7 @@ List version stacks in a given folder. <br>Rate Limits: 5 calls per 1 second(s)
|
|
|
1564
1564
|
|
|
1565
1565
|
```typescript
|
|
1566
1566
|
await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
1567
|
-
include: "media_links",
|
|
1567
|
+
include: "media_links.original",
|
|
1568
1568
|
after: "<opaque_cursor>",
|
|
1569
1569
|
page_size: 10,
|
|
1570
1570
|
include_total_count: false,
|
|
@@ -1631,7 +1631,7 @@ await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
|
|
|
1631
1631
|
<dl>
|
|
1632
1632
|
<dd>
|
|
1633
1633
|
|
|
1634
|
-
Create a new Version Stack under the parent folder. <br
|
|
1634
|
+
Create a new Version Stack under the parent folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
1635
1635
|
|
|
1636
1636
|
</dd>
|
|
1637
1637
|
</dl>
|
|
@@ -1649,7 +1649,7 @@ Create a new Version Stack under the parent folder. <br>Rate Limits: 10 calls pe
|
|
|
1649
1649
|
```typescript
|
|
1650
1650
|
await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
1651
1651
|
data: {
|
|
1652
|
-
file_ids: ["
|
|
1652
|
+
file_ids: ["7c450236-f817-4ab1-bdc9-9c6df277dce6", "fd194c47-8352-4cc3-8f25-f7a5cb8282d0"],
|
|
1653
1653
|
},
|
|
1654
1654
|
});
|
|
1655
1655
|
```
|
|
@@ -1714,7 +1714,7 @@ await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702
|
|
|
1714
1714
|
<dl>
|
|
1715
1715
|
<dd>
|
|
1716
1716
|
|
|
1717
|
-
Move version stack to a folder. <br
|
|
1717
|
+
Move version stack to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
1718
1718
|
|
|
1719
1719
|
</dd>
|
|
1720
1720
|
</dl>
|
|
@@ -1799,7 +1799,7 @@ await client.versionStacks.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c4
|
|
|
1799
1799
|
<dl>
|
|
1800
1800
|
<dd>
|
|
1801
1801
|
|
|
1802
|
-
List user roles for a given account. <br
|
|
1802
|
+
List user roles for a given account. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
1803
1803
|
|
|
1804
1804
|
</dd>
|
|
1805
1805
|
</dl>
|
|
@@ -1877,7 +1877,7 @@ await client.accountPermissions.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
|
1877
1877
|
<dl>
|
|
1878
1878
|
<dd>
|
|
1879
1879
|
|
|
1880
|
-
List accounts for the current user. <br
|
|
1880
|
+
List accounts for the current user. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
1881
1881
|
|
|
1882
1882
|
</dd>
|
|
1883
1883
|
</dl>
|
|
@@ -1944,7 +1944,7 @@ await client.accounts.index({
|
|
|
1944
1944
|
<dl>
|
|
1945
1945
|
<dd>
|
|
1946
1946
|
|
|
1947
|
-
List audit logs with filtering capabilities via query params. <br
|
|
1947
|
+
List audit logs with filtering capabilities via query params. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
1948
1948
|
|
|
1949
1949
|
</dd>
|
|
1950
1950
|
</dl>
|
|
@@ -2022,7 +2022,7 @@ await client.accounts.auditlogIndex("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
|
2022
2022
|
<dl>
|
|
2023
2023
|
<dd>
|
|
2024
2024
|
|
|
2025
|
-
Show a single comment on a file. <br
|
|
2025
|
+
Show a single comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
2026
2026
|
|
|
2027
2027
|
</dd>
|
|
2028
2028
|
</dl>
|
|
@@ -2104,7 +2104,7 @@ await client.comments.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
|
|
|
2104
2104
|
<dl>
|
|
2105
2105
|
<dd>
|
|
2106
2106
|
|
|
2107
|
-
Delete comment from an asset. <br
|
|
2107
|
+
Delete comment from an asset. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
2108
2108
|
|
|
2109
2109
|
</dd>
|
|
2110
2110
|
</dl>
|
|
@@ -2175,7 +2175,7 @@ await client.comments.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
|
|
|
2175
2175
|
<dl>
|
|
2176
2176
|
<dd>
|
|
2177
2177
|
|
|
2178
|
-
Update comment on given asset. <br
|
|
2178
|
+
Update comment on given asset. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
2179
2179
|
|
|
2180
2180
|
</dd>
|
|
2181
2181
|
</dl>
|
|
@@ -2263,7 +2263,7 @@ await client.comments.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
|
|
|
2263
2263
|
<dl>
|
|
2264
2264
|
<dd>
|
|
2265
2265
|
|
|
2266
|
-
List comments on a given asset. <br
|
|
2266
|
+
List comments on a given asset. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
2267
2267
|
|
|
2268
2268
|
</dd>
|
|
2269
2269
|
</dl>
|
|
@@ -2348,7 +2348,7 @@ await client.comments.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
|
|
|
2348
2348
|
<dl>
|
|
2349
2349
|
<dd>
|
|
2350
2350
|
|
|
2351
|
-
Create a comment on a file. <br
|
|
2351
|
+
Create a comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
2352
2352
|
|
|
2353
2353
|
</dd>
|
|
2354
2354
|
</dl>
|
|
@@ -2439,7 +2439,7 @@ await client.comments.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
|
|
|
2439
2439
|
<dl>
|
|
2440
2440
|
<dd>
|
|
2441
2441
|
|
|
2442
|
-
List webhooks for the given workspace. <br
|
|
2442
|
+
List webhooks for the given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
2443
2443
|
|
|
2444
2444
|
</dd>
|
|
2445
2445
|
</dl>
|
|
@@ -2527,7 +2527,7 @@ Creates a single webhook with secret.<br/><br/>Valid events:<p><code>
|
|
|
2527
2527
|
file.created, file.deleted, file.ready, file.updated, file.upload.completed, file.versioned, file.copied, folder.created, folder.deleted, folder.updated, folder.copied, comment.completed, comment.created, comment.deleted, comment.uncompleted, comment.updated, customfield.created, customfield.updated, customfield.deleted, metadata.value.updated, project.created, project.deleted, project.updated, collection.created, collection.updated, collection.deleted, share.created, share.updated, share.deleted, share.viewed
|
|
2528
2528
|
</code>
|
|
2529
2529
|
|
|
2530
|
-
</p>. <br
|
|
2530
|
+
</p>. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
2531
2531
|
</dd>
|
|
2532
2532
|
</dl>
|
|
2533
2533
|
</dd>
|
|
@@ -2642,7 +2642,7 @@ await client.webhooks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
|
|
|
2642
2642
|
<dl>
|
|
2643
2643
|
<dd>
|
|
2644
2644
|
|
|
2645
|
-
Show webhook details. <br
|
|
2645
|
+
Show webhook details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
2646
2646
|
|
|
2647
2647
|
</dd>
|
|
2648
2648
|
</dl>
|
|
@@ -2723,7 +2723,7 @@ await client.webhooks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
|
|
|
2723
2723
|
<dl>
|
|
2724
2724
|
<dd>
|
|
2725
2725
|
|
|
2726
|
-
Delete a webhook. <br
|
|
2726
|
+
Delete a webhook. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
2727
2727
|
|
|
2728
2728
|
</dd>
|
|
2729
2729
|
</dl>
|
|
@@ -2794,7 +2794,7 @@ await client.webhooks.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
|
|
|
2794
2794
|
<dl>
|
|
2795
2795
|
<dd>
|
|
2796
2796
|
|
|
2797
|
-
Update webhook details. <br
|
|
2797
|
+
Update webhook details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
2798
2798
|
|
|
2799
2799
|
</dd>
|
|
2800
2800
|
</dl>
|
|
@@ -2913,7 +2913,7 @@ await client.webhooks.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
|
|
|
2913
2913
|
<dl>
|
|
2914
2914
|
<dd>
|
|
2915
2915
|
|
|
2916
|
-
List user roles for a given workspace. <br
|
|
2916
|
+
List user roles for a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
2917
2917
|
|
|
2918
2918
|
</dd>
|
|
2919
2919
|
</dl>
|
|
@@ -3001,7 +3001,7 @@ await client.workspacePermissions.index(
|
|
|
3001
3001
|
<dl>
|
|
3002
3002
|
<dd>
|
|
3003
3003
|
|
|
3004
|
-
Remove a user from a given workspace. <br
|
|
3004
|
+
Remove a user from a given workspace. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
3005
3005
|
|
|
3006
3006
|
</dd>
|
|
3007
3007
|
</dl>
|
|
@@ -3085,7 +3085,7 @@ await client.workspacePermissions.workspaceUserRolesDelete(
|
|
|
3085
3085
|
<dd>
|
|
3086
3086
|
|
|
3087
3087
|
Update user roles for the given workspace if the user is already added to the workspace. If the user is
|
|
3088
|
-
not added to the workspace, the user will be added with the given role. <br
|
|
3088
|
+
not added to the workspace, the user will be added with the given role. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
3089
3089
|
|
|
3090
3090
|
</dd>
|
|
3091
3091
|
</dl>
|
|
@@ -3183,7 +3183,7 @@ await client.workspacePermissions.workspaceUserRolesUpdate(
|
|
|
3183
3183
|
<dl>
|
|
3184
3184
|
<dd>
|
|
3185
3185
|
|
|
3186
|
-
Show a single Share. <br
|
|
3186
|
+
Show a single Share. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
3187
3187
|
|
|
3188
3188
|
</dd>
|
|
3189
3189
|
</dl>
|
|
@@ -3254,7 +3254,7 @@ await client.shares.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-
|
|
|
3254
3254
|
<dl>
|
|
3255
3255
|
<dd>
|
|
3256
3256
|
|
|
3257
|
-
Delete a share. <br
|
|
3257
|
+
Delete a share. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
3258
3258
|
|
|
3259
3259
|
</dd>
|
|
3260
3260
|
</dl>
|
|
@@ -3325,7 +3325,7 @@ await client.shares.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
|
|
|
3325
3325
|
<dl>
|
|
3326
3326
|
<dd>
|
|
3327
3327
|
|
|
3328
|
-
Update share. <br
|
|
3328
|
+
Update share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
3329
3329
|
|
|
3330
3330
|
</dd>
|
|
3331
3331
|
</dl>
|
|
@@ -3346,7 +3346,7 @@ await client.shares.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
|
|
|
3346
3346
|
access: "public",
|
|
3347
3347
|
description: "A descriptive summary of the share",
|
|
3348
3348
|
downloading_enabled: true,
|
|
3349
|
-
expiration: "2026-
|
|
3349
|
+
expiration: "2026-03-02T23:37:00Z",
|
|
3350
3350
|
name: "Share Name",
|
|
3351
3351
|
passphrase: "as!dfj39sd(*",
|
|
3352
3352
|
},
|
|
@@ -3413,7 +3413,7 @@ await client.shares.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
|
|
|
3413
3413
|
<dl>
|
|
3414
3414
|
<dd>
|
|
3415
3415
|
|
|
3416
|
-
List share reviewers. <br
|
|
3416
|
+
List share reviewers. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
3417
3417
|
|
|
3418
3418
|
</dd>
|
|
3419
3419
|
</dl>
|
|
@@ -3497,11 +3497,11 @@ await client.shares.listReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702
|
|
|
3497
3497
|
<dd>
|
|
3498
3498
|
|
|
3499
3499
|
Add reviewers to secure share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
|
|
3500
|
-
<br
|
|
3500
|
+
<br/>
|
|
3501
3501
|
A request can only include one identifier type parameter.
|
|
3502
|
-
<br
|
|
3502
|
+
<br/>
|
|
3503
3503
|
`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.
|
|
3504
|
-
<br
|
|
3504
|
+
<br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
3505
3505
|
|
|
3506
3506
|
</dd>
|
|
3507
3507
|
</dl>
|
|
@@ -3588,9 +3588,9 @@ await client.shares.addReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
|
|
|
3588
3588
|
<dd>
|
|
3589
3589
|
|
|
3590
3590
|
Removes reviewers from secure Share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
|
|
3591
|
-
<br
|
|
3591
|
+
<br/>
|
|
3592
3592
|
A request can only include one identifier type parameter.
|
|
3593
|
-
<br
|
|
3593
|
+
<br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
3594
3594
|
|
|
3595
3595
|
</dd>
|
|
3596
3596
|
</dl>
|
|
@@ -3675,7 +3675,7 @@ await client.shares.removeReviewers("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b27
|
|
|
3675
3675
|
<dl>
|
|
3676
3676
|
<dd>
|
|
3677
3677
|
|
|
3678
|
-
Remove an asset currently in the share from that share. <br
|
|
3678
|
+
Remove an asset currently in the share from that share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
3679
3679
|
|
|
3680
3680
|
</dd>
|
|
3681
3681
|
</dl>
|
|
@@ -3758,7 +3758,7 @@ await client.shares.removeAsset(
|
|
|
3758
3758
|
<dl>
|
|
3759
3759
|
<dd>
|
|
3760
3760
|
|
|
3761
|
-
Add new asset share. <br
|
|
3761
|
+
Add new asset share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
3762
3762
|
|
|
3763
3763
|
</dd>
|
|
3764
3764
|
</dl>
|
|
@@ -3776,7 +3776,7 @@ Add new asset share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_us
|
|
|
3776
3776
|
```typescript
|
|
3777
3777
|
await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
3778
3778
|
data: {
|
|
3779
|
-
asset_id: "
|
|
3779
|
+
asset_id: "0874135d-c18e-4963-a7ca-f934a78e22a8",
|
|
3780
3780
|
},
|
|
3781
3781
|
});
|
|
3782
3782
|
```
|
|
@@ -3841,7 +3841,7 @@ await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
|
|
|
3841
3841
|
<dl>
|
|
3842
3842
|
<dd>
|
|
3843
3843
|
|
|
3844
|
-
List shares on a project. <br
|
|
3844
|
+
List shares on a project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
3845
3845
|
|
|
3846
3846
|
</dd>
|
|
3847
3847
|
</dl>
|
|
@@ -3924,7 +3924,7 @@ await client.shares.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
|
|
|
3924
3924
|
<dl>
|
|
3925
3925
|
<dd>
|
|
3926
3926
|
|
|
3927
|
-
Create share. <br
|
|
3927
|
+
Create share. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
3928
3928
|
|
|
3929
3929
|
</dd>
|
|
3930
3930
|
</dl>
|
|
@@ -3944,9 +3944,9 @@ await client.shares.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
|
|
|
3944
3944
|
data: {
|
|
3945
3945
|
type: "asset",
|
|
3946
3946
|
access: "public",
|
|
3947
|
-
asset_ids: ["
|
|
3947
|
+
asset_ids: ["991a9e84-ed04-4aee-9672-4ab34e64057a", "8bacca0d-18d6-4d9c-9a13-d2399e6b24a2"],
|
|
3948
3948
|
downloading_enabled: true,
|
|
3949
|
-
expiration: "2026-
|
|
3949
|
+
expiration: "2026-03-02T23:37:00Z",
|
|
3950
3950
|
name: "Share Name",
|
|
3951
3951
|
passphrase: "as!dfj39sd(*",
|
|
3952
3952
|
},
|
|
@@ -4015,7 +4015,7 @@ await client.shares.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
|
|
|
4015
4015
|
<dl>
|
|
4016
4016
|
<dd>
|
|
4017
4017
|
|
|
4018
|
-
Update metadata values across multiple files. <br
|
|
4018
|
+
Update metadata values across multiple files. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
4019
4019
|
|
|
4020
4020
|
</dd>
|
|
4021
4021
|
</dl>
|
|
@@ -4033,17 +4033,17 @@ Update metadata values across multiple files. <br>Rate Limits: 10 calls per 1.00
|
|
|
4033
4033
|
```typescript
|
|
4034
4034
|
await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
4035
4035
|
data: {
|
|
4036
|
-
file_ids: ["
|
|
4036
|
+
file_ids: ["1c072284-09bf-4067-b47d-e3dc9eb19e42", "f41e89a9-f338-43fe-9485-628d38cd5870"],
|
|
4037
4037
|
values: [
|
|
4038
4038
|
{
|
|
4039
|
-
field_definition_id: "
|
|
4039
|
+
field_definition_id: "cb90501e-d6fe-472e-b189-3e81d41dfff8",
|
|
4040
4040
|
value: [
|
|
4041
4041
|
{
|
|
4042
|
-
id: "
|
|
4042
|
+
id: "a0da7633-6ed3-489b-87a4-4dd39395fb65",
|
|
4043
4043
|
type: "user",
|
|
4044
4044
|
},
|
|
4045
4045
|
{
|
|
4046
|
-
id: "
|
|
4046
|
+
id: "96fbf6fb-ba96-4289-8adf-03241cb1f1f2",
|
|
4047
4047
|
type: "account_user_group",
|
|
4048
4048
|
},
|
|
4049
4049
|
],
|
|
@@ -4113,7 +4113,7 @@ await client.metadata.bulkUpdate("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c
|
|
|
4113
4113
|
<dl>
|
|
4114
4114
|
<dd>
|
|
4115
4115
|
|
|
4116
|
-
Show the metadata of a file. <br
|
|
4116
|
+
Show the metadata of a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
4117
4117
|
|
|
4118
4118
|
</dd>
|
|
4119
4119
|
</dl>
|
|
@@ -4196,7 +4196,7 @@ await client.metadata.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
|
|
|
4196
4196
|
<dl>
|
|
4197
4197
|
<dd>
|
|
4198
4198
|
|
|
4199
|
-
List files in a given folder. <br
|
|
4199
|
+
List files in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
4200
4200
|
|
|
4201
4201
|
</dd>
|
|
4202
4202
|
</dl>
|
|
@@ -4213,7 +4213,7 @@ List files in a given folder. <br>Rate Limits: 5 calls per 1 second(s) per accou
|
|
|
4213
4213
|
|
|
4214
4214
|
```typescript
|
|
4215
4215
|
await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
4216
|
-
include: "media_links",
|
|
4216
|
+
include: "media_links.original",
|
|
4217
4217
|
sort: "name_asc",
|
|
4218
4218
|
after: "<opaque_cursor>",
|
|
4219
4219
|
page_size: 10,
|
|
@@ -4281,7 +4281,7 @@ await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4
|
|
|
4281
4281
|
<dl>
|
|
4282
4282
|
<dd>
|
|
4283
4283
|
|
|
4284
|
-
Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br
|
|
4284
|
+
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
|
|
4285
4285
|
|
|
4286
4286
|
</dd>
|
|
4287
4287
|
</dl>
|
|
@@ -4367,9 +4367,9 @@ await client.files.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
|
|
|
4367
4367
|
<dd>
|
|
4368
4368
|
|
|
4369
4369
|
Show file details.
|
|
4370
|
-
<br
|
|
4370
|
+
<br/>
|
|
4371
4371
|
Use the `include` query parameter to selectively include additional properties in the response.
|
|
4372
|
-
<br
|
|
4372
|
+
<br/>
|
|
4373
4373
|
Note: if you include `media_links.original` and the user does not have permission to download the file
|
|
4374
4374
|
then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
|
|
4375
4375
|
watermarking is required for this user and isn't supported by the requested media_links, then the request will
|
|
@@ -4378,7 +4378,7 @@ Similarly, if a requested transcode link does not exist for a particular file (e
|
|
|
4378
4378
|
`media_links.video_h264_180` on a static image file) or transoding process hasn't completed
|
|
4379
4379
|
(i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
|
|
4380
4380
|
the response payload. In short, the client must handle null media links gracefully.
|
|
4381
|
-
<br
|
|
4381
|
+
<br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
4382
4382
|
|
|
4383
4383
|
</dd>
|
|
4384
4384
|
</dl>
|
|
@@ -4395,7 +4395,7 @@ the response payload. In short, the client must handle null media links graceful
|
|
|
4395
4395
|
|
|
4396
4396
|
```typescript
|
|
4397
4397
|
await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
4398
|
-
include: "media_links",
|
|
4398
|
+
include: "media_links.original",
|
|
4399
4399
|
});
|
|
4400
4400
|
```
|
|
4401
4401
|
|
|
@@ -4459,7 +4459,7 @@ await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4
|
|
|
4459
4459
|
<dl>
|
|
4460
4460
|
<dd>
|
|
4461
4461
|
|
|
4462
|
-
Delete file by ID. <br
|
|
4462
|
+
Delete file by ID. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
4463
4463
|
|
|
4464
4464
|
</dd>
|
|
4465
4465
|
</dl>
|
|
@@ -4530,7 +4530,7 @@ await client.files.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
|
|
|
4530
4530
|
<dl>
|
|
4531
4531
|
<dd>
|
|
4532
4532
|
|
|
4533
|
-
Update file details. <br
|
|
4533
|
+
Update file details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
4534
4534
|
|
|
4535
4535
|
</dd>
|
|
4536
4536
|
</dl>
|
|
@@ -4613,7 +4613,7 @@ await client.files.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da
|
|
|
4613
4613
|
<dl>
|
|
4614
4614
|
<dd>
|
|
4615
4615
|
|
|
4616
|
-
Copy file. <br
|
|
4616
|
+
Copy file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
4617
4617
|
|
|
4618
4618
|
</dd>
|
|
4619
4619
|
</dl>
|
|
@@ -4698,7 +4698,7 @@ await client.files.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4
|
|
|
4698
4698
|
<dl>
|
|
4699
4699
|
<dd>
|
|
4700
4700
|
|
|
4701
|
-
Create new file under parent folder through remote upload. <br
|
|
4701
|
+
Create new file under parent folder through remote upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
4702
4702
|
|
|
4703
4703
|
</dd>
|
|
4704
4704
|
</dl>
|
|
@@ -4782,7 +4782,7 @@ await client.files.createRemoteUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b
|
|
|
4782
4782
|
<dl>
|
|
4783
4783
|
<dd>
|
|
4784
4784
|
|
|
4785
|
-
Move file to a folder or version_stack. <br
|
|
4785
|
+
Move file to a folder or version_stack. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
4786
4786
|
|
|
4787
4787
|
</dd>
|
|
4788
4788
|
</dl>
|
|
@@ -4865,7 +4865,7 @@ await client.files.move("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4
|
|
|
4865
4865
|
<dl>
|
|
4866
4866
|
<dd>
|
|
4867
4867
|
|
|
4868
|
-
Create new file under parent folder through local upload. <br
|
|
4868
|
+
Create new file under parent folder through local upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
4869
4869
|
|
|
4870
4870
|
</dd>
|
|
4871
4871
|
</dl>
|
|
@@ -4949,7 +4949,7 @@ await client.files.createLocalUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2
|
|
|
4949
4949
|
<dl>
|
|
4950
4950
|
<dd>
|
|
4951
4951
|
|
|
4952
|
-
Import a file from a storage location configured on the account. <br
|
|
4952
|
+
Import a file from a storage location configured on the account. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
4953
4953
|
|
|
4954
4954
|
</dd>
|
|
4955
4955
|
</dl>
|
|
@@ -5034,7 +5034,7 @@ await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-
|
|
|
5034
5034
|
<dl>
|
|
5035
5035
|
<dd>
|
|
5036
5036
|
|
|
5037
|
-
Show file upload status details. <br
|
|
5037
|
+
Show file upload status details. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
5038
5038
|
|
|
5039
5039
|
</dd>
|
|
5040
5040
|
</dl>
|
|
@@ -5107,7 +5107,7 @@ await client.files.showFileUploadStatus("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b",
|
|
|
5107
5107
|
<dl>
|
|
5108
5108
|
<dd>
|
|
5109
5109
|
|
|
5110
|
-
Inspect details of the user associated with the bearer token. <br
|
|
5110
|
+
Inspect details of the user associated with the bearer token. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
5111
5111
|
|
|
5112
5112
|
</dd>
|
|
5113
5113
|
</dl>
|
|
@@ -5164,7 +5164,7 @@ await client.users.show();
|
|
|
5164
5164
|
<dl>
|
|
5165
5165
|
<dd>
|
|
5166
5166
|
|
|
5167
|
-
Show project details. <br
|
|
5167
|
+
Show project details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
5168
5168
|
|
|
5169
5169
|
</dd>
|
|
5170
5170
|
</dl>
|
|
@@ -5245,7 +5245,7 @@ await client.projects.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6d
|
|
|
5245
5245
|
<dl>
|
|
5246
5246
|
<dd>
|
|
5247
5247
|
|
|
5248
|
-
Delete a project. <br
|
|
5248
|
+
Delete a project. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
5249
5249
|
|
|
5250
5250
|
</dd>
|
|
5251
5251
|
</dl>
|
|
@@ -5316,7 +5316,7 @@ await client.projects.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
|
|
|
5316
5316
|
<dl>
|
|
5317
5317
|
<dd>
|
|
5318
5318
|
|
|
5319
|
-
Update project details. <br
|
|
5319
|
+
Update project details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
5320
5320
|
|
|
5321
5321
|
</dd>
|
|
5322
5322
|
</dl>
|
|
@@ -5401,7 +5401,7 @@ await client.projects.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
|
|
|
5401
5401
|
<dl>
|
|
5402
5402
|
<dd>
|
|
5403
5403
|
|
|
5404
|
-
List projects in a given workspace. <br
|
|
5404
|
+
List projects in a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
5405
5405
|
|
|
5406
5406
|
</dd>
|
|
5407
5407
|
</dl>
|
|
@@ -5485,7 +5485,7 @@ await client.projects.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6
|
|
|
5485
5485
|
<dl>
|
|
5486
5486
|
<dd>
|
|
5487
5487
|
|
|
5488
|
-
Create project in a given workspace. <br
|
|
5488
|
+
Create project in a given workspace. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
5489
5489
|
|
|
5490
5490
|
</dd>
|
|
5491
5491
|
</dl>
|
|
@@ -5571,7 +5571,7 @@ await client.projects.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
|
|
|
5571
5571
|
<dl>
|
|
5572
5572
|
<dd>
|
|
5573
5573
|
|
|
5574
|
-
Show workspace details. <br
|
|
5574
|
+
Show workspace details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
5575
5575
|
|
|
5576
5576
|
</dd>
|
|
5577
5577
|
</dl>
|
|
@@ -5652,7 +5652,7 @@ await client.workspaces.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c
|
|
|
5652
5652
|
<dl>
|
|
5653
5653
|
<dd>
|
|
5654
5654
|
|
|
5655
|
-
Delete workspace from account. <br
|
|
5655
|
+
Delete workspace from account. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
5656
5656
|
|
|
5657
5657
|
</dd>
|
|
5658
5658
|
</dl>
|
|
@@ -5723,7 +5723,7 @@ await client.workspaces.delete("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44
|
|
|
5723
5723
|
<dl>
|
|
5724
5724
|
<dd>
|
|
5725
5725
|
|
|
5726
|
-
Update a workspace. <br
|
|
5726
|
+
Update a workspace. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
5727
5727
|
|
|
5728
5728
|
</dd>
|
|
5729
5729
|
</dl>
|
|
@@ -5806,7 +5806,7 @@ await client.workspaces.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44
|
|
|
5806
5806
|
<dl>
|
|
5807
5807
|
<dd>
|
|
5808
5808
|
|
|
5809
|
-
List workspaces for a given account. <br
|
|
5809
|
+
List workspaces for a given account. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
5810
5810
|
|
|
5811
5811
|
</dd>
|
|
5812
5812
|
</dl>
|
|
@@ -5882,7 +5882,7 @@ await client.workspaces.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
|
5882
5882
|
<dl>
|
|
5883
5883
|
<dd>
|
|
5884
5884
|
|
|
5885
|
-
Create workspace from an account. <br
|
|
5885
|
+
Create workspace from an account. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
5886
5886
|
|
|
5887
5887
|
</dd>
|
|
5888
5888
|
</dl>
|