@fusebase/fusebase-gate-sdk 2.2.2-sdk.2 → 2.2.2-sdk.4
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/apis/NotesApi.d.ts +73 -0
- package/dist/apis/NotesApi.js +88 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +3 -1
- package/dist/types/index.d.ts +1 -0
- package/dist/types/index.js +1 -0
- package/dist/types/note/note.d.ts +59 -0
- package/dist/types/note/note.js +7 -0
- package/package.json +1 -1
- package/release-notes/2.2.2-sdk.4.md +9 -0
- package/release-notes/latest.md +3 -3
- package/release-notes/2.2.2-sdk.2.md +0 -9
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Notes API
|
|
3
|
+
*
|
|
4
|
+
* Generated from contract introspection
|
|
5
|
+
* Domain: notes
|
|
6
|
+
*/
|
|
7
|
+
import type { Client } from "../runtime/transport";
|
|
8
|
+
import type { CreateWorkspaceNoteFolderRequestContract, CreateWorkspaceNoteFolderResponseContract, CreateWorkspaceNoteRequestContract, CreateWorkspaceNoteResponseContract, orgIdInPathRequired, WorkspaceIdInPathRequired, WorkspaceNoteContentResponseContract, WorkspaceNoteFolderListResponseContract, WorkspaceNoteIdInPathRequired, WorkspaceNoteListResponseContract, WorkspaceNoteParentIdInQueryOptional } from "../types";
|
|
9
|
+
export declare class NotesApi {
|
|
10
|
+
private client;
|
|
11
|
+
constructor(client: Client);
|
|
12
|
+
/**
|
|
13
|
+
* Create workspace note
|
|
14
|
+
* Creates a note in the requested workspace. When parentId is omitted, gate uses `default`. Optional initial text or html can be appended after creation.
|
|
15
|
+
*/
|
|
16
|
+
createWorkspaceNote(params: {
|
|
17
|
+
path: {
|
|
18
|
+
orgId: orgIdInPathRequired;
|
|
19
|
+
workspaceId: WorkspaceIdInPathRequired;
|
|
20
|
+
};
|
|
21
|
+
headers?: Record<string, string>;
|
|
22
|
+
body: CreateWorkspaceNoteRequestContract;
|
|
23
|
+
}): Promise<CreateWorkspaceNoteResponseContract>;
|
|
24
|
+
/**
|
|
25
|
+
* Create workspace note folder
|
|
26
|
+
* Creates a folder in the requested workspace. When parentId is omitted, gate uses `root`.
|
|
27
|
+
*/
|
|
28
|
+
createWorkspaceNoteFolder(params: {
|
|
29
|
+
path: {
|
|
30
|
+
orgId: orgIdInPathRequired;
|
|
31
|
+
workspaceId: WorkspaceIdInPathRequired;
|
|
32
|
+
};
|
|
33
|
+
headers?: Record<string, string>;
|
|
34
|
+
body: CreateWorkspaceNoteFolderRequestContract;
|
|
35
|
+
}): Promise<CreateWorkspaceNoteFolderResponseContract>;
|
|
36
|
+
/**
|
|
37
|
+
* Read workspace note
|
|
38
|
+
* Returns the note title, parent metadata, and rendered html content for the requested workspace note.
|
|
39
|
+
*/
|
|
40
|
+
getWorkspaceNote(params: {
|
|
41
|
+
path: {
|
|
42
|
+
orgId: orgIdInPathRequired;
|
|
43
|
+
workspaceId: WorkspaceIdInPathRequired;
|
|
44
|
+
noteId: WorkspaceNoteIdInPathRequired;
|
|
45
|
+
};
|
|
46
|
+
headers?: Record<string, string>;
|
|
47
|
+
}): Promise<WorkspaceNoteContentResponseContract>;
|
|
48
|
+
/**
|
|
49
|
+
* List workspace note folders
|
|
50
|
+
* Returns non-portal note folders for the requested workspace.
|
|
51
|
+
*/
|
|
52
|
+
listWorkspaceNoteFolders(params: {
|
|
53
|
+
path: {
|
|
54
|
+
orgId: orgIdInPathRequired;
|
|
55
|
+
workspaceId: WorkspaceIdInPathRequired;
|
|
56
|
+
};
|
|
57
|
+
headers?: Record<string, string>;
|
|
58
|
+
}): Promise<WorkspaceNoteFolderListResponseContract>;
|
|
59
|
+
/**
|
|
60
|
+
* List workspace notes
|
|
61
|
+
* Returns non-portal notes for the requested workspace and parent folder. When parentId is omitted, gate defaults to the workspace root folder id `root`.
|
|
62
|
+
*/
|
|
63
|
+
listWorkspaceNotes(params: {
|
|
64
|
+
path: {
|
|
65
|
+
orgId: orgIdInPathRequired;
|
|
66
|
+
workspaceId: WorkspaceIdInPathRequired;
|
|
67
|
+
};
|
|
68
|
+
query?: {
|
|
69
|
+
parentId?: WorkspaceNoteParentIdInQueryOptional;
|
|
70
|
+
};
|
|
71
|
+
headers?: Record<string, string>;
|
|
72
|
+
}): Promise<WorkspaceNoteListResponseContract>;
|
|
73
|
+
}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Notes API
|
|
4
|
+
*
|
|
5
|
+
* Generated from contract introspection
|
|
6
|
+
* Domain: notes
|
|
7
|
+
*/
|
|
8
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.NotesApi = void 0;
|
|
10
|
+
class NotesApi {
|
|
11
|
+
constructor(client) {
|
|
12
|
+
this.client = client;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Create workspace note
|
|
16
|
+
* Creates a note in the requested workspace. When parentId is omitted, gate uses `default`. Optional initial text or html can be appended after creation.
|
|
17
|
+
*/
|
|
18
|
+
async createWorkspaceNote(params) {
|
|
19
|
+
return this.client.request({
|
|
20
|
+
method: "POST",
|
|
21
|
+
path: "/:orgId/workspaces/:workspaceId/notes",
|
|
22
|
+
pathParams: params.path,
|
|
23
|
+
headers: params.headers,
|
|
24
|
+
body: params.body,
|
|
25
|
+
opId: "createWorkspaceNote",
|
|
26
|
+
expectedContentType: "application/json",
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Create workspace note folder
|
|
31
|
+
* Creates a folder in the requested workspace. When parentId is omitted, gate uses `root`.
|
|
32
|
+
*/
|
|
33
|
+
async createWorkspaceNoteFolder(params) {
|
|
34
|
+
return this.client.request({
|
|
35
|
+
method: "POST",
|
|
36
|
+
path: "/:orgId/workspaces/:workspaceId/notes/folders",
|
|
37
|
+
pathParams: params.path,
|
|
38
|
+
headers: params.headers,
|
|
39
|
+
body: params.body,
|
|
40
|
+
opId: "createWorkspaceNoteFolder",
|
|
41
|
+
expectedContentType: "application/json",
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Read workspace note
|
|
46
|
+
* Returns the note title, parent metadata, and rendered html content for the requested workspace note.
|
|
47
|
+
*/
|
|
48
|
+
async getWorkspaceNote(params) {
|
|
49
|
+
return this.client.request({
|
|
50
|
+
method: "GET",
|
|
51
|
+
path: "/:orgId/workspaces/:workspaceId/notes/:noteId",
|
|
52
|
+
pathParams: params.path,
|
|
53
|
+
headers: params.headers,
|
|
54
|
+
opId: "getWorkspaceNote",
|
|
55
|
+
expectedContentType: "application/json",
|
|
56
|
+
});
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* List workspace note folders
|
|
60
|
+
* Returns non-portal note folders for the requested workspace.
|
|
61
|
+
*/
|
|
62
|
+
async listWorkspaceNoteFolders(params) {
|
|
63
|
+
return this.client.request({
|
|
64
|
+
method: "GET",
|
|
65
|
+
path: "/:orgId/workspaces/:workspaceId/notes/folders",
|
|
66
|
+
pathParams: params.path,
|
|
67
|
+
headers: params.headers,
|
|
68
|
+
opId: "listWorkspaceNoteFolders",
|
|
69
|
+
expectedContentType: "application/json",
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* List workspace notes
|
|
74
|
+
* Returns non-portal notes for the requested workspace and parent folder. When parentId is omitted, gate defaults to the workspace root folder id `root`.
|
|
75
|
+
*/
|
|
76
|
+
async listWorkspaceNotes(params) {
|
|
77
|
+
return this.client.request({
|
|
78
|
+
method: "GET",
|
|
79
|
+
path: "/:orgId/workspaces/:workspaceId/notes",
|
|
80
|
+
pathParams: params.path,
|
|
81
|
+
query: params.query,
|
|
82
|
+
headers: params.headers,
|
|
83
|
+
opId: "listWorkspaceNotes",
|
|
84
|
+
expectedContentType: "application/json",
|
|
85
|
+
});
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
exports.NotesApi = NotesApi;
|
package/dist/index.d.ts
CHANGED
|
@@ -8,6 +8,7 @@ export * from "./types";
|
|
|
8
8
|
export { AccessApi } from "./apis/AccessApi";
|
|
9
9
|
export { EmailsApi } from "./apis/EmailsApi";
|
|
10
10
|
export { HealthApi } from "./apis/HealthApi";
|
|
11
|
+
export { NotesApi } from "./apis/NotesApi";
|
|
11
12
|
export { OrgUsersApi } from "./apis/OrgUsersApi";
|
|
12
13
|
export { PortalsApi } from "./apis/PortalsApi";
|
|
13
14
|
export { SystemApi } from "./apis/SystemApi";
|
package/dist/index.js
CHANGED
|
@@ -19,7 +19,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
19
19
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
20
20
|
};
|
|
21
21
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
22
|
-
exports.WorkspacesApi = exports.TokensApi = exports.SystemApi = exports.PortalsApi = exports.OrgUsersApi = exports.HealthApi = exports.EmailsApi = exports.AccessApi = void 0;
|
|
22
|
+
exports.WorkspacesApi = exports.TokensApi = exports.SystemApi = exports.PortalsApi = exports.OrgUsersApi = exports.NotesApi = exports.HealthApi = exports.EmailsApi = exports.AccessApi = void 0;
|
|
23
23
|
__exportStar(require("./runtime"), exports);
|
|
24
24
|
__exportStar(require("./types"), exports);
|
|
25
25
|
var AccessApi_1 = require("./apis/AccessApi");
|
|
@@ -28,6 +28,8 @@ var EmailsApi_1 = require("./apis/EmailsApi");
|
|
|
28
28
|
Object.defineProperty(exports, "EmailsApi", { enumerable: true, get: function () { return EmailsApi_1.EmailsApi; } });
|
|
29
29
|
var HealthApi_1 = require("./apis/HealthApi");
|
|
30
30
|
Object.defineProperty(exports, "HealthApi", { enumerable: true, get: function () { return HealthApi_1.HealthApi; } });
|
|
31
|
+
var NotesApi_1 = require("./apis/NotesApi");
|
|
32
|
+
Object.defineProperty(exports, "NotesApi", { enumerable: true, get: function () { return NotesApi_1.NotesApi; } });
|
|
31
33
|
var OrgUsersApi_1 = require("./apis/OrgUsersApi");
|
|
32
34
|
Object.defineProperty(exports, "OrgUsersApi", { enumerable: true, get: function () { return OrgUsersApi_1.OrgUsersApi; } });
|
|
33
35
|
var PortalsApi_1 = require("./apis/PortalsApi");
|
package/dist/types/index.d.ts
CHANGED
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
*/
|
|
7
7
|
export type { AuthenticatedUserSummaryContract, MyOrgAccessResponseContract } from "./access/access";
|
|
8
8
|
export type { OrgEmailSendRequestContract, OrgEmailSendResponseContract } from "./email/email";
|
|
9
|
+
export * from "./note/note";
|
|
9
10
|
export type { OrgInviteContract, OrgMagicLinkContract, OrgPortalContract, OrgPortalListResponseContract, OrgUserAddRequestContract, OrgUserAddResponseContract, OrgUserContract, OrgUserListResponseContract, OrgWorkspaceContract, OrgWorkspaceInviteContract, OrgWorkspaceListResponseContract, OrgWorkspaceMemberContract } from "./org-user/org-user";
|
|
10
11
|
export * from "./shared/common";
|
|
11
12
|
export * from "./shared/enums";
|
package/dist/types/index.js
CHANGED
|
@@ -20,6 +20,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
20
20
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
21
21
|
};
|
|
22
22
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
23
|
+
__exportStar(require("./note/note"), exports);
|
|
23
24
|
__exportStar(require("./shared/common"), exports);
|
|
24
25
|
__exportStar(require("./shared/enums"), exports);
|
|
25
26
|
__exportStar(require("./system/system"), exports);
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
export type WorkspaceIdInPathRequired = string;
|
|
2
|
+
export type WorkspaceNoteIdInPathRequired = string;
|
|
3
|
+
export interface WorkspaceNoteSummaryContract {
|
|
4
|
+
globalId: string;
|
|
5
|
+
title?: string | null;
|
|
6
|
+
parentId?: string | null;
|
|
7
|
+
}
|
|
8
|
+
export interface WorkspaceNoteContentContract extends WorkspaceNoteSummaryContract {
|
|
9
|
+
html: string;
|
|
10
|
+
}
|
|
11
|
+
export interface WorkspaceNoteFolderListResponseContract {
|
|
12
|
+
folders: WorkspaceNoteSummaryContract[];
|
|
13
|
+
}
|
|
14
|
+
export interface WorkspaceNoteListResponseContract {
|
|
15
|
+
notes: WorkspaceNoteSummaryContract[];
|
|
16
|
+
}
|
|
17
|
+
export interface WorkspaceNoteContentResponseContract {
|
|
18
|
+
note: WorkspaceNoteContentContract;
|
|
19
|
+
}
|
|
20
|
+
export type WorkspaceNoteParentIdInQueryOptional = string | null;
|
|
21
|
+
export type WorkspaceNoteContentFormatContract = "text" | "html";
|
|
22
|
+
export interface WorkspaceNoteListQueryContract {
|
|
23
|
+
/**
|
|
24
|
+
* Folder global id to list notes from. When omitted, gate defaults to `root`.
|
|
25
|
+
*/
|
|
26
|
+
parentId?: WorkspaceNoteParentIdInQueryOptional;
|
|
27
|
+
}
|
|
28
|
+
export interface CreateWorkspaceNoteFolderRequestContract {
|
|
29
|
+
title: string;
|
|
30
|
+
/**
|
|
31
|
+
* Parent folder global id. Defaults to `root`.
|
|
32
|
+
*/
|
|
33
|
+
parentId?: string | null;
|
|
34
|
+
}
|
|
35
|
+
export interface CreateWorkspaceNoteFolderResponseContract {
|
|
36
|
+
folder: WorkspaceNoteSummaryContract;
|
|
37
|
+
}
|
|
38
|
+
export interface CreateWorkspaceNoteRequestContract {
|
|
39
|
+
title: string;
|
|
40
|
+
/**
|
|
41
|
+
* Parent folder global id. Defaults to `default`.
|
|
42
|
+
*/
|
|
43
|
+
parentId?: string | null;
|
|
44
|
+
/**
|
|
45
|
+
* Optional initial text or html appended to the note after creation.
|
|
46
|
+
*/
|
|
47
|
+
content?: string | null;
|
|
48
|
+
/**
|
|
49
|
+
* Content format used with `content`. Defaults to `text`.
|
|
50
|
+
*/
|
|
51
|
+
format?: WorkspaceNoteContentFormatContract | null;
|
|
52
|
+
}
|
|
53
|
+
export interface CreateWorkspaceNoteResponseContract {
|
|
54
|
+
note: WorkspaceNoteSummaryContract;
|
|
55
|
+
}
|
|
56
|
+
export declare const WorkspaceNoteContentFormatContract: {
|
|
57
|
+
readonly Text: "text";
|
|
58
|
+
readonly Html: "html";
|
|
59
|
+
};
|
package/package.json
CHANGED
package/release-notes/latest.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Release Notes 2.2.2-sdk.
|
|
1
|
+
# Release Notes 2.2.2-sdk.4
|
|
2
2
|
|
|
3
3
|
- Current ref: `HEAD`
|
|
4
|
-
- Previous tag: `v2.2.2-sdk.
|
|
5
|
-
- Generated at: 2026-03-
|
|
4
|
+
- Previous tag: `v2.2.2-sdk.4`
|
|
5
|
+
- Generated at: 2026-03-30T12:29:53.183Z
|
|
6
6
|
|
|
7
7
|
## Included Drafts
|
|
8
8
|
|