@macro-inc/sdk 0.4.1 → 0.6.0
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 +316 -21
- package/dist/{chunk-PTX2RV2N.js → chunk-4MI52GWV.js} +93 -1
- package/dist/{chunk-XFA7NCJ5.js → chunk-HO75UE4Z.js} +146 -15
- package/dist/{chunk-P4DTO6VD.js → chunk-MCSQNZ4E.js} +6 -0
- package/dist/{chunk-ZLBDES7U.js → chunk-SJ6S2GAT.js} +1271 -87
- package/dist/{chunk-AZJUIUIV.js → chunk-SK5CMXRV.js} +100 -14
- package/dist/{chunk-PZPTJI6F.js → chunk-TMTYN2UK.js} +229 -2
- package/dist/{chunk-PPR7IWZ7.js → chunk-ZYBAKW25.js} +2 -1
- package/dist/generated/agent-fold/index.d.ts +202 -14
- package/dist/generated/agent-harness/index.d.ts +1 -1
- package/dist/generated/agent-harness/index.js +1 -1
- package/dist/generated/agent-harness/sdk.gen.d.ts +49 -2
- package/dist/generated/agent-harness/types.gen.d.ts +527 -9
- package/dist/generated/agent-reviews/index.d.ts +11 -9
- package/dist/generated/auth/index.d.ts +1 -1
- package/dist/generated/auth/index.js +1 -1
- package/dist/generated/auth/sdk.gen.d.ts +82 -16
- package/dist/generated/auth/types.gen.d.ts +768 -18
- package/dist/generated/calendar/types.gen.d.ts +10 -3
- package/dist/generated/cognition/index.d.ts +1 -1
- package/dist/generated/cognition/index.js +1 -1
- package/dist/generated/cognition/sdk.gen.d.ts +60 -6
- package/dist/generated/cognition/types.gen.d.ts +663 -106
- package/dist/generated/connection/types.gen.d.ts +1 -1
- package/dist/generated/contacts/index.d.ts +1 -1
- package/dist/generated/contacts/index.js +1 -1
- package/dist/generated/contacts/sdk.gen.d.ts +5 -1
- package/dist/generated/contacts/types.gen.d.ts +56 -0
- package/dist/generated/email/types.gen.d.ts +8 -2
- package/dist/generated/notification/index.d.ts +1 -1
- package/dist/generated/notification/index.js +1 -1
- package/dist/generated/notification/sdk.gen.d.ts +2 -1
- package/dist/generated/notification/types.gen.d.ts +174 -1
- package/dist/generated/scheduled-action/index.d.ts +1 -1
- package/dist/generated/scheduled-action/index.js +1 -1
- package/dist/generated/scheduled-action/sdk.gen.d.ts +107 -2
- package/dist/generated/scheduled-action/types.gen.d.ts +2451 -479
- package/dist/generated/search/index.d.ts +1 -1
- package/dist/generated/search/types.gen.d.ts +50 -11
- package/dist/generated/storage/index.d.ts +1 -1
- package/dist/generated/storage/index.js +1 -1
- package/dist/generated/storage/sdk.gen.d.ts +511 -18
- package/dist/generated/storage/types.gen.d.ts +18528 -11395
- package/dist/src/entities/account-managers/grant.d.ts +28 -5
- package/dist/src/entities/account-managers/namespace.d.ts +15 -3
- package/dist/src/entities/activity/entity.d.ts +7 -0
- package/dist/src/entities/activity/namespace.d.ts +58 -0
- package/dist/src/entities/activity/namespace.test.d.ts +1 -0
- package/dist/src/entities/agent-sessions/activity.d.ts +12 -3
- package/dist/src/entities/agent-sessions/agent-session.d.ts +209 -22
- package/dist/src/entities/agent-sessions/code-execution.d.ts +15 -3
- package/dist/src/entities/agent-sessions/conversation.d.ts +46 -9
- package/dist/src/entities/agent-sessions/namespace.d.ts +72 -16
- package/dist/src/entities/agent-sessions/origin.d.ts +1 -1
- package/dist/src/entities/agent-sessions/queued-action.d.ts +17 -3
- package/dist/src/entities/agent-sessions/review.d.ts +56 -5
- package/dist/src/entities/agent-sessions/tool-approval.d.ts +5 -1
- package/dist/src/entities/agents/agent.d.ts +98 -3
- package/dist/src/entities/agents/namespace.d.ts +52 -8
- package/dist/src/entities/ai/namespace.d.ts +10 -2
- package/dist/src/entities/api-keys/api-key.d.ts +6 -1
- package/dist/src/entities/api-keys/namespace.d.ts +18 -3
- package/dist/src/entities/bots/bot.d.ts +44 -9
- package/dist/src/entities/bots/namespace.d.ts +13 -1
- package/dist/src/entities/bots/token.d.ts +6 -1
- package/dist/src/entities/calendar/booking-link.d.ts +7 -1
- package/dist/src/entities/calendar/booking-namespace.d.ts +14 -1
- package/dist/src/entities/calendar/booking.d.ts +15 -0
- package/dist/src/entities/calendar/calendar.d.ts +10 -3
- package/dist/src/entities/calendar/event.d.ts +68 -9
- package/dist/src/entities/calendar/namespace.d.ts +91 -12
- package/dist/src/entities/calendar/replacement.d.ts +19 -3
- package/dist/src/entities/calls/call-record.d.ts +107 -17
- package/dist/src/entities/calls/connection.d.ts +7 -1
- package/dist/src/entities/calls/message.d.ts +27 -5
- package/dist/src/entities/calls/namespace.d.ts +15 -3
- package/dist/src/entities/canvases/canvas.d.ts +329 -0
- package/dist/src/entities/channels/access-request.d.ts +10 -2
- package/dist/src/entities/channels/activity.d.ts +20 -4
- package/dist/src/entities/channels/channel.d.ts +154 -27
- package/dist/src/entities/channels/labels.d.ts +41 -7
- package/dist/src/entities/channels/message.d.ts +105 -8
- package/dist/src/entities/channels/message.test.d.ts +1 -0
- package/dist/src/entities/channels/namespace.d.ts +37 -7
- package/dist/src/entities/channels/post.d.ts +13 -7
- package/dist/src/entities/channels/post.test.d.ts +1 -0
- package/dist/src/entities/channels/share.d.ts +9 -0
- package/dist/src/entities/channels/share.test.d.ts +1 -0
- package/dist/src/entities/channels/thread.d.ts +24 -4
- package/dist/src/entities/chats/chat.d.ts +57 -7
- package/dist/src/entities/chats/generation.d.ts +11 -2
- package/dist/src/entities/chats/namespace.d.ts +10 -2
- package/dist/src/entities/connected-apps/connected-app.d.ts +16 -2
- package/dist/src/entities/connected-apps/connector.d.ts +3 -0
- package/dist/src/entities/connected-apps/namespace.d.ts +18 -0
- package/dist/src/entities/crm/company.d.ts +64 -16
- package/dist/src/entities/crm/contact.d.ts +102 -14
- package/dist/src/entities/crm/namespace.d.ts +113 -22
- package/dist/src/entities/crm/pipeline-entry.d.ts +109 -0
- package/dist/src/entities/crm/pipeline.d.ts +292 -29
- package/dist/src/entities/crm/pipelines.d.ts +69 -4
- package/dist/src/entities/crm-email-privacy/email-privacy.d.ts +238 -0
- package/dist/src/entities/crm-email-privacy/email-rule-preview.d.ts +55 -0
- package/dist/src/entities/crm-email-privacy/email-rule-revision.d.ts +27 -0
- package/dist/src/entities/crm-email-privacy/email-rules.d.ts +32 -0
- package/dist/src/entities/databases/column.d.ts +54 -7
- package/dist/src/entities/databases/database.d.ts +160 -18
- package/dist/src/entities/databases/namespace.d.ts +40 -8
- package/dist/src/entities/databases/row.d.ts +2 -0
- package/dist/src/entities/databases/saved-query.d.ts +151 -0
- package/dist/src/entities/databases/table.d.ts +73 -10
- package/dist/src/entities/databases/view.d.ts +37 -5
- package/dist/src/entities/databases/webhook.d.ts +8 -1
- package/dist/src/entities/documents/ai-edit.d.ts +2 -0
- package/dist/src/entities/documents/anchor.d.ts +12 -2
- package/dist/src/entities/documents/comment.d.ts +29 -5
- package/dist/src/entities/documents/create.test.d.ts +1 -0
- package/dist/src/entities/documents/document.d.ts +284 -26
- package/dist/src/entities/documents/markdown.d.ts +25 -0
- package/dist/src/entities/documents/namespace.d.ts +146 -13
- package/dist/src/entities/documents/skills.test.d.ts +1 -0
- package/dist/src/entities/documents/system-skill.d.ts +21 -1
- package/dist/src/entities/documents/text-comment.d.ts +41 -0
- package/dist/src/entities/documents/text-comment.test.d.ts +1 -0
- package/dist/src/entities/documents/version.d.ts +5 -1
- package/dist/src/entities/email/attachment.d.ts +3 -0
- package/dist/src/entities/email/draft.d.ts +61 -9
- package/dist/src/entities/email/filter.d.ts +12 -2
- package/dist/src/entities/email/label.d.ts +7 -1
- package/dist/src/entities/email/link.d.ts +5 -1
- package/dist/src/entities/email/message.d.ts +72 -14
- package/dist/src/entities/email/namespace.d.ts +134 -24
- package/dist/src/entities/email/thread.d.ts +124 -18
- package/dist/src/entities/entity-mentions/mention.d.ts +6 -1
- package/dist/src/entities/entity-mentions/namespace.d.ts +5 -1
- package/dist/src/entities/entity.d.ts +65 -6
- package/dist/src/entities/external-chat/chat.d.ts +80 -12
- package/dist/src/entities/external-chat/message.d.ts +1 -1
- package/dist/src/entities/external-chat/namespace.d.ts +5 -1
- package/dist/src/entities/external-chat/send.d.ts +10 -2
- package/dist/src/entities/favorites/namespace.d.ts +20 -3
- package/dist/src/entities/foreign/foreign-entity.d.ts +5 -1
- package/dist/src/entities/foreign/namespace.d.ts +5 -1
- package/dist/src/entities/forms/form.d.ts +91 -14
- package/dist/src/entities/forms/namespace.d.ts +10 -2
- package/dist/src/entities/forms/question.d.ts +35 -7
- package/dist/src/entities/forms/response.d.ts +25 -5
- package/dist/src/entities/forms/section.d.ts +15 -3
- package/dist/src/entities/github-pull-requests/namespace.d.ts +5 -1
- package/dist/src/entities/github-pull-requests/pull-request.d.ts +15 -3
- package/dist/src/entities/harnesses/harness.d.ts +51 -3
- package/dist/src/entities/harnesses/namespace.d.ts +54 -8
- package/dist/src/entities/harnesses/pairing.d.ts +13 -2
- package/dist/src/entities/images/image.d.ts +16 -5
- package/dist/src/entities/images/namespace.d.ts +8 -1
- package/dist/src/entities/imports/entry.d.ts +65 -0
- package/dist/src/entities/imports/namespace.d.ts +103 -0
- package/dist/src/entities/imports/namespace.test.d.ts +1 -0
- package/dist/src/entities/initiatives/initiative.d.ts +128 -4
- package/dist/src/entities/initiatives/initiative.test.d.ts +1 -0
- package/dist/src/entities/initiatives/namespace.d.ts +71 -7
- package/dist/src/entities/me/namespace.d.ts +28 -3
- package/dist/src/entities/meetings/meeting.d.ts +46 -8
- package/dist/src/entities/meetings/namespace.d.ts +20 -4
- package/dist/src/entities/memory/namespace.d.ts +49 -0
- package/dist/src/entities/memory/namespace.test.d.ts +1 -0
- package/dist/src/entities/messages/discussion.d.ts +84 -0
- package/dist/src/entities/messages/thread.d.ts +19 -5
- package/dist/src/entities/notifications/namespace.d.ts +41 -7
- package/dist/src/entities/notifications/notification.d.ts +31 -6
- package/dist/src/entities/passwords/item.d.ts +118 -0
- package/dist/src/entities/passwords/namespace.d.ts +45 -0
- package/dist/src/entities/pins/namespace.d.ts +23 -4
- package/dist/src/entities/projects/namespace.d.ts +29 -0
- package/dist/src/entities/projects/project.d.ts +58 -7
- package/dist/src/entities/properties/namespace.d.ts +67 -11
- package/dist/src/entities/properties/namespace.test.d.ts +1 -0
- package/dist/src/entities/properties/property-definition.d.ts +30 -5
- package/dist/src/entities/properties/property-option.d.ts +14 -2
- package/dist/src/entities/referrals/namespace.d.ts +8 -1
- package/dist/src/entities/routines/namespace.d.ts +198 -14
- package/dist/src/entities/routines/routine.d.ts +174 -27
- package/dist/src/entities/routines/suggestion.d.ts +38 -0
- package/dist/src/entities/saved-views/namespace.d.ts +58 -0
- package/dist/src/entities/saved-views/saved-view.d.ts +78 -0
- package/dist/src/entities/search/exclusions.d.ts +6 -0
- package/dist/src/entities/search/namespace.d.ts +9 -3
- package/dist/src/entities/search/options.d.ts +3 -2
- package/dist/src/entities/sharing/access.d.ts +50 -9
- package/dist/src/entities/spreadsheets/spreadsheet.d.ts +201 -0
- package/dist/src/entities/suggestions/namespace.d.ts +118 -0
- package/dist/src/entities/suggestions/suggestion.d.ts +172 -0
- package/dist/src/entities/suggestions/suggestion.test.d.ts +1 -0
- package/dist/src/entities/tasks/namespace.d.ts +18 -5
- package/dist/src/entities/tasks/task.d.ts +21 -3
- package/dist/src/entities/teams/invite.d.ts +3 -0
- package/dist/src/entities/teams/namespace.d.ts +10 -2
- package/dist/src/entities/teams/team.d.ts +22 -2
- package/dist/src/entities/ui/app-link.d.ts +24 -0
- package/dist/src/entities/ui/namespace.d.ts +75 -0
- package/dist/src/entities/unfurls/namespace.d.ts +12 -2
- package/dist/src/entities/users/namespace.d.ts +26 -4
- package/dist/src/entities/users/profile-picture.d.ts +29 -0
- package/dist/src/entities/users/profile-picture.test.d.ts +1 -0
- package/dist/src/entities/users/user.d.ts +52 -1
- package/dist/src/entities/web/namespace.d.ts +6 -0
- package/dist/src/entities/webhooks/namespace.d.ts +5 -0
- package/dist/src/entities/webhooks/webhook.d.ts +47 -7
- package/dist/src/entities/whatsapp/account.d.ts +5 -1
- package/dist/src/entities/whatsapp/chat.d.ts +9 -1
- package/dist/src/entities/whatsapp/namespace.d.ts +7 -1
- package/dist/src/entities/workspace/namespace.d.ts +12 -4
- package/dist/src/entities/workspace/query.d.ts +5 -1
- package/dist/src/entities/workspace/query.test.d.ts +1 -0
- package/dist/src/events/hydrate/document.d.ts +5 -0
- package/dist/src/events/hydrate/user.d.ts +14 -0
- package/dist/src/events/receiver.d.ts +2 -0
- package/dist/src/events/types.d.ts +2 -1
- package/dist/src/macro.d.ts +59 -6
- package/dist/src/macro.js +18710 -10355
- package/dist/src/utils/activity.d.ts +2 -0
- package/dist/src/utils/index.d.ts +1 -1
- package/dist/src/utils/lazy.d.ts +20 -1
- package/dist/src/utils/options.d.ts +7 -0
- package/dist/src/utils/pagination.d.ts +16 -0
- package/dist/src/utils/verbs.d.ts +3 -0
- package/package.json +1 -1
- package/dist/src/entities/crm/comment.d.ts +0 -64
|
@@ -2,6 +2,7 @@ import type { TableDetail, TableVersion } from '../../../generated/storage/types
|
|
|
2
2
|
import { DatabaseColumn } from './column';
|
|
3
3
|
import type { AddColumnOptions, Database } from './database';
|
|
4
4
|
import { DatabaseRow } from './row';
|
|
5
|
+
import type { SavedQuery, SaveQueryOptions } from './saved-query';
|
|
5
6
|
import { DatabaseView } from './view';
|
|
6
7
|
import type { DatabaseWebhook } from './webhook';
|
|
7
8
|
/**
|
|
@@ -22,40 +23,102 @@ export declare class DatabaseTable {
|
|
|
22
23
|
/**
|
|
23
24
|
* The table's record as the API returns it: the table, its columns, and
|
|
24
25
|
* its views.
|
|
26
|
+
*
|
|
27
|
+
* @readonly
|
|
25
28
|
*/
|
|
26
29
|
detail(): Promise<TableDetail>;
|
|
27
|
-
/**
|
|
30
|
+
/**
|
|
31
|
+
* The table's display name.
|
|
32
|
+
*
|
|
33
|
+
* @readonly
|
|
34
|
+
*/
|
|
28
35
|
name(): Promise<string>;
|
|
29
|
-
/**
|
|
36
|
+
/**
|
|
37
|
+
* Rename only if the last-read display name is still current.
|
|
38
|
+
*
|
|
39
|
+
* @write
|
|
40
|
+
* @idempotent
|
|
41
|
+
*/
|
|
30
42
|
rename(name: string): Promise<DatabaseTable>;
|
|
31
43
|
/**
|
|
32
44
|
* The table's current version, bumped by every committed change to its
|
|
33
45
|
* schema or rows. Schema edits such as {@link reorderColumns} send it as
|
|
34
46
|
* the base version they were made against, so a table that moved since
|
|
35
47
|
* refuses the edit with a 409.
|
|
48
|
+
*
|
|
49
|
+
* @readonly
|
|
36
50
|
*/
|
|
37
51
|
version(): Promise<TableVersion>;
|
|
38
|
-
/**
|
|
52
|
+
/**
|
|
53
|
+
* The table's fractional index within the database's tab order.
|
|
54
|
+
*
|
|
55
|
+
* @readonly
|
|
56
|
+
*/
|
|
39
57
|
position(): Promise<string>;
|
|
40
|
-
/**
|
|
58
|
+
/**
|
|
59
|
+
* The table's columns, in display order.
|
|
60
|
+
*
|
|
61
|
+
* @readonly
|
|
62
|
+
*/
|
|
41
63
|
columns(): Promise<DatabaseColumn[]>;
|
|
42
|
-
/**
|
|
64
|
+
/**
|
|
65
|
+
* Add a column to this table. See {@link Database.addColumn}.
|
|
66
|
+
*
|
|
67
|
+
* @write
|
|
68
|
+
*/
|
|
43
69
|
addColumn(options: AddColumnOptions): Promise<DatabaseColumn>;
|
|
44
|
-
/**
|
|
70
|
+
/**
|
|
71
|
+
* Persist a new column order. See {@link Database.reorderColumns}.
|
|
72
|
+
*
|
|
73
|
+
* @write
|
|
74
|
+
* @idempotent
|
|
75
|
+
*/
|
|
45
76
|
reorderColumns(columns: DatabaseColumn[]): Promise<DatabaseTable>;
|
|
46
|
-
/**
|
|
77
|
+
/**
|
|
78
|
+
* A handle to one of the table's rows, by the id an insert answered.
|
|
79
|
+
*
|
|
80
|
+
* @readonly
|
|
81
|
+
*/
|
|
47
82
|
row(id: string): DatabaseRow;
|
|
48
|
-
/**
|
|
83
|
+
/**
|
|
84
|
+
* The table's views, in their order.
|
|
85
|
+
*
|
|
86
|
+
* @readonly
|
|
87
|
+
*/
|
|
49
88
|
views(): Promise<DatabaseView[]>;
|
|
50
|
-
/**
|
|
89
|
+
/**
|
|
90
|
+
* Create a webhook that inserts rows here. See {@link Database.createWebhook}.
|
|
91
|
+
*
|
|
92
|
+
* @write
|
|
93
|
+
*/
|
|
51
94
|
createWebhook(): Promise<{
|
|
52
95
|
webhook: DatabaseWebhook;
|
|
53
96
|
token: string;
|
|
54
97
|
}>;
|
|
55
|
-
/**
|
|
98
|
+
/**
|
|
99
|
+
* Save a `SELECT` about this table as a live question. See {@link Database.saveQuery}.
|
|
100
|
+
*
|
|
101
|
+
* @write
|
|
102
|
+
*/
|
|
103
|
+
saveQuery(options: SaveQueryOptions): Promise<SavedQuery>;
|
|
104
|
+
/**
|
|
105
|
+
* Delete this table. See {@link Database.deleteTable}.
|
|
106
|
+
*
|
|
107
|
+
* @destructive
|
|
108
|
+
* @idempotent
|
|
109
|
+
*/
|
|
56
110
|
delete(): Promise<void>;
|
|
111
|
+
/**
|
|
112
|
+
* This table's URL in the Macro web app: the database, opened on this
|
|
113
|
+
* table. Hand it to users as the link to a table you built or changed.
|
|
114
|
+
*
|
|
115
|
+
* @readonly
|
|
116
|
+
*/
|
|
117
|
+
webUrl(): string;
|
|
118
|
+
/** Identity and {@link webUrl}, so serialized handles carry their link. */
|
|
57
119
|
toJSON(): {
|
|
58
120
|
id: string;
|
|
59
121
|
databaseId: string;
|
|
122
|
+
url: string;
|
|
60
123
|
};
|
|
61
124
|
}
|
|
@@ -17,24 +17,56 @@ export declare class DatabaseView {
|
|
|
17
17
|
private constructor();
|
|
18
18
|
/** A handle to a view by id, within a table. Details load on first access. */
|
|
19
19
|
static byId(table: DatabaseTable, id: string): DatabaseView;
|
|
20
|
-
/**
|
|
20
|
+
/**
|
|
21
|
+
* The view's record as the API returns it.
|
|
22
|
+
*
|
|
23
|
+
* @readonly
|
|
24
|
+
*/
|
|
21
25
|
detail(): Promise<DatabaseViewRecord>;
|
|
22
|
-
/**
|
|
26
|
+
/**
|
|
27
|
+
* The view's name, unique among its table's views ignoring case.
|
|
28
|
+
*
|
|
29
|
+
* @readonly
|
|
30
|
+
*/
|
|
23
31
|
name(): Promise<string>;
|
|
24
|
-
/**
|
|
32
|
+
/**
|
|
33
|
+
* The view's fractional index within its table's views.
|
|
34
|
+
*
|
|
35
|
+
* @readonly
|
|
36
|
+
*/
|
|
25
37
|
position(): Promise<string>;
|
|
26
|
-
/**
|
|
38
|
+
/**
|
|
39
|
+
* How the view draws its rows: a table, or a board grouped by a column.
|
|
40
|
+
*
|
|
41
|
+
* @readonly
|
|
42
|
+
*/
|
|
27
43
|
layout(): Promise<ViewLayout>;
|
|
28
|
-
/**
|
|
44
|
+
/**
|
|
45
|
+
* Which rows the view shows, and in what order.
|
|
46
|
+
*
|
|
47
|
+
* @readonly
|
|
48
|
+
*/
|
|
29
49
|
query(): Promise<ViewQuery>;
|
|
30
50
|
/**
|
|
31
51
|
* Where a board's cards sit: each placed card's lane and its key there.
|
|
32
52
|
* Cards without a place show after the placed ones of their lane, oldest
|
|
33
53
|
* first.
|
|
54
|
+
*
|
|
55
|
+
* @readonly
|
|
34
56
|
*/
|
|
35
57
|
positions(): Promise<CardPosition[]>;
|
|
58
|
+
/**
|
|
59
|
+
* This view's URL in the Macro web app: the database, opened on this
|
|
60
|
+
* view's table and this view. Hand it to users as the link to a view you
|
|
61
|
+
* built.
|
|
62
|
+
*
|
|
63
|
+
* @readonly
|
|
64
|
+
*/
|
|
65
|
+
webUrl(): string;
|
|
66
|
+
/** Identity and {@link webUrl}, so serialized handles carry their link. */
|
|
36
67
|
toJSON(): {
|
|
37
68
|
id: string;
|
|
38
69
|
tableId: string;
|
|
70
|
+
url: string;
|
|
39
71
|
};
|
|
40
72
|
}
|
|
@@ -6,6 +6,8 @@ import type { DatabaseTable } from './table';
|
|
|
6
6
|
* can POST JSON to, each object becoming a row, written with the access of
|
|
7
7
|
* the user who created it. Its token is shown only when it is created; see
|
|
8
8
|
* {@link Database.createWebhook}.
|
|
9
|
+
*
|
|
10
|
+
* @mcp-exclude Built from a listing record; no id-only reference an MCP call can pass.
|
|
9
11
|
*/
|
|
10
12
|
export declare class DatabaseWebhook {
|
|
11
13
|
/** The table its calls insert rows into. */
|
|
@@ -22,7 +24,12 @@ export declare class DatabaseWebhook {
|
|
|
22
24
|
get tokenPrefix(): string;
|
|
23
25
|
/** When it was created. */
|
|
24
26
|
get createdAt(): string;
|
|
25
|
-
/**
|
|
27
|
+
/**
|
|
28
|
+
* Delete the webhook; its URL stops working.
|
|
29
|
+
*
|
|
30
|
+
* @destructive
|
|
31
|
+
* @idempotent
|
|
32
|
+
*/
|
|
26
33
|
delete(): Promise<void>;
|
|
27
34
|
toJSON(): {
|
|
28
35
|
id: string;
|
|
@@ -50,3 +50,5 @@ export declare class DocumentEditRefusedError extends MacroApiError {
|
|
|
50
50
|
}
|
|
51
51
|
/** Run an instructions edit; `Document.edit` calls this. */
|
|
52
52
|
export declare function editWithInstructions(client: MacroClient, document: Document, instructions: string, options: DocumentEditOptions): Promise<DocumentEditResult>;
|
|
53
|
+
/** Whether an error body is the editor's refusal. */
|
|
54
|
+
export declare function isRefusal(error: unknown): error is DocumentAiEditRefused;
|
|
@@ -22,8 +22,18 @@ export declare class DocumentAnchor extends MacroEntity<AnchorRecord> {
|
|
|
22
22
|
readonly kind: () => Promise<"highlight" | "placeable">;
|
|
23
23
|
/** Page containing the annotation. */
|
|
24
24
|
readonly page: () => Promise<number>;
|
|
25
|
-
/**
|
|
25
|
+
/**
|
|
26
|
+
* Edit a placeable comment's position and display settings.
|
|
27
|
+
*
|
|
28
|
+
* @write
|
|
29
|
+
* @idempotent
|
|
30
|
+
*/
|
|
26
31
|
edit(options: Omit<EditPdfPlaceableCommentAnchorRequest, 'uuid'>): Promise<void>;
|
|
27
|
-
/**
|
|
32
|
+
/**
|
|
33
|
+
* Delete a standalone highlight annotation.
|
|
34
|
+
*
|
|
35
|
+
* @destructive
|
|
36
|
+
* @idempotent
|
|
37
|
+
*/
|
|
28
38
|
delete(): Promise<void>;
|
|
29
39
|
}
|
|
@@ -25,20 +25,44 @@ export declare class Comment extends MacroEntity<MessageRecord> {
|
|
|
25
25
|
readonly createdAt: () => Promise<string>;
|
|
26
26
|
/** When the comment was last updated. */
|
|
27
27
|
readonly updatedAt: () => Promise<string>;
|
|
28
|
-
/**
|
|
28
|
+
/**
|
|
29
|
+
* The id of the thread this comment belongs to: its root, or itself for a root.
|
|
30
|
+
*
|
|
31
|
+
* @readonly
|
|
32
|
+
*/
|
|
29
33
|
threadId(): Promise<string>;
|
|
30
|
-
/**
|
|
34
|
+
/**
|
|
35
|
+
* The document this comment is on.
|
|
36
|
+
*
|
|
37
|
+
* @readonly
|
|
38
|
+
*/
|
|
31
39
|
document(): Document;
|
|
32
|
-
/**
|
|
40
|
+
/**
|
|
41
|
+
* The user who wrote this comment.
|
|
42
|
+
*
|
|
43
|
+
* @readonly
|
|
44
|
+
*/
|
|
33
45
|
author(): Promise<User>;
|
|
34
|
-
/**
|
|
46
|
+
/**
|
|
47
|
+
* Reply in this comment's thread.
|
|
48
|
+
*
|
|
49
|
+
* @write
|
|
50
|
+
*/
|
|
35
51
|
reply(body: string | RichMessage): Promise<Comment>;
|
|
36
52
|
/**
|
|
37
53
|
* Replace the comment's text.
|
|
38
54
|
*
|
|
39
55
|
* @param body - Plain text, or a rich body composed with {@link msg}.
|
|
56
|
+
*
|
|
57
|
+
* @write
|
|
58
|
+
* @idempotent
|
|
40
59
|
*/
|
|
41
60
|
edit(body: string | RichMessage): Promise<this>;
|
|
42
|
-
/**
|
|
61
|
+
/**
|
|
62
|
+
* Delete this comment.
|
|
63
|
+
*
|
|
64
|
+
* @destructive
|
|
65
|
+
* @idempotent
|
|
66
|
+
*/
|
|
43
67
|
delete(): Promise<void>;
|
|
44
68
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|