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
|
@@ -3,16 +3,19 @@ import * as Frameio from "../../../../index.mjs";
|
|
|
3
3
|
* @example
|
|
4
4
|
* {
|
|
5
5
|
* data: {
|
|
6
|
-
* file_ids: ["
|
|
6
|
+
* file_ids: ["8615b40d-f398-470f-8bee-2695cfe9275b", "a9cf461d-aa6d-42f5-880b-d1702ebe8663"],
|
|
7
7
|
* values: [{
|
|
8
|
-
* field_definition_id: "
|
|
9
|
-
* value:
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
8
|
+
* field_definition_id: "2e8ae39f-3647-4b81-a770-9f0d7c2442bf",
|
|
9
|
+
* value: [
|
|
10
|
+
* {
|
|
11
|
+
* "id": "de7ba8c7-6147-4d05-9f45-cc3dca6bdd83",
|
|
12
|
+
* "type": "user"
|
|
13
|
+
* },
|
|
14
|
+
* {
|
|
15
|
+
* "id": "1d28fbed-5f19-406e-9493-1c0bd97a833e",
|
|
16
|
+
* "type": "account_user_group"
|
|
17
|
+
* }
|
|
18
|
+
* ]
|
|
16
19
|
* }]
|
|
17
20
|
* }
|
|
18
21
|
* }
|
|
@@ -26,7 +29,7 @@ export declare namespace BulkUpdateMetadataParams {
|
|
|
26
29
|
file_ids: Frameio.Uuid[];
|
|
27
30
|
/**
|
|
28
31
|
* Metadata field and value mapping params.
|
|
29
|
-
* Note: Select and MultiSelect field values should be passed as lists, eg: [<uuid>]. Users and MultiUser values should be passed as lists formatted as follows: [
|
|
32
|
+
* Note: Select and MultiSelect field values should be passed as lists, eg: [<uuid>]. Users and MultiUser values should be passed as lists formatted as follows: [{id: <user_id>, type: "user"}, {id: <user_group_id>, type: "account_user_group"}
|
|
30
33
|
*/
|
|
31
34
|
values: Data.Values.Item[];
|
|
32
35
|
}
|
|
@@ -6,7 +6,7 @@ export declare namespace MetadataFields {
|
|
|
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 MetadataFields {
|
|
|
28
28
|
*/
|
|
29
29
|
export declare class MetadataFields {
|
|
30
30
|
protected readonly _options: MetadataFields.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options: MetadataFields.Options);
|
|
32
32
|
/**
|
|
33
|
-
* Delete account level custom field definitions. <br
|
|
33
|
+
* Delete account level custom field definitions. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
34
34
|
*
|
|
35
35
|
* @param {Frameio.Uuid} accountId -
|
|
36
36
|
* @param {Frameio.Uuid} fieldDefinitionId -
|
|
@@ -49,7 +49,7 @@ export declare class MetadataFields {
|
|
|
49
49
|
metadataFieldDefinitionsDelete(accountId: Frameio.Uuid, fieldDefinitionId: Frameio.Uuid, requestOptions?: MetadataFields.RequestOptions): core.HttpResponsePromise<void>;
|
|
50
50
|
private __metadataFieldDefinitionsDelete;
|
|
51
51
|
/**
|
|
52
|
-
* Update account level custom field definitions. <br
|
|
52
|
+
* Update account level custom field definitions. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
53
53
|
*
|
|
54
54
|
* @param {Frameio.Uuid} accountId -
|
|
55
55
|
* @param {Frameio.Uuid} fieldDefinitionId -
|
|
@@ -82,7 +82,7 @@ export declare class MetadataFields {
|
|
|
82
82
|
metadataFieldDefinitionsUpdate(accountId: Frameio.Uuid, fieldDefinitionId: Frameio.Uuid, request?: Frameio.UpdateFieldDefinitionParams, requestOptions?: MetadataFields.RequestOptions): core.HttpResponsePromise<Frameio.FieldDefinitionResponse>;
|
|
83
83
|
private __metadataFieldDefinitionsUpdate;
|
|
84
84
|
/**
|
|
85
|
-
* List account level field definitions. <br
|
|
85
|
+
* List account level field definitions. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
86
86
|
*
|
|
87
87
|
* @param {Frameio.Uuid} accountId -
|
|
88
88
|
* @param {Frameio.MetadataFieldDefinitionsIndexRequest} request
|
|
@@ -106,7 +106,7 @@ export declare class MetadataFields {
|
|
|
106
106
|
metadataFieldDefinitionsIndex(accountId: Frameio.Uuid, request?: Frameio.MetadataFieldDefinitionsIndexRequest, requestOptions?: MetadataFields.RequestOptions): core.HttpResponsePromise<Frameio.FieldDefinitionsWithIncludesResponse>;
|
|
107
107
|
private __metadataFieldDefinitionsIndex;
|
|
108
108
|
/**
|
|
109
|
-
* Create account level field definitions. <br
|
|
109
|
+
* Create account level field definitions. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
110
110
|
*
|
|
111
111
|
* @param {Frameio.Uuid} accountId -
|
|
112
112
|
* @param {Frameio.CreateFieldDefinitionParams} request
|
|
@@ -137,5 +137,5 @@ export declare class MetadataFields {
|
|
|
137
137
|
*/
|
|
138
138
|
metadataFieldDefinitionsCreate(accountId: Frameio.Uuid, request?: Frameio.CreateFieldDefinitionParams, requestOptions?: MetadataFields.RequestOptions): core.HttpResponsePromise<Frameio.FieldDefinitionResponse>;
|
|
139
139
|
private __metadataFieldDefinitionsCreate;
|
|
140
|
-
protected _getAuthorizationHeader(): Promise<string
|
|
140
|
+
protected _getAuthorizationHeader(): Promise<string>;
|
|
141
141
|
}
|
|
@@ -17,11 +17,11 @@ import * as errors from "../../../../errors/index.mjs";
|
|
|
17
17
|
* Manage Metadata Fields and related operations.
|
|
18
18
|
*/
|
|
19
19
|
export class MetadataFields {
|
|
20
|
-
constructor(_options
|
|
20
|
+
constructor(_options) {
|
|
21
21
|
this._options = _options;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* Delete account level custom field definitions. <br
|
|
24
|
+
* Delete account level custom field definitions. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
25
25
|
*
|
|
26
26
|
* @param {Frameio.Uuid} accountId -
|
|
27
27
|
* @param {Frameio.Uuid} fieldDefinitionId -
|
|
@@ -96,7 +96,7 @@ export class MetadataFields {
|
|
|
96
96
|
});
|
|
97
97
|
}
|
|
98
98
|
/**
|
|
99
|
-
* Update account level custom field definitions. <br
|
|
99
|
+
* Update account level custom field definitions. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
100
100
|
*
|
|
101
101
|
* @param {Frameio.Uuid} accountId -
|
|
102
102
|
* @param {Frameio.Uuid} fieldDefinitionId -
|
|
@@ -188,7 +188,7 @@ export class MetadataFields {
|
|
|
188
188
|
});
|
|
189
189
|
}
|
|
190
190
|
/**
|
|
191
|
-
* List account level field definitions. <br
|
|
191
|
+
* List account level field definitions. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
192
192
|
*
|
|
193
193
|
* @param {Frameio.Uuid} accountId -
|
|
194
194
|
* @param {Frameio.MetadataFieldDefinitionsIndexRequest} request
|
|
@@ -285,7 +285,7 @@ export class MetadataFields {
|
|
|
285
285
|
});
|
|
286
286
|
}
|
|
287
287
|
/**
|
|
288
|
-
* Create account level field definitions. <br
|
|
288
|
+
* Create account level field definitions. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
289
289
|
*
|
|
290
290
|
* @param {Frameio.Uuid} accountId -
|
|
291
291
|
* @param {Frameio.CreateFieldDefinitionParams} request
|
|
@@ -377,11 +377,7 @@ export class MetadataFields {
|
|
|
377
377
|
}
|
|
378
378
|
_getAuthorizationHeader() {
|
|
379
379
|
return __awaiter(this, void 0, void 0, function* () {
|
|
380
|
-
|
|
381
|
-
if (bearer != null) {
|
|
382
|
-
return `Bearer ${bearer}`;
|
|
383
|
-
}
|
|
384
|
-
return undefined;
|
|
380
|
+
return `Bearer ${yield core.Supplier.get(this._options.token)}`;
|
|
385
381
|
});
|
|
386
382
|
}
|
|
387
383
|
}
|
|
@@ -6,7 +6,7 @@ export declare namespace ProjectPermissions {
|
|
|
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 ProjectPermissions {
|
|
|
28
28
|
*/
|
|
29
29
|
export declare class ProjectPermissions {
|
|
30
30
|
protected readonly _options: ProjectPermissions.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options: ProjectPermissions.Options);
|
|
32
32
|
/**
|
|
33
|
-
* List user roles for a given project. <br
|
|
33
|
+
* List user roles for a given project. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
34
34
|
*
|
|
35
35
|
* @param {Frameio.Uuid} accountId -
|
|
36
36
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -54,7 +54,7 @@ export declare class ProjectPermissions {
|
|
|
54
54
|
*/
|
|
55
55
|
index(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request?: Frameio.ProjectPermissionsIndexRequest, requestOptions?: ProjectPermissions.RequestOptions): Promise<core.Page<Frameio.UserRole>>;
|
|
56
56
|
/**
|
|
57
|
-
* Remove a user from a given project. <br
|
|
57
|
+
* Remove a user from a given project. <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} projectId -
|
|
@@ -75,7 +75,7 @@ export declare class ProjectPermissions {
|
|
|
75
75
|
private __delete;
|
|
76
76
|
/**
|
|
77
77
|
* Update user roles for the given project if the user is already added to the project. If the user is
|
|
78
|
-
* not added to the project, the user will be added with the given role. <br
|
|
78
|
+
* not added to the project, the user will be added with the given role. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
79
79
|
*
|
|
80
80
|
* @param {Frameio.Uuid} accountId -
|
|
81
81
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -99,5 +99,5 @@ export declare class ProjectPermissions {
|
|
|
99
99
|
*/
|
|
100
100
|
projectUserRolesUpdate(accountId: Frameio.Uuid, projectId: Frameio.Uuid, userId: Frameio.Uuid, request: Frameio.UpdateUserRolesParams, requestOptions?: ProjectPermissions.RequestOptions): core.HttpResponsePromise<Frameio.UpdateUserRolesResponse>;
|
|
101
101
|
private __projectUserRolesUpdate;
|
|
102
|
-
protected _getAuthorizationHeader(): Promise<string
|
|
102
|
+
protected _getAuthorizationHeader(): Promise<string>;
|
|
103
103
|
}
|
|
@@ -17,11 +17,11 @@ import * as errors from "../../../../errors/index.mjs";
|
|
|
17
17
|
* Manage Project Permissions and related operations.
|
|
18
18
|
*/
|
|
19
19
|
export class ProjectPermissions {
|
|
20
|
-
constructor(_options
|
|
20
|
+
constructor(_options) {
|
|
21
21
|
this._options = _options;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* List user roles for a given project. <br
|
|
24
|
+
* List user roles for a given project. <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} projectId -
|
|
@@ -126,7 +126,7 @@ export class ProjectPermissions {
|
|
|
126
126
|
});
|
|
127
127
|
}
|
|
128
128
|
/**
|
|
129
|
-
* Remove a user from a given project. <br
|
|
129
|
+
* Remove a user from a given project. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
130
130
|
*
|
|
131
131
|
* @param {Frameio.Uuid} accountId -
|
|
132
132
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -203,7 +203,7 @@ export class ProjectPermissions {
|
|
|
203
203
|
}
|
|
204
204
|
/**
|
|
205
205
|
* Update user roles for the given project if the user is already added to the project. If the user is
|
|
206
|
-
* not added to the project, the user will be added with the given role. <br
|
|
206
|
+
* not added to the project, the user will be added with the given role. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
207
207
|
*
|
|
208
208
|
* @param {Frameio.Uuid} accountId -
|
|
209
209
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -288,11 +288,7 @@ export class ProjectPermissions {
|
|
|
288
288
|
}
|
|
289
289
|
_getAuthorizationHeader() {
|
|
290
290
|
return __awaiter(this, void 0, void 0, function* () {
|
|
291
|
-
|
|
292
|
-
if (bearer != null) {
|
|
293
|
-
return `Bearer ${bearer}`;
|
|
294
|
-
}
|
|
295
|
-
return undefined;
|
|
291
|
+
return `Bearer ${yield core.Supplier.get(this._options.token)}`;
|
|
296
292
|
});
|
|
297
293
|
}
|
|
298
294
|
}
|
|
@@ -6,7 +6,7 @@ export declare namespace Projects {
|
|
|
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 Projects {
|
|
|
28
28
|
*/
|
|
29
29
|
export declare class Projects {
|
|
30
30
|
protected readonly _options: Projects.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options: Projects.Options);
|
|
32
32
|
/**
|
|
33
|
-
* Show project details. <br
|
|
33
|
+
* Show project details. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
34
34
|
*
|
|
35
35
|
* @param {Frameio.Uuid} accountId -
|
|
36
36
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -52,7 +52,7 @@ export declare class Projects {
|
|
|
52
52
|
show(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request?: Frameio.ProjectsShowRequest, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Frameio.ProjectWithIncludesResponse>;
|
|
53
53
|
private __show;
|
|
54
54
|
/**
|
|
55
|
-
* Delete a project. <br
|
|
55
|
+
* Delete a project. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
56
56
|
*
|
|
57
57
|
* @param {Frameio.Uuid} accountId -
|
|
58
58
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -71,11 +71,11 @@ export declare class Projects {
|
|
|
71
71
|
delete(accountId: Frameio.Uuid, projectId: Frameio.Uuid, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<void>;
|
|
72
72
|
private __delete;
|
|
73
73
|
/**
|
|
74
|
-
* Update project details. <br
|
|
74
|
+
* Update project details. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
75
75
|
*
|
|
76
76
|
* @param {Frameio.Uuid} accountId -
|
|
77
77
|
* @param {Frameio.Uuid} projectId -
|
|
78
|
-
* @param {Frameio.
|
|
78
|
+
* @param {Frameio.ProjectUpdateParams} request
|
|
79
79
|
* @param {Projects.RequestOptions} requestOptions - Request-specific configuration.
|
|
80
80
|
*
|
|
81
81
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -88,14 +88,16 @@ export declare class Projects {
|
|
|
88
88
|
* @example
|
|
89
89
|
* await client.projects.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
90
90
|
* data: {
|
|
91
|
-
* name: "Project Name"
|
|
91
|
+
* name: "Project Name",
|
|
92
|
+
* restricted: true,
|
|
93
|
+
* status: "active"
|
|
92
94
|
* }
|
|
93
95
|
* })
|
|
94
96
|
*/
|
|
95
|
-
update(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request: Frameio.
|
|
97
|
+
update(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request: Frameio.ProjectUpdateParams, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Frameio.ProjectResponse>;
|
|
96
98
|
private __update;
|
|
97
99
|
/**
|
|
98
|
-
* List projects in a given workspace. <br
|
|
100
|
+
* List projects in a given workspace. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
99
101
|
*
|
|
100
102
|
* @param {Frameio.Uuid} accountId -
|
|
101
103
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -119,7 +121,7 @@ export declare class Projects {
|
|
|
119
121
|
*/
|
|
120
122
|
index(accountId: Frameio.Uuid, workspaceId: Frameio.Uuid, request?: Frameio.ProjectsIndexRequest, requestOptions?: Projects.RequestOptions): Promise<core.Page<Frameio.ProjectWithIncludes>>;
|
|
121
123
|
/**
|
|
122
|
-
* Create project in a given workspace. <br
|
|
124
|
+
* Create project in a given workspace. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
123
125
|
*
|
|
124
126
|
* @param {Frameio.Uuid} accountId -
|
|
125
127
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -136,11 +138,12 @@ export declare class Projects {
|
|
|
136
138
|
* @example
|
|
137
139
|
* await client.projects.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
138
140
|
* data: {
|
|
139
|
-
* name: "Project Name"
|
|
141
|
+
* name: "Project Name",
|
|
142
|
+
* restricted: true
|
|
140
143
|
* }
|
|
141
144
|
* })
|
|
142
145
|
*/
|
|
143
146
|
create(accountId: Frameio.Uuid, workspaceId: Frameio.Uuid, request: Frameio.ProjectParams, requestOptions?: Projects.RequestOptions): core.HttpResponsePromise<Frameio.ProjectResponse>;
|
|
144
147
|
private __create;
|
|
145
|
-
protected _getAuthorizationHeader(): Promise<string
|
|
148
|
+
protected _getAuthorizationHeader(): Promise<string>;
|
|
146
149
|
}
|
|
@@ -17,11 +17,11 @@ import * as errors from "../../../../errors/index.mjs";
|
|
|
17
17
|
* Manage Projects and related operations.
|
|
18
18
|
*/
|
|
19
19
|
export class Projects {
|
|
20
|
-
constructor(_options
|
|
20
|
+
constructor(_options) {
|
|
21
21
|
this._options = _options;
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* Show project details. <br
|
|
24
|
+
* Show project details. <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} projectId -
|
|
@@ -104,7 +104,7 @@ export class Projects {
|
|
|
104
104
|
});
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
|
-
* Delete a project. <br
|
|
107
|
+
* Delete a project. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
108
108
|
*
|
|
109
109
|
* @param {Frameio.Uuid} accountId -
|
|
110
110
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -179,11 +179,11 @@ export class Projects {
|
|
|
179
179
|
});
|
|
180
180
|
}
|
|
181
181
|
/**
|
|
182
|
-
* Update project details. <br
|
|
182
|
+
* Update project details. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
183
183
|
*
|
|
184
184
|
* @param {Frameio.Uuid} accountId -
|
|
185
185
|
* @param {Frameio.Uuid} projectId -
|
|
186
|
-
* @param {Frameio.
|
|
186
|
+
* @param {Frameio.ProjectUpdateParams} request
|
|
187
187
|
* @param {Projects.RequestOptions} requestOptions - Request-specific configuration.
|
|
188
188
|
*
|
|
189
189
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -196,7 +196,9 @@ export class Projects {
|
|
|
196
196
|
* @example
|
|
197
197
|
* await client.projects.update("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
198
198
|
* data: {
|
|
199
|
-
* name: "Project Name"
|
|
199
|
+
* name: "Project Name",
|
|
200
|
+
* restricted: true,
|
|
201
|
+
* status: "active"
|
|
200
202
|
* }
|
|
201
203
|
* })
|
|
202
204
|
*/
|
|
@@ -262,7 +264,7 @@ export class Projects {
|
|
|
262
264
|
});
|
|
263
265
|
}
|
|
264
266
|
/**
|
|
265
|
-
* List projects in a given workspace. <br
|
|
267
|
+
* List projects in a given workspace. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
266
268
|
*
|
|
267
269
|
* @param {Frameio.Uuid} accountId -
|
|
268
270
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -370,7 +372,7 @@ export class Projects {
|
|
|
370
372
|
});
|
|
371
373
|
}
|
|
372
374
|
/**
|
|
373
|
-
* Create project in a given workspace. <br
|
|
375
|
+
* Create project in a given workspace. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
374
376
|
*
|
|
375
377
|
* @param {Frameio.Uuid} accountId -
|
|
376
378
|
* @param {Frameio.Uuid} workspaceId -
|
|
@@ -387,7 +389,8 @@ export class Projects {
|
|
|
387
389
|
* @example
|
|
388
390
|
* await client.projects.create("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
389
391
|
* data: {
|
|
390
|
-
* name: "Project Name"
|
|
392
|
+
* name: "Project Name",
|
|
393
|
+
* restricted: true
|
|
391
394
|
* }
|
|
392
395
|
* })
|
|
393
396
|
*/
|
|
@@ -454,11 +457,7 @@ export class Projects {
|
|
|
454
457
|
}
|
|
455
458
|
_getAuthorizationHeader() {
|
|
456
459
|
return __awaiter(this, void 0, void 0, function* () {
|
|
457
|
-
|
|
458
|
-
if (bearer != null) {
|
|
459
|
-
return `Bearer ${bearer}`;
|
|
460
|
-
}
|
|
461
|
-
return undefined;
|
|
460
|
+
return `Bearer ${yield core.Supplier.get(this._options.token)}`;
|
|
462
461
|
});
|
|
463
462
|
}
|
|
464
463
|
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* data: {
|
|
5
|
+
* name: "Project Name",
|
|
6
|
+
* restricted: true
|
|
7
|
+
* }
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface ProjectParams {
|
|
11
|
+
data: ProjectParams.Data;
|
|
12
|
+
}
|
|
13
|
+
export declare namespace ProjectParams {
|
|
14
|
+
interface Data {
|
|
15
|
+
/** Project Name */
|
|
16
|
+
name: string;
|
|
17
|
+
/** Whether the project is restricted or not */
|
|
18
|
+
restricted?: boolean;
|
|
19
|
+
}
|
|
20
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* data: {
|
|
5
|
+
* name: "Project Name",
|
|
6
|
+
* restricted: true,
|
|
7
|
+
* status: "active"
|
|
8
|
+
* }
|
|
9
|
+
* }
|
|
10
|
+
*/
|
|
11
|
+
export interface ProjectUpdateParams {
|
|
12
|
+
data: ProjectUpdateParams.Data;
|
|
13
|
+
}
|
|
14
|
+
export declare namespace ProjectUpdateParams {
|
|
15
|
+
interface Data {
|
|
16
|
+
/** Project Name */
|
|
17
|
+
name?: string;
|
|
18
|
+
/** Whether the project is restricted or not */
|
|
19
|
+
restricted?: boolean;
|
|
20
|
+
/** Project Status */
|
|
21
|
+
status?: Data.Status;
|
|
22
|
+
}
|
|
23
|
+
namespace Data {
|
|
24
|
+
/** Project Status */
|
|
25
|
+
const Status: {
|
|
26
|
+
readonly Active: "active";
|
|
27
|
+
readonly Inactive: "inactive";
|
|
28
|
+
};
|
|
29
|
+
type Status = (typeof Status)[keyof typeof Status];
|
|
30
|
+
}
|
|
31
|
+
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export var ProjectUpdateParams;
|
|
3
|
+
(function (ProjectUpdateParams) {
|
|
4
|
+
let Data;
|
|
5
|
+
(function (Data) {
|
|
6
|
+
/** Project Status */
|
|
7
|
+
Data.Status = {
|
|
8
|
+
Active: "active",
|
|
9
|
+
Inactive: "inactive",
|
|
10
|
+
};
|
|
11
|
+
})(Data = ProjectUpdateParams.Data || (ProjectUpdateParams.Data = {}));
|
|
12
|
+
})(ProjectUpdateParams || (ProjectUpdateParams = {}));
|
|
@@ -1,2 +1,4 @@
|
|
|
1
1
|
export { type ProjectsShowRequest } from "./ProjectsShowRequest.mjs";
|
|
2
|
+
export { type ProjectUpdateParams } from "./ProjectUpdateParams.mjs";
|
|
2
3
|
export { type ProjectsIndexRequest } from "./ProjectsIndexRequest.mjs";
|
|
4
|
+
export { type ProjectParams } from "./ProjectParams.mjs";
|
|
@@ -6,7 +6,7 @@ export declare namespace Shares {
|
|
|
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 Shares {
|
|
|
28
28
|
*/
|
|
29
29
|
export declare class Shares {
|
|
30
30
|
protected readonly _options: Shares.Options;
|
|
31
|
-
constructor(_options
|
|
31
|
+
constructor(_options: Shares.Options);
|
|
32
32
|
/**
|
|
33
|
-
* Show a single Share. <br
|
|
33
|
+
* Show a single Share. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
34
34
|
*
|
|
35
35
|
* @param {Frameio.Uuid} accountId -
|
|
36
36
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -49,7 +49,7 @@ export declare class Shares {
|
|
|
49
49
|
show(accountId: Frameio.Uuid, shareId: Frameio.Uuid, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.ShareResponse>;
|
|
50
50
|
private __show;
|
|
51
51
|
/**
|
|
52
|
-
* Delete a share. <br
|
|
52
|
+
* Delete a share. <br>Rate Limits: 60 calls per 1.00 minute(s) per account_user
|
|
53
53
|
*
|
|
54
54
|
* @param {Frameio.Uuid} accountId -
|
|
55
55
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -68,7 +68,7 @@ export declare class Shares {
|
|
|
68
68
|
delete(accountId: Frameio.Uuid, shareId: Frameio.Uuid, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<void>;
|
|
69
69
|
private __delete;
|
|
70
70
|
/**
|
|
71
|
-
* Update share. <br
|
|
71
|
+
* Update share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
72
72
|
*
|
|
73
73
|
* @param {Frameio.Uuid} accountId -
|
|
74
74
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -87,7 +87,8 @@ export declare class Shares {
|
|
|
87
87
|
* data: {
|
|
88
88
|
* access: "public",
|
|
89
89
|
* description: "A descriptive summary of the share",
|
|
90
|
-
*
|
|
90
|
+
* downloading_enabled: true,
|
|
91
|
+
* expiration: "2025-12-17T02:04:49Z",
|
|
91
92
|
* name: "Share Name",
|
|
92
93
|
* passphrase: "as!dfj39sd(*"
|
|
93
94
|
* }
|
|
@@ -96,7 +97,7 @@ export declare class Shares {
|
|
|
96
97
|
update(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request: Frameio.UpdateShareParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.ShareResponse>;
|
|
97
98
|
private __update;
|
|
98
99
|
/**
|
|
99
|
-
* List share reviewers. <br
|
|
100
|
+
* List share reviewers. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
100
101
|
*
|
|
101
102
|
* @param {Frameio.Uuid} accountId -
|
|
102
103
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -120,11 +121,11 @@ export declare class Shares {
|
|
|
120
121
|
listReviewers(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request?: Frameio.SharesListReviewersRequest, requestOptions?: Shares.RequestOptions): Promise<core.Page<Frameio.User>>;
|
|
121
122
|
/**
|
|
122
123
|
* Add reviewers to secure share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
|
|
123
|
-
* <br
|
|
124
|
+
* <br>
|
|
124
125
|
* A request can only include one identifier type parameter.
|
|
125
|
-
* <br
|
|
126
|
+
* <br>
|
|
126
127
|
* `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.
|
|
127
|
-
* <br
|
|
128
|
+
* <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
128
129
|
*
|
|
129
130
|
* @param {Frameio.Uuid} accountId -
|
|
130
131
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -152,9 +153,9 @@ export declare class Shares {
|
|
|
152
153
|
private __addReviewers;
|
|
153
154
|
/**
|
|
154
155
|
* Removes reviewers from secure Share by three identifier types: `adobe_user_id`, `email`, and `user_id`.
|
|
155
|
-
* <br
|
|
156
|
+
* <br>
|
|
156
157
|
* A request can only include one identifier type parameter.
|
|
157
|
-
* <br
|
|
158
|
+
* <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
158
159
|
*
|
|
159
160
|
* @param {Frameio.Uuid} accountId -
|
|
160
161
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -180,7 +181,7 @@ export declare class Shares {
|
|
|
180
181
|
removeReviewers(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request: Frameio.RemoveReviewerParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<void>;
|
|
181
182
|
private __removeReviewers;
|
|
182
183
|
/**
|
|
183
|
-
* Remove an asset currently in the share from that share. <br
|
|
184
|
+
* Remove an asset currently in the share from that share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
184
185
|
*
|
|
185
186
|
* @param {Frameio.Uuid} accountId -
|
|
186
187
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -200,7 +201,7 @@ export declare class Shares {
|
|
|
200
201
|
removeAsset(accountId: Frameio.Uuid, shareId: Frameio.Uuid, assetId: Frameio.Uuid, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.RemoveAssetResponse>;
|
|
201
202
|
private __removeAsset;
|
|
202
203
|
/**
|
|
203
|
-
* Add new asset share. <br
|
|
204
|
+
* Add new asset share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
204
205
|
*
|
|
205
206
|
* @param {Frameio.Uuid} accountId -
|
|
206
207
|
* @param {Frameio.Uuid} shareId -
|
|
@@ -217,14 +218,14 @@ export declare class Shares {
|
|
|
217
218
|
* @example
|
|
218
219
|
* await client.shares.addAsset("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
219
220
|
* data: {
|
|
220
|
-
* asset_id: "
|
|
221
|
+
* asset_id: "68f9a51b-d4e1-43be-bfce-08adac91e4e1"
|
|
221
222
|
* }
|
|
222
223
|
* })
|
|
223
224
|
*/
|
|
224
225
|
addAsset(accountId: Frameio.Uuid, shareId: Frameio.Uuid, request: Frameio.AddAssetParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.AddAssetResponse>;
|
|
225
226
|
private __addAsset;
|
|
226
227
|
/**
|
|
227
|
-
* List shares on a project. <br
|
|
228
|
+
* List shares on a project. <br>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
228
229
|
*
|
|
229
230
|
* @param {Frameio.Uuid} accountId -
|
|
230
231
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -247,7 +248,7 @@ export declare class Shares {
|
|
|
247
248
|
*/
|
|
248
249
|
index(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request?: Frameio.SharesIndexRequest, requestOptions?: Shares.RequestOptions): Promise<core.Page<Frameio.Share>>;
|
|
249
250
|
/**
|
|
250
|
-
* Create share. <br
|
|
251
|
+
* Create share. <br>Rate Limits: 10 calls per 1.00 minute(s) per account_user
|
|
251
252
|
*
|
|
252
253
|
* @param {Frameio.Uuid} accountId -
|
|
253
254
|
* @param {Frameio.Uuid} projectId -
|
|
@@ -266,8 +267,9 @@ export declare class Shares {
|
|
|
266
267
|
* data: {
|
|
267
268
|
* type: "asset",
|
|
268
269
|
* access: "public",
|
|
269
|
-
* asset_ids: ["
|
|
270
|
-
*
|
|
270
|
+
* asset_ids: ["31771855-14a4-427b-8efe-6355127f983c", "8ed9a3b2-d458-46a6-b494-4b54a3c4d16d"],
|
|
271
|
+
* downloading_enabled: true,
|
|
272
|
+
* expiration: "2025-12-17T02:04:49Z",
|
|
271
273
|
* name: "Share Name",
|
|
272
274
|
* passphrase: "as!dfj39sd(*"
|
|
273
275
|
* }
|
|
@@ -275,5 +277,5 @@ export declare class Shares {
|
|
|
275
277
|
*/
|
|
276
278
|
create(accountId: Frameio.Uuid, projectId: Frameio.Uuid, request: Frameio.CreateShareParams, requestOptions?: Shares.RequestOptions): core.HttpResponsePromise<Frameio.ShareResponse>;
|
|
277
279
|
private __create;
|
|
278
|
-
protected _getAuthorizationHeader(): Promise<string
|
|
280
|
+
protected _getAuthorizationHeader(): Promise<string>;
|
|
279
281
|
}
|