@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
|
@@ -35,7 +35,7 @@ export type Entity = {
|
|
|
35
35
|
/**
|
|
36
36
|
* The type of an entity in Macro
|
|
37
37
|
*/
|
|
38
|
-
export type EntityType = 'user' | 'chat' | 'channel' | 'channel_message' | 'document' | 'project' | 'email_thread' | 'calendar_event' | 'team' | 'call' | 'foreign_entity' | 'static_file' | 'crm_company' | 'crm_contact' | 'crm_pipeline' | 'reminder' | 'skill' | 'agent_session' | 'scheduled_action' | 'initiative' | 'database' | 'database_row' | 'form' | 'external_chat';
|
|
38
|
+
export type EntityType = 'user' | 'chat' | 'channel' | 'channel_message' | 'document' | 'project' | 'email_thread' | 'calendar_event' | 'team' | 'call' | 'foreign_entity' | 'static_file' | 'crm_company' | 'crm_contact' | 'crm_pipeline' | 'reminder' | 'harness' | 'skill' | 'agent_session' | 'scheduled_action' | 'initiative' | 'database' | 'database_row' | 'form' | 'external_chat';
|
|
39
39
|
export type GenericErrorResponse = {
|
|
40
40
|
/**
|
|
41
41
|
* Indicates if an error occurred
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export { type Options, Sdk } from './sdk.gen';
|
|
2
|
-
export type { AddContactData, AddContactError, AddContactErrors, AddContactRequest, AddContactResponse, AddContactResponses, ClientOptions, GetContactsData, GetContactsError, GetContactsErrors, GetContactsResponse, GetContactsResponse2, GetContactsResponses } from './types.gen';
|
|
2
|
+
export type { AddContactData, AddContactError, AddContactErrors, AddContactRequest, AddContactResponse, AddContactResponses, ClientOptions, GetContactsData, GetContactsError, GetContactsErrors, GetContactsResponse, GetContactsResponse2, GetContactsResponses, SearchedPerson, SearchPeopleData, SearchPeopleError, SearchPeopleErrors, SearchPeopleResponse, SearchPeopleResponse2, SearchPeopleResponses } from './types.gen';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
|
|
2
|
-
import type { AddContactData, AddContactErrors, AddContactResponses, GetContactsData, GetContactsErrors, GetContactsResponses } from './types.gen';
|
|
2
|
+
import type { AddContactData, AddContactErrors, AddContactResponses, GetContactsData, GetContactsErrors, GetContactsResponses, SearchPeopleData, SearchPeopleErrors, SearchPeopleResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -39,5 +39,9 @@ export declare class Sdk extends HeyApiClient {
|
|
|
39
39
|
* POST /contacts handler.
|
|
40
40
|
*/
|
|
41
41
|
addContact<ThrowOnError extends boolean = false>(options: Options<AddContactData, ThrowOnError>): RequestResult<AddContactResponses, AddContactErrors, ThrowOnError>;
|
|
42
|
+
/**
|
|
43
|
+
* GET /contacts/search handler: ranked search of the viewer's contacts and team.
|
|
44
|
+
*/
|
|
45
|
+
searchPeople<ThrowOnError extends boolean = false>(options: Options<SearchPeopleData, ThrowOnError>): RequestResult<SearchPeopleResponses, SearchPeopleErrors, ThrowOnError>;
|
|
42
46
|
}
|
|
43
47
|
export {};
|
|
@@ -19,6 +19,36 @@ export type GetContactsResponse = {
|
|
|
19
19
|
*/
|
|
20
20
|
contacts: Array<string>;
|
|
21
21
|
};
|
|
22
|
+
/**
|
|
23
|
+
* Response body for GET /contacts/search.
|
|
24
|
+
*/
|
|
25
|
+
export type SearchPeopleResponse = {
|
|
26
|
+
/**
|
|
27
|
+
* Matches ranked teammates first, then prefix matches, then by name or email.
|
|
28
|
+
*/
|
|
29
|
+
people: Array<SearchedPerson>;
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* One ranked person in a GET /contacts/search response.
|
|
33
|
+
*/
|
|
34
|
+
export type SearchedPerson = {
|
|
35
|
+
/**
|
|
36
|
+
* Whether the person is an agent rather than a human; false for non-Macro contacts.
|
|
37
|
+
*/
|
|
38
|
+
isAgent: boolean;
|
|
39
|
+
/**
|
|
40
|
+
* Whether the person is on the viewer's current team.
|
|
41
|
+
*/
|
|
42
|
+
isTeammate: boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Resolved name, as the contact directory shows it; null when unknown.
|
|
45
|
+
*/
|
|
46
|
+
name?: string | null;
|
|
47
|
+
/**
|
|
48
|
+
* The person's user ID (`macro|<email>`).
|
|
49
|
+
*/
|
|
50
|
+
userId: string;
|
|
51
|
+
};
|
|
22
52
|
export type GetContactsData = {
|
|
23
53
|
body?: never;
|
|
24
54
|
path?: never;
|
|
@@ -50,3 +80,29 @@ export type AddContactResponses = {
|
|
|
50
80
|
204: void;
|
|
51
81
|
};
|
|
52
82
|
export type AddContactResponse = AddContactResponses[keyof AddContactResponses];
|
|
83
|
+
export type SearchPeopleData = {
|
|
84
|
+
body?: never;
|
|
85
|
+
path?: never;
|
|
86
|
+
query: {
|
|
87
|
+
/**
|
|
88
|
+
* Text matched against email and name. Under two characters after
|
|
89
|
+
* trimming returns no people; over 512 bytes is rejected.
|
|
90
|
+
*/
|
|
91
|
+
query: string;
|
|
92
|
+
/**
|
|
93
|
+
* Maximum results: default 20, values over 50 are capped at 50, zero is rejected.
|
|
94
|
+
*/
|
|
95
|
+
limit?: number;
|
|
96
|
+
};
|
|
97
|
+
url: '/contacts/search';
|
|
98
|
+
};
|
|
99
|
+
export type SearchPeopleErrors = {
|
|
100
|
+
400: string;
|
|
101
|
+
401: string;
|
|
102
|
+
500: string;
|
|
103
|
+
};
|
|
104
|
+
export type SearchPeopleError = SearchPeopleErrors[keyof SearchPeopleErrors];
|
|
105
|
+
export type SearchPeopleResponses = {
|
|
106
|
+
200: SearchPeopleResponse;
|
|
107
|
+
};
|
|
108
|
+
export type SearchPeopleResponse2 = SearchPeopleResponses[keyof SearchPeopleResponses];
|
|
@@ -165,6 +165,12 @@ export type ApiDraftInput = {
|
|
|
165
165
|
* Generation from the last loaded draft; legacy clients begin at zero.
|
|
166
166
|
*/
|
|
167
167
|
draft_generation?: number;
|
|
168
|
+
/**
|
|
169
|
+
* The address to send from: the selected inbox's own address or one of
|
|
170
|
+
* its verified Gmail send-as aliases, which sends under the alias's
|
|
171
|
+
* display name. Omit it to send from the inbox's own address.
|
|
172
|
+
*/
|
|
173
|
+
from?: string | null;
|
|
168
174
|
headers_json?: null | Value;
|
|
169
175
|
/**
|
|
170
176
|
* Per-message override for whether to include the signature on send:
|
|
@@ -1104,7 +1110,7 @@ export type ForwardCalendarEventError = {
|
|
|
1104
1110
|
/**
|
|
1105
1111
|
* Why a forward was not sent.
|
|
1106
1112
|
*/
|
|
1107
|
-
export type ForwardCalendarEventErrorCode = 'not_found' | 'invalid_recipients' | 'inbox_unavailable' | 'send_failed';
|
|
1113
|
+
export type ForwardCalendarEventErrorCode = 'not_found' | 'invalid_recipients' | 'inbox_unavailable' | 'send_failed' | 'confirmation_required';
|
|
1108
1114
|
/**
|
|
1109
1115
|
* One person a forwarded invitation goes to.
|
|
1110
1116
|
*/
|
|
@@ -2070,7 +2076,7 @@ export type ForwardCalendarEventErrors = {
|
|
|
2070
2076
|
*/
|
|
2071
2077
|
401: unknown;
|
|
2072
2078
|
/**
|
|
2073
|
-
* The inbox holding the copy cannot send for the viewer
|
|
2079
|
+
* The inbox holding the copy cannot send for the viewer, or an agent's program asked to forward
|
|
2074
2080
|
*/
|
|
2075
2081
|
403: ForwardCalendarEventError;
|
|
2076
2082
|
/**
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export { type Options, Sdk } from './sdk.gen';
|
|
2
|
-
export type { AgentSessionMentionedMetadata, AgentSessionNotificationRef, AgentSessionOriginParent, AgentSessionSettledMetadata, AgentSessionWaitingForInputMetadata, AiResponseMetadata, ApiUserNotification, BulkDeleteUserNotificationsV2Data, BulkDeleteUserNotificationsV2Error, BulkDeleteUserNotificationsV2Errors, BulkDeleteUserNotificationsV2Responses, BulkGetByEventItemIdsRequest, BulkGetTypedNotificationsByEventItemIdsData, BulkGetTypedNotificationsByEventItemIdsError, BulkGetTypedNotificationsByEventItemIdsErrors, BulkGetTypedNotificationsByEventItemIdsResponse, BulkGetTypedNotificationsByEventItemIdsResponses, BulkItem, BulkMarkNotificationsDoneData, BulkMarkNotificationsDoneError, BulkMarkNotificationsDoneErrors, BulkMarkNotificationsDoneResponses, BulkMarkNotificationsSeenData, BulkMarkNotificationsSeenError, BulkMarkNotificationsSeenErrors, BulkMarkNotificationsSeenResponses, BulkMarkNotificationsUndoneData, BulkMarkNotificationsUndoneError, BulkMarkNotificationsUndoneErrors, BulkMarkNotificationsUndoneResponses, BulkRemoveItemsRequest, BulkSetItemsRequest, CalendarEventJoinRequestMetadata, CalendarEventReminderMetadata, CallStartedMetadata, ChannelAccessRequestedMetadata, ChannelInviteMetadata, ChannelMentionMetadata, ChannelMessageReactionMetadata, ChannelMessageSendMetadata, ChannelReplyMetadata, ChannelType, ClientOptions, CommentedOnDocumentMetadata, CommentRef, CommonChannelMetadata, ConnGatewayNotificationPayload, CreateNotification, CrmDiscussionMetadata, CrmDiscussionReason, DeleteUserNotificationV2Data, DeleteUserNotificationV2Error, DeleteUserNotificationV2Errors, DeleteUserNotificationV2Responses, DeviceRequest, DeviceType, DisableNotificationTypeData, DisableNotificationTypeError, DisableNotificationTypeErrors, DisableNotificationTypeResponses, DocumentMentionMetadata, EmptyResponse, EnableNotificationTypeData, EnableNotificationTypeError, EnableNotificationTypeErrors, EnableNotificationTypeResponses, Entity, EntityAccessGrantedMetadata, EntityAccessRequestedMetadata, EntityType, ErrorResponse, ExternalChatMessageMetadata, ExternalChatProvider, GetAllUserNotificationsResponse, GetNotificationTypePreferencesData, GetNotificationTypePreferencesError, GetNotificationTypePreferencesErrors, GetNotificationTypePreferencesResponse, GetNotificationTypePreferencesResponse2, GetNotificationTypePreferencesResponses, GetTypedNotificationByIdData, GetTypedNotificationByIdError, GetTypedNotificationByIdErrors, GetTypedNotificationByIdResponse, GetTypedNotificationByIdResponses, GetTypedNotificationsByEventItemIdData, GetTypedNotificationsByEventItemIdError, GetTypedNotificationsByEventItemIdErrors, GetTypedNotificationsByEventItemIdResponse, GetTypedNotificationsByEventItemIdResponses, GetUnsubscribesData, GetUnsubscribesError, GetUnsubscribesErrors, GetUnsubscribesResponse, GetUnsubscribesResponses, GithubPrCheckRun, GithubPrCheckRunState, GithubPrComment, GithubPrCommentKind, GithubPrEventAction, GithubPrEventStatus, GithubPrMention, GithubPrMentionLocation, GithubPrNotificationCommon, GithubPrReview, GithubPrReviewState, GithubPrStatusChanged, GithubReviewRequested, HealthHandlerData, HealthHandlerResponse, HealthHandlerResponses, InboxReauthRequiredMetadata, InitiativeDiscussionMetadata, InitiativeDiscussionReason, InviteePlan, InviteToTeamMetadata, ItemSharedMetadata, ListTypedNotificationsData, ListTypedNotificationsError, ListTypedNotificationsErrors, ListTypedNotificationsResponse, ListTypedNotificationsResponses, MacroUserIdStr, MentionedInDocumentCommentMetadata, NewEmailMetadata, NotifEvent, NotificationBulkRequest, NotificationDocumentSubType, NotificationServiceApiVersion, NotificationState, NotificationTypeName, PushNotificationData, PushNotificationNavigation, RealtimeNotifTaggedContentValue, ReminderMetadata, RemoveUnsubscribeAllData, RemoveUnsubscribeAllError, RemoveUnsubscribeAllErrors, RemoveUnsubscribeAllResponse, RemoveUnsubscribeAllResponses, RemoveUnsubscribeItemData, RemoveUnsubscribeItemError, RemoveUnsubscribeItemErrors, RemoveUnsubscribeItemResponse, RemoveUnsubscribeItemResponses, RemoveUnsubscribeItemsData, RemoveUnsubscribeItemsError, RemoveUnsubscribeItemsErrors, RemoveUnsubscribeItemsResponse, RemoveUnsubscribeItemsResponses, RepliedToDocumentCommentThreadMetadata, RequestedAccessLevel, RoutineRunFinishedMetadata, RoutineRunOutcome, TaskAssignedMetadata, UnsubscribeAllData, UnsubscribeAllError, UnsubscribeAllErrors, UnsubscribeAllResponse, UnsubscribeAllResponses, UnsubscribeEmailData, UnsubscribeEmailError, UnsubscribeEmailErrors, UnsubscribeEmailResponse, UnsubscribeEmailResponses, UnsubscribeItemData, UnsubscribeItemError, UnsubscribeItemErrors, UnsubscribeItemPathParams, UnsubscribeItemResponse, UnsubscribeItemResponses, UnsubscribeItemsData, UnsubscribeItemsError, UnsubscribeItemsErrors, UnsubscribeItemsResponse, UnsubscribeItemsResponses, UserUnsubscribe } from './types.gen';
|
|
2
|
+
export type { AgentProvider, AgentSessionMentionedMetadata, AgentSessionNotificationRef, AgentSessionOriginParent, AgentSessionSettledMetadata, AgentSessionWaitingForInputMetadata, AgentSignInExpiryMetadata, AgentSignInExpiryStage, AiResponseMetadata, ApiUserNotification, BulkDeleteUserNotificationsV2Data, BulkDeleteUserNotificationsV2Error, BulkDeleteUserNotificationsV2Errors, BulkDeleteUserNotificationsV2Responses, BulkGetByEventItemIdsRequest, BulkGetTypedNotificationsByEventItemIdsData, BulkGetTypedNotificationsByEventItemIdsError, BulkGetTypedNotificationsByEventItemIdsErrors, BulkGetTypedNotificationsByEventItemIdsResponse, BulkGetTypedNotificationsByEventItemIdsResponses, BulkItem, BulkMarkNotificationsDoneData, BulkMarkNotificationsDoneError, BulkMarkNotificationsDoneErrors, BulkMarkNotificationsDoneResponses, BulkMarkNotificationsSeenData, BulkMarkNotificationsSeenError, BulkMarkNotificationsSeenErrors, BulkMarkNotificationsSeenResponses, BulkMarkNotificationsUndoneData, BulkMarkNotificationsUndoneError, BulkMarkNotificationsUndoneErrors, BulkMarkNotificationsUndoneResponses, BulkRemoveItemsRequest, BulkSetItemsRequest, CalendarEventJoinRequestMetadata, CalendarEventReminderMetadata, CallStartedMetadata, ChannelAccessRequestedMetadata, ChannelInviteMetadata, ChannelMentionMetadata, ChannelMessageReactionMetadata, ChannelMessageSendMetadata, ChannelReplyMetadata, ChannelType, ClientOptions, CommentedOnDocumentMetadata, CommentRef, CommonChannelMetadata, ComputerSetupAgent, ComputerSetupMetadata, ComputerSetupOutcome, ConnGatewayNotificationPayload, CreateNotification, CrmDiscussionMetadata, CrmDiscussionReason, DeleteUserNotificationV2Data, DeleteUserNotificationV2Error, DeleteUserNotificationV2Errors, DeleteUserNotificationV2Responses, DeviceRequest, DeviceType, DisableNotificationTypeData, DisableNotificationTypeError, DisableNotificationTypeErrors, DisableNotificationTypeResponses, DocumentMentionMetadata, EmptyResponse, EnableNotificationTypeData, EnableNotificationTypeError, EnableNotificationTypeErrors, EnableNotificationTypeResponses, Entity, EntityAccessGrantedMetadata, EntityAccessRequestedMetadata, EntityType, ErrorResponse, ExternalChatMessageMetadata, ExternalChatProvider, GetAllUserNotificationsResponse, GetNotificationTypePreferencesData, GetNotificationTypePreferencesError, GetNotificationTypePreferencesErrors, GetNotificationTypePreferencesResponse, GetNotificationTypePreferencesResponse2, GetNotificationTypePreferencesResponses, GetTypedNotificationByIdData, GetTypedNotificationByIdError, GetTypedNotificationByIdErrors, GetTypedNotificationByIdResponse, GetTypedNotificationByIdResponses, GetTypedNotificationsByEventItemIdData, GetTypedNotificationsByEventItemIdError, GetTypedNotificationsByEventItemIdErrors, GetTypedNotificationsByEventItemIdResponse, GetTypedNotificationsByEventItemIdResponses, GetUnsubscribesData, GetUnsubscribesError, GetUnsubscribesErrors, GetUnsubscribesResponse, GetUnsubscribesResponses, GithubPrCheckRun, GithubPrCheckRunState, GithubPrComment, GithubPrCommentKind, GithubPrEventAction, GithubPrEventStatus, GithubPrMention, GithubPrMentionLocation, GithubPrNotificationCommon, GithubPrReview, GithubPrReviewState, GithubPrStatusChanged, GithubReviewRequested, HealthHandlerData, HealthHandlerResponse, HealthHandlerResponses, InboxReauthRequiredMetadata, InitiativeDiscussionMetadata, InitiativeDiscussionReason, InviteePlan, InviteToTeamMetadata, ItemSharedMetadata, ListTypedNotificationsData, ListTypedNotificationsError, ListTypedNotificationsErrors, ListTypedNotificationsResponse, ListTypedNotificationsResponses, MacroUserIdStr, MentionedInDocumentCommentMetadata, NewEmailMetadata, NotifEvent, NotificationBulkRequest, NotificationDocumentSubType, NotificationServiceApiVersion, NotificationState, NotificationTypeName, PasswordAccessRequestedMetadata, PushNotificationData, PushNotificationNavigation, RealtimeNotifTaggedContentValue, ReminderMetadata, RemoveUnsubscribeAllData, RemoveUnsubscribeAllError, RemoveUnsubscribeAllErrors, RemoveUnsubscribeAllResponse, RemoveUnsubscribeAllResponses, RemoveUnsubscribeItemData, RemoveUnsubscribeItemError, RemoveUnsubscribeItemErrors, RemoveUnsubscribeItemResponse, RemoveUnsubscribeItemResponses, RemoveUnsubscribeItemsData, RemoveUnsubscribeItemsError, RemoveUnsubscribeItemsErrors, RemoveUnsubscribeItemsResponse, RemoveUnsubscribeItemsResponses, RepliedToDocumentCommentThreadMetadata, RequestedAccessLevel, RoutineRunFinishedMetadata, RoutineRunOutcome, RuntimeAccessRemovedMetadata, StoppedAgent, TaskAssignedMetadata, UnsubscribeAllData, UnsubscribeAllError, UnsubscribeAllErrors, UnsubscribeAllResponse, UnsubscribeAllResponses, UnsubscribeEmailData, UnsubscribeEmailError, UnsubscribeEmailErrors, UnsubscribeEmailResponse, UnsubscribeEmailResponses, UnsubscribeItemData, UnsubscribeItemError, UnsubscribeItemErrors, UnsubscribeItemPathParams, UnsubscribeItemResponse, UnsubscribeItemResponses, UnsubscribeItemsData, UnsubscribeItemsError, UnsubscribeItemsErrors, UnsubscribeItemsResponse, UnsubscribeItemsResponses, UserUnsubscribe } from './types.gen';
|
|
@@ -48,7 +48,8 @@ export declare class Sdk extends HeyApiClient {
|
|
|
48
48
|
*/
|
|
49
49
|
removeUnsubscribeItem<ThrowOnError extends boolean = false>(options: Options<RemoveUnsubscribeItemData, ThrowOnError>): RequestResult<RemoveUnsubscribeItemResponses, RemoveUnsubscribeItemErrors, ThrowOnError>;
|
|
50
50
|
/**
|
|
51
|
-
* Unsubscribes a user from a given item for notifications
|
|
51
|
+
* Unsubscribes a user from a given item for notifications, or, with
|
|
52
|
+
* `mentions_only`, from everything on a channel but their direct mentions.
|
|
52
53
|
*/
|
|
53
54
|
unsubscribeItem<ThrowOnError extends boolean = false>(options: Options<UnsubscribeItemData, ThrowOnError>): RequestResult<UnsubscribeItemResponses, UnsubscribeItemErrors, ThrowOnError>;
|
|
54
55
|
/**
|
|
@@ -1,6 +1,12 @@
|
|
|
1
1
|
export type ClientOptions = {
|
|
2
2
|
baseUrl: `${string}://${string}` | (string & {});
|
|
3
3
|
};
|
|
4
|
+
/**
|
|
5
|
+
* Whose account an agent signs in to: the Postgres `agent_provider` enum of
|
|
6
|
+
* `provider_accounts.provider` and `harness_account_logins.provider`. New
|
|
7
|
+
* providers add a value there.
|
|
8
|
+
*/
|
|
9
|
+
export type AgentProvider = 'claude';
|
|
4
10
|
/**
|
|
5
11
|
* Someone named the recipient in a prompt to an agent session.
|
|
6
12
|
*/
|
|
@@ -104,6 +110,37 @@ export type AgentSessionWaitingForInputMetadata = AgentSessionNotificationRef &
|
|
|
104
110
|
*/
|
|
105
111
|
turn: number;
|
|
106
112
|
};
|
|
113
|
+
/**
|
|
114
|
+
* The account a team's Macro computer signed an agent in to is about to
|
|
115
|
+
* stop working, or has. Sent to whoever signed it in and to the team's
|
|
116
|
+
* admins and owner, who can sign it in again from Settings → Machines.
|
|
117
|
+
*/
|
|
118
|
+
export type AgentSignInExpiryMetadata = {
|
|
119
|
+
/**
|
|
120
|
+
* The agent whose sign-in is running out.
|
|
121
|
+
*/
|
|
122
|
+
agent: AgentProvider;
|
|
123
|
+
/**
|
|
124
|
+
* The computer's name when the notice was sent.
|
|
125
|
+
*/
|
|
126
|
+
computerName: string;
|
|
127
|
+
/**
|
|
128
|
+
* When the sign-in expires or expired; absent when the agent rejected it.
|
|
129
|
+
*/
|
|
130
|
+
expiresAt?: string | null;
|
|
131
|
+
/**
|
|
132
|
+
* The computer's harness, whose runtime row holds the sign-in.
|
|
133
|
+
*/
|
|
134
|
+
harnessId: string;
|
|
135
|
+
/**
|
|
136
|
+
* How close the sign-in is to no longer working.
|
|
137
|
+
*/
|
|
138
|
+
stage: AgentSignInExpiryStage;
|
|
139
|
+
};
|
|
140
|
+
/**
|
|
141
|
+
* How close a computer's agent sign-in is to no longer working.
|
|
142
|
+
*/
|
|
143
|
+
export type AgentSignInExpiryStage = 'expires_soon' | 'expires_today' | 'expired';
|
|
107
144
|
export type AiResponseMetadata = {
|
|
108
145
|
messageId: string;
|
|
109
146
|
summary: string;
|
|
@@ -438,6 +475,55 @@ export type CommonChannelMetadata = {
|
|
|
438
475
|
channelName?: string;
|
|
439
476
|
channelType: ChannelType;
|
|
440
477
|
};
|
|
478
|
+
/**
|
|
479
|
+
* The agent teammate a computer was bought for, so its inviter hears about
|
|
480
|
+
* the agent rather than the machine.
|
|
481
|
+
*/
|
|
482
|
+
export type ComputerSetupAgent = {
|
|
483
|
+
/**
|
|
484
|
+
* The agent's name.
|
|
485
|
+
*/
|
|
486
|
+
name: string;
|
|
487
|
+
/**
|
|
488
|
+
* The agent's Macro user id, to open a DM with it.
|
|
489
|
+
*/
|
|
490
|
+
userId: string;
|
|
491
|
+
};
|
|
492
|
+
/**
|
|
493
|
+
* A team's Macro computer finished first-time setup, or could not be set
|
|
494
|
+
* up. Sent to its buyer, who continues (or retries) from the setup flow.
|
|
495
|
+
*/
|
|
496
|
+
export type ComputerSetupMetadata = {
|
|
497
|
+
agent?: null | ComputerSetupAgent;
|
|
498
|
+
/**
|
|
499
|
+
* The computer that was set up.
|
|
500
|
+
*/
|
|
501
|
+
computerId: string;
|
|
502
|
+
/**
|
|
503
|
+
* The computer's name when the notice was sent.
|
|
504
|
+
*/
|
|
505
|
+
computerName: string;
|
|
506
|
+
/**
|
|
507
|
+
* The computer's harness, once macrod has connected.
|
|
508
|
+
*/
|
|
509
|
+
harnessId?: string | null;
|
|
510
|
+
/**
|
|
511
|
+
* Ready, or why setup failed.
|
|
512
|
+
*/
|
|
513
|
+
outcome: ComputerSetupOutcome;
|
|
514
|
+
};
|
|
515
|
+
/**
|
|
516
|
+
* How a computer's first setup ended.
|
|
517
|
+
*/
|
|
518
|
+
export type ComputerSetupOutcome = {
|
|
519
|
+
kind: 'ready';
|
|
520
|
+
} | {
|
|
521
|
+
/**
|
|
522
|
+
* Why, in the words the computer's status shows.
|
|
523
|
+
*/
|
|
524
|
+
failureReason: string;
|
|
525
|
+
kind: 'failed';
|
|
526
|
+
};
|
|
441
527
|
/**
|
|
442
528
|
* Concrete schema type for [`RealtimeNotif`] with `serde_json::Value` metadata.
|
|
443
529
|
*
|
|
@@ -606,7 +692,7 @@ export type EntityAccessRequestedMetadata = {
|
|
|
606
692
|
/**
|
|
607
693
|
* The type of an entity in Macro
|
|
608
694
|
*/
|
|
609
|
-
export type EntityType = 'user' | 'chat' | 'channel' | 'channel_message' | 'document' | 'project' | 'email_thread' | 'calendar_event' | 'team' | 'call' | 'foreign_entity' | 'static_file' | 'crm_company' | 'crm_contact' | 'crm_pipeline' | 'reminder' | 'skill' | 'agent_session' | 'scheduled_action' | 'initiative' | 'database' | 'database_row' | 'form' | 'external_chat';
|
|
695
|
+
export type EntityType = 'user' | 'chat' | 'channel' | 'channel_message' | 'document' | 'project' | 'email_thread' | 'calendar_event' | 'team' | 'call' | 'foreign_entity' | 'static_file' | 'crm_company' | 'crm_contact' | 'crm_pipeline' | 'reminder' | 'harness' | 'skill' | 'agent_session' | 'scheduled_action' | 'initiative' | 'database' | 'database_row' | 'form' | 'external_chat';
|
|
610
696
|
/**
|
|
611
697
|
* A plain old json error response for use with axum.
|
|
612
698
|
* yup, thats it.
|
|
@@ -1260,12 +1346,39 @@ export type NotifEvent = {
|
|
|
1260
1346
|
*/
|
|
1261
1347
|
content: ChannelAccessRequestedMetadata;
|
|
1262
1348
|
tag: 'channel_access_requested';
|
|
1349
|
+
} | {
|
|
1350
|
+
/**
|
|
1351
|
+
* An agent asked for access to a vault item the user manages.
|
|
1352
|
+
*/
|
|
1353
|
+
content: PasswordAccessRequestedMetadata;
|
|
1354
|
+
tag: 'password_access_requested';
|
|
1263
1355
|
} | {
|
|
1264
1356
|
/**
|
|
1265
1357
|
* One of the user's routines finished a run, successfully or not.
|
|
1266
1358
|
*/
|
|
1267
1359
|
content: RoutineRunFinishedMetadata;
|
|
1268
1360
|
tag: 'routine_run_finished';
|
|
1361
|
+
} | {
|
|
1362
|
+
/**
|
|
1363
|
+
* An agent's sign-in on one of the team's Macro computers is about
|
|
1364
|
+
* to expire, expired, or was rejected.
|
|
1365
|
+
*/
|
|
1366
|
+
content: AgentSignInExpiryMetadata;
|
|
1367
|
+
tag: 'agent_sign_in_expiry';
|
|
1368
|
+
} | {
|
|
1369
|
+
/**
|
|
1370
|
+
* A Macro computer the user bought finished first-time setup, or
|
|
1371
|
+
* could not be set up.
|
|
1372
|
+
*/
|
|
1373
|
+
content: ComputerSetupMetadata;
|
|
1374
|
+
tag: 'computer_setup';
|
|
1375
|
+
} | {
|
|
1376
|
+
/**
|
|
1377
|
+
* A runtime's owner removed the user's access to it, and agents of
|
|
1378
|
+
* theirs living there stopped.
|
|
1379
|
+
*/
|
|
1380
|
+
content: RuntimeAccessRemovedMetadata;
|
|
1381
|
+
tag: 'runtime_access_removed';
|
|
1269
1382
|
};
|
|
1270
1383
|
/**
|
|
1271
1384
|
* the notification ids that we are bulk updating
|
|
@@ -1298,6 +1411,29 @@ export type NotificationState = 'unseen' | 'seen' | 'done';
|
|
|
1298
1411
|
* newtype wrapper for the the typename of a Notification
|
|
1299
1412
|
*/
|
|
1300
1413
|
export type NotificationTypeName = string;
|
|
1414
|
+
/**
|
|
1415
|
+
* An agent asked for access to a team vault item. Sent to the item's current
|
|
1416
|
+
* human creator and the team's current administrators, with the agent as
|
|
1417
|
+
* sender. Carries the item name and opaque ids only, never values.
|
|
1418
|
+
*/
|
|
1419
|
+
export type PasswordAccessRequestedMetadata = {
|
|
1420
|
+
/**
|
|
1421
|
+
* Requested item.
|
|
1422
|
+
*/
|
|
1423
|
+
itemId: string;
|
|
1424
|
+
/**
|
|
1425
|
+
* Item display name when the request was made.
|
|
1426
|
+
*/
|
|
1427
|
+
itemName: string;
|
|
1428
|
+
/**
|
|
1429
|
+
* Request under review.
|
|
1430
|
+
*/
|
|
1431
|
+
requestId: string;
|
|
1432
|
+
/**
|
|
1433
|
+
* Team owning the item.
|
|
1434
|
+
*/
|
|
1435
|
+
teamId: string;
|
|
1436
|
+
};
|
|
1301
1437
|
/**
|
|
1302
1438
|
* the value we send as the payload in the ios notification
|
|
1303
1439
|
* This data is accessible to the client
|
|
@@ -1477,6 +1613,34 @@ export type RoutineRunFinishedMetadata = {
|
|
|
1477
1613
|
* How a routine run ended, as its notification reports it.
|
|
1478
1614
|
*/
|
|
1479
1615
|
export type RoutineRunOutcome = 'succeeded' | 'failed';
|
|
1616
|
+
/**
|
|
1617
|
+
* A runtime's owner removed the recipient's access to it, or lowered it to
|
|
1618
|
+
* Read, and agents the recipient keeps living there stopped.
|
|
1619
|
+
*/
|
|
1620
|
+
export type RuntimeAccessRemovedMetadata = {
|
|
1621
|
+
/**
|
|
1622
|
+
* The recipient's agents living on the runtime, which stopped. Never
|
|
1623
|
+
* empty: without one there is nothing to tell them.
|
|
1624
|
+
*/
|
|
1625
|
+
agents: Array<StoppedAgent>;
|
|
1626
|
+
/**
|
|
1627
|
+
* The runtime's name.
|
|
1628
|
+
*/
|
|
1629
|
+
runtimeName: string;
|
|
1630
|
+
};
|
|
1631
|
+
/**
|
|
1632
|
+
* One of the recipient's agents that stopped with their runtime access.
|
|
1633
|
+
*/
|
|
1634
|
+
export type StoppedAgent = {
|
|
1635
|
+
/**
|
|
1636
|
+
* The agent's bot id.
|
|
1637
|
+
*/
|
|
1638
|
+
botId: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* The agent's display name.
|
|
1641
|
+
*/
|
|
1642
|
+
name: string;
|
|
1643
|
+
};
|
|
1480
1644
|
/**
|
|
1481
1645
|
* Metadata for when a user is assigned to a task
|
|
1482
1646
|
*/
|
|
@@ -1509,6 +1673,10 @@ export type UserUnsubscribe = {
|
|
|
1509
1673
|
* The item type
|
|
1510
1674
|
*/
|
|
1511
1675
|
item_type: string;
|
|
1676
|
+
/**
|
|
1677
|
+
* The item still notifies the user when a message @mentions them directly.
|
|
1678
|
+
*/
|
|
1679
|
+
mentions_only?: boolean;
|
|
1512
1680
|
/**
|
|
1513
1681
|
* None for permanent mutes; notifications resume automatically at this deadline.
|
|
1514
1682
|
*/
|
|
@@ -1586,6 +1754,11 @@ export type UnsubscribeItemData = {
|
|
|
1586
1754
|
* A future resume time. Omit to mute indefinitely.
|
|
1587
1755
|
*/
|
|
1588
1756
|
snoozed_until?: string | null;
|
|
1757
|
+
/**
|
|
1758
|
+
* Keep notifying for messages that @mention the user directly and silence
|
|
1759
|
+
* the rest. Channels only; cannot be combined with `snoozed_until`.
|
|
1760
|
+
*/
|
|
1761
|
+
mentions_only?: boolean;
|
|
1589
1762
|
};
|
|
1590
1763
|
url: '/unsubscribe/item/{item_type}/{item_id}';
|
|
1591
1764
|
};
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export { type Options, Sdk } from './sdk.gen';
|
|
2
|
-
export type { ActionConfiguration, ActionConfigurationUpdate, ActionExecutionRecord, ActionKind, ActionTrigger, ActivateScheduledActionTemplateData, ActivateScheduledActionTemplateError, ActivateScheduledActionTemplateErrors, ActivateScheduledActionTemplateResponse, ActivateScheduledActionTemplateResponses, AgentMcpServer, AgentTask, AgentTaskAgent, AiAdmissionErrorBody, ClientOptions, CodeUpgrade, ConditionResult, CreateScheduledActionData, CreateScheduledActionError, CreateScheduledActionErrors, CreateScheduledActionResponse, CreateScheduledActionResponses, DeleteScheduledActionData, DeleteScheduledActionError, DeleteScheduledActionErrors, DeleteScheduledActionResponse, DeleteScheduledActionResponses, Draft, DraftContext, DraftedRoutine, DraftedStep, DraftRequest, DraftRoutineData, DraftRoutineError, DraftRoutineErrors, DraftRoutineRequest, DraftRoutineResponse, DraftRoutineResponses, EmptyResponse, EventFilter, EventFilters, EventName, ExecuteScheduledActionNowData, ExecuteScheduledActionNowError, ExecuteScheduledActionNowErrors, ExecuteScheduledActionNowResponse, ExecuteScheduledActionNowResponses, ExecutionResource, ExecutionResourceType, ExecutionResult, GetScheduledActionData, GetScheduledActionError, GetScheduledActionErrors, GetScheduledActionResponse, GetScheduledActionResponses, GetScheduledActionTemplateData, GetScheduledActionTemplateError, GetScheduledActionTemplateErrors, GetScheduledActionTemplateResponse, GetScheduledActionTemplateResponses, GithubSelector, InProgressExecution, ListScheduledActionCodeUpgradesData, ListScheduledActionCodeUpgradesError, ListScheduledActionCodeUpgradesErrors, ListScheduledActionCodeUpgradesResponse, ListScheduledActionCodeUpgradesResponses, ListScheduledActionHistoryData, ListScheduledActionHistoryError, ListScheduledActionHistoryErrors, ListScheduledActionHistoryResponse, ListScheduledActionHistoryResponses, ListScheduledActionsData, ListScheduledActionsError, ListScheduledActionsErrors, ListScheduledActionsResponse, ListScheduledActionsResponses,
|
|
2
|
+
export type { AcceptSuggestionData, AcceptSuggestionError, AcceptSuggestionErrors, AcceptSuggestionRequest, AcceptSuggestionResponse, AcceptSuggestionResponses, ActionConfiguration, ActionConfigurationUpdate, ActionExecutionRecord, ActionKind, ActionTrigger, ActivateScheduledActionTemplateData, ActivateScheduledActionTemplateError, ActivateScheduledActionTemplateErrors, ActivateScheduledActionTemplateResponse, ActivateScheduledActionTemplateResponses, AddSuggestionData, AddSuggestionError, AddSuggestionErrors, AddSuggestionResponse, AddSuggestionResponses, AgentMcpServer, AgentStep, AgentTask, AgentTaskAgent, AiAdmissionErrorBody, AppearanceColor, AppearanceIcon, AttachDraft, AttachSuggestionDraftData, AttachSuggestionDraftError, AttachSuggestionDraftErrors, AttachSuggestionDraftResponse, AttachSuggestionDraftResponses, CatalogEntry, Category, CheckedStepProblems, CheckRoutineRequest, CheckScheduledActionData, CheckScheduledActionError, CheckScheduledActionErrors, CheckScheduledActionResponse, CheckScheduledActionResponses, CheckSummary, ClientOptions, CodeIdentity, CodeStep, CodeUpgrade, ConditionResult, CreatedItem, CreatedRoutine, CreateScheduledActionData, CreateScheduledActionError, CreateScheduledActionErrors, CreateScheduledActionResponse, CreateScheduledActionResponses, DeleteScheduledActionData, DeleteScheduledActionError, DeleteScheduledActionErrors, DeleteScheduledActionResponse, DeleteScheduledActionResponses, DetachScheduledActionData, DetachScheduledActionError, DetachScheduledActionErrors, DetachScheduledActionResponse, DetachScheduledActionResponses, DiscardRoutineDraftJobData, DiscardRoutineDraftJobError, DiscardRoutineDraftJobErrors, DiscardRoutineDraftJobResponse, DiscardRoutineDraftJobResponses, DismissRoutineSuggestionData, DismissRoutineSuggestionError, DismissRoutineSuggestionErrors, DismissRoutineSuggestionResponse, DismissRoutineSuggestionResponses, DismissSuggestionData, DismissSuggestionError, DismissSuggestionErrors, DismissSuggestionResponse, DismissSuggestionResponses, Draft, DraftAsked, DraftContext, DraftCreated, DraftedRoutine, DraftedStep, DraftJob, DraftJobProgress, DraftJobState, DraftKind, DraftRequest, DraftRoutineData, DraftRoutineError, DraftRoutineErrors, DraftRoutineRequest, DraftRoutineResponse, DraftRoutineResponses, DraftStage, DraftUpdate, DraftUpdateState, EmptyResponse, EntityAction, EntityAppearance, EntityType, EventFilter, EventFilters, EventName, ExecuteScheduledActionNowData, ExecuteScheduledActionNowError, ExecuteScheduledActionNowErrors, ExecuteScheduledActionNowResponse, ExecuteScheduledActionNowResponses, ExecutionRecordResponse, ExecutionResource, ExecutionResourceType, ExecutionResult, FeedCounts, FoundName, FoundNames, GenerationOverview, GenerationStarted, GenerationState, GenerationStatus, GenerationTrigger, GetRoutineDraftJobData, GetRoutineDraftJobError, GetRoutineDraftJobErrors, GetRoutineDraftJobResponse, GetRoutineDraftJobResponses, GetScheduledActionData, GetScheduledActionError, GetScheduledActionErrors, GetScheduledActionResponse, GetScheduledActionResponses, GetScheduledActionTemplateData, GetScheduledActionTemplateError, GetScheduledActionTemplateErrors, GetScheduledActionTemplateResponse, GetScheduledActionTemplateResponses, GetSuggestionGenerationData, GetSuggestionGenerationError, GetSuggestionGenerationErrors, GetSuggestionGenerationResponse, GetSuggestionGenerationResponses, GithubSelector, InProgressExecution, ItemKind, KindName, KnobName, LeftName, ListRoutineDraftJobsData, ListRoutineDraftJobsError, ListRoutineDraftJobsErrors, ListRoutineDraftJobsResponse, ListRoutineDraftJobsResponses, ListRoutineSuggestionsData, ListRoutineSuggestionsError, ListRoutineSuggestionsErrors, ListRoutineSuggestionsResponse, ListRoutineSuggestionsResponses, ListScheduledActionCodeUpgradesData, ListScheduledActionCodeUpgradesError, ListScheduledActionCodeUpgradesErrors, ListScheduledActionCodeUpgradesResponse, ListScheduledActionCodeUpgradesResponses, ListScheduledActionHistoryData, ListScheduledActionHistoryError, ListScheduledActionHistoryErrors, ListScheduledActionHistoryResponse, ListScheduledActionHistoryResponses, ListScheduledActionsData, ListScheduledActionsError, ListScheduledActionsErrors, ListScheduledActionsResponse, ListScheduledActionsResponses, ListSuggestionsData, ListSuggestionsError, ListSuggestionsErrors, ListSuggestionsResponse, ListSuggestionsResponses, NamedItemKind, NewSuggestion, PayloadCondition, PayloadScalar, PropertySelector, RecordSuggestionsSeenData, RecordSuggestionsSeenError, RecordSuggestionsSeenErrors, RecordSuggestionsSeenResponse, RecordSuggestionsSeenResponses, RecordSuggestionsViewedData, RecordSuggestionsViewedError, RecordSuggestionsViewedErrors, RecordSuggestionsViewedResponse, RecordSuggestionsViewedResponses, RegenerateSuggestionsData, RegenerateSuggestionsError, RegenerateSuggestionsErrors, RegenerateSuggestionsResponse, RegenerateSuggestionsResponses, RegenerationCooldown, RegenerationRefusal, RegenerationRunning, RestoreSuggestionData, RestoreSuggestionError, RestoreSuggestionErrors, RestoreSuggestionResponse, RestoreSuggestionResponses, RetireRoutineSuggestionData, RetireRoutineSuggestionError, RetireRoutineSuggestionErrors, RetireRoutineSuggestionResponse, RetireRoutineSuggestionResponses, RetireSuggestion, RetireSuggestionData, RetireSuggestionError, RetireSuggestionErrors, RetireSuggestionRequest, RetireSuggestionResponse, RetireSuggestionResponses, ReviewedState, ReviewedSuggestion, ReviewRoutineSuggestionsData, ReviewRoutineSuggestionsError, ReviewRoutineSuggestionsErrors, ReviewRoutineSuggestionsResponse, ReviewRoutineSuggestionsResponses, ReviewSuggestionsData, ReviewSuggestionsError, ReviewSuggestionsErrors, ReviewSuggestionsResponse, ReviewSuggestionsResponses, RewriteSuggestion, RewriteSuggestionData, RewriteSuggestionError, RewriteSuggestionErrors, RewriteSuggestionResponse, RewriteSuggestionResponses, RoutineCatalogData, RoutineCatalogError, RoutineCatalogErrors, RoutineCatalogResponse, RoutineCatalogResponses, RoutineCheck, RoutineKnob, RoutineModelId, RoutineProgram, RoutineSentencePart, RoutineSoFar, RoutineStep, RoutineSuggestion, RoutineSuggestionCard, RoutineSuggestions, RoutineTask, RoutineTemplate, RoutineText, RoutineTrigger, RoutineTriggers, RunInfo, RunMode, RunStart, RunStateName, RunVisibility, Schedule, ScheduledAction, ScheduledActionHealthData, ScheduledActionHealthResponse, ScheduledActionHealthResponses, ScheduledActionResponse, ScheduledActionUpdate, SdkFingerprint, SetScheduledActionAppearanceData, SetScheduledActionAppearanceErrors, SetScheduledActionAppearanceResponse, SetScheduledActionAppearanceResponses, SetScheduledActionEnabled, SetScheduledActionEnabledData, SetScheduledActionEnabledError, SetScheduledActionEnabledErrors, SetScheduledActionEnabledResponse, SetScheduledActionEnabledResponses, ShareRoutineTemplate, ShareScheduledActionTemplateData, ShareScheduledActionTemplateError, ShareScheduledActionTemplateErrors, ShareScheduledActionTemplateResponse, ShareScheduledActionTemplateResponses, StartDraftJobRequest, StartRoutineDraftJobData, StartRoutineDraftJobError, StartRoutineDraftJobErrors, StartRoutineDraftJobResponse, StartRoutineDraftJobResponses, StartSuggestionGenerationData, StartSuggestionGenerationError, StartSuggestionGenerationErrors, StartSuggestionGenerationResponse, StartSuggestionGenerationResponses, StepId, StepKind, StepProblem, StepTitle, SubRoutine, SuggestedPick, Suggestion, SuggestionChanged, SuggestionDraft, SuggestionFeed, SuggestionFrom, SuggestionGenerationStatus, SuggestionKind, SuggestionReview, SuggestionRun, SuggestionsReview, SuggestionState, SuggestionStatus, SuggestionWriteOutcome, SuggestOutcome, SuggestRequest, SuggestRoutineData, SuggestRoutineError, SuggestRoutineErrors, SuggestRoutineResponse, SuggestRoutineResponses, Surface, Target, TemplateVariable, UnshareScheduledActionTemplateData, UnshareScheduledActionTemplateError, UnshareScheduledActionTemplateErrors, UnshareScheduledActionTemplateResponse, UnshareScheduledActionTemplateResponses, UpdateScheduledActionData, UpdateScheduledActionError, UpdateScheduledActionErrors, UpdateScheduledActionResponse, UpdateScheduledActionResponses, UpgradeOutcome, VariableFill } from './types.gen';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
|
|
2
|
-
import type { ActivateScheduledActionTemplateData, ActivateScheduledActionTemplateErrors, ActivateScheduledActionTemplateResponses, CreateScheduledActionData, CreateScheduledActionErrors, CreateScheduledActionResponses, DeleteScheduledActionData, DeleteScheduledActionErrors, DeleteScheduledActionResponses, DraftRoutineData, DraftRoutineErrors, DraftRoutineResponses, ExecuteScheduledActionNowData, ExecuteScheduledActionNowErrors, ExecuteScheduledActionNowResponses, GetScheduledActionData, GetScheduledActionErrors, GetScheduledActionResponses, GetScheduledActionTemplateData, GetScheduledActionTemplateErrors, GetScheduledActionTemplateResponses, ListScheduledActionCodeUpgradesData, ListScheduledActionCodeUpgradesErrors, ListScheduledActionCodeUpgradesResponses, ListScheduledActionHistoryData, ListScheduledActionHistoryErrors, ListScheduledActionHistoryResponses, ListScheduledActionsData, ListScheduledActionsErrors, ListScheduledActionsResponses,
|
|
2
|
+
import type { AcceptSuggestionData, AcceptSuggestionErrors, AcceptSuggestionResponses, ActivateScheduledActionTemplateData, ActivateScheduledActionTemplateErrors, ActivateScheduledActionTemplateResponses, AddSuggestionData, AddSuggestionErrors, AddSuggestionResponses, AttachSuggestionDraftData, AttachSuggestionDraftErrors, AttachSuggestionDraftResponses, CheckScheduledActionData, CheckScheduledActionErrors, CheckScheduledActionResponses, CreateScheduledActionData, CreateScheduledActionErrors, CreateScheduledActionResponses, DeleteScheduledActionData, DeleteScheduledActionErrors, DeleteScheduledActionResponses, DetachScheduledActionData, DetachScheduledActionErrors, DetachScheduledActionResponses, DiscardRoutineDraftJobData, DiscardRoutineDraftJobErrors, DiscardRoutineDraftJobResponses, DismissRoutineSuggestionData, DismissRoutineSuggestionErrors, DismissRoutineSuggestionResponses, DismissSuggestionData, DismissSuggestionErrors, DismissSuggestionResponses, DraftRoutineData, DraftRoutineErrors, DraftRoutineResponses, ExecuteScheduledActionNowData, ExecuteScheduledActionNowErrors, ExecuteScheduledActionNowResponses, GetRoutineDraftJobData, GetRoutineDraftJobErrors, GetRoutineDraftJobResponses, GetScheduledActionData, GetScheduledActionErrors, GetScheduledActionResponses, GetScheduledActionTemplateData, GetScheduledActionTemplateErrors, GetScheduledActionTemplateResponses, GetSuggestionGenerationData, GetSuggestionGenerationErrors, GetSuggestionGenerationResponses, ListRoutineDraftJobsData, ListRoutineDraftJobsErrors, ListRoutineDraftJobsResponses, ListRoutineSuggestionsData, ListRoutineSuggestionsErrors, ListRoutineSuggestionsResponses, ListScheduledActionCodeUpgradesData, ListScheduledActionCodeUpgradesErrors, ListScheduledActionCodeUpgradesResponses, ListScheduledActionHistoryData, ListScheduledActionHistoryErrors, ListScheduledActionHistoryResponses, ListScheduledActionsData, ListScheduledActionsErrors, ListScheduledActionsResponses, ListSuggestionsData, ListSuggestionsErrors, ListSuggestionsResponses, RecordSuggestionsSeenData, RecordSuggestionsSeenErrors, RecordSuggestionsSeenResponses, RecordSuggestionsViewedData, RecordSuggestionsViewedErrors, RecordSuggestionsViewedResponses, RegenerateSuggestionsData, RegenerateSuggestionsErrors, RegenerateSuggestionsResponses, RestoreSuggestionData, RestoreSuggestionErrors, RestoreSuggestionResponses, RetireRoutineSuggestionData, RetireRoutineSuggestionErrors, RetireRoutineSuggestionResponses, RetireSuggestionData, RetireSuggestionErrors, RetireSuggestionResponses, ReviewRoutineSuggestionsData, ReviewRoutineSuggestionsErrors, ReviewRoutineSuggestionsResponses, ReviewSuggestionsData, ReviewSuggestionsErrors, ReviewSuggestionsResponses, RewriteSuggestionData, RewriteSuggestionErrors, RewriteSuggestionResponses, RoutineCatalogData, RoutineCatalogErrors, RoutineCatalogResponses, ScheduledActionHealthData, ScheduledActionHealthResponses, SetScheduledActionAppearanceData, SetScheduledActionAppearanceErrors, SetScheduledActionAppearanceResponses, SetScheduledActionEnabledData, SetScheduledActionEnabledErrors, SetScheduledActionEnabledResponses, ShareScheduledActionTemplateData, ShareScheduledActionTemplateErrors, ShareScheduledActionTemplateResponses, StartRoutineDraftJobData, StartRoutineDraftJobErrors, StartRoutineDraftJobResponses, StartSuggestionGenerationData, StartSuggestionGenerationErrors, StartSuggestionGenerationResponses, SuggestRoutineData, SuggestRoutineErrors, SuggestRoutineResponses, UnshareScheduledActionTemplateData, UnshareScheduledActionTemplateErrors, UnshareScheduledActionTemplateResponses, UpdateScheduledActionData, UpdateScheduledActionErrors, UpdateScheduledActionResponses } from './types.gen';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -33,13 +33,51 @@ export declare class Sdk extends HeyApiClient {
|
|
|
33
33
|
});
|
|
34
34
|
scheduledActionHealth<ThrowOnError extends boolean = false>(options?: Options<ScheduledActionHealthData, ThrowOnError>): RequestResult<ScheduledActionHealthResponses, unknown, ThrowOnError>;
|
|
35
35
|
listScheduledActions<ThrowOnError extends boolean = false>(options?: Options<ListScheduledActionsData, ThrowOnError>): RequestResult<ListScheduledActionsResponses, ListScheduledActionsErrors, ThrowOnError>;
|
|
36
|
+
/**
|
|
37
|
+
* Create a routine. A create made by a routine's run, from its code step
|
|
38
|
+
* or its Ask AI step's session, makes that routine's sub-routine: the
|
|
39
|
+
* caller's credential says so, never the body.
|
|
40
|
+
*/
|
|
36
41
|
createScheduledAction<ThrowOnError extends boolean = false>(options: Options<CreateScheduledActionData, ThrowOnError>): RequestResult<CreateScheduledActionResponses, CreateScheduledActionErrors, ThrowOnError>;
|
|
37
|
-
|
|
42
|
+
routineCatalog<ThrowOnError extends boolean = false>(options: Options<RoutineCatalogData, ThrowOnError>): RequestResult<RoutineCatalogResponses, RoutineCatalogErrors, ThrowOnError>;
|
|
43
|
+
/**
|
|
44
|
+
* What saving this routine would find wrong, without saving it: the same
|
|
45
|
+
* checks as creating it. A routine draft's session hands its draft back
|
|
46
|
+
* this way.
|
|
47
|
+
*/
|
|
48
|
+
checkScheduledAction<ThrowOnError extends boolean = false>(options: Options<CheckScheduledActionData, ThrowOnError>): RequestResult<CheckScheduledActionResponses, CheckScheduledActionErrors, ThrowOnError>;
|
|
49
|
+
listRoutineDraftJobs<ThrowOnError extends boolean = false>(options?: Options<ListRoutineDraftJobsData, ThrowOnError>): RequestResult<ListRoutineDraftJobsResponses, ListRoutineDraftJobsErrors, ThrowOnError>;
|
|
50
|
+
startRoutineDraftJob<ThrowOnError extends boolean = false>(options: Options<StartRoutineDraftJobData, ThrowOnError>): RequestResult<StartRoutineDraftJobResponses, StartRoutineDraftJobErrors, ThrowOnError>;
|
|
51
|
+
discardRoutineDraftJob<ThrowOnError extends boolean = false>(options: Options<DiscardRoutineDraftJobData, ThrowOnError>): RequestResult<DiscardRoutineDraftJobResponses, DiscardRoutineDraftJobErrors, ThrowOnError>;
|
|
52
|
+
getRoutineDraftJob<ThrowOnError extends boolean = false>(options: Options<GetRoutineDraftJobData, ThrowOnError>): RequestResult<GetRoutineDraftJobResponses, GetRoutineDraftJobErrors, ThrowOnError>;
|
|
38
53
|
draftRoutine<ThrowOnError extends boolean = false>(options: Options<DraftRoutineData, ThrowOnError>): RequestResult<DraftRoutineResponses, DraftRoutineErrors, ThrowOnError>;
|
|
54
|
+
listRoutineSuggestions<ThrowOnError extends boolean = false>(options?: Options<ListRoutineSuggestionsData, ThrowOnError>): RequestResult<ListRoutineSuggestionsResponses, ListRoutineSuggestionsErrors, ThrowOnError>;
|
|
55
|
+
/**
|
|
56
|
+
* Hand back one routine suggestion from a routine suggestion session, the
|
|
57
|
+
* way a draft's session checks its routine: a catalog routine with knob
|
|
58
|
+
* values, or a drafted routine, checked as saving checks it.
|
|
59
|
+
*/
|
|
60
|
+
suggestRoutine<ThrowOnError extends boolean = false>(options: Options<SuggestRoutineData, ThrowOnError>): RequestResult<SuggestRoutineResponses, SuggestRoutineErrors, ThrowOnError>;
|
|
61
|
+
/**
|
|
62
|
+
* What a routines generation session reads before managing suggestions.
|
|
63
|
+
*/
|
|
64
|
+
reviewRoutineSuggestions<ThrowOnError extends boolean = false>(options?: Options<ReviewRoutineSuggestionsData, ThrowOnError>): RequestResult<ReviewRoutineSuggestionsResponses, ReviewRoutineSuggestionsErrors, ThrowOnError>;
|
|
65
|
+
dismissRoutineSuggestion<ThrowOnError extends boolean = false>(options: Options<DismissRoutineSuggestionData, ThrowOnError>): RequestResult<DismissRoutineSuggestionResponses, DismissRoutineSuggestionErrors, ThrowOnError>;
|
|
66
|
+
/**
|
|
67
|
+
* Retire an open suggestion that no longer fits, from a routines
|
|
68
|
+
* generation session.
|
|
69
|
+
*/
|
|
70
|
+
retireRoutineSuggestion<ThrowOnError extends boolean = false>(options: Options<RetireRoutineSuggestionData, ThrowOnError>): RequestResult<RetireRoutineSuggestionResponses, RetireRoutineSuggestionErrors, ThrowOnError>;
|
|
39
71
|
deleteScheduledAction<ThrowOnError extends boolean = false>(options: Options<DeleteScheduledActionData, ThrowOnError>): RequestResult<DeleteScheduledActionResponses, DeleteScheduledActionErrors, ThrowOnError>;
|
|
40
72
|
getScheduledAction<ThrowOnError extends boolean = false>(options: Options<GetScheduledActionData, ThrowOnError>): RequestResult<GetScheduledActionResponses, GetScheduledActionErrors, ThrowOnError>;
|
|
41
73
|
updateScheduledAction<ThrowOnError extends boolean = false>(options: Options<UpdateScheduledActionData, ThrowOnError>): RequestResult<UpdateScheduledActionResponses, UpdateScheduledActionErrors, ThrowOnError>;
|
|
74
|
+
setScheduledActionAppearance<ThrowOnError extends boolean = false>(options: Options<SetScheduledActionAppearanceData, ThrowOnError>): RequestResult<SetScheduledActionAppearanceResponses, SetScheduledActionAppearanceErrors, ThrowOnError>;
|
|
42
75
|
listScheduledActionCodeUpgrades<ThrowOnError extends boolean = false>(options: Options<ListScheduledActionCodeUpgradesData, ThrowOnError>): RequestResult<ListScheduledActionCodeUpgradesResponses, ListScheduledActionCodeUpgradesErrors, ThrowOnError>;
|
|
76
|
+
/**
|
|
77
|
+
* Keep a sub-routine as the owner's own routine: it moves to the main list
|
|
78
|
+
* and no longer follows the routine whose run created it.
|
|
79
|
+
*/
|
|
80
|
+
detachScheduledAction<ThrowOnError extends boolean = false>(options: Options<DetachScheduledActionData, ThrowOnError>): RequestResult<DetachScheduledActionResponses, DetachScheduledActionErrors, ThrowOnError>;
|
|
43
81
|
setScheduledActionEnabled<ThrowOnError extends boolean = false>(options: Options<SetScheduledActionEnabledData, ThrowOnError>): RequestResult<SetScheduledActionEnabledResponses, SetScheduledActionEnabledErrors, ThrowOnError>;
|
|
44
82
|
executeScheduledActionNow<ThrowOnError extends boolean = false>(options: Options<ExecuteScheduledActionNowData, ThrowOnError>): RequestResult<ExecuteScheduledActionNowResponses, ExecuteScheduledActionNowErrors, ThrowOnError>;
|
|
45
83
|
listScheduledActionHistory<ThrowOnError extends boolean = false>(options: Options<ListScheduledActionHistoryData, ThrowOnError>): RequestResult<ListScheduledActionHistoryResponses, ListScheduledActionHistoryErrors, ThrowOnError>;
|
|
@@ -47,5 +85,72 @@ export declare class Sdk extends HeyApiClient {
|
|
|
47
85
|
getScheduledActionTemplate<ThrowOnError extends boolean = false>(options: Options<GetScheduledActionTemplateData, ThrowOnError>): RequestResult<GetScheduledActionTemplateResponses, GetScheduledActionTemplateErrors, ThrowOnError>;
|
|
48
86
|
shareScheduledActionTemplate<ThrowOnError extends boolean = false>(options: Options<ShareScheduledActionTemplateData, ThrowOnError>): RequestResult<ShareScheduledActionTemplateResponses, ShareScheduledActionTemplateErrors, ThrowOnError>;
|
|
49
87
|
activateScheduledActionTemplate<ThrowOnError extends boolean = false>(options: Options<ActivateScheduledActionTemplateData, ThrowOnError>): RequestResult<ActivateScheduledActionTemplateResponses, ActivateScheduledActionTemplateErrors, ThrowOnError>;
|
|
88
|
+
/**
|
|
89
|
+
* The caller's feed, for them or their own agent.
|
|
90
|
+
*/
|
|
91
|
+
listSuggestions<ThrowOnError extends boolean = false>(options?: Options<ListSuggestionsData, ThrowOnError>): RequestResult<ListSuggestionsResponses, ListSuggestionsErrors, ThrowOnError>;
|
|
92
|
+
/**
|
|
93
|
+
* Add a suggestion from a suggestions generation session, or a new version of the
|
|
94
|
+
* one with its dedup key.
|
|
95
|
+
*/
|
|
96
|
+
addSuggestion<ThrowOnError extends boolean = false>(options: Options<AddSuggestionData, ThrowOnError>): RequestResult<AddSuggestionResponses, AddSuggestionErrors, ThrowOnError>;
|
|
97
|
+
/**
|
|
98
|
+
* Start the caller's onboarding generation, once their inbox is connected.
|
|
99
|
+
*/
|
|
100
|
+
startSuggestionGeneration<ThrowOnError extends boolean = false>(options: Options<StartSuggestionGenerationData, ThrowOnError>): RequestResult<StartSuggestionGenerationResponses, StartSuggestionGenerationErrors, ThrowOnError>;
|
|
101
|
+
/**
|
|
102
|
+
* The caller's suggestion generations now.
|
|
103
|
+
*/
|
|
104
|
+
getSuggestionGeneration<ThrowOnError extends boolean = false>(options?: Options<GetSuggestionGenerationData, ThrowOnError>): RequestResult<GetSuggestionGenerationResponses, GetSuggestionGenerationErrors, ThrowOnError>;
|
|
105
|
+
/**
|
|
106
|
+
* Start fresh suggestions for the caller: at most once an hour, and not
|
|
107
|
+
* while one of their generations runs.
|
|
108
|
+
*/
|
|
109
|
+
regenerateSuggestions<ThrowOnError extends boolean = false>(options: Options<RegenerateSuggestionsData, ThrowOnError>): RequestResult<RegenerateSuggestionsResponses, RegenerateSuggestionsErrors, ThrowOnError>;
|
|
110
|
+
/**
|
|
111
|
+
* What a suggestions generation session reads before managing suggestions.
|
|
112
|
+
*/
|
|
113
|
+
reviewSuggestions<ThrowOnError extends boolean = false>(options?: Options<ReviewSuggestionsData, ThrowOnError>): RequestResult<ReviewSuggestionsResponses, ReviewSuggestionsErrors, ThrowOnError>;
|
|
114
|
+
/**
|
|
115
|
+
* The caller loaded the app in their time zone.
|
|
116
|
+
*/
|
|
117
|
+
recordSuggestionsSeen<ThrowOnError extends boolean = false>(options: Options<RecordSuggestionsSeenData, ThrowOnError>): RequestResult<RecordSuggestionsSeenResponses, RecordSuggestionsSeenErrors, ThrowOnError>;
|
|
118
|
+
/**
|
|
119
|
+
* The caller opened their feed: what it showed as new no longer is. The app
|
|
120
|
+
* sends it once the feed is on screen.
|
|
121
|
+
*/
|
|
122
|
+
recordSuggestionsViewed<ThrowOnError extends boolean = false>(options?: Options<RecordSuggestionsViewedData, ThrowOnError>): RequestResult<RecordSuggestionsViewedResponses, RecordSuggestionsViewedErrors, ThrowOnError>;
|
|
123
|
+
/**
|
|
124
|
+
* Change an open suggestion from a suggestions generation session.
|
|
125
|
+
*/
|
|
126
|
+
rewriteSuggestion<ThrowOnError extends boolean = false>(options: Options<RewriteSuggestionData, ThrowOnError>): RequestResult<RewriteSuggestionResponses, RewriteSuggestionErrors, ThrowOnError>;
|
|
127
|
+
/**
|
|
128
|
+
* The caller, or someone acting for them, acts on a suggestion: a background
|
|
129
|
+
* prompt suggestion starts its run when the person accepts it in the app (anyone
|
|
130
|
+
* else only takes it on); a reply suggestion is only taken on, and is done once
|
|
131
|
+
* the person replies on its item; any other note or prompt is done once they act
|
|
132
|
+
* on it (open its item or the composer), and shows in the feed's `done`. A
|
|
133
|
+
* routine suggestion is refused: the person saves its routine in the app, which
|
|
134
|
+
* makes it done.
|
|
135
|
+
*/
|
|
136
|
+
acceptSuggestion<ThrowOnError extends boolean = false>(options: Options<AcceptSuggestionData, ThrowOnError>): RequestResult<AcceptSuggestionResponses, AcceptSuggestionErrors, ThrowOnError>;
|
|
137
|
+
/**
|
|
138
|
+
* The caller, or their own agent, isn't interested in an open suggestion.
|
|
139
|
+
*/
|
|
140
|
+
dismissSuggestion<ThrowOnError extends boolean = false>(options: Options<DismissSuggestionData, ThrowOnError>): RequestResult<DismissSuggestionResponses, DismissSuggestionErrors, ThrowOnError>;
|
|
141
|
+
/**
|
|
142
|
+
* Make a reply draft a suggestions generation session wrote the draft of an
|
|
143
|
+
* open reply suggestion. Nothing is sent.
|
|
144
|
+
*/
|
|
145
|
+
attachSuggestionDraft<ThrowOnError extends boolean = false>(options: Options<AttachSuggestionDraftData, ThrowOnError>): RequestResult<AttachSuggestionDraftResponses, AttachSuggestionDraftErrors, ThrowOnError>;
|
|
146
|
+
/**
|
|
147
|
+
* The caller, or their own agent, takes back dismissing a suggestion, within
|
|
148
|
+
* five minutes of it.
|
|
149
|
+
*/
|
|
150
|
+
restoreSuggestion<ThrowOnError extends boolean = false>(options: Options<RestoreSuggestionData, ThrowOnError>): RequestResult<RestoreSuggestionResponses, RestoreSuggestionErrors, ThrowOnError>;
|
|
151
|
+
/**
|
|
152
|
+
* Retire an open suggestion from a suggestions generation session.
|
|
153
|
+
*/
|
|
154
|
+
retireSuggestion<ThrowOnError extends boolean = false>(options: Options<RetireSuggestionData, ThrowOnError>): RequestResult<RetireSuggestionResponses, RetireSuggestionErrors, ThrowOnError>;
|
|
50
155
|
}
|
|
51
156
|
export {};
|