@macro-inc/sdk 0.0.1
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 +177 -0
- package/dist/chunk-5HAKQN23.js +1263 -0
- package/dist/chunk-77EI4LSQ.js +2492 -0
- package/dist/chunk-CTKR64MY.js +1436 -0
- package/dist/chunk-JXIQT5TH.js +1467 -0
- package/dist/chunk-P4DTO6VD.js +830 -0
- package/dist/chunk-PAAFJYGO.js +967 -0
- package/dist/chunk-QNUS5BC5.js +913 -0
- package/dist/chunk-SGAHIERJ.js +1235 -0
- package/dist/chunk-V45LUJDI.js +838 -0
- package/dist/chunk-YRUXFEZM.js +1044 -0
- package/dist/generated/agent-harness/client/client.gen.d.ts +2 -0
- package/dist/generated/agent-harness/client/index.d.ts +10 -0
- package/dist/generated/agent-harness/client/types.gen.d.ts +120 -0
- package/dist/generated/agent-harness/client/utils.gen.d.ts +37 -0
- package/dist/generated/agent-harness/client.gen.d.ts +12 -0
- package/dist/generated/agent-harness/core/auth.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/params.gen.d.ts +43 -0
- package/dist/generated/agent-harness/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/agent-harness/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/agent-harness/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/agent-harness/core/types.gen.d.ts +83 -0
- package/dist/generated/agent-harness/core/utils.gen.d.ts +19 -0
- package/dist/generated/agent-harness/index.d.ts +2 -0
- package/dist/generated/agent-harness/index.js +6 -0
- package/dist/generated/agent-harness/sdk.gen.d.ts +84 -0
- package/dist/generated/agent-harness/types.gen.d.ts +539 -0
- package/dist/generated/auth/client/client.gen.d.ts +2 -0
- package/dist/generated/auth/client/index.d.ts +10 -0
- package/dist/generated/auth/client/types.gen.d.ts +120 -0
- package/dist/generated/auth/client/utils.gen.d.ts +37 -0
- package/dist/generated/auth/client.gen.d.ts +12 -0
- package/dist/generated/auth/core/auth.gen.d.ts +25 -0
- package/dist/generated/auth/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/auth/core/params.gen.d.ts +43 -0
- package/dist/generated/auth/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/auth/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/auth/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/auth/core/types.gen.d.ts +83 -0
- package/dist/generated/auth/core/utils.gen.d.ts +19 -0
- package/dist/generated/auth/index.d.ts +2 -0
- package/dist/generated/auth/index.js +6 -0
- package/dist/generated/auth/sdk.gen.d.ts +383 -0
- package/dist/generated/auth/types.gen.d.ts +2175 -0
- package/dist/generated/cognition/client/client.gen.d.ts +2 -0
- package/dist/generated/cognition/client/index.d.ts +10 -0
- package/dist/generated/cognition/client/types.gen.d.ts +120 -0
- package/dist/generated/cognition/client/utils.gen.d.ts +37 -0
- package/dist/generated/cognition/client.gen.d.ts +12 -0
- package/dist/generated/cognition/core/auth.gen.d.ts +25 -0
- package/dist/generated/cognition/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/cognition/core/params.gen.d.ts +43 -0
- package/dist/generated/cognition/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/cognition/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/cognition/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/cognition/core/types.gen.d.ts +83 -0
- package/dist/generated/cognition/core/utils.gen.d.ts +19 -0
- package/dist/generated/cognition/index.d.ts +2 -0
- package/dist/generated/cognition/index.js +6 -0
- package/dist/generated/cognition/sdk.gen.d.ts +224 -0
- package/dist/generated/cognition/types.gen.d.ts +2484 -0
- package/dist/generated/connection/client/client.gen.d.ts +2 -0
- package/dist/generated/connection/client/index.d.ts +10 -0
- package/dist/generated/connection/client/types.gen.d.ts +120 -0
- package/dist/generated/connection/client/utils.gen.d.ts +37 -0
- package/dist/generated/connection/client.gen.d.ts +12 -0
- package/dist/generated/connection/core/auth.gen.d.ts +25 -0
- package/dist/generated/connection/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/connection/core/params.gen.d.ts +43 -0
- package/dist/generated/connection/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/connection/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/connection/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/connection/core/types.gen.d.ts +83 -0
- package/dist/generated/connection/core/utils.gen.d.ts +19 -0
- package/dist/generated/connection/index.d.ts +2 -0
- package/dist/generated/connection/index.js +839 -0
- package/dist/generated/connection/sdk.gen.d.ts +38 -0
- package/dist/generated/connection/types.gen.d.ts +235 -0
- package/dist/generated/contacts/client/client.gen.d.ts +2 -0
- package/dist/generated/contacts/client/index.d.ts +10 -0
- package/dist/generated/contacts/client/types.gen.d.ts +120 -0
- package/dist/generated/contacts/client/utils.gen.d.ts +37 -0
- package/dist/generated/contacts/client.gen.d.ts +12 -0
- package/dist/generated/contacts/core/auth.gen.d.ts +25 -0
- package/dist/generated/contacts/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/contacts/core/params.gen.d.ts +43 -0
- package/dist/generated/contacts/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/contacts/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/contacts/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/contacts/core/types.gen.d.ts +83 -0
- package/dist/generated/contacts/core/utils.gen.d.ts +19 -0
- package/dist/generated/contacts/index.d.ts +2 -0
- package/dist/generated/contacts/index.js +6 -0
- package/dist/generated/contacts/sdk.gen.d.ts +43 -0
- package/dist/generated/contacts/types.gen.d.ts +52 -0
- package/dist/generated/email/client/client.gen.d.ts +2 -0
- package/dist/generated/email/client/index.d.ts +10 -0
- package/dist/generated/email/client/types.gen.d.ts +120 -0
- package/dist/generated/email/client/utils.gen.d.ts +37 -0
- package/dist/generated/email/client.gen.d.ts +12 -0
- package/dist/generated/email/core/auth.gen.d.ts +25 -0
- package/dist/generated/email/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/email/core/params.gen.d.ts +43 -0
- package/dist/generated/email/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/email/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/email/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/email/core/types.gen.d.ts +83 -0
- package/dist/generated/email/core/utils.gen.d.ts +19 -0
- package/dist/generated/email/index.d.ts +2 -0
- package/dist/generated/email/index.js +6 -0
- package/dist/generated/email/sdk.gen.d.ts +254 -0
- package/dist/generated/email/types.gen.d.ts +2614 -0
- package/dist/generated/notification/client/client.gen.d.ts +2 -0
- package/dist/generated/notification/client/index.d.ts +10 -0
- package/dist/generated/notification/client/types.gen.d.ts +120 -0
- package/dist/generated/notification/client/utils.gen.d.ts +37 -0
- package/dist/generated/notification/client.gen.d.ts +12 -0
- package/dist/generated/notification/core/auth.gen.d.ts +25 -0
- package/dist/generated/notification/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/notification/core/params.gen.d.ts +43 -0
- package/dist/generated/notification/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/notification/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/notification/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/notification/core/types.gen.d.ts +83 -0
- package/dist/generated/notification/core/utils.gen.d.ts +19 -0
- package/dist/generated/notification/index.d.ts +2 -0
- package/dist/generated/notification/index.js +6 -0
- package/dist/generated/notification/sdk.gen.d.ts +118 -0
- package/dist/generated/notification/types.gen.d.ts +1352 -0
- package/dist/generated/properties/client/client.gen.d.ts +2 -0
- package/dist/generated/properties/client/index.d.ts +10 -0
- package/dist/generated/properties/client/types.gen.d.ts +120 -0
- package/dist/generated/properties/client/utils.gen.d.ts +37 -0
- package/dist/generated/properties/client.gen.d.ts +12 -0
- package/dist/generated/properties/core/auth.gen.d.ts +25 -0
- package/dist/generated/properties/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/properties/core/params.gen.d.ts +43 -0
- package/dist/generated/properties/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/properties/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/properties/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/properties/core/types.gen.d.ts +83 -0
- package/dist/generated/properties/core/utils.gen.d.ts +19 -0
- package/dist/generated/properties/index.d.ts +2 -0
- package/dist/generated/properties/index.js +6 -0
- package/dist/generated/properties/sdk.gen.d.ts +158 -0
- package/dist/generated/properties/types.gen.d.ts +1288 -0
- package/dist/generated/scheduled-action/client/client.gen.d.ts +2 -0
- package/dist/generated/scheduled-action/client/index.d.ts +10 -0
- package/dist/generated/scheduled-action/client/types.gen.d.ts +120 -0
- package/dist/generated/scheduled-action/client/utils.gen.d.ts +37 -0
- package/dist/generated/scheduled-action/client.gen.d.ts +12 -0
- package/dist/generated/scheduled-action/core/auth.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/params.gen.d.ts +43 -0
- package/dist/generated/scheduled-action/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/scheduled-action/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/scheduled-action/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/scheduled-action/core/types.gen.d.ts +83 -0
- package/dist/generated/scheduled-action/core/utils.gen.d.ts +19 -0
- package/dist/generated/scheduled-action/index.d.ts +2 -0
- package/dist/generated/scheduled-action/index.js +845 -0
- package/dist/generated/scheduled-action/sdk.gen.d.ts +42 -0
- package/dist/generated/scheduled-action/types.gen.d.ts +241 -0
- package/dist/generated/search/client/client.gen.d.ts +2 -0
- package/dist/generated/search/client/index.d.ts +10 -0
- package/dist/generated/search/client/types.gen.d.ts +120 -0
- package/dist/generated/search/client/utils.gen.d.ts +37 -0
- package/dist/generated/search/client.gen.d.ts +12 -0
- package/dist/generated/search/core/auth.gen.d.ts +25 -0
- package/dist/generated/search/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/search/core/params.gen.d.ts +43 -0
- package/dist/generated/search/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/search/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/search/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/search/core/types.gen.d.ts +83 -0
- package/dist/generated/search/core/utils.gen.d.ts +19 -0
- package/dist/generated/search/index.d.ts +2 -0
- package/dist/generated/search/index.js +6 -0
- package/dist/generated/search/sdk.gen.d.ts +44 -0
- package/dist/generated/search/types.gen.d.ts +2194 -0
- package/dist/generated/static-files/client/client.gen.d.ts +2 -0
- package/dist/generated/static-files/client/index.d.ts +10 -0
- package/dist/generated/static-files/client/types.gen.d.ts +120 -0
- package/dist/generated/static-files/client/utils.gen.d.ts +37 -0
- package/dist/generated/static-files/client.gen.d.ts +12 -0
- package/dist/generated/static-files/core/auth.gen.d.ts +25 -0
- package/dist/generated/static-files/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/static-files/core/params.gen.d.ts +43 -0
- package/dist/generated/static-files/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/static-files/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/static-files/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/static-files/core/types.gen.d.ts +83 -0
- package/dist/generated/static-files/core/utils.gen.d.ts +19 -0
- package/dist/generated/static-files/index.d.ts +2 -0
- package/dist/generated/static-files/index.js +842 -0
- package/dist/generated/static-files/sdk.gen.d.ts +43 -0
- package/dist/generated/static-files/types.gen.d.ts +214 -0
- package/dist/generated/storage/client/client.gen.d.ts +2 -0
- package/dist/generated/storage/client/index.d.ts +10 -0
- package/dist/generated/storage/client/types.gen.d.ts +120 -0
- package/dist/generated/storage/client/utils.gen.d.ts +37 -0
- package/dist/generated/storage/client.gen.d.ts +12 -0
- package/dist/generated/storage/core/auth.gen.d.ts +25 -0
- package/dist/generated/storage/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/storage/core/params.gen.d.ts +43 -0
- package/dist/generated/storage/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/storage/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/storage/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/storage/core/types.gen.d.ts +83 -0
- package/dist/generated/storage/core/utils.gen.d.ts +19 -0
- package/dist/generated/storage/index.d.ts +2 -0
- package/dist/generated/storage/index.js +6 -0
- package/dist/generated/storage/sdk.gen.d.ts +858 -0
- package/dist/generated/storage/types.gen.d.ts +12105 -0
- package/dist/generated/unfurl/client/client.gen.d.ts +2 -0
- package/dist/generated/unfurl/client/index.d.ts +10 -0
- package/dist/generated/unfurl/client/types.gen.d.ts +120 -0
- package/dist/generated/unfurl/client/utils.gen.d.ts +37 -0
- package/dist/generated/unfurl/client.gen.d.ts +12 -0
- package/dist/generated/unfurl/core/auth.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/params.gen.d.ts +43 -0
- package/dist/generated/unfurl/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/unfurl/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/unfurl/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/unfurl/core/types.gen.d.ts +83 -0
- package/dist/generated/unfurl/core/utils.gen.d.ts +19 -0
- package/dist/generated/unfurl/index.d.ts +2 -0
- package/dist/generated/unfurl/index.js +835 -0
- package/dist/generated/unfurl/sdk.gen.d.ts +47 -0
- package/dist/generated/unfurl/types.gen.d.ts +125 -0
- package/dist/src/config.d.ts +51 -0
- package/dist/src/entities/agent-sessions/agent-session.d.ts +45 -0
- package/dist/src/entities/agent-sessions/namespace.d.ts +18 -0
- package/dist/src/entities/bots/namespace.d.ts +25 -0
- package/dist/src/entities/calls/call-record.d.ts +55 -0
- package/dist/src/entities/calls/namespace.d.ts +9 -0
- package/dist/src/entities/channels/channel.d.ts +88 -0
- package/dist/src/entities/channels/message.d.ts +64 -0
- package/dist/src/entities/channels/namespace.d.ts +30 -0
- package/dist/src/entities/channels/post.d.ts +20 -0
- package/dist/src/entities/channels/thread.d.ts +30 -0
- package/dist/src/entities/chats/chat.d.ts +55 -0
- package/dist/src/entities/chats/namespace.d.ts +14 -0
- package/dist/src/entities/crm/comment.d.ts +43 -0
- package/dist/src/entities/crm/company.d.ts +70 -0
- package/dist/src/entities/crm/contact.d.ts +48 -0
- package/dist/src/entities/crm/namespace.d.ts +22 -0
- package/dist/src/entities/documents/comment.d.ts +41 -0
- package/dist/src/entities/documents/document.d.ts +130 -0
- package/dist/src/entities/documents/namespace.d.ts +43 -0
- package/dist/src/entities/documents/system-skill.d.ts +16 -0
- package/dist/src/entities/email/attachment.d.ts +36 -0
- package/dist/src/entities/email/label.d.ts +31 -0
- package/dist/src/entities/email/link.d.ts +29 -0
- package/dist/src/entities/email/message.d.ts +58 -0
- package/dist/src/entities/email/namespace.d.ts +49 -0
- package/dist/src/entities/email/thread.d.ts +88 -0
- package/dist/src/entities/entity.d.ts +101 -0
- package/dist/src/entities/favorites/namespace.d.ts +19 -0
- package/dist/src/entities/foreign/foreign-entity.d.ts +30 -0
- package/dist/src/entities/foreign/namespace.d.ts +7 -0
- package/dist/src/entities/notifications/namespace.d.ts +29 -0
- package/dist/src/entities/notifications/notification.d.ts +50 -0
- package/dist/src/entities/pins/namespace.d.ts +19 -0
- package/dist/src/entities/projects/namespace.d.ts +13 -0
- package/dist/src/entities/projects/project.d.ts +42 -0
- package/dist/src/entities/properties/namespace.d.ts +47 -0
- package/dist/src/entities/properties/property-definition.d.ts +45 -0
- package/dist/src/entities/properties/property-option.d.ts +32 -0
- package/dist/src/entities/search.d.ts +23 -0
- package/dist/src/entities/tasks/namespace.d.ts +21 -0
- package/dist/src/entities/tasks/task.d.ts +34 -0
- package/dist/src/entities/teams/namespace.d.ts +12 -0
- package/dist/src/entities/teams/team.d.ts +40 -0
- package/dist/src/entities/users/namespace.d.ts +10 -0
- package/dist/src/entities/users/user.d.ts +43 -0
- package/dist/src/entities/webhooks/namespace.d.ts +31 -0
- package/dist/src/entities/webhooks/webhook.d.ts +88 -0
- package/dist/src/events/hydrate/channel.d.ts +85 -0
- package/dist/src/events/hydrate/document.d.ts +54 -0
- package/dist/src/events/receiver.d.ts +51 -0
- package/dist/src/events/types.d.ts +40 -0
- package/dist/src/events/verify.d.ts +13 -0
- package/dist/src/local-portmap.d.ts +8 -0
- package/dist/src/macro.d.ts +62 -0
- package/dist/src/macro.js +4215 -0
- package/dist/src/mentions.d.ts +37 -0
- package/dist/src/raw.d.ts +12 -0
- package/dist/src/utils/client.d.ts +53 -0
- package/dist/src/utils/index.d.ts +4 -0
- package/dist/src/utils/lazy.d.ts +18 -0
- package/dist/src/utils/pagination.d.ts +7 -0
- package/dist/src/utils/unwrap.d.ts +23 -0
- package/package.json +49 -0
|
@@ -0,0 +1,858 @@
|
|
|
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';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
|
+
/**
|
|
5
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
+
* individual options. This might be also useful if you want to implement a
|
|
7
|
+
* custom client.
|
|
8
|
+
*/
|
|
9
|
+
client?: Client;
|
|
10
|
+
/**
|
|
11
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
+
*/
|
|
14
|
+
meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
|
|
15
|
+
};
|
|
16
|
+
declare class HeyApiClient {
|
|
17
|
+
protected client: Client;
|
|
18
|
+
constructor(args?: {
|
|
19
|
+
client?: Client;
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
declare class HeyApiRegistry<T> {
|
|
23
|
+
private readonly defaultKey;
|
|
24
|
+
private readonly instances;
|
|
25
|
+
get(key?: string): T;
|
|
26
|
+
set(value: T, key?: string): void;
|
|
27
|
+
}
|
|
28
|
+
export declare class Sdk extends HeyApiClient {
|
|
29
|
+
static readonly __registry: HeyApiRegistry<Sdk>;
|
|
30
|
+
constructor(args?: {
|
|
31
|
+
client?: Client;
|
|
32
|
+
key?: string;
|
|
33
|
+
});
|
|
34
|
+
/**
|
|
35
|
+
* Deletes a single unthreaded anchor for a document
|
|
36
|
+
* If you need to delete a threaded anchor, see the delete comment handler
|
|
37
|
+
*/
|
|
38
|
+
deleteAnchor<ThrowOnError extends boolean = false>(options: Options<DeleteAnchorData, ThrowOnError>): RequestResult<DeleteAnchorResponses, DeleteAnchorErrors, ThrowOnError>;
|
|
39
|
+
/**
|
|
40
|
+
* Edits a single anchor for a document
|
|
41
|
+
*/
|
|
42
|
+
editAnchor<ThrowOnError extends boolean = false>(options: Options<EditAnchorData, ThrowOnError>): RequestResult<EditAnchorResponses, EditAnchorErrors, ThrowOnError>;
|
|
43
|
+
/**
|
|
44
|
+
* Gets a set of comment anchors for a document
|
|
45
|
+
*/
|
|
46
|
+
getDocumentAnchors<ThrowOnError extends boolean = false>(options: Options<GetDocumentAnchorsData, ThrowOnError>): RequestResult<GetDocumentAnchorsResponses, GetDocumentAnchorsErrors, ThrowOnError>;
|
|
47
|
+
/**
|
|
48
|
+
* Creates an unthreaded anchor for a document
|
|
49
|
+
* If you need to create a threaded anchor, see the create comment handler
|
|
50
|
+
*/
|
|
51
|
+
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
|
+
/**
|
|
70
|
+
* Handler for `GET /bots/me`.
|
|
71
|
+
*/
|
|
72
|
+
getSelfBot<ThrowOnError extends boolean = false>(options?: Options<GetSelfBotData, ThrowOnError>): RequestResult<GetSelfBotResponses, GetSelfBotErrors, ThrowOnError>;
|
|
73
|
+
/**
|
|
74
|
+
* Handler for `GET /bots/{bot_id}/channels`.
|
|
75
|
+
*/
|
|
76
|
+
listBotChannels<ThrowOnError extends boolean = false>(options: Options<ListBotChannelsData, ThrowOnError>): RequestResult<ListBotChannelsResponses, ListBotChannelsErrors, ThrowOnError>;
|
|
77
|
+
/**
|
|
78
|
+
* Handler for `DELETE /bots/{bot_id}/channels/{channel_id}`.
|
|
79
|
+
*/
|
|
80
|
+
removeBotFromChannelByBot<ThrowOnError extends boolean = false>(options: Options<RemoveBotFromChannelByBotData, ThrowOnError>): RequestResult<RemoveBotFromChannelByBotResponses, RemoveBotFromChannelByBotErrors, ThrowOnError>;
|
|
81
|
+
/**
|
|
82
|
+
* Return calendar occurrences visible to the authenticated requester.
|
|
83
|
+
*/
|
|
84
|
+
listOccurrences<ThrowOnError extends boolean = false>(options: Options<ListOccurrencesData, ThrowOnError>): RequestResult<ListOccurrencesResponses, ListOccurrencesErrors, ThrowOnError>;
|
|
85
|
+
/**
|
|
86
|
+
* Resolve mentioned calendar events to the requester's own projections.
|
|
87
|
+
*/
|
|
88
|
+
mentionPreviews<ThrowOnError extends boolean = false>(options: Options<MentionPreviewsData, ThrowOnError>): RequestResult<MentionPreviewsResponses, MentionPreviewsErrors, ThrowOnError>;
|
|
89
|
+
/**
|
|
90
|
+
* Handler for `GET /call/active`.
|
|
91
|
+
*
|
|
92
|
+
* Lists all active calls in channels the caller is an active member of,
|
|
93
|
+
* newest first. Calls with no active participants (orphaned by dropped RTC
|
|
94
|
+
* webhooks) are excluded.
|
|
95
|
+
*/
|
|
96
|
+
getActiveCalls<ThrowOnError extends boolean = false>(options?: Options<GetActiveCallsData, ThrowOnError>): RequestResult<GetActiveCallsResponses, GetActiveCallsErrors, ThrowOnError>;
|
|
97
|
+
/**
|
|
98
|
+
* Handler for `POST /call/record/preview`.
|
|
99
|
+
*
|
|
100
|
+
* Batch-fetches lightweight previews for a list of call ids. Mirrors the
|
|
101
|
+
* `POST /documents/preview` endpoint: no per-id access checks, duplicate
|
|
102
|
+
* ids are deduplicated server-side, and missing ids come back as
|
|
103
|
+
* `CallRecordPreview::DoesNotExist` rather than producing an error.
|
|
104
|
+
*/
|
|
105
|
+
getBatchCallRecordPreview<ThrowOnError extends boolean = false>(options: Options<GetBatchCallRecordPreviewData, ThrowOnError>): RequestResult<GetBatchCallRecordPreviewResponses, GetBatchCallRecordPreviewErrors, ThrowOnError>;
|
|
106
|
+
/**
|
|
107
|
+
* Handler for `DELETE /call/record/{call_id}`.
|
|
108
|
+
*
|
|
109
|
+
* Deletes a call record (and its participants/transcripts via cascade).
|
|
110
|
+
* Access is validated via channel membership (MemberParticipantRole).
|
|
111
|
+
*/
|
|
112
|
+
deleteCallRecord<ThrowOnError extends boolean = false>(options: Options<DeleteCallRecordData, ThrowOnError>): RequestResult<DeleteCallRecordResponses, DeleteCallRecordErrors, ThrowOnError>;
|
|
113
|
+
/**
|
|
114
|
+
* Handler for `GET /call/record/{call_id}`.
|
|
115
|
+
*
|
|
116
|
+
* Returns the full [`CallRecord`] (metadata + participants + transcript)
|
|
117
|
+
* for a call identified by its own id. Covers both active and archived calls.
|
|
118
|
+
* Access is validated via channel membership (MemberParticipantRole).
|
|
119
|
+
*/
|
|
120
|
+
getCallRecord<ThrowOnError extends boolean = false>(options: Options<GetCallRecordData, ThrowOnError>): RequestResult<GetCallRecordResponses, GetCallRecordErrors, ThrowOnError>;
|
|
121
|
+
/**
|
|
122
|
+
* Handler for `PATCH /call/record/{call_id}`.
|
|
123
|
+
*
|
|
124
|
+
* Edits a call record — currently supports updating the record's share
|
|
125
|
+
* permissions. Access is validated via channel membership
|
|
126
|
+
*/
|
|
127
|
+
editCallRecord<ThrowOnError extends boolean = false>(options: Options<EditCallRecordData, ThrowOnError>): RequestResult<EditCallRecordResponses, EditCallRecordErrors, ThrowOnError>;
|
|
128
|
+
/**
|
|
129
|
+
* Handler for `POST /call/record/{call_id}/share-with-team/toggle`.
|
|
130
|
+
*
|
|
131
|
+
* Toggles the `share_with_team` flag on the active call. Returns the new
|
|
132
|
+
* value as the JSON body.
|
|
133
|
+
*/
|
|
134
|
+
toggleShareWithTeam<ThrowOnError extends boolean = false>(options: Options<ToggleShareWithTeamData, ThrowOnError>): RequestResult<ToggleShareWithTeamResponses, ToggleShareWithTeamErrors, ThrowOnError>;
|
|
135
|
+
/**
|
|
136
|
+
* Handler for `PATCH /call/record/{call_id}/transcript`.
|
|
137
|
+
*
|
|
138
|
+
* Applies per-diarized-speaker `custom_speaker` overrides to the call's
|
|
139
|
+
* archived transcript rows. Auth uses the same `EditAccessLevel` extractor
|
|
140
|
+
* as `edit_call_record_handler`.
|
|
141
|
+
*/
|
|
142
|
+
editCallTranscript<ThrowOnError extends boolean = false>(options: Options<EditCallTranscriptData, ThrowOnError>): RequestResult<EditCallTranscriptResponses, EditCallTranscriptErrors, ThrowOnError>;
|
|
143
|
+
/**
|
|
144
|
+
* Handler for `GET /call/ring-status/{call_id}`.
|
|
145
|
+
*
|
|
146
|
+
* Reports whether the authenticated user should keep ringing for the call.
|
|
147
|
+
* Polled by native clients while the CallKit incoming-call UI is showing, so
|
|
148
|
+
* a ring can be cancelled when the user answers on another device
|
|
149
|
+
* (`answered`) or the call ends before anyone answers (`ended`).
|
|
150
|
+
*
|
|
151
|
+
* Outside the user-auth layer: the bearer credential is the recipient's
|
|
152
|
+
* LiveKit JWT from the VoIP push payload, verified with the LiveKit secret.
|
|
153
|
+
*/
|
|
154
|
+
getRingStatus<ThrowOnError extends boolean = false>(options: Options<GetRingStatusData, ThrowOnError>): RequestResult<GetRingStatusResponses, GetRingStatusErrors, ThrowOnError>;
|
|
155
|
+
/**
|
|
156
|
+
* Handler for `POST /call/webhook`.
|
|
157
|
+
*
|
|
158
|
+
* Receives webhook events from the RTC provider (e.g. LiveKit).
|
|
159
|
+
* The `Authorization` header contains the webhook auth token
|
|
160
|
+
* and the body contains the raw event payload.
|
|
161
|
+
*/
|
|
162
|
+
callWebhook<ThrowOnError extends boolean = false>(options?: Options<CallWebhookData, ThrowOnError>): RequestResult<CallWebhookResponses, CallWebhookErrors, ThrowOnError>;
|
|
163
|
+
/**
|
|
164
|
+
* Handler for `DELETE /call/{channel_id}`.
|
|
165
|
+
*/
|
|
166
|
+
leaveOrEndCall<ThrowOnError extends boolean = false>(options: Options<LeaveOrEndCallData, ThrowOnError>): RequestResult<LeaveOrEndCallResponses, LeaveOrEndCallErrors, ThrowOnError>;
|
|
167
|
+
/**
|
|
168
|
+
* Handler for `GET /call/{channel_id}`.
|
|
169
|
+
*
|
|
170
|
+
* Gets or creates a call for the channel. If a call already exists, joins it;
|
|
171
|
+
* otherwise creates a new one. Always returns a join token.
|
|
172
|
+
*/
|
|
173
|
+
getOrCreateCall<ThrowOnError extends boolean = false>(options: Options<GetOrCreateCallData, ThrowOnError>): RequestResult<GetOrCreateCallResponses, GetOrCreateCallErrors, ThrowOnError>;
|
|
174
|
+
/**
|
|
175
|
+
* Handler for `GET /call/{channel_id}/active`.
|
|
176
|
+
*
|
|
177
|
+
* Returns 200 with call info if an active call exists, or 204 No Content if not.
|
|
178
|
+
*/
|
|
179
|
+
checkActiveCall<ThrowOnError extends boolean = false>(options: Options<CheckActiveCallData, ThrowOnError>): RequestResult<CheckActiveCallResponses, CheckActiveCallErrors, ThrowOnError>;
|
|
180
|
+
/**
|
|
181
|
+
* Handler for `POST /call/{channel_id}/transcript`.
|
|
182
|
+
*
|
|
183
|
+
* Receives transcript segments from the transcription agent.
|
|
184
|
+
* Authenticated via the `x-macro-internal-call` shared secret.
|
|
185
|
+
* Duplicate segments (same `segment_id`) are ignored.
|
|
186
|
+
*/
|
|
187
|
+
ingestTranscript<ThrowOnError extends boolean = false>(options: Options<IngestTranscriptData, ThrowOnError>): RequestResult<IngestTranscriptResponses, IngestTranscriptErrors, ThrowOnError>;
|
|
188
|
+
/**
|
|
189
|
+
* Handler for `POST /channels`.
|
|
190
|
+
*/
|
|
191
|
+
createChannel<ThrowOnError extends boolean = false>(options: Options<CreateChannelData, ThrowOnError>): RequestResult<CreateChannelResponses, CreateChannelErrors, ThrowOnError>;
|
|
192
|
+
/**
|
|
193
|
+
* Handler for `GET /channels/activity`.
|
|
194
|
+
*/
|
|
195
|
+
getActivity<ThrowOnError extends boolean = false>(options?: Options<GetActivityData, ThrowOnError>): RequestResult<GetActivityResponses, GetActivityErrors, ThrowOnError>;
|
|
196
|
+
/**
|
|
197
|
+
* Handler for `POST /channels/activity`.
|
|
198
|
+
*/
|
|
199
|
+
postActivity<ThrowOnError extends boolean = false>(options: Options<PostActivityData, ThrowOnError>): RequestResult<PostActivityResponses, PostActivityErrors, ThrowOnError>;
|
|
200
|
+
/**
|
|
201
|
+
* Handler for `GET /channels/attachments/{entity_type}/{entity_id}/references`.
|
|
202
|
+
*/
|
|
203
|
+
getAttachmentReferences<ThrowOnError extends boolean = false>(options: Options<GetAttachmentReferencesData, ThrowOnError>): RequestResult<GetAttachmentReferencesResponses, GetAttachmentReferencesErrors, ThrowOnError>;
|
|
204
|
+
/**
|
|
205
|
+
* Handler for `POST /channels/get_or_create_dm`.
|
|
206
|
+
*/
|
|
207
|
+
getOrCreateDm<ThrowOnError extends boolean = false>(options: Options<GetOrCreateDmData, ThrowOnError>): RequestResult<GetOrCreateDmResponses, GetOrCreateDmErrors, ThrowOnError>;
|
|
208
|
+
/**
|
|
209
|
+
* Handler for `POST /channels/get_or_create_private`.
|
|
210
|
+
*/
|
|
211
|
+
getOrCreatePrivate<ThrowOnError extends boolean = false>(options: Options<GetOrCreatePrivateData, ThrowOnError>): RequestResult<GetOrCreatePrivateResponses, GetOrCreatePrivateErrors, ThrowOnError>;
|
|
212
|
+
/**
|
|
213
|
+
* Handler for `POST /channels/join/{join_code}`.
|
|
214
|
+
*/
|
|
215
|
+
joinChannelByCode<ThrowOnError extends boolean = false>(options: Options<JoinChannelByCodeData, ThrowOnError>): RequestResult<JoinChannelByCodeResponses, JoinChannelByCodeErrors, ThrowOnError>;
|
|
216
|
+
/**
|
|
217
|
+
* Handler for `POST /channels/mentions`.
|
|
218
|
+
*/
|
|
219
|
+
createEntityMention<ThrowOnError extends boolean = false>(options: Options<CreateEntityMentionData, ThrowOnError>): RequestResult<CreateEntityMentionResponses, CreateEntityMentionErrors, ThrowOnError>;
|
|
220
|
+
/**
|
|
221
|
+
* Handler for `DELETE /channels/mentions/{mention_id}`.
|
|
222
|
+
*/
|
|
223
|
+
deleteEntityMention<ThrowOnError extends boolean = false>(options: Options<DeleteEntityMentionData, ThrowOnError>): RequestResult<DeleteEntityMentionResponses, DeleteEntityMentionErrors, ThrowOnError>;
|
|
224
|
+
/**
|
|
225
|
+
* Handler for `POST /channels/preview`.
|
|
226
|
+
*/
|
|
227
|
+
getBatchChannelPreview<ThrowOnError extends boolean = false>(options: Options<GetBatchChannelPreviewData, ThrowOnError>): RequestResult<GetBatchChannelPreviewResponses, GetBatchChannelPreviewErrors, ThrowOnError>;
|
|
228
|
+
/**
|
|
229
|
+
* Handler for `DELETE /channels/{channel_id}`.
|
|
230
|
+
*/
|
|
231
|
+
deleteChannel<ThrowOnError extends boolean = false>(options: Options<DeleteChannelData, ThrowOnError>): RequestResult<DeleteChannelResponses, DeleteChannelErrors, ThrowOnError>;
|
|
232
|
+
/**
|
|
233
|
+
* Handler for `GET /channels/{channel_id}`.
|
|
234
|
+
*/
|
|
235
|
+
getChannel<ThrowOnError extends boolean = false>(options: Options<GetChannelData, ThrowOnError>): RequestResult<GetChannelResponses, GetChannelErrors, ThrowOnError>;
|
|
236
|
+
/**
|
|
237
|
+
* Handler for `PATCH /channels/{channel_id}`.
|
|
238
|
+
*/
|
|
239
|
+
patchChannel<ThrowOnError extends boolean = false>(options: Options<PatchChannelData, ThrowOnError>): RequestResult<PatchChannelResponses, PatchChannelErrors, ThrowOnError>;
|
|
240
|
+
/**
|
|
241
|
+
* Handler for `GET /channels/{channel_id}/attachments`.
|
|
242
|
+
*/
|
|
243
|
+
getChannelAttachments<ThrowOnError extends boolean = false>(options: Options<GetChannelAttachmentsData, ThrowOnError>): RequestResult<GetChannelAttachmentsResponses, GetChannelAttachmentsErrors, ThrowOnError>;
|
|
244
|
+
/**
|
|
245
|
+
* Handler for `POST /channels/{channel_id}/bots/scoped`.
|
|
246
|
+
*/
|
|
247
|
+
createChannelScopedBot<ThrowOnError extends boolean = false>(options: Options<CreateChannelScopedBotData, ThrowOnError>): RequestResult<CreateChannelScopedBotResponses, CreateChannelScopedBotErrors, ThrowOnError>;
|
|
248
|
+
/**
|
|
249
|
+
* Handler for `POST /channels/{channel_id}/join`.
|
|
250
|
+
*/
|
|
251
|
+
joinChannel<ThrowOnError extends boolean = false>(options: Options<JoinChannelData, ThrowOnError>): RequestResult<JoinChannelResponses, JoinChannelErrors, ThrowOnError>;
|
|
252
|
+
/**
|
|
253
|
+
* Handler for `GET /channels/{channel_id}/join-link`.
|
|
254
|
+
*/
|
|
255
|
+
getChannelJoinLink<ThrowOnError extends boolean = false>(options: Options<GetChannelJoinLinkData, ThrowOnError>): RequestResult<GetChannelJoinLinkResponses, GetChannelJoinLinkErrors, ThrowOnError>;
|
|
256
|
+
/**
|
|
257
|
+
* Handler for `POST /channels/{channel_id}/leave`.
|
|
258
|
+
*/
|
|
259
|
+
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
|
+
/**
|
|
293
|
+
* Handler for `DELETE /channels/{channel_id}/participants`.
|
|
294
|
+
*/
|
|
295
|
+
removeParticipants<ThrowOnError extends boolean = false>(options: Options<RemoveParticipantsData, ThrowOnError>): RequestResult<RemoveParticipantsResponses, RemoveParticipantsErrors, ThrowOnError>;
|
|
296
|
+
/**
|
|
297
|
+
* Handler for `GET /channels/{channel_id}/participants`.
|
|
298
|
+
*/
|
|
299
|
+
getChannelParticipants<ThrowOnError extends boolean = false>(options: Options<GetChannelParticipantsData, ThrowOnError>): RequestResult<GetChannelParticipantsResponses, GetChannelParticipantsErrors, ThrowOnError>;
|
|
300
|
+
/**
|
|
301
|
+
* Handler for `POST /channels/{channel_id}/participants`.
|
|
302
|
+
*/
|
|
303
|
+
addParticipants<ThrowOnError extends boolean = false>(options: Options<AddParticipantsData, ThrowOnError>): RequestResult<AddParticipantsResponses, AddParticipantsErrors, ThrowOnError>;
|
|
304
|
+
/**
|
|
305
|
+
* Handler for `POST /channels/{channel_id}/reaction`.
|
|
306
|
+
*/
|
|
307
|
+
postReaction<ThrowOnError extends boolean = false>(options: Options<PostReactionData, ThrowOnError>): RequestResult<PostReactionResponses, PostReactionErrors, ThrowOnError>;
|
|
308
|
+
/**
|
|
309
|
+
* Handler for `POST /channels/{channel_id}/typing`.
|
|
310
|
+
*/
|
|
311
|
+
postTyping<ThrowOnError extends boolean = false>(options: Options<PostTypingData, ThrowOnError>): RequestResult<PostTypingResponses, PostTypingErrors, ThrowOnError>;
|
|
312
|
+
/**
|
|
313
|
+
* Handler for `POST /channels/{channel_id}/webhook`.
|
|
314
|
+
*/
|
|
315
|
+
postChannelBotWebhook<ThrowOnError extends boolean = false>(options: Options<PostChannelBotWebhookData, ThrowOnError>): RequestResult<PostChannelBotWebhookResponses, PostChannelBotWebhookErrors, ThrowOnError>;
|
|
316
|
+
/**
|
|
317
|
+
* Soft-delete a collab surface.
|
|
318
|
+
*/
|
|
319
|
+
deleteCollabSurface<ThrowOnError extends boolean = false>(options: Options<DeleteCollabSurfaceData, ThrowOnError>): RequestResult<DeleteCollabSurfaceResponses, DeleteCollabSurfaceErrors, ThrowOnError>;
|
|
320
|
+
/**
|
|
321
|
+
* Fetch a collab surface.
|
|
322
|
+
*/
|
|
323
|
+
getCollabSurface<ThrowOnError extends boolean = false>(options: Options<GetCollabSurfaceData, ThrowOnError>): RequestResult<GetCollabSurfaceResponses, GetCollabSurfaceErrors, ThrowOnError>;
|
|
324
|
+
/**
|
|
325
|
+
* Idempotently ensure a collab surface exists (load-or-create).
|
|
326
|
+
*
|
|
327
|
+
* The id is caller-supplied, so an embedding surface can hold a stable id
|
|
328
|
+
* and blindly ensure it on mount: the first ensure creates and initializes
|
|
329
|
+
* the session, every later one (including concurrent ones) returns the same
|
|
330
|
+
* surface. A soft-deleted id is `410 Gone` and never comes back.
|
|
331
|
+
*/
|
|
332
|
+
ensureCollabSurface<ThrowOnError extends boolean = false>(options: Options<EnsureCollabSurfaceData, ThrowOnError>): RequestResult<EnsureCollabSurfaceResponses, EnsureCollabSurfaceErrors, ThrowOnError>;
|
|
333
|
+
/**
|
|
334
|
+
* Mint a sync-service connection token for a surface.
|
|
335
|
+
*/
|
|
336
|
+
createCollabSurfaceToken<ThrowOnError extends boolean = false>(options: Options<CreateCollabSurfaceTokenData, ThrowOnError>): RequestResult<CreateCollabSurfaceTokenResponses, CreateCollabSurfaceTokenErrors, ThrowOnError>;
|
|
337
|
+
/**
|
|
338
|
+
* Handle channel list requests for `GET /comms/channels`.
|
|
339
|
+
*/
|
|
340
|
+
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
|
+
/**
|
|
368
|
+
* Manually create a CRM company for the caller's team. Any team member
|
|
369
|
+
* may create one. The domain must not already be tracked by the team
|
|
370
|
+
* (409), and the team's CRM killswitch must be on (403). Returns the
|
|
371
|
+
* created company in the same shape as `GET /crm/companies/{id}` (its
|
|
372
|
+
* contact list is empty until emails populate it).
|
|
373
|
+
*/
|
|
374
|
+
createCrmCompany<ThrowOnError extends boolean = false>(options: Options<CreateCrmCompanyData, ThrowOnError>): RequestResult<CreateCrmCompanyResponses, CreateCrmCompanyErrors, ThrowOnError>;
|
|
375
|
+
/**
|
|
376
|
+
* Fetch a single CRM company by id, hydrated with its domains, the
|
|
377
|
+
* primary domain's directory display metadata (name + description),
|
|
378
|
+
* and the company's contacts. Access is enforced by
|
|
379
|
+
* [`CrmCompanyAccessLevelExtractor`]: the user must be on the team
|
|
380
|
+
* that owns the company, and hidden companies are invisible to plain
|
|
381
|
+
* members. Admin/owner callers see hidden companies and contacts so
|
|
382
|
+
* they can render the right unhide UI.
|
|
383
|
+
*/
|
|
384
|
+
getCompany<ThrowOnError extends boolean = false>(options: Options<GetCompanyData, ThrowOnError>): RequestResult<GetCompanyResponses, GetCompanyErrors, ThrowOnError>;
|
|
385
|
+
/**
|
|
386
|
+
* List the contacts of a CRM company. Access is enforced by
|
|
387
|
+
* [`CrmCompanyAccessLevelExtractor`]: the user must be on the team that
|
|
388
|
+
* owns the company. Hidden companies and hidden contacts are invisible
|
|
389
|
+
* to plain members; admin/owner callers see hidden rows so they can
|
|
390
|
+
* render the right unhide UI.
|
|
391
|
+
*/
|
|
392
|
+
listCompanyContacts<ThrowOnError extends boolean = false>(options: Options<ListCompanyContactsData, ThrowOnError>): RequestResult<ListCompanyContactsResponses, ListCompanyContactsErrors, ThrowOnError>;
|
|
393
|
+
/**
|
|
394
|
+
* Manually create a contact under a CRM company. Access is enforced by
|
|
395
|
+
* [`CrmCompanyAccessLevelExtractor`]: the caller must be on the team
|
|
396
|
+
* that owns the company (hidden companies are reachable for
|
|
397
|
+
* admin/owner only, and the new contact then inherits `hidden`). The
|
|
398
|
+
* email's domain must be one of the company's domains (400), the
|
|
399
|
+
* company must not already track the email (409), and the team's CRM
|
|
400
|
+
* killswitch must be on (403).
|
|
401
|
+
*/
|
|
402
|
+
createCrmContact<ThrowOnError extends boolean = false>(options: Options<CreateCrmContactData, ThrowOnError>): RequestResult<CreateCrmContactResponses, CreateCrmContactErrors, ThrowOnError>;
|
|
403
|
+
/**
|
|
404
|
+
* Toggle `email_sync` on a CRM company. Purely a visibility flag —
|
|
405
|
+
* it gates whether team members can see each other's emails with
|
|
406
|
+
* this company. Existing CRM data is unaffected.
|
|
407
|
+
*/
|
|
408
|
+
setEmailSync<ThrowOnError extends boolean = false>(options: Options<SetEmailSyncData, ThrowOnError>): RequestResult<SetEmailSyncResponses, SetEmailSyncErrors, ThrowOnError>;
|
|
409
|
+
/**
|
|
410
|
+
* Toggle `hidden` on a CRM company. Hiding also disables
|
|
411
|
+
* `email_sync` and soft-hides every contact under the company.
|
|
412
|
+
* Un-hide restores contact visibility only; `email_sync` is left
|
|
413
|
+
* untouched (the team must re-enable it explicitly). Contact rows
|
|
414
|
+
* and contact sources survive the cycle.
|
|
415
|
+
*/
|
|
416
|
+
setCompanyHidden<ThrowOnError extends boolean = false>(options: Options<SetCompanyHiddenData, ThrowOnError>): RequestResult<SetCompanyHiddenResponses, SetCompanyHiddenErrors, ThrowOnError>;
|
|
417
|
+
/**
|
|
418
|
+
* Rename a CRM company. Access is enforced by
|
|
419
|
+
* [`CrmCompanyAccessLevelExtractor`]: the caller must be on the team
|
|
420
|
+
* that owns the company (hidden companies are reachable for
|
|
421
|
+
* admin/owner only). The name is a team-scoped override
|
|
422
|
+
* (`custom_name`) and never touches the global domain directory.
|
|
423
|
+
*/
|
|
424
|
+
setCrmCompanyName<ThrowOnError extends boolean = false>(options: Options<SetCrmCompanyNameData, ThrowOnError>): RequestResult<SetCrmCompanyNameResponses, SetCrmCompanyNameErrors, ThrowOnError>;
|
|
425
|
+
/**
|
|
426
|
+
* Look up a CRM contact by email in the caller's team. Returns a null
|
|
427
|
+
* `contact` when no visible contact exists. Any team member may resolve a
|
|
428
|
+
* visible contact; admin/owner callers may also resolve hidden contacts and
|
|
429
|
+
* contacts under hidden companies.
|
|
430
|
+
*/
|
|
431
|
+
getContactByEmail<ThrowOnError extends boolean = false>(options: Options<GetContactByEmailData, ThrowOnError>): RequestResult<GetContactByEmailResponses, GetContactByEmailErrors, ThrowOnError>;
|
|
432
|
+
/**
|
|
433
|
+
* Fetch a single CRM contact by id. Access is enforced by
|
|
434
|
+
* [`CrmContactAccessLevelExtractor`]: the user must be on the team that
|
|
435
|
+
* owns the contact's parent company, and hidden contacts are invisible
|
|
436
|
+
* to plain members. Admin/owner callers see hidden contacts so they can
|
|
437
|
+
* render the right unhide UI.
|
|
438
|
+
*/
|
|
439
|
+
getContact<ThrowOnError extends boolean = false>(options: Options<GetContactData, ThrowOnError>): RequestResult<GetContactResponses, GetContactErrors, ThrowOnError>;
|
|
440
|
+
/**
|
|
441
|
+
* Toggle `hidden` on a CRM contact. Hiding is a display-only opt-out
|
|
442
|
+
* scoped to the team that owns the contact's company.
|
|
443
|
+
*/
|
|
444
|
+
setContactHidden<ThrowOnError extends boolean = false>(options: Options<SetContactHiddenData, ThrowOnError>): RequestResult<SetContactHiddenResponses, SetContactHiddenErrors, ThrowOnError>;
|
|
445
|
+
/**
|
|
446
|
+
* Rename a CRM contact. Access is enforced by
|
|
447
|
+
* [`CrmContactAccessLevelExtractor`]: the caller must be on the team
|
|
448
|
+
* that owns the contact's company (hidden contacts are reachable for
|
|
449
|
+
* admin/owner only). The name overwrites the team-scoped
|
|
450
|
+
* `crm_contacts.name` column.
|
|
451
|
+
*/
|
|
452
|
+
setCrmContactName<ThrowOnError extends boolean = false>(options: Options<SetCrmContactNameData, ThrowOnError>): RequestResult<SetCrmContactNameResponses, SetCrmContactNameErrors, ThrowOnError>;
|
|
453
|
+
/**
|
|
454
|
+
* Read the caller's team CRM configuration. Any team member may read;
|
|
455
|
+
* teams without a settings row get the defaults.
|
|
456
|
+
*/
|
|
457
|
+
getCrmTeamSettings<ThrowOnError extends boolean = false>(options?: Options<GetCrmTeamSettingsData, ThrowOnError>): RequestResult<GetCrmTeamSettingsResponses, GetCrmTeamSettingsErrors, ThrowOnError>;
|
|
458
|
+
/**
|
|
459
|
+
* Partially update the caller's team CRM configuration. Any team
|
|
460
|
+
* member may update the views fields (`team_views`,
|
|
461
|
+
* `default_team_view_id`); the governance fields (permission
|
|
462
|
+
* thresholds, `closed_stage_ids`) require an admin/owner team role
|
|
463
|
+
* (403 otherwise). Omitted fields keep their current values;
|
|
464
|
+
* `team_views` is replaced whole. Returns the resulting settings.
|
|
465
|
+
*/
|
|
466
|
+
putCrmTeamSettings<ThrowOnError extends boolean = false>(options: Options<PutCrmTeamSettingsData, ThrowOnError>): RequestResult<PutCrmTeamSettingsResponses, PutCrmTeamSettingsErrors, ThrowOnError>;
|
|
467
|
+
/**
|
|
468
|
+
* Gets the users documents to populate their recent document list
|
|
469
|
+
*/
|
|
470
|
+
getUserDocumentsHandler<ThrowOnError extends boolean = false>(options: Options<GetUserDocumentsHandlerData, ThrowOnError>): RequestResult<GetUserDocumentsHandlerResponses, GetUserDocumentsHandlerErrors, ThrowOnError>;
|
|
471
|
+
/**
|
|
472
|
+
* Handler for `POST /documents`.
|
|
473
|
+
*
|
|
474
|
+
* Creates a new document, generates an S3 presigned upload URL, and returns
|
|
475
|
+
* the document metadata with the URL for the client to upload to.
|
|
476
|
+
*/
|
|
477
|
+
createDocument<ThrowOnError extends boolean = false>(options: Options<CreateDocumentData, ThrowOnError>): RequestResult<CreateDocumentResponses, CreateDocumentErrors, ThrowOnError>;
|
|
478
|
+
/**
|
|
479
|
+
* Creates and initializes a markdown document in one backend-owned lifecycle.
|
|
480
|
+
*/
|
|
481
|
+
createMarkdownHandler<ThrowOnError extends boolean = false>(options: Options<CreateMarkdownHandlerData, ThrowOnError>): RequestResult<CreateMarkdownHandlerResponses, CreateMarkdownHandlerErrors, ThrowOnError>;
|
|
482
|
+
/**
|
|
483
|
+
* Creates a skill document with initialized markdown content in one
|
|
484
|
+
* backend-owned lifecycle. Skills are markdown documents containing
|
|
485
|
+
* instructions that AI reads and follows when the skill is referenced in an
|
|
486
|
+
* AI input.
|
|
487
|
+
*/
|
|
488
|
+
createSkillHandler<ThrowOnError extends boolean = false>(options: Options<CreateSkillHandlerData, ThrowOnError>): RequestResult<CreateSkillHandlerResponses, CreateSkillHandlerErrors, ThrowOnError>;
|
|
489
|
+
/**
|
|
490
|
+
* Creates a snippet document with initialized markdown content in one
|
|
491
|
+
* backend-owned lifecycle. Snippets are created personal; team sharing is
|
|
492
|
+
* toggled separately via `PUT /documents/{document_id}/team_share`.
|
|
493
|
+
*/
|
|
494
|
+
createSnippetHandler<ThrowOnError extends boolean = false>(options: Options<CreateSnippetHandlerData, ThrowOnError>): RequestResult<CreateSnippetHandlerResponses, CreateSnippetHandlerErrors, ThrowOnError>;
|
|
495
|
+
/**
|
|
496
|
+
* Creates a task document with properties and initialized markdown content in
|
|
497
|
+
* one backend-owned lifecycle.
|
|
498
|
+
*/
|
|
499
|
+
createTaskHandler<ThrowOnError extends boolean = false>(options: Options<CreateTaskHandlerData, ThrowOnError>): RequestResult<CreateTaskHandlerResponses, CreateTaskHandlerErrors, ThrowOnError>;
|
|
500
|
+
initializeUserDocuments<ThrowOnError extends boolean = false>(options?: Options<InitializeUserDocumentsData, ThrowOnError>): RequestResult<InitializeUserDocumentsResponses, InitializeUserDocumentsErrors, ThrowOnError>;
|
|
501
|
+
/**
|
|
502
|
+
* Gets a list of all the user's documents so they are able to be searched on
|
|
503
|
+
*/
|
|
504
|
+
getDocumentListHandler<ThrowOnError extends boolean = false>(options?: Options<GetDocumentListHandlerData, ThrowOnError>): RequestResult<GetDocumentListHandlerResponses, GetDocumentListHandlerErrors, ThrowOnError>;
|
|
505
|
+
/**
|
|
506
|
+
* Validates the provided document permissions token
|
|
507
|
+
*/
|
|
508
|
+
validateDocumentPermissionsToken<ThrowOnError extends boolean = false>(options: Options<ValidateDocumentPermissionsTokenData, ThrowOnError>): RequestResult<ValidateDocumentPermissionsTokenResponses, ValidateDocumentPermissionsTokenErrors, ThrowOnError>;
|
|
509
|
+
/**
|
|
510
|
+
* Generates a document permissions token for a provided document id
|
|
511
|
+
*/
|
|
512
|
+
getDocumentPermissionsToken<ThrowOnError extends boolean = false>(options: Options<GetDocumentPermissionsTokenData, ThrowOnError>): RequestResult<GetDocumentPermissionsTokenResponses, GetDocumentPermissionsTokenErrors, ThrowOnError>;
|
|
513
|
+
/**
|
|
514
|
+
* Takes the docx document bom parts and generates presigned urls to upload
|
|
515
|
+
* any new content
|
|
516
|
+
*
|
|
517
|
+
* @deprecated
|
|
518
|
+
*/
|
|
519
|
+
presaveDocumentHandler<ThrowOnError extends boolean = false>(options: Options<PresaveDocumentHandlerData, ThrowOnError>): RequestResult<PresaveDocumentHandlerResponses, PresaveDocumentHandlerErrors, ThrowOnError>;
|
|
520
|
+
getBatchPreviewHandler<ThrowOnError extends boolean = false>(options: Options<GetBatchPreviewHandlerData, ThrowOnError>): RequestResult<GetBatchPreviewHandlerResponses, GetBatchPreviewHandlerErrors, ThrowOnError>;
|
|
521
|
+
/**
|
|
522
|
+
* Handler for `GET /documents/slug/{slug}`.
|
|
523
|
+
*
|
|
524
|
+
* Returns document metadata, user access level, and view location.
|
|
525
|
+
*/
|
|
526
|
+
getDocumentByTeamSlug<ThrowOnError extends boolean = false>(options: Options<GetDocumentByTeamSlugData, ThrowOnError>): RequestResult<GetDocumentByTeamSlugResponses, GetDocumentByTeamSlugErrors, ThrowOnError>;
|
|
527
|
+
/**
|
|
528
|
+
* Resolves the current user's starter documents.
|
|
529
|
+
*/
|
|
530
|
+
handler<ThrowOnError extends boolean = false>(options?: Options<HandlerData, ThrowOnError>): RequestResult<HandlerResponses, HandlerErrors, ThrowOnError>;
|
|
531
|
+
/**
|
|
532
|
+
* Lists the built-in system skills. System skills are static, code-defined
|
|
533
|
+
* AI instructions (see the `system_skills` crate); they surface in the
|
|
534
|
+
* skills menu and AI skill tools like user skills, but have no document
|
|
535
|
+
* behind them, so clients must not offer to open them.
|
|
536
|
+
*/
|
|
537
|
+
getSystemSkillsHandler<ThrowOnError extends boolean = false>(options?: Options<GetSystemSkillsHandlerData, ThrowOnError>): RequestResult<GetSystemSkillsHandlerResponses, GetSystemSkillsHandlerErrors, ThrowOnError>;
|
|
538
|
+
/**
|
|
539
|
+
* Handler for `DELETE /documents/{document_id}`.
|
|
540
|
+
*
|
|
541
|
+
* Soft-deletes a document (only owners can delete).
|
|
542
|
+
*/
|
|
543
|
+
deleteDocument<ThrowOnError extends boolean = false>(options: Options<DeleteDocumentData, ThrowOnError>): RequestResult<DeleteDocumentResponses, DeleteDocumentErrors, ThrowOnError>;
|
|
544
|
+
/**
|
|
545
|
+
* Handler for `GET /documents/{document_id}`.
|
|
546
|
+
*
|
|
547
|
+
* Returns document metadata, user access level, and view location.
|
|
548
|
+
*/
|
|
549
|
+
getDocument<ThrowOnError extends boolean = false>(options: Options<GetDocumentData, ThrowOnError>): RequestResult<GetDocumentResponses, GetDocumentErrors, ThrowOnError>;
|
|
550
|
+
/**
|
|
551
|
+
* Handler for `PATCH /documents/{document_id}`.
|
|
552
|
+
*
|
|
553
|
+
* Edits document metadata such as name or project, and modifies
|
|
554
|
+
* the document's share permissions. Requires edit access to the document,
|
|
555
|
+
* and edit access to the target project if moving the document.
|
|
556
|
+
*/
|
|
557
|
+
editDocument<ThrowOnError extends boolean = false>(options: Options<EditDocumentData, ThrowOnError>): RequestResult<EditDocumentResponses, EditDocumentErrors, ThrowOnError>;
|
|
558
|
+
/**
|
|
559
|
+
* Creates a new version of a document
|
|
560
|
+
*/
|
|
561
|
+
saveDocumentHandler<ThrowOnError extends boolean = false>(options: Options<SaveDocumentHandlerData, ThrowOnError>): RequestResult<SaveDocumentHandlerResponses, SaveDocumentHandlerErrors, ThrowOnError>;
|
|
562
|
+
/**
|
|
563
|
+
* Handler for `GET /documents/{document_id}/branch_name`.
|
|
564
|
+
*
|
|
565
|
+
* Returns the short UUID and git branch name for a task document.
|
|
566
|
+
* Returns 400 if the document is not a task.
|
|
567
|
+
*/
|
|
568
|
+
getDocumentBranchName<ThrowOnError extends boolean = false>(options: Options<GetDocumentBranchNameData, ThrowOnError>): RequestResult<GetDocumentBranchNameResponses, GetDocumentBranchNameErrors, ThrowOnError>;
|
|
569
|
+
/**
|
|
570
|
+
* Handler for `POST /documents/{document_id}/copy`.
|
|
571
|
+
*
|
|
572
|
+
* Copies an existing document, creating a new document with the same content.
|
|
573
|
+
* Does not require re-uploading the document file.
|
|
574
|
+
*/
|
|
575
|
+
copyDocument<ThrowOnError extends boolean = false>(options: Options<CopyDocumentData, ThrowOnError>): RequestResult<CopyDocumentResponses, CopyDocumentErrors, ThrowOnError>;
|
|
576
|
+
/**
|
|
577
|
+
* Generates a presigned url to download the raw content of the document
|
|
578
|
+
* For files with modification layers, they will not be applied in the downloaded file.
|
|
579
|
+
*/
|
|
580
|
+
exportDocument<ThrowOnError extends boolean = false>(options: Options<ExportDocumentData, ThrowOnError>): RequestResult<ExportDocumentResponses, ExportDocumentErrors, ThrowOnError>;
|
|
581
|
+
/**
|
|
582
|
+
* Handler for `GET /documents/{document_id}/github_prs`.
|
|
583
|
+
*
|
|
584
|
+
* Returns GitHub pull requests associated with a task document.
|
|
585
|
+
* Returns 400 if the document is not a task.
|
|
586
|
+
*/
|
|
587
|
+
getDocumentGithubPullRequests<ThrowOnError extends boolean = false>(options: Options<GetDocumentGithubPullRequestsData, ThrowOnError>): RequestResult<GetDocumentGithubPullRequestsResponses, GetDocumentGithubPullRequestsErrors, ThrowOnError>;
|
|
588
|
+
/**
|
|
589
|
+
* Gets the presigned url(s) for the document. aka location
|
|
590
|
+
*/
|
|
591
|
+
getLocationHandler<ThrowOnError extends boolean = false>(options: Options<GetLocationHandlerData, ThrowOnError>): RequestResult<GetLocationHandlerResponses, GetLocationHandlerErrors, ThrowOnError>;
|
|
592
|
+
/**
|
|
593
|
+
* Handler for `GET /documents/{document_id}/location_v3`.
|
|
594
|
+
*
|
|
595
|
+
* Returns a presigned URL or sync service content for accessing the document.
|
|
596
|
+
*/
|
|
597
|
+
getDocumentLocationV3<ThrowOnError extends boolean = false>(options: Options<GetDocumentLocationV3Data, ThrowOnError>): RequestResult<GetDocumentLocationV3Responses, GetDocumentLocationV3Errors, ThrowOnError>;
|
|
598
|
+
/**
|
|
599
|
+
* Permanently deletes a document.
|
|
600
|
+
*/
|
|
601
|
+
permanentlyDeleteDocument<ThrowOnError extends boolean = false>(options: Options<PermanentlyDeleteDocumentData, ThrowOnError>): RequestResult<PermanentlyDeleteDocumentResponses, PermanentlyDeleteDocumentErrors, ThrowOnError>;
|
|
602
|
+
/**
|
|
603
|
+
* Fetches the document pdf processing result for a given document id
|
|
604
|
+
*/
|
|
605
|
+
getDocumentProcessingResult<ThrowOnError extends boolean = false>(options: Options<GetDocumentProcessingResultData, ThrowOnError>): RequestResult<GetDocumentProcessingResultResponses, GetDocumentProcessingResultErrors, ThrowOnError>;
|
|
606
|
+
/**
|
|
607
|
+
* Fetches the document processing result for a given document id and job id
|
|
608
|
+
*/
|
|
609
|
+
jobProcessingResultHandler<ThrowOnError extends boolean = false>(options: Options<JobProcessingResultHandlerData, ThrowOnError>): RequestResult<JobProcessingResultHandlerResponses, JobProcessingResultHandlerErrors, ThrowOnError>;
|
|
610
|
+
/**
|
|
611
|
+
* Deletes a specific document
|
|
612
|
+
*/
|
|
613
|
+
revertDeleteDocument<ThrowOnError extends boolean = false>(options: Options<RevertDeleteDocumentData, ThrowOnError>): RequestResult<RevertDeleteDocumentResponses, RevertDeleteDocumentErrors, ThrowOnError>;
|
|
614
|
+
/**
|
|
615
|
+
* Handler for `GET /documents/{document_id}/short_id`.
|
|
616
|
+
*
|
|
617
|
+
* Returns the short UUID for a document.
|
|
618
|
+
*/
|
|
619
|
+
getDocumentShortId<ThrowOnError extends boolean = false>(options: Options<GetDocumentShortIdData, ThrowOnError>): RequestResult<GetDocumentShortIdResponses, GetDocumentShortIdErrors, ThrowOnError>;
|
|
620
|
+
/**
|
|
621
|
+
* For any file that isn't PDF or DOCX, use this endpoint for saving.
|
|
622
|
+
* This endpoint will allow you to save the document by providing the file content as part of a multipart request. Use key 'file' along with the file bytes.
|
|
623
|
+
* simple_save is different than the save_document endpoint because it does not return a presigned URL, Instead, it simply saves the file to S3 directly (and returns the document metadata).
|
|
624
|
+
*/
|
|
625
|
+
simpleSave<ThrowOnError extends boolean = false>(options: Options<SimpleSaveData, ThrowOnError>): RequestResult<SimpleSaveResponses, SimpleSaveErrors, ThrowOnError>;
|
|
626
|
+
/**
|
|
627
|
+
* Gets the team-share state of a document. The team is resolved from the
|
|
628
|
+
* document owner's team membership; `teamId` is omitted when the owner does
|
|
629
|
+
* not belong to a team.
|
|
630
|
+
*/
|
|
631
|
+
getDocumentTeamShare<ThrowOnError extends boolean = false>(options: Options<GetDocumentTeamShareData, ThrowOnError>): RequestResult<GetDocumentTeamShareResponses, GetDocumentTeamShareErrors, ThrowOnError>;
|
|
632
|
+
/**
|
|
633
|
+
* Sets the team-share state of a document. Sharing grants the document
|
|
634
|
+
* owner's team Edit access; unsharing removes the team's access. Requires
|
|
635
|
+
* Edit access on the document.
|
|
636
|
+
*/
|
|
637
|
+
setDocumentTeamShare<ThrowOnError extends boolean = false>(options: Options<SetDocumentTeamShareData, ThrowOnError>): RequestResult<SetDocumentTeamShareResponses, SetDocumentTeamShareErrors, ThrowOnError>;
|
|
638
|
+
/**
|
|
639
|
+
* Gets the list of users who have viewed a given document
|
|
640
|
+
*/
|
|
641
|
+
getDocumentViewsHandler<ThrowOnError extends boolean = false>(options: Options<GetDocumentViewsHandlerData, ThrowOnError>): RequestResult<GetDocumentViewsHandlerResponses, GetDocumentViewsHandlerErrors, ThrowOnError>;
|
|
642
|
+
/**
|
|
643
|
+
* Gets a particular document by its id
|
|
644
|
+
*/
|
|
645
|
+
getDocumentVersion<ThrowOnError extends boolean = false>(options: Options<GetDocumentVersionData, ThrowOnError>): RequestResult<GetDocumentVersionResponses, GetDocumentVersionErrors, ThrowOnError>;
|
|
646
|
+
/**
|
|
647
|
+
* Get the current user's permission for a given entity.
|
|
648
|
+
*/
|
|
649
|
+
getEntityPermission<ThrowOnError extends boolean = false>(options: Options<GetEntityPermissionData, ThrowOnError>): RequestResult<GetEntityPermissionResponses, GetEntityPermissionErrors, ThrowOnError>;
|
|
650
|
+
/**
|
|
651
|
+
* List the caller's favorites.
|
|
652
|
+
*/
|
|
653
|
+
listFavorites<ThrowOnError extends boolean = false>(options?: Options<ListFavoritesData, ThrowOnError>): RequestResult<ListFavoritesResponses, ListFavoritesErrors, ThrowOnError>;
|
|
654
|
+
/**
|
|
655
|
+
* Favorite an entity in the caller's collection.
|
|
656
|
+
*/
|
|
657
|
+
addFavorite<ThrowOnError extends boolean = false>(options: Options<AddFavoriteData, ThrowOnError>): RequestResult<AddFavoriteResponses, AddFavoriteErrors, ThrowOnError>;
|
|
658
|
+
/**
|
|
659
|
+
* Persist a manual order for the caller's favorites.
|
|
660
|
+
*/
|
|
661
|
+
reorderFavorites<ThrowOnError extends boolean = false>(options: Options<ReorderFavoritesData, ThrowOnError>): RequestResult<ReorderFavoritesResponses, ReorderFavoritesErrors, ThrowOnError>;
|
|
662
|
+
/**
|
|
663
|
+
* Remove a favorite by entity.
|
|
664
|
+
*/
|
|
665
|
+
removeFavoriteByEntity<ThrowOnError extends boolean = false>(options: Options<RemoveFavoriteByEntityData, ThrowOnError>): RequestResult<RemoveFavoriteByEntityResponses, RemoveFavoriteByEntityErrors, ThrowOnError>;
|
|
666
|
+
/**
|
|
667
|
+
* Get a visible foreign entity by its internal ID.
|
|
668
|
+
*/
|
|
669
|
+
getForeignEntity<ThrowOnError extends boolean = false>(options: Options<GetForeignEntityData, ThrowOnError>): RequestResult<GetForeignEntityResponses, GetForeignEntityErrors, ThrowOnError>;
|
|
670
|
+
/**
|
|
671
|
+
* Redirects an authenticated user to the github sync app installation page.
|
|
672
|
+
*/
|
|
673
|
+
installSync<ThrowOnError extends boolean = false>(options?: Options<InstallSyncData, ThrowOnError>): RequestResult<unknown, InstallSyncErrors, ThrowOnError>;
|
|
674
|
+
/**
|
|
675
|
+
* Health check
|
|
676
|
+
*/
|
|
677
|
+
healthHandler<ThrowOnError extends boolean = false>(options?: Options<HealthHandlerData, ThrowOnError>): RequestResult<HealthHandlerResponses, unknown, ThrowOnError>;
|
|
678
|
+
/**
|
|
679
|
+
* Gets the users history
|
|
680
|
+
*/
|
|
681
|
+
getHistoryHandler<ThrowOnError extends boolean = false>(options?: Options<GetHistoryHandlerData, ThrowOnError>): RequestResult<GetHistoryHandlerResponses, GetHistoryHandlerErrors, ThrowOnError>;
|
|
682
|
+
/**
|
|
683
|
+
* Deletes an item from the user's history
|
|
684
|
+
*/
|
|
685
|
+
deleteHistoryHandler<ThrowOnError extends boolean = false>(options: Options<DeleteHistoryHandlerData, ThrowOnError>): RequestResult<DeleteHistoryHandlerResponses, DeleteHistoryHandlerErrors, ThrowOnError>;
|
|
686
|
+
/**
|
|
687
|
+
* Upserts an item into the user's history and performs other necessary tracking actions
|
|
688
|
+
*/
|
|
689
|
+
upsertHistoryHandler<ThrowOnError extends boolean = false>(options: Options<UpsertHistoryHandlerData, ThrowOnError>): RequestResult<UpsertHistoryHandlerResponses, UpsertHistoryHandlerErrors, ThrowOnError>;
|
|
690
|
+
/**
|
|
691
|
+
* Gets the instructions document for the current user
|
|
692
|
+
*/
|
|
693
|
+
getInstructionsHandler<ThrowOnError extends boolean = false>(options?: Options<GetInstructionsHandlerData, ThrowOnError>): RequestResult<GetInstructionsHandlerResponses, GetInstructionsHandlerErrors, ThrowOnError>;
|
|
694
|
+
/**
|
|
695
|
+
* Creates an instructions document for the current user
|
|
696
|
+
*/
|
|
697
|
+
createInstructionsHandler<ThrowOnError extends boolean = false>(options?: Options<CreateInstructionsHandlerData, ThrowOnError>): RequestResult<CreateInstructionsHandlerResponses, CreateInstructionsHandlerErrors, ThrowOnError>;
|
|
698
|
+
/**
|
|
699
|
+
* Gets the items the user has access to
|
|
700
|
+
*/
|
|
701
|
+
getItemsSoup<ThrowOnError extends boolean = false>(options?: Options<GetItemsSoupData, ThrowOnError>): RequestResult<GetItemsSoupResponses, GetItemsSoupErrors, ThrowOnError>;
|
|
702
|
+
/**
|
|
703
|
+
* Gets the items the user has access to
|
|
704
|
+
*/
|
|
705
|
+
postItemsSoup<ThrowOnError extends boolean = false>(options: Options<PostItemsSoupData, ThrowOnError>): RequestResult<PostItemsSoupResponses, PostItemsSoupErrors, ThrowOnError>;
|
|
706
|
+
/**
|
|
707
|
+
* Gets the items the user has access to using AST filters
|
|
708
|
+
*/
|
|
709
|
+
postItemsSoupAst<ThrowOnError extends boolean = false>(options: Options<PostItemsSoupAstData, ThrowOnError>): RequestResult<PostItemsSoupAstResponses, PostItemsSoupAstErrors, ThrowOnError>;
|
|
710
|
+
/**
|
|
711
|
+
* Gets the items grouped by the specified field using AST filters.
|
|
712
|
+
*/
|
|
713
|
+
postItemsSoupAstGrouped<ThrowOnError extends boolean = false>(options: Options<PostItemsSoupAstGroupedData, ThrowOnError>): RequestResult<PostItemsSoupAstGroupedResponses, PostItemsSoupAstGroupedErrors, ThrowOnError>;
|
|
714
|
+
/**
|
|
715
|
+
* Gets the users pinned items
|
|
716
|
+
*/
|
|
717
|
+
getPinsHandler<ThrowOnError extends boolean = false>(options?: Options<GetPinsHandlerData, ThrowOnError>): RequestResult<GetPinsHandlerResponses, GetPinsHandlerErrors, ThrowOnError>;
|
|
718
|
+
/**
|
|
719
|
+
* Saves the updated order of the pins for the user
|
|
720
|
+
*/
|
|
721
|
+
reorderPinsHandler<ThrowOnError extends boolean = false>(options: Options<ReorderPinsHandlerData, ThrowOnError>): RequestResult<ReorderPinsHandlerResponses, ReorderPinsHandlerErrors, ThrowOnError>;
|
|
722
|
+
/**
|
|
723
|
+
* Deletes the pin for the user
|
|
724
|
+
*/
|
|
725
|
+
removePinHandler<ThrowOnError extends boolean = false>(options: Options<RemovePinHandlerData, ThrowOnError>): RequestResult<RemovePinHandlerResponses, RemovePinHandlerErrors, ThrowOnError>;
|
|
726
|
+
/**
|
|
727
|
+
* Pins the item for the user
|
|
728
|
+
*/
|
|
729
|
+
addPinHandler<ThrowOnError extends boolean = false>(options: Options<AddPinHandlerData, ThrowOnError>): RequestResult<AddPinHandlerResponses, AddPinHandlerErrors, ThrowOnError>;
|
|
730
|
+
/**
|
|
731
|
+
* List projects visible to the authenticated user.
|
|
732
|
+
*/
|
|
733
|
+
getProjectsHandler<ThrowOnError extends boolean = false>(options?: Options<GetProjectsHandlerData, ThrowOnError>): RequestResult<GetProjectsHandlerResponses, GetProjectsHandlerErrors, ThrowOnError>;
|
|
734
|
+
/**
|
|
735
|
+
* Create a project, optionally beneath an existing project.
|
|
736
|
+
*/
|
|
737
|
+
createProjectHandler<ThrowOnError extends boolean = false>(options: Options<CreateProjectHandlerData, ThrowOnError>): RequestResult<CreateProjectHandlerResponses, CreateProjectHandlerErrors, ThrowOnError>;
|
|
738
|
+
/**
|
|
739
|
+
* List pending root projects owned by the authenticated user.
|
|
740
|
+
*/
|
|
741
|
+
getPendingProjectsHandler<ThrowOnError extends boolean = false>(options?: Options<GetPendingProjectsHandlerData, ThrowOnError>): RequestResult<GetPendingProjectsHandlerResponses, GetPendingProjectsHandlerErrors, ThrowOnError>;
|
|
742
|
+
/**
|
|
743
|
+
* Get previews for a batch of project IDs.
|
|
744
|
+
*/
|
|
745
|
+
getBatchProjectPreview<ThrowOnError extends boolean = false>(options: Options<GetBatchProjectPreviewData, ThrowOnError>): RequestResult<GetBatchProjectPreviewResponses, GetBatchProjectPreviewErrors, ThrowOnError>;
|
|
746
|
+
/**
|
|
747
|
+
* Upload a folder tree and create its upload destinations.
|
|
748
|
+
*/
|
|
749
|
+
uploadFolderHandler<ThrowOnError extends boolean = false>(options: Options<UploadFolderHandlerData, ThrowOnError>): RequestResult<UploadFolderHandlerResponses, UploadFolderHandlerErrors, ThrowOnError>;
|
|
750
|
+
/**
|
|
751
|
+
* Create a request for extracting an uploaded folder archive.
|
|
752
|
+
*/
|
|
753
|
+
uploadExtractFolderHandler<ThrowOnError extends boolean = false>(options: Options<UploadExtractFolderHandlerData, ThrowOnError>): RequestResult<UploadExtractFolderHandlerResponses, UploadExtractFolderHandlerErrors, ThrowOnError>;
|
|
754
|
+
/**
|
|
755
|
+
* Soft-delete a project and all of its children.
|
|
756
|
+
*/
|
|
757
|
+
deleteProjectHandler<ThrowOnError extends boolean = false>(options: Options<DeleteProjectHandlerData, ThrowOnError>): RequestResult<DeleteProjectHandlerResponses, DeleteProjectHandlerErrors, ThrowOnError>;
|
|
758
|
+
/**
|
|
759
|
+
* Get project metadata.
|
|
760
|
+
*/
|
|
761
|
+
getProjectHandler<ThrowOnError extends boolean = false>(options: Options<GetProjectHandlerData, ThrowOnError>): RequestResult<GetProjectHandlerResponses, GetProjectHandlerErrors, ThrowOnError>;
|
|
762
|
+
/**
|
|
763
|
+
* Get the caller's project access level.
|
|
764
|
+
*/
|
|
765
|
+
getProjectUserAccessLevel<ThrowOnError extends boolean = false>(options: Options<GetProjectUserAccessLevelData, ThrowOnError>): RequestResult<GetProjectUserAccessLevelResponses, GetProjectUserAccessLevelErrors, ThrowOnError>;
|
|
766
|
+
/**
|
|
767
|
+
* Get a project's immediate children.
|
|
768
|
+
*/
|
|
769
|
+
getProjectContentHandler<ThrowOnError extends boolean = false>(options: Options<GetProjectContentHandlerData, ThrowOnError>): RequestResult<GetProjectContentHandlerResponses, GetProjectContentHandlerErrors, ThrowOnError>;
|
|
770
|
+
/**
|
|
771
|
+
* Permanently delete a soft-deleted project and all of its children.
|
|
772
|
+
*/
|
|
773
|
+
permanentlyDeleteProject<ThrowOnError extends boolean = false>(options: Options<PermanentlyDeleteProjectData, ThrowOnError>): RequestResult<PermanentlyDeleteProjectResponses, PermanentlyDeleteProjectErrors, ThrowOnError>;
|
|
774
|
+
/**
|
|
775
|
+
* Get a project's share permissions.
|
|
776
|
+
*/
|
|
777
|
+
getProjectPermissionsV2<ThrowOnError extends boolean = false>(options: Options<GetProjectPermissionsV2Data, ThrowOnError>): RequestResult<GetProjectPermissionsV2Responses, GetProjectPermissionsV2Errors, ThrowOnError>;
|
|
778
|
+
/**
|
|
779
|
+
* Restore a soft-deleted project and its children.
|
|
780
|
+
*/
|
|
781
|
+
revertDeleteProject<ThrowOnError extends boolean = false>(options: Options<RevertDeleteProjectData, ThrowOnError>): RequestResult<RevertDeleteProjectResponses, RevertDeleteProjectErrors, ThrowOnError>;
|
|
782
|
+
/**
|
|
783
|
+
* Gets the users recently deleted items.
|
|
784
|
+
*/
|
|
785
|
+
recentlyDeleted<ThrowOnError extends boolean = false>(options?: Options<RecentlyDeletedData, ThrowOnError>): RequestResult<RecentlyDeletedResponses, RecentlyDeletedErrors, ThrowOnError>;
|
|
786
|
+
/**
|
|
787
|
+
* List the caller's reminders, soonest firing first.
|
|
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.
|
|
796
|
+
*/
|
|
797
|
+
deleteReminder<ThrowOnError extends boolean = false>(options: Options<DeleteReminderData, ThrowOnError>): RequestResult<DeleteReminderResponses, DeleteReminderErrors, ThrowOnError>;
|
|
798
|
+
/**
|
|
799
|
+
* Fetch one of the caller's reminders.
|
|
800
|
+
*/
|
|
801
|
+
getReminder<ThrowOnError extends boolean = false>(options: Options<GetReminderData, ThrowOnError>): RequestResult<GetReminderResponses, GetReminderErrors, ThrowOnError>;
|
|
802
|
+
/**
|
|
803
|
+
* Modify one of the caller's reminders.
|
|
804
|
+
*/
|
|
805
|
+
updateReminder<ThrowOnError extends boolean = false>(options: Options<UpdateReminderData, ThrowOnError>): RequestResult<UpdateReminderResponses, UpdateReminderErrors, ThrowOnError>;
|
|
806
|
+
getViewsHandler<ThrowOnError extends boolean = false>(options?: Options<GetViewsHandlerData, ThrowOnError>): RequestResult<GetViewsHandlerResponses, GetViewsHandlerErrors, ThrowOnError>;
|
|
807
|
+
createViewHandler<ThrowOnError extends boolean = false>(options: Options<CreateViewHandlerData, ThrowOnError>): RequestResult<CreateViewHandlerResponses, CreateViewHandlerErrors, ThrowOnError>;
|
|
808
|
+
excludeDefaultViewHandler<ThrowOnError extends boolean = false>(options: Options<ExcludeDefaultViewHandlerData, ThrowOnError>): RequestResult<ExcludeDefaultViewHandlerResponses, ExcludeDefaultViewHandlerErrors, ThrowOnError>;
|
|
809
|
+
deleteViewHandler<ThrowOnError extends boolean = false>(options: Options<DeleteViewHandlerData, ThrowOnError>): RequestResult<DeleteViewHandlerResponses, DeleteViewHandlerErrors, ThrowOnError>;
|
|
810
|
+
patchViewHandler<ThrowOnError extends boolean = false>(options: Options<PatchViewHandlerData, ThrowOnError>): RequestResult<PatchViewHandlerResponses, PatchViewHandlerErrors, ThrowOnError>;
|
|
811
|
+
bulkWakeupSyncServiceDocuments<ThrowOnError extends boolean = false>(options: Options<BulkWakeupSyncServiceDocumentsData, ThrowOnError>): RequestResult<BulkWakeupSyncServiceDocumentsResponses, BulkWakeupSyncServiceDocumentsErrors, ThrowOnError>;
|
|
812
|
+
/**
|
|
813
|
+
* Edits the share permissions of a thread.
|
|
814
|
+
*/
|
|
815
|
+
editThreadV2<ThrowOnError extends boolean = false>(options: Options<EditThreadV2Data, ThrowOnError>): RequestResult<EditThreadV2Responses, EditThreadV2Errors, ThrowOnError>;
|
|
816
|
+
/**
|
|
817
|
+
* Deletes a document location for the user
|
|
818
|
+
*/
|
|
819
|
+
deleteUserDocumentViewLocation<ThrowOnError extends boolean = false>(options: Options<DeleteUserDocumentViewLocationData, ThrowOnError>): RequestResult<DeleteUserDocumentViewLocationResponses, DeleteUserDocumentViewLocationErrors, ThrowOnError>;
|
|
820
|
+
/**
|
|
821
|
+
* Gets a UserPdfDocumentLocation entry
|
|
822
|
+
*/
|
|
823
|
+
getUserDocumentViewLocation<ThrowOnError extends boolean = false>(options: Options<GetUserDocumentViewLocationData, ThrowOnError>): RequestResult<GetUserDocumentViewLocationResponses, GetUserDocumentViewLocationErrors, ThrowOnError>;
|
|
824
|
+
upsertUserDocumentViewLocation<ThrowOnError extends boolean = false>(options: Options<UpsertUserDocumentViewLocationData, ThrowOnError>): RequestResult<UpsertUserDocumentViewLocationResponses, UpsertUserDocumentViewLocationErrors, ThrowOnError>;
|
|
825
|
+
/**
|
|
826
|
+
* Gets the current documents share permissions
|
|
827
|
+
*/
|
|
828
|
+
getDocumentPermissionsV2<ThrowOnError extends boolean = false>(options: Options<GetDocumentPermissionsV2Data, ThrowOnError>): RequestResult<GetDocumentPermissionsV2Responses, GetDocumentPermissionsV2Errors, ThrowOnError>;
|
|
829
|
+
/**
|
|
830
|
+
* Edit project metadata and sharing settings.
|
|
831
|
+
*/
|
|
832
|
+
editProjectV2<ThrowOnError extends boolean = false>(options: Options<EditProjectV2Data, ThrowOnError>): RequestResult<EditProjectV2Responses, EditProjectV2Errors, ThrowOnError>;
|
|
833
|
+
/**
|
|
834
|
+
* List the caller's webhooks.
|
|
835
|
+
*/
|
|
836
|
+
listWebhooks<ThrowOnError extends boolean = false>(options?: Options<ListWebhooksData, ThrowOnError>): RequestResult<ListWebhooksResponses, ListWebhooksErrors, ThrowOnError>;
|
|
837
|
+
/**
|
|
838
|
+
* Create a webhook.
|
|
839
|
+
*/
|
|
840
|
+
createWebhook<ThrowOnError extends boolean = false>(options: Options<CreateWebhookData, ThrowOnError>): RequestResult<CreateWebhookResponses, CreateWebhookErrors, ThrowOnError>;
|
|
841
|
+
/**
|
|
842
|
+
* Delete a webhook.
|
|
843
|
+
*/
|
|
844
|
+
deleteWebhook<ThrowOnError extends boolean = false>(options: Options<DeleteWebhookData, ThrowOnError>): RequestResult<DeleteWebhookResponses, DeleteWebhookErrors, ThrowOnError>;
|
|
845
|
+
/**
|
|
846
|
+
* Get a webhook.
|
|
847
|
+
*/
|
|
848
|
+
getWebhook<ThrowOnError extends boolean = false>(options: Options<GetWebhookData, ThrowOnError>): RequestResult<GetWebhookResponses, GetWebhookErrors, ThrowOnError>;
|
|
849
|
+
/**
|
|
850
|
+
* Patch a webhook.
|
|
851
|
+
*/
|
|
852
|
+
patchWebhook<ThrowOnError extends boolean = false>(options: Options<PatchWebhookData, ThrowOnError>): RequestResult<PatchWebhookResponses, PatchWebhookErrors, ThrowOnError>;
|
|
853
|
+
/**
|
|
854
|
+
* Validate a webhook endpoint.
|
|
855
|
+
*/
|
|
856
|
+
validateWebhook<ThrowOnError extends boolean = false>(options: Options<ValidateWebhookData, ThrowOnError>): RequestResult<ValidateWebhookResponses, ValidateWebhookErrors, ThrowOnError>;
|
|
857
|
+
}
|
|
858
|
+
export {};
|