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
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* access: "public",
|
|
6
6
|
* description: "A descriptive summary of the share",
|
|
7
7
|
* downloading_enabled: true,
|
|
8
|
-
* expiration: "2026-
|
|
8
|
+
* expiration: "2026-03-02T23:37:00Z",
|
|
9
9
|
* name: "Share Name",
|
|
10
10
|
* passphrase: "as!dfj39sd(*"
|
|
11
11
|
* }
|
|
@@ -17,14 +17,14 @@ export interface UpdateShareParams {
|
|
|
17
17
|
export declare namespace UpdateShareParams {
|
|
18
18
|
interface Data {
|
|
19
19
|
access?: Data.Access;
|
|
20
|
-
/** Share description
|
|
20
|
+
/** Share description - NOTE: Requires feature custom_branded_shares */
|
|
21
21
|
description?: string;
|
|
22
22
|
downloading_enabled?: boolean;
|
|
23
23
|
/** Expiration timestamp */
|
|
24
24
|
expiration?: string;
|
|
25
25
|
/** Share Name (must include at least one non-whitespace character and no line breaks) */
|
|
26
26
|
name?: string;
|
|
27
|
-
/** Passphrase to access share */
|
|
27
|
+
/** Passphrase to access share, if passphrase is required and not given it will be generated */
|
|
28
28
|
passphrase?: string;
|
|
29
29
|
}
|
|
30
30
|
namespace Data {
|
|
@@ -31,7 +31,7 @@ export declare class Users {
|
|
|
31
31
|
protected readonly _options: Users.Options;
|
|
32
32
|
constructor(_options: Users.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Inspect details of the user associated with the bearer token. <br
|
|
34
|
+
* Inspect details of the user associated with the bearer token. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
35
35
|
*
|
|
36
36
|
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
37
37
|
*
|
|
@@ -57,7 +57,7 @@ class Users {
|
|
|
57
57
|
this._options = _options;
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* Inspect details of the user associated with the bearer token. <br
|
|
60
|
+
* Inspect details of the user associated with the bearer token. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
61
61
|
*
|
|
62
62
|
* @param {Users.RequestOptions} requestOptions - Request-specific configuration.
|
|
63
63
|
*
|
|
@@ -32,9 +32,9 @@ export declare class VersionStacks {
|
|
|
32
32
|
constructor(_options: VersionStacks.Options);
|
|
33
33
|
/**
|
|
34
34
|
* List the children (files) in a given version stack.
|
|
35
|
-
* <br
|
|
35
|
+
* <br/>
|
|
36
36
|
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
37
|
-
* <br
|
|
37
|
+
* <br/>
|
|
38
38
|
* Note: if you include `media_links.original` and the user does not have permission to download files
|
|
39
39
|
* in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
|
|
40
40
|
* If the content is inaccessible because watermarking is required for this user and isn't supported by
|
|
@@ -43,7 +43,7 @@ export declare class VersionStacks {
|
|
|
43
43
|
* `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
|
|
44
44
|
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
|
|
45
45
|
* null in the response payload. In short, the client must handle null media links gracefully.
|
|
46
|
-
* <br
|
|
46
|
+
* <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
47
47
|
*
|
|
48
48
|
* @param {Frameio.Uuid} accountId -
|
|
49
49
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -60,7 +60,7 @@ export declare class VersionStacks {
|
|
|
60
60
|
*
|
|
61
61
|
* @example
|
|
62
62
|
* await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
63
|
-
* include: "media_links",
|
|
63
|
+
* include: "media_links.original",
|
|
64
64
|
* after: "<opaque_cursor>",
|
|
65
65
|
* page_size: 10,
|
|
66
66
|
* include_total_count: false
|
|
@@ -69,7 +69,7 @@ export declare class VersionStacks {
|
|
|
69
69
|
index(accountId: Frameio.Uuid, versionStackId: Frameio.Uuid, request?: Frameio.VersionStacksIndexRequest, requestOptions?: VersionStacks.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackAssetsWithIncludesResponse>;
|
|
70
70
|
private __index;
|
|
71
71
|
/**
|
|
72
|
-
* Show version stack details. <br
|
|
72
|
+
* Show version stack details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
73
73
|
*
|
|
74
74
|
* @param {Frameio.Uuid} accountId -
|
|
75
75
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -86,13 +86,13 @@ export declare class VersionStacks {
|
|
|
86
86
|
*
|
|
87
87
|
* @example
|
|
88
88
|
* await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
89
|
-
* include: "media_links"
|
|
89
|
+
* include: "media_links.original"
|
|
90
90
|
* })
|
|
91
91
|
*/
|
|
92
92
|
show(accountId: Frameio.Uuid, versionStackId: Frameio.Uuid, request?: Frameio.VersionStacksShowRequest, requestOptions?: VersionStacks.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackWithIncludesResponse>;
|
|
93
93
|
private __show;
|
|
94
94
|
/**
|
|
95
|
-
* Copy version stack. <br
|
|
95
|
+
* Copy version stack. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
96
96
|
*
|
|
97
97
|
* @param {Frameio.Uuid} accountId -
|
|
98
98
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -118,7 +118,7 @@ export declare class VersionStacks {
|
|
|
118
118
|
copy(accountId: Frameio.Uuid, versionStackId: Frameio.Uuid, request?: Frameio.VersionStackCopyParams, requestOptions?: VersionStacks.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackCopyResponse>;
|
|
119
119
|
private __copy;
|
|
120
120
|
/**
|
|
121
|
-
* List version stacks in a given folder. <br
|
|
121
|
+
* List version stacks in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
122
122
|
*
|
|
123
123
|
* @param {Frameio.Uuid} accountId -
|
|
124
124
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -135,7 +135,7 @@ export declare class VersionStacks {
|
|
|
135
135
|
*
|
|
136
136
|
* @example
|
|
137
137
|
* await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
138
|
-
* include: "media_links",
|
|
138
|
+
* include: "media_links.original",
|
|
139
139
|
* after: "<opaque_cursor>",
|
|
140
140
|
* page_size: 10,
|
|
141
141
|
* include_total_count: false
|
|
@@ -144,7 +144,7 @@ export declare class VersionStacks {
|
|
|
144
144
|
list(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.VersionStacksListRequest, requestOptions?: VersionStacks.RequestOptions): core.HttpResponsePromise<Frameio.VersionStacksWithIncludesResponse>;
|
|
145
145
|
private __list;
|
|
146
146
|
/**
|
|
147
|
-
* Create a new Version Stack under the parent folder. <br
|
|
147
|
+
* Create a new Version Stack under the parent folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
148
148
|
*
|
|
149
149
|
* @param {Frameio.Uuid} accountId -
|
|
150
150
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -162,14 +162,14 @@ export declare class VersionStacks {
|
|
|
162
162
|
* @example
|
|
163
163
|
* await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
164
164
|
* data: {
|
|
165
|
-
* file_ids: ["
|
|
165
|
+
* file_ids: ["7c450236-f817-4ab1-bdc9-9c6df277dce6", "fd194c47-8352-4cc3-8f25-f7a5cb8282d0"]
|
|
166
166
|
* }
|
|
167
167
|
* })
|
|
168
168
|
*/
|
|
169
169
|
create(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.VersionStackCreateParams, requestOptions?: VersionStacks.RequestOptions): core.HttpResponsePromise<Frameio.VersionStackWithIncludesResponse>;
|
|
170
170
|
private __create;
|
|
171
171
|
/**
|
|
172
|
-
* Move version stack to a folder. <br
|
|
172
|
+
* Move version stack to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
173
173
|
*
|
|
174
174
|
* @param {Frameio.Uuid} accountId -
|
|
175
175
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -69,9 +69,9 @@ class VersionStacks {
|
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
71
71
|
* List the children (files) in a given version stack.
|
|
72
|
-
* <br
|
|
72
|
+
* <br/>
|
|
73
73
|
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
74
|
-
* <br
|
|
74
|
+
* <br/>
|
|
75
75
|
* Note: if you include `media_links.original` and the user does not have permission to download files
|
|
76
76
|
* in the corresponding project, then this endpoint will respond with a `403 Forbidden` error.
|
|
77
77
|
* If the content is inaccessible because watermarking is required for this user and isn't supported by
|
|
@@ -80,7 +80,7 @@ class VersionStacks {
|
|
|
80
80
|
* `media_links.video_h264_180` on a static image file) or transoding process hasn't finished
|
|
81
81
|
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the a media link will also be set to
|
|
82
82
|
* null in the response payload. In short, the client must handle null media links gracefully.
|
|
83
|
-
* <br
|
|
83
|
+
* <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
84
84
|
*
|
|
85
85
|
* @param {Frameio.Uuid} accountId -
|
|
86
86
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -97,7 +97,7 @@ class VersionStacks {
|
|
|
97
97
|
*
|
|
98
98
|
* @example
|
|
99
99
|
* await client.versionStacks.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
100
|
-
* include: "media_links",
|
|
100
|
+
* include: "media_links.original",
|
|
101
101
|
* after: "<opaque_cursor>",
|
|
102
102
|
* page_size: 10,
|
|
103
103
|
* include_total_count: false
|
|
@@ -181,7 +181,7 @@ class VersionStacks {
|
|
|
181
181
|
});
|
|
182
182
|
}
|
|
183
183
|
/**
|
|
184
|
-
* Show version stack details. <br
|
|
184
|
+
* Show version stack details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
185
185
|
*
|
|
186
186
|
* @param {Frameio.Uuid} accountId -
|
|
187
187
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -198,7 +198,7 @@ class VersionStacks {
|
|
|
198
198
|
*
|
|
199
199
|
* @example
|
|
200
200
|
* await client.versionStacks.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
201
|
-
* include: "media_links"
|
|
201
|
+
* include: "media_links.original"
|
|
202
202
|
* })
|
|
203
203
|
*/
|
|
204
204
|
show(accountId, versionStackId, request = {}, requestOptions) {
|
|
@@ -270,7 +270,7 @@ class VersionStacks {
|
|
|
270
270
|
});
|
|
271
271
|
}
|
|
272
272
|
/**
|
|
273
|
-
* Copy version stack. <br
|
|
273
|
+
* Copy version stack. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
274
274
|
*
|
|
275
275
|
* @param {Frameio.Uuid} accountId -
|
|
276
276
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -362,7 +362,7 @@ class VersionStacks {
|
|
|
362
362
|
});
|
|
363
363
|
}
|
|
364
364
|
/**
|
|
365
|
-
* List version stacks in a given folder. <br
|
|
365
|
+
* List version stacks in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
366
366
|
*
|
|
367
367
|
* @param {Frameio.Uuid} accountId -
|
|
368
368
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -379,7 +379,7 @@ class VersionStacks {
|
|
|
379
379
|
*
|
|
380
380
|
* @example
|
|
381
381
|
* await client.versionStacks.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
382
|
-
* include: "media_links",
|
|
382
|
+
* include: "media_links.original",
|
|
383
383
|
* after: "<opaque_cursor>",
|
|
384
384
|
* page_size: 10,
|
|
385
385
|
* include_total_count: false
|
|
@@ -463,7 +463,7 @@ class VersionStacks {
|
|
|
463
463
|
});
|
|
464
464
|
}
|
|
465
465
|
/**
|
|
466
|
-
* Create a new Version Stack under the parent folder. <br
|
|
466
|
+
* Create a new Version Stack under the parent folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
467
467
|
*
|
|
468
468
|
* @param {Frameio.Uuid} accountId -
|
|
469
469
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -481,7 +481,7 @@ class VersionStacks {
|
|
|
481
481
|
* @example
|
|
482
482
|
* await client.versionStacks.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
483
483
|
* data: {
|
|
484
|
-
* file_ids: ["
|
|
484
|
+
* file_ids: ["7c450236-f817-4ab1-bdc9-9c6df277dce6", "fd194c47-8352-4cc3-8f25-f7a5cb8282d0"]
|
|
485
485
|
* }
|
|
486
486
|
* })
|
|
487
487
|
*/
|
|
@@ -552,7 +552,7 @@ class VersionStacks {
|
|
|
552
552
|
});
|
|
553
553
|
}
|
|
554
554
|
/**
|
|
555
|
-
* Move version stack to a folder. <br
|
|
555
|
+
* Move version stack to a folder. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
556
556
|
*
|
|
557
557
|
* @param {Frameio.Uuid} accountId -
|
|
558
558
|
* @param {Frameio.Uuid} versionStackId -
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
2
2
|
export declare const VersionStacksIndexRequestInclude: {
|
|
3
|
-
readonly MediaLinks: "media_links";
|
|
4
3
|
readonly MediaLinksOriginal: "media_links.original";
|
|
5
4
|
readonly MediaLinksThumbnail: "media_links.thumbnail";
|
|
6
5
|
readonly MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality";
|
|
@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.VersionStacksIndexRequestInclude = void 0;
|
|
5
5
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
6
6
|
exports.VersionStacksIndexRequestInclude = {
|
|
7
|
-
MediaLinks: "media_links",
|
|
8
7
|
MediaLinksOriginal: "media_links.original",
|
|
9
8
|
MediaLinksThumbnail: "media_links.thumbnail",
|
|
10
9
|
MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality",
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
2
2
|
export declare const VersionStacksListRequestInclude: {
|
|
3
|
-
readonly MediaLinks: "media_links";
|
|
4
3
|
readonly MediaLinksOriginal: "media_links.original";
|
|
5
4
|
readonly MediaLinksThumbnail: "media_links.thumbnail";
|
|
6
5
|
readonly MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality";
|
|
@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.VersionStacksListRequestInclude = void 0;
|
|
5
5
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
6
6
|
exports.VersionStacksListRequestInclude = {
|
|
7
|
-
MediaLinks: "media_links",
|
|
8
7
|
MediaLinksOriginal: "media_links.original",
|
|
9
8
|
MediaLinksThumbnail: "media_links.thumbnail",
|
|
10
9
|
MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality",
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
2
2
|
export declare const VersionStacksShowRequestInclude: {
|
|
3
|
-
readonly MediaLinks: "media_links";
|
|
4
3
|
readonly MediaLinksOriginal: "media_links.original";
|
|
5
4
|
readonly MediaLinksThumbnail: "media_links.thumbnail";
|
|
6
5
|
readonly MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality";
|
|
@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.VersionStacksShowRequestInclude = void 0;
|
|
5
5
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
6
6
|
exports.VersionStacksShowRequestInclude = {
|
|
7
|
-
MediaLinks: "media_links",
|
|
8
7
|
MediaLinksOriginal: "media_links.original",
|
|
9
8
|
MediaLinksThumbnail: "media_links.thumbnail",
|
|
10
9
|
MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality",
|
|
@@ -31,7 +31,7 @@ export declare class Webhooks {
|
|
|
31
31
|
protected readonly _options: Webhooks.Options;
|
|
32
32
|
constructor(_options: Webhooks.Options);
|
|
33
33
|
/**
|
|
34
|
-
* List webhooks for the given workspace. <br
|
|
34
|
+
* List webhooks for the given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
35
35
|
*
|
|
36
36
|
* @param {Frameio.Uuid} accountId -
|
|
37
37
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -60,7 +60,7 @@ export declare class Webhooks {
|
|
|
60
60
|
* Creates a single webhook with secret.<br/><br/>Valid events:<p><code>
|
|
61
61
|
* 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
|
|
62
62
|
* </code>
|
|
63
|
-
* </p>. <br
|
|
63
|
+
* </p>. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
64
64
|
*
|
|
65
65
|
* @param {Frameio.Uuid} accountId -
|
|
66
66
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -87,7 +87,7 @@ export declare class Webhooks {
|
|
|
87
87
|
create(accountId: Frameio.Uuid, workspaceId: Frameio.Uuid, request: Frameio.WebhookCreateParams, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Frameio.WebhookCreateResponse>;
|
|
88
88
|
private __create;
|
|
89
89
|
/**
|
|
90
|
-
* Show webhook details. <br
|
|
90
|
+
* Show webhook details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
91
91
|
*
|
|
92
92
|
* @param {Frameio.Uuid} accountId -
|
|
93
93
|
* @param {Frameio.Uuid} webhookId -
|
|
@@ -110,7 +110,7 @@ export declare class Webhooks {
|
|
|
110
110
|
show(accountId: Frameio.Uuid, webhookId: Frameio.Uuid, request?: Frameio.WebhooksShowRequest, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<Frameio.WebhookWithIncludesResponse>;
|
|
111
111
|
private __show;
|
|
112
112
|
/**
|
|
113
|
-
* Delete a webhook. <br
|
|
113
|
+
* Delete a webhook. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
114
114
|
*
|
|
115
115
|
* @param {Frameio.Uuid} accountId -
|
|
116
116
|
* @param {Frameio.Uuid} webhookId -
|
|
@@ -130,7 +130,7 @@ export declare class Webhooks {
|
|
|
130
130
|
delete(accountId: Frameio.Uuid, webhookId: Frameio.Uuid, requestOptions?: Webhooks.RequestOptions): core.HttpResponsePromise<void>;
|
|
131
131
|
private __delete;
|
|
132
132
|
/**
|
|
133
|
-
* Update webhook details. <br
|
|
133
|
+
* Update webhook details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
134
134
|
*
|
|
135
135
|
* @param {Frameio.Uuid} accountId -
|
|
136
136
|
* @param {Frameio.Uuid} webhookId -
|
|
@@ -57,7 +57,7 @@ class Webhooks {
|
|
|
57
57
|
this._options = _options;
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* List webhooks for the given workspace. <br
|
|
60
|
+
* List webhooks for the given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
61
61
|
*
|
|
62
62
|
* @param {Frameio.Uuid} accountId -
|
|
63
63
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -158,7 +158,7 @@ class Webhooks {
|
|
|
158
158
|
* Creates a single webhook with secret.<br/><br/>Valid events:<p><code>
|
|
159
159
|
* 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
|
|
160
160
|
* </code>
|
|
161
|
-
* </p>. <br
|
|
161
|
+
* </p>. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
162
162
|
*
|
|
163
163
|
* @param {Frameio.Uuid} accountId -
|
|
164
164
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -246,7 +246,7 @@ class Webhooks {
|
|
|
246
246
|
});
|
|
247
247
|
}
|
|
248
248
|
/**
|
|
249
|
-
* Show webhook details. <br
|
|
249
|
+
* Show webhook details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
250
250
|
*
|
|
251
251
|
* @param {Frameio.Uuid} accountId -
|
|
252
252
|
* @param {Frameio.Uuid} webhookId -
|
|
@@ -332,7 +332,7 @@ class Webhooks {
|
|
|
332
332
|
});
|
|
333
333
|
}
|
|
334
334
|
/**
|
|
335
|
-
* Delete a webhook. <br
|
|
335
|
+
* Delete a webhook. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
336
336
|
*
|
|
337
337
|
* @param {Frameio.Uuid} accountId -
|
|
338
338
|
* @param {Frameio.Uuid} webhookId -
|
|
@@ -410,7 +410,7 @@ class Webhooks {
|
|
|
410
410
|
});
|
|
411
411
|
}
|
|
412
412
|
/**
|
|
413
|
-
* Update webhook details. <br
|
|
413
|
+
* Update webhook details. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
414
414
|
*
|
|
415
415
|
* @param {Frameio.Uuid} accountId -
|
|
416
416
|
* @param {Frameio.Uuid} webhookId -
|
|
@@ -31,7 +31,7 @@ export declare class WorkspacePermissions {
|
|
|
31
31
|
protected readonly _options: WorkspacePermissions.Options;
|
|
32
32
|
constructor(_options: WorkspacePermissions.Options);
|
|
33
33
|
/**
|
|
34
|
-
* List user roles for a given workspace. <br
|
|
34
|
+
* List user roles for a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
35
35
|
*
|
|
36
36
|
* @param {Frameio.Uuid} accountId -
|
|
37
37
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -57,7 +57,7 @@ export declare class WorkspacePermissions {
|
|
|
57
57
|
index(accountId: Frameio.Uuid, workspaceId: Frameio.Uuid, request?: Frameio.WorkspacePermissionsIndexRequest, requestOptions?: WorkspacePermissions.RequestOptions): core.HttpResponsePromise<Frameio.WorkspaceUserRolesResponse>;
|
|
58
58
|
private __index;
|
|
59
59
|
/**
|
|
60
|
-
* Remove a user from a given workspace. <br
|
|
60
|
+
* Remove a user from a given workspace. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
61
61
|
*
|
|
62
62
|
* @param {Frameio.Uuid} accountId -
|
|
63
63
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -79,7 +79,7 @@ export declare class WorkspacePermissions {
|
|
|
79
79
|
private __workspaceUserRolesDelete;
|
|
80
80
|
/**
|
|
81
81
|
* Update user roles for the given workspace if the user is already added to the workspace. If the user is
|
|
82
|
-
* not added to the workspace, the user will be added with the given role. <br
|
|
82
|
+
* 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
|
|
83
83
|
*
|
|
84
84
|
* @param {Frameio.Uuid} accountId -
|
|
85
85
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -57,7 +57,7 @@ class WorkspacePermissions {
|
|
|
57
57
|
this._options = _options;
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* List user roles for a given workspace. <br
|
|
60
|
+
* List user roles for a given workspace. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
61
61
|
*
|
|
62
62
|
* @param {Frameio.Uuid} accountId -
|
|
63
63
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -155,7 +155,7 @@ class WorkspacePermissions {
|
|
|
155
155
|
});
|
|
156
156
|
}
|
|
157
157
|
/**
|
|
158
|
-
* Remove a user from a given workspace. <br
|
|
158
|
+
* Remove a user from a given workspace. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
159
159
|
*
|
|
160
160
|
* @param {Frameio.Uuid} accountId -
|
|
161
161
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -235,7 +235,7 @@ class WorkspacePermissions {
|
|
|
235
235
|
}
|
|
236
236
|
/**
|
|
237
237
|
* Update user roles for the given workspace if the user is already added to the workspace. If the user is
|
|
238
|
-
* not added to the workspace, the user will be added with the given role. <br
|
|
238
|
+
* 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
|
|
239
239
|
*
|
|
240
240
|
* @param {Frameio.Uuid} accountId -
|
|
241
241
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -31,7 +31,7 @@ export declare class Workspaces {
|
|
|
31
31
|
protected readonly _options: Workspaces.Options;
|
|
32
32
|
constructor(_options: Workspaces.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Show workspace details. <br
|
|
34
|
+
* Show workspace details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
35
35
|
*
|
|
36
36
|
* @param {Frameio.Uuid} accountId -
|
|
37
37
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -54,7 +54,7 @@ export declare class Workspaces {
|
|
|
54
54
|
show(accountId: Frameio.Uuid, workspaceId: Frameio.Uuid, request?: Frameio.WorkspacesShowRequest, requestOptions?: Workspaces.RequestOptions): core.HttpResponsePromise<Frameio.WorkspaceWithIncludesResponse>;
|
|
55
55
|
private __show;
|
|
56
56
|
/**
|
|
57
|
-
* Delete workspace from account. <br
|
|
57
|
+
* Delete workspace from account. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
58
58
|
*
|
|
59
59
|
* @param {Frameio.Uuid} accountId -
|
|
60
60
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -74,7 +74,7 @@ export declare class Workspaces {
|
|
|
74
74
|
delete(accountId: Frameio.Uuid, workspaceId: Frameio.Uuid, requestOptions?: Workspaces.RequestOptions): core.HttpResponsePromise<void>;
|
|
75
75
|
private __delete;
|
|
76
76
|
/**
|
|
77
|
-
* Update a workspace. <br
|
|
77
|
+
* Update a workspace. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
78
78
|
*
|
|
79
79
|
* @param {Frameio.Uuid} accountId -
|
|
80
80
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -99,7 +99,7 @@ export declare class Workspaces {
|
|
|
99
99
|
update(accountId: Frameio.Uuid, workspaceId: Frameio.Uuid, request: Frameio.WorkspaceParams, requestOptions?: Workspaces.RequestOptions): core.HttpResponsePromise<Frameio.WorkspaceResponse>;
|
|
100
100
|
private __update;
|
|
101
101
|
/**
|
|
102
|
-
* List workspaces for a given account. <br
|
|
102
|
+
* List workspaces for a given account. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
103
103
|
*
|
|
104
104
|
* @param {Frameio.Uuid} accountId -
|
|
105
105
|
* @param {Frameio.WorkspacesIndexRequest} request
|
|
@@ -124,7 +124,7 @@ export declare class Workspaces {
|
|
|
124
124
|
index(accountId: Frameio.Uuid, request?: Frameio.WorkspacesIndexRequest, requestOptions?: Workspaces.RequestOptions): core.HttpResponsePromise<Frameio.WorkspacesWithIncludesResponse>;
|
|
125
125
|
private __index;
|
|
126
126
|
/**
|
|
127
|
-
* Create workspace from an account. <br
|
|
127
|
+
* Create workspace from an account. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
128
128
|
*
|
|
129
129
|
* @param {Frameio.Uuid} accountId -
|
|
130
130
|
* @param {Frameio.WorkspaceParams} request
|
|
@@ -57,7 +57,7 @@ class Workspaces {
|
|
|
57
57
|
this._options = _options;
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* Show workspace details. <br
|
|
60
|
+
* Show workspace details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
61
61
|
*
|
|
62
62
|
* @param {Frameio.Uuid} accountId -
|
|
63
63
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -146,7 +146,7 @@ class Workspaces {
|
|
|
146
146
|
});
|
|
147
147
|
}
|
|
148
148
|
/**
|
|
149
|
-
* Delete workspace from account. <br
|
|
149
|
+
* Delete workspace from account. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
150
150
|
*
|
|
151
151
|
* @param {Frameio.Uuid} accountId -
|
|
152
152
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -224,7 +224,7 @@ class Workspaces {
|
|
|
224
224
|
});
|
|
225
225
|
}
|
|
226
226
|
/**
|
|
227
|
-
* Update a workspace. <br
|
|
227
|
+
* Update a workspace. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
228
228
|
*
|
|
229
229
|
* @param {Frameio.Uuid} accountId -
|
|
230
230
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -310,7 +310,7 @@ class Workspaces {
|
|
|
310
310
|
});
|
|
311
311
|
}
|
|
312
312
|
/**
|
|
313
|
-
* List workspaces for a given account. <br
|
|
313
|
+
* List workspaces for a given account. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
314
314
|
*
|
|
315
315
|
* @param {Frameio.Uuid} accountId -
|
|
316
316
|
* @param {Frameio.WorkspacesIndexRequest} request
|
|
@@ -410,7 +410,7 @@ class Workspaces {
|
|
|
410
410
|
});
|
|
411
411
|
}
|
|
412
412
|
/**
|
|
413
|
-
* Create workspace from an account. <br
|
|
413
|
+
* Create workspace from an account. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
414
414
|
*
|
|
415
415
|
* @param {Frameio.Uuid} accountId -
|
|
416
416
|
* @param {Frameio.WorkspaceParams} request
|
|
@@ -2,15 +2,14 @@ export interface AssetShareParams {
|
|
|
2
2
|
access: AssetShareParams.Access;
|
|
3
3
|
/** Asset IDs (File, folder, and/or version stack IDs) */
|
|
4
4
|
asset_ids?: string[];
|
|
5
|
-
/** Share description - NOTE: Requires
|
|
5
|
+
/** Share description - NOTE: Requires feature custom_branded_shares */
|
|
6
6
|
description?: string;
|
|
7
|
-
/** NOTE: Requires a Pro, Team, or Enterprise plan */
|
|
8
7
|
downloading_enabled?: boolean;
|
|
9
8
|
/** Expiration timestamp */
|
|
10
9
|
expiration?: string;
|
|
11
10
|
/** Share Name (must include at least one non-whitespace character and no line breaks) */
|
|
12
11
|
name: string;
|
|
13
|
-
/** Passphrase to access share
|
|
12
|
+
/** Passphrase to access share, if passphrase is required and not given it will be generated */
|
|
14
13
|
passphrase?: string;
|
|
15
14
|
}
|
|
16
15
|
export declare namespace AssetShareParams {
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
2
2
|
export declare const FileWithMediaLinksInclude: {
|
|
3
|
-
readonly MediaLinks: "media_links";
|
|
4
3
|
readonly MediaLinksOriginal: "media_links.original";
|
|
5
4
|
readonly MediaLinksThumbnail: "media_links.thumbnail";
|
|
6
5
|
readonly MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality";
|
|
@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.FileWithMediaLinksInclude = void 0;
|
|
5
5
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
6
6
|
exports.FileWithMediaLinksInclude = {
|
|
7
|
-
MediaLinks: "media_links",
|
|
8
7
|
MediaLinksOriginal: "media_links.original",
|
|
9
8
|
MediaLinksThumbnail: "media_links.thumbnail",
|
|
10
9
|
MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality",
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
export interface MediaLinkCommon {
|
|
2
2
|
/**
|
|
3
|
-
* URL to download the media file.<br
|
|
4
|
-
* HTTP response headers will include Content-Disposition = 'attachment;filename=<filename>'.<br
|
|
5
|
-
* Watermarks may be applied for transcode links as per Account settings and User permissions.<br
|
|
3
|
+
* URL to download the media file.<br/>
|
|
4
|
+
* HTTP response headers will include Content-Disposition = 'attachment;filename=<filename>'.<br/>
|
|
5
|
+
* Watermarks may be applied for transcode links as per Account settings and User permissions.<br/>
|
|
6
6
|
*/
|
|
7
7
|
download_url?: string;
|
|
8
8
|
/** Accepts any additional properties */
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import * as Frameio from "../index.js";
|
|
2
2
|
export interface OriginalMediaLink extends Frameio.MediaLinkCommon {
|
|
3
3
|
/**
|
|
4
|
-
* URL to view the media file in a web browser in its original resolution and media type.<br
|
|
5
|
-
* HTTP response headers will include Content-Disposition = 'inline;filename=<filename>'.<br
|
|
4
|
+
* URL to view the media file in a web browser in its original resolution and media type.<br/>
|
|
5
|
+
* HTTP response headers will include Content-Disposition = 'inline;filename=<filename>'.<br/>
|
|
6
6
|
*/
|
|
7
7
|
inline_url?: string;
|
|
8
8
|
}
|