@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,5 +1,5 @@
|
|
|
1
|
-
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client';
|
|
2
|
-
import type { AddFavoriteData, AddFavoriteErrors, AddFavoriteResponses, AddParticipantsData, AddParticipantsErrors, AddParticipantsResponses, AddPinHandlerData, AddPinHandlerErrors, AddPinHandlerResponses, BulkWakeupSyncServiceDocumentsData, BulkWakeupSyncServiceDocumentsErrors, BulkWakeupSyncServiceDocumentsResponses, CallWebhookData, CallWebhookErrors, CallWebhookResponses, CheckActiveCallData, CheckActiveCallErrors, CheckActiveCallResponses, CopyDocumentData, CopyDocumentErrors, CopyDocumentResponses, CreateAnchorData, CreateAnchorErrors, CreateAnchorResponses, CreateChannelData, CreateChannelErrors, CreateChannelResponses, CreateChannelScopedBotData, CreateChannelScopedBotErrors, CreateChannelScopedBotResponses, CreateCollabSurfaceTokenData, CreateCollabSurfaceTokenErrors, CreateCollabSurfaceTokenResponses, CreateCommentData, CreateCommentErrors, CreateCommentResponses, CreateCrmCommentData, CreateCrmCommentErrors, CreateCrmCommentResponses, CreateCrmCompanyData, CreateCrmCompanyErrors, CreateCrmCompanyResponses, CreateCrmContactData, CreateCrmContactErrors, CreateCrmContactResponses, CreateDocumentData, CreateDocumentErrors, CreateDocumentResponses, CreateEntityMentionData, CreateEntityMentionErrors, CreateEntityMentionResponses, CreateInstructionsHandlerData, CreateInstructionsHandlerErrors, CreateInstructionsHandlerResponses, CreateMarkdownHandlerData, CreateMarkdownHandlerErrors, CreateMarkdownHandlerResponses, CreateProjectHandlerData, CreateProjectHandlerErrors, CreateProjectHandlerResponses, CreateReminderData, CreateReminderErrors, CreateReminderResponses, CreateSkillHandlerData, CreateSkillHandlerErrors, CreateSkillHandlerResponses, CreateSnippetHandlerData, CreateSnippetHandlerErrors, CreateSnippetHandlerResponses, CreateTaskHandlerData, CreateTaskHandlerErrors, CreateTaskHandlerResponses, CreateViewHandlerData, CreateViewHandlerErrors, CreateViewHandlerResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, DeleteAnchorData, DeleteAnchorErrors, DeleteAnchorResponses, DeleteCallRecordData, DeleteCallRecordErrors, DeleteCallRecordResponses, DeleteChannelData, DeleteChannelErrors, DeleteChannelResponses, DeleteCollabSurfaceData, DeleteCollabSurfaceErrors, DeleteCollabSurfaceResponses, DeleteCommentData, DeleteCommentErrors, DeleteCommentResponses, DeleteCrmCommentData, DeleteCrmCommentErrors, DeleteCrmCommentResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteEntityMentionData, DeleteEntityMentionErrors, DeleteEntityMentionResponses, DeleteHistoryHandlerData, DeleteHistoryHandlerErrors, DeleteHistoryHandlerResponses, DeleteMessageData, DeleteMessageErrors, DeleteMessageResponses, DeleteProjectHandlerData, DeleteProjectHandlerErrors, DeleteProjectHandlerResponses, DeleteReminderData, DeleteReminderErrors, DeleteReminderResponses, DeleteUserDocumentViewLocationData, DeleteUserDocumentViewLocationErrors, DeleteUserDocumentViewLocationResponses, DeleteViewHandlerData, DeleteViewHandlerErrors, DeleteViewHandlerResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponses, EditAnchorData, EditAnchorErrors, EditAnchorResponses, EditCallRecordData, EditCallRecordErrors, EditCallRecordResponses, EditCallTranscriptData, EditCallTranscriptErrors, EditCallTranscriptResponses, EditCommentData, EditCommentErrors, EditCommentResponses, EditCrmCommentData, EditCrmCommentErrors, EditCrmCommentResponses, EditDocumentData, EditDocumentErrors, EditDocumentResponses, EditProjectV2Data, EditProjectV2Errors, EditProjectV2Responses, EditThreadV2Data, EditThreadV2Errors, EditThreadV2Responses, EnsureCollabSurfaceData, EnsureCollabSurfaceErrors, EnsureCollabSurfaceResponses, ExcludeDefaultViewHandlerData, ExcludeDefaultViewHandlerErrors, ExcludeDefaultViewHandlerResponses, ExportDocumentData, ExportDocumentErrors, ExportDocumentResponses, GetActiveCallsData, GetActiveCallsErrors, GetActiveCallsResponses, GetActivityData, GetActivityErrors, GetActivityResponses, GetAttachmentReferencesData, GetAttachmentReferencesErrors, GetAttachmentReferencesResponses, GetBatchCallRecordPreviewData, GetBatchCallRecordPreviewErrors, GetBatchCallRecordPreviewResponses, GetBatchChannelPreviewData, GetBatchChannelPreviewErrors, GetBatchChannelPreviewResponses, GetBatchPreviewHandlerData, GetBatchPreviewHandlerErrors, GetBatchPreviewHandlerResponses, GetBatchProjectPreviewData, GetBatchProjectPreviewErrors, GetBatchProjectPreviewResponses, GetCallRecordData, GetCallRecordErrors, GetCallRecordResponses, GetChannelAttachmentsData, GetChannelAttachmentsErrors, GetChannelAttachmentsResponses, GetChannelData, GetChannelErrors, GetChannelJoinLinkData, GetChannelJoinLinkErrors, GetChannelJoinLinkResponses, GetChannelMessagesData, GetChannelMessagesErrors, GetChannelMessagesResponses, GetChannelParticipantsData, GetChannelParticipantsErrors, GetChannelParticipantsResponses, GetChannelResponses, GetChannelsData, GetChannelsErrors, GetChannelsResponses, GetCollabSurfaceData, GetCollabSurfaceErrors, GetCollabSurfaceResponses, GetCompanyData, GetCompanyErrors, GetCompanyResponses, GetContactByEmailData, GetContactByEmailErrors, GetContactByEmailResponses, GetContactData, GetContactErrors, GetContactResponses, GetCrmTeamSettingsData, GetCrmTeamSettingsErrors, GetCrmTeamSettingsResponses, GetDocumentAnchorsData, GetDocumentAnchorsErrors, GetDocumentAnchorsResponses, GetDocumentBranchNameData, GetDocumentBranchNameErrors, GetDocumentBranchNameResponses, GetDocumentByTeamSlugData, GetDocumentByTeamSlugErrors, GetDocumentByTeamSlugResponses, GetDocumentCommentsData, GetDocumentCommentsErrors, GetDocumentCommentsResponses, GetDocumentData, GetDocumentErrors, GetDocumentGithubPullRequestsData, GetDocumentGithubPullRequestsErrors, GetDocumentGithubPullRequestsResponses, GetDocumentListHandlerData, GetDocumentListHandlerErrors, GetDocumentListHandlerResponses, GetDocumentLocationV3Data, GetDocumentLocationV3Errors, GetDocumentLocationV3Responses, GetDocumentPermissionsTokenData, GetDocumentPermissionsTokenErrors, GetDocumentPermissionsTokenResponses, GetDocumentPermissionsV2Data, GetDocumentPermissionsV2Errors, GetDocumentPermissionsV2Responses, GetDocumentProcessingResultData, GetDocumentProcessingResultErrors, GetDocumentProcessingResultResponses, GetDocumentResponses, GetDocumentShortIdData, GetDocumentShortIdErrors, GetDocumentShortIdResponses, GetDocumentTeamShareData, GetDocumentTeamShareErrors, GetDocumentTeamShareResponses, GetDocumentVersionData, GetDocumentVersionErrors, GetDocumentVersionResponses, GetDocumentViewsHandlerData, GetDocumentViewsHandlerErrors, GetDocumentViewsHandlerResponses, GetEntityPermissionData, GetEntityPermissionErrors, GetEntityPermissionResponses, GetForeignEntityData, GetForeignEntityErrors, GetForeignEntityResponses, GetHistoryHandlerData, GetHistoryHandlerErrors, GetHistoryHandlerResponses, GetInstructionsHandlerData, GetInstructionsHandlerErrors, GetInstructionsHandlerResponses, GetItemsSoupData, GetItemsSoupErrors, GetItemsSoupResponses, GetLocationHandlerData, GetLocationHandlerErrors, GetLocationHandlerResponses, GetMessageWithContextData, GetMessageWithContextErrors, GetMessageWithContextResponses, GetOrCreateCallData, GetOrCreateCallErrors, GetOrCreateCallResponses, GetOrCreateDmData, GetOrCreateDmErrors, GetOrCreateDmResponses, GetOrCreatePrivateData, GetOrCreatePrivateErrors, GetOrCreatePrivateResponses, GetPendingProjectsHandlerData, GetPendingProjectsHandlerErrors, GetPendingProjectsHandlerResponses, GetPinsHandlerData, GetPinsHandlerErrors, GetPinsHandlerResponses, GetProjectContentHandlerData, GetProjectContentHandlerErrors, GetProjectContentHandlerResponses, GetProjectHandlerData, GetProjectHandlerErrors, GetProjectHandlerResponses, GetProjectPermissionsV2Data, GetProjectPermissionsV2Errors, GetProjectPermissionsV2Responses, GetProjectsHandlerData, GetProjectsHandlerErrors, GetProjectsHandlerResponses, GetProjectUserAccessLevelData, GetProjectUserAccessLevelErrors, GetProjectUserAccessLevelResponses, GetReminderData, GetReminderErrors, GetReminderResponses, GetRingStatusData, GetRingStatusErrors, GetRingStatusResponses, GetSelfBotData, GetSelfBotErrors, GetSelfBotResponses, GetSystemSkillsHandlerData, GetSystemSkillsHandlerErrors, GetSystemSkillsHandlerResponses, GetThreadRepliesData, GetThreadRepliesErrors, GetThreadRepliesResponses, GetUserDocumentsHandlerData, GetUserDocumentsHandlerErrors, GetUserDocumentsHandlerResponses, GetUserDocumentViewLocationData, GetUserDocumentViewLocationErrors, GetUserDocumentViewLocationResponses, GetViewsHandlerData, GetViewsHandlerErrors, GetViewsHandlerResponses, GetWebhookData, GetWebhookErrors, GetWebhookResponses, HandlerData, HandlerErrors, HandlerResponses, HealthHandlerData, HealthHandlerResponses, IngestTranscriptData, IngestTranscriptErrors, IngestTranscriptResponses, InitializeUserDocumentsData, InitializeUserDocumentsErrors, InitializeUserDocumentsResponses, InstallSyncData, InstallSyncErrors, JobProcessingResultHandlerData, JobProcessingResultHandlerErrors, JobProcessingResultHandlerResponses, JoinChannelByCodeData, JoinChannelByCodeErrors, JoinChannelByCodeResponses, JoinChannelData, JoinChannelErrors, JoinChannelResponses, LeaveChannelData, LeaveChannelErrors, LeaveChannelResponses, LeaveOrEndCallData, LeaveOrEndCallErrors, LeaveOrEndCallResponses, ListBotChannelsData, ListBotChannelsErrors, ListBotChannelsResponses, ListCompanyContactsData, ListCompanyContactsErrors, ListCompanyContactsResponses, ListCrmCommentsData, ListCrmCommentsErrors, ListCrmCommentsResponses, ListFavoritesData, ListFavoritesErrors, ListFavoritesResponses, ListOccurrencesData, ListOccurrencesErrors, ListOccurrencesResponses, ListRemindersData, ListRemindersErrors, ListRemindersResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, MentionPreviewsData, MentionPreviewsErrors, MentionPreviewsResponses, PatchChannelData, PatchChannelErrors, PatchChannelResponses, PatchMessageData, PatchMessageErrors, PatchMessageResponses, PatchViewHandlerData, PatchViewHandlerErrors, PatchViewHandlerResponses, PatchWebhookData, PatchWebhookErrors, PatchWebhookResponses, PermanentlyDeleteDocumentData, PermanentlyDeleteDocumentErrors, PermanentlyDeleteDocumentResponses, PermanentlyDeleteProjectData, PermanentlyDeleteProjectErrors, PermanentlyDeleteProjectResponses, PostActivityData, PostActivityErrors, PostActivityResponses, PostChannelBotWebhookData, PostChannelBotWebhookErrors, PostChannelBotWebhookResponses, PostChannelMessagesData, PostChannelMessagesErrors, PostChannelMessagesResponses, PostItemsSoupAstData, PostItemsSoupAstErrors, PostItemsSoupAstGroupedData, PostItemsSoupAstGroupedErrors, PostItemsSoupAstGroupedResponses, PostItemsSoupAstResponses, PostItemsSoupData, PostItemsSoupErrors, PostItemsSoupResponses, PostMessageData, PostMessageErrors, PostMessageResponses, PostReactionData, PostReactionErrors, PostReactionResponses, PostTypingData, PostTypingErrors, PostTypingResponses, PresaveDocumentHandlerData, PresaveDocumentHandlerErrors, PresaveDocumentHandlerResponses, PutCrmTeamSettingsData, PutCrmTeamSettingsErrors, PutCrmTeamSettingsResponses, RecentlyDeletedData, RecentlyDeletedErrors, RecentlyDeletedResponses, RemoveBotFromChannelByBotData, RemoveBotFromChannelByBotErrors, RemoveBotFromChannelByBotResponses, RemoveFavoriteByEntityData, RemoveFavoriteByEntityErrors, RemoveFavoriteByEntityResponses, RemoveParticipantsData, RemoveParticipantsErrors, RemoveParticipantsResponses, RemovePinHandlerData, RemovePinHandlerErrors, RemovePinHandlerResponses, ReorderFavoritesData, ReorderFavoritesErrors, ReorderFavoritesResponses, ReorderPinsHandlerData, ReorderPinsHandlerErrors, ReorderPinsHandlerResponses, ResolveChannelMessageData, ResolveChannelMessageErrors, ResolveChannelMessageResponses, RevertDeleteDocumentData, RevertDeleteDocumentErrors, RevertDeleteDocumentResponses, RevertDeleteProjectData, RevertDeleteProjectErrors, RevertDeleteProjectResponses, SaveDocumentHandlerData, SaveDocumentHandlerErrors, SaveDocumentHandlerResponses, SetCompanyHiddenData, SetCompanyHiddenErrors, SetCompanyHiddenResponses, SetContactHiddenData, SetContactHiddenErrors, SetContactHiddenResponses, SetCrmCompanyNameData, SetCrmCompanyNameErrors, SetCrmCompanyNameResponses, SetCrmContactNameData, SetCrmContactNameErrors, SetCrmContactNameResponses, SetDocumentTeamShareData, SetDocumentTeamShareErrors, SetDocumentTeamShareResponses, SetEmailSyncData, SetEmailSyncErrors, SetEmailSyncResponses, SimpleSaveData, SimpleSaveErrors, SimpleSaveResponses, ToggleShareWithTeamData, ToggleShareWithTeamErrors, ToggleShareWithTeamResponses, UpdateReminderData, UpdateReminderErrors, UpdateReminderResponses, UploadExtractFolderHandlerData, UploadExtractFolderHandlerErrors, UploadExtractFolderHandlerResponses, UploadFolderHandlerData, UploadFolderHandlerErrors, UploadFolderHandlerResponses, UpsertHistoryHandlerData, UpsertHistoryHandlerErrors, UpsertHistoryHandlerResponses, UpsertUserDocumentViewLocationData, UpsertUserDocumentViewLocationErrors, UpsertUserDocumentViewLocationResponses, ValidateDocumentPermissionsTokenData, ValidateDocumentPermissionsTokenErrors, ValidateDocumentPermissionsTokenResponses, ValidateWebhookData, ValidateWebhookErrors, ValidateWebhookResponses } from './types.gen';
|
|
1
|
+
import type { Client, ClientMeta, Options as Options2, RequestResult, ServerSentEventsResult, TDataShape } from './client';
|
|
2
|
+
import type { AccessRequestsCancelData, AccessRequestsCancelErrors, AccessRequestsCancelResponses, AccessRequestsDirectData, AccessRequestsDirectErrors, AccessRequestsDirectResponses, AccessRequestsRemoveDirectData, AccessRequestsRemoveDirectErrors, AccessRequestsRemoveDirectResponses, AccessRequestsResolveData, AccessRequestsResolveErrors, AccessRequestsResolveResponses, AccessRequestsSetDirectData, AccessRequestsSetDirectErrors, AccessRequestsSetDirectResponses, AccessRequestsStateData, AccessRequestsStateErrors, AccessRequestsStateResponses, AccessRequestsSubmitData, AccessRequestsSubmitErrors, AccessRequestsSubmitResponses, AddFavoriteData, AddFavoriteErrors, AddFavoriteResponses, AddParticipantsData, AddParticipantsErrors, AddParticipantsResponses, AddPinHandlerData, AddPinHandlerErrors, AddPinHandlerResponses, ApplyCrmPipelineOpsData, ApplyCrmPipelineOpsResponses, ApplyDatabaseOpsData, ApplyDatabaseOpsErrors, ApplyDatabaseOpsResponses, ApproveHarnessPairingData, ApproveHarnessPairingErrors, ApproveHarnessPairingResponses, BulkWakeupSyncServiceDocumentsData, BulkWakeupSyncServiceDocumentsErrors, BulkWakeupSyncServiceDocumentsResponses, CallWebhookData, CallWebhookErrors, CallWebhookResponses, CancelSlackImportData, CancelSlackImportErrors, CancelSlackImportResponses, CheckActiveCallData, CheckActiveCallErrors, CheckActiveCallResponses, ClaimHarnessPairingData, ClaimHarnessPairingErrors, ClaimHarnessPairingResponses, CollaborateFormData, CollaborateFormErrors, CollaborateFormResponses, CompleteSlackImportUploadsData, CompleteSlackImportUploadsErrors, CompleteSlackImportUploadsResponses, ConvertDatabaseColumnData, ConvertDatabaseColumnErrors, ConvertDatabaseColumnResponses, CopyDocumentData, CopyDocumentErrors, CopyDocumentResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateAnchorData, CreateAnchorErrors, CreateAnchorResponses, CreateChannelData, CreateChannelErrors, CreateChannelLabelData, CreateChannelLabelErrors, CreateChannelLabelResponses, CreateChannelResponses, CreateChannelScopedBotData, CreateChannelScopedBotErrors, CreateChannelScopedBotResponses, CreateCollabSurfaceTokenData, CreateCollabSurfaceTokenErrors, CreateCollabSurfaceTokenResponses, CreateCrmCompanyData, CreateCrmCompanyErrors, CreateCrmCompanyResponses, CreateCrmContactData, CreateCrmContactErrors, CreateCrmContactResponses, CreateCrmPipelineData, CreateCrmPipelineResponses, CreateDatabaseData, CreateDatabaseErrors, CreateDatabaseResponses, CreateDatabaseWebhookData, CreateDatabaseWebhookErrors, CreateDatabaseWebhookResponses, CreateDocumentData, CreateDocumentErrors, CreateDocumentResponses, CreateEntityMentionData, CreateEntityMentionErrors, CreateEntityMentionResponses, CreateFormData, CreateFormErrors, CreateFormResponses, CreateHarnessPairingData, CreateHarnessPairingErrors, CreateHarnessPairingResponses, CreateInitiativeData, CreateInitiativeErrors, CreateInitiativeResponses, CreateInstructionsHandlerData, CreateInstructionsHandlerErrors, CreateInstructionsHandlerResponses, CreateMarkdownHandlerData, CreateMarkdownHandlerErrors, CreateMarkdownHandlerResponses, CreateProjectHandlerData, CreateProjectHandlerErrors, CreateProjectHandlerResponses, CreateSkillHandlerData, CreateSkillHandlerErrors, CreateSkillHandlerResponses, CreateSlackImportData, CreateSlackImportErrors, CreateSlackImportResponses, CreateSnippetHandlerData, CreateSnippetHandlerErrors, CreateSnippetHandlerResponses, CreateTaskHandlerData, CreateTaskHandlerErrors, CreateTaskHandlerResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, CreateViewHandlerData, CreateViewHandlerErrors, CreateViewHandlerResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, DeclineCallData, DeclineCallErrors, DeclineCallResponses, DeclineRingData, DeclineRingErrors, DeclineRingResponses, DeleteAnchorData, DeleteAnchorErrors, DeleteAnchorResponses, DeleteCallRecordData, DeleteCallRecordErrors, DeleteCallRecordResponses, DeleteChannelData, DeleteChannelErrors, DeleteChannelLabelData, DeleteChannelLabelErrors, DeleteChannelLabelResponses, DeleteChannelResponses, DeleteCollabSurfaceData, DeleteCollabSurfaceErrors, DeleteCollabSurfaceResponses, DeleteDatabaseWebhookData, DeleteDatabaseWebhookErrors, DeleteDatabaseWebhookResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteEntityMentionData, DeleteEntityMentionErrors, DeleteEntityMentionResponses, DeleteHarnessData, DeleteHarnessErrors, DeleteHarnessResponses, DeleteHistoryHandlerData, DeleteHistoryHandlerErrors, DeleteHistoryHandlerResponses, DeleteInitiativeData, DeleteInitiativeErrors, DeleteInitiativeResponses, DeleteProjectHandlerData, DeleteProjectHandlerErrors, DeleteProjectHandlerResponses, DeleteSelfHarnessData, DeleteSelfHarnessErrors, DeleteSelfHarnessResponses, DeleteUserApiKeyData, DeleteUserApiKeyErrors, DeleteUserApiKeyResponses, DeleteUserDocumentViewLocationData, DeleteUserDocumentViewLocationErrors, DeleteUserDocumentViewLocationResponses, DeleteViewHandlerData, DeleteViewHandlerErrors, DeleteViewHandlerResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponses, DeliverDatabaseWebhookData, DeliverDatabaseWebhookErrors, DeliverDatabaseWebhookResponses, EditAnchorData, EditAnchorErrors, EditAnchorResponses, EditCallRecordData, EditCallRecordErrors, EditCallRecordResponses, EditCallTranscriptData, EditCallTranscriptErrors, EditCallTranscriptResponses, EditDocumentData, EditDocumentErrors, EditDocumentResponses, EditMyFormResponseData, EditMyFormResponseErrors, EditMyFormResponseResponses, EditProjectV2Data, EditProjectV2Errors, EditProjectV2Responses, EditThreadV2Data, EditThreadV2Errors, EditThreadV2Responses, EnsureCollabSurfaceData, EnsureCollabSurfaceErrors, EnsureCollabSurfaceResponses, EnsureStarterHandlerData, EnsureStarterHandlerErrors, EnsureStarterHandlerResponses, EntityMessageCreateData, EntityMessageCreateResponses, EntityMessageDeleteMessageData, EntityMessageDeleteMessageResponses, EntityMessageDeleteThreadData, EntityMessageDeleteThreadResponses, EntityMessageEditData, EntityMessageEditResponses, EntityMessageGetMessageData, EntityMessageGetMessageResponses, EntityMessageGetThreadData, EntityMessageGetThreadResponses, EntityMessageLegacyData, EntityMessageLegacyResponses, EntityMessagePatchThreadData, EntityMessagePatchThreadResponses, EntityMessageReactData, EntityMessageReactResponses, EntityMessageTypingData, EntityMessageTypingResponses, ExcludeDefaultViewHandlerData, ExcludeDefaultViewHandlerErrors, ExcludeDefaultViewHandlerResponses, ExportDocumentData, ExportDocumentErrors, ExportDocumentResponses, FinalizeSlackImportData, FinalizeSlackImportErrors, FinalizeSlackImportResponses, GetActiveCallsData, GetActiveCallsErrors, GetActiveCallsResponses, GetActivityData, GetActivityErrors, GetActivityResponses, GetAttachmentReferencesData, GetAttachmentReferencesErrors, GetAttachmentReferencesResponses, GetBatchCallRecordPreviewData, GetBatchCallRecordPreviewErrors, GetBatchCallRecordPreviewResponses, GetBatchChannelPreviewData, GetBatchChannelPreviewErrors, GetBatchChannelPreviewResponses, GetBatchPreviewHandlerData, GetBatchPreviewHandlerErrors, GetBatchPreviewHandlerResponses, GetBatchProjectPreviewData, GetBatchProjectPreviewErrors, GetBatchProjectPreviewResponses, GetBotOwnerProfilesData, GetBotOwnerProfilesErrors, GetBotOwnerProfilesResponses, GetCallRecordData, GetCallRecordErrors, GetCallRecordResponses, GetChannelAttachmentsData, GetChannelAttachmentsErrors, GetChannelAttachmentsResponses, GetChannelData, GetChannelErrors, GetChannelJoinLinkData, GetChannelJoinLinkErrors, GetChannelJoinLinkResponses, GetChannelParticipantsData, GetChannelParticipantsErrors, GetChannelParticipantsResponses, GetChannelResponses, GetChannelsData, GetChannelsErrors, GetChannelsResponses, GetCollabSurfaceData, GetCollabSurfaceErrors, GetCollabSurfaceResponses, GetCompanyData, GetCompanyErrors, GetCompanyResponses, GetContactByEmailData, GetContactByEmailErrors, GetContactByEmailResponses, GetContactData, GetContactErrors, GetContactResponses, GetCrmPipelineData, GetCrmPipelinePermissionsData, GetCrmPipelinePermissionsResponses, GetCrmPipelineResponses, GetCrmPipelineRowsData, GetCrmPipelineRowsResponses, GetCrmPipelineTableData, GetCrmPipelineTableResponses, GetCrmTeamSettingsData, GetCrmTeamSettingsErrors, GetCrmTeamSettingsResponses, GetDatabaseData, GetDatabaseErrors, GetDatabasePermissionsData, GetDatabasePermissionsErrors, GetDatabasePermissionsResponses, GetDatabaseQueryData, GetDatabaseQueryErrors, GetDatabaseQueryResponses, GetDatabaseResponses, GetDatabaseRowHistoryData, GetDatabaseRowHistoryErrors, GetDatabaseRowHistoryResponses, GetDatabaseTableChangesData, GetDatabaseTableChangesErrors, GetDatabaseTableChangesResponses, GetDatabaseViewPositionsData, GetDatabaseViewPositionsErrors, GetDatabaseViewPositionsResponses, GetDocumentAnchorsData, GetDocumentAnchorsErrors, GetDocumentAnchorsResponses, GetDocumentBranchNameData, GetDocumentBranchNameErrors, GetDocumentBranchNameResponses, GetDocumentByTeamSlugData, GetDocumentByTeamSlugErrors, GetDocumentByTeamSlugResponses, GetDocumentData, GetDocumentErrors, GetDocumentGithubPullRequestsData, GetDocumentGithubPullRequestsErrors, GetDocumentGithubPullRequestsResponses, GetDocumentListHandlerData, GetDocumentListHandlerErrors, GetDocumentListHandlerResponses, GetDocumentLocationV3Data, GetDocumentLocationV3Errors, GetDocumentLocationV3Responses, GetDocumentPermissionsTokenData, GetDocumentPermissionsTokenErrors, GetDocumentPermissionsTokenResponses, GetDocumentPermissionsV2Data, GetDocumentPermissionsV2Errors, GetDocumentPermissionsV2Responses, GetDocumentProcessingResultData, GetDocumentProcessingResultErrors, GetDocumentProcessingResultResponses, GetDocumentResponses, GetDocumentShortIdData, GetDocumentShortIdErrors, GetDocumentShortIdResponses, GetDocumentTeamShareData, GetDocumentTeamShareErrors, GetDocumentTeamShareResponses, GetDocumentTextContentData, GetDocumentTextContentErrors, GetDocumentTextContentResponses, GetDocumentVersionData, GetDocumentVersionErrors, GetDocumentVersionResponses, GetDocumentViewsHandlerData, GetDocumentViewsHandlerErrors, GetDocumentViewsHandlerResponses, GetEmailFollowupData, GetEmailFollowupErrors, GetEmailFollowupResponses, GetEntityPermissionData, GetEntityPermissionErrors, GetEntityPermissionResponses, GetForeignEntityBySourceData, GetForeignEntityBySourceErrors, GetForeignEntityBySourceResponses, GetForeignEntityData, GetForeignEntityErrors, GetForeignEntityResponses, GetFormData, GetFormErrors, GetFormPermissionsData, GetFormPermissionsErrors, GetFormPermissionsResponses, GetFormResponses, GetFormResponseSummaryData, GetFormResponseSummaryErrors, GetFormResponseSummaryResponses, GetFormTallyData, GetFormTallyErrors, GetFormTallyResponses, GetGithubPullRequestChangesData, GetGithubPullRequestChangesErrors, GetGithubPullRequestChangesPatchData, GetGithubPullRequestChangesPatchErrors, GetGithubPullRequestChangesPatchResponses, GetGithubPullRequestChangesResponses, GetGithubPullRequestData, GetGithubPullRequestErrors, GetGithubPullRequestFacetsData, GetGithubPullRequestFacetsErrors, GetGithubPullRequestFacetsResponses, GetGithubPullRequestResponses, GetGithubPullRequestTasksData, GetGithubPullRequestTasksErrors, GetGithubPullRequestTasksResponses, GetHarnessPairingData, GetHarnessPairingErrors, GetHarnessPairingResponses, GetHistoryHandlerData, GetHistoryHandlerErrors, GetHistoryHandlerResponses, GetInitiativeData, GetInitiativeErrors, GetInitiativeResponses, GetInstructionsHandlerData, GetInstructionsHandlerErrors, GetInstructionsHandlerResponses, GetItemsSoupData, GetItemsSoupErrors, GetItemsSoupResponses, GetLocationHandlerData, GetLocationHandlerErrors, GetLocationHandlerResponses, GetMyFormResponseData, GetMyFormResponseErrors, GetMyFormResponseResponses, GetOrCreateCallData, GetOrCreateCallErrors, GetOrCreateCallResponses, GetOrCreateDmData, GetOrCreateDmErrors, GetOrCreateDmResponses, GetOrCreatePrivateData, GetOrCreatePrivateErrors, GetOrCreatePrivateResponses, GetPendingProjectsHandlerData, GetPendingProjectsHandlerErrors, GetPendingProjectsHandlerResponses, GetPinsHandlerData, GetPinsHandlerErrors, GetPinsHandlerResponses, GetProjectContentHandlerData, GetProjectContentHandlerErrors, GetProjectContentHandlerResponses, GetProjectHandlerData, GetProjectHandlerErrors, GetProjectHandlerResponses, GetProjectPermissionsV2Data, GetProjectPermissionsV2Errors, GetProjectPermissionsV2Responses, GetProjectsHandlerData, GetProjectsHandlerErrors, GetProjectsHandlerResponses, GetProjectUserAccessLevelData, GetProjectUserAccessLevelErrors, GetProjectUserAccessLevelResponses, GetRingStatusData, GetRingStatusErrors, GetRingStatusResponses, GetSelfBotData, GetSelfBotErrors, GetSelfBotResponses, GetSelfHarnessData, GetSelfHarnessErrors, GetSelfHarnessResponses, GetSlackImportData, GetSlackImportErrors, GetSlackImportResponses, GetSystemSkillsHandlerData, GetSystemSkillsHandlerErrors, GetSystemSkillsHandlerResponses, GetUserDocumentsHandlerData, GetUserDocumentsHandlerErrors, GetUserDocumentsHandlerResponses, GetUserDocumentViewLocationData, GetUserDocumentViewLocationErrors, GetUserDocumentViewLocationResponses, GetViewsHandlerData, GetViewsHandlerErrors, GetViewsHandlerResponses, GetWebhookData, GetWebhookErrors, GetWebhookResponses, GuestCallChatPostData, GuestCallChatPostErrors, GuestCallChatPostResponses, GuestCallChatReadData, GuestCallChatReadErrors, GuestCallChatReadResponses, HandlerData, HandlerErrors, HandlerResponses, HealthHandlerData, HealthHandlerResponses, ImportDatabaseTableData, ImportDatabaseTableErrors, ImportDatabaseTableResponses, InferDatabaseColumnTypeData, InferDatabaseColumnTypeErrors, InferDatabaseColumnTypeResponses, IngestTranscriptData, IngestTranscriptErrors, IngestTranscriptResponses, InitializeUserDocumentsData, InitializeUserDocumentsErrors, InitializeUserDocumentsResponses, InstallSyncData, InstallSyncErrors, JobProcessingResultHandlerData, JobProcessingResultHandlerErrors, JobProcessingResultHandlerResponses, JoinChannelByCodeData, JoinChannelByCodeErrors, JoinChannelByCodeResponses, JoinChannelData, JoinChannelErrors, JoinChannelResponses, LeaveChannelData, LeaveChannelErrors, LeaveChannelResponses, LeaveOrEndCallData, LeaveOrEndCallErrors, LeaveOrEndCallResponses, ListAccessibleFormsData, ListAccessibleFormsErrors, ListAccessibleFormsResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBotChannelsData, ListBotChannelsErrors, ListBotChannelsResponses, ListChannelLabelsData, ListChannelLabelsErrors, ListChannelLabelsResponses, ListCompanyContactsData, ListCompanyContactsErrors, ListCompanyContactsResponses, ListCrmPipelinesData, ListCrmPipelinesResponses, ListDatabaseColumnCastsData, ListDatabaseColumnCastsErrors, ListDatabaseColumnCastsResponses, ListDatabasesData, ListDatabasesErrors, ListDatabasesResponses, ListDatabaseWebhooksData, ListDatabaseWebhooksErrors, ListDatabaseWebhooksResponses, ListEmailRemindersData, ListEmailRemindersErrors, ListEmailRemindersResponses, ListFavoritesData, ListFavoritesErrors, ListFavoritesResponses, ListFormsData, ListFormsErrors, ListFormsResponses, ListHarnessAgentsData, ListHarnessAgentsErrors, ListHarnessAgentsResponses, ListHarnessesData, ListHarnessesErrors, ListHarnessesResponses, ListHarnessSessionsData, ListHarnessSessionsErrors, ListHarnessSessionsResponses, ListInitiativesData, ListInitiativesErrors, ListInitiativesResponses, ListOccurrencesData, ListOccurrencesErrors, ListOccurrencesResponses, ListSlackImportsData, ListSlackImportsResponses, ListTeamCalendarData, ListTeamCalendarResponses, ListTeamOutOfOfficeData, ListTeamOutOfOfficeErrors, ListTeamOutOfOfficeResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, MeetingCancelData, MeetingCancelErrors, MeetingCancelPreparationData, MeetingCancelPreparationErrors, MeetingCancelPreparationResponses, MeetingCancelResponses, MeetingCreateData, MeetingCreateErrors, MeetingCreateResponses, MeetingGuestJoinData, MeetingGuestJoinErrors, MeetingGuestJoinResponses, MeetingGuestParticipantsData, MeetingGuestParticipantsErrors, MeetingGuestParticipantsResponses, MeetingInviteData, MeetingInviteErrors, MeetingInvitePermissionsData, MeetingInvitePermissionsErrors, MeetingInvitePermissionsResponses, MeetingInviteResponses, MeetingInviteUsersData, MeetingInviteUsersErrors, MeetingInviteUsersResponses, MeetingJoinData, MeetingJoinErrors, MeetingJoinResponses, MeetingLeaveData, MeetingLeaveErrors, MeetingLeaveResponses, MeetingListActiveData, MeetingListActiveErrors, MeetingListActiveResponses, MeetingListData, MeetingListErrors, MeetingListResponses, MeetingLookupData, MeetingLookupErrors, MeetingLookupResponses, MeetingParticipantsData, MeetingParticipantsErrors, MeetingParticipantsResponses, MeetingPrepareData, MeetingPrepareErrors, MeetingPrepareResponses, MeetingShareData, MeetingShareErrors, MeetingShareResponses, MeetingUpdateData, MeetingUpdateErrors, MeetingUpdateResponses, MentionPreviewsData, MentionPreviewsErrors, MentionPreviewsResponses, MessageTimelineData, MessageTimelineEntriesData, MessageTimelineEntriesResponses, MessageTimelineResponses, PatchChannelData, PatchChannelErrors, PatchChannelResponses, PatchViewHandlerData, PatchViewHandlerErrors, PatchViewHandlerResponses, PatchWebhookData, PatchWebhookErrors, PatchWebhookResponses, PermanentlyDeleteDocumentData, PermanentlyDeleteDocumentErrors, PermanentlyDeleteDocumentResponses, PermanentlyDeleteProjectData, PermanentlyDeleteProjectErrors, PermanentlyDeleteProjectResponses, PostActivityData, PostActivityErrors, PostActivityResponses, PostChannelBotWebhookData, PostChannelBotWebhookErrors, PostChannelBotWebhookResponses, PostItemsSoupAstData, PostItemsSoupAstErrors, PostItemsSoupAstGroupedData, PostItemsSoupAstGroupedErrors, PostItemsSoupAstGroupedResponses, PostItemsSoupAstResponses, PostItemsSoupData, PostItemsSoupErrors, PostItemsSoupResponses, PresaveDocumentHandlerData, PresaveDocumentHandlerErrors, PresaveDocumentHandlerResponses, PreviewSmartTagData, PreviewSmartTagErrors, PreviewSmartTagResponses, PutCrmTeamSettingsData, PutCrmTeamSettingsErrors, PutCrmTeamSettingsResponses, PutCrmTeamStagesData, PutCrmTeamStagesErrors, PutCrmTeamStagesResponses, PutFormLayoutData, PutFormLayoutErrors, PutFormLayoutResponses, QueryCrmPipelineRowsData, QueryCrmPipelineRowsResponses, QueryDatabasesData, QueryDatabasesErrors, QueryDatabasesResponses, RecentlyDeletedData, RecentlyDeletedErrors, RecentlyDeletedResponses, RegisterSlackImportUploadsData, RegisterSlackImportUploadsErrors, RegisterSlackImportUploadsResponses, RemoveBotFromChannelByBotData, RemoveBotFromChannelByBotErrors, RemoveBotFromChannelByBotResponses, RemoveFavoriteByEntityData, RemoveFavoriteByEntityErrors, RemoveFavoriteByEntityResponses, RemoveParticipantsData, RemoveParticipantsErrors, RemoveParticipantsResponses, RemovePinHandlerData, RemovePinHandlerErrors, RemovePinHandlerResponses, RenameChannelLabelData, RenameChannelLabelErrors, RenameChannelLabelResponses, RenameCrmPipelineData, RenameCrmPipelineResponses, ReorderFavoritesData, ReorderFavoritesErrors, ReorderFavoritesResponses, ReorderPinsHandlerData, ReorderPinsHandlerErrors, ReorderPinsHandlerResponses, ResetCrmTeamStagesData, ResetCrmTeamStagesErrors, ResetCrmTeamStagesResponses, RevertDeleteDocumentData, RevertDeleteDocumentErrors, RevertDeleteDocumentResponses, RevertDeleteProjectData, RevertDeleteProjectErrors, RevertDeleteProjectResponses, SaveDatabaseQueryData, SaveDatabaseQueryErrors, SaveDatabaseQueryResponses, SaveDocumentHandlerData, SaveDocumentHandlerErrors, SaveDocumentHandlerResponses, SearchContactsData, SearchContactsErrors, SearchContactsResponses, SetChannelLabelData, SetChannelLabelErrors, SetChannelLabelResponses, SetChannelPictureData, SetChannelPictureErrors, SetChannelPictureResponses, SetCompanyHiddenData, SetCompanyHiddenErrors, SetCompanyHiddenResponses, SetContactHiddenData, SetContactHiddenErrors, SetContactHiddenResponses, SetCrmCompanyNameData, SetCrmCompanyNameErrors, SetCrmCompanyNameResponses, SetCrmContactNameData, SetCrmContactNameErrors, SetCrmContactNameResponses, SetDocumentTeamShareData, SetDocumentTeamShareErrors, SetDocumentTeamShareResponses, SetEmailFollowupData, SetEmailFollowupErrors, SetEmailFollowupResponses, SetEmailSyncData, SetEmailSyncErrors, SetEmailSyncResponses, ShareCrmPipelineData, ShareCrmPipelineResponses, ShareDatabaseAwarenessData, ShareDatabaseAwarenessErrors, ShareDatabaseAwarenessResponses, SimpleSaveData, SimpleSaveErrors, SimpleSaveResponses, StreamEventsData, StreamEventsResponse, StreamEventsResponses, SubmitFormResponseData, SubmitFormResponseErrors, SubmitFormResponseResponses, ToggleShareWithTeamData, ToggleShareWithTeamErrors, ToggleShareWithTeamResponses, TranscribeDictationData, TranscribeDictationErrors, TranscribeDictationResponses, TrashCrmPipelineData, TrashCrmPipelineResponses, UndoDatabaseChangeData, UndoDatabaseChangeErrors, UndoDatabaseChangeResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateCrmPipelinePermissionsData, UpdateCrmPipelinePermissionsResponses, UpdateDatabasePermissionsData, UpdateDatabasePermissionsErrors, UpdateDatabasePermissionsResponses, UpdateFormData, UpdateFormErrors, UpdateFormPermissionsData, UpdateFormPermissionsErrors, UpdateFormPermissionsResponses, UpdateFormResponses, UpdateInitiativeData, UpdateInitiativeErrors, UpdateInitiativeResponses, UploadExtractFolderHandlerData, UploadExtractFolderHandlerErrors, UploadExtractFolderHandlerResponses, UploadFolderHandlerData, UploadFolderHandlerErrors, UploadFolderHandlerResponses, UpsertHistoryHandlerData, UpsertHistoryHandlerErrors, UpsertHistoryHandlerResponses, UpsertUserDocumentViewLocationData, UpsertUserDocumentViewLocationErrors, UpsertUserDocumentViewLocationResponses, ValidateDocumentPermissionsTokenData, ValidateDocumentPermissionsTokenErrors, ValidateDocumentPermissionsTokenResponses, ValidateWebhookData, ValidateWebhookErrors, ValidateWebhookResponses } 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
|
|
@@ -32,8 +32,19 @@ export declare class Sdk extends HeyApiClient {
|
|
|
32
32
|
key?: string;
|
|
33
33
|
});
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
36
|
-
|
|
35
|
+
* Handler for `GET /agents`.
|
|
36
|
+
*/
|
|
37
|
+
listAgents<ThrowOnError extends boolean = false>(options?: Options<ListAgentsData, ThrowOnError>): RequestResult<ListAgentsResponses, ListAgentsErrors, ThrowOnError>;
|
|
38
|
+
/**
|
|
39
|
+
* Handler for `POST /agents`.
|
|
40
|
+
*/
|
|
41
|
+
createAgent<ThrowOnError extends boolean = false>(options: Options<CreateAgentData, ThrowOnError>): RequestResult<CreateAgentResponses, CreateAgentErrors, ThrowOnError>;
|
|
42
|
+
/**
|
|
43
|
+
* Handler for `PUT /agents/{agent_id}`.
|
|
44
|
+
*/
|
|
45
|
+
updateAgent<ThrowOnError extends boolean = false>(options: Options<UpdateAgentData, ThrowOnError>): RequestResult<UpdateAgentResponses, UpdateAgentErrors, ThrowOnError>;
|
|
46
|
+
/**
|
|
47
|
+
* Deletes a highlight and any attached discussion under the annotation policy.
|
|
37
48
|
*/
|
|
38
49
|
deleteAnchor<ThrowOnError extends boolean = false>(options: Options<DeleteAnchorData, ThrowOnError>): RequestResult<DeleteAnchorResponses, DeleteAnchorErrors, ThrowOnError>;
|
|
39
50
|
/**
|
|
@@ -46,30 +57,21 @@ export declare class Sdk extends HeyApiClient {
|
|
|
46
57
|
getDocumentAnchors<ThrowOnError extends boolean = false>(options: Options<GetDocumentAnchorsData, ThrowOnError>): RequestResult<GetDocumentAnchorsResponses, GetDocumentAnchorsErrors, ThrowOnError>;
|
|
47
58
|
/**
|
|
48
59
|
* Creates an unthreaded anchor for a document
|
|
49
|
-
*
|
|
60
|
+
* Attach a discussion through the shared message API.
|
|
50
61
|
*/
|
|
51
62
|
createAnchor<ThrowOnError extends boolean = false>(options: Options<CreateAnchorData, ThrowOnError>): RequestResult<CreateAnchorResponses, CreateAnchorErrors, ThrowOnError>;
|
|
52
|
-
/**
|
|
53
|
-
* Deletes a single comment for a document
|
|
54
|
-
*/
|
|
55
|
-
deleteComment<ThrowOnError extends boolean = false>(options: Options<DeleteCommentData, ThrowOnError>): RequestResult<DeleteCommentResponses, DeleteCommentErrors, ThrowOnError>;
|
|
56
|
-
/**
|
|
57
|
-
* Edits a single comment for a document
|
|
58
|
-
*/
|
|
59
|
-
editComment<ThrowOnError extends boolean = false>(options: Options<EditCommentData, ThrowOnError>): RequestResult<EditCommentResponses, EditCommentErrors, ThrowOnError>;
|
|
60
|
-
/**
|
|
61
|
-
* Gets a set of comment threads for a document
|
|
62
|
-
*/
|
|
63
|
-
getDocumentComments<ThrowOnError extends boolean = false>(options: Options<GetDocumentCommentsData, ThrowOnError>): RequestResult<GetDocumentCommentsResponses, GetDocumentCommentsErrors, ThrowOnError>;
|
|
64
|
-
/**
|
|
65
|
-
* Creates a single comment for a document
|
|
66
|
-
* Optionally creates a new thread/anchor if one does not exist
|
|
67
|
-
*/
|
|
68
|
-
createComment<ThrowOnError extends boolean = false>(options: Options<CreateCommentData, ThrowOnError>): RequestResult<CreateCommentResponses, CreateCommentErrors, ThrowOnError>;
|
|
69
63
|
/**
|
|
70
64
|
* Handler for `GET /bots/me`.
|
|
71
65
|
*/
|
|
72
66
|
getSelfBot<ThrowOnError extends boolean = false>(options?: Options<GetSelfBotData, ThrowOnError>): RequestResult<GetSelfBotResponses, GetSelfBotErrors, ThrowOnError>;
|
|
67
|
+
/**
|
|
68
|
+
* Handler for `GET /bots/profiles`.
|
|
69
|
+
*
|
|
70
|
+
* Returns display fields and the sponsor for each requested bot. Not a
|
|
71
|
+
* manageability check: any authenticated user or internal caller may look up
|
|
72
|
+
* ids they already have.
|
|
73
|
+
*/
|
|
74
|
+
getBotOwnerProfiles<ThrowOnError extends boolean = false>(options?: Options<GetBotOwnerProfilesData, ThrowOnError>): RequestResult<GetBotOwnerProfilesResponses, GetBotOwnerProfilesErrors, ThrowOnError>;
|
|
73
75
|
/**
|
|
74
76
|
* Handler for `GET /bots/{bot_id}/channels`.
|
|
75
77
|
*/
|
|
@@ -86,6 +88,14 @@ export declare class Sdk extends HeyApiClient {
|
|
|
86
88
|
* Resolve mentioned calendar events to the requester's own projections.
|
|
87
89
|
*/
|
|
88
90
|
mentionPreviews<ThrowOnError extends boolean = false>(options: Options<MentionPreviewsData, ThrowOnError>): RequestResult<MentionPreviewsResponses, MentionPreviewsErrors, ThrowOnError>;
|
|
91
|
+
/**
|
|
92
|
+
* Query authorized projections in a bounded viewport.
|
|
93
|
+
*/
|
|
94
|
+
listTeamCalendar<ThrowOnError extends boolean = false>(options: Options<ListTeamCalendarData, ThrowOnError>): RequestResult<ListTeamCalendarResponses, unknown, ThrowOnError>;
|
|
95
|
+
/**
|
|
96
|
+
* Return teammates' out-of-office occurrences in the requested viewport.
|
|
97
|
+
*/
|
|
98
|
+
listTeamOutOfOffice<ThrowOnError extends boolean = false>(options: Options<ListTeamOutOfOfficeData, ThrowOnError>): RequestResult<ListTeamOutOfOfficeResponses, ListTeamOutOfOfficeErrors, ThrowOnError>;
|
|
89
99
|
/**
|
|
90
100
|
* Handler for `GET /call/active`.
|
|
91
101
|
*
|
|
@@ -94,6 +104,78 @@ export declare class Sdk extends HeyApiClient {
|
|
|
94
104
|
* webhooks) are excluded.
|
|
95
105
|
*/
|
|
96
106
|
getActiveCalls<ThrowOnError extends boolean = false>(options?: Options<GetActiveCallsData, ThrowOnError>): RequestResult<GetActiveCallsResponses, GetActiveCallsErrors, ThrowOnError>;
|
|
107
|
+
/**
|
|
108
|
+
* Read the live call discussion as a verified guest.
|
|
109
|
+
*/
|
|
110
|
+
guestCallChatRead<ThrowOnError extends boolean = false>(options: Options<GuestCallChatReadData, ThrowOnError>): RequestResult<GuestCallChatReadResponses, GuestCallChatReadErrors, ThrowOnError>;
|
|
111
|
+
/**
|
|
112
|
+
* Append text to the same saved discussion used by account participants.
|
|
113
|
+
*/
|
|
114
|
+
guestCallChatPost<ThrowOnError extends boolean = false>(options: Options<GuestCallChatPostData, ThrowOnError>): RequestResult<GuestCallChatPostResponses, GuestCallChatPostErrors, ThrowOnError>;
|
|
115
|
+
/**
|
|
116
|
+
* Handle `GET /call/join/{token}` through the call domain service.
|
|
117
|
+
*/
|
|
118
|
+
meetingLookup<ThrowOnError extends boolean = false>(options: Options<MeetingLookupData, ThrowOnError>): RequestResult<MeetingLookupResponses, MeetingLookupErrors, ThrowOnError>;
|
|
119
|
+
/**
|
|
120
|
+
* Handle `POST /call/join/{token}` through the call domain service.
|
|
121
|
+
*/
|
|
122
|
+
meetingGuestJoin<ThrowOnError extends boolean = false>(options: Options<MeetingGuestJoinData, ThrowOnError>): RequestResult<MeetingGuestJoinResponses, MeetingGuestJoinErrors, ThrowOnError>;
|
|
123
|
+
/**
|
|
124
|
+
* Handle `POST /call/join/{token}/leave` through the call domain service.
|
|
125
|
+
*/
|
|
126
|
+
meetingLeave<ThrowOnError extends boolean = false>(options: Options<MeetingLeaveData, ThrowOnError>): RequestResult<MeetingLeaveResponses, MeetingLeaveErrors, ThrowOnError>;
|
|
127
|
+
/**
|
|
128
|
+
* Read a standalone meeting preview without admitting a guest to the room.
|
|
129
|
+
*/
|
|
130
|
+
meetingGuestParticipants<ThrowOnError extends boolean = false>(options: Options<MeetingGuestParticipantsData, ThrowOnError>): RequestResult<MeetingGuestParticipantsResponses, MeetingGuestParticipantsErrors, ThrowOnError>;
|
|
131
|
+
/**
|
|
132
|
+
* Handle `GET /call/meetings` through the call domain service.
|
|
133
|
+
*/
|
|
134
|
+
meetingList<ThrowOnError extends boolean = false>(options?: Options<MeetingListData, ThrowOnError>): RequestResult<MeetingListResponses, MeetingListErrors, ThrowOnError>;
|
|
135
|
+
/**
|
|
136
|
+
* Handle `POST /call/meetings` through the call domain service.
|
|
137
|
+
*/
|
|
138
|
+
meetingCreate<ThrowOnError extends boolean = false>(options: Options<MeetingCreateData, ThrowOnError>): RequestResult<MeetingCreateResponses, MeetingCreateErrors, ThrowOnError>;
|
|
139
|
+
/**
|
|
140
|
+
* List the authenticated actor's active quick calls.
|
|
141
|
+
*/
|
|
142
|
+
meetingListActive<ThrowOnError extends boolean = false>(options?: Options<MeetingListActiveData, ThrowOnError>): RequestResult<MeetingListActiveResponses, MeetingListActiveErrors, ThrowOnError>;
|
|
143
|
+
/**
|
|
144
|
+
* Read the authenticated caller's invitation capability without exposing the creator.
|
|
145
|
+
*/
|
|
146
|
+
meetingInvitePermissions<ThrowOnError extends boolean = false>(options: Options<MeetingInvitePermissionsData, ThrowOnError>): RequestResult<MeetingInvitePermissionsResponses, MeetingInvitePermissionsErrors, ThrowOnError>;
|
|
147
|
+
/**
|
|
148
|
+
* Queue an owner-authorized guest invitation email.
|
|
149
|
+
*/
|
|
150
|
+
meetingInvite<ThrowOnError extends boolean = false>(options: Options<MeetingInviteData, ThrowOnError>): RequestResult<MeetingInviteResponses, MeetingInviteErrors, ThrowOnError>;
|
|
151
|
+
/**
|
|
152
|
+
* Ring registered teammates selected by the standalone meeting owner.
|
|
153
|
+
*/
|
|
154
|
+
meetingInviteUsers<ThrowOnError extends boolean = false>(options: Options<MeetingInviteUsersData, ThrowOnError>): RequestResult<MeetingInviteUsersResponses, MeetingInviteUsersErrors, ThrowOnError>;
|
|
155
|
+
/**
|
|
156
|
+
* Handle `POST /call/meetings/join/{token}` through the call domain service.
|
|
157
|
+
*/
|
|
158
|
+
meetingJoin<ThrowOnError extends boolean = false>(options: Options<MeetingJoinData, ThrowOnError>): RequestResult<MeetingJoinResponses, MeetingJoinErrors, ThrowOnError>;
|
|
159
|
+
/**
|
|
160
|
+
* Read the participant preview for an authenticated invitation holder.
|
|
161
|
+
*/
|
|
162
|
+
meetingParticipants<ThrowOnError extends boolean = false>(options: Options<MeetingParticipantsData, ThrowOnError>): RequestResult<MeetingParticipantsResponses, MeetingParticipantsErrors, ThrowOnError>;
|
|
163
|
+
/**
|
|
164
|
+
* Reserve a room while the authenticated caller configures a new call.
|
|
165
|
+
*/
|
|
166
|
+
meetingPrepare<ThrowOnError extends boolean = false>(options?: Options<MeetingPrepareData, ThrowOnError>): RequestResult<MeetingPrepareResponses, MeetingPrepareErrors, ThrowOnError>;
|
|
167
|
+
/**
|
|
168
|
+
* Cancel an unused room; the domain owns ownership and activation checks.
|
|
169
|
+
*/
|
|
170
|
+
meetingCancelPreparation<ThrowOnError extends boolean = false>(options: Options<MeetingCancelPreparationData, ThrowOnError>): RequestResult<MeetingCancelPreparationResponses, MeetingCancelPreparationErrors, ThrowOnError>;
|
|
171
|
+
/**
|
|
172
|
+
* Handle `DELETE /call/meetings/{meeting_id}` through the call domain service.
|
|
173
|
+
*/
|
|
174
|
+
meetingCancel<ThrowOnError extends boolean = false>(options: Options<MeetingCancelData, ThrowOnError>): RequestResult<MeetingCancelResponses, MeetingCancelErrors, ThrowOnError>;
|
|
175
|
+
/**
|
|
176
|
+
* Handle owner-authorized meeting title and schedule edits.
|
|
177
|
+
*/
|
|
178
|
+
meetingUpdate<ThrowOnError extends boolean = false>(options: Options<MeetingUpdateData, ThrowOnError>): RequestResult<MeetingUpdateResponses, MeetingUpdateErrors, ThrowOnError>;
|
|
97
179
|
/**
|
|
98
180
|
* Handler for `POST /call/record/preview`.
|
|
99
181
|
*
|
|
@@ -121,15 +203,33 @@ export declare class Sdk extends HeyApiClient {
|
|
|
121
203
|
/**
|
|
122
204
|
* Handler for `PATCH /call/record/{call_id}`.
|
|
123
205
|
*
|
|
124
|
-
* Edits a call record
|
|
125
|
-
*
|
|
206
|
+
* Edits a call record: link/channel share permissions, display name, and
|
|
207
|
+
* team sharing. Edit access (channel membership) is required for the request.
|
|
208
|
+
* `sharePermission.teamShareAccessLevel` only accepts `view` or `null`; while
|
|
209
|
+
* the call is live it sets the pending share-with-team toggle, and once the
|
|
210
|
+
* call is archived it is additionally authorized against the call's creator.
|
|
126
211
|
*/
|
|
127
212
|
editCallRecord<ThrowOnError extends boolean = false>(options: Options<EditCallRecordData, ThrowOnError>): RequestResult<EditCallRecordResponses, EditCallRecordErrors, ThrowOnError>;
|
|
213
|
+
/**
|
|
214
|
+
* Handler for `POST /call/record/{call_id}/decline`.
|
|
215
|
+
*
|
|
216
|
+
* Declines the identified active call for the caller without joining it.
|
|
217
|
+
* Bound to `call_id` so a stale incoming-call UI cannot decline a newer call
|
|
218
|
+
* that replaced it in the same channel. The caller's other devices are told
|
|
219
|
+
* to stop ringing (`call_declined`); the call continues for everyone else.
|
|
220
|
+
*/
|
|
221
|
+
declineCall<ThrowOnError extends boolean = false>(options: Options<DeclineCallData, ThrowOnError>): RequestResult<DeclineCallResponses, DeclineCallErrors, ThrowOnError>;
|
|
222
|
+
/**
|
|
223
|
+
* Handle `POST /call/record/{call_id}/link` through the call domain service.
|
|
224
|
+
*/
|
|
225
|
+
meetingShare<ThrowOnError extends boolean = false>(options: Options<MeetingShareData, ThrowOnError>): RequestResult<MeetingShareResponses, MeetingShareErrors, ThrowOnError>;
|
|
128
226
|
/**
|
|
129
227
|
* Handler for `POST /call/record/{call_id}/share-with-team/toggle`.
|
|
130
228
|
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
229
|
+
* Flips the live call's share-with-team toggle and returns the new value as
|
|
230
|
+
* the JSON body. The toggle is applied as canonical team sharing (View for
|
|
231
|
+
* the creator's team) when the call is archived; archived calls answer 409
|
|
232
|
+
* and are edited through `PATCH /call/record/{call_id}` instead.
|
|
133
233
|
*/
|
|
134
234
|
toggleShareWithTeam<ThrowOnError extends boolean = false>(options: Options<ToggleShareWithTeamData, ThrowOnError>): RequestResult<ToggleShareWithTeamResponses, ToggleShareWithTeamErrors, ThrowOnError>;
|
|
135
235
|
/**
|
|
@@ -152,6 +252,16 @@ export declare class Sdk extends HeyApiClient {
|
|
|
152
252
|
* LiveKit JWT from the VoIP push payload, verified with the LiveKit secret.
|
|
153
253
|
*/
|
|
154
254
|
getRingStatus<ThrowOnError extends boolean = false>(options: Options<GetRingStatusData, ThrowOnError>): RequestResult<GetRingStatusResponses, GetRingStatusErrors, ThrowOnError>;
|
|
255
|
+
/**
|
|
256
|
+
* Handler for `POST /call/ring-status/{call_id}/decline`.
|
|
257
|
+
*
|
|
258
|
+
* Declines a ringing call from a native client, e.g. the iPhone lock-screen
|
|
259
|
+
* decline button, so the user's other devices stop ringing. Authorized like
|
|
260
|
+
* [`ring_status_handler`]: the bearer credential is the recipient's LiveKit
|
|
261
|
+
* JWT from the VoIP push payload, which identifies both the room and the
|
|
262
|
+
* declining user.
|
|
263
|
+
*/
|
|
264
|
+
declineRing<ThrowOnError extends boolean = false>(options: Options<DeclineRingData, ThrowOnError>): RequestResult<DeclineRingResponses, DeclineRingErrors, ThrowOnError>;
|
|
155
265
|
/**
|
|
156
266
|
* Handler for `POST /call/webhook`.
|
|
157
267
|
*
|
|
@@ -185,6 +295,30 @@ export declare class Sdk extends HeyApiClient {
|
|
|
185
295
|
* Duplicate segments (same `segment_id`) are ignored.
|
|
186
296
|
*/
|
|
187
297
|
ingestTranscript<ThrowOnError extends boolean = false>(options: Options<IngestTranscriptData, ThrowOnError>): RequestResult<IngestTranscriptResponses, IngestTranscriptErrors, ThrowOnError>;
|
|
298
|
+
/**
|
|
299
|
+
* List the caller's shared or private labels.
|
|
300
|
+
*/
|
|
301
|
+
listChannelLabels<ThrowOnError extends boolean = false>(options?: Options<ListChannelLabelsData, ThrowOnError>): RequestResult<ListChannelLabelsResponses, ListChannelLabelsErrors, ThrowOnError>;
|
|
302
|
+
/**
|
|
303
|
+
* Create a label for the caller's authorized scope.
|
|
304
|
+
*/
|
|
305
|
+
createChannelLabel<ThrowOnError extends boolean = false>(options: Options<CreateChannelLabelData, ThrowOnError>): RequestResult<CreateChannelLabelResponses, CreateChannelLabelErrors, ThrowOnError>;
|
|
306
|
+
/**
|
|
307
|
+
* Move a channel into a label of the caller's authorized scope, or out of any label.
|
|
308
|
+
*/
|
|
309
|
+
setChannelLabel<ThrowOnError extends boolean = false>(options: Options<SetChannelLabelData, ThrowOnError>): RequestResult<SetChannelLabelResponses, SetChannelLabelErrors, ThrowOnError>;
|
|
310
|
+
/**
|
|
311
|
+
* Preview visible channels matched by a smart tag, without creating it.
|
|
312
|
+
*/
|
|
313
|
+
previewSmartTag<ThrowOnError extends boolean = false>(options: Options<PreviewSmartTagData, ThrowOnError>): RequestResult<PreviewSmartTagResponses, PreviewSmartTagErrors, ThrowOnError>;
|
|
314
|
+
/**
|
|
315
|
+
* Delete a label of the caller's authorized scope. Its channels return to the plain list.
|
|
316
|
+
*/
|
|
317
|
+
deleteChannelLabel<ThrowOnError extends boolean = false>(options: Options<DeleteChannelLabelData, ThrowOnError>): RequestResult<DeleteChannelLabelResponses, DeleteChannelLabelErrors, ThrowOnError>;
|
|
318
|
+
/**
|
|
319
|
+
* Rename a label of the caller's authorized scope.
|
|
320
|
+
*/
|
|
321
|
+
renameChannelLabel<ThrowOnError extends boolean = false>(options: Options<RenameChannelLabelData, ThrowOnError>): RequestResult<RenameChannelLabelResponses, RenameChannelLabelErrors, ThrowOnError>;
|
|
188
322
|
/**
|
|
189
323
|
* Handler for `POST /channels`.
|
|
190
324
|
*/
|
|
@@ -257,38 +391,6 @@ export declare class Sdk extends HeyApiClient {
|
|
|
257
391
|
* Handler for `POST /channels/{channel_id}/leave`.
|
|
258
392
|
*/
|
|
259
393
|
leaveChannel<ThrowOnError extends boolean = false>(options: Options<LeaveChannelData, ThrowOnError>): RequestResult<LeaveChannelResponses, LeaveChannelErrors, ThrowOnError>;
|
|
260
|
-
/**
|
|
261
|
-
* Handler for `POST /channels/{channel_id}/message`.
|
|
262
|
-
*/
|
|
263
|
-
postMessage<ThrowOnError extends boolean = false>(options: Options<PostMessageData, ThrowOnError>): RequestResult<PostMessageResponses, PostMessageErrors, ThrowOnError>;
|
|
264
|
-
/**
|
|
265
|
-
* Handler for `DELETE /channels/{channel_id}/message/{message_id}`.
|
|
266
|
-
*/
|
|
267
|
-
deleteMessage<ThrowOnError extends boolean = false>(options: Options<DeleteMessageData, ThrowOnError>): RequestResult<DeleteMessageResponses, DeleteMessageErrors, ThrowOnError>;
|
|
268
|
-
/**
|
|
269
|
-
* Handler for `PATCH /channels/{channel_id}/message/{message_id}`.
|
|
270
|
-
*/
|
|
271
|
-
patchMessage<ThrowOnError extends boolean = false>(options: Options<PatchMessageData, ThrowOnError>): RequestResult<PatchMessageResponses, PatchMessageErrors, ThrowOnError>;
|
|
272
|
-
/**
|
|
273
|
-
* Handler for `GET /channels/{channel_id}/messages`.
|
|
274
|
-
*/
|
|
275
|
-
getChannelMessages<ThrowOnError extends boolean = false>(options: Options<GetChannelMessagesData, ThrowOnError>): RequestResult<GetChannelMessagesResponses, GetChannelMessagesErrors, ThrowOnError>;
|
|
276
|
-
/**
|
|
277
|
-
* Handler for `POST /channels/{channel_id}/messages`.
|
|
278
|
-
*/
|
|
279
|
-
postChannelMessages<ThrowOnError extends boolean = false>(options: Options<PostChannelMessagesData, ThrowOnError>): RequestResult<PostChannelMessagesResponses, PostChannelMessagesErrors, ThrowOnError>;
|
|
280
|
-
/**
|
|
281
|
-
* Handler for `GET /channels/{channel_id}/messages/{message_id}/context`.
|
|
282
|
-
*/
|
|
283
|
-
getMessageWithContext<ThrowOnError extends boolean = false>(options: Options<GetMessageWithContextData, ThrowOnError>): RequestResult<GetMessageWithContextResponses, GetMessageWithContextErrors, ThrowOnError>;
|
|
284
|
-
/**
|
|
285
|
-
* Handler for `GET /channels/{channel_id}/messages/{message_id}/replies`.
|
|
286
|
-
*/
|
|
287
|
-
getThreadReplies<ThrowOnError extends boolean = false>(options: Options<GetThreadRepliesData, ThrowOnError>): RequestResult<GetThreadRepliesResponses, GetThreadRepliesErrors, ThrowOnError>;
|
|
288
|
-
/**
|
|
289
|
-
* Handler for `GET /channels/{channel_id}/messages/{message_id}/resolve`.
|
|
290
|
-
*/
|
|
291
|
-
resolveChannelMessage<ThrowOnError extends boolean = false>(options: Options<ResolveChannelMessageData, ThrowOnError>): RequestResult<ResolveChannelMessageResponses, ResolveChannelMessageErrors, ThrowOnError>;
|
|
292
394
|
/**
|
|
293
395
|
* Handler for `DELETE /channels/{channel_id}/participants`.
|
|
294
396
|
*/
|
|
@@ -302,13 +404,9 @@ export declare class Sdk extends HeyApiClient {
|
|
|
302
404
|
*/
|
|
303
405
|
addParticipants<ThrowOnError extends boolean = false>(options: Options<AddParticipantsData, ThrowOnError>): RequestResult<AddParticipantsResponses, AddParticipantsErrors, ThrowOnError>;
|
|
304
406
|
/**
|
|
305
|
-
*
|
|
306
|
-
*/
|
|
307
|
-
postReaction<ThrowOnError extends boolean = false>(options: Options<PostReactionData, ThrowOnError>): RequestResult<PostReactionResponses, PostReactionErrors, ThrowOnError>;
|
|
308
|
-
/**
|
|
309
|
-
* Handler for `POST /channels/{channel_id}/typing`.
|
|
407
|
+
* Set a channel or group chat profile picture. Requires channel participation.
|
|
310
408
|
*/
|
|
311
|
-
|
|
409
|
+
setChannelPicture<ThrowOnError extends boolean = false>(options: Options<SetChannelPictureData, ThrowOnError>): RequestResult<SetChannelPictureResponses, SetChannelPictureErrors, ThrowOnError>;
|
|
312
410
|
/**
|
|
313
411
|
* Handler for `POST /channels/{channel_id}/webhook`.
|
|
314
412
|
*/
|
|
@@ -338,32 +436,6 @@ export declare class Sdk extends HeyApiClient {
|
|
|
338
436
|
* Handle channel list requests for `GET /comms/channels`.
|
|
339
437
|
*/
|
|
340
438
|
getChannels<ThrowOnError extends boolean = false>(options?: Options<GetChannelsData, ThrowOnError>): RequestResult<GetChannelsResponses, GetChannelsErrors, ThrowOnError>;
|
|
341
|
-
/**
|
|
342
|
-
* Soft-delete a CRM comment, scoped to the requesting user's team. When it
|
|
343
|
-
* was the thread's last live comment, the thread is soft-deleted too
|
|
344
|
-
* (reported via `threadDeleted`).
|
|
345
|
-
*/
|
|
346
|
-
deleteCrmComment<ThrowOnError extends boolean = false>(options: Options<DeleteCrmCommentData, ThrowOnError>): RequestResult<DeleteCrmCommentResponses, DeleteCrmCommentErrors, ThrowOnError>;
|
|
347
|
-
/**
|
|
348
|
-
* Edit a CRM comment's text, scoped to the requesting user's team via the
|
|
349
|
-
* comment's thread → entity → company. Returns the updated comment.
|
|
350
|
-
*/
|
|
351
|
-
editCrmComment<ThrowOnError extends boolean = false>(options: Options<EditCrmCommentData, ThrowOnError>): RequestResult<EditCrmCommentResponses, EditCrmCommentErrors, ThrowOnError>;
|
|
352
|
-
/**
|
|
353
|
-
* List the comment threads on a CRM company or contact. Access is
|
|
354
|
-
* enforced by [`EntityPermissionExtractor`] against the path's
|
|
355
|
-
* `crm_company`/`crm_contact` entity type — hidden parents are
|
|
356
|
-
* invisible to plain members. An accessible entity with no threads
|
|
357
|
-
* returns `200 []`.
|
|
358
|
-
*/
|
|
359
|
-
listCrmComments<ThrowOnError extends boolean = false>(options: Options<ListCrmCommentsData, ThrowOnError>): RequestResult<ListCrmCommentsResponses, ListCrmCommentsErrors, ThrowOnError>;
|
|
360
|
-
/**
|
|
361
|
-
* Create a comment on a CRM company or contact — a new thread, or a reply
|
|
362
|
-
* when `threadId` is supplied. Returns the full thread (with all comments)
|
|
363
|
-
* after the insert. Team-scoped; 404 when the entity isn't owned by the
|
|
364
|
-
* team or `threadId` doesn't belong to it.
|
|
365
|
-
*/
|
|
366
|
-
createCrmComment<ThrowOnError extends boolean = false>(options: Options<CreateCrmCommentData, ThrowOnError>): RequestResult<CreateCrmCommentResponses, CreateCrmCommentErrors, ThrowOnError>;
|
|
367
439
|
/**
|
|
368
440
|
* Manually create a CRM company for the caller's team. Any team member
|
|
369
441
|
* may create one. The domain must not already be tracked by the team
|
|
@@ -422,6 +494,12 @@ export declare class Sdk extends HeyApiClient {
|
|
|
422
494
|
* (`custom_name`) and never touches the global domain directory.
|
|
423
495
|
*/
|
|
424
496
|
setCrmCompanyName<ThrowOnError extends boolean = false>(options: Options<SetCrmCompanyNameData, ThrowOnError>): RequestResult<SetCrmCompanyNameResponses, SetCrmCompanyNameErrors, ThrowOnError>;
|
|
497
|
+
/**
|
|
498
|
+
* Search the caller's team's CRM contacts by email or name. Any team member
|
|
499
|
+
* may search visible contacts; admin/owner callers also match hidden
|
|
500
|
+
* contacts and contacts under hidden companies.
|
|
501
|
+
*/
|
|
502
|
+
searchContacts<ThrowOnError extends boolean = false>(options?: Options<SearchContactsData, ThrowOnError>): RequestResult<SearchContactsResponses, SearchContactsErrors, ThrowOnError>;
|
|
425
503
|
/**
|
|
426
504
|
* Look up a CRM contact by email in the caller's team. Returns a null
|
|
427
505
|
* `contact` when no visible contact exists. Any team member may resolve a
|
|
@@ -450,6 +528,55 @@ export declare class Sdk extends HeyApiClient {
|
|
|
450
528
|
* `crm_contacts.name` column.
|
|
451
529
|
*/
|
|
452
530
|
setCrmContactName<ThrowOnError extends boolean = false>(options: Options<SetCrmContactNameData, ThrowOnError>): RequestResult<SetCrmContactNameResponses, SetCrmContactNameErrors, ThrowOnError>;
|
|
531
|
+
/**
|
|
532
|
+
* List the caller's live pipelines in their CRM.
|
|
533
|
+
*/
|
|
534
|
+
listCrmPipelines<ThrowOnError extends boolean = false>(options?: Options<ListCrmPipelinesData, ThrowOnError>): RequestResult<ListCrmPipelinesResponses, unknown, ThrowOnError>;
|
|
535
|
+
/**
|
|
536
|
+
* Create a private or team-shared pipeline.
|
|
537
|
+
*/
|
|
538
|
+
createCrmPipeline<ThrowOnError extends boolean = false>(options: Options<CreateCrmPipelineData, ThrowOnError>): RequestResult<CreateCrmPipelineResponses, unknown, ThrowOnError>;
|
|
539
|
+
/**
|
|
540
|
+
* Read one pipeline by its entity identity.
|
|
541
|
+
*/
|
|
542
|
+
getCrmPipeline<ThrowOnError extends boolean = false>(options: Options<GetCrmPipelineData, ThrowOnError>): RequestResult<GetCrmPipelineResponses, unknown, ThrowOnError>;
|
|
543
|
+
/**
|
|
544
|
+
* Rename a pipeline.
|
|
545
|
+
*/
|
|
546
|
+
renameCrmPipeline<ThrowOnError extends boolean = false>(options: Options<RenameCrmPipelineData, ThrowOnError>): RequestResult<RenameCrmPipelineResponses, unknown, ThrowOnError>;
|
|
547
|
+
/**
|
|
548
|
+
* Edit pipeline schema or records with the common typed operations.
|
|
549
|
+
*/
|
|
550
|
+
applyCrmPipelineOps<ThrowOnError extends boolean = false>(options: Options<ApplyCrmPipelineOpsData, ThrowOnError>): RequestResult<ApplyCrmPipelineOpsResponses, unknown, ThrowOnError>;
|
|
551
|
+
/**
|
|
552
|
+
* Read the owner, team grant and channel recipients of a pipeline the caller can edit.
|
|
553
|
+
*/
|
|
554
|
+
getCrmPipelinePermissions<ThrowOnError extends boolean = false>(options: Options<GetCrmPipelinePermissionsData, ThrowOnError>): RequestResult<GetCrmPipelinePermissionsResponses, unknown, ThrowOnError>;
|
|
555
|
+
/**
|
|
556
|
+
* Share a pipeline the caller can edit with channels, or change or remove
|
|
557
|
+
* their access. Team access changes through `/sharing`; there is no share link.
|
|
558
|
+
*/
|
|
559
|
+
updateCrmPipelinePermissions<ThrowOnError extends boolean = false>(options: Options<UpdateCrmPipelinePermissionsData, ThrowOnError>): RequestResult<UpdateCrmPipelinePermissionsResponses, unknown, ThrowOnError>;
|
|
560
|
+
/**
|
|
561
|
+
* Read pipeline records through pipeline access.
|
|
562
|
+
*/
|
|
563
|
+
getCrmPipelineRows<ThrowOnError extends boolean = false>(options: Options<GetCrmPipelineRowsData, ThrowOnError>): RequestResult<GetCrmPipelineRowsResponses, unknown, ThrowOnError>;
|
|
564
|
+
/**
|
|
565
|
+
* Query rows through pipeline access using the shared view protocol.
|
|
566
|
+
*/
|
|
567
|
+
queryCrmPipelineRows<ThrowOnError extends boolean = false>(options: Options<QueryCrmPipelineRowsData, ThrowOnError>): RequestResult<QueryCrmPipelineRowsResponses, unknown, ThrowOnError>;
|
|
568
|
+
/**
|
|
569
|
+
* Update sharing.
|
|
570
|
+
*/
|
|
571
|
+
shareCrmPipeline<ThrowOnError extends boolean = false>(options: Options<ShareCrmPipelineData, ThrowOnError>): RequestResult<ShareCrmPipelineResponses, unknown, ThrowOnError>;
|
|
572
|
+
/**
|
|
573
|
+
* Read the host-owned table schema.
|
|
574
|
+
*/
|
|
575
|
+
getCrmPipelineTable<ThrowOnError extends boolean = false>(options: Options<GetCrmPipelineTableData, ThrowOnError>): RequestResult<GetCrmPipelineTableResponses, unknown, ThrowOnError>;
|
|
576
|
+
/**
|
|
577
|
+
* Trash or restore a pipeline.
|
|
578
|
+
*/
|
|
579
|
+
trashCrmPipeline<ThrowOnError extends boolean = false>(options: Options<TrashCrmPipelineData, ThrowOnError>): RequestResult<TrashCrmPipelineResponses, unknown, ThrowOnError>;
|
|
453
580
|
/**
|
|
454
581
|
* Read the caller's team CRM configuration. Any team member may read;
|
|
455
582
|
* teams without a settings row get the defaults.
|
|
@@ -464,6 +591,148 @@ export declare class Sdk extends HeyApiClient {
|
|
|
464
591
|
* `team_views` is replaced whole. Returns the resulting settings.
|
|
465
592
|
*/
|
|
466
593
|
putCrmTeamSettings<ThrowOnError extends boolean = false>(options: Options<PutCrmTeamSettingsData, ThrowOnError>): RequestResult<PutCrmTeamSettingsResponses, PutCrmTeamSettingsErrors, ThrowOnError>;
|
|
594
|
+
/**
|
|
595
|
+
* Reset the team's deal stages to the defaults; gated like `PUT /crm/stages`.
|
|
596
|
+
*/
|
|
597
|
+
resetCrmTeamStages<ThrowOnError extends boolean = false>(options?: Options<ResetCrmTeamStagesData, ThrowOnError>): RequestResult<ResetCrmTeamStagesResponses, ResetCrmTeamStagesErrors, ThrowOnError>;
|
|
598
|
+
/**
|
|
599
|
+
* Replace the team's deal stages; requires `edit_stages_role` (403 otherwise).
|
|
600
|
+
*/
|
|
601
|
+
putCrmTeamStages<ThrowOnError extends boolean = false>(options: Options<PutCrmTeamStagesData, ThrowOnError>): RequestResult<PutCrmTeamStagesResponses, PutCrmTeamStagesErrors, ThrowOnError>;
|
|
602
|
+
/**
|
|
603
|
+
* List the caller's databases.
|
|
604
|
+
*/
|
|
605
|
+
listDatabases<ThrowOnError extends boolean = false>(options?: Options<ListDatabasesData, ThrowOnError>): RequestResult<ListDatabasesResponses, ListDatabasesErrors, ThrowOnError>;
|
|
606
|
+
/**
|
|
607
|
+
* Create a database owned by the caller; its first table, "Table 1", holds a
|
|
608
|
+
* "Name" text column.
|
|
609
|
+
*/
|
|
610
|
+
createDatabase<ThrowOnError extends boolean = false>(options: Options<CreateDatabaseData, ThrowOnError>): RequestResult<CreateDatabaseResponses, CreateDatabaseErrors, ThrowOnError>;
|
|
611
|
+
/**
|
|
612
|
+
* Save an immutable query. Editing a question saves a new one.
|
|
613
|
+
*/
|
|
614
|
+
saveDatabaseQuery<ThrowOnError extends boolean = false>(options: Options<SaveDatabaseQueryData, ThrowOnError>): RequestResult<SaveDatabaseQueryResponses, SaveDatabaseQueryErrors, ThrowOnError>;
|
|
615
|
+
/**
|
|
616
|
+
* A saved query's definition, for its creator or a viewer of its database.
|
|
617
|
+
*/
|
|
618
|
+
getDatabaseQuery<ThrowOnError extends boolean = false>(options: Options<GetDatabaseQueryData, ThrowOnError>): RequestResult<GetDatabaseQueryResponses, GetDatabaseQueryErrors, ThrowOnError>;
|
|
619
|
+
/**
|
|
620
|
+
* Run one statement as the authenticated user. The viewer's catalog authorizes reads;
|
|
621
|
+
* the SQL domain service obtains an edit receipt for every written database.
|
|
622
|
+
*/
|
|
623
|
+
queryDatabases<ThrowOnError extends boolean = false>(options: Options<QueryDatabasesData, ThrowOnError>): RequestResult<QueryDatabasesResponses, QueryDatabasesErrors, ThrowOnError>;
|
|
624
|
+
/**
|
|
625
|
+
* Create a small example once for the authenticated user, if they have no databases.
|
|
626
|
+
*/
|
|
627
|
+
ensureStarterHandler<ThrowOnError extends boolean = false>(options?: Options<EnsureStarterHandlerData, ThrowOnError>): RequestResult<EnsureStarterHandlerResponses, EnsureStarterHandlerErrors, ThrowOnError>;
|
|
628
|
+
/**
|
|
629
|
+
* Insert rows through a webhook. The body is a JSON object, one row, or
|
|
630
|
+
* an array of up to 100 objects, one row each. Keys name columns by name
|
|
631
|
+
* (ignoring case) or id; `null` leaves a cell empty. Values may be loose:
|
|
632
|
+
* `"45"` for a number, `"true"` for a checkbox, a label or labels for a
|
|
633
|
+
* select, `2026-10-09` for a date. Nothing is written unless every row fits.
|
|
634
|
+
*/
|
|
635
|
+
deliverDatabaseWebhook<ThrowOnError extends boolean = false>(options: Options<DeliverDatabaseWebhookData, ThrowOnError>): RequestResult<DeliverDatabaseWebhookResponses, DeliverDatabaseWebhookErrors, ThrowOnError>;
|
|
636
|
+
/**
|
|
637
|
+
* Schema detail of one database.
|
|
638
|
+
*/
|
|
639
|
+
getDatabase<ThrowOnError extends boolean = false>(options: Options<GetDatabaseData, ThrowOnError>): RequestResult<GetDatabaseResponses, GetDatabaseErrors, ThrowOnError>;
|
|
640
|
+
/**
|
|
641
|
+
* Tell a database's other viewers where the caller is.
|
|
642
|
+
*/
|
|
643
|
+
shareDatabaseAwareness<ThrowOnError extends boolean = false>(options: Options<ShareDatabaseAwarenessData, ThrowOnError>): RequestResult<ShareDatabaseAwarenessResponses, ShareDatabaseAwarenessErrors, ThrowOnError>;
|
|
644
|
+
/**
|
|
645
|
+
* Undo one of your own committed changes: its inverse applies as a new,
|
|
646
|
+
* journaled batch, under the table's lock, guarded against what others
|
|
647
|
+
* changed since. A cell someone changed since is left alone and listed; a
|
|
648
|
+
* row or column you added that someone else wrote since, or a name, option,
|
|
649
|
+
* order, view or card place changed since, refuses the undo. Others'
|
|
650
|
+
* changes always stay. Redo by undoing the undo's change.
|
|
651
|
+
*/
|
|
652
|
+
undoDatabaseChange<ThrowOnError extends boolean = false>(options: Options<UndoDatabaseChangeData, ThrowOnError>): RequestResult<UndoDatabaseChangeResponses, UndoDatabaseChangeErrors, ThrowOnError>;
|
|
653
|
+
/**
|
|
654
|
+
* Import a new table and every row atomically; retries carry the same request ID.
|
|
655
|
+
*/
|
|
656
|
+
importDatabaseTable<ThrowOnError extends boolean = false>(options: Options<ImportDatabaseTableData, ThrowOnError>): RequestResult<ImportDatabaseTableResponses, ImportDatabaseTableErrors, ThrowOnError>;
|
|
657
|
+
/**
|
|
658
|
+
* Apply a batch of typed ops, the one write surface of a database: add,
|
|
659
|
+
* rename, remove and order tables and columns, change a column's type, add
|
|
660
|
+
* and change options, insert, update and delete rows, and write views and a
|
|
661
|
+
* board's card places. The ops apply in order in one transaction, so a
|
|
662
|
+
* later op may name a table, column, option or view an earlier one created
|
|
663
|
+
* under the id its client minted. Ops are last-write-wins unless the batch names
|
|
664
|
+
* base versions. A refused op, named by its index (and row and column where
|
|
665
|
+
* relevant), leaves the whole batch unwritten.
|
|
666
|
+
*/
|
|
667
|
+
applyDatabaseOps<ThrowOnError extends boolean = false>(options: Options<ApplyDatabaseOpsData, ThrowOnError>): RequestResult<ApplyDatabaseOpsResponses, ApplyDatabaseOpsErrors, ThrowOnError>;
|
|
668
|
+
/**
|
|
669
|
+
* Read recipients for a database owned by the caller. Link and team
|
|
670
|
+
* sharing are always `null`: databases do not support them yet.
|
|
671
|
+
*/
|
|
672
|
+
getDatabasePermissions<ThrowOnError extends boolean = false>(options: Options<GetDatabasePermissionsData, ThrowOnError>): RequestResult<GetDatabasePermissionsResponses, GetDatabasePermissionsErrors, ThrowOnError>;
|
|
673
|
+
/**
|
|
674
|
+
* Update channel recipients after proving database ownership. Turning on
|
|
675
|
+
* link or team sharing is refused; ownership cannot be changed here.
|
|
676
|
+
*/
|
|
677
|
+
updateDatabasePermissions<ThrowOnError extends boolean = false>(options: Options<UpdateDatabasePermissionsData, ThrowOnError>): RequestResult<UpdateDatabasePermissionsResponses, UpdateDatabasePermissionsErrors, ThrowOnError>;
|
|
678
|
+
/**
|
|
679
|
+
* What changed in a table since a version, from the change journal: the
|
|
680
|
+
* rows that changed, each once as it stands now (`insert`, `update` or
|
|
681
|
+
* `delete`), and the columns. A reader holding the table at `since` reads
|
|
682
|
+
* just those rows; it reads the table whole when a column changed, the
|
|
683
|
+
* journal is not `complete`, or the rows are `truncated`.
|
|
684
|
+
*/
|
|
685
|
+
getDatabaseTableChanges<ThrowOnError extends boolean = false>(options: Options<GetDatabaseTableChangesData, ThrowOnError>): RequestResult<GetDatabaseTableChangesResponses, GetDatabaseTableChangesErrors, ThrowOnError>;
|
|
686
|
+
/**
|
|
687
|
+
* What changing one column to each type of the type menu would do to its
|
|
688
|
+
* values: safe, checked (with how many values would not convert and a few
|
|
689
|
+
* of them), or never (with why). Changes nothing.
|
|
690
|
+
*/
|
|
691
|
+
listDatabaseColumnCasts<ThrowOnError extends boolean = false>(options: Options<ListDatabaseColumnCastsData, ThrowOnError>): RequestResult<ListDatabaseColumnCastsResponses, ListDatabaseColumnCastsErrors, ThrowOnError>;
|
|
692
|
+
/**
|
|
693
|
+
* What one column's values become under another type: the values that
|
|
694
|
+
* convert, with the options they need, for a new column of that type beside
|
|
695
|
+
* it. The column itself is left as it is: a client writes the conversion as
|
|
696
|
+
* one ops batch, a `create_column` then an `update_rows`, with the answered
|
|
697
|
+
* table version as its base version. Changes nothing.
|
|
698
|
+
*/
|
|
699
|
+
convertDatabaseColumn<ThrowOnError extends boolean = false>(options: Options<ConvertDatabaseColumnData, ThrowOnError>): RequestResult<ConvertDatabaseColumnResponses, ConvertDatabaseColumnErrors, ThrowOnError>;
|
|
700
|
+
/**
|
|
701
|
+
* Settle a new empty text column's type.
|
|
702
|
+
*/
|
|
703
|
+
inferDatabaseColumnType<ThrowOnError extends boolean = false>(options: Options<InferDatabaseColumnTypeData, ThrowOnError>): RequestResult<InferDatabaseColumnTypeResponses, InferDatabaseColumnTypeErrors, ThrowOnError>;
|
|
704
|
+
/**
|
|
705
|
+
* A row's history, from the change journal: every committed change that
|
|
706
|
+
* touched it, newest first, with who made it, when, and the values of the
|
|
707
|
+
* columns it touched before and after. It reads after the row is removed,
|
|
708
|
+
* so a removed row's last values stay readable.
|
|
709
|
+
*/
|
|
710
|
+
getDatabaseRowHistory<ThrowOnError extends boolean = false>(options: Options<GetDatabaseRowHistoryData, ThrowOnError>): RequestResult<GetDatabaseRowHistoryResponses, GetDatabaseRowHistoryErrors, ThrowOnError>;
|
|
711
|
+
/**
|
|
712
|
+
* Where a board's cards sit, for drawing it: the views come with the
|
|
713
|
+
* database's detail, their cards' places from here.
|
|
714
|
+
*/
|
|
715
|
+
getDatabaseViewPositions<ThrowOnError extends boolean = false>(options: Options<GetDatabaseViewPositionsData, ThrowOnError>): RequestResult<GetDatabaseViewPositionsResponses, GetDatabaseViewPositionsErrors, ThrowOnError>;
|
|
716
|
+
/**
|
|
717
|
+
* The database's webhooks.
|
|
718
|
+
*/
|
|
719
|
+
listDatabaseWebhooks<ThrowOnError extends boolean = false>(options: Options<ListDatabaseWebhooksData, ThrowOnError>): RequestResult<ListDatabaseWebhooksResponses, ListDatabaseWebhooksErrors, ThrowOnError>;
|
|
720
|
+
/**
|
|
721
|
+
* Create a webhook: a secret URL whose calls insert rows into one of the
|
|
722
|
+
* database's tables, writing with the creator's access.
|
|
723
|
+
*/
|
|
724
|
+
createDatabaseWebhook<ThrowOnError extends boolean = false>(options: Options<CreateDatabaseWebhookData, ThrowOnError>): RequestResult<CreateDatabaseWebhookResponses, CreateDatabaseWebhookErrors, ThrowOnError>;
|
|
725
|
+
/**
|
|
726
|
+
* Delete a webhook; its URL stops working.
|
|
727
|
+
*/
|
|
728
|
+
deleteDatabaseWebhook<ThrowOnError extends boolean = false>(options: Options<DeleteDatabaseWebhookData, ThrowOnError>): RequestResult<DeleteDatabaseWebhookResponses, DeleteDatabaseWebhookErrors, ThrowOnError>;
|
|
729
|
+
/**
|
|
730
|
+
* Transcribe a transient recording with OpenAI Whisper.
|
|
731
|
+
*
|
|
732
|
+
* Available to every signed-in user on every plan; does not consume chat
|
|
733
|
+
* credits. Audio and transcripts are never persisted.
|
|
734
|
+
*/
|
|
735
|
+
transcribeDictation<ThrowOnError extends boolean = false>(options: Options<TranscribeDictationData, ThrowOnError>): RequestResult<TranscribeDictationResponses, TranscribeDictationErrors, ThrowOnError>;
|
|
467
736
|
/**
|
|
468
737
|
* Gets the users documents to populate their recent document list
|
|
469
738
|
*/
|
|
@@ -497,6 +766,13 @@ export declare class Sdk extends HeyApiClient {
|
|
|
497
766
|
* one backend-owned lifecycle.
|
|
498
767
|
*/
|
|
499
768
|
createTaskHandler<ThrowOnError extends boolean = false>(options: Options<CreateTaskHandlerData, ThrowOnError>): RequestResult<CreateTaskHandlerResponses, CreateTaskHandlerErrors, ThrowOnError>;
|
|
769
|
+
/**
|
|
770
|
+
* Handler for `POST /documents/github_prs/tasks`.
|
|
771
|
+
*
|
|
772
|
+
* Returns the task documents each of up to 100 GitHub pull requests references, for the pull
|
|
773
|
+
* requests the caller can see.
|
|
774
|
+
*/
|
|
775
|
+
getGithubPullRequestTasks<ThrowOnError extends boolean = false>(options: Options<GetGithubPullRequestTasksData, ThrowOnError>): RequestResult<GetGithubPullRequestTasksResponses, GetGithubPullRequestTasksErrors, ThrowOnError>;
|
|
500
776
|
initializeUserDocuments<ThrowOnError extends boolean = false>(options?: Options<InitializeUserDocumentsData, ThrowOnError>): RequestResult<InitializeUserDocumentsResponses, InitializeUserDocumentsErrors, ThrowOnError>;
|
|
501
777
|
/**
|
|
502
778
|
* Gets a list of all the user's documents so they are able to be searched on
|
|
@@ -630,11 +906,16 @@ export declare class Sdk extends HeyApiClient {
|
|
|
630
906
|
*/
|
|
631
907
|
getDocumentTeamShare<ThrowOnError extends boolean = false>(options: Options<GetDocumentTeamShareData, ThrowOnError>): RequestResult<GetDocumentTeamShareResponses, GetDocumentTeamShareErrors, ThrowOnError>;
|
|
632
908
|
/**
|
|
633
|
-
* Sets
|
|
634
|
-
* owner
|
|
635
|
-
* Edit
|
|
909
|
+
* Sets explicit team sharing. Requires a verified acting identity matching
|
|
910
|
+
* the persisted document owner, not merely effective Edit or Owner access.
|
|
911
|
+
* Initial enable defaults to Edit; repeated enable preserves the chosen level.
|
|
912
|
+
* Clear removes only the managed direct grant, not inherited team access.
|
|
636
913
|
*/
|
|
637
914
|
setDocumentTeamShare<ThrowOnError extends boolean = false>(options: Options<SetDocumentTeamShareData, ThrowOnError>): RequestResult<SetDocumentTeamShareResponses, SetDocumentTeamShareErrors, ThrowOnError>;
|
|
915
|
+
/**
|
|
916
|
+
* Read current Markdown or extracted file text with the document's view receipt.
|
|
917
|
+
*/
|
|
918
|
+
getDocumentTextContent<ThrowOnError extends boolean = false>(options: Options<GetDocumentTextContentData, ThrowOnError>): RequestResult<GetDocumentTextContentResponses, GetDocumentTextContentErrors, ThrowOnError>;
|
|
638
919
|
/**
|
|
639
920
|
* Gets the list of users who have viewed a given document
|
|
640
921
|
*/
|
|
@@ -643,6 +924,34 @@ export declare class Sdk extends HeyApiClient {
|
|
|
643
924
|
* Gets a particular document by its id
|
|
644
925
|
*/
|
|
645
926
|
getDocumentVersion<ThrowOnError extends boolean = false>(options: Options<GetDocumentVersionData, ThrowOnError>): RequestResult<GetDocumentVersionResponses, GetDocumentVersionErrors, ThrowOnError>;
|
|
927
|
+
/**
|
|
928
|
+
* State access request state through the domain service.
|
|
929
|
+
*/
|
|
930
|
+
accessRequestsState<ThrowOnError extends boolean = false>(options: Options<AccessRequestsStateData, ThrowOnError>): RequestResult<AccessRequestsStateResponses, AccessRequestsStateErrors, ThrowOnError>;
|
|
931
|
+
/**
|
|
932
|
+
* Cancel access request state through the domain service.
|
|
933
|
+
*/
|
|
934
|
+
accessRequestsCancel<ThrowOnError extends boolean = false>(options: Options<AccessRequestsCancelData, ThrowOnError>): RequestResult<AccessRequestsCancelResponses, AccessRequestsCancelErrors, ThrowOnError>;
|
|
935
|
+
/**
|
|
936
|
+
* Submit access request state through the domain service.
|
|
937
|
+
*/
|
|
938
|
+
accessRequestsSubmit<ThrowOnError extends boolean = false>(options: Options<AccessRequestsSubmitData, ThrowOnError>): RequestResult<AccessRequestsSubmitResponses, AccessRequestsSubmitErrors, ThrowOnError>;
|
|
939
|
+
/**
|
|
940
|
+
* Resolve access request state through the domain service.
|
|
941
|
+
*/
|
|
942
|
+
accessRequestsResolve<ThrowOnError extends boolean = false>(options: Options<AccessRequestsResolveData, ThrowOnError>): RequestResult<AccessRequestsResolveResponses, AccessRequestsResolveErrors, ThrowOnError>;
|
|
943
|
+
/**
|
|
944
|
+
* Direct access request state through the domain service.
|
|
945
|
+
*/
|
|
946
|
+
accessRequestsDirect<ThrowOnError extends boolean = false>(options: Options<AccessRequestsDirectData, ThrowOnError>): RequestResult<AccessRequestsDirectResponses, AccessRequestsDirectErrors, ThrowOnError>;
|
|
947
|
+
/**
|
|
948
|
+
* Remove direct access request state through the domain service.
|
|
949
|
+
*/
|
|
950
|
+
accessRequestsRemoveDirect<ThrowOnError extends boolean = false>(options: Options<AccessRequestsRemoveDirectData, ThrowOnError>): RequestResult<AccessRequestsRemoveDirectResponses, AccessRequestsRemoveDirectErrors, ThrowOnError>;
|
|
951
|
+
/**
|
|
952
|
+
* Set direct access request state through the domain service.
|
|
953
|
+
*/
|
|
954
|
+
accessRequestsSetDirect<ThrowOnError extends boolean = false>(options: Options<AccessRequestsSetDirectData, ThrowOnError>): RequestResult<AccessRequestsSetDirectResponses, AccessRequestsSetDirectErrors, ThrowOnError>;
|
|
646
955
|
/**
|
|
647
956
|
* Get the current user's permission for a given entity.
|
|
648
957
|
*/
|
|
@@ -663,14 +972,167 @@ export declare class Sdk extends HeyApiClient {
|
|
|
663
972
|
* Remove a favorite by entity.
|
|
664
973
|
*/
|
|
665
974
|
removeFavoriteByEntity<ThrowOnError extends boolean = false>(options: Options<RemoveFavoriteByEntityData, ThrowOnError>): RequestResult<RemoveFavoriteByEntityResponses, RemoveFavoriteByEntityErrors, ThrowOnError>;
|
|
975
|
+
/**
|
|
976
|
+
* Get a visible foreign entity by the identifier its source system assigned.
|
|
977
|
+
*
|
|
978
|
+
* `foreign_entity_id` is a wildcard path segment: sources store slashes inside
|
|
979
|
+
* the identifier, for example `owner/repo/pull/12`.
|
|
980
|
+
*
|
|
981
|
+
* Authorization matches the by-id route. Internal service callers see every
|
|
982
|
+
* record; an authenticated user sees a record only when they have view access
|
|
983
|
+
* to it, and records they cannot view are reported as `404` so the route never
|
|
984
|
+
* reveals that a mapping exists. Bot tokens are not accepted here — they use
|
|
985
|
+
* the by-id route, which mints a bot-scoped receipt.
|
|
986
|
+
*/
|
|
987
|
+
getForeignEntityBySource<ThrowOnError extends boolean = false>(options: Options<GetForeignEntityBySourceData, ThrowOnError>): RequestResult<GetForeignEntityBySourceResponses, GetForeignEntityBySourceErrors, ThrowOnError>;
|
|
666
988
|
/**
|
|
667
989
|
* Get a visible foreign entity by its internal ID.
|
|
668
990
|
*/
|
|
669
991
|
getForeignEntity<ThrowOnError extends boolean = false>(options: Options<GetForeignEntityData, ThrowOnError>): RequestResult<GetForeignEntityResponses, GetForeignEntityErrors, ThrowOnError>;
|
|
992
|
+
/**
|
|
993
|
+
* The live forms over a database the caller can see, for the grid's chip
|
|
994
|
+
* and the delete-table confirmation.
|
|
995
|
+
*/
|
|
996
|
+
listForms<ThrowOnError extends boolean = false>(options: Options<ListFormsData, ThrowOnError>): RequestResult<ListFormsResponses, ListFormsErrors, ThrowOnError>;
|
|
997
|
+
/**
|
|
998
|
+
* Create a form owned by the caller: over a new database named like it, or
|
|
999
|
+
* over an existing table of a database the caller owns. Database Edit is
|
|
1000
|
+
* not enough to attach a form: the form's editors gain Edit on the
|
|
1001
|
+
* database through it.
|
|
1002
|
+
*/
|
|
1003
|
+
createForm<ThrowOnError extends boolean = false>(options: Options<CreateFormData, ThrowOnError>): RequestResult<CreateFormResponses, CreateFormErrors, ThrowOnError>;
|
|
1004
|
+
/**
|
|
1005
|
+
* Every live form the caller holds a grant on, newest first, with their
|
|
1006
|
+
* level: what Drive and Quick Access list. Public forms reached only by
|
|
1007
|
+
* their link are not listed.
|
|
1008
|
+
*/
|
|
1009
|
+
listAccessibleForms<ThrowOnError extends boolean = false>(options?: Options<ListAccessibleFormsData, ThrowOnError>): RequestResult<ListAccessibleFormsResponses, ListAccessibleFormsErrors, ThrowOnError>;
|
|
1010
|
+
/**
|
|
1011
|
+
* A form with its layout, each question joined with its column's title,
|
|
1012
|
+
* type and options. Never rows. Readable by anyone when the form is public.
|
|
1013
|
+
*/
|
|
1014
|
+
getForm<ThrowOnError extends boolean = false>(options: Options<GetFormData, ThrowOnError>): RequestResult<GetFormResponses, GetFormErrors, ThrowOnError>;
|
|
1015
|
+
/**
|
|
1016
|
+
* Change a form's facts. The description and confirmation message take
|
|
1017
|
+
* edit; who responds, open or closed, the closing time and tallies take
|
|
1018
|
+
* its owner.
|
|
1019
|
+
*/
|
|
1020
|
+
updateForm<ThrowOnError extends boolean = false>(options: Options<UpdateFormData, ThrowOnError>): RequestResult<UpdateFormResponses, UpdateFormErrors, ThrowOnError>;
|
|
1021
|
+
/**
|
|
1022
|
+
* Open the editor-only collaborative layout, or publish its latest valid
|
|
1023
|
+
* revision. Content stays in the existing collaboration surface.
|
|
1024
|
+
*/
|
|
1025
|
+
collaborateForm<ThrowOnError extends boolean = false>(options: Options<CollaborateFormData, ThrowOnError>): RequestResult<CollaborateFormResponses, CollaborateFormErrors, ThrowOnError>;
|
|
1026
|
+
/**
|
|
1027
|
+
* Save a validated replacement in the shared layout and report publication.
|
|
1028
|
+
* A 200 response with `publicationError` means the draft is saved, while
|
|
1029
|
+
* respondents still see `detail`. Retrying collaboration retries publication.
|
|
1030
|
+
*/
|
|
1031
|
+
putFormLayout<ThrowOnError extends boolean = false>(options: Options<PutFormLayoutData, ThrowOnError>): RequestResult<PutFormLayoutResponses, PutFormLayoutErrors, ThrowOnError>;
|
|
1032
|
+
/**
|
|
1033
|
+
* A form's recipients, for its owner. Link and team sharing are always
|
|
1034
|
+
* `null`: a form's public audience is its own setting.
|
|
1035
|
+
*/
|
|
1036
|
+
getFormPermissions<ThrowOnError extends boolean = false>(options: Options<GetFormPermissionsData, ThrowOnError>): RequestResult<GetFormPermissionsResponses, GetFormPermissionsErrors, ThrowOnError>;
|
|
1037
|
+
/**
|
|
1038
|
+
* Change a form's channel recipients, for its owner. Turning on link or
|
|
1039
|
+
* team sharing is refused.
|
|
1040
|
+
*/
|
|
1041
|
+
updateFormPermissions<ThrowOnError extends boolean = false>(options: Options<UpdateFormPermissionsData, ThrowOnError>): RequestResult<UpdateFormPermissionsResponses, UpdateFormPermissionsErrors, ThrowOnError>;
|
|
1042
|
+
/**
|
|
1043
|
+
* Respond to a form. A gate that stops the response answers `stopped` and
|
|
1044
|
+
* writes nothing to the table. A public form takes anonymous responses.
|
|
1045
|
+
*/
|
|
1046
|
+
submitFormResponse<ThrowOnError extends boolean = false>(options: Options<SubmitFormResponseData, ThrowOnError>): RequestResult<SubmitFormResponseResponses, SubmitFormResponseErrors, ThrowOnError>;
|
|
1047
|
+
/**
|
|
1048
|
+
* The signed-in caller's own response, with the row's current cells.
|
|
1049
|
+
*/
|
|
1050
|
+
getMyFormResponse<ThrowOnError extends boolean = false>(options: Options<GetMyFormResponseData, ThrowOnError>): RequestResult<GetMyFormResponseResponses, GetMyFormResponseErrors, ThrowOnError>;
|
|
1051
|
+
/**
|
|
1052
|
+
* Replace the signed-in caller's answers while the form is open. A gate
|
|
1053
|
+
* that stops the edit leaves the saved response as it was.
|
|
1054
|
+
*/
|
|
1055
|
+
editMyFormResponse<ThrowOnError extends boolean = false>(options: Options<EditMyFormResponseData, ThrowOnError>): RequestResult<EditMyFormResponseResponses, EditMyFormResponseErrors, ThrowOnError>;
|
|
1056
|
+
/**
|
|
1057
|
+
* Response counts for the form's editors.
|
|
1058
|
+
*/
|
|
1059
|
+
getFormResponseSummary<ThrowOnError extends boolean = false>(options: Options<GetFormResponseSummaryData, ThrowOnError>): RequestResult<GetFormResponseSummaryResponses, GetFormResponseSummaryErrors, ThrowOnError>;
|
|
1060
|
+
/**
|
|
1061
|
+
* Option counts of the form's choice questions: for respondents when the
|
|
1062
|
+
* owner shows them, for editors always.
|
|
1063
|
+
*/
|
|
1064
|
+
getFormTally<ThrowOnError extends boolean = false>(options: Options<GetFormTallyData, ThrowOnError>): RequestResult<GetFormTallyResponses, GetFormTallyErrors, ThrowOnError>;
|
|
670
1065
|
/**
|
|
671
1066
|
* Redirects an authenticated user to the github sync app installation page.
|
|
672
1067
|
*/
|
|
673
1068
|
installSync<ThrowOnError extends boolean = false>(options?: Options<InstallSyncData, ThrowOnError>): RequestResult<unknown, InstallSyncErrors, ThrowOnError>;
|
|
1069
|
+
/**
|
|
1070
|
+
* List the repositories and authors among the GitHub pull requests visible to the caller.
|
|
1071
|
+
*/
|
|
1072
|
+
getGithubPullRequestFacets<ThrowOnError extends boolean = false>(options?: Options<GetGithubPullRequestFacetsData, ThrowOnError>): RequestResult<GetGithubPullRequestFacetsResponses, GetGithubPullRequestFacetsErrors, ThrowOnError>;
|
|
1073
|
+
/**
|
|
1074
|
+
* Get the pull request behind a foreign entity record the caller can view.
|
|
1075
|
+
*/
|
|
1076
|
+
getGithubPullRequest<ThrowOnError extends boolean = false>(options: Options<GetGithubPullRequestData, ThrowOnError>): RequestResult<GetGithubPullRequestResponses, GetGithubPullRequestErrors, ThrowOnError>;
|
|
1077
|
+
/**
|
|
1078
|
+
* Get the changes of the pull request behind a foreign entity record the caller can view.
|
|
1079
|
+
*/
|
|
1080
|
+
getGithubPullRequestChanges<ThrowOnError extends boolean = false>(options: Options<GetGithubPullRequestChangesData, ThrowOnError>): RequestResult<GetGithubPullRequestChangesResponses, GetGithubPullRequestChangesErrors, ThrowOnError>;
|
|
1081
|
+
/**
|
|
1082
|
+
* Get the patch of changes of the pull request behind a foreign entity record the caller can
|
|
1083
|
+
* view.
|
|
1084
|
+
*/
|
|
1085
|
+
getGithubPullRequestChangesPatch<ThrowOnError extends boolean = false>(options: Options<GetGithubPullRequestChangesPatchData, ThrowOnError>): RequestResult<GetGithubPullRequestChangesPatchResponses, GetGithubPullRequestChangesPatchErrors, ThrowOnError>;
|
|
1086
|
+
/**
|
|
1087
|
+
* Handler for `POST /harness-pairings`.
|
|
1088
|
+
*
|
|
1089
|
+
* Unauthenticated by design: the daemon has no credential yet - obtaining one
|
|
1090
|
+
* is the point. The pairing releases nothing until a signed-in user approves
|
|
1091
|
+
* it, and creation is throttled in the domain service.
|
|
1092
|
+
*/
|
|
1093
|
+
createHarnessPairing<ThrowOnError extends boolean = false>(options: Options<CreateHarnessPairingData, ThrowOnError>): RequestResult<CreateHarnessPairingResponses, CreateHarnessPairingErrors, ThrowOnError>;
|
|
1094
|
+
/**
|
|
1095
|
+
* Handler for `GET /harness-pairings/{code}`.
|
|
1096
|
+
*/
|
|
1097
|
+
getHarnessPairing<ThrowOnError extends boolean = false>(options: Options<GetHarnessPairingData, ThrowOnError>): RequestResult<GetHarnessPairingResponses, GetHarnessPairingErrors, ThrowOnError>;
|
|
1098
|
+
/**
|
|
1099
|
+
* Handler for `POST /harness-pairings/{code}/approve`.
|
|
1100
|
+
*/
|
|
1101
|
+
approveHarnessPairing<ThrowOnError extends boolean = false>(options: Options<ApproveHarnessPairingData, ThrowOnError>): RequestResult<ApproveHarnessPairingResponses, ApproveHarnessPairingErrors, ThrowOnError>;
|
|
1102
|
+
/**
|
|
1103
|
+
* Handler for `POST /harness-pairings/{pairing_id}/claim`.
|
|
1104
|
+
*
|
|
1105
|
+
* Unauthenticated like pairing creation; the device secret minted alongside
|
|
1106
|
+
* the pairing is the credential, and the pairing id (not the short user
|
|
1107
|
+
* code) addresses it.
|
|
1108
|
+
*/
|
|
1109
|
+
claimHarnessPairing<ThrowOnError extends boolean = false>(options: Options<ClaimHarnessPairingData, ThrowOnError>): RequestResult<ClaimHarnessPairingResponses, ClaimHarnessPairingErrors, ThrowOnError>;
|
|
1110
|
+
/**
|
|
1111
|
+
* Handler for `GET /harnesses`.
|
|
1112
|
+
*/
|
|
1113
|
+
listHarnesses<ThrowOnError extends boolean = false>(options?: Options<ListHarnessesData, ThrowOnError>): RequestResult<ListHarnessesResponses, ListHarnessesErrors, ThrowOnError>;
|
|
1114
|
+
/**
|
|
1115
|
+
* Handler for `DELETE /harnesses/me`.
|
|
1116
|
+
*
|
|
1117
|
+
* A daemon retiring itself: the valid credential is the authorization.
|
|
1118
|
+
*/
|
|
1119
|
+
deleteSelfHarness<ThrowOnError extends boolean = false>(options?: Options<DeleteSelfHarnessData, ThrowOnError>): RequestResult<DeleteSelfHarnessResponses, DeleteSelfHarnessErrors, ThrowOnError>;
|
|
1120
|
+
/**
|
|
1121
|
+
* Handler for `GET /harnesses/me`.
|
|
1122
|
+
*/
|
|
1123
|
+
getSelfHarness<ThrowOnError extends boolean = false>(options?: Options<GetSelfHarnessData, ThrowOnError>): RequestResult<GetSelfHarnessResponses, GetSelfHarnessErrors, ThrowOnError>;
|
|
1124
|
+
/**
|
|
1125
|
+
* Handler for `GET /harnesses/me/agents`.
|
|
1126
|
+
*/
|
|
1127
|
+
listHarnessAgents<ThrowOnError extends boolean = false>(options?: Options<ListHarnessAgentsData, ThrowOnError>): RequestResult<ListHarnessAgentsResponses, ListHarnessAgentsErrors, ThrowOnError>;
|
|
1128
|
+
/**
|
|
1129
|
+
* Handler for `GET /harnesses/me/sessions`.
|
|
1130
|
+
*/
|
|
1131
|
+
listHarnessSessions<ThrowOnError extends boolean = false>(options?: Options<ListHarnessSessionsData, ThrowOnError>): RequestResult<ListHarnessSessionsResponses, ListHarnessSessionsErrors, ThrowOnError>;
|
|
1132
|
+
/**
|
|
1133
|
+
* Handler for `DELETE /harnesses/{harness_id}`.
|
|
1134
|
+
*/
|
|
1135
|
+
deleteHarness<ThrowOnError extends boolean = false>(options: Options<DeleteHarnessData, ThrowOnError>): RequestResult<DeleteHarnessResponses, DeleteHarnessErrors, ThrowOnError>;
|
|
674
1136
|
/**
|
|
675
1137
|
* Health check
|
|
676
1138
|
*/
|
|
@@ -687,6 +1149,26 @@ export declare class Sdk extends HeyApiClient {
|
|
|
687
1149
|
* Upserts an item into the user's history and performs other necessary tracking actions
|
|
688
1150
|
*/
|
|
689
1151
|
upsertHistoryHandler<ThrowOnError extends boolean = false>(options: Options<UpsertHistoryHandlerData, ThrowOnError>): RequestResult<UpsertHistoryHandlerResponses, UpsertHistoryHandlerErrors, ThrowOnError>;
|
|
1152
|
+
/**
|
|
1153
|
+
* List initiatives the caller can view.
|
|
1154
|
+
*/
|
|
1155
|
+
listInitiatives<ThrowOnError extends boolean = false>(options?: Options<ListInitiativesData, ThrowOnError>): RequestResult<ListInitiativesResponses, ListInitiativesErrors, ThrowOnError>;
|
|
1156
|
+
/**
|
|
1157
|
+
* Create an initiative owned by the caller.
|
|
1158
|
+
*/
|
|
1159
|
+
createInitiative<ThrowOnError extends boolean = false>(options: Options<CreateInitiativeData, ThrowOnError>): RequestResult<CreateInitiativeResponses, CreateInitiativeErrors, ThrowOnError>;
|
|
1160
|
+
/**
|
|
1161
|
+
* Delete the initiative the caller owns.
|
|
1162
|
+
*/
|
|
1163
|
+
deleteInitiative<ThrowOnError extends boolean = false>(options: Options<DeleteInitiativeData, ThrowOnError>): RequestResult<DeleteInitiativeResponses, DeleteInitiativeErrors, ThrowOnError>;
|
|
1164
|
+
/**
|
|
1165
|
+
* Fetch one initiative the caller can view.
|
|
1166
|
+
*/
|
|
1167
|
+
getInitiative<ThrowOnError extends boolean = false>(options: Options<GetInitiativeData, ThrowOnError>): RequestResult<GetInitiativeResponses, GetInitiativeErrors, ThrowOnError>;
|
|
1168
|
+
/**
|
|
1169
|
+
* Update fields the caller can edit.
|
|
1170
|
+
*/
|
|
1171
|
+
updateInitiative<ThrowOnError extends boolean = false>(options: Options<UpdateInitiativeData, ThrowOnError>): RequestResult<UpdateInitiativeResponses, UpdateInitiativeErrors, ThrowOnError>;
|
|
690
1172
|
/**
|
|
691
1173
|
* Gets the instructions document for the current user
|
|
692
1174
|
*/
|
|
@@ -711,6 +1193,54 @@ export declare class Sdk extends HeyApiClient {
|
|
|
711
1193
|
* Gets the items grouped by the specified field using AST filters.
|
|
712
1194
|
*/
|
|
713
1195
|
postItemsSoupAstGrouped<ThrowOnError extends boolean = false>(options: Options<PostItemsSoupAstGroupedData, ThrowOnError>): RequestResult<PostItemsSoupAstGroupedResponses, PostItemsSoupAstGroupedErrors, ThrowOnError>;
|
|
1196
|
+
/**
|
|
1197
|
+
* Read a bounded timeline with lazy thread previews.
|
|
1198
|
+
*/
|
|
1199
|
+
messageTimeline<ThrowOnError extends boolean = false>(options: Options<MessageTimelineData, ThrowOnError>): RequestResult<MessageTimelineResponses, unknown, ThrowOnError>;
|
|
1200
|
+
/**
|
|
1201
|
+
* Create a root message or reply.
|
|
1202
|
+
*/
|
|
1203
|
+
entityMessageCreate<ThrowOnError extends boolean = false>(options: Options<EntityMessageCreateData, ThrowOnError>): RequestResult<EntityMessageCreateResponses, unknown, ThrowOnError>;
|
|
1204
|
+
/**
|
|
1205
|
+
* Tombstone one message; deleting a discussion's root deletes the discussion.
|
|
1206
|
+
*/
|
|
1207
|
+
entityMessageDeleteMessage<ThrowOnError extends boolean = false>(options: Options<EntityMessageDeleteMessageData, ThrowOnError>): RequestResult<EntityMessageDeleteMessageResponses, unknown, ThrowOnError>;
|
|
1208
|
+
/**
|
|
1209
|
+
* Resolve a message within its parent.
|
|
1210
|
+
*/
|
|
1211
|
+
entityMessageGetMessage<ThrowOnError extends boolean = false>(options: Options<EntityMessageGetMessageData, ThrowOnError>): RequestResult<EntityMessageGetMessageResponses, unknown, ThrowOnError>;
|
|
1212
|
+
/**
|
|
1213
|
+
* Edit an owned message.
|
|
1214
|
+
*/
|
|
1215
|
+
entityMessageEdit<ThrowOnError extends boolean = false>(options: Options<EntityMessageEditData, ThrowOnError>): RequestResult<EntityMessageEditResponses, unknown, ThrowOnError>;
|
|
1216
|
+
/**
|
|
1217
|
+
* Change the caller's reaction.
|
|
1218
|
+
*/
|
|
1219
|
+
entityMessageReact<ThrowOnError extends boolean = false>(options: Options<EntityMessageReactData, ThrowOnError>): RequestResult<EntityMessageReactResponses, unknown, ThrowOnError>;
|
|
1220
|
+
/**
|
|
1221
|
+
* Resolve an old link under current parent permissions.
|
|
1222
|
+
*/
|
|
1223
|
+
entityMessageLegacy<ThrowOnError extends boolean = false>(options: Options<EntityMessageLegacyData, ThrowOnError>): RequestResult<EntityMessageLegacyResponses, unknown, ThrowOnError>;
|
|
1224
|
+
/**
|
|
1225
|
+
* Explicitly remove a discussion.
|
|
1226
|
+
*/
|
|
1227
|
+
entityMessageDeleteThread<ThrowOnError extends boolean = false>(options: Options<EntityMessageDeleteThreadData, ThrowOnError>): RequestResult<EntityMessageDeleteThreadResponses, unknown, ThrowOnError>;
|
|
1228
|
+
/**
|
|
1229
|
+
* Open a specific discussion from a link or annotation.
|
|
1230
|
+
*/
|
|
1231
|
+
entityMessageGetThread<ThrowOnError extends boolean = false>(options: Options<EntityMessageGetThreadData, ThrowOnError>): RequestResult<EntityMessageGetThreadResponses, unknown, ThrowOnError>;
|
|
1232
|
+
/**
|
|
1233
|
+
* Update a discussion's lifecycle and placement.
|
|
1234
|
+
*/
|
|
1235
|
+
entityMessagePatchThread<ThrowOnError extends boolean = false>(options: Options<EntityMessagePatchThreadData, ThrowOnError>): RequestResult<EntityMessagePatchThreadResponses, unknown, ThrowOnError>;
|
|
1236
|
+
/**
|
|
1237
|
+
* Read a bounded window of messages and the parent's activity, ordered by the server.
|
|
1238
|
+
*/
|
|
1239
|
+
messageTimelineEntries<ThrowOnError extends boolean = false>(options: Options<MessageTimelineEntriesData, ThrowOnError>): RequestResult<MessageTimelineEntriesResponses, unknown, ThrowOnError>;
|
|
1240
|
+
/**
|
|
1241
|
+
* Broadcast typing within an authorized discussion.
|
|
1242
|
+
*/
|
|
1243
|
+
entityMessageTyping<ThrowOnError extends boolean = false>(options: Options<EntityMessageTypingData, ThrowOnError>): RequestResult<EntityMessageTypingResponses, unknown, ThrowOnError>;
|
|
714
1244
|
/**
|
|
715
1245
|
* Gets the users pinned items
|
|
716
1246
|
*/
|
|
@@ -784,35 +1314,72 @@ export declare class Sdk extends HeyApiClient {
|
|
|
784
1314
|
*/
|
|
785
1315
|
recentlyDeleted<ThrowOnError extends boolean = false>(options?: Options<RecentlyDeletedData, ThrowOnError>): RequestResult<RecentlyDeletedResponses, RecentlyDeletedErrors, ThrowOnError>;
|
|
786
1316
|
/**
|
|
787
|
-
* List
|
|
788
|
-
*/
|
|
789
|
-
listReminders<ThrowOnError extends boolean = false>(options?: Options<ListRemindersData, ThrowOnError>): RequestResult<ListRemindersResponses, ListRemindersErrors, ThrowOnError>;
|
|
790
|
-
/**
|
|
791
|
-
* Create a reminder, optionally attached to an entity the caller can view.
|
|
792
|
-
*/
|
|
793
|
-
createReminder<ThrowOnError extends boolean = false>(options: Options<CreateReminderData, ThrowOnError>): RequestResult<CreateReminderResponses, CreateReminderErrors, ThrowOnError>;
|
|
794
|
-
/**
|
|
795
|
-
* Delete one of the caller's reminders.
|
|
1317
|
+
* List original email threads with caller-private reminder work.
|
|
796
1318
|
*/
|
|
797
|
-
|
|
1319
|
+
listEmailReminders<ThrowOnError extends boolean = false>(options?: Options<ListEmailRemindersData, ThrowOnError>): RequestResult<ListEmailRemindersResponses, ListEmailRemindersErrors, ThrowOnError>;
|
|
798
1320
|
/**
|
|
799
|
-
*
|
|
1321
|
+
* Read an email follow-up and reconcile inbound reply cancellation.
|
|
800
1322
|
*/
|
|
801
|
-
|
|
1323
|
+
getEmailFollowup<ThrowOnError extends boolean = false>(options: Options<GetEmailFollowupData, ThrowOnError>): RequestResult<GetEmailFollowupResponses, GetEmailFollowupErrors, ThrowOnError>;
|
|
802
1324
|
/**
|
|
803
|
-
*
|
|
1325
|
+
* Schedule, edit or remove one email follow-up as an idempotent operation.
|
|
804
1326
|
*/
|
|
805
|
-
|
|
1327
|
+
setEmailFollowup<ThrowOnError extends boolean = false>(options: Options<SetEmailFollowupData, ThrowOnError>): RequestResult<SetEmailFollowupResponses, SetEmailFollowupErrors, ThrowOnError>;
|
|
806
1328
|
getViewsHandler<ThrowOnError extends boolean = false>(options?: Options<GetViewsHandlerData, ThrowOnError>): RequestResult<GetViewsHandlerResponses, GetViewsHandlerErrors, ThrowOnError>;
|
|
807
1329
|
createViewHandler<ThrowOnError extends boolean = false>(options: Options<CreateViewHandlerData, ThrowOnError>): RequestResult<CreateViewHandlerResponses, CreateViewHandlerErrors, ThrowOnError>;
|
|
808
1330
|
excludeDefaultViewHandler<ThrowOnError extends boolean = false>(options: Options<ExcludeDefaultViewHandlerData, ThrowOnError>): RequestResult<ExcludeDefaultViewHandlerResponses, ExcludeDefaultViewHandlerErrors, ThrowOnError>;
|
|
809
1331
|
deleteViewHandler<ThrowOnError extends boolean = false>(options: Options<DeleteViewHandlerData, ThrowOnError>): RequestResult<DeleteViewHandlerResponses, DeleteViewHandlerErrors, ThrowOnError>;
|
|
810
1332
|
patchViewHandler<ThrowOnError extends boolean = false>(options: Options<PatchViewHandlerData, ThrowOnError>): RequestResult<PatchViewHandlerResponses, PatchViewHandlerErrors, ThrowOnError>;
|
|
1333
|
+
/**
|
|
1334
|
+
* List this administrator's team receipts, effective server limits and source binding.
|
|
1335
|
+
*/
|
|
1336
|
+
listSlackImports<ThrowOnError extends boolean = false>(options?: Options<ListSlackImportsData, ThrowOnError>): RequestResult<ListSlackImportsResponses, unknown, ThrowOnError>;
|
|
1337
|
+
/**
|
|
1338
|
+
* Create or replay a job using a scoped idempotency token and full selected metadata.
|
|
1339
|
+
* Missing creation timestamps and unknown message counts are represented as null.
|
|
1340
|
+
*/
|
|
1341
|
+
createSlackImport<ThrowOnError extends boolean = false>(options: Options<CreateSlackImportData, ThrowOnError>): RequestResult<CreateSlackImportResponses, CreateSlackImportErrors, ThrowOnError>;
|
|
1342
|
+
/**
|
|
1343
|
+
* Read sanitized progress; foreign jobs are indistinguishable from missing jobs.
|
|
1344
|
+
*/
|
|
1345
|
+
getSlackImport<ThrowOnError extends boolean = false>(options: Options<GetSlackImportData, ThrowOnError>): RequestResult<GetSlackImportResponses, GetSlackImportErrors, ThrowOnError>;
|
|
1346
|
+
/**
|
|
1347
|
+
* Stop unclaimed work. Active leases may settle; cancellation does not roll back history.
|
|
1348
|
+
*/
|
|
1349
|
+
cancelSlackImport<ThrowOnError extends boolean = false>(options: Options<CancelSlackImportData, ThrowOnError>): RequestResult<CancelSlackImportResponses, CancelSlackImportErrors, ThrowOnError>;
|
|
1350
|
+
/**
|
|
1351
|
+
* Close registration idempotently; never-ready conversations are skipped, not queued work.
|
|
1352
|
+
*/
|
|
1353
|
+
finalizeSlackImport<ThrowOnError extends boolean = false>(options: Options<FinalizeSlackImportData, ThrowOnError>): RequestResult<FinalizeSlackImportResponses, FinalizeSlackImportErrors, ThrowOnError>;
|
|
1354
|
+
/**
|
|
1355
|
+
* Issue short-lived, checksum/length-bound, create-only PUT grants. Do not log or persist URLs.
|
|
1356
|
+
* Retry a PUT returning 412 by completing/verifying the existing object, not overwriting it.
|
|
1357
|
+
*/
|
|
1358
|
+
registerSlackImportUploads<ThrowOnError extends boolean = false>(options: Options<RegisterSlackImportUploadsData, ThrowOnError>): RequestResult<RegisterSlackImportUploadsResponses, RegisterSlackImportUploadsErrors, ThrowOnError>;
|
|
1359
|
+
/**
|
|
1360
|
+
* Verify storage checksums and lengths for registered objects. A seal fixes the ENTIRE
|
|
1361
|
+
* descriptor set (contiguous indices, sizes and hashes), not just this completion batch.
|
|
1362
|
+
* Empty uploads with a zero-part seal support shape-only or empty-history imports.
|
|
1363
|
+
* Work becomes ready only after verified users metadata, a seal and every required part.
|
|
1364
|
+
*/
|
|
1365
|
+
completeSlackImportUploads<ThrowOnError extends boolean = false>(options: Options<CompleteSlackImportUploadsData, ThrowOnError>): RequestResult<CompleteSlackImportUploadsResponses, CompleteSlackImportUploadsErrors, ThrowOnError>;
|
|
811
1366
|
bulkWakeupSyncServiceDocuments<ThrowOnError extends boolean = false>(options: Options<BulkWakeupSyncServiceDocumentsData, ThrowOnError>): RequestResult<BulkWakeupSyncServiceDocumentsResponses, BulkWakeupSyncServiceDocumentsErrors, ThrowOnError>;
|
|
812
1367
|
/**
|
|
813
1368
|
* Edits the share permissions of a thread.
|
|
814
1369
|
*/
|
|
815
1370
|
editThreadV2<ThrowOnError extends boolean = false>(options: Options<EditThreadV2Data, ThrowOnError>): RequestResult<EditThreadV2Responses, EditThreadV2Errors, ThrowOnError>;
|
|
1371
|
+
/**
|
|
1372
|
+
* List the caller's API keys.
|
|
1373
|
+
*/
|
|
1374
|
+
listUserApiKeys<ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>): RequestResult<ListUserApiKeysResponses, ListUserApiKeysErrors, ThrowOnError>;
|
|
1375
|
+
/**
|
|
1376
|
+
* Mint a new API key for the caller.
|
|
1377
|
+
*/
|
|
1378
|
+
createUserApiKey<ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>): RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError>;
|
|
1379
|
+
/**
|
|
1380
|
+
* Delete one of the caller's API keys.
|
|
1381
|
+
*/
|
|
1382
|
+
deleteUserApiKey<ThrowOnError extends boolean = false>(options: Options<DeleteUserApiKeyData, ThrowOnError>): RequestResult<DeleteUserApiKeyResponses, DeleteUserApiKeyErrors, ThrowOnError>;
|
|
816
1383
|
/**
|
|
817
1384
|
* Deletes a document location for the user
|
|
818
1385
|
*/
|
|
@@ -830,6 +1397,10 @@ export declare class Sdk extends HeyApiClient {
|
|
|
830
1397
|
* Edit project metadata and sharing settings.
|
|
831
1398
|
*/
|
|
832
1399
|
editProjectV2<ThrowOnError extends boolean = false>(options: Options<EditProjectV2Data, ThrowOnError>): RequestResult<EditProjectV2Responses, EditProjectV2Errors, ThrowOnError>;
|
|
1400
|
+
/**
|
|
1401
|
+
* Stream matching broker events to the caller over Server-Sent Events.
|
|
1402
|
+
*/
|
|
1403
|
+
streamEvents<ThrowOnError extends boolean = false>(options: Options<StreamEventsData, ThrowOnError, StreamEventsResponse>): Promise<ServerSentEventsResult<StreamEventsResponses>>;
|
|
833
1404
|
/**
|
|
834
1405
|
* List the caller's webhooks.
|
|
835
1406
|
*/
|