frameio 1.3.1 → 1.3.5
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 +41 -14
- package/dist/cjs/api/resources/files/client/Client.js +102 -14
- package/dist/cjs/api/resources/files/client/requests/FileImportParams.d.ts +23 -0
- 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/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/files/types/FilesListRequestInclude.d.ts +1 -1
- package/dist/cjs/api/resources/files/types/FilesListRequestInclude.js +1 -1
- package/dist/cjs/api/resources/files/types/FilesShowRequestInclude.d.ts +1 -1
- package/dist/cjs/api/resources/files/types/FilesShowRequestInclude.js +1 -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 +1 -1
- package/dist/cjs/api/resources/folders/types/FoldersIndexRequestInclude.js +1 -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 +1 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.js +1 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksListRequestInclude.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksListRequestInclude.js +1 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.ts +1 -1
- package/dist/cjs/api/resources/versionStacks/types/VersionStacksShowRequestInclude.js +1 -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/AuditLogwithIncludes.d.ts +1 -0
- package/dist/cjs/api/types/AuditLogwithIncludes.js +1 -0
- package/dist/cjs/api/types/FileWithMediaLinksInclude.d.ts +1 -1
- package/dist/cjs/api/types/FileWithMediaLinksInclude.js +1 -1
- package/dist/cjs/api/types/Filters.d.ts +1 -0
- package/dist/cjs/api/types/Filters.js +1 -0
- package/dist/cjs/api/types/MediaLinkCommon.d.ts +3 -3
- package/dist/cjs/api/types/MediaLinksCollection.d.ts +1 -0
- 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/UnprocessableContent.js +3 -0
- package/dist/cjs/api/types/VersionStackWithIncludes.d.ts +1 -1
- 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 +41 -14
- package/dist/esm/api/resources/files/client/Client.mjs +102 -14
- package/dist/esm/api/resources/files/client/requests/FileImportParams.d.mts +23 -0
- 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/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/files/types/FilesListRequestInclude.d.mts +1 -1
- package/dist/esm/api/resources/files/types/FilesListRequestInclude.mjs +1 -1
- package/dist/esm/api/resources/files/types/FilesShowRequestInclude.d.mts +1 -1
- package/dist/esm/api/resources/files/types/FilesShowRequestInclude.mjs +1 -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 +1 -1
- package/dist/esm/api/resources/folders/types/FoldersIndexRequestInclude.mjs +1 -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 +1 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksIndexRequestInclude.mjs +1 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksListRequestInclude.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksListRequestInclude.mjs +1 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.d.mts +1 -1
- package/dist/esm/api/resources/versionStacks/types/VersionStacksShowRequestInclude.mjs +1 -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/AuditLogwithIncludes.d.mts +1 -0
- package/dist/esm/api/types/AuditLogwithIncludes.mjs +1 -0
- package/dist/esm/api/types/FileWithMediaLinksInclude.d.mts +1 -1
- package/dist/esm/api/types/FileWithMediaLinksInclude.mjs +1 -1
- package/dist/esm/api/types/Filters.d.mts +1 -0
- package/dist/esm/api/types/Filters.mjs +1 -0
- package/dist/esm/api/types/MediaLinkCommon.d.mts +3 -3
- package/dist/esm/api/types/MediaLinksCollection.d.mts +1 -0
- 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/UnprocessableContent.mjs +2 -0
- package/dist/esm/api/types/VersionStackWithIncludes.d.mts +1 -1
- 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 +179 -94
- /package/dist/cjs/api/{types/UnprocessableEntity.js → resources/files/client/requests/FileImportParams.js} +0 -0
- /package/dist/esm/api/{types/UnprocessableEntity.mjs → resources/files/client/requests/FileImportParams.mjs} +0 -0
package/dist/cjs/Client.js
CHANGED
|
@@ -57,8 +57,8 @@ class FrameioClient {
|
|
|
57
57
|
this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
|
|
58
58
|
"X-Fern-Language": "JavaScript",
|
|
59
59
|
"X-Fern-SDK-Name": "frameio",
|
|
60
|
-
"X-Fern-SDK-Version": "1.3.
|
|
61
|
-
"User-Agent": "frameio/1.3.
|
|
60
|
+
"X-Fern-SDK-Version": "1.3.5",
|
|
61
|
+
"User-Agent": "frameio/1.3.5",
|
|
62
62
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
63
63
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
64
64
|
}, _options === null || _options === void 0 ? void 0 : _options.headers) });
|
|
@@ -31,7 +31,7 @@ export declare class AccountPermissions {
|
|
|
31
31
|
protected readonly _options: AccountPermissions.Options;
|
|
32
32
|
constructor(_options: AccountPermissions.Options);
|
|
33
33
|
/**
|
|
34
|
-
* List user roles for a given account. <br
|
|
34
|
+
* List user roles for a given account. <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.AccountPermissionsIndexRequest} request
|
|
@@ -57,7 +57,7 @@ class AccountPermissions {
|
|
|
57
57
|
this._options = _options;
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* List user roles for a given account. <br
|
|
60
|
+
* List user roles for a given account. <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.AccountPermissionsIndexRequest} request
|
|
@@ -31,7 +31,7 @@ export declare class Accounts {
|
|
|
31
31
|
protected readonly _options: Accounts.Options;
|
|
32
32
|
constructor(_options: Accounts.Options);
|
|
33
33
|
/**
|
|
34
|
-
* List accounts for the current user. <br
|
|
34
|
+
* List accounts for the current user. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
35
35
|
*
|
|
36
36
|
* @param {Frameio.AccountsIndexRequest} request
|
|
37
37
|
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -54,7 +54,7 @@ export declare class Accounts {
|
|
|
54
54
|
index(request?: Frameio.AccountsIndexRequest, requestOptions?: Accounts.RequestOptions): core.HttpResponsePromise<Frameio.AccountsResponse>;
|
|
55
55
|
private __index;
|
|
56
56
|
/**
|
|
57
|
-
* List audit logs with filtering capabilities via query params. <br
|
|
57
|
+
* List audit logs with filtering capabilities via query params. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
58
58
|
*
|
|
59
59
|
* @param {Frameio.Uuid} accountId -
|
|
60
60
|
* @param {Frameio.AuditlogIndexRequest} request
|
|
@@ -57,7 +57,7 @@ class Accounts {
|
|
|
57
57
|
this._options = _options;
|
|
58
58
|
}
|
|
59
59
|
/**
|
|
60
|
-
* List accounts for the current user. <br
|
|
60
|
+
* List accounts for the current user. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
61
61
|
*
|
|
62
62
|
* @param {Frameio.AccountsIndexRequest} request
|
|
63
63
|
* @param {Accounts.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -149,7 +149,7 @@ class Accounts {
|
|
|
149
149
|
});
|
|
150
150
|
}
|
|
151
151
|
/**
|
|
152
|
-
* List audit logs with filtering capabilities via query params. <br
|
|
152
|
+
* List audit logs with filtering capabilities via query params. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
153
153
|
*
|
|
154
154
|
* @param {Frameio.Uuid} accountId -
|
|
155
155
|
* @param {Frameio.AuditlogIndexRequest} request
|
|
@@ -31,7 +31,7 @@ export declare class Comments {
|
|
|
31
31
|
protected readonly _options: Comments.Options;
|
|
32
32
|
constructor(_options: Comments.Options);
|
|
33
33
|
/**
|
|
34
|
-
* Show a single comment on a file. <br
|
|
34
|
+
* Show a single comment on a file. <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} commentId -
|
|
@@ -55,7 +55,7 @@ export declare class Comments {
|
|
|
55
55
|
show(accountId: Frameio.Uuid, commentId: Frameio.Uuid, request?: Frameio.CommentsShowRequest, requestOptions?: Comments.RequestOptions): core.HttpResponsePromise<Frameio.CommentWithIncludesResponse>;
|
|
56
56
|
private __show;
|
|
57
57
|
/**
|
|
58
|
-
* Delete comment from an asset. <br
|
|
58
|
+
* Delete comment from an asset. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
59
59
|
*
|
|
60
60
|
* @param {Frameio.Uuid} accountId -
|
|
61
61
|
* @param {Frameio.Uuid} commentId -
|
|
@@ -75,7 +75,7 @@ export declare class Comments {
|
|
|
75
75
|
delete(accountId: Frameio.Uuid, commentId: Frameio.Uuid, requestOptions?: Comments.RequestOptions): core.HttpResponsePromise<void>;
|
|
76
76
|
private __delete;
|
|
77
77
|
/**
|
|
78
|
-
* Update comment on given asset. <br
|
|
78
|
+
* Update comment on given asset. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
79
79
|
*
|
|
80
80
|
* @param {Frameio.Uuid} accountId -
|
|
81
81
|
* @param {Frameio.Uuid} commentId -
|
|
@@ -104,7 +104,7 @@ export declare class Comments {
|
|
|
104
104
|
update(accountId: Frameio.Uuid, commentId: Frameio.Uuid, request: Frameio.UpdateCommentParams, requestOptions?: Comments.RequestOptions): core.HttpResponsePromise<Frameio.CommentResponse>;
|
|
105
105
|
private __update;
|
|
106
106
|
/**
|
|
107
|
-
* List comments on a given asset. <br
|
|
107
|
+
* List comments on a given asset. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
108
108
|
*
|
|
109
109
|
* @param {Frameio.Uuid} accountId -
|
|
110
110
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -131,7 +131,7 @@ export declare class Comments {
|
|
|
131
131
|
index(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request?: Frameio.CommentsIndexRequest, requestOptions?: Comments.RequestOptions): core.HttpResponsePromise<Frameio.CommentsWithIncludesResponse>;
|
|
132
132
|
private __index;
|
|
133
133
|
/**
|
|
134
|
-
* Create a comment on a file. <br
|
|
134
|
+
* Create a comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
135
135
|
*
|
|
136
136
|
* @param {Frameio.Uuid} accountId -
|
|
137
137
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -68,7 +68,7 @@ class Comments {
|
|
|
68
68
|
this._options = _options;
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
71
|
-
* Show a single comment on a file. <br
|
|
71
|
+
* Show a single comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
72
72
|
*
|
|
73
73
|
* @param {Frameio.Uuid} accountId -
|
|
74
74
|
* @param {Frameio.Uuid} commentId -
|
|
@@ -158,7 +158,7 @@ class Comments {
|
|
|
158
158
|
});
|
|
159
159
|
}
|
|
160
160
|
/**
|
|
161
|
-
* Delete comment from an asset. <br
|
|
161
|
+
* Delete comment from an asset. <br/>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
162
162
|
*
|
|
163
163
|
* @param {Frameio.Uuid} accountId -
|
|
164
164
|
* @param {Frameio.Uuid} commentId -
|
|
@@ -236,7 +236,7 @@ class Comments {
|
|
|
236
236
|
});
|
|
237
237
|
}
|
|
238
238
|
/**
|
|
239
|
-
* Update comment on given asset. <br
|
|
239
|
+
* Update comment on given asset. <br/>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
240
240
|
*
|
|
241
241
|
* @param {Frameio.Uuid} accountId -
|
|
242
242
|
* @param {Frameio.Uuid} commentId -
|
|
@@ -331,7 +331,7 @@ class Comments {
|
|
|
331
331
|
});
|
|
332
332
|
}
|
|
333
333
|
/**
|
|
334
|
-
* List comments on a given asset. <br
|
|
334
|
+
* List comments on a given asset. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
335
335
|
*
|
|
336
336
|
* @param {Frameio.Uuid} accountId -
|
|
337
337
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -433,7 +433,7 @@ class Comments {
|
|
|
433
433
|
});
|
|
434
434
|
}
|
|
435
435
|
/**
|
|
436
|
-
* Create a comment on a file. <br
|
|
436
|
+
* Create a comment on a file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
437
437
|
*
|
|
438
438
|
* @param {Frameio.Uuid} accountId -
|
|
439
439
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -31,7 +31,7 @@ export declare class Files {
|
|
|
31
31
|
protected readonly _options: Files.Options;
|
|
32
32
|
constructor(_options: Files.Options);
|
|
33
33
|
/**
|
|
34
|
-
* List files in a given folder. <br
|
|
34
|
+
* List files in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
35
35
|
*
|
|
36
36
|
* @param {Frameio.Uuid} accountId -
|
|
37
37
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -48,7 +48,7 @@ export declare class Files {
|
|
|
48
48
|
*
|
|
49
49
|
* @example
|
|
50
50
|
* await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
51
|
-
* include: "media_links",
|
|
51
|
+
* include: "media_links.original",
|
|
52
52
|
* sort: "name_asc",
|
|
53
53
|
* after: "<opaque_cursor>",
|
|
54
54
|
* page_size: 10,
|
|
@@ -58,7 +58,7 @@ export declare class Files {
|
|
|
58
58
|
list(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request?: Frameio.FilesListRequest, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileAssetsWithIncludesResponse>;
|
|
59
59
|
private __list;
|
|
60
60
|
/**
|
|
61
|
-
* Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br
|
|
61
|
+
* Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
62
62
|
*
|
|
63
63
|
* @param {Frameio.Uuid} accountId -
|
|
64
64
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -86,9 +86,9 @@ export declare class Files {
|
|
|
86
86
|
private __create;
|
|
87
87
|
/**
|
|
88
88
|
* Show file details.
|
|
89
|
-
* <br
|
|
89
|
+
* <br/>
|
|
90
90
|
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
91
|
-
* <br
|
|
91
|
+
* <br/>
|
|
92
92
|
* Note: if you include `media_links.original` and the user does not have permission to download the file
|
|
93
93
|
* then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
|
|
94
94
|
* watermarking is required for this user and isn't supported by the requested media_links, then the request will
|
|
@@ -97,7 +97,7 @@ export declare class Files {
|
|
|
97
97
|
* `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
|
|
98
98
|
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
|
|
99
99
|
* the response payload. In short, the client must handle null media links gracefully.
|
|
100
|
-
* <br
|
|
100
|
+
* <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
101
101
|
*
|
|
102
102
|
* @param {Frameio.Uuid} accountId -
|
|
103
103
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -114,13 +114,13 @@ export declare class Files {
|
|
|
114
114
|
*
|
|
115
115
|
* @example
|
|
116
116
|
* await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
117
|
-
* include: "media_links"
|
|
117
|
+
* include: "media_links.original"
|
|
118
118
|
* })
|
|
119
119
|
*/
|
|
120
120
|
show(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request?: Frameio.FilesShowRequest, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithIncludesResponse>;
|
|
121
121
|
private __show;
|
|
122
122
|
/**
|
|
123
|
-
* Delete file by ID. <br
|
|
123
|
+
* Delete file by ID. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
124
124
|
*
|
|
125
125
|
* @param {Frameio.Uuid} accountId -
|
|
126
126
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -140,7 +140,7 @@ export declare class Files {
|
|
|
140
140
|
delete(accountId: Frameio.Uuid, fileId: Frameio.Uuid, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<void>;
|
|
141
141
|
private __delete;
|
|
142
142
|
/**
|
|
143
|
-
* Update file details. <br
|
|
143
|
+
* Update file details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
144
144
|
*
|
|
145
145
|
* @param {Frameio.Uuid} accountId -
|
|
146
146
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -165,7 +165,7 @@ export declare class Files {
|
|
|
165
165
|
update(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request: Frameio.FileUpdateParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
|
|
166
166
|
private __update;
|
|
167
167
|
/**
|
|
168
|
-
* Copy file. <br
|
|
168
|
+
* Copy file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
169
169
|
*
|
|
170
170
|
* @param {Frameio.Uuid} accountId -
|
|
171
171
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -192,7 +192,7 @@ export declare class Files {
|
|
|
192
192
|
copy(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request?: Frameio.FileCopyParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileCopyResponse>;
|
|
193
193
|
private __copy;
|
|
194
194
|
/**
|
|
195
|
-
* Create new file under parent folder through remote upload. <br
|
|
195
|
+
* Create new file under parent folder through remote upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
196
196
|
*
|
|
197
197
|
* @param {Frameio.Uuid} accountId -
|
|
198
198
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -218,7 +218,7 @@ export declare class Files {
|
|
|
218
218
|
createRemoteUpload(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateRemoteUploadParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileRemoteUploadResponse>;
|
|
219
219
|
private __createRemoteUpload;
|
|
220
220
|
/**
|
|
221
|
-
* Move file to a folder or version_stack. <br
|
|
221
|
+
* Move file to a folder or version_stack. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
222
222
|
*
|
|
223
223
|
* @param {Frameio.Uuid} accountId -
|
|
224
224
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -243,7 +243,7 @@ export declare class Files {
|
|
|
243
243
|
move(accountId: Frameio.Uuid, fileId: Frameio.Uuid, request: Frameio.FileMoveParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
|
|
244
244
|
private __move;
|
|
245
245
|
/**
|
|
246
|
-
* Create new file under parent folder through local upload. <br
|
|
246
|
+
* Create new file under parent folder through local upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
247
247
|
*
|
|
248
248
|
* @param {Frameio.Uuid} accountId -
|
|
249
249
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -269,7 +269,34 @@ export declare class Files {
|
|
|
269
269
|
createLocalUpload(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileCreateLocalUploadParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileWithUploadUrlsResponse>;
|
|
270
270
|
private __createLocalUpload;
|
|
271
271
|
/**
|
|
272
|
-
*
|
|
272
|
+
* Import a file from a storage location configured on the account. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
273
|
+
*
|
|
274
|
+
* @param {Frameio.Uuid} accountId -
|
|
275
|
+
* @param {Frameio.Uuid} folderId -
|
|
276
|
+
* @param {Frameio.FileImportParams} request
|
|
277
|
+
* @param {Files.RequestOptions} requestOptions - Request-specific configuration.
|
|
278
|
+
*
|
|
279
|
+
* @throws {@link Frameio.BadRequestError}
|
|
280
|
+
* @throws {@link Frameio.UnauthorizedError}
|
|
281
|
+
* @throws {@link Frameio.ForbiddenError}
|
|
282
|
+
* @throws {@link Frameio.NotFoundError}
|
|
283
|
+
* @throws {@link Frameio.ConflictError}
|
|
284
|
+
* @throws {@link Frameio.UnprocessableEntityError}
|
|
285
|
+
* @throws {@link Frameio.TooManyRequestsError}
|
|
286
|
+
*
|
|
287
|
+
* @example
|
|
288
|
+
* await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
289
|
+
* data: {
|
|
290
|
+
* key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
|
|
291
|
+
* name: "asset.png",
|
|
292
|
+
* storage_location: "123e4567-e89b-12d3-a456-426614174000"
|
|
293
|
+
* }
|
|
294
|
+
* })
|
|
295
|
+
*/
|
|
296
|
+
importFile(accountId: Frameio.Uuid, folderId: Frameio.Uuid, request: Frameio.FileImportParams, requestOptions?: Files.RequestOptions): core.HttpResponsePromise<Frameio.FileResponse>;
|
|
297
|
+
private __importFile;
|
|
298
|
+
/**
|
|
299
|
+
* Show file upload status details. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
273
300
|
*
|
|
274
301
|
* @param {Frameio.Uuid} accountId -
|
|
275
302
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -68,7 +68,7 @@ class Files {
|
|
|
68
68
|
this._options = _options;
|
|
69
69
|
}
|
|
70
70
|
/**
|
|
71
|
-
* List files in a given folder. <br
|
|
71
|
+
* List files in a given folder. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
72
72
|
*
|
|
73
73
|
* @param {Frameio.Uuid} accountId -
|
|
74
74
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -85,7 +85,7 @@ class Files {
|
|
|
85
85
|
*
|
|
86
86
|
* @example
|
|
87
87
|
* await client.files.list("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
88
|
-
* include: "media_links",
|
|
88
|
+
* include: "media_links.original",
|
|
89
89
|
* sort: "name_asc",
|
|
90
90
|
* after: "<opaque_cursor>",
|
|
91
91
|
* page_size: 10,
|
|
@@ -173,7 +173,7 @@ class Files {
|
|
|
173
173
|
});
|
|
174
174
|
}
|
|
175
175
|
/**
|
|
176
|
-
* Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br
|
|
176
|
+
* Create new file under parent folder. `Create file (local upload)` and `Create file (remote upload)` have replaced this endpoint. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
177
177
|
*
|
|
178
178
|
* @param {Frameio.Uuid} accountId -
|
|
179
179
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -262,9 +262,9 @@ class Files {
|
|
|
262
262
|
}
|
|
263
263
|
/**
|
|
264
264
|
* Show file details.
|
|
265
|
-
* <br
|
|
265
|
+
* <br/>
|
|
266
266
|
* Use the `include` query parameter to selectively include additional properties in the response.
|
|
267
|
-
* <br
|
|
267
|
+
* <br/>
|
|
268
268
|
* Note: if you include `media_links.original` and the user does not have permission to download the file
|
|
269
269
|
* then this endpoint will respond with a `403 Forbidden` error. If the content is inaccessible because
|
|
270
270
|
* watermarking is required for this user and isn't supported by the requested media_links, then the request will
|
|
@@ -273,7 +273,7 @@ class Files {
|
|
|
273
273
|
* `media_links.video_h264_180` on a static image file) or transoding process hasn't completed
|
|
274
274
|
* (i.e. the file's `status` is "uploaded" rather than "transcoded"), then the link will also be set to null in
|
|
275
275
|
* the response payload. In short, the client must handle null media links gracefully.
|
|
276
|
-
* <br
|
|
276
|
+
* <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
277
277
|
*
|
|
278
278
|
* @param {Frameio.Uuid} accountId -
|
|
279
279
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -290,7 +290,7 @@ class Files {
|
|
|
290
290
|
*
|
|
291
291
|
* @example
|
|
292
292
|
* await client.files.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
293
|
-
* include: "media_links"
|
|
293
|
+
* include: "media_links.original"
|
|
294
294
|
* })
|
|
295
295
|
*/
|
|
296
296
|
show(accountId, fileId, request = {}, requestOptions) {
|
|
@@ -359,7 +359,7 @@ class Files {
|
|
|
359
359
|
});
|
|
360
360
|
}
|
|
361
361
|
/**
|
|
362
|
-
* Delete file by ID. <br
|
|
362
|
+
* Delete file by ID. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
363
363
|
*
|
|
364
364
|
* @param {Frameio.Uuid} accountId -
|
|
365
365
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -437,7 +437,7 @@ class Files {
|
|
|
437
437
|
});
|
|
438
438
|
}
|
|
439
439
|
/**
|
|
440
|
-
* Update file details. <br
|
|
440
|
+
* Update file details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
441
441
|
*
|
|
442
442
|
* @param {Frameio.Uuid} accountId -
|
|
443
443
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -523,7 +523,7 @@ class Files {
|
|
|
523
523
|
});
|
|
524
524
|
}
|
|
525
525
|
/**
|
|
526
|
-
* Copy file. <br
|
|
526
|
+
* Copy file. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
527
527
|
*
|
|
528
528
|
* @param {Frameio.Uuid} accountId -
|
|
529
529
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -619,7 +619,7 @@ class Files {
|
|
|
619
619
|
});
|
|
620
620
|
}
|
|
621
621
|
/**
|
|
622
|
-
* Create new file under parent folder through remote upload. <br
|
|
622
|
+
* Create new file under parent folder through remote upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
623
623
|
*
|
|
624
624
|
* @param {Frameio.Uuid} accountId -
|
|
625
625
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -706,7 +706,7 @@ class Files {
|
|
|
706
706
|
});
|
|
707
707
|
}
|
|
708
708
|
/**
|
|
709
|
-
* Move file to a folder or version_stack. <br
|
|
709
|
+
* Move file to a folder or version_stack. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
710
710
|
*
|
|
711
711
|
* @param {Frameio.Uuid} accountId -
|
|
712
712
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -792,7 +792,7 @@ class Files {
|
|
|
792
792
|
});
|
|
793
793
|
}
|
|
794
794
|
/**
|
|
795
|
-
* Create new file under parent folder through local upload. <br
|
|
795
|
+
* Create new file under parent folder through local upload. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
796
796
|
*
|
|
797
797
|
* @param {Frameio.Uuid} accountId -
|
|
798
798
|
* @param {Frameio.Uuid} folderId -
|
|
@@ -879,7 +879,95 @@ class Files {
|
|
|
879
879
|
});
|
|
880
880
|
}
|
|
881
881
|
/**
|
|
882
|
-
*
|
|
882
|
+
* Import a file from a storage location configured on the account. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
883
|
+
*
|
|
884
|
+
* @param {Frameio.Uuid} accountId -
|
|
885
|
+
* @param {Frameio.Uuid} folderId -
|
|
886
|
+
* @param {Frameio.FileImportParams} request
|
|
887
|
+
* @param {Files.RequestOptions} requestOptions - Request-specific configuration.
|
|
888
|
+
*
|
|
889
|
+
* @throws {@link Frameio.BadRequestError}
|
|
890
|
+
* @throws {@link Frameio.UnauthorizedError}
|
|
891
|
+
* @throws {@link Frameio.ForbiddenError}
|
|
892
|
+
* @throws {@link Frameio.NotFoundError}
|
|
893
|
+
* @throws {@link Frameio.ConflictError}
|
|
894
|
+
* @throws {@link Frameio.UnprocessableEntityError}
|
|
895
|
+
* @throws {@link Frameio.TooManyRequestsError}
|
|
896
|
+
*
|
|
897
|
+
* @example
|
|
898
|
+
* await client.files.importFile("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
899
|
+
* data: {
|
|
900
|
+
* key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
|
|
901
|
+
* name: "asset.png",
|
|
902
|
+
* storage_location: "123e4567-e89b-12d3-a456-426614174000"
|
|
903
|
+
* }
|
|
904
|
+
* })
|
|
905
|
+
*/
|
|
906
|
+
importFile(accountId, folderId, request, requestOptions) {
|
|
907
|
+
return core.HttpResponsePromise.fromPromise(this.__importFile(accountId, folderId, request, requestOptions));
|
|
908
|
+
}
|
|
909
|
+
__importFile(accountId, folderId, request, requestOptions) {
|
|
910
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
911
|
+
var _a, _b, _c, _d;
|
|
912
|
+
let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
913
|
+
const _response = yield ((_b = this._options.fetcher) !== null && _b !== void 0 ? _b : core.fetcher)({
|
|
914
|
+
url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.FrameioEnvironment.Default, `v4/accounts/${encodeURIComponent(accountId)}/folders/${encodeURIComponent(folderId)}/files/import`),
|
|
915
|
+
method: "POST",
|
|
916
|
+
headers: _headers,
|
|
917
|
+
contentType: "application/json",
|
|
918
|
+
queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
|
|
919
|
+
requestType: "json",
|
|
920
|
+
body: request,
|
|
921
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
922
|
+
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
923
|
+
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
924
|
+
});
|
|
925
|
+
if (_response.ok) {
|
|
926
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
927
|
+
}
|
|
928
|
+
if (_response.error.reason === "status-code") {
|
|
929
|
+
switch (_response.error.statusCode) {
|
|
930
|
+
case 400:
|
|
931
|
+
throw new Frameio.BadRequestError(_response.error.body, _response.rawResponse);
|
|
932
|
+
case 401:
|
|
933
|
+
throw new Frameio.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
934
|
+
case 403:
|
|
935
|
+
throw new Frameio.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
936
|
+
case 404:
|
|
937
|
+
throw new Frameio.NotFoundError(_response.error.body, _response.rawResponse);
|
|
938
|
+
case 409:
|
|
939
|
+
throw new Frameio.ConflictError(_response.error.body, _response.rawResponse);
|
|
940
|
+
case 422:
|
|
941
|
+
throw new Frameio.UnprocessableEntityError(_response.error.body, _response.rawResponse);
|
|
942
|
+
case 429:
|
|
943
|
+
throw new Frameio.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
944
|
+
default:
|
|
945
|
+
throw new errors.FrameioError({
|
|
946
|
+
statusCode: _response.error.statusCode,
|
|
947
|
+
body: _response.error.body,
|
|
948
|
+
rawResponse: _response.rawResponse,
|
|
949
|
+
});
|
|
950
|
+
}
|
|
951
|
+
}
|
|
952
|
+
switch (_response.error.reason) {
|
|
953
|
+
case "non-json":
|
|
954
|
+
throw new errors.FrameioError({
|
|
955
|
+
statusCode: _response.error.statusCode,
|
|
956
|
+
body: _response.error.rawBody,
|
|
957
|
+
rawResponse: _response.rawResponse,
|
|
958
|
+
});
|
|
959
|
+
case "timeout":
|
|
960
|
+
throw new errors.FrameioTimeoutError("Timeout exceeded when calling POST /v4/accounts/{account_id}/folders/{folder_id}/files/import.");
|
|
961
|
+
case "unknown":
|
|
962
|
+
throw new errors.FrameioError({
|
|
963
|
+
message: _response.error.errorMessage,
|
|
964
|
+
rawResponse: _response.rawResponse,
|
|
965
|
+
});
|
|
966
|
+
}
|
|
967
|
+
});
|
|
968
|
+
}
|
|
969
|
+
/**
|
|
970
|
+
* Show file upload status details. <br/>Rate Limits: 5 calls per 1 second(s) per account_user
|
|
883
971
|
*
|
|
884
972
|
* @param {Frameio.Uuid} accountId -
|
|
885
973
|
* @param {Frameio.Uuid} fileId -
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* data: {
|
|
5
|
+
* key: "uploads/08091b0f-a541-42f5-a059-5e8c4afecc12/original.png",
|
|
6
|
+
* name: "asset.png",
|
|
7
|
+
* storage_location: "123e4567-e89b-12d3-a456-426614174000"
|
|
8
|
+
* }
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface FileImportParams {
|
|
12
|
+
data: FileImportParams.Data;
|
|
13
|
+
}
|
|
14
|
+
export declare namespace FileImportParams {
|
|
15
|
+
interface Data {
|
|
16
|
+
/** File key/path within the filespace */
|
|
17
|
+
key: string;
|
|
18
|
+
/** File name */
|
|
19
|
+
name: string;
|
|
20
|
+
/** Storage location with account UUID as the value or prefix. Applies to accounts with Storage Connect */
|
|
21
|
+
storage_location: string;
|
|
22
|
+
}
|
|
23
|
+
}
|
|
@@ -6,3 +6,4 @@ export { type FileCopyParams } from "./FileCopyParams.js";
|
|
|
6
6
|
export { type FileCreateRemoteUploadParams } from "./FileCreateRemoteUploadParams.js";
|
|
7
7
|
export { type FileMoveParams } from "./FileMoveParams.js";
|
|
8
8
|
export { type FileCreateLocalUploadParams } from "./FileCreateLocalUploadParams.js";
|
|
9
|
+
export { type FileImportParams } from "./FileImportParams.js";
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
2
2
|
export declare const FilesListRequestInclude: {
|
|
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";
|
|
7
6
|
readonly MediaLinksVideoH264180: "media_links.video_h264_180";
|
|
8
7
|
readonly MediaLinksHighQuality: "media_links.high_quality";
|
|
9
8
|
readonly MediaLinksEfficient: "media_links.efficient";
|
|
9
|
+
readonly MediaLinksScrubSheet: "media_links.scrub_sheet";
|
|
10
10
|
readonly Creator: "creator";
|
|
11
11
|
readonly Project: "project";
|
|
12
12
|
readonly ProjectOwner: "project.owner";
|
|
@@ -4,13 +4,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.FilesListRequestInclude = void 0;
|
|
5
5
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
6
6
|
exports.FilesListRequestInclude = {
|
|
7
|
-
MediaLinks: "media_links",
|
|
8
7
|
MediaLinksOriginal: "media_links.original",
|
|
9
8
|
MediaLinksThumbnail: "media_links.thumbnail",
|
|
10
9
|
MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality",
|
|
11
10
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
12
11
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
13
12
|
MediaLinksEfficient: "media_links.efficient",
|
|
13
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
14
14
|
Creator: "creator",
|
|
15
15
|
Project: "project",
|
|
16
16
|
ProjectOwner: "project.owner",
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
2
2
|
export declare const FilesShowRequestInclude: {
|
|
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";
|
|
7
6
|
readonly MediaLinksVideoH264180: "media_links.video_h264_180";
|
|
8
7
|
readonly MediaLinksHighQuality: "media_links.high_quality";
|
|
9
8
|
readonly MediaLinksEfficient: "media_links.efficient";
|
|
9
|
+
readonly MediaLinksScrubSheet: "media_links.scrub_sheet";
|
|
10
10
|
readonly Creator: "creator";
|
|
11
11
|
readonly Project: "project";
|
|
12
12
|
readonly ProjectOwner: "project.owner";
|
|
@@ -4,13 +4,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.FilesShowRequestInclude = void 0;
|
|
5
5
|
/** Supported include query parameter values for endpoints that return files with media links */
|
|
6
6
|
exports.FilesShowRequestInclude = {
|
|
7
|
-
MediaLinks: "media_links",
|
|
8
7
|
MediaLinksOriginal: "media_links.original",
|
|
9
8
|
MediaLinksThumbnail: "media_links.thumbnail",
|
|
10
9
|
MediaLinksThumbnailHighQuality: "media_links.thumbnail_high_quality",
|
|
11
10
|
MediaLinksVideoH264180: "media_links.video_h264_180",
|
|
12
11
|
MediaLinksHighQuality: "media_links.high_quality",
|
|
13
12
|
MediaLinksEfficient: "media_links.efficient",
|
|
13
|
+
MediaLinksScrubSheet: "media_links.scrub_sheet",
|
|
14
14
|
Creator: "creator",
|
|
15
15
|
Project: "project",
|
|
16
16
|
ProjectOwner: "project.owner",
|