frameio 4.2.2 → 4.2.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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +30 -30
- package/dist/cjs/Client.js +38 -38
- package/dist/cjs/api/resources/collections/client/Client.d.ts +17 -17
- package/dist/cjs/api/resources/collections/client/Client.js +30 -30
- package/dist/cjs/api/resources/files/client/Client.d.ts +96 -96
- package/dist/cjs/api/resources/files/client/Client.js +175 -175
- package/dist/cjs/api/resources/folders/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/folders/client/Client.js +29 -29
- package/dist/cjs/api/resources/metadata/client/Client.d.ts +27 -27
- package/dist/cjs/api/resources/metadata/client/Client.js +50 -50
- package/dist/cjs/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.ts +4 -4
- package/dist/cjs/api/resources/projectPermissions/client/Client.d.ts +24 -24
- package/dist/cjs/api/resources/projectPermissions/client/Client.js +87 -87
- package/dist/cjs/api/resources/projects/client/Client.d.ts +56 -0
- package/dist/cjs/api/resources/projects/client/Client.js +166 -0
- package/dist/cjs/api/resources/projects/client/requests/AccountProjectsIndexRequest.d.ts +24 -0
- package/dist/cjs/api/resources/projects/client/requests/AccountProjectsIndexRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/InvitedProjectsIndexRequest.d.ts +24 -0
- package/dist/cjs/api/resources/projects/client/requests/InvitedProjectsIndexRequest.js +3 -0
- package/dist/cjs/api/resources/projects/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/projects/types/AccountProjectsIndexRequestSort.d.ts +8 -0
- package/dist/cjs/api/resources/projects/types/AccountProjectsIndexRequestSort.js +11 -0
- package/dist/cjs/api/resources/projects/types/InvitedProjectsIndexRequestSort.d.ts +8 -0
- package/dist/cjs/api/resources/projects/types/InvitedProjectsIndexRequestSort.js +11 -0
- package/dist/cjs/api/resources/projects/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/projects/types/index.js +2 -0
- package/dist/cjs/api/resources/shares/client/Client.d.ts +49 -49
- package/dist/cjs/api/resources/shares/client/Client.js +146 -146
- 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 +1 -1
- package/dist/cjs/api/resources/versionStacks/client/Client.d.ts +64 -64
- package/dist/cjs/api/resources/versionStacks/client/Client.js +121 -121
- package/dist/cjs/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.ts +1 -1
- package/dist/cjs/api/resources/workspacePermissions/client/Client.d.ts +24 -24
- package/dist/cjs/api/resources/workspacePermissions/client/Client.js +87 -87
- package/dist/cjs/api/resources/workspaces/client/Client.d.ts +34 -34
- package/dist/cjs/api/resources/workspaces/client/Client.js +141 -141
- package/dist/cjs/api/types/AuditLogwithIncludes.d.ts +6 -0
- package/dist/cjs/api/types/AuditLogwithIncludes.js +6 -0
- package/dist/cjs/api/types/Filters.d.ts +6 -0
- package/dist/cjs/api/types/Filters.js +6 -0
- package/dist/cjs/api/types/LongTextDefinition.d.ts +0 -16
- package/dist/cjs/api/types/LongTextDefinition.js +0 -17
- package/dist/cjs/api/types/NumberDefinition.d.ts +16 -0
- package/dist/cjs/api/types/NumberDefinition.js +13 -0
- package/dist/cjs/api/types/TextDefinition.d.ts +0 -16
- package/dist/cjs/api/types/TextDefinition.js +0 -17
- package/dist/cjs/api/types/ToggleDefinition.d.ts +16 -0
- package/dist/cjs/api/types/ToggleDefinition.js +17 -0
- package/dist/cjs/api/types/UserSingleDefinition.d.ts +0 -16
- package/dist/cjs/api/types/UserSingleDefinition.js +0 -13
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +30 -30
- package/dist/esm/Client.mjs +38 -38
- package/dist/esm/api/resources/collections/client/Client.d.mts +17 -17
- package/dist/esm/api/resources/collections/client/Client.mjs +30 -30
- package/dist/esm/api/resources/files/client/Client.d.mts +96 -96
- package/dist/esm/api/resources/files/client/Client.mjs +175 -175
- package/dist/esm/api/resources/folders/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/folders/client/Client.mjs +29 -29
- package/dist/esm/api/resources/metadata/client/Client.d.mts +27 -27
- package/dist/esm/api/resources/metadata/client/Client.mjs +50 -50
- package/dist/esm/api/resources/metadata/client/requests/BulkUpdateMetadataParams.d.mts +4 -4
- package/dist/esm/api/resources/projectPermissions/client/Client.d.mts +24 -24
- package/dist/esm/api/resources/projectPermissions/client/Client.mjs +87 -87
- package/dist/esm/api/resources/projects/client/Client.d.mts +56 -0
- package/dist/esm/api/resources/projects/client/Client.mjs +166 -0
- package/dist/esm/api/resources/projects/client/requests/AccountProjectsIndexRequest.d.mts +24 -0
- package/dist/esm/api/resources/projects/client/requests/AccountProjectsIndexRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/InvitedProjectsIndexRequest.d.mts +24 -0
- package/dist/esm/api/resources/projects/client/requests/InvitedProjectsIndexRequest.mjs +2 -0
- package/dist/esm/api/resources/projects/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/projects/types/AccountProjectsIndexRequestSort.d.mts +8 -0
- package/dist/esm/api/resources/projects/types/AccountProjectsIndexRequestSort.mjs +8 -0
- package/dist/esm/api/resources/projects/types/InvitedProjectsIndexRequestSort.d.mts +8 -0
- package/dist/esm/api/resources/projects/types/InvitedProjectsIndexRequestSort.mjs +8 -0
- package/dist/esm/api/resources/projects/types/index.d.mts +2 -0
- package/dist/esm/api/resources/projects/types/index.mjs +2 -0
- package/dist/esm/api/resources/shares/client/Client.d.mts +49 -49
- package/dist/esm/api/resources/shares/client/Client.mjs +146 -146
- 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 +1 -1
- package/dist/esm/api/resources/versionStacks/client/Client.d.mts +64 -64
- package/dist/esm/api/resources/versionStacks/client/Client.mjs +121 -121
- package/dist/esm/api/resources/versionStacks/client/requests/VersionStackCreateParams.d.mts +1 -1
- package/dist/esm/api/resources/workspacePermissions/client/Client.d.mts +24 -24
- package/dist/esm/api/resources/workspacePermissions/client/Client.mjs +87 -87
- package/dist/esm/api/resources/workspaces/client/Client.d.mts +34 -34
- package/dist/esm/api/resources/workspaces/client/Client.mjs +141 -141
- package/dist/esm/api/types/AuditLogwithIncludes.d.mts +6 -0
- package/dist/esm/api/types/AuditLogwithIncludes.mjs +6 -0
- package/dist/esm/api/types/Filters.d.mts +6 -0
- package/dist/esm/api/types/Filters.mjs +6 -0
- package/dist/esm/api/types/LongTextDefinition.d.mts +0 -16
- package/dist/esm/api/types/LongTextDefinition.mjs +1 -16
- package/dist/esm/api/types/NumberDefinition.d.mts +16 -0
- package/dist/esm/api/types/NumberDefinition.mjs +13 -0
- package/dist/esm/api/types/TextDefinition.d.mts +0 -16
- package/dist/esm/api/types/TextDefinition.mjs +1 -16
- package/dist/esm/api/types/ToggleDefinition.d.mts +16 -0
- package/dist/esm/api/types/ToggleDefinition.mjs +16 -1
- package/dist/esm/api/types/UserSingleDefinition.d.mts +0 -16
- package/dist/esm/api/types/UserSingleDefinition.mjs +0 -13
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +112 -112
- package/reference.md +1392 -1234
|
@@ -17,4 +17,17 @@ var NumberDefinition;
|
|
|
17
17
|
Timecode: "timecode",
|
|
18
18
|
};
|
|
19
19
|
})(FieldConfiguration = NumberDefinition.FieldConfiguration || (NumberDefinition.FieldConfiguration = {}));
|
|
20
|
+
/** Field type */
|
|
21
|
+
NumberDefinition.FieldType = {
|
|
22
|
+
Text: "text",
|
|
23
|
+
LongText: "long_text",
|
|
24
|
+
Select: "select",
|
|
25
|
+
SelectMulti: "select_multi",
|
|
26
|
+
Rating: "rating",
|
|
27
|
+
Number: "number",
|
|
28
|
+
Toggle: "toggle",
|
|
29
|
+
UserSingle: "user_single",
|
|
30
|
+
UserMulti: "user_multi",
|
|
31
|
+
Date: "date",
|
|
32
|
+
};
|
|
20
33
|
})(NumberDefinition || (exports.NumberDefinition = NumberDefinition = {}));
|
|
@@ -4,8 +4,6 @@ export interface TextDefinition {
|
|
|
4
4
|
/** Field definition creator ID */
|
|
5
5
|
creator_id: string;
|
|
6
6
|
field_configuration: TextDefinition.FieldConfiguration;
|
|
7
|
-
/** Field type */
|
|
8
|
-
field_type: TextDefinition.FieldType;
|
|
9
7
|
/** Field definition ID */
|
|
10
8
|
id: string;
|
|
11
9
|
/** Field definition mutability. System fields cannot be updated. */
|
|
@@ -17,18 +15,4 @@ export interface TextDefinition {
|
|
|
17
15
|
}
|
|
18
16
|
export declare namespace TextDefinition {
|
|
19
17
|
type FieldConfiguration = {};
|
|
20
|
-
/** Field type */
|
|
21
|
-
const FieldType: {
|
|
22
|
-
readonly Text: "text";
|
|
23
|
-
readonly LongText: "long_text";
|
|
24
|
-
readonly Select: "select";
|
|
25
|
-
readonly SelectMulti: "select_multi";
|
|
26
|
-
readonly Rating: "rating";
|
|
27
|
-
readonly Number: "number";
|
|
28
|
-
readonly Toggle: "toggle";
|
|
29
|
-
readonly UserSingle: "user_single";
|
|
30
|
-
readonly UserMulti: "user_multi";
|
|
31
|
-
readonly Date: "date";
|
|
32
|
-
};
|
|
33
|
-
type FieldType = (typeof FieldType)[keyof typeof FieldType];
|
|
34
18
|
}
|
|
@@ -1,20 +1,3 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
-
exports.TextDefinition = void 0;
|
|
5
|
-
var TextDefinition;
|
|
6
|
-
(function (TextDefinition) {
|
|
7
|
-
/** Field type */
|
|
8
|
-
TextDefinition.FieldType = {
|
|
9
|
-
Text: "text",
|
|
10
|
-
LongText: "long_text",
|
|
11
|
-
Select: "select",
|
|
12
|
-
SelectMulti: "select_multi",
|
|
13
|
-
Rating: "rating",
|
|
14
|
-
Number: "number",
|
|
15
|
-
Toggle: "toggle",
|
|
16
|
-
UserSingle: "user_single",
|
|
17
|
-
UserMulti: "user_multi",
|
|
18
|
-
Date: "date",
|
|
19
|
-
};
|
|
20
|
-
})(TextDefinition || (exports.TextDefinition = TextDefinition = {}));
|
|
@@ -4,6 +4,8 @@ export interface ToggleDefinition {
|
|
|
4
4
|
/** Field definition creator ID */
|
|
5
5
|
creator_id: string;
|
|
6
6
|
field_configuration: ToggleDefinition.FieldConfiguration;
|
|
7
|
+
/** Field type */
|
|
8
|
+
field_type: ToggleDefinition.FieldType;
|
|
7
9
|
/** Field definition ID */
|
|
8
10
|
id: string;
|
|
9
11
|
/** Field definition mutability. System fields cannot be updated. */
|
|
@@ -18,4 +20,18 @@ export declare namespace ToggleDefinition {
|
|
|
18
20
|
/** Color value hex code. ex: #fbd400 */
|
|
19
21
|
color?: string | undefined;
|
|
20
22
|
}
|
|
23
|
+
/** Field type */
|
|
24
|
+
const FieldType: {
|
|
25
|
+
readonly Text: "text";
|
|
26
|
+
readonly LongText: "long_text";
|
|
27
|
+
readonly Select: "select";
|
|
28
|
+
readonly SelectMulti: "select_multi";
|
|
29
|
+
readonly Rating: "rating";
|
|
30
|
+
readonly Number: "number";
|
|
31
|
+
readonly Toggle: "toggle";
|
|
32
|
+
readonly UserSingle: "user_single";
|
|
33
|
+
readonly UserMulti: "user_multi";
|
|
34
|
+
readonly Date: "date";
|
|
35
|
+
};
|
|
36
|
+
type FieldType = (typeof FieldType)[keyof typeof FieldType];
|
|
21
37
|
}
|
|
@@ -1,3 +1,20 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.ToggleDefinition = void 0;
|
|
5
|
+
var ToggleDefinition;
|
|
6
|
+
(function (ToggleDefinition) {
|
|
7
|
+
/** Field type */
|
|
8
|
+
ToggleDefinition.FieldType = {
|
|
9
|
+
Text: "text",
|
|
10
|
+
LongText: "long_text",
|
|
11
|
+
Select: "select",
|
|
12
|
+
SelectMulti: "select_multi",
|
|
13
|
+
Rating: "rating",
|
|
14
|
+
Number: "number",
|
|
15
|
+
Toggle: "toggle",
|
|
16
|
+
UserSingle: "user_single",
|
|
17
|
+
UserMulti: "user_multi",
|
|
18
|
+
Date: "date",
|
|
19
|
+
};
|
|
20
|
+
})(ToggleDefinition || (exports.ToggleDefinition = ToggleDefinition = {}));
|
|
@@ -4,8 +4,6 @@ export interface UserSingleDefinition {
|
|
|
4
4
|
/** Field definition creator ID */
|
|
5
5
|
creator_id: string;
|
|
6
6
|
field_configuration: UserSingleDefinition.FieldConfiguration;
|
|
7
|
-
/** Field type */
|
|
8
|
-
field_type: UserSingleDefinition.FieldType;
|
|
9
7
|
/** Field definition ID */
|
|
10
8
|
id: string;
|
|
11
9
|
/** Field definition mutability. System fields cannot be updated. */
|
|
@@ -43,18 +41,4 @@ export declare namespace UserSingleDefinition {
|
|
|
43
41
|
};
|
|
44
42
|
type MemberOptionsType = (typeof MemberOptionsType)[keyof typeof MemberOptionsType];
|
|
45
43
|
}
|
|
46
|
-
/** Field type */
|
|
47
|
-
const FieldType: {
|
|
48
|
-
readonly Text: "text";
|
|
49
|
-
readonly LongText: "long_text";
|
|
50
|
-
readonly Select: "select";
|
|
51
|
-
readonly SelectMulti: "select_multi";
|
|
52
|
-
readonly Rating: "rating";
|
|
53
|
-
readonly Number: "number";
|
|
54
|
-
readonly Toggle: "toggle";
|
|
55
|
-
readonly UserSingle: "user_single";
|
|
56
|
-
readonly UserMulti: "user_multi";
|
|
57
|
-
readonly Date: "date";
|
|
58
|
-
};
|
|
59
|
-
type FieldType = (typeof FieldType)[keyof typeof FieldType];
|
|
60
44
|
}
|
|
@@ -21,17 +21,4 @@ var UserSingleDefinition;
|
|
|
21
21
|
Custom: "custom",
|
|
22
22
|
};
|
|
23
23
|
})(FieldConfiguration = UserSingleDefinition.FieldConfiguration || (UserSingleDefinition.FieldConfiguration = {}));
|
|
24
|
-
/** Field type */
|
|
25
|
-
UserSingleDefinition.FieldType = {
|
|
26
|
-
Text: "text",
|
|
27
|
-
LongText: "long_text",
|
|
28
|
-
Select: "select",
|
|
29
|
-
SelectMulti: "select_multi",
|
|
30
|
-
Rating: "rating",
|
|
31
|
-
Number: "number",
|
|
32
|
-
Toggle: "toggle",
|
|
33
|
-
UserSingle: "user_single",
|
|
34
|
-
UserMulti: "user_multi",
|
|
35
|
-
Date: "date",
|
|
36
|
-
};
|
|
37
24
|
})(UserSingleDefinition || (exports.UserSingleDefinition = UserSingleDefinition = {}));
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "4.2.
|
|
1
|
+
export declare const SDK_VERSION = "4.2.3";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/BaseClient.mjs
CHANGED
|
@@ -7,8 +7,8 @@ export function normalizeClientOptions(options) {
|
|
|
7
7
|
const headers = mergeHeaders({
|
|
8
8
|
"X-Fern-Language": "JavaScript",
|
|
9
9
|
"X-Fern-SDK-Name": "frameio",
|
|
10
|
-
"X-Fern-SDK-Version": "4.2.
|
|
11
|
-
"User-Agent": "frameio/4.2.
|
|
10
|
+
"X-Fern-SDK-Version": "4.2.3",
|
|
11
|
+
"User-Agent": "frameio/4.2.3",
|
|
12
12
|
"X-Fern-Runtime": core.RUNTIME.type,
|
|
13
13
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
|
14
14
|
"user-agent": (_a = options === null || options === void 0 ? void 0 : options.userAgent) !== null && _a !== void 0 ? _a : "frameio-ts",
|
package/dist/esm/Client.d.mts
CHANGED
|
@@ -28,47 +28,47 @@ export declare namespace FrameioClient {
|
|
|
28
28
|
}
|
|
29
29
|
export declare class FrameioClient {
|
|
30
30
|
protected readonly _options: NormalizedClientOptionsWithAuth<FrameioClient.Options>;
|
|
31
|
-
protected
|
|
32
|
-
protected _metadataFields: MetadataFieldsClient | undefined;
|
|
33
|
-
protected _projectPermissions: ProjectPermissionsClient | undefined;
|
|
34
|
-
protected _folders: FoldersClient | undefined;
|
|
35
|
-
protected _versionStacks: VersionStacksClient | undefined;
|
|
36
|
-
protected _accountPermissions: AccountPermissionsClient | undefined;
|
|
31
|
+
protected _search: SearchClient | undefined;
|
|
37
32
|
protected _comments: CommentsClient | undefined;
|
|
38
|
-
protected _accounts: AccountsClient | undefined;
|
|
39
|
-
protected _webhooks: WebhooksClient | undefined;
|
|
40
|
-
protected _workspacePermissions: WorkspacePermissionsClient | undefined;
|
|
41
|
-
protected _groups: GroupsClient | undefined;
|
|
42
33
|
protected _shares: SharesClient | undefined;
|
|
43
|
-
protected _metadata: MetadataClient | undefined;
|
|
44
|
-
protected _files: FilesClient | undefined;
|
|
45
34
|
protected _users: UsersClient | undefined;
|
|
46
|
-
protected
|
|
35
|
+
protected _collections: CollectionsClient | undefined;
|
|
36
|
+
protected _files: FilesClient | undefined;
|
|
37
|
+
protected _metadataFields: MetadataFieldsClient | undefined;
|
|
38
|
+
protected _customActions: CustomActionsClient | undefined;
|
|
39
|
+
protected _workspacePermissions: WorkspacePermissionsClient | undefined;
|
|
40
|
+
protected _versionStacks: VersionStacksClient | undefined;
|
|
47
41
|
protected _folderPermissions: FolderPermissionsClient | undefined;
|
|
42
|
+
protected _metadata: MetadataClient | undefined;
|
|
43
|
+
protected _groups: GroupsClient | undefined;
|
|
44
|
+
protected _projects: ProjectsClient | undefined;
|
|
48
45
|
protected _workspaces: WorkspacesClient | undefined;
|
|
49
|
-
protected
|
|
50
|
-
protected
|
|
46
|
+
protected _accounts: AccountsClient | undefined;
|
|
47
|
+
protected _webhooks: WebhooksClient | undefined;
|
|
48
|
+
protected _folders: FoldersClient | undefined;
|
|
49
|
+
protected _accountPermissions: AccountPermissionsClient | undefined;
|
|
50
|
+
protected _projectPermissions: ProjectPermissionsClient | undefined;
|
|
51
51
|
constructor(options: FrameioClient.Options);
|
|
52
|
-
get
|
|
53
|
-
get metadataFields(): MetadataFieldsClient;
|
|
54
|
-
get projectPermissions(): ProjectPermissionsClient;
|
|
55
|
-
get folders(): FoldersClient;
|
|
56
|
-
get versionStacks(): VersionStacksClient;
|
|
57
|
-
get accountPermissions(): AccountPermissionsClient;
|
|
52
|
+
get search(): SearchClient;
|
|
58
53
|
get comments(): CommentsClient;
|
|
59
|
-
get accounts(): AccountsClient;
|
|
60
|
-
get webhooks(): WebhooksClient;
|
|
61
|
-
get workspacePermissions(): WorkspacePermissionsClient;
|
|
62
|
-
get groups(): GroupsClient;
|
|
63
54
|
get shares(): SharesClient;
|
|
64
|
-
get metadata(): MetadataClient;
|
|
65
|
-
get files(): FilesClient;
|
|
66
55
|
get users(): UsersClient;
|
|
67
|
-
get
|
|
56
|
+
get collections(): CollectionsClient;
|
|
57
|
+
get files(): FilesClient;
|
|
58
|
+
get metadataFields(): MetadataFieldsClient;
|
|
59
|
+
get customActions(): CustomActionsClient;
|
|
60
|
+
get workspacePermissions(): WorkspacePermissionsClient;
|
|
61
|
+
get versionStacks(): VersionStacksClient;
|
|
68
62
|
get folderPermissions(): FolderPermissionsClient;
|
|
63
|
+
get metadata(): MetadataClient;
|
|
64
|
+
get groups(): GroupsClient;
|
|
65
|
+
get projects(): ProjectsClient;
|
|
69
66
|
get workspaces(): WorkspacesClient;
|
|
70
|
-
get
|
|
71
|
-
get
|
|
67
|
+
get accounts(): AccountsClient;
|
|
68
|
+
get webhooks(): WebhooksClient;
|
|
69
|
+
get folders(): FoldersClient;
|
|
70
|
+
get accountPermissions(): AccountPermissionsClient;
|
|
71
|
+
get projectPermissions(): ProjectPermissionsClient;
|
|
72
72
|
/**
|
|
73
73
|
* Make a passthrough request using the SDK's configured auth, retry, logging, etc.
|
|
74
74
|
* This is useful for making requests to endpoints not yet supported in the SDK.
|
package/dist/esm/Client.mjs
CHANGED
|
@@ -34,85 +34,85 @@ export class FrameioClient {
|
|
|
34
34
|
constructor(options) {
|
|
35
35
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
36
36
|
}
|
|
37
|
-
get
|
|
38
|
-
var _a;
|
|
39
|
-
return ((_a = this._customActions) !== null && _a !== void 0 ? _a : (this._customActions = new CustomActionsClient(this._options)));
|
|
40
|
-
}
|
|
41
|
-
get metadataFields() {
|
|
37
|
+
get search() {
|
|
42
38
|
var _a;
|
|
43
|
-
return ((_a = this.
|
|
39
|
+
return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new SearchClient(this._options)));
|
|
44
40
|
}
|
|
45
|
-
get
|
|
41
|
+
get comments() {
|
|
46
42
|
var _a;
|
|
47
|
-
return ((_a = this.
|
|
43
|
+
return ((_a = this._comments) !== null && _a !== void 0 ? _a : (this._comments = new CommentsClient(this._options)));
|
|
48
44
|
}
|
|
49
|
-
get
|
|
45
|
+
get shares() {
|
|
50
46
|
var _a;
|
|
51
|
-
return ((_a = this.
|
|
47
|
+
return ((_a = this._shares) !== null && _a !== void 0 ? _a : (this._shares = new SharesClient(this._options)));
|
|
52
48
|
}
|
|
53
|
-
get
|
|
49
|
+
get users() {
|
|
54
50
|
var _a;
|
|
55
|
-
return ((_a = this.
|
|
51
|
+
return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new UsersClient(this._options)));
|
|
56
52
|
}
|
|
57
|
-
get
|
|
53
|
+
get collections() {
|
|
58
54
|
var _a;
|
|
59
|
-
return ((_a = this.
|
|
55
|
+
return ((_a = this._collections) !== null && _a !== void 0 ? _a : (this._collections = new CollectionsClient(this._options)));
|
|
60
56
|
}
|
|
61
|
-
get
|
|
57
|
+
get files() {
|
|
62
58
|
var _a;
|
|
63
|
-
return ((_a = this.
|
|
59
|
+
return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new FilesClient(this._options)));
|
|
64
60
|
}
|
|
65
|
-
get
|
|
61
|
+
get metadataFields() {
|
|
66
62
|
var _a;
|
|
67
|
-
return ((_a = this.
|
|
63
|
+
return ((_a = this._metadataFields) !== null && _a !== void 0 ? _a : (this._metadataFields = new MetadataFieldsClient(this._options)));
|
|
68
64
|
}
|
|
69
|
-
get
|
|
65
|
+
get customActions() {
|
|
70
66
|
var _a;
|
|
71
|
-
return ((_a = this.
|
|
67
|
+
return ((_a = this._customActions) !== null && _a !== void 0 ? _a : (this._customActions = new CustomActionsClient(this._options)));
|
|
72
68
|
}
|
|
73
69
|
get workspacePermissions() {
|
|
74
70
|
var _a;
|
|
75
71
|
return ((_a = this._workspacePermissions) !== null && _a !== void 0 ? _a : (this._workspacePermissions = new WorkspacePermissionsClient(this._options)));
|
|
76
72
|
}
|
|
77
|
-
get
|
|
73
|
+
get versionStacks() {
|
|
78
74
|
var _a;
|
|
79
|
-
return ((_a = this.
|
|
75
|
+
return ((_a = this._versionStacks) !== null && _a !== void 0 ? _a : (this._versionStacks = new VersionStacksClient(this._options)));
|
|
80
76
|
}
|
|
81
|
-
get
|
|
77
|
+
get folderPermissions() {
|
|
82
78
|
var _a;
|
|
83
|
-
return ((_a = this.
|
|
79
|
+
return ((_a = this._folderPermissions) !== null && _a !== void 0 ? _a : (this._folderPermissions = new FolderPermissionsClient(this._options)));
|
|
84
80
|
}
|
|
85
81
|
get metadata() {
|
|
86
82
|
var _a;
|
|
87
83
|
return ((_a = this._metadata) !== null && _a !== void 0 ? _a : (this._metadata = new MetadataClient(this._options)));
|
|
88
84
|
}
|
|
89
|
-
get
|
|
90
|
-
var _a;
|
|
91
|
-
return ((_a = this._files) !== null && _a !== void 0 ? _a : (this._files = new FilesClient(this._options)));
|
|
92
|
-
}
|
|
93
|
-
get users() {
|
|
85
|
+
get groups() {
|
|
94
86
|
var _a;
|
|
95
|
-
return ((_a = this.
|
|
87
|
+
return ((_a = this._groups) !== null && _a !== void 0 ? _a : (this._groups = new GroupsClient(this._options)));
|
|
96
88
|
}
|
|
97
89
|
get projects() {
|
|
98
90
|
var _a;
|
|
99
91
|
return ((_a = this._projects) !== null && _a !== void 0 ? _a : (this._projects = new ProjectsClient(this._options)));
|
|
100
92
|
}
|
|
101
|
-
get folderPermissions() {
|
|
102
|
-
var _a;
|
|
103
|
-
return ((_a = this._folderPermissions) !== null && _a !== void 0 ? _a : (this._folderPermissions = new FolderPermissionsClient(this._options)));
|
|
104
|
-
}
|
|
105
93
|
get workspaces() {
|
|
106
94
|
var _a;
|
|
107
95
|
return ((_a = this._workspaces) !== null && _a !== void 0 ? _a : (this._workspaces = new WorkspacesClient(this._options)));
|
|
108
96
|
}
|
|
109
|
-
get
|
|
97
|
+
get accounts() {
|
|
110
98
|
var _a;
|
|
111
|
-
return ((_a = this.
|
|
99
|
+
return ((_a = this._accounts) !== null && _a !== void 0 ? _a : (this._accounts = new AccountsClient(this._options)));
|
|
112
100
|
}
|
|
113
|
-
get
|
|
101
|
+
get webhooks() {
|
|
114
102
|
var _a;
|
|
115
|
-
return ((_a = this.
|
|
103
|
+
return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new WebhooksClient(this._options)));
|
|
104
|
+
}
|
|
105
|
+
get folders() {
|
|
106
|
+
var _a;
|
|
107
|
+
return ((_a = this._folders) !== null && _a !== void 0 ? _a : (this._folders = new FoldersClient(this._options)));
|
|
108
|
+
}
|
|
109
|
+
get accountPermissions() {
|
|
110
|
+
var _a;
|
|
111
|
+
return ((_a = this._accountPermissions) !== null && _a !== void 0 ? _a : (this._accountPermissions = new AccountPermissionsClient(this._options)));
|
|
112
|
+
}
|
|
113
|
+
get projectPermissions() {
|
|
114
|
+
var _a;
|
|
115
|
+
return ((_a = this._projectPermissions) !== null && _a !== void 0 ? _a : (this._projectPermissions = new ProjectPermissionsClient(this._options)));
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
118
|
* Make a passthrough request using the SDK's configured auth, retry, logging, etc.
|
|
@@ -14,11 +14,11 @@ export declare class CollectionsClient {
|
|
|
14
14
|
protected readonly _options: NormalizedClientOptionsWithAuth<CollectionsClient.Options>;
|
|
15
15
|
constructor(options: CollectionsClient.Options);
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* List collections for a project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
18
18
|
*
|
|
19
19
|
* @param {Frameio.Uuid} account_id
|
|
20
|
-
* @param {Frameio.Uuid}
|
|
21
|
-
* @param {Frameio.
|
|
20
|
+
* @param {Frameio.Uuid} project_id
|
|
21
|
+
* @param {Frameio.CollectionsIndexRequest} request
|
|
22
22
|
* @param {CollectionsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
23
23
|
*
|
|
24
24
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -30,18 +30,21 @@ export declare class CollectionsClient {
|
|
|
30
30
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
31
31
|
*
|
|
32
32
|
* @example
|
|
33
|
-
* await client.collections.
|
|
34
|
-
* include: "creator,project"
|
|
33
|
+
* await client.collections.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
34
|
+
* include: "creator,project",
|
|
35
|
+
* after: "<opaque_cursor>",
|
|
36
|
+
* page_size: 10,
|
|
37
|
+
* include_total_count: false
|
|
35
38
|
* })
|
|
36
39
|
*/
|
|
37
|
-
|
|
38
|
-
private
|
|
40
|
+
index(account_id: Frameio.Uuid, project_id: Frameio.Uuid, request?: Frameio.CollectionsIndexRequest, requestOptions?: CollectionsClient.RequestOptions): core.HttpResponsePromise<Frameio.CollectionsResponse>;
|
|
41
|
+
private __index;
|
|
39
42
|
/**
|
|
40
|
-
*
|
|
43
|
+
* Show collection details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
41
44
|
*
|
|
42
45
|
* @param {Frameio.Uuid} account_id
|
|
43
|
-
* @param {Frameio.Uuid}
|
|
44
|
-
* @param {Frameio.
|
|
46
|
+
* @param {Frameio.Uuid} collection_id
|
|
47
|
+
* @param {Frameio.CollectionsShowRequest} request
|
|
45
48
|
* @param {CollectionsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
46
49
|
*
|
|
47
50
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -53,13 +56,10 @@ export declare class CollectionsClient {
|
|
|
53
56
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
54
57
|
*
|
|
55
58
|
* @example
|
|
56
|
-
* await client.collections.
|
|
57
|
-
* include: "creator,project"
|
|
58
|
-
* after: "<opaque_cursor>",
|
|
59
|
-
* page_size: 10,
|
|
60
|
-
* include_total_count: false
|
|
59
|
+
* await client.collections.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
60
|
+
* include: "creator,project"
|
|
61
61
|
* })
|
|
62
62
|
*/
|
|
63
|
-
|
|
64
|
-
private
|
|
63
|
+
show(account_id: Frameio.Uuid, collection_id: Frameio.Uuid, request?: Frameio.CollectionsShowRequest, requestOptions?: CollectionsClient.RequestOptions): core.HttpResponsePromise<Frameio.CollectionResponse>;
|
|
64
|
+
private __show;
|
|
65
65
|
}
|
|
@@ -23,11 +23,11 @@ export class CollectionsClient {
|
|
|
23
23
|
this._options = normalizeClientOptionsWithAuth(options);
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* List collections for a project. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
27
27
|
*
|
|
28
28
|
* @param {Frameio.Uuid} account_id
|
|
29
|
-
* @param {Frameio.Uuid}
|
|
30
|
-
* @param {Frameio.
|
|
29
|
+
* @param {Frameio.Uuid} project_id
|
|
30
|
+
* @param {Frameio.CollectionsIndexRequest} request
|
|
31
31
|
* @param {CollectionsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
32
32
|
*
|
|
33
33
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -39,24 +39,30 @@ export class CollectionsClient {
|
|
|
39
39
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
40
40
|
*
|
|
41
41
|
* @example
|
|
42
|
-
* await client.collections.
|
|
43
|
-
* include: "creator,project"
|
|
42
|
+
* await client.collections.index("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
43
|
+
* include: "creator,project",
|
|
44
|
+
* after: "<opaque_cursor>",
|
|
45
|
+
* page_size: 10,
|
|
46
|
+
* include_total_count: false
|
|
44
47
|
* })
|
|
45
48
|
*/
|
|
46
|
-
|
|
47
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
49
|
+
index(account_id, project_id, request = {}, requestOptions) {
|
|
50
|
+
return core.HttpResponsePromise.fromPromise(this.__index(account_id, project_id, request, requestOptions));
|
|
48
51
|
}
|
|
49
|
-
|
|
50
|
-
return __awaiter(this, arguments, void 0, function* (account_id,
|
|
52
|
+
__index(account_id_1, project_id_1) {
|
|
53
|
+
return __awaiter(this, arguments, void 0, function* (account_id, project_id, request = {}, requestOptions) {
|
|
51
54
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
52
|
-
const { include } = request;
|
|
55
|
+
const { include, after, page_size: pageSize, include_total_count: includeTotalCount } = request;
|
|
53
56
|
const _queryParams = {
|
|
54
57
|
include,
|
|
58
|
+
after,
|
|
59
|
+
page_size: pageSize,
|
|
60
|
+
include_total_count: includeTotalCount,
|
|
55
61
|
};
|
|
56
62
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
57
63
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
58
64
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
59
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/
|
|
65
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/projects/${core.url.encodePathParam(project_id)}/collections`),
|
|
60
66
|
method: "GET",
|
|
61
67
|
headers: _headers,
|
|
62
68
|
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
@@ -93,15 +99,15 @@ export class CollectionsClient {
|
|
|
93
99
|
});
|
|
94
100
|
}
|
|
95
101
|
}
|
|
96
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/
|
|
102
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/projects/{project_id}/collections");
|
|
97
103
|
});
|
|
98
104
|
}
|
|
99
105
|
/**
|
|
100
|
-
*
|
|
106
|
+
* Show collection details. <br/>Rate Limits: 100 calls per 1.00 minute(s) per account_user
|
|
101
107
|
*
|
|
102
108
|
* @param {Frameio.Uuid} account_id
|
|
103
|
-
* @param {Frameio.Uuid}
|
|
104
|
-
* @param {Frameio.
|
|
109
|
+
* @param {Frameio.Uuid} collection_id
|
|
110
|
+
* @param {Frameio.CollectionsShowRequest} request
|
|
105
111
|
* @param {CollectionsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
106
112
|
*
|
|
107
113
|
* @throws {@link Frameio.BadRequestError}
|
|
@@ -113,30 +119,24 @@ export class CollectionsClient {
|
|
|
113
119
|
* @throws {@link Frameio.TooManyRequestsError}
|
|
114
120
|
*
|
|
115
121
|
* @example
|
|
116
|
-
* await client.collections.
|
|
117
|
-
* include: "creator,project"
|
|
118
|
-
* after: "<opaque_cursor>",
|
|
119
|
-
* page_size: 10,
|
|
120
|
-
* include_total_count: false
|
|
122
|
+
* await client.collections.show("b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", "b2702c44-c6da-4bb6-8bbd-be6e547ccf1b", {
|
|
123
|
+
* include: "creator,project"
|
|
121
124
|
* })
|
|
122
125
|
*/
|
|
123
|
-
|
|
124
|
-
return core.HttpResponsePromise.fromPromise(this.
|
|
126
|
+
show(account_id, collection_id, request = {}, requestOptions) {
|
|
127
|
+
return core.HttpResponsePromise.fromPromise(this.__show(account_id, collection_id, request, requestOptions));
|
|
125
128
|
}
|
|
126
|
-
|
|
127
|
-
return __awaiter(this, arguments, void 0, function* (account_id,
|
|
129
|
+
__show(account_id_1, collection_id_1) {
|
|
130
|
+
return __awaiter(this, arguments, void 0, function* (account_id, collection_id, request = {}, requestOptions) {
|
|
128
131
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
|
|
129
|
-
const { include
|
|
132
|
+
const { include } = request;
|
|
130
133
|
const _queryParams = {
|
|
131
134
|
include,
|
|
132
|
-
after,
|
|
133
|
-
page_size: pageSize,
|
|
134
|
-
include_total_count: includeTotalCount,
|
|
135
135
|
};
|
|
136
136
|
const _authRequest = yield this._options.authProvider.getAuthRequest();
|
|
137
137
|
const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders({ "user-agent": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.userAgent) !== null && _b !== void 0 ? _b : "frameio-ts" }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
|
|
138
138
|
const _response = yield ((_c = this._options.fetcher) !== null && _c !== void 0 ? _c : core.fetcher)({
|
|
139
|
-
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/
|
|
139
|
+
url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.FrameioEnvironment.Default, `v4/accounts/${core.url.encodePathParam(account_id)}/collections/${core.url.encodePathParam(collection_id)}`),
|
|
140
140
|
method: "GET",
|
|
141
141
|
headers: _headers,
|
|
142
142
|
queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
|
|
@@ -173,7 +173,7 @@ export class CollectionsClient {
|
|
|
173
173
|
});
|
|
174
174
|
}
|
|
175
175
|
}
|
|
176
|
-
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/
|
|
176
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/v4/accounts/{account_id}/collections/{collection_id}");
|
|
177
177
|
});
|
|
178
178
|
}
|
|
179
179
|
}
|