@macro-inc/sdk 0.0.1 → 0.2.2
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 +628 -21
- package/dist/{chunk-5HAKQN23.js → chunk-7LVVPVNT.js} +70 -57
- package/dist/{chunk-JXIQT5TH.js → chunk-7YJ6Y7HJ.js} +234 -16
- package/dist/chunk-LMJW65ML.js +836 -0
- package/dist/{chunk-SGAHIERJ.js → chunk-OGE7WXJE.js} +16 -0
- package/dist/chunk-PRUFPW3B.js +943 -0
- package/dist/{chunk-CTKR64MY.js → chunk-QVBNNMQS.js} +242 -367
- package/dist/{chunk-QNUS5BC5.js → chunk-SUINKDXF.js} +30 -84
- package/dist/{chunk-77EI4LSQ.js → chunk-ZQXOHNDB.js} +1518 -386
- 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 +174 -4
- package/dist/generated/agent-harness/types.gen.d.ts +2511 -189
- 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 +106 -8
- package/dist/generated/auth/types.gen.d.ts +1473 -116
- package/dist/generated/calendar/client/client.gen.d.ts +2 -0
- package/dist/generated/calendar/client/index.d.ts +10 -0
- package/dist/generated/calendar/client/types.gen.d.ts +120 -0
- package/dist/generated/calendar/client/utils.gen.d.ts +37 -0
- package/dist/generated/calendar/client.gen.d.ts +12 -0
- package/dist/generated/calendar/core/auth.gen.d.ts +25 -0
- package/dist/generated/calendar/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/calendar/core/params.gen.d.ts +43 -0
- package/dist/generated/calendar/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/calendar/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/calendar/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/calendar/core/types.gen.d.ts +83 -0
- package/dist/generated/calendar/core/utils.gen.d.ts +19 -0
- package/dist/generated/calendar/index.d.ts +2 -0
- package/dist/generated/calendar/index.js +6 -0
- package/dist/generated/calendar/sdk.gen.d.ts +95 -0
- package/dist/generated/calendar/types.gen.d.ts +1091 -0
- 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 +6 -1
- package/dist/generated/cognition/types.gen.d.ts +304 -36
- package/dist/generated/connection/types.gen.d.ts +1 -1
- package/dist/generated/email/index.d.ts +1 -1
- package/dist/generated/email/index.js +1 -1
- package/dist/generated/email/sdk.gen.d.ts +32 -27
- package/dist/generated/email/types.gen.d.ts +586 -409
- package/dist/generated/notification/index.d.ts +1 -1
- package/dist/generated/notification/types.gen.d.ts +384 -19
- package/dist/generated/properties/types.gen.d.ts +8 -5
- package/dist/generated/scheduled-action/index.d.ts +1 -1
- package/dist/generated/scheduled-action/index.js +3 -842
- package/dist/generated/scheduled-action/sdk.gen.d.ts +3 -1
- package/dist/generated/scheduled-action/types.gen.d.ts +277 -41
- package/dist/generated/search/index.d.ts +1 -1
- package/dist/generated/search/types.gen.d.ts +262 -43
- 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 +678 -107
- package/dist/generated/storage/types.gen.d.ts +14827 -5995
- package/dist/generated/unfurl/index.d.ts +1 -1
- package/dist/generated/unfurl/index.js +3 -832
- package/dist/generated/unfurl/types.gen.d.ts +20 -0
- package/dist/src/config.d.ts +33 -13
- package/dist/src/entities/agent-sessions/agent-session.d.ts +150 -6
- package/dist/src/entities/agent-sessions/code-execution.d.ts +43 -0
- package/dist/src/entities/agent-sessions/conversation.d.ts +54 -0
- package/dist/src/entities/agent-sessions/namespace.d.ts +23 -5
- package/dist/src/entities/agent-sessions/queued-action.d.ts +46 -0
- package/dist/src/entities/agent-sessions/review.d.ts +107 -0
- package/dist/src/entities/agent-sessions/tool-approval.d.ts +21 -0
- package/dist/src/entities/agents/agent.d.ts +47 -0
- package/dist/src/entities/agents/namespace.d.ts +13 -0
- package/dist/src/entities/ai/namespace.d.ts +24 -0
- package/dist/src/entities/api-keys/api-key.d.ts +17 -0
- package/dist/src/entities/api-keys/namespace.d.ts +18 -0
- package/dist/src/entities/calendar/calendar.d.ts +35 -0
- package/dist/src/entities/calendar/event.d.ts +123 -0
- package/dist/src/entities/calendar/event.test.d.ts +1 -0
- package/dist/src/entities/calendar/namespace.d.ts +111 -0
- package/dist/src/entities/calendar/replacement.d.ts +15 -0
- package/dist/src/entities/calls/call-record.d.ts +62 -6
- package/dist/src/entities/calls/message.d.ts +33 -0
- package/dist/src/entities/channels/activity.d.ts +24 -0
- package/dist/src/entities/channels/channel.d.ts +44 -3
- package/dist/src/entities/channels/labels.d.ts +39 -0
- package/dist/src/entities/channels/message.d.ts +9 -17
- package/dist/src/entities/channels/namespace.d.ts +6 -0
- package/dist/src/entities/channels/picture.d.ts +11 -0
- package/dist/src/entities/channels/post.d.ts +1 -1
- package/dist/src/entities/channels/thread.d.ts +5 -0
- package/dist/src/entities/chats/chat.d.ts +11 -1
- package/dist/src/entities/chats/generation.d.ts +46 -0
- package/dist/src/entities/crm/comment.d.ts +55 -34
- package/dist/src/entities/crm/company.d.ts +42 -10
- package/dist/src/entities/crm/contact.d.ts +42 -10
- package/dist/src/entities/crm/namespace.d.ts +18 -1
- package/dist/src/entities/crm/pipeline.d.ts +122 -0
- package/dist/src/entities/crm/pipelines.d.ts +14 -0
- package/dist/src/entities/databases/column.d.ts +75 -0
- package/dist/src/entities/databases/database.d.ts +272 -0
- package/dist/src/entities/databases/namespace.d.ts +21 -0
- package/dist/src/entities/databases/query.d.ts +86 -0
- package/dist/src/entities/databases/row.d.ts +27 -0
- package/dist/src/entities/databases/table.d.ts +61 -0
- package/dist/src/entities/databases/view.d.ts +40 -0
- package/dist/src/entities/databases/webhook.d.ts +32 -0
- package/dist/src/entities/documents/anchor.d.ts +29 -0
- package/dist/src/entities/documents/comment.d.ts +25 -22
- package/dist/src/entities/documents/document.d.ts +60 -12
- package/dist/src/entities/documents/namespace.d.ts +30 -0
- package/dist/src/entities/documents/version.d.ts +22 -0
- package/dist/src/entities/email/draft.d.ts +79 -0
- package/dist/src/entities/email/filter.d.ts +34 -0
- package/dist/src/entities/email/link.d.ts +6 -4
- package/dist/src/entities/email/message.d.ts +12 -1
- package/dist/src/entities/email/namespace.d.ts +34 -1
- package/dist/src/entities/email/thread.d.ts +23 -1
- package/dist/src/entities/entity-mentions/mention.d.ts +16 -0
- package/dist/src/entities/entity-mentions/namespace.d.ts +12 -0
- package/dist/src/entities/entity.d.ts +7 -0
- package/dist/src/entities/favorites/namespace.d.ts +14 -2
- package/dist/src/entities/foreign/foreign-entity.d.ts +2 -0
- package/dist/src/entities/foreign/namespace.d.ts +40 -0
- package/dist/src/entities/forms/form.d.ts +227 -0
- package/dist/src/entities/forms/namespace.d.ts +18 -0
- package/dist/src/entities/forms/question.d.ts +37 -0
- package/dist/src/entities/forms/response.d.ts +32 -0
- package/dist/src/entities/forms/section.d.ts +19 -0
- package/dist/src/entities/github-pull-requests/namespace.d.ts +12 -0
- package/dist/src/entities/github-pull-requests/pull-request.d.ts +52 -0
- package/dist/src/entities/harnesses/harness.d.ts +19 -0
- package/dist/src/entities/harnesses/namespace.d.ts +33 -0
- package/dist/src/entities/harnesses/pairing.d.ts +39 -0
- package/dist/src/entities/initiatives/initiative.d.ts +50 -0
- package/dist/src/entities/initiatives/namespace.d.ts +13 -0
- package/dist/src/entities/meetings/meeting.d.ts +38 -0
- package/dist/src/entities/meetings/namespace.d.ts +18 -0
- package/dist/src/entities/messages/thread.d.ts +101 -0
- package/dist/src/entities/notifications/notification.d.ts +6 -3
- package/dist/src/entities/notifications/notification.test.d.ts +1 -0
- package/dist/src/entities/projects/project.d.ts +7 -0
- package/dist/src/entities/reference.d.ts +82 -0
- package/dist/src/entities/routines/namespace.d.ts +15 -0
- package/dist/src/entities/routines/routine.d.ts +115 -0
- package/dist/src/entities/sharing/access.d.ts +65 -0
- package/dist/src/entities/sharing/permissions.d.ts +13 -0
- package/dist/src/entities/tasks/namespace.d.ts +4 -0
- package/dist/src/entities/tasks/task.d.ts +6 -0
- package/dist/src/entities/unfurls/namespace.d.ts +10 -0
- package/dist/src/entities/webhooks/webhook.d.ts +3 -1
- package/dist/src/entities/workspace/items.d.ts +7 -0
- package/dist/src/entities/workspace/namespace.d.ts +83 -0
- package/dist/src/entities/workspace/query.d.ts +12 -0
- package/dist/src/entities/workspace/types.d.ts +96 -0
- package/dist/src/events/hydrate/agentSession.d.ts +192 -0
- package/dist/src/events/hydrate/channel.d.ts +2 -39
- package/dist/src/events/hydrate/message.d.ts +70 -0
- package/dist/src/events/receiver.d.ts +57 -19
- package/dist/src/events/types.d.ts +3 -1
- package/dist/src/macro.d.ts +80 -3
- package/dist/src/macro.js +8832 -2784
- package/dist/src/utils/activity.d.ts +11 -0
- package/dist/src/utils/activity.test.d.ts +1 -0
- package/dist/src/utils/client.d.ts +10 -1
- package/dist/src/utils/concurrency.d.ts +5 -0
- package/dist/src/utils/index.d.ts +1 -0
- package/dist/src/utils/pagination.d.ts +9 -4
- package/package.json +11 -3
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export { type Options, Sdk } from './sdk.gen';
|
|
2
|
-
export type { AiResponseMetadata, ApiUserNotification, BulkDeleteUserNotificationsV2Data, BulkDeleteUserNotificationsV2Error, BulkDeleteUserNotificationsV2Errors, BulkDeleteUserNotificationsV2Responses, BulkGetByEventItemIdsRequest, BulkGetTypedNotificationsByEventItemIdsData, BulkGetTypedNotificationsByEventItemIdsError, BulkGetTypedNotificationsByEventItemIdsErrors, BulkGetTypedNotificationsByEventItemIdsResponse, BulkGetTypedNotificationsByEventItemIdsResponses, BulkMarkNotificationsDoneData, BulkMarkNotificationsDoneError, BulkMarkNotificationsDoneErrors, BulkMarkNotificationsDoneResponses, BulkMarkNotificationsSeenData, BulkMarkNotificationsSeenError, BulkMarkNotificationsSeenErrors, BulkMarkNotificationsSeenResponses, BulkMarkNotificationsUndoneData, BulkMarkNotificationsUndoneError, BulkMarkNotificationsUndoneErrors, BulkMarkNotificationsUndoneResponses, CalendarEventReminderMetadata, CallStartedMetadata, ChannelInviteMetadata, ChannelMentionMetadata, ChannelMessageSendMetadata, ChannelReplyMetadata, ChannelType, ClientOptions, CommentedOnDocumentMetadata, CommonChannelMetadata, ConnGatewayNotificationPayload, CreateNotification, DeleteUserNotificationV2Data, DeleteUserNotificationV2Error, DeleteUserNotificationV2Errors, DeleteUserNotificationV2Responses, DeviceRequest, DeviceType, DisableNotificationTypeData, DisableNotificationTypeError, DisableNotificationTypeErrors, DisableNotificationTypeResponses, DocumentMentionMetadata, EmptyResponse, EnableNotificationTypeData, EnableNotificationTypeError, EnableNotificationTypeErrors, EnableNotificationTypeResponses, Entity, EntityType, ErrorResponse, 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, InviteToTeamMetadata, ItemSharedMetadata, ListTypedNotificationsData, ListTypedNotificationsError, ListTypedNotificationsErrors, ListTypedNotificationsResponse, ListTypedNotificationsResponses, MacroUserIdStr, MentionedInDocumentCommentMetadata, NewEmailMetadata, NotifEvent, NotificationBulkRequest, NotificationDocumentSubType, NotificationServiceApiVersion, NotificationTypeName, PushNotificationData, RealtimeNotifTaggedContentValue, ReminderMetadata, RemoveUnsubscribeAllData, RemoveUnsubscribeAllError, RemoveUnsubscribeAllErrors, RemoveUnsubscribeAllResponse, RemoveUnsubscribeAllResponses, RemoveUnsubscribeItemData, RemoveUnsubscribeItemError, RemoveUnsubscribeItemErrors, RemoveUnsubscribeItemResponse, RemoveUnsubscribeItemResponses, RepliedToDocumentCommentThreadMetadata, TaskAssignedMetadata, UnsubscribeAllData, UnsubscribeAllError, UnsubscribeAllErrors, UnsubscribeAllResponse, UnsubscribeAllResponses, UnsubscribeEmailData, UnsubscribeEmailError, UnsubscribeEmailErrors, UnsubscribeEmailResponse, UnsubscribeEmailResponses, UnsubscribeItemData, UnsubscribeItemError, UnsubscribeItemErrors, UnsubscribeItemPathParams, UnsubscribeItemResponse, UnsubscribeItemResponses, UserUnsubscribe } from './types.gen';
|
|
2
|
+
export type { AgentSessionMentionedMetadata, AgentSessionNotificationRef, AgentSessionOriginParent, AgentSessionSettledMetadata, AgentSessionWaitingForInputMetadata, AiResponseMetadata, ApiUserNotification, BulkDeleteUserNotificationsV2Data, BulkDeleteUserNotificationsV2Error, BulkDeleteUserNotificationsV2Errors, BulkDeleteUserNotificationsV2Responses, BulkGetByEventItemIdsRequest, BulkGetTypedNotificationsByEventItemIdsData, BulkGetTypedNotificationsByEventItemIdsError, BulkGetTypedNotificationsByEventItemIdsErrors, BulkGetTypedNotificationsByEventItemIdsResponse, BulkGetTypedNotificationsByEventItemIdsResponses, BulkMarkNotificationsDoneData, BulkMarkNotificationsDoneError, BulkMarkNotificationsDoneErrors, BulkMarkNotificationsDoneResponses, BulkMarkNotificationsSeenData, BulkMarkNotificationsSeenError, BulkMarkNotificationsSeenErrors, BulkMarkNotificationsSeenResponses, BulkMarkNotificationsUndoneData, BulkMarkNotificationsUndoneError, BulkMarkNotificationsUndoneErrors, BulkMarkNotificationsUndoneResponses, CalendarEventReminderMetadata, CallStartedMetadata, 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, 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, InviteToTeamMetadata, ItemSharedMetadata, ListTypedNotificationsData, ListTypedNotificationsError, ListTypedNotificationsErrors, ListTypedNotificationsResponse, ListTypedNotificationsResponses, MacroUserIdStr, MentionedInDocumentCommentMetadata, NewEmailMetadata, NotifEvent, NotificationBulkRequest, NotificationDocumentSubType, NotificationServiceApiVersion, NotificationState, NotificationTypeName, PushNotificationData, RealtimeNotifTaggedContentValue, ReminderMetadata, RemoveUnsubscribeAllData, RemoveUnsubscribeAllError, RemoveUnsubscribeAllErrors, RemoveUnsubscribeAllResponse, RemoveUnsubscribeAllResponses, RemoveUnsubscribeItemData, RemoveUnsubscribeItemError, RemoveUnsubscribeItemErrors, RemoveUnsubscribeItemResponse, RemoveUnsubscribeItemResponses, RepliedToDocumentCommentThreadMetadata, RequestedAccessLevel, TaskAssignedMetadata, UnsubscribeAllData, UnsubscribeAllError, UnsubscribeAllErrors, UnsubscribeAllResponse, UnsubscribeAllResponses, UnsubscribeEmailData, UnsubscribeEmailError, UnsubscribeEmailErrors, UnsubscribeEmailResponse, UnsubscribeEmailResponses, UnsubscribeItemData, UnsubscribeItemError, UnsubscribeItemErrors, UnsubscribeItemPathParams, UnsubscribeItemResponse, UnsubscribeItemResponses, UserUnsubscribe } from './types.gen';
|
|
@@ -1,6 +1,109 @@
|
|
|
1
1
|
export type ClientOptions = {
|
|
2
2
|
baseUrl: `${string}://${string}` | (string & {});
|
|
3
3
|
};
|
|
4
|
+
/**
|
|
5
|
+
* Someone named the recipient in a prompt to an agent session.
|
|
6
|
+
*/
|
|
7
|
+
export type AgentSessionMentionedMetadata = AgentSessionNotificationRef & {
|
|
8
|
+
/**
|
|
9
|
+
* The action carrying the prompt.
|
|
10
|
+
*/
|
|
11
|
+
actionId: string;
|
|
12
|
+
/**
|
|
13
|
+
* Who wrote the prompt, absent when a bot acted on nobody's behalf.
|
|
14
|
+
*/
|
|
15
|
+
mentionedBy?: string | null;
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* Flattened into each agent-session kind so the wire keeps these keys at the
|
|
19
|
+
* top level of the metadata, the way [`CommonChannelMetadata`] does.
|
|
20
|
+
*/
|
|
21
|
+
export type AgentSessionNotificationRef = {
|
|
22
|
+
/**
|
|
23
|
+
* The magic-chip message for the turn in question, when one was posted.
|
|
24
|
+
*/
|
|
25
|
+
announcementMessageId?: string | null;
|
|
26
|
+
/**
|
|
27
|
+
* The bot the session runs for. A string on the wire: system bots have
|
|
28
|
+
* fixed ids like `00000000-0000-0000-0000-00000000a2a2`, which are not
|
|
29
|
+
* RFC 4122 uuids and fail a `format: uuid` check on the client.
|
|
30
|
+
*/
|
|
31
|
+
botId: string;
|
|
32
|
+
/**
|
|
33
|
+
* The bot's display name; agent notifications have no user sender, so
|
|
34
|
+
* this is who they read as being from.
|
|
35
|
+
*/
|
|
36
|
+
botName: string;
|
|
37
|
+
/**
|
|
38
|
+
* The channel the session was opened from, when it was opened from a
|
|
39
|
+
* channel thread.
|
|
40
|
+
*/
|
|
41
|
+
channelId?: string | null;
|
|
42
|
+
parent?: null | AgentSessionOriginParent;
|
|
43
|
+
/**
|
|
44
|
+
* The session; what a click opens.
|
|
45
|
+
*/
|
|
46
|
+
sessionId: string;
|
|
47
|
+
/**
|
|
48
|
+
* The session's name at the time of the event.
|
|
49
|
+
*/
|
|
50
|
+
sessionName: string;
|
|
51
|
+
/**
|
|
52
|
+
* The thread the session was opened from, when it was.
|
|
53
|
+
*/
|
|
54
|
+
threadId?: string | null;
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
* The session an agent-session notification is about, and where its magic
|
|
58
|
+
* chip lives when it was opened from a thread.
|
|
59
|
+
*
|
|
60
|
+
* The conversation an agent session was opened from: a channel, document,
|
|
61
|
+
* or initiative. Spelled like the message API's parent for client routing.
|
|
62
|
+
*/
|
|
63
|
+
export type AgentSessionOriginParent = {
|
|
64
|
+
/**
|
|
65
|
+
* The parent entity id.
|
|
66
|
+
*/
|
|
67
|
+
id: string;
|
|
68
|
+
/**
|
|
69
|
+
* `channel`, `document`, or `initiative`.
|
|
70
|
+
*/
|
|
71
|
+
type: string;
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* An agent finished a turn with nothing queued behind it.
|
|
75
|
+
*/
|
|
76
|
+
export type AgentSessionSettledMetadata = AgentSessionNotificationRef & {
|
|
77
|
+
/**
|
|
78
|
+
* Who prompted the turn, absent when a bot acted on nobody's behalf.
|
|
79
|
+
*/
|
|
80
|
+
actor?: string | null;
|
|
81
|
+
/**
|
|
82
|
+
* The agent's last prose in the turn, whole; `None` when it wrote none.
|
|
83
|
+
*/
|
|
84
|
+
excerpt?: string | null;
|
|
85
|
+
/**
|
|
86
|
+
* The ACP stop reason, or `error`.
|
|
87
|
+
*/
|
|
88
|
+
stopReason: string;
|
|
89
|
+
/**
|
|
90
|
+
* The turn that ended.
|
|
91
|
+
*/
|
|
92
|
+
turn: number;
|
|
93
|
+
};
|
|
94
|
+
/**
|
|
95
|
+
* An agent is blocked on a question only the session's owner can answer.
|
|
96
|
+
*/
|
|
97
|
+
export type AgentSessionWaitingForInputMetadata = AgentSessionNotificationRef & {
|
|
98
|
+
/**
|
|
99
|
+
* The question, as the agent phrased it.
|
|
100
|
+
*/
|
|
101
|
+
question: string;
|
|
102
|
+
/**
|
|
103
|
+
* The turn asking.
|
|
104
|
+
*/
|
|
105
|
+
turn: number;
|
|
106
|
+
};
|
|
4
107
|
export type AiResponseMetadata = {
|
|
5
108
|
messageId: string;
|
|
6
109
|
summary: string;
|
|
@@ -14,10 +117,6 @@ export type ApiUserNotification = Entity & {
|
|
|
14
117
|
* When the notification was deleted.
|
|
15
118
|
*/
|
|
16
119
|
deleted_at?: string | null;
|
|
17
|
-
/**
|
|
18
|
-
* Whether the notification is marked as done.
|
|
19
|
-
*/
|
|
20
|
-
done: boolean;
|
|
21
120
|
/**
|
|
22
121
|
* The notification ID.
|
|
23
122
|
*/
|
|
@@ -43,6 +142,10 @@ export type ApiUserNotification = Entity & {
|
|
|
43
142
|
* Whether the notification has been sent.
|
|
44
143
|
*/
|
|
45
144
|
sent: boolean;
|
|
145
|
+
/**
|
|
146
|
+
* The authoritative notification lifecycle state.
|
|
147
|
+
*/
|
|
148
|
+
state: NotificationState;
|
|
46
149
|
/**
|
|
47
150
|
* When the notification was last updated.
|
|
48
151
|
*/
|
|
@@ -136,6 +239,11 @@ export type ChannelInviteMetadata = {
|
|
|
136
239
|
* The user who sent the invitation
|
|
137
240
|
*/
|
|
138
241
|
invitedBy: string;
|
|
242
|
+
/**
|
|
243
|
+
* Whether this is a direct message rather than a channel invitation.
|
|
244
|
+
* Older notification payloads retain channel-invitation wording.
|
|
245
|
+
*/
|
|
246
|
+
isDirectMessage?: boolean;
|
|
139
247
|
/**
|
|
140
248
|
* Message content to show in the invite email, when the invite was triggered by a message.
|
|
141
249
|
*/
|
|
@@ -164,6 +272,31 @@ export type ChannelMentionMetadata = CommonChannelMetadata & {
|
|
|
164
272
|
*/
|
|
165
273
|
threadId?: string | null;
|
|
166
274
|
};
|
|
275
|
+
/**
|
|
276
|
+
* Metadata for a reaction added to one of the recipient's channel messages.
|
|
277
|
+
*/
|
|
278
|
+
export type ChannelMessageReactionMetadata = CommonChannelMetadata & {
|
|
279
|
+
/**
|
|
280
|
+
* The emoji added by the reactor.
|
|
281
|
+
*/
|
|
282
|
+
emoji: string;
|
|
283
|
+
/**
|
|
284
|
+
* The reacted-to message content.
|
|
285
|
+
*/
|
|
286
|
+
messageContent: string;
|
|
287
|
+
/**
|
|
288
|
+
* The reacted-to message id.
|
|
289
|
+
*/
|
|
290
|
+
messageId: string;
|
|
291
|
+
/**
|
|
292
|
+
* Optional reactor profile picture URL.
|
|
293
|
+
*/
|
|
294
|
+
senderProfilePictureUrl?: string | null;
|
|
295
|
+
/**
|
|
296
|
+
* The thread root id when the reacted-to message is a reply.
|
|
297
|
+
*/
|
|
298
|
+
threadId?: string | null;
|
|
299
|
+
};
|
|
167
300
|
export type ChannelMessageSendMetadata = CommonChannelMetadata & {
|
|
168
301
|
/**
|
|
169
302
|
* The content of the message
|
|
@@ -211,6 +344,12 @@ export type ChannelReplyMetadata = CommonChannelMetadata & {
|
|
|
211
344
|
userId?: string | null;
|
|
212
345
|
};
|
|
213
346
|
export type ChannelType = 'public' | 'private' | 'directMessage' | 'team';
|
|
347
|
+
/**
|
|
348
|
+
* Identity of a document comment or its thread. Comments written before the
|
|
349
|
+
* shared message store carry the legacy numeric ids; comments in the shared
|
|
350
|
+
* store carry the message and root UUIDs.
|
|
351
|
+
*/
|
|
352
|
+
export type CommentRef = number | string;
|
|
214
353
|
/**
|
|
215
354
|
* Notification sent when someone comments on a document the user owns.
|
|
216
355
|
*/
|
|
@@ -218,7 +357,7 @@ export type CommentedOnDocumentMetadata = {
|
|
|
218
357
|
/**
|
|
219
358
|
* the comment id
|
|
220
359
|
*/
|
|
221
|
-
commentId:
|
|
360
|
+
commentId: CommentRef;
|
|
222
361
|
/**
|
|
223
362
|
* The name of the document.
|
|
224
363
|
*/
|
|
@@ -231,6 +370,10 @@ export type CommentedOnDocumentMetadata = {
|
|
|
231
370
|
* The owner of the document.
|
|
232
371
|
*/
|
|
233
372
|
owner: string;
|
|
373
|
+
/**
|
|
374
|
+
* Public bot name when the author is an agent rather than a Macro user.
|
|
375
|
+
*/
|
|
376
|
+
senderDisplayName?: string | null;
|
|
234
377
|
senderProfilePictureUrl?: string | null;
|
|
235
378
|
subType?: null | NotificationDocumentSubType;
|
|
236
379
|
/**
|
|
@@ -240,7 +383,7 @@ export type CommentedOnDocumentMetadata = {
|
|
|
240
383
|
/**
|
|
241
384
|
* the thread id
|
|
242
385
|
*/
|
|
243
|
-
threadId:
|
|
386
|
+
threadId: CommentRef;
|
|
244
387
|
};
|
|
245
388
|
/**
|
|
246
389
|
* Common metadata for notifications on channels
|
|
@@ -270,6 +413,44 @@ export type CreateNotification = Entity & {
|
|
|
270
413
|
*/
|
|
271
414
|
service_sender: string;
|
|
272
415
|
};
|
|
416
|
+
/**
|
|
417
|
+
* CRM discussion metadata. The notification entity identifies the company or
|
|
418
|
+
* contact; message and thread UUIDs select the discussion inside it.
|
|
419
|
+
*/
|
|
420
|
+
export type CrmDiscussionMetadata = {
|
|
421
|
+
/**
|
|
422
|
+
* Canonical shared message UUID.
|
|
423
|
+
*/
|
|
424
|
+
messageId: string;
|
|
425
|
+
/**
|
|
426
|
+
* Semantic reason selected by the message delivery domain.
|
|
427
|
+
*/
|
|
428
|
+
reason: CrmDiscussionReason;
|
|
429
|
+
/**
|
|
430
|
+
* Company or contact display name.
|
|
431
|
+
*/
|
|
432
|
+
recordName: string;
|
|
433
|
+
/**
|
|
434
|
+
* Public display name for a bot author.
|
|
435
|
+
*/
|
|
436
|
+
senderDisplayName?: string | null;
|
|
437
|
+
/**
|
|
438
|
+
* Optional avatar for push notification attachments.
|
|
439
|
+
*/
|
|
440
|
+
senderProfilePictureUrl?: string | null;
|
|
441
|
+
/**
|
|
442
|
+
* Posted Markdown content.
|
|
443
|
+
*/
|
|
444
|
+
text: string;
|
|
445
|
+
/**
|
|
446
|
+
* Canonical discussion root UUID.
|
|
447
|
+
*/
|
|
448
|
+
threadId: string;
|
|
449
|
+
};
|
|
450
|
+
/**
|
|
451
|
+
* Why a CRM discussion notification was delivered.
|
|
452
|
+
*/
|
|
453
|
+
export type CrmDiscussionReason = 'mention' | 'reply' | 'owner';
|
|
273
454
|
/**
|
|
274
455
|
* Request to register or unregister a device for push notifications.
|
|
275
456
|
*/
|
|
@@ -278,6 +459,10 @@ export type DeviceRequest = {
|
|
|
278
459
|
* The device platform type (iOS or Android).
|
|
279
460
|
*/
|
|
280
461
|
deviceType: DeviceType;
|
|
462
|
+
/**
|
|
463
|
+
* Whether this Android binary supports native Telecom incoming calls.
|
|
464
|
+
*/
|
|
465
|
+
nativeCallCapable?: boolean;
|
|
281
466
|
/**
|
|
282
467
|
* The device push notification token.
|
|
283
468
|
*/
|
|
@@ -322,10 +507,60 @@ export type Entity = {
|
|
|
322
507
|
*/
|
|
323
508
|
entity_type: EntityType;
|
|
324
509
|
};
|
|
510
|
+
/**
|
|
511
|
+
* A person granted you access to a shared entity.
|
|
512
|
+
*/
|
|
513
|
+
export type EntityAccessGrantedMetadata = {
|
|
514
|
+
/**
|
|
515
|
+
* Requested or granted permission.
|
|
516
|
+
*/
|
|
517
|
+
accessLevel: RequestedAccessLevel;
|
|
518
|
+
/**
|
|
519
|
+
* Shared item's name.
|
|
520
|
+
*/
|
|
521
|
+
entityName: string;
|
|
522
|
+
/**
|
|
523
|
+
* Document file type for routing.
|
|
524
|
+
*/
|
|
525
|
+
fileType?: string | null;
|
|
526
|
+
/**
|
|
527
|
+
* Stable request identity.
|
|
528
|
+
*/
|
|
529
|
+
requestId: string;
|
|
530
|
+
/**
|
|
531
|
+
* Revision that generated this notification.
|
|
532
|
+
*/
|
|
533
|
+
revision: number;
|
|
534
|
+
};
|
|
535
|
+
/**
|
|
536
|
+
* A person requested access to a shared entity.
|
|
537
|
+
*/
|
|
538
|
+
export type EntityAccessRequestedMetadata = {
|
|
539
|
+
/**
|
|
540
|
+
* Requested or granted permission.
|
|
541
|
+
*/
|
|
542
|
+
accessLevel: RequestedAccessLevel;
|
|
543
|
+
/**
|
|
544
|
+
* Shared item's name.
|
|
545
|
+
*/
|
|
546
|
+
entityName: string;
|
|
547
|
+
/**
|
|
548
|
+
* Document file type for routing.
|
|
549
|
+
*/
|
|
550
|
+
fileType?: string | null;
|
|
551
|
+
/**
|
|
552
|
+
* Stable request identity.
|
|
553
|
+
*/
|
|
554
|
+
requestId: string;
|
|
555
|
+
/**
|
|
556
|
+
* Revision that generated this notification.
|
|
557
|
+
*/
|
|
558
|
+
revision: number;
|
|
559
|
+
};
|
|
325
560
|
/**
|
|
326
561
|
* The type of an entity in Macro
|
|
327
562
|
*/
|
|
328
|
-
export type EntityType = 'user' | 'chat' | 'channel' | 'channel_message' | 'document' | 'project' | 'email_thread' | 'calendar_event' | 'team' | 'call' | 'foreign_entity' | 'static_file' | 'crm_company' | 'crm_contact' | 'reminder' | 'skill' | 'agent_session';
|
|
563
|
+
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';
|
|
329
564
|
/**
|
|
330
565
|
* A plain old json error response for use with axum.
|
|
331
566
|
* yup, thats it.
|
|
@@ -580,6 +815,48 @@ export type InboxReauthRequiredMetadata = {
|
|
|
580
815
|
*/
|
|
581
816
|
emailAddress: string;
|
|
582
817
|
};
|
|
818
|
+
/**
|
|
819
|
+
* Project discussion metadata. The notification entity identifies the initiative;
|
|
820
|
+
* message and thread UUIDs select the discussion inside that project.
|
|
821
|
+
*/
|
|
822
|
+
export type InitiativeDiscussionMetadata = {
|
|
823
|
+
/**
|
|
824
|
+
* Canonical shared message UUID.
|
|
825
|
+
*/
|
|
826
|
+
messageId: string;
|
|
827
|
+
/**
|
|
828
|
+
* Authenticated project owner.
|
|
829
|
+
*/
|
|
830
|
+
owner: string;
|
|
831
|
+
/**
|
|
832
|
+
* Name displayed in the project header.
|
|
833
|
+
*/
|
|
834
|
+
projectName: string;
|
|
835
|
+
/**
|
|
836
|
+
* Semantic reason selected by the message delivery domain.
|
|
837
|
+
*/
|
|
838
|
+
reason: InitiativeDiscussionReason;
|
|
839
|
+
/**
|
|
840
|
+
* Public display name for a bot author.
|
|
841
|
+
*/
|
|
842
|
+
senderDisplayName?: string | null;
|
|
843
|
+
/**
|
|
844
|
+
* Optional avatar for push notification attachments.
|
|
845
|
+
*/
|
|
846
|
+
senderProfilePictureUrl?: string | null;
|
|
847
|
+
/**
|
|
848
|
+
* Posted Markdown content.
|
|
849
|
+
*/
|
|
850
|
+
text: string;
|
|
851
|
+
/**
|
|
852
|
+
* Canonical discussion root UUID.
|
|
853
|
+
*/
|
|
854
|
+
threadId: string;
|
|
855
|
+
};
|
|
856
|
+
/**
|
|
857
|
+
* Why a project discussion notification was delivered.
|
|
858
|
+
*/
|
|
859
|
+
export type InitiativeDiscussionReason = 'mention' | 'reply' | 'assignee' | 'owner';
|
|
583
860
|
/**
|
|
584
861
|
* Metadata for when a user is invited to a team.
|
|
585
862
|
*/
|
|
@@ -643,7 +920,7 @@ export type MentionedInDocumentCommentMetadata = {
|
|
|
643
920
|
/**
|
|
644
921
|
* the comment id
|
|
645
922
|
*/
|
|
646
|
-
commentId:
|
|
923
|
+
commentId: CommentRef;
|
|
647
924
|
/**
|
|
648
925
|
* The name of the document.
|
|
649
926
|
*/
|
|
@@ -660,6 +937,10 @@ export type MentionedInDocumentCommentMetadata = {
|
|
|
660
937
|
* The owner of the document.
|
|
661
938
|
*/
|
|
662
939
|
owner: string;
|
|
940
|
+
/**
|
|
941
|
+
* Public bot name when the author is an agent rather than a Macro user.
|
|
942
|
+
*/
|
|
943
|
+
senderDisplayName?: string | null;
|
|
663
944
|
senderProfilePictureUrl?: string | null;
|
|
664
945
|
subType?: null | NotificationDocumentSubType;
|
|
665
946
|
/**
|
|
@@ -669,7 +950,7 @@ export type MentionedInDocumentCommentMetadata = {
|
|
|
669
950
|
/**
|
|
670
951
|
* the thread id
|
|
671
952
|
*/
|
|
672
|
-
threadId:
|
|
953
|
+
threadId: CommentRef;
|
|
673
954
|
};
|
|
674
955
|
export type NewEmailMetadata = {
|
|
675
956
|
sender?: string | null;
|
|
@@ -716,6 +997,30 @@ export type NotifEvent = {
|
|
|
716
997
|
*/
|
|
717
998
|
content: CommentedOnDocumentMetadata;
|
|
718
999
|
tag: 'commented_on_document';
|
|
1000
|
+
} | {
|
|
1001
|
+
/**
|
|
1002
|
+
* Someone requested more access to a shared entity.
|
|
1003
|
+
*/
|
|
1004
|
+
content: EntityAccessRequestedMetadata;
|
|
1005
|
+
tag: 'entity_access_requested';
|
|
1006
|
+
} | {
|
|
1007
|
+
/**
|
|
1008
|
+
* An owner granted requested access.
|
|
1009
|
+
*/
|
|
1010
|
+
content: EntityAccessGrantedMetadata;
|
|
1011
|
+
tag: 'entity_access_granted';
|
|
1012
|
+
} | {
|
|
1013
|
+
/**
|
|
1014
|
+
* Someone commented, replied, or mentioned the recipient on a project.
|
|
1015
|
+
*/
|
|
1016
|
+
content: InitiativeDiscussionMetadata;
|
|
1017
|
+
tag: 'initiative_discussion';
|
|
1018
|
+
} | {
|
|
1019
|
+
/**
|
|
1020
|
+
* Someone commented, replied, or mentioned the recipient on a CRM company or contact.
|
|
1021
|
+
*/
|
|
1022
|
+
content: CrmDiscussionMetadata;
|
|
1023
|
+
tag: 'crm_discussion';
|
|
719
1024
|
} | {
|
|
720
1025
|
/**
|
|
721
1026
|
* The user was invited to a channel.
|
|
@@ -824,6 +1129,30 @@ export type NotifEvent = {
|
|
|
824
1129
|
*/
|
|
825
1130
|
content: GithubPrReview;
|
|
826
1131
|
tag: 'github_pr_review';
|
|
1132
|
+
} | {
|
|
1133
|
+
/**
|
|
1134
|
+
* An agent finished a turn with nothing queued behind it.
|
|
1135
|
+
*/
|
|
1136
|
+
content: AgentSessionSettledMetadata;
|
|
1137
|
+
tag: 'agent_session_settled';
|
|
1138
|
+
} | {
|
|
1139
|
+
/**
|
|
1140
|
+
* An agent is blocked on a question for the session's owner.
|
|
1141
|
+
*/
|
|
1142
|
+
content: AgentSessionWaitingForInputMetadata;
|
|
1143
|
+
tag: 'agent_session_waiting_for_input';
|
|
1144
|
+
} | {
|
|
1145
|
+
/**
|
|
1146
|
+
* The user was named in a prompt to an agent session.
|
|
1147
|
+
*/
|
|
1148
|
+
content: AgentSessionMentionedMetadata;
|
|
1149
|
+
tag: 'agent_session_mentioned';
|
|
1150
|
+
} | {
|
|
1151
|
+
/**
|
|
1152
|
+
* Someone reacted to one of the user's channel messages.
|
|
1153
|
+
*/
|
|
1154
|
+
content: ChannelMessageReactionMetadata;
|
|
1155
|
+
tag: 'channel_message_reaction';
|
|
827
1156
|
};
|
|
828
1157
|
/**
|
|
829
1158
|
* the notification ids that we are bulk updating
|
|
@@ -844,8 +1173,14 @@ export type NotificationDocumentSubType = {
|
|
|
844
1173
|
type: 'snippet';
|
|
845
1174
|
} | {
|
|
846
1175
|
type: 'skill';
|
|
1176
|
+
} | {
|
|
1177
|
+
type: 'initiative_description';
|
|
847
1178
|
};
|
|
848
1179
|
export type NotificationServiceApiVersion = 'v1';
|
|
1180
|
+
/**
|
|
1181
|
+
* The mutually exclusive lifecycle states of a user's notification.
|
|
1182
|
+
*/
|
|
1183
|
+
export type NotificationState = 'unseen' | 'seen' | 'done';
|
|
849
1184
|
/**
|
|
850
1185
|
* newtype wrapper for the the typename of a Notification
|
|
851
1186
|
*/
|
|
@@ -873,10 +1208,6 @@ export type RealtimeNotifTaggedContentValue = Entity & {
|
|
|
873
1208
|
* When the notification was deleted.
|
|
874
1209
|
*/
|
|
875
1210
|
deleted_at?: string | null;
|
|
876
|
-
/**
|
|
877
|
-
* Whether the notification is marked as done.
|
|
878
|
-
*/
|
|
879
|
-
done: boolean;
|
|
880
1211
|
/**
|
|
881
1212
|
* The notification event type string (e.g. "channel_mention").
|
|
882
1213
|
* TODO make this a new type
|
|
@@ -898,6 +1229,10 @@ export type RealtimeNotifTaggedContentValue = Entity & {
|
|
|
898
1229
|
* Whether the notification has been sent.
|
|
899
1230
|
*/
|
|
900
1231
|
sent: boolean;
|
|
1232
|
+
/**
|
|
1233
|
+
* The authoritative lifecycle state, independent of viewing timestamps.
|
|
1234
|
+
*/
|
|
1235
|
+
state: NotificationState;
|
|
901
1236
|
/**
|
|
902
1237
|
* When the notification was last updated.
|
|
903
1238
|
*/
|
|
@@ -948,7 +1283,7 @@ export type RepliedToDocumentCommentThreadMetadata = {
|
|
|
948
1283
|
/**
|
|
949
1284
|
* the comment id
|
|
950
1285
|
*/
|
|
951
|
-
commentId:
|
|
1286
|
+
commentId: CommentRef;
|
|
952
1287
|
/**
|
|
953
1288
|
* The name of the document.
|
|
954
1289
|
*/
|
|
@@ -961,6 +1296,10 @@ export type RepliedToDocumentCommentThreadMetadata = {
|
|
|
961
1296
|
* The owner of the document.
|
|
962
1297
|
*/
|
|
963
1298
|
owner: string;
|
|
1299
|
+
/**
|
|
1300
|
+
* Public bot name when the author is an agent rather than a Macro user.
|
|
1301
|
+
*/
|
|
1302
|
+
senderDisplayName?: string | null;
|
|
964
1303
|
senderProfilePictureUrl?: string | null;
|
|
965
1304
|
subType?: null | NotificationDocumentSubType;
|
|
966
1305
|
/**
|
|
@@ -970,8 +1309,12 @@ export type RepliedToDocumentCommentThreadMetadata = {
|
|
|
970
1309
|
/**
|
|
971
1310
|
* the thread id
|
|
972
1311
|
*/
|
|
973
|
-
threadId:
|
|
1312
|
+
threadId: CommentRef;
|
|
974
1313
|
};
|
|
1314
|
+
/**
|
|
1315
|
+
* Permission level used by an access request, excluding ownership.
|
|
1316
|
+
*/
|
|
1317
|
+
export type RequestedAccessLevel = 'view' | 'comment' | 'edit';
|
|
975
1318
|
/**
|
|
976
1319
|
* Metadata for when a user is assigned to a task
|
|
977
1320
|
*/
|
|
@@ -993,7 +1336,7 @@ export type TaskAssignedMetadata = {
|
|
|
993
1336
|
};
|
|
994
1337
|
export type UnsubscribeItemPathParams = {
|
|
995
1338
|
item_id: string;
|
|
996
|
-
item_type:
|
|
1339
|
+
item_type: EntityType;
|
|
997
1340
|
};
|
|
998
1341
|
export type UserUnsubscribe = {
|
|
999
1342
|
/**
|
|
@@ -1004,6 +1347,10 @@ export type UserUnsubscribe = {
|
|
|
1004
1347
|
* The item type
|
|
1005
1348
|
*/
|
|
1006
1349
|
item_type: string;
|
|
1350
|
+
/**
|
|
1351
|
+
* None for permanent mutes; notifications resume automatically at this deadline.
|
|
1352
|
+
*/
|
|
1353
|
+
snoozed_until?: string | null;
|
|
1007
1354
|
};
|
|
1008
1355
|
export type HealthHandlerData = {
|
|
1009
1356
|
body?: never;
|
|
@@ -1051,7 +1398,7 @@ export type UnsubscribeEmailResponse = UnsubscribeEmailResponses[keyof Unsubscri
|
|
|
1051
1398
|
export type RemoveUnsubscribeItemData = {
|
|
1052
1399
|
body?: never;
|
|
1053
1400
|
path: {
|
|
1054
|
-
item_type:
|
|
1401
|
+
item_type: EntityType;
|
|
1055
1402
|
item_id: string;
|
|
1056
1403
|
};
|
|
1057
1404
|
query?: never;
|
|
@@ -1069,13 +1416,19 @@ export type RemoveUnsubscribeItemResponse = RemoveUnsubscribeItemResponses[keyof
|
|
|
1069
1416
|
export type UnsubscribeItemData = {
|
|
1070
1417
|
body?: never;
|
|
1071
1418
|
path: {
|
|
1072
|
-
item_type:
|
|
1419
|
+
item_type: EntityType;
|
|
1073
1420
|
item_id: string;
|
|
1074
1421
|
};
|
|
1075
|
-
query?:
|
|
1422
|
+
query?: {
|
|
1423
|
+
/**
|
|
1424
|
+
* A future resume time. Omit to mute indefinitely.
|
|
1425
|
+
*/
|
|
1426
|
+
snoozed_until?: string | null;
|
|
1427
|
+
};
|
|
1076
1428
|
url: '/unsubscribe/item/{item_type}/{item_id}';
|
|
1077
1429
|
};
|
|
1078
1430
|
export type UnsubscribeItemErrors = {
|
|
1431
|
+
400: ErrorResponse;
|
|
1079
1432
|
401: ErrorResponse;
|
|
1080
1433
|
500: ErrorResponse;
|
|
1081
1434
|
};
|
|
@@ -1118,6 +1471,10 @@ export type ListTypedNotificationsData = {
|
|
|
1118
1471
|
body?: never;
|
|
1119
1472
|
path?: never;
|
|
1120
1473
|
query?: {
|
|
1474
|
+
/**
|
|
1475
|
+
* Comma-separated exact states: unseen,seen,done. Omitted defaults to unseen,seen; empty includes all states.
|
|
1476
|
+
*/
|
|
1477
|
+
states?: string;
|
|
1121
1478
|
/**
|
|
1122
1479
|
* Size limit per page.
|
|
1123
1480
|
*/
|
|
@@ -1143,6 +1500,10 @@ export type BulkGetTypedNotificationsByEventItemIdsData = {
|
|
|
1143
1500
|
body: BulkGetByEventItemIdsRequest;
|
|
1144
1501
|
path?: never;
|
|
1145
1502
|
query?: {
|
|
1503
|
+
/**
|
|
1504
|
+
* Comma-separated exact states: unseen,seen,done. Omitted defaults to unseen,seen; empty includes all states.
|
|
1505
|
+
*/
|
|
1506
|
+
states?: string;
|
|
1146
1507
|
/**
|
|
1147
1508
|
* Size limit per page. Default 20, max 500.
|
|
1148
1509
|
*/
|
|
@@ -1173,6 +1534,10 @@ export type GetTypedNotificationsByEventItemIdData = {
|
|
|
1173
1534
|
event_item_id: string;
|
|
1174
1535
|
};
|
|
1175
1536
|
query?: {
|
|
1537
|
+
/**
|
|
1538
|
+
* Comma-separated exact states: unseen,seen,done. Omitted defaults to unseen,seen; empty includes all states.
|
|
1539
|
+
*/
|
|
1540
|
+
states?: string;
|
|
1176
1541
|
/**
|
|
1177
1542
|
* Size limit per page.
|
|
1178
1543
|
*/
|
|
@@ -247,7 +247,7 @@ export type EntityReference = {
|
|
|
247
247
|
/**
|
|
248
248
|
* Type of entity that can be referenced by entity properties.
|
|
249
249
|
*/
|
|
250
|
-
export type EntityType = 'CALENDAR_EVENT' | 'CALL_RECORD' | 'CHANNEL' | 'CHAT' | 'COMPANY' | 'DOCUMENT' | 'PROJECT' | 'TASK' | 'THREAD' | 'USER';
|
|
250
|
+
export type EntityType = 'CALENDAR_EVENT' | 'CALL_RECORD' | 'CHANNEL' | 'CHAT' | 'COMPANY' | 'DATABASE_ROW' | 'CONTACT' | 'DOCUMENT' | 'INITIATIVE' | 'PROJECT' | 'TASK' | 'THREAD' | 'USER';
|
|
251
251
|
/**
|
|
252
252
|
* Query parameters for listing properties
|
|
253
253
|
*/
|
|
@@ -330,7 +330,7 @@ export type PropertyDefinition = {
|
|
|
330
330
|
*/
|
|
331
331
|
is_system: boolean;
|
|
332
332
|
owner: PropertyOwner;
|
|
333
|
-
specific_entity_type
|
|
333
|
+
specific_entity_type: null | EntityType;
|
|
334
334
|
updated_at: string;
|
|
335
335
|
};
|
|
336
336
|
/**
|
|
@@ -375,7 +375,7 @@ export type PropertyDefinitionWithOptionsResponse = {
|
|
|
375
375
|
* A selectable option for select-type properties (service representation).
|
|
376
376
|
*/
|
|
377
377
|
export type PropertyOption = {
|
|
378
|
-
color
|
|
378
|
+
color: string | null;
|
|
379
379
|
created_at: string;
|
|
380
380
|
display_order: number;
|
|
381
381
|
id: string;
|
|
@@ -410,7 +410,7 @@ export type PropertyOptionValue = {
|
|
|
410
410
|
value: number;
|
|
411
411
|
};
|
|
412
412
|
/**
|
|
413
|
-
* Defines who owns a property - user-scoped, team-scoped, or system.
|
|
413
|
+
* Defines who owns a property - user-scoped, team-scoped, database-scoped, or system.
|
|
414
414
|
*/
|
|
415
415
|
export type PropertyOwner = {
|
|
416
416
|
scope: 'user';
|
|
@@ -418,6 +418,9 @@ export type PropertyOwner = {
|
|
|
418
418
|
} | {
|
|
419
419
|
scope: 'team';
|
|
420
420
|
team_id: string;
|
|
421
|
+
} | {
|
|
422
|
+
database_id: string;
|
|
423
|
+
scope: 'database';
|
|
421
424
|
} | {
|
|
422
425
|
scope: 'system';
|
|
423
426
|
};
|
|
@@ -432,7 +435,7 @@ export type PropertyScope = 'user' | 'team' | 'system' | 'all';
|
|
|
432
435
|
* here; task classification is resolved by the properties domain from the
|
|
433
436
|
* document subtype.
|
|
434
437
|
*/
|
|
435
|
-
export type PropertyTargetEntityType = 'CALL_RECORD' | 'CHANNEL' | 'CHAT' | 'COMPANY' | 'DOCUMENT' | 'PROJECT' | 'THREAD' | 'USER';
|
|
438
|
+
export type PropertyTargetEntityType = 'CALL_RECORD' | 'CHANNEL' | 'CHAT' | 'COMPANY' | 'DATABASE_ROW' | 'DOCUMENT' | 'INITIATIVE' | 'PROJECT' | 'THREAD' | 'USER';
|
|
436
439
|
/**
|
|
437
440
|
* Canonical reference to an entity receiving properties.
|
|
438
441
|
*/
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export { type Options, Sdk } from './sdk.gen';
|
|
2
|
-
export type { ActionExecutionRecord, ActionKind, AgentTask, ClientOptions, CreateScheduledAction, CreateScheduledActionData, CreateScheduledActionError, CreateScheduledActionErrors, CreateScheduledActionResponse, CreateScheduledActionResponses, DeleteScheduledActionData, DeleteScheduledActionError, DeleteScheduledActionErrors, DeleteScheduledActionResponse, DeleteScheduledActionResponses, EmptyResponse, ExecuteScheduledActionNowData, ExecuteScheduledActionNowError, ExecuteScheduledActionNowErrors, ExecuteScheduledActionNowResponse, ExecuteScheduledActionNowResponses, InProgressExecution, ListScheduledActionHistoryData, ListScheduledActionHistoryError, ListScheduledActionHistoryErrors, ListScheduledActionHistoryResponse, ListScheduledActionHistoryResponses, ListScheduledActionsData, ListScheduledActionsError, ListScheduledActionsErrors, ListScheduledActionsResponse, ListScheduledActionsResponses, Schedule, ScheduledAction, ScheduledActionHealthData, ScheduledActionHealthResponse, ScheduledActionHealthResponses, ScheduledActionUpdate, UpdateScheduledAction, UpdateScheduledActionData, UpdateScheduledActionError, UpdateScheduledActionErrors, UpdateScheduledActionResponse, UpdateScheduledActionResponses } from './types.gen';
|
|
2
|
+
export type { ActionConfiguration, ActionConfigurationUpdate, ActionExecutionRecord, ActionKind, ActionTrigger, AgentTask, AgentTaskAgent, AiAdmissionErrorBody, ClientOptions, ConditionResult, CreateScheduledAction, CreateScheduledActionData, CreateScheduledActionError, CreateScheduledActionErrors, CreateScheduledActionResponse, CreateScheduledActionResponses, DeleteScheduledActionData, DeleteScheduledActionError, DeleteScheduledActionErrors, DeleteScheduledActionResponse, DeleteScheduledActionResponses, EmptyResponse, EventFilter, EventFilters, EventName, ExecuteScheduledActionNowData, ExecuteScheduledActionNowError, ExecuteScheduledActionNowErrors, ExecuteScheduledActionNowResponse, ExecuteScheduledActionNowResponses, ExecutionResource, ExecutionResourceType, ExecutionResult, GetScheduledActionData, GetScheduledActionError, GetScheduledActionErrors, GetScheduledActionResponse, GetScheduledActionResponses, InProgressExecution, LegacyActionConfiguration, ListScheduledActionHistoryData, ListScheduledActionHistoryError, ListScheduledActionHistoryErrors, ListScheduledActionHistoryResponse, ListScheduledActionHistoryResponses, ListScheduledActionsData, ListScheduledActionsError, ListScheduledActionsErrors, ListScheduledActionsResponse, ListScheduledActionsResponses, RoutineModelId, RoutineTrigger, RoutineTriggers, Schedule, ScheduledAction, ScheduledActionHealthData, ScheduledActionHealthResponse, ScheduledActionHealthResponses, ScheduledActionResponse, ScheduledActionUpdate, SetScheduledActionEnabled, SetScheduledActionEnabledData, SetScheduledActionEnabledError, SetScheduledActionEnabledErrors, SetScheduledActionEnabledResponse, SetScheduledActionEnabledResponses, UpdateScheduledAction, UpdateScheduledActionData, UpdateScheduledActionError, UpdateScheduledActionErrors, UpdateScheduledActionResponse, UpdateScheduledActionResponses } from './types.gen';
|