frameio 1.3.0 → 1.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/files/client/Client.d.ts +27 -0
- package/dist/cjs/api/resources/files/client/Client.js +88 -0
- package/dist/cjs/api/resources/files/client/requests/FileImportParams.d.ts +23 -0
- package/dist/cjs/api/resources/files/client/requests/FileImportParams.js +3 -0
- package/dist/cjs/api/resources/files/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/files/types/FilesListRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/files/types/FilesListRequestInclude.js +1 -0
- package/dist/cjs/api/resources/files/types/FilesShowRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/files/types/FilesShowRequestInclude.js +1 -0
- package/dist/cjs/api/resources/folders/types/FoldersIndexRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/folders/types/FoldersIndexRequestInclude.js +1 -0
- package/dist/cjs/api/resources/metadata/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/metadata/client/Client.js +4 -4
- package/dist/cjs/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.ts +4 -4
- package/dist/cjs/api/resources/shares/client/Client.d.ts +4 -4
- package/dist/cjs/api/resources/shares/client/Client.js +4 -4
- package/dist/cjs/api/resources/shares/client/requests/AddAssetParams.d.ts +1 -1
- package/dist/cjs/api/resources/shares/client/requests/CreateShareParams.d.ts +2 -2
- package/dist/cjs/api/resources/shares/client/requests/UpdateShareParams.d.ts +3 -3
- package/dist/cjs/api/resources/versionStacks/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/client/Client.js +1 -1
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.js +1 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksListRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksListRequestInclude.js +1 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.ts +1 -0
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.js +1 -0
- package/dist/cjs/api/types/AssetShareParams.d.ts +3 -2
- package/dist/cjs/api/types/AuditLogwithIncludes.d.ts +1 -0
- package/dist/cjs/api/types/AuditLogwithIncludes.js +1 -0
- package/dist/cjs/api/types/FileWithMediaLinksInclude.d.ts +1 -0
- package/dist/cjs/api/types/FileWithMediaLinksInclude.js +1 -0
- package/dist/cjs/api/types/Filters.d.ts +1 -0
- package/dist/cjs/api/types/Filters.js +1 -0
- package/dist/cjs/api/types/MediaLinksCollection.d.ts +1 -0
- package/dist/cjs/api/types/Share.d.ts +1 -1
- package/dist/cjs/api/types/VersionStackWithIncludes.d.ts +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/files/client/Client.d.mts +27 -0
- package/dist/esm/api/resources/files/client/Client.mjs +88 -0
- package/dist/esm/api/resources/files/client/requests/FileImportParams.d.mts +23 -0
- package/dist/esm/api/resources/files/client/requests/FileImportParams.mjs +2 -0
- package/dist/esm/api/resources/files/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/files/types/FilesListRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/files/types/FilesListRequestInclude.mjs +1 -0
- package/dist/esm/api/resources/files/types/FilesShowRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/files/types/FilesShowRequestInclude.mjs +1 -0
- package/dist/esm/api/resources/folders/types/FoldersIndexRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/folders/types/FoldersIndexRequestInclude.mjs +1 -0
- package/dist/esm/api/resources/metadata/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/metadata/client/Client.mjs +4 -4
- package/dist/esm/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.mts +4 -4
- package/dist/esm/api/resources/shares/client/Client.d.mts +4 -4
- package/dist/esm/api/resources/shares/client/Client.mjs +4 -4
- package/dist/esm/api/resources/shares/client/requests/AddAssetParams.d.mts +1 -1
- package/dist/esm/api/resources/shares/client/requests/CreateShareParams.d.mts +2 -2
- package/dist/esm/api/resources/shares/client/requests/UpdateShareParams.d.mts +3 -3
- package/dist/esm/api/resources/versionStacks/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/client/Client.mjs +1 -1
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.mjs +1 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksListRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksListRequestInclude.mjs +1 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.mts +1 -0
- package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.mjs +1 -0
- package/dist/esm/api/types/AssetShareParams.d.mts +3 -2
- package/dist/esm/api/types/AuditLogwithIncludes.d.mts +1 -0
- package/dist/esm/api/types/AuditLogwithIncludes.mjs +1 -0
- package/dist/esm/api/types/FileWithMediaLinksInclude.d.mts +1 -0
- package/dist/esm/api/types/FileWithMediaLinksInclude.mjs +1 -0
- package/dist/esm/api/types/Filters.d.mts +1 -0
- package/dist/esm/api/types/Filters.mjs +1 -0
- package/dist/esm/api/types/MediaLinksCollection.d.mts +1 -0
- package/dist/esm/api/types/Share.d.mts +1 -1
- package/dist/esm/api/types/VersionStackWithIncludes.d.mts +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +94 -9
package/reference.md
CHANGED
|
@@ -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: ["b26bface-a5e6-4bef-8dab-79497f55f6cd", "91aac164-64de-4c36-89e0-e7b8a47f9efd"],
|
|
1653
1653
|
},
|
|
1654
1654
|
});
|
|
1655
1655
|
```
|
|
@@ -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-02-18T00:54:56Z",
|
|
3350
3350
|
name: "Share Name",
|
|
3351
3351
|
passphrase: "as!dfj39sd(*",
|
|
3352
3352
|
},
|
|
@@ -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: "95ea9fe2-2fdd-4d3d-9d7f-d6c8f01af204",
|
|
3780
3780
|
},
|
|
3781
3781
|
});
|
|
3782
3782
|
```
|
|
@@ -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: ["c8b416a0-af84-420b-b322-a9339873b974", "094fd8cf-647a-4a64-8a9d-876cff04d75b"],
|
|
3948
3948
|
downloading_enabled: true,
|
|
3949
|
-
expiration: "2026-
|
|
3949
|
+
expiration: "2026-02-18T00:54:56Z",
|
|
3950
3950
|
name: "Share Name",
|
|
3951
3951
|
passphrase: "as!dfj39sd(*",
|
|
3952
3952
|
},
|
|
@@ -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: ["340a5466-cc97-4290-888e-45e02d965a5c", "272a22d6-199f-4f0e-b6c3-c1b2afc0d20d"],
|
|
4037
4037
|
values: [
|
|
4038
4038
|
{
|
|
4039
|
-
field_definition_id: "
|
|
4039
|
+
field_definition_id: "d45c5c1c-8405-4b99-adb9-46a468433a93",
|
|
4040
4040
|
value: [
|
|
4041
4041
|
{
|
|
4042
|
-
id: "
|
|
4042
|
+
id: "0910d770-1742-44f5-bd63-91653a8d0999",
|
|
4043
4043
|
type: "user",
|
|
4044
4044
|
},
|
|
4045
4045
|
{
|
|
4046
|
-
id: "
|
|
4046
|
+
id: "2952a0ad-f70a-4aca-990f-cc34a8bb053c",
|
|
4047
4047
|
type: "account_user_group",
|
|
4048
4048
|
},
|
|
4049
4049
|
],
|
|
@@ -4937,6 +4937,91 @@ await client.files.createLocalUpload("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2
|
|
|
4937
4937
|
</dl>
|
|
4938
4938
|
</details>
|
|
4939
4939
|
|
|
4940
|
+
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">importFile</a>(accountId, folderId, { ...params }) -> Frameio.FileResponse</code></summary>
|
|
4941
|
+
<dl>
|
|
4942
|
+
<dd>
|
|
4943
|
+
|
|
4944
|
+
#### 📝 Description
|
|
4945
|
+
|
|
4946
|
+
<dl>
|
|
4947
|
+
<dd>
|
|
4948
|
+
|
|
4949
|
+
<dl>
|
|
4950
|
+
<dd>
|
|
4951
|
+
|
|
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
|
+
|
|
4954
|
+
</dd>
|
|
4955
|
+
</dl>
|
|
4956
|
+
</dd>
|
|
4957
|
+
</dl>
|
|
4958
|
+
|
|
4959
|
+
#### 🔌 Usage
|
|
4960
|
+
|
|
4961
|
+
<dl>
|
|
4962
|
+
<dd>
|
|
4963
|
+
|
|
4964
|
+
<dl>
|
|
4965
|
+
<dd>
|
|
4966
|
+
|
|
4967
|
+
```typescript
|
|
4968
|
+
await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
4969
|
+
data: {
|
|
4970
|
+
key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
|
|
4971
|
+
name: "asset.png",
|
|
4972
|
+
storage_location: "123e4567-e89b-12d3-a456-426614174000",
|
|
4973
|
+
},
|
|
4974
|
+
});
|
|
4975
|
+
```
|
|
4976
|
+
|
|
4977
|
+
</dd>
|
|
4978
|
+
</dl>
|
|
4979
|
+
</dd>
|
|
4980
|
+
</dl>
|
|
4981
|
+
|
|
4982
|
+
#### ⚙️ Parameters
|
|
4983
|
+
|
|
4984
|
+
<dl>
|
|
4985
|
+
<dd>
|
|
4986
|
+
|
|
4987
|
+
<dl>
|
|
4988
|
+
<dd>
|
|
4989
|
+
|
|
4990
|
+
**accountId:** `Frameio.Uuid` —
|
|
4991
|
+
|
|
4992
|
+
</dd>
|
|
4993
|
+
</dl>
|
|
4994
|
+
|
|
4995
|
+
<dl>
|
|
4996
|
+
<dd>
|
|
4997
|
+
|
|
4998
|
+
**folderId:** `Frameio.Uuid` —
|
|
4999
|
+
|
|
5000
|
+
</dd>
|
|
5001
|
+
</dl>
|
|
5002
|
+
|
|
5003
|
+
<dl>
|
|
5004
|
+
<dd>
|
|
5005
|
+
|
|
5006
|
+
**request:** `Frameio.FileImportParams`
|
|
5007
|
+
|
|
5008
|
+
</dd>
|
|
5009
|
+
</dl>
|
|
5010
|
+
|
|
5011
|
+
<dl>
|
|
5012
|
+
<dd>
|
|
5013
|
+
|
|
5014
|
+
**requestOptions:** `Files.RequestOptions`
|
|
5015
|
+
|
|
5016
|
+
</dd>
|
|
5017
|
+
</dl>
|
|
5018
|
+
</dd>
|
|
5019
|
+
</dl>
|
|
5020
|
+
|
|
5021
|
+
</dd>
|
|
5022
|
+
</dl>
|
|
5023
|
+
</details>
|
|
5024
|
+
|
|
4940
5025
|
<details><summary><code>client.files.<a href="/src/api/resources/files/client/Client.ts">showFileUploadStatus</a>(accountId, fileId) -> Frameio.FileUploadStatusResponse</code></summary>
|
|
4941
5026
|
<dl>
|
|
4942
5027
|
<dd>
|