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
|
@@ -17,11 +17,11 @@ import * as errors from "../../../../errors/index.mjs";
|
|
|
17
17
|
* Manage Shares and related operations.
|
|
18
18
|
*/
|
|
19
19
|
export class Shares {
|
|
20
|
-
constructor(_options
|
|
20
|
+
constructor(_options) {
|
|
21
21
|
this._options = _options;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* Show a single Share. <br
|
|
24
|
+
* Show a single Share. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
25
25
|
*
|
|
26
26
|
* @param {Frameio.Uuid} accountId -
|
|
27
27
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -96,7 +96,7 @@ export class Shares {
|
|
|
96
96
|
});
|
|
97
97
|
}
|
|
98
98
|
/**
|
|
99
|
-
* Delete a share. <br
|
|
99
|
+
* Delete a share. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
100
100
|
*
|
|
101
101
|
* @param {Frameio.Uuid} accountId -
|
|
102
102
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -171,7 +171,7 @@ export class Shares {
|
|
|
171
171
|
});
|
|
172
172
|
}
|
|
173
173
|
/**
|
|
174
|
-
* Update share. <br
|
|
174
|
+
* Update share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
175
175
|
*
|
|
176
176
|
* @param {Frameio.Uuid} accountId -
|
|
177
177
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -190,7 +190,8 @@ export class Shares {
|
|
|
190
190
|
* data: {
|
|
191
191
|
* access: "public",
|
|
192
192
|
* description: "A descriptive summary of the share",
|
|
193
|
-
*
|
|
193
|
+
* downloading_enabled: true,
|
|
194
|
+
* expiration: "2025-12-17T02:04:49Z",
|
|
194
195
|
* name: "Share Name",
|
|
195
196
|
* passphrase: "as!dfj39sd(*"
|
|
196
197
|
* }
|
|
@@ -258,7 +259,7 @@ export class Shares {
|
|
|
258
259
|
});
|
|
259
260
|
}
|
|
260
261
|
/**
|
|
261
|
-
* List share reviewers. <br
|
|
262
|
+
* List share reviewers. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
262
263
|
*
|
|
263
264
|
* @param {Frameio.Uuid} accountId -
|
|
264
265
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -363,11 +364,11 @@ export class Shares {
|
|
|
363
364
|
}
|
|
364
365
|
/**
|
|
365
366
|
* Add reviewers to secure share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
|
|
366
|
-
* <br
|
|
367
|
+
* <br>
|
|
367
368
|
* A request can only include one identifier type parameter.
|
|
368
|
-
* <br
|
|
369
|
+
* <br>
|
|
369
370
|
* `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.
|
|
370
|
-
* <br
|
|
371
|
+
* <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
371
372
|
*
|
|
372
373
|
* @param {Frameio.Uuid} accountId -
|
|
373
374
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -454,9 +455,9 @@ export class Shares {
|
|
|
454
455
|
}
|
|
455
456
|
/**
|
|
456
457
|
* Removes reviewers from secure Share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
|
|
457
|
-
* <br
|
|
458
|
+
* <br>
|
|
458
459
|
* A request can only include one identifier type parameter.
|
|
459
|
-
* <br
|
|
460
|
+
* <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
460
461
|
*
|
|
461
462
|
* @param {Frameio.Uuid} accountId -
|
|
462
463
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -541,7 +542,7 @@ export class Shares {
|
|
|
541
542
|
});
|
|
542
543
|
}
|
|
543
544
|
/**
|
|
544
|
-
* Remove an asset currently in the share from that share. <br
|
|
545
|
+
* Remove an asset currently in the share from that share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
545
546
|
*
|
|
546
547
|
* @param {Frameio.Uuid} accountId -
|
|
547
548
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -617,7 +618,7 @@ export class Shares {
|
|
|
617
618
|
});
|
|
618
619
|
}
|
|
619
620
|
/**
|
|
620
|
-
* Add new asset share. <br
|
|
621
|
+
* Add new asset share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
621
622
|
*
|
|
622
623
|
* @param {Frameio.Uuid} accountId -
|
|
623
624
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -634,7 +635,7 @@ export class Shares {
|
|
|
634
635
|
* @example
|
|
635
636
|
* await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
636
637
|
* data: {
|
|
637
|
-
* asset_id: "
|
|
638
|
+
* asset_id: "68f9a51b-d4e1-43be-bfce-08adac91e4e1"
|
|
638
639
|
* }
|
|
639
640
|
* })
|
|
640
641
|
*/
|
|
@@ -700,7 +701,7 @@ export class Shares {
|
|
|
700
701
|
});
|
|
701
702
|
}
|
|
702
703
|
/**
|
|
703
|
-
* List shares on a project. <br
|
|
704
|
+
* List shares on a project. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
704
705
|
*
|
|
705
706
|
* @param {Frameio.Uuid} accountId -
|
|
706
707
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -801,7 +802,7 @@ export class Shares {
|
|
|
801
802
|
});
|
|
802
803
|
}
|
|
803
804
|
/**
|
|
804
|
-
* Create share. <br
|
|
805
|
+
* Create share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
805
806
|
*
|
|
806
807
|
* @param {Frameio.Uuid} accountId -
|
|
807
808
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -820,8 +821,9 @@ export class Shares {
|
|
|
820
821
|
* data: {
|
|
821
822
|
* type: "asset",
|
|
822
823
|
* access: "public",
|
|
823
|
-
* asset_ids: ["
|
|
824
|
-
*
|
|
824
|
+
* asset_ids: ["31771855-14a4-427b-8efe-6355127f983c", "8ed9a3b2-d458-46a6-b494-4b54a3c4d16d"],
|
|
825
|
+
* downloading_enabled: true,
|
|
826
|
+
* expiration: "2025-12-17T02:04:49Z",
|
|
825
827
|
* name: "Share Name",
|
|
826
828
|
* passphrase: "as!dfj39sd(*"
|
|
827
829
|
* }
|
|
@@ -890,11 +892,7 @@ export class Shares {
|
|
|
890
892
|
}
|
|
891
893
|
_getAuthorizationHeader() {
|
|
892
894
|
return __awaiter(this, void 0, void 0, function* () {
|
|
893
|
-
|
|
894
|
-
if (bearer != null) {
|
|
895
|
-
return `Bearer ${bearer}`;
|
|
896
|
-
}
|
|
897
|
-
return undefined;
|
|
895
|
+
return `Bearer ${yield core.Supplier.get(this._options.token)}`;
|
|
898
896
|
});
|
|
899
897
|
}
|
|
900
898
|
}
|
|
@@ -5,8 +5,9 @@ import * as Frameio from "../../../../index.mjs";
|
|
|
5
5
|
* data: {
|
|
6
6
|
* type: "asset",
|
|
7
7
|
* access: "public",
|
|
8
|
-
* asset_ids: ["
|
|
9
|
-
*
|
|
8
|
+
* asset_ids: ["31771855-14a4-427b-8efe-6355127f983c", "8ed9a3b2-d458-46a6-b494-4b54a3c4d16d"],
|
|
9
|
+
* downloading_enabled: true,
|
|
10
|
+
* expiration: "2025-12-17T02:04:49Z",
|
|
10
11
|
* name: "Share Name",
|
|
11
12
|
* passphrase: "as!dfj39sd(*"
|
|
12
13
|
* }
|
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
* data: {
|
|
5
5
|
* access: "public",
|
|
6
6
|
* description: "A descriptive summary of the share",
|
|
7
|
-
*
|
|
7
|
+
* downloading_enabled: true,
|
|
8
|
+
* expiration: "2025-12-17T02:04:49Z",
|
|
8
9
|
* name: "Share Name",
|
|
9
10
|
* passphrase: "as!dfj39sd(*"
|
|
10
11
|
* }
|
|
@@ -18,6 +19,7 @@ export declare namespace UpdateShareParams {
|
|
|
18
19
|
access?: Data.Access;
|
|
19
20
|
/** Share description - NOTE: Requires feature custom_branded_shares */
|
|
20
21
|
description?: string;
|
|
22
|
+
downloading_enabled?: boolean;
|
|
21
23
|
/** Expiration timestamp */
|
|
22
24
|
expiration?: string;
|
|
23
25
|
/** Share Name (must include at least one non-whitespace character and no line breaks) */
|
|
@@ -6,7 +6,7 @@ export declare namespace Users {
|
|
|
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 Users {
|
|
|
28
28
|
*/
|
|
29
29
|
export declare class Users {
|
|
30
30
|
protected readonly _options: Users.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options: Users.Options);
|
|
32
32
|
/**
|
|
33
|
-
* Inspect details of the user associated with the bearer token. <br
|
|
33
|
+
* Inspect details of the user associated with the bearer token. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
34
34
|
*
|
|
35
35
|
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
36
36
|
*
|
|
@@ -46,5 +46,5 @@ export declare class Users {
|
|
|
46
46
|
*/
|
|
47
47
|
show(requestOptions?: Users.RequestOptions): core.HttpResponsePromise<Frameio.ProfileResponse>;
|
|
48
48
|
private __show;
|
|
49
|
-
protected _getAuthorizationHeader(): Promise<string
|
|
49
|
+
protected _getAuthorizationHeader(): Promise<string>;
|
|
50
50
|
}
|
|
@@ -17,11 +17,11 @@ import * as errors from "../../../../errors/index.mjs";
|
|
|
17
17
|
* Manage Users and related operations.
|
|
18
18
|
*/
|
|
19
19
|
export class Users {
|
|
20
|
-
constructor(_options
|
|
20
|
+
constructor(_options) {
|
|
21
21
|
this._options = _options;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* Inspect details of the user associated with the bearer token. <br
|
|
24
|
+
* Inspect details of the user associated with the bearer token. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
25
25
|
*
|
|
26
26
|
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
27
27
|
*
|
|
@@ -95,11 +95,7 @@ export class Users {
|
|
|
95
95
|
}
|
|
96
96
|
_getAuthorizationHeader() {
|
|
97
97
|
return __awaiter(this, void 0, void 0, function* () {
|
|
98
|
-
|
|
99
|
-
if (bearer != null) {
|
|
100
|
-
return `Bearer ${bearer}`;
|
|
101
|
-
}
|
|
102
|
-
return undefined;
|
|
98
|
+
return `Bearer ${yield core.Supplier.get(this._options.token)}`;
|
|
103
99
|
});
|
|
104
100
|
}
|
|
105
101
|
}
|
|
@@ -6,7 +6,7 @@ export declare namespace VersionStacks {
|
|
|
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,12 +28,12 @@ export declare namespace VersionStacks {
|
|
|
28
28
|
*/
|
|
29
29
|
export declare class VersionStacks {
|
|
30
30
|
protected readonly _options: VersionStacks.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options: VersionStacks.Options);
|
|
32
32
|
/**
|
|
33
33
|
* List the children (files) in a given version stack.
|
|
34
|
-
* <br
|
|
34
|
+
* <br>
|
|
35
35
|
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
36
|
-
* <br
|
|
36
|
+
* <br>
|
|
37
37
|
* Note: if you include `media_links.original` and the user does not have permission to download files
|
|
38
38
|
* in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
|
|
39
39
|
* If the content is inaccessible because watermarking is required for this user and isn't supported by
|
|
@@ -42,6 +42,7 @@ export declare class VersionStacks {
|
|
|
42
42
|
* `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
|
|
43
43
|
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
|
|
44
44
|
* null in the response payload. In short, the client must handle null media links gracefully.
|
|
45
|
+
* <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
45
46
|
*
|
|
46
47
|
* @param {Frameio.Uuid} accountId -
|
|
47
48
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -66,7 +67,29 @@ export declare class VersionStacks {
|
|
|
66
67
|
index(accountId: Frameio.Uuid, versionStackId: Frameio.Uuid, request?: Frameio.VersionStacksIndexRequest, requestOptions?: VersionStacks.RequestOptions): core.HttpResponsePromise<Frameio.AssetsWithIncludesResponse>;
|
|
67
68
|
private __index;
|
|
68
69
|
/**
|
|
69
|
-
*
|
|
70
|
+
* Show version stack details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
71
|
+
*
|
|
72
|
+
* @param {Frameio.Uuid} accountId -
|
|
73
|
+
* @param {Frameio.Uuid} versionStackId -
|
|
74
|
+
* @param {Frameio.VersionStacksShowRequest} request
|
|
75
|
+
* @param {VersionStacks.RequestOptions} requestOptions - Request-specific configuration.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link Frameio.BadRequestError}
|
|
78
|
+
* @throws {@link Frameio.UnauthorizedError}
|
|
79
|
+
* @throws {@link Frameio.ForbiddenError}
|
|
80
|
+
* @throws {@link Frameio.NotFoundError}
|
|
81
|
+
* @throws {@link Frameio.UnprocessableEntityError}
|
|
82
|
+
* @throws {@link Frameio.TooManyRequestsError}
|
|
83
|
+
*
|
|
84
|
+
* @example
|
|
85
|
+
* await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
86
|
+
* include: "media_links"
|
|
87
|
+
* })
|
|
88
|
+
*/
|
|
89
|
+
show(accountId: Frameio.Uuid, versionStackId: Frameio.Uuid, request?: Frameio.VersionStacksShowRequest, requestOptions?: VersionStacks.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackWithIncludesResponse>;
|
|
90
|
+
private __show;
|
|
91
|
+
/**
|
|
92
|
+
* Copy version stack. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
70
93
|
*
|
|
71
94
|
* @param {Frameio.Uuid} accountId -
|
|
72
95
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -82,6 +105,7 @@ export declare class VersionStacks {
|
|
|
82
105
|
*
|
|
83
106
|
* @example
|
|
84
107
|
* await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
108
|
+
* copy_metadata: true,
|
|
85
109
|
* data: {
|
|
86
110
|
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
87
111
|
* }
|
|
@@ -90,7 +114,7 @@ export declare class VersionStacks {
|
|
|
90
114
|
copy(accountId: Frameio.Uuid, versionStackId: Frameio.Uuid, request?: Frameio.VersionStackCopyParams, requestOptions?: VersionStacks.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackCopyResponse>;
|
|
91
115
|
private __copy;
|
|
92
116
|
/**
|
|
93
|
-
* List version stacks in a given folder
|
|
117
|
+
* List version stacks in a given folder. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
94
118
|
*
|
|
95
119
|
* @param {Frameio.Uuid} accountId -
|
|
96
120
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -115,7 +139,7 @@ export declare class VersionStacks {
|
|
|
115
139
|
list(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.VersionStacksListRequest, requestOptions?: VersionStacks.RequestOptions): core.HttpResponsePromise<Frameio.VersionStacksWithIncludesResponse>;
|
|
116
140
|
private __list;
|
|
117
141
|
/**
|
|
118
|
-
* Create a new Version Stack under the parent folder. <br
|
|
142
|
+
* Create a new Version Stack under the parent folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
119
143
|
*
|
|
120
144
|
* @param {Frameio.Uuid} accountId -
|
|
121
145
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -132,14 +156,14 @@ export declare class VersionStacks {
|
|
|
132
156
|
* @example
|
|
133
157
|
* await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
134
158
|
* data: {
|
|
135
|
-
* file_ids: ["
|
|
159
|
+
* file_ids: ["f964b3e0-7286-4187-9c10-2aef68111366", "2b805a91-0a5b-47fd-93c9-87e41da01fe4"]
|
|
136
160
|
* }
|
|
137
161
|
* })
|
|
138
162
|
*/
|
|
139
163
|
create(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.VersionStackCreateParams, requestOptions?: VersionStacks.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackWithIncludesResponse>;
|
|
140
164
|
private __create;
|
|
141
165
|
/**
|
|
142
|
-
* Move version stack to a folder. <br
|
|
166
|
+
* Move version stack to a folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
143
167
|
*
|
|
144
168
|
* @param {Frameio.Uuid} accountId -
|
|
145
169
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -162,5 +186,5 @@ export declare class VersionStacks {
|
|
|
162
186
|
*/
|
|
163
187
|
move(accountId: Frameio.Uuid, versionStackId: Frameio.Uuid, request: Frameio.VersionStackMoveParams, requestOptions?: VersionStacks.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackResponse>;
|
|
164
188
|
private __move;
|
|
165
|
-
protected _getAuthorizationHeader(): Promise<string
|
|
189
|
+
protected _getAuthorizationHeader(): Promise<string>;
|
|
166
190
|
}
|
|
@@ -8,6 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
8
8
|
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
9
|
});
|
|
10
10
|
};
|
|
11
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
12
|
+
var t = {};
|
|
13
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
14
|
+
t[p] = s[p];
|
|
15
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
16
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
17
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
18
|
+
t[p[i]] = s[p[i]];
|
|
19
|
+
}
|
|
20
|
+
return t;
|
|
21
|
+
};
|
|
11
22
|
import * as environments from "../../../../environments.mjs";
|
|
12
23
|
import * as core from "../../../../core/index.mjs";
|
|
13
24
|
import * as Frameio from "../../../index.mjs";
|
|
@@ -17,14 +28,14 @@ import * as errors from "../../../../errors/index.mjs";
|
|
|
17
28
|
* Manage Version Stacks and related operations.
|
|
18
29
|
*/
|
|
19
30
|
export class VersionStacks {
|
|
20
|
-
constructor(_options
|
|
31
|
+
constructor(_options) {
|
|
21
32
|
this._options = _options;
|
|
22
33
|
}
|
|
23
34
|
/**
|
|
24
35
|
* List the children (files) in a given version stack.
|
|
25
|
-
* <br
|
|
36
|
+
* <br>
|
|
26
37
|
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
27
|
-
* <br
|
|
38
|
+
* <br>
|
|
28
39
|
* Note: if you include `media_links.original` and the user does not have permission to download files
|
|
29
40
|
* in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
|
|
30
41
|
* If the content is inaccessible because watermarking is required for this user and isn't supported by
|
|
@@ -33,6 +44,7 @@ export class VersionStacks {
|
|
|
33
44
|
* `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
|
|
34
45
|
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
|
|
35
46
|
* null in the response payload. In short, the client must handle null media links gracefully.
|
|
47
|
+
* <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
36
48
|
*
|
|
37
49
|
* @param {Frameio.Uuid} accountId -
|
|
38
50
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -127,7 +139,93 @@ export class VersionStacks {
|
|
|
127
139
|
});
|
|
128
140
|
}
|
|
129
141
|
/**
|
|
130
|
-
*
|
|
142
|
+
* Show version stack details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
143
|
+
*
|
|
144
|
+
* @param {Frameio.Uuid} accountId -
|
|
145
|
+
* @param {Frameio.Uuid} versionStackId -
|
|
146
|
+
* @param {Frameio.VersionStacksShowRequest} request
|
|
147
|
+
* @param {VersionStacks.RequestOptions} requestOptions - Request-specific configuration.
|
|
148
|
+
*
|
|
149
|
+
* @throws {@link Frameio.BadRequestError}
|
|
150
|
+
* @throws {@link Frameio.UnauthorizedError}
|
|
151
|
+
* @throws {@link Frameio.ForbiddenError}
|
|
152
|
+
* @throws {@link Frameio.NotFoundError}
|
|
153
|
+
* @throws {@link Frameio.UnprocessableEntityError}
|
|
154
|
+
* @throws {@link Frameio.TooManyRequestsError}
|
|
155
|
+
*
|
|
156
|
+
* @example
|
|
157
|
+
* await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
158
|
+
* include: "media_links"
|
|
159
|
+
* })
|
|
160
|
+
*/
|
|
161
|
+
show(accountId, versionStackId, request = {}, requestOptions) {
|
|
162
|
+
return core.HttpResponsePromise.fromPromise(this.__show(accountId, versionStackId, request, requestOptions));
|
|
163
|
+
}
|
|
164
|
+
__show(accountId_1, versionStackId_1) {
|
|
165
|
+
return __awaiter(this, arguments, void 0, function* (accountId, versionStackId, request = {}, requestOptions) {
|
|
166
|
+
var _a, _b, _c;
|
|
167
|
+
const { include } = request;
|
|
168
|
+
const _queryParams = {};
|
|
169
|
+
if (include != null) {
|
|
170
|
+
_queryParams["include"] = include;
|
|
171
|
+
}
|
|
172
|
+
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
173
|
+
const _response = yield core.fetcher({
|
|
174
|
+
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)}/version_stacks/${encodeURIComponent(versionStackId)}`),
|
|
175
|
+
method: "GET",
|
|
176
|
+
headers: _headers,
|
|
177
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
178
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
179
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
180
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
181
|
+
});
|
|
182
|
+
if (_response.ok) {
|
|
183
|
+
return {
|
|
184
|
+
data: _response.body,
|
|
185
|
+
rawResponse: _response.rawResponse,
|
|
186
|
+
};
|
|
187
|
+
}
|
|
188
|
+
if (_response.error.reason === "status-code") {
|
|
189
|
+
switch (_response.error.statusCode) {
|
|
190
|
+
case 400:
|
|
191
|
+
throw new Frameio.BadRequestError(_response.error.body, _response.rawResponse);
|
|
192
|
+
case 401:
|
|
193
|
+
throw new Frameio.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
194
|
+
case 403:
|
|
195
|
+
throw new Frameio.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
196
|
+
case 404:
|
|
197
|
+
throw new Frameio.NotFoundError(_response.error.body, _response.rawResponse);
|
|
198
|
+
case 422:
|
|
199
|
+
throw new Frameio.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
200
|
+
case 429:
|
|
201
|
+
throw new Frameio.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
202
|
+
default:
|
|
203
|
+
throw new errors.FrameioError({
|
|
204
|
+
statusCode: _response.error.statusCode,
|
|
205
|
+
body: _response.error.body,
|
|
206
|
+
rawResponse: _response.rawResponse,
|
|
207
|
+
});
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
switch (_response.error.reason) {
|
|
211
|
+
case "non-json":
|
|
212
|
+
throw new errors.FrameioError({
|
|
213
|
+
statusCode: _response.error.statusCode,
|
|
214
|
+
body: _response.error.rawBody,
|
|
215
|
+
rawResponse: _response.rawResponse,
|
|
216
|
+
});
|
|
217
|
+
case "timeout":
|
|
218
|
+
throw new errors.FrameioTimeoutError("Timeout exceeded when calling GET /v4/accounts/{account_id}/version_stacks/{version_stack_id}.");
|
|
219
|
+
case "unknown":
|
|
220
|
+
throw new errors.FrameioError({
|
|
221
|
+
message: _response.error.errorMessage,
|
|
222
|
+
rawResponse: _response.rawResponse,
|
|
223
|
+
});
|
|
224
|
+
}
|
|
225
|
+
});
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* Copy version stack. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
131
229
|
*
|
|
132
230
|
* @param {Frameio.Uuid} accountId -
|
|
133
231
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -143,6 +241,7 @@ export class VersionStacks {
|
|
|
143
241
|
*
|
|
144
242
|
* @example
|
|
145
243
|
* await client.versionStacks.copy("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
244
|
+
* copy_metadata: true,
|
|
146
245
|
* data: {
|
|
147
246
|
* parent_id: "2e426fe0-f965-4594-8b2b-b4dff1dc00ec"
|
|
148
247
|
* }
|
|
@@ -154,15 +253,20 @@ export class VersionStacks {
|
|
|
154
253
|
__copy(accountId_1, versionStackId_1) {
|
|
155
254
|
return __awaiter(this, arguments, void 0, function* (accountId, versionStackId, request = {}, requestOptions) {
|
|
156
255
|
var _a, _b, _c;
|
|
256
|
+
const { copy_metadata: copyMetadata } = request, _body = __rest(request, ["copy_metadata"]);
|
|
257
|
+
const _queryParams = {};
|
|
258
|
+
if (copyMetadata != null) {
|
|
259
|
+
_queryParams["copy_metadata"] = copyMetadata.toString();
|
|
260
|
+
}
|
|
157
261
|
let _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
158
262
|
const _response = yield core.fetcher({
|
|
159
263
|
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)}/version_stacks/${encodeURIComponent(versionStackId)}/copy`),
|
|
160
264
|
method: "POST",
|
|
161
265
|
headers: _headers,
|
|
162
266
|
contentType: "application/json",
|
|
163
|
-
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
267
|
+
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
164
268
|
requestType: "json",
|
|
165
|
-
body:
|
|
269
|
+
body: _body,
|
|
166
270
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
167
271
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
168
272
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
@@ -210,7 +314,7 @@ export class VersionStacks {
|
|
|
210
314
|
});
|
|
211
315
|
}
|
|
212
316
|
/**
|
|
213
|
-
* List version stacks in a given folder
|
|
317
|
+
* List version stacks in a given folder. <br>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
214
318
|
*
|
|
215
319
|
* @param {Frameio.Uuid} accountId -
|
|
216
320
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -308,7 +412,7 @@ export class VersionStacks {
|
|
|
308
412
|
});
|
|
309
413
|
}
|
|
310
414
|
/**
|
|
311
|
-
* Create a new Version Stack under the parent folder. <br
|
|
415
|
+
* Create a new Version Stack under the parent folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
312
416
|
*
|
|
313
417
|
* @param {Frameio.Uuid} accountId -
|
|
314
418
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -325,7 +429,7 @@ export class VersionStacks {
|
|
|
325
429
|
* @example
|
|
326
430
|
* await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
327
431
|
* data: {
|
|
328
|
-
* file_ids: ["
|
|
432
|
+
* file_ids: ["f964b3e0-7286-4187-9c10-2aef68111366", "2b805a91-0a5b-47fd-93c9-87e41da01fe4"]
|
|
329
433
|
* }
|
|
330
434
|
* })
|
|
331
435
|
*/
|
|
@@ -394,7 +498,7 @@ export class VersionStacks {
|
|
|
394
498
|
});
|
|
395
499
|
}
|
|
396
500
|
/**
|
|
397
|
-
* Move version stack to a folder. <br
|
|
501
|
+
* Move version stack to a folder. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
398
502
|
*
|
|
399
503
|
* @param {Frameio.Uuid} accountId -
|
|
400
504
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -478,11 +582,7 @@ export class VersionStacks {
|
|
|
478
582
|
}
|
|
479
583
|
_getAuthorizationHeader() {
|
|
480
584
|
return __awaiter(this, void 0, void 0, function* () {
|
|
481
|
-
|
|
482
|
-
if (bearer != null) {
|
|
483
|
-
return `Bearer ${bearer}`;
|
|
484
|
-
}
|
|
485
|
-
return undefined;
|
|
585
|
+
return `Bearer ${yield core.Supplier.get(this._options.token)}`;
|
|
486
586
|
});
|
|
487
587
|
}
|
|
488
588
|
}
|
|
@@ -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 VersionStackCopyParams {
|
|
11
|
+
/** Whether to copy metadata values along with the version stack */
|
|
12
|
+
copy_metadata?: boolean;
|
|
10
13
|
data?: VersionStackCopyParams.Data;
|
|
11
14
|
}
|
|
12
15
|
export declare namespace VersionStackCopyParams {
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* @example
|
|
3
3
|
* {
|
|
4
4
|
* data: {
|
|
5
|
-
* file_ids: ["
|
|
5
|
+
* file_ids: ["f964b3e0-7286-4187-9c10-2aef68111366", "2b805a91-0a5b-47fd-93c9-87e41da01fe4"]
|
|
6
6
|
* }
|
|
7
7
|
* }
|
|
8
8
|
*/
|
|
@@ -18,6 +18,6 @@ export declare namespace VersionStackCreateParams {
|
|
|
18
18
|
* <br/>
|
|
19
19
|
* Two file IDs are required and up to a maximum of ten. Files must exist in the parent directory identified in the path.
|
|
20
20
|
*/
|
|
21
|
-
file_ids
|
|
21
|
+
file_ids: string[];
|
|
22
22
|
}
|
|
23
23
|
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
export { type VersionStacksIndexRequest } from "./VersionStacksIndexRequest.mjs";
|
|
2
|
+
export { type VersionStacksShowRequest } from "./VersionStacksShowRequest.mjs";
|
|
2
3
|
export { type VersionStackCopyParams } from "./VersionStackCopyParams.mjs";
|
|
3
4
|
export { type VersionStacksListRequest } from "./VersionStacksListRequest.mjs";
|
|
4
5
|
export { type VersionStackCreateParams } from "./VersionStackCreateParams.mjs";
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/** Supported include query parameter values for endpoints that return files with media links */
|
|
2
|
+
export declare const VersionStacksShowRequestInclude: {
|
|
3
|
+
readonly MediaLinks: "media_links";
|
|
4
|
+
readonly MediaLinksOriginal: "media_links.original";
|
|
5
|
+
readonly MediaLinksThumbnail: "media_links.thumbnail";
|
|
6
|
+
readonly MediaLinksVideoH264180: "media_links.video_h264_180";
|
|
7
|
+
readonly MediaLinksHighQuality: "media_links.high_quality";
|
|
8
|
+
readonly MediaLinksEfficient: "media_links.efficient";
|
|
9
|
+
readonly Creator: "creator";
|
|
10
|
+
readonly Project: "project";
|
|
11
|
+
readonly Metadata: "metadata";
|
|
12
|
+
};
|
|
13
|
+
export type VersionStacksShowRequestInclude = (typeof VersionStacksShowRequestInclude)[keyof typeof VersionStacksShowRequestInclude];
|