@rox-one/sdk 0.0.0-stage → 0.7.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/CALLS.md +82 -0
- package/README.md +1259 -2
- package/dist/chunk-AOHK5YXC.js +5585 -0
- package/dist/chunk-CATFKTFD.js +80 -0
- package/dist/chunk-FQGPXWPJ.js +1491 -0
- package/dist/chunk-G43PLP2U.js +1087 -0
- package/dist/chunk-LMJW65ML.js +836 -0
- package/dist/chunk-MCSQNZ4E.js +836 -0
- package/dist/chunk-NSJ3GKUC.js +1552 -0
- package/dist/chunk-OGFKJOK7.js +2068 -0
- package/dist/chunk-RDEJZJBZ.js +1351 -0
- package/dist/chunk-TMTYN2UK.js +1128 -0
- package/dist/chunk-V45LUJDI.js +838 -0
- package/dist/chunk-YRUXFEZM.js +1044 -0
- package/dist/chunk-ZYBAKW25.js +994 -0
- package/dist/generated/agent-fold/index.d.ts +4520 -0
- package/dist/generated/agent-fold/index.js +0 -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 +375 -0
- package/dist/generated/agent-harness/types.gen.d.ts +4725 -0
- package/dist/generated/agent-reviews/index.d.ts +895 -0
- package/dist/generated/agent-reviews/index.js +0 -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 +674 -0
- package/dist/generated/auth/types.gen.d.ts +5233 -0
- package/dist/generated/calendar/client/client.gen.d.ts +2 -0
- package/dist/generated/calendar/client/index.d.ts +10 -0
- package/dist/generated/calendar/client/types.gen.d.ts +120 -0
- package/dist/generated/calendar/client/utils.gen.d.ts +37 -0
- package/dist/generated/calendar/client.gen.d.ts +12 -0
- package/dist/generated/calendar/core/auth.gen.d.ts +25 -0
- package/dist/generated/calendar/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/calendar/core/params.gen.d.ts +43 -0
- package/dist/generated/calendar/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/calendar/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/calendar/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/calendar/core/types.gen.d.ts +83 -0
- package/dist/generated/calendar/core/utils.gen.d.ts +19 -0
- package/dist/generated/calendar/index.d.ts +2 -0
- package/dist/generated/calendar/index.js +6 -0
- package/dist/generated/calendar/sdk.gen.d.ts +157 -0
- package/dist/generated/calendar/types.gen.d.ts +2333 -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 +348 -0
- package/dist/generated/cognition/types.gen.d.ts +4228 -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 +854 -0
- package/dist/generated/connection/sdk.gen.d.ts +43 -0
- package/dist/generated/connection/types.gen.d.ts +252 -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 +47 -0
- package/dist/generated/contacts/types.gen.d.ts +108 -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 +301 -0
- package/dist/generated/email/types.gen.d.ts +3262 -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 +127 -0
- package/dist/generated/notification/types.gen.d.ts +2084 -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 +1311 -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 +6 -0
- package/dist/generated/scheduled-action/sdk.gen.d.ts +156 -0
- package/dist/generated/scheduled-action/types.gen.d.ts +3099 -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 +2532 -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 +220 -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 +2285 -0
- package/dist/generated/storage/types.gen.d.ts +34546 -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 +6 -0
- package/dist/generated/unfurl/sdk.gen.d.ts +47 -0
- package/dist/generated/unfurl/types.gen.d.ts +145 -0
- package/dist/src/calls/browser.d.ts +14 -0
- package/dist/src/calls/browser.js +102 -0
- package/dist/src/calls/common.d.ts +18 -0
- package/dist/src/calls/node.d.ts +24 -0
- package/dist/src/calls/node.js +145 -0
- package/dist/src/calls/telemetry.d.ts +5 -0
- package/dist/src/config.d.ts +71 -0
- package/dist/src/entities/account-managers/grant.d.ts +62 -0
- package/dist/src/entities/account-managers/namespace.d.ts +29 -0
- package/dist/src/entities/activity/entity.d.ts +7 -0
- package/dist/src/entities/activity/namespace.d.ts +58 -0
- package/dist/src/entities/activity/namespace.test.d.ts +1 -0
- package/dist/src/entities/agent-sessions/activity.d.ts +48 -0
- package/dist/src/entities/agent-sessions/agent-session.d.ts +518 -0
- package/dist/src/entities/agent-sessions/code-execution.d.ts +60 -0
- package/dist/src/entities/agent-sessions/conversation.d.ts +91 -0
- package/dist/src/entities/agent-sessions/namespace.d.ts +142 -0
- package/dist/src/entities/agent-sessions/origin.d.ts +94 -0
- package/dist/src/entities/agent-sessions/queued-action.d.ts +60 -0
- package/dist/src/entities/agent-sessions/review.d.ts +114 -0
- package/dist/src/entities/agent-sessions/tool-approval.d.ts +25 -0
- package/dist/src/entities/agent-sessions/view.d.ts +11 -0
- package/dist/src/entities/agents/agent.d.ts +142 -0
- package/dist/src/entities/agents/namespace.d.ts +66 -0
- package/dist/src/entities/ai/namespace.d.ts +36 -0
- package/dist/src/entities/api-keys/api-key.d.ts +22 -0
- package/dist/src/entities/api-keys/namespace.d.ts +37 -0
- package/dist/src/entities/bots/bot.d.ts +143 -0
- package/dist/src/entities/bots/namespace.d.ts +50 -0
- package/dist/src/entities/bots/token.d.ts +39 -0
- package/dist/src/entities/calendar/booking-link.d.ts +55 -0
- package/dist/src/entities/calendar/booking-namespace.d.ts +143 -0
- package/dist/src/entities/calendar/booking-namespace.test.d.ts +1 -0
- package/dist/src/entities/calendar/booking.d.ts +97 -0
- package/dist/src/entities/calendar/calendar.d.ts +49 -0
- package/dist/src/entities/calendar/create-confirmed.test.d.ts +1 -0
- package/dist/src/entities/calendar/event.d.ts +283 -0
- package/dist/src/entities/calendar/event.test.d.ts +1 -0
- package/dist/src/entities/calendar/namespace.d.ts +334 -0
- package/dist/src/entities/calendar/namespace.test.d.ts +1 -0
- package/dist/src/entities/calendar/replacement.d.ts +31 -0
- package/dist/src/entities/calls/call-record.d.ts +231 -0
- package/dist/src/entities/calls/connection.d.ts +59 -0
- package/dist/src/entities/calls/errors.d.ts +15 -0
- package/dist/src/entities/calls/message.d.ts +55 -0
- package/dist/src/entities/calls/namespace.d.ts +41 -0
- package/dist/src/entities/calls/participant.d.ts +22 -0
- package/dist/src/entities/canvases/canvas.d.ts +329 -0
- package/dist/src/entities/channels/access-request.d.ts +42 -0
- package/dist/src/entities/channels/activity.d.ts +40 -0
- package/dist/src/entities/channels/channel.d.ts +302 -0
- package/dist/src/entities/channels/labels.d.ts +73 -0
- package/dist/src/entities/channels/message.d.ts +153 -0
- package/dist/src/entities/channels/message.test.d.ts +1 -0
- package/dist/src/entities/channels/namespace.d.ts +82 -0
- package/dist/src/entities/channels/namespace.test.d.ts +1 -0
- package/dist/src/entities/channels/picture.d.ts +11 -0
- package/dist/src/entities/channels/post.d.ts +37 -0
- package/dist/src/entities/channels/post.test.d.ts +1 -0
- package/dist/src/entities/channels/share.d.ts +9 -0
- package/dist/src/entities/channels/share.test.d.ts +1 -0
- package/dist/src/entities/channels/thread.d.ts +64 -0
- package/dist/src/entities/chats/chat.d.ts +121 -0
- package/dist/src/entities/chats/generation.d.ts +55 -0
- package/dist/src/entities/chats/namespace.d.ts +35 -0
- package/dist/src/entities/connected-apps/connected-app.d.ts +121 -0
- package/dist/src/entities/connected-apps/connector.d.ts +59 -0
- package/dist/src/entities/connected-apps/namespace.d.ts +92 -0
- package/dist/src/entities/crm/company.d.ts +154 -0
- package/dist/src/entities/crm/contact.d.ts +168 -0
- package/dist/src/entities/crm/namespace.d.ts +163 -0
- package/dist/src/entities/crm/pipeline-entry.d.ts +109 -0
- package/dist/src/entities/crm/pipeline.d.ts +426 -0
- package/dist/src/entities/crm/pipelines.d.ts +79 -0
- package/dist/src/entities/crm-email-privacy/email-privacy.d.ts +238 -0
- package/dist/src/entities/crm-email-privacy/email-rule-preview.d.ts +55 -0
- package/dist/src/entities/crm-email-privacy/email-rule-revision.d.ts +27 -0
- package/dist/src/entities/crm-email-privacy/email-rules.d.ts +32 -0
- package/dist/src/entities/databases/column.d.ts +122 -0
- package/dist/src/entities/databases/database.d.ts +431 -0
- package/dist/src/entities/databases/namespace.d.ts +109 -0
- package/dist/src/entities/databases/query.d.ts +86 -0
- package/dist/src/entities/databases/row.d.ts +29 -0
- package/dist/src/entities/databases/saved-query.d.ts +151 -0
- package/dist/src/entities/databases/table.d.ts +124 -0
- package/dist/src/entities/databases/view.d.ts +72 -0
- package/dist/src/entities/databases/webhook.d.ts +39 -0
- package/dist/src/entities/documents/ai-edit.d.ts +54 -0
- package/dist/src/entities/documents/anchor.d.ts +39 -0
- package/dist/src/entities/documents/comment.d.ts +68 -0
- package/dist/src/entities/documents/create.test.d.ts +1 -0
- package/dist/src/entities/documents/document.d.ts +675 -0
- package/dist/src/entities/documents/markdown.d.ts +25 -0
- package/dist/src/entities/documents/namespace.d.ts +291 -0
- package/dist/src/entities/documents/office-files.d.ts +47 -0
- package/dist/src/entities/documents/skills.test.d.ts +1 -0
- package/dist/src/entities/documents/system-skill.d.ts +36 -0
- package/dist/src/entities/documents/text-comment.d.ts +41 -0
- package/dist/src/entities/documents/text-comment.test.d.ts +1 -0
- package/dist/src/entities/documents/version.d.ts +26 -0
- package/dist/src/entities/email/attachment.d.ts +39 -0
- package/dist/src/entities/email/body-rox-compat.d.ts +22 -0
- package/dist/src/entities/email/draft.d.ts +164 -0
- package/dist/src/entities/email/filter.d.ts +44 -0
- package/dist/src/entities/email/label.d.ts +37 -0
- package/dist/src/entities/email/link.d.ts +35 -0
- package/dist/src/entities/email/message.d.ts +223 -0
- package/dist/src/entities/email/namespace.d.ts +235 -0
- package/dist/src/entities/email/namespace.test.d.ts +1 -0
- package/dist/src/entities/email/thread.d.ts +268 -0
- package/dist/src/entities/entity-mentions/mention.d.ts +21 -0
- package/dist/src/entities/entity-mentions/namespace.d.ts +20 -0
- package/dist/src/entities/entity.d.ts +167 -0
- package/dist/src/entities/external-chat/chat.d.ts +173 -0
- package/dist/src/entities/external-chat/message.d.ts +54 -0
- package/dist/src/entities/external-chat/namespace.d.ts +22 -0
- package/dist/src/entities/external-chat/participant.d.ts +28 -0
- package/dist/src/entities/external-chat/send.d.ts +40 -0
- package/dist/src/entities/external-chat/upload.d.ts +25 -0
- package/dist/src/entities/favorites/namespace.d.ts +52 -0
- package/dist/src/entities/foreign/foreign-entity.d.ts +36 -0
- package/dist/src/entities/foreign/namespace.d.ts +54 -0
- package/dist/src/entities/forms/form.d.ts +319 -0
- package/dist/src/entities/forms/namespace.d.ts +30 -0
- package/dist/src/entities/forms/question.d.ts +65 -0
- package/dist/src/entities/forms/response.d.ts +52 -0
- package/dist/src/entities/forms/section.d.ts +31 -0
- package/dist/src/entities/github-pull-requests/namespace.d.ts +20 -0
- package/dist/src/entities/github-pull-requests/pull-request.d.ts +64 -0
- package/dist/src/entities/harnesses/harness.d.ts +76 -0
- package/dist/src/entities/harnesses/namespace.d.ts +83 -0
- package/dist/src/entities/harnesses/pairing.d.ts +50 -0
- package/dist/src/entities/images/image.d.ts +88 -0
- package/dist/src/entities/images/namespace.d.ts +55 -0
- package/dist/src/entities/images/namespace.test.d.ts +1 -0
- package/dist/src/entities/imports/entry.d.ts +65 -0
- package/dist/src/entities/imports/namespace.d.ts +103 -0
- package/dist/src/entities/imports/namespace.test.d.ts +1 -0
- package/dist/src/entities/initiatives/initiative.d.ts +185 -0
- package/dist/src/entities/initiatives/initiative.test.d.ts +1 -0
- package/dist/src/entities/initiatives/namespace.d.ts +90 -0
- package/dist/src/entities/me/namespace.d.ts +68 -0
- package/dist/src/entities/meetings/meeting.d.ts +81 -0
- package/dist/src/entities/meetings/namespace.d.ts +38 -0
- package/dist/src/entities/memory/namespace.d.ts +49 -0
- package/dist/src/entities/memory/namespace.test.d.ts +1 -0
- package/dist/src/entities/messages/discussion.d.ts +84 -0
- package/dist/src/entities/messages/thread.d.ts +115 -0
- package/dist/src/entities/notifications/namespace.d.ts +66 -0
- package/dist/src/entities/notifications/notification.d.ts +78 -0
- package/dist/src/entities/notifications/notification.test.d.ts +1 -0
- package/dist/src/entities/passwords/item.d.ts +118 -0
- package/dist/src/entities/passwords/namespace.d.ts +45 -0
- package/dist/src/entities/pins/namespace.d.ts +42 -0
- package/dist/src/entities/projects/namespace.d.ts +45 -0
- package/dist/src/entities/projects/project.d.ts +108 -0
- package/dist/src/entities/properties/namespace.d.ts +105 -0
- package/dist/src/entities/properties/namespace.test.d.ts +1 -0
- package/dist/src/entities/properties/property-definition.d.ts +70 -0
- package/dist/src/entities/properties/property-option.d.ts +44 -0
- package/dist/src/entities/reference.d.ts +82 -0
- package/dist/src/entities/referrals/namespace.d.ts +40 -0
- package/dist/src/entities/routines/namespace.d.ts +239 -0
- package/dist/src/entities/routines/routine.d.ts +341 -0
- package/dist/src/entities/routines/suggestion.d.ts +38 -0
- package/dist/src/entities/saved-views/namespace.d.ts +58 -0
- package/dist/src/entities/saved-views/saved-view.d.ts +78 -0
- package/dist/src/entities/search/exclusions.d.ts +6 -0
- package/dist/src/entities/search/namespace.d.ts +71 -0
- package/dist/src/entities/search/options.d.ts +30 -0
- package/dist/src/entities/search/types.d.ts +90 -0
- package/dist/src/entities/sharing/access.d.ts +120 -0
- package/dist/src/entities/sharing/permissions.d.ts +13 -0
- package/dist/src/entities/spreadsheets/spreadsheet.d.ts +201 -0
- package/dist/src/entities/suggestions/namespace.d.ts +118 -0
- package/dist/src/entities/suggestions/suggestion.d.ts +172 -0
- package/dist/src/entities/suggestions/suggestion.test.d.ts +1 -0
- package/dist/src/entities/tasks/namespace.d.ts +77 -0
- package/dist/src/entities/tasks/task.d.ts +99 -0
- package/dist/src/entities/teams/invite.d.ts +33 -0
- package/dist/src/entities/teams/namespace.d.ts +23 -0
- package/dist/src/entities/teams/team.d.ts +129 -0
- package/dist/src/entities/ui/app-link.d.ts +24 -0
- package/dist/src/entities/ui/namespace.d.ts +75 -0
- package/dist/src/entities/unfurls/namespace.d.ts +24 -0
- package/dist/src/entities/users/namespace.d.ts +41 -0
- package/dist/src/entities/users/profile-picture.d.ts +29 -0
- package/dist/src/entities/users/profile-picture.test.d.ts +1 -0
- package/dist/src/entities/users/user.d.ts +102 -0
- package/dist/src/entities/web/namespace.d.ts +67 -0
- package/dist/src/entities/web/namespace.test.d.ts +1 -0
- package/dist/src/entities/webhooks/namespace.d.ts +38 -0
- package/dist/src/entities/webhooks/webhook.d.ts +130 -0
- package/dist/src/entities/whatsapp/account.d.ts +24 -0
- package/dist/src/entities/whatsapp/chat.d.ts +62 -0
- package/dist/src/entities/whatsapp/namespace.d.ts +29 -0
- package/dist/src/entities/workspace/items.d.ts +14 -0
- package/dist/src/entities/workspace/namespace.d.ts +96 -0
- package/dist/src/entities/workspace/query.d.ts +39 -0
- package/dist/src/entities/workspace/query.test.d.ts +1 -0
- package/dist/src/entities/workspace/types.d.ts +99 -0
- package/dist/src/events/hydrate/agentSession.d.ts +192 -0
- package/dist/src/events/hydrate/call.d.ts +101 -0
- package/dist/src/events/hydrate/channel.d.ts +55 -0
- package/dist/src/events/hydrate/document.d.ts +59 -0
- package/dist/src/events/hydrate/message.d.ts +70 -0
- package/dist/src/events/hydrate/user.d.ts +14 -0
- package/dist/src/events/receiver.d.ts +91 -0
- package/dist/src/events/types.d.ts +44 -0
- package/dist/src/events/verify.d.ts +13 -0
- package/dist/src/local-portmap.d.ts +8 -0
- package/dist/src/mentions.d.ts +42 -0
- package/dist/src/raw.d.ts +12 -0
- package/dist/src/rox.d.ts +268 -0
- package/dist/src/rox.js +23231 -0
- package/dist/src/utils/activity.d.ts +34 -0
- package/dist/src/utils/activity.test.d.ts +1 -0
- package/dist/src/utils/client.d.ts +62 -0
- package/dist/src/utils/concurrency.d.ts +5 -0
- package/dist/src/utils/index.d.ts +5 -0
- package/dist/src/utils/lazy.d.ts +37 -0
- package/dist/src/utils/options.d.ts +7 -0
- package/dist/src/utils/pagination.d.ts +28 -0
- package/dist/src/utils/unwrap.d.ts +48 -0
- package/dist/src/utils/verbs.d.ts +3 -0
- package/package.json +82 -4
|
@@ -0,0 +1,2285 @@
|
|
|
1
|
+
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type ServerSentEventsResult, type TDataShape } from './client';
|
|
2
|
+
import type { AccessRequestsCancelData, AccessRequestsCancelErrors, AccessRequestsCancelResponses, AccessRequestsDirectData, AccessRequestsDirectErrors, AccessRequestsDirectResponses, AccessRequestsRemoveDirectData, AccessRequestsRemoveDirectErrors, AccessRequestsRemoveDirectResponses, AccessRequestsResolveData, AccessRequestsResolveErrors, AccessRequestsResolveResponses, AccessRequestsSetDirectData, AccessRequestsSetDirectErrors, AccessRequestsSetDirectResponses, AccessRequestsStateData, AccessRequestsStateErrors, AccessRequestsStateResponses, AccessRequestsSubmitData, AccessRequestsSubmitErrors, AccessRequestsSubmitResponses, AddChannelBotData, AddChannelBotErrors, AddChannelBotResponses, AddCrmContactEmailData, AddCrmContactEmailErrors, AddCrmContactEmailResponses, AddCrmPipelineEntriesData, AddCrmPipelineEntriesErrors, AddCrmPipelineEntriesResponses, AddFavoriteData, AddFavoriteErrors, AddFavoriteResponses, AddParticipantsData, AddParticipantsErrors, AddParticipantsResponses, AddPinHandlerData, AddPinHandlerErrors, AddPinHandlerResponses, ApplyCanvasEditsData, ApplyCanvasEditsErrors, ApplyCanvasEditsResponses, ApplyCrmPipelineOpsData, ApplyCrmPipelineOpsResponses, ApplyDatabaseOpsData, ApplyDatabaseOpsErrors, ApplyDatabaseOpsResponses, ApproveHarnessPairingData, ApproveHarnessPairingErrors, ApproveHarnessPairingResponses, BlockCrmDomainData, BlockCrmDomainErrors, BlockCrmDomainResponses, BulkWakeupSyncServiceDocumentsData, BulkWakeupSyncServiceDocumentsErrors, BulkWakeupSyncServiceDocumentsResponses, CalculateSpreadsheetData, CalculateSpreadsheetErrors, CalculateSpreadsheetResponses, CallWebhookData, CallWebhookErrors, CallWebhookResponses, CancelChannelAccessRequestData, CancelChannelAccessRequestErrors, CancelChannelAccessRequestResponses, CancelCrmEmailRulePreviewData, CancelCrmEmailRulePreviewResponses, CancelSlackImportData, CancelSlackImportErrors, CancelSlackImportResponses, CheckActiveCallData, CheckActiveCallErrors, CheckActiveCallResponses, ClaimAccountManagerTokenData, ClaimAccountManagerTokenErrors, ClaimAccountManagerTokenResponses, ClaimHarnessPairingData, ClaimHarnessPairingErrors, ClaimHarnessPairingResponses, CollaborateFormData, CollaborateFormErrors, CollaborateFormResponses, CommentOnDocumentTextData, CommentOnDocumentTextErrors, CommentOnDocumentTextResponses, CompleteSlackImportUploadsData, CompleteSlackImportUploadsErrors, CompleteSlackImportUploadsResponses, ConvertDatabaseColumnData, ConvertDatabaseColumnErrors, ConvertDatabaseColumnResponses, CopyDocumentData, CopyDocumentErrors, CopyDocumentResponses, CopyPresentationData, CopyPresentationErrors, CopyPresentationResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateAnchorData, CreateAnchorErrors, CreateAnchorResponses, CreateBotData, CreateBotErrors, CreateBotResponses, CreateBotTokenData, CreateBotTokenErrors, CreateBotTokenResponses, CreateCanvasHandlerData, CreateCanvasHandlerErrors, CreateCanvasHandlerResponses, CreateChannelData, CreateChannelErrors, CreateChannelLabelData, CreateChannelLabelErrors, CreateChannelLabelResponses, CreateChannelResponses, CreateChannelScopedBotData, CreateChannelScopedBotErrors, CreateChannelScopedBotResponses, CreateChannelSectionData, CreateChannelSectionErrors, CreateChannelSectionResponses, CreateCollabSurfaceTokenData, CreateCollabSurfaceTokenErrors, CreateCollabSurfaceTokenResponses, CreateCrmCompanyData, CreateCrmCompanyErrors, CreateCrmCompanyResponses, CreateCrmContactData, CreateCrmContactErrors, CreateCrmContactResponses, CreateCrmPipelineData, CreateCrmPipelineResponses, CreateCrmPipelineWithFieldsData, CreateCrmPipelineWithFieldsErrors, CreateCrmPipelineWithFieldsResponses, CreateCrmTeamContactData, CreateCrmTeamContactErrors, CreateCrmTeamContactResponses, CreateDatabaseData, CreateDatabaseErrors, CreateDatabaseResponses, CreateDatabaseWebhookData, CreateDatabaseWebhookErrors, CreateDatabaseWebhookResponses, CreateDocumentData, CreateDocumentErrors, CreateDocumentResponses, CreateEntityMentionData, CreateEntityMentionErrors, CreateEntityMentionResponses, CreateFormData, CreateFormErrors, CreateFormResponses, CreateHarnessPairingData, CreateHarnessPairingErrors, CreateHarnessPairingResponses, CreateInitiativeData, CreateInitiativeErrors, CreateInitiativeResponses, CreateInstructionsHandlerData, CreateInstructionsHandlerErrors, CreateInstructionsHandlerResponses, CreateMarkdownHandlerData, CreateMarkdownHandlerErrors, CreateMarkdownHandlerResponses, CreateProjectHandlerData, CreateProjectHandlerErrors, CreateProjectHandlerResponses, CreateSavedViewDefinitionData, CreateSavedViewDefinitionErrors, CreateSavedViewDefinitionResponses, CreateSkillHandlerData, CreateSkillHandlerErrors, CreateSkillHandlerResponses, CreateSlackImportData, CreateSlackImportErrors, CreateSlackImportResponses, CreateSnippetHandlerData, CreateSnippetHandlerErrors, CreateSnippetHandlerResponses, CreateSpreadsheetData, CreateSpreadsheetErrors, CreateSpreadsheetResponses, CreateTaskHandlerData, CreateTaskHandlerErrors, CreateTaskHandlerResponses, CreateUserApiKeyData, CreateUserApiKeyErrors, CreateUserApiKeyResponses, CreateViewHandlerData, CreateViewHandlerErrors, CreateViewHandlerResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, DeclineCallData, DeclineCallErrors, DeclineCallResponses, DeclineRingData, DeclineRingErrors, DeclineRingResponses, DeleteAnchorData, DeleteAnchorErrors, DeleteAnchorResponses, DeleteBotData, DeleteBotErrors, DeleteBotResponses, DeleteCallRecordData, DeleteCallRecordErrors, DeleteCallRecordResponses, DeleteChannelData, DeleteChannelErrors, DeleteChannelLabelData, DeleteChannelLabelErrors, DeleteChannelLabelResponses, DeleteChannelResponses, DeleteChannelSectionData, DeleteChannelSectionErrors, DeleteChannelSectionResponses, DeleteCollabSurfaceData, DeleteCollabSurfaceErrors, DeleteCollabSurfaceResponses, DeleteDatabaseWebhookData, DeleteDatabaseWebhookErrors, DeleteDatabaseWebhookResponses, DeleteDocumentData, DeleteDocumentErrors, DeleteDocumentResponses, DeleteEntityMentionData, DeleteEntityMentionErrors, DeleteEntityMentionResponses, DeleteHarnessData, DeleteHarnessErrors, DeleteHarnessResponses, DeleteHistoryHandlerData, DeleteHistoryHandlerErrors, DeleteHistoryHandlerResponses, DeleteInitiativeData, DeleteInitiativeErrors, DeleteInitiativeResponses, DeleteProjectHandlerData, DeleteProjectHandlerErrors, DeleteProjectHandlerResponses, DeleteSavedViewDefinitionData, DeleteSavedViewDefinitionErrors, DeleteSavedViewDefinitionResponses, DeleteSelfHarnessData, DeleteSelfHarnessErrors, DeleteSelfHarnessResponses, DeleteUserApiKeyData, DeleteUserApiKeyErrors, DeleteUserApiKeyResponses, DeleteUserDocumentViewLocationData, DeleteUserDocumentViewLocationErrors, DeleteUserDocumentViewLocationResponses, DeleteViewHandlerData, DeleteViewHandlerErrors, DeleteViewHandlerResponses, DeleteWebhookData, DeleteWebhookErrors, DeleteWebhookResponses, DeliverDatabaseWebhookData, DeliverDatabaseWebhookErrors, DeliverDatabaseWebhookResponses, DuplicateDatabaseData, DuplicateDatabaseErrors, DuplicateDatabaseResponses, EditAnchorData, EditAnchorErrors, EditAnchorResponses, EditCallRecordData, EditCallRecordErrors, EditCallRecordResponses, EditCallTranscriptData, EditCallTranscriptErrors, EditCallTranscriptResponses, EditCanvasWithAiData, EditCanvasWithAiErrors, EditCanvasWithAiResponses, EditCrmPipelineData, EditCrmPipelineErrors, EditCrmPipelineResponses, EditDocumentData, EditDocumentErrors, EditDocumentResponses, EditDocumentWithAiData, EditDocumentWithAiErrors, EditDocumentWithAiResponses, EditMyFormResponseData, EditMyFormResponseErrors, EditMyFormResponseResponses, EditPresentationData, EditPresentationErrors, EditPresentationResponses, EditProjectV2Data, EditProjectV2Errors, EditProjectV2Responses, EditSpreadsheetData, EditSpreadsheetErrors, EditSpreadsheetResponses, EditSpreadsheetWithAiData, EditSpreadsheetWithAiErrors, EditSpreadsheetWithAiResponses, EditThreadV2Data, EditThreadV2Errors, EditThreadV2Responses, EditWordDocumentData, EditWordDocumentErrors, EditWordDocumentResponses, EnsureCollabSurfaceData, EnsureCollabSurfaceErrors, EnsureCollabSurfaceResponses, EnsureStarterHandlerData, EnsureStarterHandlerErrors, EnsureStarterHandlerResponses, EntityMessageCreateData, EntityMessageCreateResponses, EntityMessageDeleteMessageData, EntityMessageDeleteMessageResponses, EntityMessageDeleteThreadData, EntityMessageDeleteThreadResponses, EntityMessageEditData, EntityMessageEditResponses, EntityMessageGetMessageData, EntityMessageGetMessageResponses, EntityMessageGetThreadData, EntityMessageGetThreadResponses, EntityMessageLegacyData, EntityMessageLegacyResponses, EntityMessagePatchThreadData, EntityMessagePatchThreadResponses, EntityMessageReactData, EntityMessageReactResponses, EntityMessageTypingData, EntityMessageTypingResponses, EventIcsData, EventIcsErrors, EventIcsResponses, ExcludeDefaultViewHandlerData, ExcludeDefaultViewHandlerErrors, ExcludeDefaultViewHandlerResponses, ExportCrmPipelineCsvData, ExportCrmPipelineCsvErrors, ExportCrmPipelineCsvResponses, ExportDocumentData, ExportDocumentErrors, ExportDocumentResponses, ExternalChatAddData, ExternalChatAddResponses, ExternalChatData, ExternalChatDeliveryData, ExternalChatDeliveryResponses, ExternalChatMessageAttachmentsData, ExternalChatMessageAttachmentsResponses, ExternalChatMessageData, ExternalChatMessageResponses, ExternalChatMessagesData, ExternalChatMessagesResponses, ExternalChatPermissionsData, ExternalChatPermissionsResponses, ExternalChatReadData, ExternalChatReadResponses, ExternalChatRemoveData, ExternalChatRemoveResponses, ExternalChatResponses, ExternalChatsData, ExternalChatSendData, ExternalChatSendErrors, ExternalChatSendResponses, ExternalChatSendsData, ExternalChatSendsResponses, ExternalChatsResponses, ExternalChatUpdatePermissionsData, ExternalChatUpdatePermissionsResponses, ExternalChatUploadData, ExternalChatUploadResponses, FinalizeSlackImportData, FinalizeSlackImportErrors, FinalizeSlackImportResponses, FindCrmPipelineEntriesData, FindCrmPipelineEntriesErrors, FindCrmPipelineEntriesResponses, GetAccountManagerGrantData, GetAccountManagerGrantErrors, GetAccountManagerGrantResponses, GetActiveCallsData, GetActiveCallsErrors, GetActiveCallsResponses, GetActivityData, GetActivityErrors, GetActivityResponses, GetAttachmentReferencesData, GetAttachmentReferencesErrors, GetAttachmentReferencesResponses, GetBatchCallRecordPreviewData, GetBatchCallRecordPreviewErrors, GetBatchCallRecordPreviewResponses, GetBatchChannelPreviewData, GetBatchChannelPreviewErrors, GetBatchChannelPreviewResponses, GetBatchPreviewHandlerData, GetBatchPreviewHandlerErrors, GetBatchPreviewHandlerResponses, GetBatchProjectPreviewData, GetBatchProjectPreviewErrors, GetBatchProjectPreviewResponses, GetBotData, GetBotErrors, GetBotOwnerProfilesData, GetBotOwnerProfilesErrors, GetBotOwnerProfilesResponses, GetBotResponses, GetCallParticipantsData, GetCallParticipantsErrors, GetCallParticipantsResponses, GetCallRecordData, GetCallRecordErrors, GetCallRecordingData, GetCallRecordingErrors, GetCallRecordingResponses, GetCallRecordResponses, GetCallRingStateData, GetCallRingStateResponses, GetChannelAccessRequestData, GetChannelAccessRequestErrors, GetChannelAccessRequestResponses, GetChannelAttachmentsData, GetChannelAttachmentsErrors, GetChannelAttachmentsResponses, GetChannelData, GetChannelErrors, GetChannelJoinLinkData, GetChannelJoinLinkErrors, GetChannelJoinLinkResponses, GetChannelParticipantsData, GetChannelParticipantsErrors, GetChannelParticipantsResponses, GetChannelResponses, GetChannelsData, GetChannelsErrors, GetChannelsResponses, GetCollabSurfaceData, GetCollabSurfaceErrors, GetCollabSurfaceResponses, GetCompanyData, GetCompanyErrors, GetCompanyResponses, GetContactByEmailData, GetContactByEmailErrors, GetContactByEmailResponses, GetContactData, GetContactErrors, GetContactResponses, GetCrmEmailPolicyData, GetCrmEmailPolicyResponses, GetCrmEmailPrivacyData, GetCrmEmailPrivacyResponses, GetCrmEmailRulePreviewData, GetCrmEmailRulePreviewResponses, GetCrmEmailRuleRevisionData, GetCrmEmailRuleRevisionResponses, GetCrmMemberAccessData, GetCrmMemberAccessResponses, GetCrmPipelineCsvData, GetCrmPipelineCsvErrors, GetCrmPipelineCsvResponses, GetCrmPipelineData, GetCrmPipelinePermissionsData, GetCrmPipelinePermissionsResponses, GetCrmPipelineResponses, GetCrmPipelineRowsData, GetCrmPipelineRowsResponses, GetCrmPipelineStageRequirementsData, GetCrmPipelineStageRequirementsResponses, GetCrmPipelineTableData, GetCrmPipelineTableResponses, GetCrmPipelineViewPositionsData, GetCrmPipelineViewPositionsResponses, GetCrmTeamSettingsData, GetCrmTeamSettingsErrors, GetCrmTeamSettingsResponses, GetDatabaseData, GetDatabaseErrors, GetDatabasePermissionsData, GetDatabasePermissionsErrors, GetDatabasePermissionsResponses, GetDatabaseQueryData, GetDatabaseQueryErrors, GetDatabaseQueryResponses, GetDatabaseResponses, GetDatabaseRowHistoryData, GetDatabaseRowHistoryErrors, GetDatabaseRowHistoryResponses, GetDatabaseTableChangesData, GetDatabaseTableChangesErrors, GetDatabaseTableChangesResponses, GetDatabaseViewPositionsData, GetDatabaseViewPositionsErrors, GetDatabaseViewPositionsResponses, GetDocumentAnchorsData, GetDocumentAnchorsErrors, GetDocumentAnchorsResponses, GetDocumentBranchNameData, GetDocumentBranchNameErrors, GetDocumentBranchNameResponses, GetDocumentByTeamSlugData, GetDocumentByTeamSlugErrors, GetDocumentByTeamSlugResponses, GetDocumentData, GetDocumentErrors, GetDocumentGithubPullRequestsData, GetDocumentGithubPullRequestsErrors, GetDocumentGithubPullRequestsResponses, GetDocumentListHandlerData, GetDocumentListHandlerErrors, GetDocumentListHandlerResponses, GetDocumentLocationV3Data, GetDocumentLocationV3Errors, GetDocumentLocationV3Responses, GetDocumentMarkdownData, GetDocumentMarkdownErrors, GetDocumentMarkdownResponses, GetDocumentPermissionsTokenData, GetDocumentPermissionsTokenErrors, GetDocumentPermissionsTokenResponses, GetDocumentPermissionsV2Data, GetDocumentPermissionsV2Errors, GetDocumentPermissionsV2Responses, GetDocumentProcessingResultData, GetDocumentProcessingResultErrors, GetDocumentProcessingResultResponses, GetDocumentResponses, GetDocumentShortIdData, GetDocumentShortIdErrors, GetDocumentShortIdResponses, GetDocumentTeamShareData, GetDocumentTeamShareErrors, GetDocumentTeamShareResponses, GetDocumentTextContentData, GetDocumentTextContentErrors, GetDocumentTextContentResponses, GetDocumentVersionData, GetDocumentVersionErrors, GetDocumentVersionResponses, GetDocumentViewsHandlerData, GetDocumentViewsHandlerErrors, GetDocumentViewsHandlerResponses, GetEmailFollowupData, GetEmailFollowupErrors, GetEmailFollowupResponses, GetEntityPermissionData, GetEntityPermissionErrors, GetEntityPermissionResponses, GetForeignEntityBySourceData, GetForeignEntityBySourceErrors, GetForeignEntityBySourceResponses, GetForeignEntityData, GetForeignEntityErrors, GetForeignEntityResponses, GetFormData, GetFormErrors, GetFormPermissionsData, GetFormPermissionsErrors, GetFormPermissionsResponses, GetFormResponses, GetFormResponseSummaryData, GetFormResponseSummaryErrors, GetFormResponseSummaryResponses, GetFormTallyData, GetFormTallyErrors, GetFormTallyResponses, GetGithubPullRequestChangesData, GetGithubPullRequestChangesErrors, GetGithubPullRequestChangesPatchData, GetGithubPullRequestChangesPatchErrors, GetGithubPullRequestChangesPatchResponses, GetGithubPullRequestChangesResponses, GetGithubPullRequestData, GetGithubPullRequestErrors, GetGithubPullRequestFacetsData, GetGithubPullRequestFacetsErrors, GetGithubPullRequestFacetsResponses, GetGithubPullRequestResponses, GetGithubPullRequestTasksData, GetGithubPullRequestTasksErrors, GetGithubPullRequestTasksResponses, GetHarnessPairingData, GetHarnessPairingErrors, GetHarnessPairingResponses, GetHistoryHandlerData, GetHistoryHandlerErrors, GetHistoryHandlerResponses, GetInitiativeActivityData, GetInitiativeActivityErrors, GetInitiativeActivityResponses, GetInitiativeData, GetInitiativeDescriptionData, GetInitiativeDescriptionErrors, GetInitiativeDescriptionResponses, GetInitiativeErrors, GetInitiativeResponses, GetInstructionsHandlerData, GetInstructionsHandlerErrors, GetInstructionsHandlerResponses, GetItemsSoupData, GetItemsSoupErrors, GetItemsSoupResponses, GetLiveCallsData, GetLiveCallsResponses, GetLocationHandlerData, GetLocationHandlerErrors, GetLocationHandlerResponses, GetMyChannelAccessRequestData, GetMyChannelAccessRequestErrors, GetMyChannelAccessRequestResponses, GetMyFormResponseData, GetMyFormResponseErrors, GetMyFormResponseResponses, GetOrCreateCallData, GetOrCreateCallErrors, GetOrCreateCallResponses, GetOrCreateDmData, GetOrCreateDmErrors, GetOrCreateDmResponses, GetOrCreatePrivateData, GetOrCreatePrivateErrors, GetOrCreatePrivateResponses, GetPendingProjectsHandlerData, GetPendingProjectsHandlerErrors, GetPendingProjectsHandlerResponses, GetPinsHandlerData, GetPinsHandlerErrors, GetPinsHandlerResponses, GetProjectContentHandlerData, GetProjectContentHandlerErrors, GetProjectContentHandlerResponses, GetProjectHandlerData, GetProjectHandlerErrors, GetProjectHandlerResponses, GetProjectPermissionsV2Data, GetProjectPermissionsV2Errors, GetProjectPermissionsV2Responses, GetProjectsHandlerData, GetProjectsHandlerErrors, GetProjectsHandlerResponses, GetProjectUserAccessLevelData, GetProjectUserAccessLevelErrors, GetProjectUserAccessLevelResponses, GetRingStatusData, GetRingStatusErrors, GetRingStatusResponses, GetSavedViewDefinitionData, GetSavedViewDefinitionErrors, GetSavedViewDefinitionResponses, GetSelfBotData, GetSelfBotErrors, GetSelfBotResponses, GetSelfHarnessData, GetSelfHarnessErrors, GetSelfHarnessResponses, GetSkillDescriptionData, GetSkillDescriptionErrors, GetSkillDescriptionResponses, GetSlackImportData, GetSlackImportErrors, GetSlackImportResponses, GetSystemSkillsHandlerData, GetSystemSkillsHandlerErrors, GetSystemSkillsHandlerResponses, GetTeamAvailabilityData, GetTeamAvailabilityErrors, GetTeamAvailabilityResponses, GetUploadExtractStatusHandlerData, GetUploadExtractStatusHandlerErrors, GetUploadExtractStatusHandlerResponses, GetUserDocumentsHandlerData, GetUserDocumentsHandlerErrors, GetUserDocumentsHandlerResponses, GetUserDocumentViewLocationData, GetUserDocumentViewLocationErrors, GetUserDocumentViewLocationResponses, GetViewsHandlerData, GetViewsHandlerErrors, GetViewsHandlerResponses, GetWebhookData, GetWebhookErrors, GetWebhookResponses, GuestCallChatDeleteMessageData, GuestCallChatDeleteMessageErrors, GuestCallChatDeleteMessageResponses, GuestCallChatPatchMessageData, GuestCallChatPatchMessageErrors, GuestCallChatPatchMessageResponses, GuestCallChatPostData, GuestCallChatPostErrors, GuestCallChatPostMessageData, GuestCallChatPostMessageErrors, GuestCallChatPostMessageResponses, GuestCallChatPostResponses, GuestCallChatReactMessageData, GuestCallChatReactMessageErrors, GuestCallChatReactMessageResponses, GuestCallChatReadData, GuestCallChatReadErrors, GuestCallChatReadResponses, GuestCallChatReadThreadData, GuestCallChatReadThreadErrors, GuestCallChatReadThreadResponses, HandlerData, HandlerErrors, HandlerResponses, HealthHandlerData, HealthHandlerResponses, ImportCrmCompaniesCsvData, ImportCrmCompaniesCsvErrors, ImportCrmCompaniesCsvResponses, ImportCrmPipelineCsvData, ImportCrmPipelineCsvErrors, ImportCrmPipelineCsvResponses, ImportDatabaseTableData, ImportDatabaseTableErrors, ImportDatabaseTableResponses, InferDatabaseColumnTypeData, InferDatabaseColumnTypeErrors, InferDatabaseColumnTypeResponses, IngestTranscriptData, IngestTranscriptErrors, IngestTranscriptResponses, InitializeUserDocumentsData, InitializeUserDocumentsErrors, InitializeUserDocumentsResponses, InstallSyncData, InstallSyncErrors, JobProcessingResultHandlerData, JobProcessingResultHandlerErrors, JobProcessingResultHandlerResponses, JoinCallData, JoinCallErrors, JoinCallResponses, JoinChannelByCodeData, JoinChannelByCodeErrors, JoinChannelByCodeResponses, JoinChannelData, JoinChannelErrors, JoinChannelResponses, LeaveCallData, LeaveCallErrors, LeaveCallResponses, LeaveChannelData, LeaveChannelErrors, LeaveChannelResponses, LeaveOrEndCallData, LeaveOrEndCallErrors, LeaveOrEndCallResponses, ListAccessibleFormsData, ListAccessibleFormsErrors, ListAccessibleFormsResponses, ListAccountManagersData, ListAccountManagersErrors, ListAccountManagersResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBotChannelsData, ListBotChannelsErrors, ListBotChannelsResponses, ListBotsData, ListBotsErrors, ListBotsResponses, ListBotTokensData, ListBotTokensErrors, ListBotTokensResponses, ListChannelBotsData, ListChannelBotsErrors, ListChannelBotsResponses, ListChannelLabelsData, ListChannelLabelsErrors, ListChannelLabelsResponses, ListChannelSectionsData, ListChannelSectionsErrors, ListChannelSectionsResponses, ListCompanyContactsData, ListCompanyContactsErrors, ListCompanyContactsPageData, ListCompanyContactsPageErrors, ListCompanyContactsPageResponses, ListCompanyContactsResponses, ListCrmBlockedDomainsData, ListCrmBlockedDomainsErrors, ListCrmBlockedDomainsResponses, ListCrmEmailPolicyHistoryData, ListCrmEmailPolicyHistoryResponses, ListCrmExcludedEmailThreadsData, ListCrmExcludedEmailThreadsResponses, ListCrmPipelineDetailsData, ListCrmPipelineDetailsErrors, ListCrmPipelineDetailsResponses, ListCrmPipelinesData, ListCrmPipelinesResponses, ListCrmRecordPipelineEntriesData, ListCrmRecordPipelineEntriesErrors, ListCrmRecordPipelineEntriesResponses, ListDatabaseColumnCastsData, ListDatabaseColumnCastsErrors, ListDatabaseColumnCastsResponses, ListDatabasesData, ListDatabasesErrors, ListDatabasesResponses, ListDatabaseWebhooksData, ListDatabaseWebhooksErrors, ListDatabaseWebhooksResponses, ListEmailRemindersData, ListEmailRemindersErrors, ListEmailRemindersResponses, ListFavoritesData, ListFavoritesErrors, ListFavoritesResponses, ListFormsData, ListFormsErrors, ListFormsResponses, ListHarnessAgentsData, ListHarnessAgentsErrors, ListHarnessAgentsResponses, ListHarnessDirectoryData, ListHarnessDirectoryErrors, ListHarnessDirectoryResponses, ListHarnessesData, ListHarnessesErrors, ListHarnessesResponses, ListHarnessResidentsData, ListHarnessResidentsErrors, ListHarnessResidentsResponses, ListHarnessSessionsData, ListHarnessSessionsErrors, ListHarnessSessionsResponses, ListInitiativesData, ListInitiativesErrors, ListInitiativesResponses, ListJoinRequestsData, ListJoinRequestsErrors, ListJoinRequestsResponses, ListOccurrencesData, ListOccurrencesErrors, ListOccurrencesResponses, ListSavedViewDefinitionsData, ListSavedViewDefinitionsErrors, ListSavedViewDefinitionsResponses, ListSlackImportsData, ListSlackImportsResponses, ListTeamCalendarData, ListTeamCalendarResponses, ListTeamOutOfOfficeData, ListTeamOutOfOfficeErrors, ListTeamOutOfOfficeResponses, ListUserApiKeysData, ListUserApiKeysErrors, ListUserApiKeysResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, MeetingCancelData, MeetingCancelErrors, MeetingCancelPreparationData, MeetingCancelPreparationErrors, MeetingCancelPreparationResponses, MeetingCancelResponses, MeetingCreateData, MeetingCreateErrors, MeetingCreateResponses, MeetingGuestJoinData, MeetingGuestJoinErrors, MeetingGuestJoinResponses, MeetingGuestParticipantsData, MeetingGuestParticipantsErrors, MeetingGuestParticipantsResponses, MeetingInviteData, MeetingInviteErrors, MeetingInvitePermissionsData, MeetingInvitePermissionsErrors, MeetingInvitePermissionsResponses, MeetingInviteResponses, MeetingInviteUsersData, MeetingInviteUsersErrors, MeetingInviteUsersResponses, MeetingJoinData, MeetingJoinErrors, MeetingJoinResponses, MeetingLeaveData, MeetingLeaveErrors, MeetingLeaveResponses, MeetingListActiveData, MeetingListActiveErrors, MeetingListActiveResponses, MeetingListData, MeetingListErrors, MeetingListResponses, MeetingLookupData, MeetingLookupErrors, MeetingLookupResponses, MeetingParticipantsData, MeetingParticipantsErrors, MeetingParticipantsResponses, MeetingPrepareData, MeetingPrepareErrors, MeetingPrepareResponses, MeetingShareData, MeetingShareErrors, MeetingShareResponses, MeetingUpdateData, MeetingUpdateErrors, MeetingUpdateResponses, MentionPreviewsData, MentionPreviewsErrors, MentionPreviewsResponses, MessageTimelineData, MessageTimelineEntriesData, MessageTimelineEntriesResponses, MessageTimelineResponses, PageInitiativesData, PageInitiativesErrors, PageInitiativesResponses, PasswordsActivityData, PasswordsActivityErrors, PasswordsActivityResponses, PasswordsAgentAccessRequestsData, PasswordsAgentAccessRequestsErrors, PasswordsAgentAccessRequestsResponses, PasswordsAgentCreateData, PasswordsAgentCreateErrors, PasswordsAgentCreateResponses, PasswordsAgentDiscloseData, PasswordsAgentDiscloseErrors, PasswordsAgentDiscloseResponses, PasswordsAgentMyRequestData, PasswordsAgentMyRequestErrors, PasswordsAgentMyRequestResponses, PasswordsAgentRequestAccessData, PasswordsAgentRequestAccessErrors, PasswordsAgentRequestAccessResponses, PasswordsAgentResolveRequestData, PasswordsAgentResolveRequestErrors, PasswordsAgentResolveRequestResponses, PasswordsAgentRevokeData, PasswordsAgentRevokeErrors, PasswordsAgentRevokeResponses, PasswordsAgentSearchData, PasswordsAgentSearchErrors, PasswordsAgentSearchResponses, PasswordsAgentSetTotpData, PasswordsAgentSetTotpErrors, PasswordsAgentSetTotpResponses, PasswordsAgentTotpCodeData, PasswordsAgentTotpCodeErrors, PasswordsAgentTotpCodeResponses, PasswordsAgentUpdateData, PasswordsAgentUpdateErrors, PasswordsAgentUpdateResponses, PasswordsCopyData, PasswordsCopyErrors, PasswordsCopyResponses, PasswordsCopyUsernameData, PasswordsCopyUsernameErrors, PasswordsCopyUsernameResponses, PasswordsCreateData, PasswordsCreateErrors, PasswordsCreateFolderData, PasswordsCreateFolderErrors, PasswordsCreateFolderResponses, PasswordsCreateResponses, PasswordsDetailData, PasswordsDetailErrors, PasswordsDetailResponses, PasswordsFoldersData, PasswordsFoldersErrors, PasswordsFoldersResponses, PasswordsGrantsData, PasswordsGrantsErrors, PasswordsGrantsResponses, PasswordsHistoryData, PasswordsHistoryErrors, PasswordsHistoryResponses, PasswordsImportBatchData, PasswordsImportBatchErrors, PasswordsImportBatchResponses, PasswordsListData, PasswordsListErrors, PasswordsListResponses, PasswordsMatchData, PasswordsMatchErrors, PasswordsMatchResponses, PasswordsMoveFolderData, PasswordsMoveFolderErrors, PasswordsMoveFolderResponses, PasswordsPatchData, PasswordsPatchErrors, PasswordsPatchResponses, PasswordsRemoveData, PasswordsRemoveErrors, PasswordsRemoveFolderData, PasswordsRemoveFolderErrors, PasswordsRemoveFolderResponses, PasswordsRemoveResponses, PasswordsRemoveTotpData, PasswordsRemoveTotpErrors, PasswordsRemoveTotpResponses, PasswordsRenameFolderData, PasswordsRenameFolderErrors, PasswordsRenameFolderResponses, PasswordsRevealData, PasswordsRevealErrors, PasswordsRevealResponses, PasswordsSetTotpData, PasswordsSetTotpErrors, PasswordsSetTotpResponses, PasswordsShareData, PasswordsShareErrors, PasswordsShareResponses, PasswordsTeamsData, PasswordsTeamsErrors, PasswordsTeamsResponses, PasswordsTotpData, PasswordsTotpErrors, PasswordsTotpResponses, PasswordsUpdateData, PasswordsUpdateErrors, PasswordsUpdateResponses, PasswordsUsernameData, PasswordsUsernameErrors, PasswordsUsernameResponses, PatchAgentData, PatchAgentErrors, PatchAgentResponses, PatchBotData, PatchBotErrors, PatchBotResponses, PatchChannelData, PatchChannelErrors, PatchChannelResponses, PatchHarnessData, PatchHarnessErrors, PatchHarnessResponses, PatchViewHandlerData, PatchViewHandlerErrors, PatchViewHandlerResponses, PatchWebhookData, PatchWebhookErrors, PatchWebhookResponses, PermanentlyDeleteDocumentData, PermanentlyDeleteDocumentErrors, PermanentlyDeleteDocumentResponses, PermanentlyDeleteProjectData, PermanentlyDeleteProjectErrors, PermanentlyDeleteProjectResponses, PostActivityData, PostActivityErrors, PostActivityResponses, PostChannelBotWebhookData, PostChannelBotWebhookErrors, PostChannelBotWebhookResponses, PostItemsSoupAstData, PostItemsSoupAstErrors, PostItemsSoupAstGroupedData, PostItemsSoupAstGroupedErrors, PostItemsSoupAstGroupedResponses, PostItemsSoupAstResponses, PostItemsSoupData, PostItemsSoupErrors, PostItemsSoupResponses, PresaveDocumentHandlerData, PresaveDocumentHandlerErrors, PresaveDocumentHandlerResponses, PreviewChannelSectionData, PreviewChannelSectionErrors, PreviewChannelSectionResponses, PreviewCrmEmailRulesData, PreviewCrmEmailRulesResponses, PreviewCrmRecordsData, PreviewCrmRecordsErrors, PreviewCrmRecordsResponses, PreviewSmartTagData, PreviewSmartTagErrors, PreviewSmartTagResponses, PutCrmTeamSettingsData, PutCrmTeamSettingsErrors, PutCrmTeamSettingsResponses, PutCrmTeamStagesData, PutCrmTeamStagesErrors, PutCrmTeamStagesResponses, PutFormLayoutData, PutFormLayoutErrors, PutFormLayoutResponses, QueryCrmPipelineRowsData, QueryCrmPipelineRowsResponses, QueryDatabasesData, QueryDatabasesErrors, QueryDatabasesResponses, ReadCanvasSceneData, ReadCanvasSceneErrors, ReadCanvasSceneResponses, ReadDesignData, ReadDesignErrors, ReadDesignResponses, ReadIllustratorDocumentData, ReadIllustratorDocumentErrors, ReadIllustratorDocumentResponses, ReadPhotoshopDocumentData, ReadPhotoshopDocumentErrors, ReadPhotoshopDocumentResponses, ReadPresentationData, ReadPresentationErrors, ReadPresentationResponses, ReadSpreadsheetData, ReadSpreadsheetErrors, ReadSpreadsheetResponses, ReadWordDocumentData, ReadWordDocumentErrors, ReadWordDocumentResponses, RecentlyDeletedData, RecentlyDeletedErrors, RecentlyDeletedResponses, RegisterSlackImportUploadsData, RegisterSlackImportUploadsErrors, RegisterSlackImportUploadsResponses, RemoveBotFromChannelByBotData, RemoveBotFromChannelByBotErrors, RemoveBotFromChannelByBotResponses, RemoveCrmContactEmailData, RemoveCrmContactEmailErrors, RemoveCrmContactEmailResponses, RemoveCrmPipelineEntriesData, RemoveCrmPipelineEntriesErrors, RemoveCrmPipelineEntriesResponses, RemoveFavoriteByEntityData, RemoveFavoriteByEntityErrors, RemoveFavoriteByEntityResponses, RemoveParticipantsData, RemoveParticipantsErrors, RemoveParticipantsResponses, RemovePinHandlerData, RemovePinHandlerErrors, RemovePinHandlerResponses, RenameChannelLabelData, RenameChannelLabelErrors, RenameChannelLabelResponses, RenameCrmPipelineData, RenameCrmPipelineResponses, RenderCanvasData, RenderCanvasErrors, RenderCanvasResponses, ReorderFavoritesData, ReorderFavoritesErrors, ReorderFavoritesResponses, ReorderPinsHandlerData, ReorderPinsHandlerErrors, ReorderPinsHandlerResponses, ReorderSavedViewDefinitionsData, ReorderSavedViewDefinitionsErrors, ReorderSavedViewDefinitionsResponses, RequestAccountManagerData, RequestAccountManagerErrors, RequestAccountManagerResponses, RequestChannelAccessData, RequestChannelAccessErrors, RequestChannelAccessResponses, RequestToJoinData, RequestToJoinErrors, RequestToJoinResponses, ResetCrmTeamStagesData, ResetCrmTeamStagesErrors, ResetCrmTeamStagesResponses, ResolveChannelAccessRequestData, ResolveChannelAccessRequestErrors, ResolveChannelAccessRequestResponses, RespondToAccountManagerRequestData, RespondToAccountManagerRequestErrors, RespondToAccountManagerRequestResponses, RevertDeleteDocumentData, RevertDeleteDocumentErrors, RevertDeleteDocumentResponses, RevertDeleteProjectData, RevertDeleteProjectErrors, RevertDeleteProjectResponses, RevokeAccountManagerGrantData, RevokeAccountManagerGrantErrors, RevokeAccountManagerGrantResponses, RevokeBotTokenData, RevokeBotTokenErrors, RevokeBotTokenResponses, SaveDatabaseQueryData, SaveDatabaseQueryErrors, SaveDatabaseQueryResponses, SaveDocumentHandlerData, SaveDocumentHandlerErrors, SaveDocumentHandlerResponses, SearchContactsData, SearchContactsErrors, SearchContactsResponses, SearchCrmPipelineEntriesData, SearchCrmPipelineEntriesErrors, SearchCrmPipelineEntriesResponses, SetChannelLabelData, SetChannelLabelErrors, SetChannelLabelResponses, SetChannelPictureData, SetChannelPictureErrors, SetChannelPictureResponses, SetChannelSectionData, SetChannelSectionErrors, SetChannelSectionResponses, SetCompanyHiddenData, SetCompanyHiddenErrors, SetCompanyHiddenResponses, SetContactHiddenData, SetContactHiddenErrors, SetContactHiddenResponses, SetCrmCompanyNameData, SetCrmCompanyNameErrors, SetCrmCompanyNameResponses, SetCrmContactCompanyData, SetCrmContactCompanyErrors, SetCrmContactCompanyResponses, SetCrmContactEmailData, SetCrmContactEmailErrors, SetCrmContactEmailResponses, SetCrmContactNameData, SetCrmContactNameErrors, SetCrmContactNameResponses, SetCrmPipelineStageRequirementData, SetCrmPipelineStageRequirementResponses, SetDatabaseAppearanceData, SetDatabaseAppearanceErrors, SetDatabaseAppearanceResponses, SetDocumentAppearanceData, SetDocumentAppearanceErrors, SetDocumentAppearanceResponses, SetDocumentTeamShareData, SetDocumentTeamShareErrors, SetDocumentTeamShareResponses, SetEmailFollowupData, SetEmailFollowupErrors, SetEmailFollowupResponses, SetEmailSyncData, SetEmailSyncErrors, SetEmailSyncResponses, SetFormAppearanceData, SetFormAppearanceErrors, SetFormAppearanceResponses, SetHarnessTeamAccessData, SetHarnessTeamAccessErrors, SetHarnessTeamAccessResponses, SetInitiativeAppearanceData, SetInitiativeAppearanceErrors, SetInitiativeAppearanceResponses, SetSkillDescriptionData, SetSkillDescriptionErrors, SetSkillDescriptionResponses, ShareCrmPipelineData, ShareCrmPipelineResponses, ShareDatabaseAwarenessData, ShareDatabaseAwarenessErrors, ShareDatabaseAwarenessResponses, ShareWithChannelData, ShareWithChannelErrors, ShareWithChannelResponses, SimpleSaveData, SimpleSaveErrors, SimpleSaveResponses, StartCallData, StartCallErrors, StartCallResponses, StreamEventsData, StreamEventsResponse, StreamEventsResponses, SubmitFormResponseData, SubmitFormResponseErrors, SubmitFormResponseResponses, TaskSimilaritySearchHandlerData, TaskSimilaritySearchHandlerErrors, TaskSimilaritySearchHandlerResponses, ToggleShareWithTeamData, ToggleShareWithTeamErrors, ToggleShareWithTeamResponses, TranscribeDictationData, TranscribeDictationErrors, TranscribeDictationResponses, TrashCrmPipelineData, TrashCrmPipelineResponses, UnblockCrmDomainData, UnblockCrmDomainErrors, UnblockCrmDomainResponses, UndoDatabaseChangeData, UndoDatabaseChangeErrors, UndoDatabaseChangeResponses, UnlinkCrmContactCompanyData, UnlinkCrmContactCompanyErrors, UnlinkCrmContactCompanyResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateChannelSectionData, UpdateChannelSectionErrors, UpdateChannelSectionResponses, UpdateCrmEmailPolicyData, UpdateCrmEmailPolicyErrors, UpdateCrmEmailPolicyResponses, UpdateCrmEmailPrivacyData, UpdateCrmEmailPrivacyResponses, UpdateCrmPipelineEntriesData, UpdateCrmPipelineEntriesErrors, UpdateCrmPipelineEntriesResponses, UpdateCrmPipelinePermissionsData, UpdateCrmPipelinePermissionsResponses, UpdateDatabasePermissionsData, UpdateDatabasePermissionsErrors, UpdateDatabasePermissionsResponses, UpdateFormData, UpdateFormErrors, UpdateFormPermissionsData, UpdateFormPermissionsErrors, UpdateFormPermissionsResponses, UpdateFormResponses, UpdateInitiativeData, UpdateInitiativeErrors, UpdateInitiativeResponses, UpdateSavedViewDefinitionData, UpdateSavedViewDefinitionErrors, UpdateSavedViewDefinitionResponses, UploadExtractFolderHandlerData, UploadExtractFolderHandlerErrors, UploadExtractFolderHandlerResponses, UploadFileData, UploadFileErrors, UploadFileResponses, UploadFolderHandlerData, UploadFolderHandlerErrors, UploadFolderHandlerResponses, UpsertHistoryHandlerData, UpsertHistoryHandlerErrors, UpsertHistoryHandlerResponses, UpsertUserDocumentViewLocationData, UpsertUserDocumentViewLocationErrors, UpsertUserDocumentViewLocationResponses, ValidateCrmEmailRulesData, ValidateCrmEmailRulesResponses, ValidateDocumentPermissionsTokenData, ValidateDocumentPermissionsTokenErrors, ValidateDocumentPermissionsTokenResponses, ValidateWebhookData, ValidateWebhookErrors, ValidateWebhookResponses, WhatsappAccountData, WhatsappAccountResponses, WhatsappCancelPairingData, WhatsappCancelPairingResponses, WhatsappChatsData, WhatsappChatsResponses, WhatsappConnectData, WhatsappConnectResponses, WhatsappDisconnectData, WhatsappDisconnectResponses, WhatsappImportHistoryData, WhatsappImportHistoryResponses, WhatsappLookupData, WhatsappLookupResponses, WhatsappPairingData, WhatsappPairingResponses, WhatsappPasskeyData, WhatsappPasskeyResponses, WhatsappStartLookupData, WhatsappStartLookupResponses, WriteDocumentMarkdownData, WriteDocumentMarkdownErrors, WriteDocumentMarkdownResponses } 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
|
+
* List the managers of the caller's account.
|
|
36
|
+
*/
|
|
37
|
+
listAccountManagers<ThrowOnError extends boolean = false>(options?: Options<ListAccountManagersData, ThrowOnError>): RequestResult<ListAccountManagersResponses, ListAccountManagersErrors, ThrowOnError>;
|
|
38
|
+
/**
|
|
39
|
+
* Ask another account for manager access, in your DM with them.
|
|
40
|
+
*/
|
|
41
|
+
requestAccountManager<ThrowOnError extends boolean = false>(options: Options<RequestAccountManagerData, ThrowOnError>): RequestResult<RequestAccountManagerResponses, RequestAccountManagerErrors, ThrowOnError>;
|
|
42
|
+
/**
|
|
43
|
+
* End a grant. Either side may withdraw it.
|
|
44
|
+
*/
|
|
45
|
+
revokeAccountManagerGrant<ThrowOnError extends boolean = false>(options: Options<RevokeAccountManagerGrantData, ThrowOnError>): RequestResult<RevokeAccountManagerGrantResponses, RevokeAccountManagerGrantErrors, ThrowOnError>;
|
|
46
|
+
/**
|
|
47
|
+
* Read a grant the caller is part of.
|
|
48
|
+
*/
|
|
49
|
+
getAccountManagerGrant<ThrowOnError extends boolean = false>(options: Options<GetAccountManagerGrantData, ThrowOnError>): RequestResult<GetAccountManagerGrantResponses, GetAccountManagerGrantErrors, ThrowOnError>;
|
|
50
|
+
/**
|
|
51
|
+
* Approve or decline a request the caller didn't make.
|
|
52
|
+
*/
|
|
53
|
+
respondToAccountManagerRequest<ThrowOnError extends boolean = false>(options: Options<RespondToAccountManagerRequestData, ThrowOnError>): RequestResult<RespondToAccountManagerRequestResponses, RespondToAccountManagerRequestErrors, ThrowOnError>;
|
|
54
|
+
/**
|
|
55
|
+
* Issue the credential to the manager. Works once. A POST, so link previews
|
|
56
|
+
* and crawlers can't use it up.
|
|
57
|
+
*/
|
|
58
|
+
claimAccountManagerToken<ThrowOnError extends boolean = false>(options: Options<ClaimAccountManagerTokenData, ThrowOnError>): RequestResult<ClaimAccountManagerTokenResponses, ClaimAccountManagerTokenErrors, ThrowOnError>;
|
|
59
|
+
/**
|
|
60
|
+
* Handler for `GET /agents`.
|
|
61
|
+
*/
|
|
62
|
+
listAgents<ThrowOnError extends boolean = false>(options?: Options<ListAgentsData, ThrowOnError>): RequestResult<ListAgentsResponses, ListAgentsErrors, ThrowOnError>;
|
|
63
|
+
/**
|
|
64
|
+
* Handler for `POST /agents`.
|
|
65
|
+
*/
|
|
66
|
+
createAgent<ThrowOnError extends boolean = false>(options: Options<CreateAgentData, ThrowOnError>): RequestResult<CreateAgentResponses, CreateAgentErrors, ThrowOnError>;
|
|
67
|
+
/**
|
|
68
|
+
* Handler for `PATCH /agents/{agent_id}`: change only the settings the body
|
|
69
|
+
* names, keeping every other one, as the `ConfigureAgent` tool does.
|
|
70
|
+
*/
|
|
71
|
+
patchAgent<ThrowOnError extends boolean = false>(options: Options<PatchAgentData, ThrowOnError>): RequestResult<PatchAgentResponses, PatchAgentErrors, ThrowOnError>;
|
|
72
|
+
/**
|
|
73
|
+
* Handler for `PUT /agents/{agent_id}`.
|
|
74
|
+
*/
|
|
75
|
+
updateAgent<ThrowOnError extends boolean = false>(options: Options<UpdateAgentData, ThrowOnError>): RequestResult<UpdateAgentResponses, UpdateAgentErrors, ThrowOnError>;
|
|
76
|
+
/**
|
|
77
|
+
* Deletes a highlight and any attached discussion under the annotation policy.
|
|
78
|
+
*/
|
|
79
|
+
deleteAnchor<ThrowOnError extends boolean = false>(options: Options<DeleteAnchorData, ThrowOnError>): RequestResult<DeleteAnchorResponses, DeleteAnchorErrors, ThrowOnError>;
|
|
80
|
+
/**
|
|
81
|
+
* Edits a single anchor for a document
|
|
82
|
+
*/
|
|
83
|
+
editAnchor<ThrowOnError extends boolean = false>(options: Options<EditAnchorData, ThrowOnError>): RequestResult<EditAnchorResponses, EditAnchorErrors, ThrowOnError>;
|
|
84
|
+
/**
|
|
85
|
+
* Gets a set of comment anchors for a document
|
|
86
|
+
*/
|
|
87
|
+
getDocumentAnchors<ThrowOnError extends boolean = false>(options: Options<GetDocumentAnchorsData, ThrowOnError>): RequestResult<GetDocumentAnchorsResponses, GetDocumentAnchorsErrors, ThrowOnError>;
|
|
88
|
+
/**
|
|
89
|
+
* Creates an unthreaded anchor for a document
|
|
90
|
+
* Attach a discussion through the shared message API.
|
|
91
|
+
*/
|
|
92
|
+
createAnchor<ThrowOnError extends boolean = false>(options: Options<CreateAnchorData, ThrowOnError>): RequestResult<CreateAnchorResponses, CreateAnchorErrors, ThrowOnError>;
|
|
93
|
+
/**
|
|
94
|
+
* Handler for `GET /bots`: the bots the caller can manage.
|
|
95
|
+
*/
|
|
96
|
+
listBots<ThrowOnError extends boolean = false>(options?: Options<ListBotsData, ThrowOnError>): RequestResult<ListBotsResponses, ListBotsErrors, ThrowOnError>;
|
|
97
|
+
/**
|
|
98
|
+
* Handler for `POST /bots`.
|
|
99
|
+
*/
|
|
100
|
+
createBot<ThrowOnError extends boolean = false>(options: Options<CreateBotData, ThrowOnError>): RequestResult<CreateBotResponses, CreateBotErrors, ThrowOnError>;
|
|
101
|
+
/**
|
|
102
|
+
* Handler for `GET /bots/me`.
|
|
103
|
+
*/
|
|
104
|
+
getSelfBot<ThrowOnError extends boolean = false>(options?: Options<GetSelfBotData, ThrowOnError>): RequestResult<GetSelfBotResponses, GetSelfBotErrors, ThrowOnError>;
|
|
105
|
+
/**
|
|
106
|
+
* Handler for `GET /bots/profiles`.
|
|
107
|
+
*
|
|
108
|
+
* Returns display fields and the sponsor for each requested bot. Not a
|
|
109
|
+
* manageability check: any authenticated user or internal caller may look up
|
|
110
|
+
* ids they already have.
|
|
111
|
+
*/
|
|
112
|
+
getBotOwnerProfiles<ThrowOnError extends boolean = false>(options?: Options<GetBotOwnerProfilesData, ThrowOnError>): RequestResult<GetBotOwnerProfilesResponses, GetBotOwnerProfilesErrors, ThrowOnError>;
|
|
113
|
+
/**
|
|
114
|
+
* Handler for `DELETE /bots/{bot_id}`.
|
|
115
|
+
*/
|
|
116
|
+
deleteBot<ThrowOnError extends boolean = false>(options: Options<DeleteBotData, ThrowOnError>): RequestResult<DeleteBotResponses, DeleteBotErrors, ThrowOnError>;
|
|
117
|
+
/**
|
|
118
|
+
* Handler for `GET /bots/{bot_id}`.
|
|
119
|
+
*/
|
|
120
|
+
getBot<ThrowOnError extends boolean = false>(options: Options<GetBotData, ThrowOnError>): RequestResult<GetBotResponses, GetBotErrors, ThrowOnError>;
|
|
121
|
+
/**
|
|
122
|
+
* Handler for `PATCH /bots/{bot_id}`.
|
|
123
|
+
*/
|
|
124
|
+
patchBot<ThrowOnError extends boolean = false>(options: Options<PatchBotData, ThrowOnError>): RequestResult<PatchBotResponses, PatchBotErrors, ThrowOnError>;
|
|
125
|
+
/**
|
|
126
|
+
* Handler for `GET /bots/{bot_id}/channels`.
|
|
127
|
+
*/
|
|
128
|
+
listBotChannels<ThrowOnError extends boolean = false>(options: Options<ListBotChannelsData, ThrowOnError>): RequestResult<ListBotChannelsResponses, ListBotChannelsErrors, ThrowOnError>;
|
|
129
|
+
/**
|
|
130
|
+
* Handler for `DELETE /bots/{bot_id}/channels/{channel_id}`.
|
|
131
|
+
*/
|
|
132
|
+
removeBotFromChannelByBot<ThrowOnError extends boolean = false>(options: Options<RemoveBotFromChannelByBotData, ThrowOnError>): RequestResult<RemoveBotFromChannelByBotResponses, RemoveBotFromChannelByBotErrors, ThrowOnError>;
|
|
133
|
+
/**
|
|
134
|
+
* Handler for `GET /bots/{bot_id}/tokens`.
|
|
135
|
+
*/
|
|
136
|
+
listBotTokens<ThrowOnError extends boolean = false>(options: Options<ListBotTokensData, ThrowOnError>): RequestResult<ListBotTokensResponses, ListBotTokensErrors, ThrowOnError>;
|
|
137
|
+
/**
|
|
138
|
+
* Handler for `POST /bots/{bot_id}/tokens`.
|
|
139
|
+
*/
|
|
140
|
+
createBotToken<ThrowOnError extends boolean = false>(options: Options<CreateBotTokenData, ThrowOnError>): RequestResult<CreateBotTokenResponses, CreateBotTokenErrors, ThrowOnError>;
|
|
141
|
+
/**
|
|
142
|
+
* Handler for `DELETE /bots/{bot_id}/tokens/{token_id}`.
|
|
143
|
+
*/
|
|
144
|
+
revokeBotToken<ThrowOnError extends boolean = false>(options: Options<RevokeBotTokenData, ThrowOnError>): RequestResult<RevokeBotTokenResponses, RevokeBotTokenErrors, ThrowOnError>;
|
|
145
|
+
/**
|
|
146
|
+
* Return calendar occurrences visible to the authenticated requester.
|
|
147
|
+
*/
|
|
148
|
+
listOccurrences<ThrowOnError extends boolean = false>(options: Options<ListOccurrencesData, ThrowOnError>): RequestResult<ListOccurrencesResponses, ListOccurrencesErrors, ThrowOnError>;
|
|
149
|
+
/**
|
|
150
|
+
* Resolve mentioned calendar events to the requester's own projections.
|
|
151
|
+
*/
|
|
152
|
+
mentionPreviews<ThrowOnError extends boolean = false>(options: Options<MentionPreviewsData, ThrowOnError>): RequestResult<MentionPreviewsResponses, MentionPreviewsErrors, ThrowOnError>;
|
|
153
|
+
/**
|
|
154
|
+
* Query authorized projections in a bounded viewport.
|
|
155
|
+
*/
|
|
156
|
+
listTeamCalendar<ThrowOnError extends boolean = false>(options: Options<ListTeamCalendarData, ThrowOnError>): RequestResult<ListTeamCalendarResponses, unknown, ThrowOnError>;
|
|
157
|
+
/**
|
|
158
|
+
* Return teammates' out-of-office occurrences in the requested viewport.
|
|
159
|
+
*/
|
|
160
|
+
listTeamOutOfOffice<ThrowOnError extends boolean = false>(options: Options<ListTeamOutOfOfficeData, ThrowOnError>): RequestResult<ListTeamOutOfOfficeResponses, ListTeamOutOfOfficeErrors, ThrowOnError>;
|
|
161
|
+
/**
|
|
162
|
+
* Merge the requester's and selected teammates' busy time in a bounded window.
|
|
163
|
+
*/
|
|
164
|
+
getTeamAvailability<ThrowOnError extends boolean = false>(options: Options<GetTeamAvailabilityData, ThrowOnError>): RequestResult<GetTeamAvailabilityResponses, GetTeamAvailabilityErrors, ThrowOnError>;
|
|
165
|
+
/**
|
|
166
|
+
* Export an event the requester can see — their own, or one shared with a
|
|
167
|
+
* channel they belong to — as an iCalendar file named after its title.
|
|
168
|
+
*/
|
|
169
|
+
eventIcs<ThrowOnError extends boolean = false>(options: Options<EventIcsData, ThrowOnError>): RequestResult<EventIcsResponses, EventIcsErrors, ThrowOnError>;
|
|
170
|
+
/**
|
|
171
|
+
* List pending requests to join an event the requester can change.
|
|
172
|
+
*/
|
|
173
|
+
listJoinRequests<ThrowOnError extends boolean = false>(options: Options<ListJoinRequestsData, ThrowOnError>): RequestResult<ListJoinRequestsResponses, ListJoinRequestsErrors, ThrowOnError>;
|
|
174
|
+
/**
|
|
175
|
+
* Ask the person who shared an event with one of the requester's channels
|
|
176
|
+
* to add them as a guest. Asking again while the request is pending or
|
|
177
|
+
* accepted changes nothing; a declined request stands, so asking after a
|
|
178
|
+
* decline is refused with `request_declined`.
|
|
179
|
+
*/
|
|
180
|
+
requestToJoin<ThrowOnError extends boolean = false>(options: Options<RequestToJoinData, ThrowOnError>): RequestResult<RequestToJoinResponses, RequestToJoinErrors, ThrowOnError>;
|
|
181
|
+
/**
|
|
182
|
+
* Handler for `GET /call/active`.
|
|
183
|
+
*
|
|
184
|
+
* Lists all active calls in channels the caller is an active member of,
|
|
185
|
+
* newest first. Calls with no active participants (orphaned by dropped RTC
|
|
186
|
+
* webhooks) are excluded.
|
|
187
|
+
*/
|
|
188
|
+
getActiveCalls<ThrowOnError extends boolean = false>(options?: Options<GetActiveCallsData, ThrowOnError>): RequestResult<GetActiveCallsResponses, GetActiveCallsErrors, ThrowOnError>;
|
|
189
|
+
/**
|
|
190
|
+
* List all channel and standalone calls this account can join.
|
|
191
|
+
*/
|
|
192
|
+
getLiveCalls<ThrowOnError extends boolean = false>(options?: Options<GetLiveCallsData, ThrowOnError>): RequestResult<GetLiveCallsResponses, unknown, ThrowOnError>;
|
|
193
|
+
/**
|
|
194
|
+
* Read the live call discussion as a verified guest.
|
|
195
|
+
*/
|
|
196
|
+
guestCallChatRead<ThrowOnError extends boolean = false>(options: Options<GuestCallChatReadData, ThrowOnError>): RequestResult<GuestCallChatReadResponses, GuestCallChatReadErrors, ThrowOnError>;
|
|
197
|
+
/**
|
|
198
|
+
* Append text to the same saved discussion used by account participants.
|
|
199
|
+
*/
|
|
200
|
+
guestCallChatPost<ThrowOnError extends boolean = false>(options: Options<GuestCallChatPostData, ThrowOnError>): RequestResult<GuestCallChatPostResponses, GuestCallChatPostErrors, ThrowOnError>;
|
|
201
|
+
/**
|
|
202
|
+
* Post a guest message to the shared call thread.
|
|
203
|
+
*/
|
|
204
|
+
guestCallChatPostMessage<ThrowOnError extends boolean = false>(options: Options<GuestCallChatPostMessageData, ThrowOnError>): RequestResult<GuestCallChatPostMessageResponses, GuestCallChatPostMessageErrors, ThrowOnError>;
|
|
205
|
+
/**
|
|
206
|
+
* Delete a message owned by this guest.
|
|
207
|
+
*/
|
|
208
|
+
guestCallChatDeleteMessage<ThrowOnError extends boolean = false>(options: Options<GuestCallChatDeleteMessageData, ThrowOnError>): RequestResult<GuestCallChatDeleteMessageResponses, GuestCallChatDeleteMessageErrors, ThrowOnError>;
|
|
209
|
+
/**
|
|
210
|
+
* Edit a message owned by this guest.
|
|
211
|
+
*/
|
|
212
|
+
guestCallChatPatchMessage<ThrowOnError extends boolean = false>(options: Options<GuestCallChatPatchMessageData, ThrowOnError>): RequestResult<GuestCallChatPatchMessageResponses, GuestCallChatPatchMessageErrors, ThrowOnError>;
|
|
213
|
+
/**
|
|
214
|
+
* Add or remove this guest's reaction.
|
|
215
|
+
*/
|
|
216
|
+
guestCallChatReactMessage<ThrowOnError extends boolean = false>(options: Options<GuestCallChatReactMessageData, ThrowOnError>): RequestResult<GuestCallChatReactMessageResponses, GuestCallChatReactMessageErrors, ThrowOnError>;
|
|
217
|
+
/**
|
|
218
|
+
* Read the shared call thread with identities redacted.
|
|
219
|
+
*/
|
|
220
|
+
guestCallChatReadThread<ThrowOnError extends boolean = false>(options: Options<GuestCallChatReadThreadData, ThrowOnError>): RequestResult<GuestCallChatReadThreadResponses, GuestCallChatReadThreadErrors, ThrowOnError>;
|
|
221
|
+
/**
|
|
222
|
+
* Handle `GET /call/join/{token}` through the call domain service.
|
|
223
|
+
*/
|
|
224
|
+
meetingLookup<ThrowOnError extends boolean = false>(options: Options<MeetingLookupData, ThrowOnError>): RequestResult<MeetingLookupResponses, MeetingLookupErrors, ThrowOnError>;
|
|
225
|
+
/**
|
|
226
|
+
* Handle `POST /call/join/{token}` through the call domain service.
|
|
227
|
+
*/
|
|
228
|
+
meetingGuestJoin<ThrowOnError extends boolean = false>(options: Options<MeetingGuestJoinData, ThrowOnError>): RequestResult<MeetingGuestJoinResponses, MeetingGuestJoinErrors, ThrowOnError>;
|
|
229
|
+
/**
|
|
230
|
+
* Handle `POST /call/join/{token}/leave` through the call domain service.
|
|
231
|
+
*/
|
|
232
|
+
meetingLeave<ThrowOnError extends boolean = false>(options: Options<MeetingLeaveData, ThrowOnError>): RequestResult<MeetingLeaveResponses, MeetingLeaveErrors, ThrowOnError>;
|
|
233
|
+
/**
|
|
234
|
+
* Read a standalone meeting preview without admitting a guest to the room.
|
|
235
|
+
*/
|
|
236
|
+
meetingGuestParticipants<ThrowOnError extends boolean = false>(options: Options<MeetingGuestParticipantsData, ThrowOnError>): RequestResult<MeetingGuestParticipantsResponses, MeetingGuestParticipantsErrors, ThrowOnError>;
|
|
237
|
+
/**
|
|
238
|
+
* Handle `GET /call/meetings` through the call domain service.
|
|
239
|
+
*/
|
|
240
|
+
meetingList<ThrowOnError extends boolean = false>(options?: Options<MeetingListData, ThrowOnError>): RequestResult<MeetingListResponses, MeetingListErrors, ThrowOnError>;
|
|
241
|
+
/**
|
|
242
|
+
* Handle `POST /call/meetings` through the call domain service.
|
|
243
|
+
*/
|
|
244
|
+
meetingCreate<ThrowOnError extends boolean = false>(options: Options<MeetingCreateData, ThrowOnError>): RequestResult<MeetingCreateResponses, MeetingCreateErrors, ThrowOnError>;
|
|
245
|
+
/**
|
|
246
|
+
* List the authenticated actor's active quick calls.
|
|
247
|
+
*/
|
|
248
|
+
meetingListActive<ThrowOnError extends boolean = false>(options?: Options<MeetingListActiveData, ThrowOnError>): RequestResult<MeetingListActiveResponses, MeetingListActiveErrors, ThrowOnError>;
|
|
249
|
+
/**
|
|
250
|
+
* Read the authenticated caller's invitation capability without exposing the creator.
|
|
251
|
+
*/
|
|
252
|
+
meetingInvitePermissions<ThrowOnError extends boolean = false>(options: Options<MeetingInvitePermissionsData, ThrowOnError>): RequestResult<MeetingInvitePermissionsResponses, MeetingInvitePermissionsErrors, ThrowOnError>;
|
|
253
|
+
/**
|
|
254
|
+
* Queue an owner-authorized guest invitation email.
|
|
255
|
+
*/
|
|
256
|
+
meetingInvite<ThrowOnError extends boolean = false>(options: Options<MeetingInviteData, ThrowOnError>): RequestResult<MeetingInviteResponses, MeetingInviteErrors, ThrowOnError>;
|
|
257
|
+
/**
|
|
258
|
+
* Ring registered teammates selected by the standalone meeting owner.
|
|
259
|
+
*/
|
|
260
|
+
meetingInviteUsers<ThrowOnError extends boolean = false>(options: Options<MeetingInviteUsersData, ThrowOnError>): RequestResult<MeetingInviteUsersResponses, MeetingInviteUsersErrors, ThrowOnError>;
|
|
261
|
+
/**
|
|
262
|
+
* Handle `POST /call/meetings/join/{token}` through the call domain service.
|
|
263
|
+
*/
|
|
264
|
+
meetingJoin<ThrowOnError extends boolean = false>(options: Options<MeetingJoinData, ThrowOnError>): RequestResult<MeetingJoinResponses, MeetingJoinErrors, ThrowOnError>;
|
|
265
|
+
/**
|
|
266
|
+
* Read the participant preview for an authenticated invitation holder.
|
|
267
|
+
*/
|
|
268
|
+
meetingParticipants<ThrowOnError extends boolean = false>(options: Options<MeetingParticipantsData, ThrowOnError>): RequestResult<MeetingParticipantsResponses, MeetingParticipantsErrors, ThrowOnError>;
|
|
269
|
+
/**
|
|
270
|
+
* Reserve a room while the authenticated caller configures a new call.
|
|
271
|
+
*/
|
|
272
|
+
meetingPrepare<ThrowOnError extends boolean = false>(options?: Options<MeetingPrepareData, ThrowOnError>): RequestResult<MeetingPrepareResponses, MeetingPrepareErrors, ThrowOnError>;
|
|
273
|
+
/**
|
|
274
|
+
* Cancel an unused room; the domain owns ownership and activation checks.
|
|
275
|
+
*/
|
|
276
|
+
meetingCancelPreparation<ThrowOnError extends boolean = false>(options: Options<MeetingCancelPreparationData, ThrowOnError>): RequestResult<MeetingCancelPreparationResponses, MeetingCancelPreparationErrors, ThrowOnError>;
|
|
277
|
+
/**
|
|
278
|
+
* Handle `DELETE /call/meetings/{meeting_id}` through the call domain service.
|
|
279
|
+
*/
|
|
280
|
+
meetingCancel<ThrowOnError extends boolean = false>(options: Options<MeetingCancelData, ThrowOnError>): RequestResult<MeetingCancelResponses, MeetingCancelErrors, ThrowOnError>;
|
|
281
|
+
/**
|
|
282
|
+
* Handle owner-authorized meeting title and schedule edits.
|
|
283
|
+
*/
|
|
284
|
+
meetingUpdate<ThrowOnError extends boolean = false>(options: Options<MeetingUpdateData, ThrowOnError>): RequestResult<MeetingUpdateResponses, MeetingUpdateErrors, ThrowOnError>;
|
|
285
|
+
/**
|
|
286
|
+
* Handler for `POST /call/record/preview`.
|
|
287
|
+
*
|
|
288
|
+
* Batch-fetches lightweight previews for a list of call ids. Mirrors the
|
|
289
|
+
* `POST /documents/preview` endpoint: no per-id access checks, duplicate
|
|
290
|
+
* ids are deduplicated server-side, and missing ids come back as
|
|
291
|
+
* `CallRecordPreview::DoesNotExist` rather than producing an error.
|
|
292
|
+
*/
|
|
293
|
+
getBatchCallRecordPreview<ThrowOnError extends boolean = false>(options: Options<GetBatchCallRecordPreviewData, ThrowOnError>): RequestResult<GetBatchCallRecordPreviewResponses, GetBatchCallRecordPreviewErrors, ThrowOnError>;
|
|
294
|
+
/**
|
|
295
|
+
* Handler for `DELETE /call/record/{call_id}`.
|
|
296
|
+
*
|
|
297
|
+
* Deletes a call record (and its participants/transcripts via cascade).
|
|
298
|
+
* Access is validated via channel membership (MemberParticipantRole).
|
|
299
|
+
*/
|
|
300
|
+
deleteCallRecord<ThrowOnError extends boolean = false>(options: Options<DeleteCallRecordData, ThrowOnError>): RequestResult<DeleteCallRecordResponses, DeleteCallRecordErrors, ThrowOnError>;
|
|
301
|
+
/**
|
|
302
|
+
* Handler for `GET /call/record/{call_id}`.
|
|
303
|
+
*
|
|
304
|
+
* Returns the full [`CallRecord`] (metadata + participants + transcript)
|
|
305
|
+
* for a call identified by its own id. Covers both active and archived calls.
|
|
306
|
+
* Access is validated via channel membership (MemberParticipantRole).
|
|
307
|
+
*/
|
|
308
|
+
getCallRecord<ThrowOnError extends boolean = false>(options: Options<GetCallRecordData, ThrowOnError>): RequestResult<GetCallRecordResponses, GetCallRecordErrors, ThrowOnError>;
|
|
309
|
+
/**
|
|
310
|
+
* Handler for `PATCH /call/record/{call_id}`.
|
|
311
|
+
*
|
|
312
|
+
* Edits a call record: link/channel share permissions, display name, and
|
|
313
|
+
* team sharing. Edit access (channel membership) is required for the request.
|
|
314
|
+
* `sharePermission.teamShareAccessLevel` only accepts `view` or `null`; while
|
|
315
|
+
* the call is live it sets the pending share-with-team toggle, and once the
|
|
316
|
+
* call is archived it is additionally authorized against the call's creator.
|
|
317
|
+
*/
|
|
318
|
+
editCallRecord<ThrowOnError extends boolean = false>(options: Options<EditCallRecordData, ThrowOnError>): RequestResult<EditCallRecordResponses, EditCallRecordErrors, ThrowOnError>;
|
|
319
|
+
/**
|
|
320
|
+
* Handler for `POST /call/record/{call_id}/decline`.
|
|
321
|
+
*
|
|
322
|
+
* Declines the identified active call for the caller without joining it.
|
|
323
|
+
* Bound to `call_id` so a stale incoming-call UI cannot decline a newer call
|
|
324
|
+
* that replaced it in the same channel. The caller's other devices are told
|
|
325
|
+
* to stop ringing (`call_declined`); the call continues for everyone else.
|
|
326
|
+
*/
|
|
327
|
+
declineCall<ThrowOnError extends boolean = false>(options: Options<DeclineCallData, ThrowOnError>): RequestResult<DeclineCallResponses, DeclineCallErrors, ThrowOnError>;
|
|
328
|
+
/**
|
|
329
|
+
* Join a live call by its session id.
|
|
330
|
+
*/
|
|
331
|
+
joinCall<ThrowOnError extends boolean = false>(options: Options<JoinCallData, ThrowOnError>): RequestResult<JoinCallResponses, JoinCallErrors, ThrowOnError>;
|
|
332
|
+
/**
|
|
333
|
+
* Leave a specific live call.
|
|
334
|
+
*/
|
|
335
|
+
leaveCall<ThrowOnError extends boolean = false>(options: Options<LeaveCallData, ThrowOnError>): RequestResult<LeaveCallResponses, LeaveCallErrors, ThrowOnError>;
|
|
336
|
+
/**
|
|
337
|
+
* Handle `POST /call/record/{call_id}/link` through the call domain service.
|
|
338
|
+
*/
|
|
339
|
+
meetingShare<ThrowOnError extends boolean = false>(options: Options<MeetingShareData, ThrowOnError>): RequestResult<MeetingShareResponses, MeetingShareErrors, ThrowOnError>;
|
|
340
|
+
/**
|
|
341
|
+
* Read live participants and track state for a joinable call.
|
|
342
|
+
*/
|
|
343
|
+
getCallParticipants<ThrowOnError extends boolean = false>(options: Options<GetCallParticipantsData, ThrowOnError>): RequestResult<GetCallParticipantsResponses, GetCallParticipantsErrors, ThrowOnError>;
|
|
344
|
+
/**
|
|
345
|
+
* Stream the recording bytes for a call record the caller may view.
|
|
346
|
+
*/
|
|
347
|
+
getCallRecording<ThrowOnError extends boolean = false>(options: Options<GetCallRecordingData, ThrowOnError>): RequestResult<GetCallRecordingResponses, GetCallRecordingErrors, ThrowOnError>;
|
|
348
|
+
/**
|
|
349
|
+
* Read this account's ring state for a call.
|
|
350
|
+
*/
|
|
351
|
+
getCallRingState<ThrowOnError extends boolean = false>(options: Options<GetCallRingStateData, ThrowOnError>): RequestResult<GetCallRingStateResponses, unknown, ThrowOnError>;
|
|
352
|
+
/**
|
|
353
|
+
* Handler for `POST /call/record/{call_id}/share-with-team/toggle`.
|
|
354
|
+
*
|
|
355
|
+
* Flips the live call's share-with-team toggle and returns the new value as
|
|
356
|
+
* the JSON body. The toggle is applied as canonical team sharing (View for
|
|
357
|
+
* the creator's team) when the call is archived; archived calls answer 409
|
|
358
|
+
* and are edited through `PATCH /call/record/{call_id}` instead.
|
|
359
|
+
*/
|
|
360
|
+
toggleShareWithTeam<ThrowOnError extends boolean = false>(options: Options<ToggleShareWithTeamData, ThrowOnError>): RequestResult<ToggleShareWithTeamResponses, ToggleShareWithTeamErrors, ThrowOnError>;
|
|
361
|
+
/**
|
|
362
|
+
* Handler for `PATCH /call/record/{call_id}/transcript`.
|
|
363
|
+
*
|
|
364
|
+
* Applies per-diarized-speaker `custom_speaker` overrides to the call's
|
|
365
|
+
* archived transcript rows. Auth uses the same `EditAccessLevel` extractor
|
|
366
|
+
* as `edit_call_record_handler`.
|
|
367
|
+
*/
|
|
368
|
+
editCallTranscript<ThrowOnError extends boolean = false>(options: Options<EditCallTranscriptData, ThrowOnError>): RequestResult<EditCallTranscriptResponses, EditCallTranscriptErrors, ThrowOnError>;
|
|
369
|
+
/**
|
|
370
|
+
* Handler for `GET /call/ring-status/{call_id}`.
|
|
371
|
+
*
|
|
372
|
+
* Reports whether the authenticated user should keep ringing for the call.
|
|
373
|
+
* Polled by native clients while the CallKit incoming-call UI is showing, so
|
|
374
|
+
* a ring can be cancelled when the user answers on another device
|
|
375
|
+
* (`answered`) or the call ends before anyone answers (`ended`).
|
|
376
|
+
*
|
|
377
|
+
* Outside the user-auth layer: the bearer credential is the recipient's
|
|
378
|
+
* LiveKit JWT from the VoIP push payload, verified with the LiveKit secret.
|
|
379
|
+
*/
|
|
380
|
+
getRingStatus<ThrowOnError extends boolean = false>(options: Options<GetRingStatusData, ThrowOnError>): RequestResult<GetRingStatusResponses, GetRingStatusErrors, ThrowOnError>;
|
|
381
|
+
/**
|
|
382
|
+
* Handler for `POST /call/ring-status/{call_id}/decline`.
|
|
383
|
+
*
|
|
384
|
+
* Declines a ringing call from a native client, e.g. the iPhone lock-screen
|
|
385
|
+
* decline button, so the user's other devices stop ringing. Authorized like
|
|
386
|
+
* [`ring_status_handler`]: the bearer credential is the recipient's LiveKit
|
|
387
|
+
* JWT from the VoIP push payload, which identifies both the room and the
|
|
388
|
+
* declining user.
|
|
389
|
+
*/
|
|
390
|
+
declineRing<ThrowOnError extends boolean = false>(options: Options<DeclineRingData, ThrowOnError>): RequestResult<DeclineRingResponses, DeclineRingErrors, ThrowOnError>;
|
|
391
|
+
/**
|
|
392
|
+
* Handler for `POST /call/webhook`.
|
|
393
|
+
*
|
|
394
|
+
* Receives webhook events from the RTC provider (e.g. LiveKit).
|
|
395
|
+
* The `Authorization` header contains the webhook auth token
|
|
396
|
+
* and the body contains the raw event payload.
|
|
397
|
+
*/
|
|
398
|
+
callWebhook<ThrowOnError extends boolean = false>(options?: Options<CallWebhookData, ThrowOnError>): RequestResult<CallWebhookResponses, CallWebhookErrors, ThrowOnError>;
|
|
399
|
+
/**
|
|
400
|
+
* Handler for `DELETE /call/{channel_id}`.
|
|
401
|
+
*/
|
|
402
|
+
leaveOrEndCall<ThrowOnError extends boolean = false>(options: Options<LeaveOrEndCallData, ThrowOnError>): RequestResult<LeaveOrEndCallResponses, LeaveOrEndCallErrors, ThrowOnError>;
|
|
403
|
+
/**
|
|
404
|
+
* Handler for `GET /call/{channel_id}`.
|
|
405
|
+
*
|
|
406
|
+
* Gets or creates a call for the channel. If a call already exists, joins it;
|
|
407
|
+
* otherwise creates a new one. Always returns a join token.
|
|
408
|
+
*/
|
|
409
|
+
getOrCreateCall<ThrowOnError extends boolean = false>(options: Options<GetOrCreateCallData, ThrowOnError>): RequestResult<GetOrCreateCallResponses, GetOrCreateCallErrors, ThrowOnError>;
|
|
410
|
+
/**
|
|
411
|
+
* Start or join a channel call explicitly.
|
|
412
|
+
*/
|
|
413
|
+
startCall<ThrowOnError extends boolean = false>(options: Options<StartCallData, ThrowOnError>): RequestResult<StartCallResponses, StartCallErrors, ThrowOnError>;
|
|
414
|
+
/**
|
|
415
|
+
* Handler for `GET /call/{channel_id}/active`.
|
|
416
|
+
*
|
|
417
|
+
* Returns 200 with call info if an active call exists, or 204 No Content if not.
|
|
418
|
+
*/
|
|
419
|
+
checkActiveCall<ThrowOnError extends boolean = false>(options: Options<CheckActiveCallData, ThrowOnError>): RequestResult<CheckActiveCallResponses, CheckActiveCallErrors, ThrowOnError>;
|
|
420
|
+
/**
|
|
421
|
+
* Handler for `POST /call/{channel_id}/transcript`.
|
|
422
|
+
*
|
|
423
|
+
* Receives transcript segments from the transcription agent.
|
|
424
|
+
* Authenticated via the `x-macro-internal-call` shared secret.
|
|
425
|
+
* Duplicate segments (same `segment_id`) are ignored.
|
|
426
|
+
*/
|
|
427
|
+
ingestTranscript<ThrowOnError extends boolean = false>(options: Options<IngestTranscriptData, ThrowOnError>): RequestResult<IngestTranscriptResponses, IngestTranscriptErrors, ThrowOnError>;
|
|
428
|
+
/**
|
|
429
|
+
* List the caller's shared or private labels.
|
|
430
|
+
*/
|
|
431
|
+
listChannelLabels<ThrowOnError extends boolean = false>(options?: Options<ListChannelLabelsData, ThrowOnError>): RequestResult<ListChannelLabelsResponses, ListChannelLabelsErrors, ThrowOnError>;
|
|
432
|
+
/**
|
|
433
|
+
* Create a label for the caller's authorized scope.
|
|
434
|
+
*/
|
|
435
|
+
createChannelLabel<ThrowOnError extends boolean = false>(options: Options<CreateChannelLabelData, ThrowOnError>): RequestResult<CreateChannelLabelResponses, CreateChannelLabelErrors, ThrowOnError>;
|
|
436
|
+
/**
|
|
437
|
+
* Move a channel into a label of the caller's authorized scope, or out of any label.
|
|
438
|
+
*/
|
|
439
|
+
setChannelLabel<ThrowOnError extends boolean = false>(options: Options<SetChannelLabelData, ThrowOnError>): RequestResult<SetChannelLabelResponses, SetChannelLabelErrors, ThrowOnError>;
|
|
440
|
+
/**
|
|
441
|
+
* Preview visible channels matched by a smart tag, without creating it.
|
|
442
|
+
*/
|
|
443
|
+
previewSmartTag<ThrowOnError extends boolean = false>(options: Options<PreviewSmartTagData, ThrowOnError>): RequestResult<PreviewSmartTagResponses, PreviewSmartTagErrors, ThrowOnError>;
|
|
444
|
+
/**
|
|
445
|
+
* Delete a label of the caller's authorized scope. Its channels return to the plain list.
|
|
446
|
+
*/
|
|
447
|
+
deleteChannelLabel<ThrowOnError extends boolean = false>(options: Options<DeleteChannelLabelData, ThrowOnError>): RequestResult<DeleteChannelLabelResponses, DeleteChannelLabelErrors, ThrowOnError>;
|
|
448
|
+
/**
|
|
449
|
+
* Update a label, optionally moving it to another authorized scope.
|
|
450
|
+
*/
|
|
451
|
+
renameChannelLabel<ThrowOnError extends boolean = false>(options: Options<RenameChannelLabelData, ThrowOnError>): RequestResult<RenameChannelLabelResponses, RenameChannelLabelErrors, ThrowOnError>;
|
|
452
|
+
/**
|
|
453
|
+
* List the caller's shared or private labels.
|
|
454
|
+
*/
|
|
455
|
+
listChannelSections<ThrowOnError extends boolean = false>(options?: Options<ListChannelSectionsData, ThrowOnError>): RequestResult<ListChannelSectionsResponses, ListChannelSectionsErrors, ThrowOnError>;
|
|
456
|
+
/**
|
|
457
|
+
* Create a label for the caller's authorized scope.
|
|
458
|
+
*/
|
|
459
|
+
createChannelSection<ThrowOnError extends boolean = false>(options: Options<CreateChannelSectionData, ThrowOnError>): RequestResult<CreateChannelSectionResponses, CreateChannelSectionErrors, ThrowOnError>;
|
|
460
|
+
/**
|
|
461
|
+
* Move a channel into a label of the caller's authorized scope, or out of any label.
|
|
462
|
+
*/
|
|
463
|
+
setChannelSection<ThrowOnError extends boolean = false>(options: Options<SetChannelSectionData, ThrowOnError>): RequestResult<SetChannelSectionResponses, SetChannelSectionErrors, ThrowOnError>;
|
|
464
|
+
/**
|
|
465
|
+
* Preview visible channels matched by a smart tag, without creating it.
|
|
466
|
+
*/
|
|
467
|
+
previewChannelSection<ThrowOnError extends boolean = false>(options: Options<PreviewChannelSectionData, ThrowOnError>): RequestResult<PreviewChannelSectionResponses, PreviewChannelSectionErrors, ThrowOnError>;
|
|
468
|
+
/**
|
|
469
|
+
* Delete a label of the caller's authorized scope. Its channels return to the plain list.
|
|
470
|
+
*/
|
|
471
|
+
deleteChannelSection<ThrowOnError extends boolean = false>(options: Options<DeleteChannelSectionData, ThrowOnError>): RequestResult<DeleteChannelSectionResponses, DeleteChannelSectionErrors, ThrowOnError>;
|
|
472
|
+
/**
|
|
473
|
+
* Update a label, optionally moving it to another authorized scope.
|
|
474
|
+
*/
|
|
475
|
+
updateChannelSection<ThrowOnError extends boolean = false>(options: Options<UpdateChannelSectionData, ThrowOnError>): RequestResult<UpdateChannelSectionResponses, UpdateChannelSectionErrors, ThrowOnError>;
|
|
476
|
+
/**
|
|
477
|
+
* Handler for `POST /channels`.
|
|
478
|
+
*/
|
|
479
|
+
createChannel<ThrowOnError extends boolean = false>(options: Options<CreateChannelData, ThrowOnError>): RequestResult<CreateChannelResponses, CreateChannelErrors, ThrowOnError>;
|
|
480
|
+
/**
|
|
481
|
+
* Handler for `GET /channels/activity`.
|
|
482
|
+
*/
|
|
483
|
+
getActivity<ThrowOnError extends boolean = false>(options?: Options<GetActivityData, ThrowOnError>): RequestResult<GetActivityResponses, GetActivityErrors, ThrowOnError>;
|
|
484
|
+
/**
|
|
485
|
+
* Handler for `POST /channels/activity`.
|
|
486
|
+
*/
|
|
487
|
+
postActivity<ThrowOnError extends boolean = false>(options: Options<PostActivityData, ThrowOnError>): RequestResult<PostActivityResponses, PostActivityErrors, ThrowOnError>;
|
|
488
|
+
/**
|
|
489
|
+
* Handler for `GET /channels/attachments/{entity_type}/{entity_id}/references`.
|
|
490
|
+
*/
|
|
491
|
+
getAttachmentReferences<ThrowOnError extends boolean = false>(options: Options<GetAttachmentReferencesData, ThrowOnError>): RequestResult<GetAttachmentReferencesResponses, GetAttachmentReferencesErrors, ThrowOnError>;
|
|
492
|
+
/**
|
|
493
|
+
* Handler for `POST /channels/get_or_create_dm`.
|
|
494
|
+
*/
|
|
495
|
+
getOrCreateDm<ThrowOnError extends boolean = false>(options: Options<GetOrCreateDmData, ThrowOnError>): RequestResult<GetOrCreateDmResponses, GetOrCreateDmErrors, ThrowOnError>;
|
|
496
|
+
/**
|
|
497
|
+
* Handler for `POST /channels/get_or_create_private`.
|
|
498
|
+
*/
|
|
499
|
+
getOrCreatePrivate<ThrowOnError extends boolean = false>(options: Options<GetOrCreatePrivateData, ThrowOnError>): RequestResult<GetOrCreatePrivateResponses, GetOrCreatePrivateErrors, ThrowOnError>;
|
|
500
|
+
/**
|
|
501
|
+
* Handler for `POST /channels/join/{join_code}`.
|
|
502
|
+
*/
|
|
503
|
+
joinChannelByCode<ThrowOnError extends boolean = false>(options: Options<JoinChannelByCodeData, ThrowOnError>): RequestResult<JoinChannelByCodeResponses, JoinChannelByCodeErrors, ThrowOnError>;
|
|
504
|
+
/**
|
|
505
|
+
* Handler for `POST /channels/mentions`.
|
|
506
|
+
*/
|
|
507
|
+
createEntityMention<ThrowOnError extends boolean = false>(options: Options<CreateEntityMentionData, ThrowOnError>): RequestResult<CreateEntityMentionResponses, CreateEntityMentionErrors, ThrowOnError>;
|
|
508
|
+
/**
|
|
509
|
+
* Handler for `DELETE /channels/mentions/{mention_id}`.
|
|
510
|
+
*/
|
|
511
|
+
deleteEntityMention<ThrowOnError extends boolean = false>(options: Options<DeleteEntityMentionData, ThrowOnError>): RequestResult<DeleteEntityMentionResponses, DeleteEntityMentionErrors, ThrowOnError>;
|
|
512
|
+
/**
|
|
513
|
+
* Handler for `POST /channels/preview`.
|
|
514
|
+
*/
|
|
515
|
+
getBatchChannelPreview<ThrowOnError extends boolean = false>(options: Options<GetBatchChannelPreviewData, ThrowOnError>): RequestResult<GetBatchChannelPreviewResponses, GetBatchChannelPreviewErrors, ThrowOnError>;
|
|
516
|
+
/**
|
|
517
|
+
* Handler for `DELETE /channels/{channel_id}`.
|
|
518
|
+
*/
|
|
519
|
+
deleteChannel<ThrowOnError extends boolean = false>(options: Options<DeleteChannelData, ThrowOnError>): RequestResult<DeleteChannelResponses, DeleteChannelErrors, ThrowOnError>;
|
|
520
|
+
/**
|
|
521
|
+
* Handler for `GET /channels/{channel_id}`.
|
|
522
|
+
*/
|
|
523
|
+
getChannel<ThrowOnError extends boolean = false>(options: Options<GetChannelData, ThrowOnError>): RequestResult<GetChannelResponses, GetChannelErrors, ThrowOnError>;
|
|
524
|
+
/**
|
|
525
|
+
* Handler for `PATCH /channels/{channel_id}`.
|
|
526
|
+
*/
|
|
527
|
+
patchChannel<ThrowOnError extends boolean = false>(options: Options<PatchChannelData, ThrowOnError>): RequestResult<PatchChannelResponses, PatchChannelErrors, ThrowOnError>;
|
|
528
|
+
/**
|
|
529
|
+
* Handler for `DELETE /channels/{channel_id}/access-requests/mine`.
|
|
530
|
+
*/
|
|
531
|
+
cancelChannelAccessRequest<ThrowOnError extends boolean = false>(options: Options<CancelChannelAccessRequestData, ThrowOnError>): RequestResult<CancelChannelAccessRequestResponses, CancelChannelAccessRequestErrors, ThrowOnError>;
|
|
532
|
+
/**
|
|
533
|
+
* Handler for `GET /channels/{channel_id}/access-requests/mine`.
|
|
534
|
+
*/
|
|
535
|
+
getMyChannelAccessRequest<ThrowOnError extends boolean = false>(options: Options<GetMyChannelAccessRequestData, ThrowOnError>): RequestResult<GetMyChannelAccessRequestResponses, GetMyChannelAccessRequestErrors, ThrowOnError>;
|
|
536
|
+
/**
|
|
537
|
+
* Handler for `PUT /channels/{channel_id}/access-requests/mine`.
|
|
538
|
+
*/
|
|
539
|
+
requestChannelAccess<ThrowOnError extends boolean = false>(options: Options<RequestChannelAccessData, ThrowOnError>): RequestResult<RequestChannelAccessResponses, RequestChannelAccessErrors, ThrowOnError>;
|
|
540
|
+
/**
|
|
541
|
+
* Handler for `GET /channels/{channel_id}/access-requests/{request_id}`.
|
|
542
|
+
*/
|
|
543
|
+
getChannelAccessRequest<ThrowOnError extends boolean = false>(options: Options<GetChannelAccessRequestData, ThrowOnError>): RequestResult<GetChannelAccessRequestResponses, GetChannelAccessRequestErrors, ThrowOnError>;
|
|
544
|
+
/**
|
|
545
|
+
* Handler for `POST /channels/{channel_id}/access-requests/{request_id}/resolve`.
|
|
546
|
+
*/
|
|
547
|
+
resolveChannelAccessRequest<ThrowOnError extends boolean = false>(options: Options<ResolveChannelAccessRequestData, ThrowOnError>): RequestResult<ResolveChannelAccessRequestResponses, ResolveChannelAccessRequestErrors, ThrowOnError>;
|
|
548
|
+
/**
|
|
549
|
+
* Handler for `GET /channels/{channel_id}/attachments`.
|
|
550
|
+
*/
|
|
551
|
+
getChannelAttachments<ThrowOnError extends boolean = false>(options: Options<GetChannelAttachmentsData, ThrowOnError>): RequestResult<GetChannelAttachmentsResponses, GetChannelAttachmentsErrors, ThrowOnError>;
|
|
552
|
+
/**
|
|
553
|
+
* Handler for `GET /channels/{channel_id}/bots`.
|
|
554
|
+
*/
|
|
555
|
+
listChannelBots<ThrowOnError extends boolean = false>(options: Options<ListChannelBotsData, ThrowOnError>): RequestResult<ListChannelBotsResponses, ListChannelBotsErrors, ThrowOnError>;
|
|
556
|
+
/**
|
|
557
|
+
* Handler for `POST /channels/{channel_id}/bots`.
|
|
558
|
+
*/
|
|
559
|
+
addChannelBot<ThrowOnError extends boolean = false>(options: Options<AddChannelBotData, ThrowOnError>): RequestResult<AddChannelBotResponses, AddChannelBotErrors, ThrowOnError>;
|
|
560
|
+
/**
|
|
561
|
+
* Handler for `POST /channels/{channel_id}/bots/scoped`.
|
|
562
|
+
*/
|
|
563
|
+
createChannelScopedBot<ThrowOnError extends boolean = false>(options: Options<CreateChannelScopedBotData, ThrowOnError>): RequestResult<CreateChannelScopedBotResponses, CreateChannelScopedBotErrors, ThrowOnError>;
|
|
564
|
+
/**
|
|
565
|
+
* Handler for `POST /channels/{channel_id}/join`.
|
|
566
|
+
*/
|
|
567
|
+
joinChannel<ThrowOnError extends boolean = false>(options: Options<JoinChannelData, ThrowOnError>): RequestResult<JoinChannelResponses, JoinChannelErrors, ThrowOnError>;
|
|
568
|
+
/**
|
|
569
|
+
* Handler for `GET /channels/{channel_id}/join-link`.
|
|
570
|
+
*/
|
|
571
|
+
getChannelJoinLink<ThrowOnError extends boolean = false>(options: Options<GetChannelJoinLinkData, ThrowOnError>): RequestResult<GetChannelJoinLinkResponses, GetChannelJoinLinkErrors, ThrowOnError>;
|
|
572
|
+
/**
|
|
573
|
+
* Handler for `POST /channels/{channel_id}/leave`.
|
|
574
|
+
*/
|
|
575
|
+
leaveChannel<ThrowOnError extends boolean = false>(options: Options<LeaveChannelData, ThrowOnError>): RequestResult<LeaveChannelResponses, LeaveChannelErrors, ThrowOnError>;
|
|
576
|
+
/**
|
|
577
|
+
* Handler for `DELETE /channels/{channel_id}/participants`.
|
|
578
|
+
*/
|
|
579
|
+
removeParticipants<ThrowOnError extends boolean = false>(options: Options<RemoveParticipantsData, ThrowOnError>): RequestResult<RemoveParticipantsResponses, RemoveParticipantsErrors, ThrowOnError>;
|
|
580
|
+
/**
|
|
581
|
+
* Handler for `GET /channels/{channel_id}/participants`.
|
|
582
|
+
*/
|
|
583
|
+
getChannelParticipants<ThrowOnError extends boolean = false>(options: Options<GetChannelParticipantsData, ThrowOnError>): RequestResult<GetChannelParticipantsResponses, GetChannelParticipantsErrors, ThrowOnError>;
|
|
584
|
+
/**
|
|
585
|
+
* Handler for `POST /channels/{channel_id}/participants`.
|
|
586
|
+
*/
|
|
587
|
+
addParticipants<ThrowOnError extends boolean = false>(options: Options<AddParticipantsData, ThrowOnError>): RequestResult<AddParticipantsResponses, AddParticipantsErrors, ThrowOnError>;
|
|
588
|
+
/**
|
|
589
|
+
* Set a channel or group chat profile picture. Requires channel participation.
|
|
590
|
+
*/
|
|
591
|
+
setChannelPicture<ThrowOnError extends boolean = false>(options: Options<SetChannelPictureData, ThrowOnError>): RequestResult<SetChannelPictureResponses, SetChannelPictureErrors, ThrowOnError>;
|
|
592
|
+
/**
|
|
593
|
+
* Handler for `POST /channels/{channel_id}/shares`.
|
|
594
|
+
*
|
|
595
|
+
* Grants the channel's current members access to one item, the way posting
|
|
596
|
+
* it in a message does. Calendar events can be shared only from the caller's
|
|
597
|
+
* own calendar, and private or confidential events are refused. Sharing again
|
|
598
|
+
* is a no-op.
|
|
599
|
+
*/
|
|
600
|
+
shareWithChannel<ThrowOnError extends boolean = false>(options: Options<ShareWithChannelData, ThrowOnError>): RequestResult<ShareWithChannelResponses, ShareWithChannelErrors, ThrowOnError>;
|
|
601
|
+
/**
|
|
602
|
+
* Handler for `POST /channels/{channel_id}/webhook`.
|
|
603
|
+
*/
|
|
604
|
+
postChannelBotWebhook<ThrowOnError extends boolean = false>(options: Options<PostChannelBotWebhookData, ThrowOnError>): RequestResult<PostChannelBotWebhookResponses, PostChannelBotWebhookErrors, ThrowOnError>;
|
|
605
|
+
/**
|
|
606
|
+
* Soft-delete a collab surface.
|
|
607
|
+
*/
|
|
608
|
+
deleteCollabSurface<ThrowOnError extends boolean = false>(options: Options<DeleteCollabSurfaceData, ThrowOnError>): RequestResult<DeleteCollabSurfaceResponses, DeleteCollabSurfaceErrors, ThrowOnError>;
|
|
609
|
+
/**
|
|
610
|
+
* Fetch a collab surface.
|
|
611
|
+
*/
|
|
612
|
+
getCollabSurface<ThrowOnError extends boolean = false>(options: Options<GetCollabSurfaceData, ThrowOnError>): RequestResult<GetCollabSurfaceResponses, GetCollabSurfaceErrors, ThrowOnError>;
|
|
613
|
+
/**
|
|
614
|
+
* Idempotently ensure a collab surface exists (load-or-create).
|
|
615
|
+
*
|
|
616
|
+
* The id is caller-supplied, so an embedding surface can hold a stable id
|
|
617
|
+
* and blindly ensure it on mount: the first ensure creates and initializes
|
|
618
|
+
* the session, every later one (including concurrent ones) returns the same
|
|
619
|
+
* surface. A soft-deleted id is `410 Gone` and never comes back.
|
|
620
|
+
*/
|
|
621
|
+
ensureCollabSurface<ThrowOnError extends boolean = false>(options: Options<EnsureCollabSurfaceData, ThrowOnError>): RequestResult<EnsureCollabSurfaceResponses, EnsureCollabSurfaceErrors, ThrowOnError>;
|
|
622
|
+
/**
|
|
623
|
+
* Mint a sync-service connection token for a surface.
|
|
624
|
+
*/
|
|
625
|
+
createCollabSurfaceToken<ThrowOnError extends boolean = false>(options: Options<CreateCollabSurfaceTokenData, ThrowOnError>): RequestResult<CreateCollabSurfaceTokenResponses, CreateCollabSurfaceTokenErrors, ThrowOnError>;
|
|
626
|
+
/**
|
|
627
|
+
* Handle channel list requests for `GET /comms/channels`.
|
|
628
|
+
*/
|
|
629
|
+
getChannels<ThrowOnError extends boolean = false>(options?: Options<GetChannelsData, ThrowOnError>): RequestResult<GetChannelsResponses, GetChannelsErrors, ThrowOnError>;
|
|
630
|
+
/**
|
|
631
|
+
* List the domains the caller's team keeps out of email sync,
|
|
632
|
+
* alphabetically. Any team member may read.
|
|
633
|
+
*/
|
|
634
|
+
listCrmBlockedDomains<ThrowOnError extends boolean = false>(options?: Options<ListCrmBlockedDomainsData, ThrowOnError>): RequestResult<ListCrmBlockedDomainsResponses, ListCrmBlockedDomainsErrors, ThrowOnError>;
|
|
635
|
+
/**
|
|
636
|
+
* Remove a team domain exclusion and schedule eligible email backfill,
|
|
637
|
+
* preserving record visibility. Idempotent. Requires an admin/owner role (403).
|
|
638
|
+
*/
|
|
639
|
+
unblockCrmDomain<ThrowOnError extends boolean = false>(options: Options<UnblockCrmDomainData, ThrowOnError>): RequestResult<UnblockCrmDomainResponses, UnblockCrmDomainErrors, ThrowOnError>;
|
|
640
|
+
/**
|
|
641
|
+
* Block a domain and its subdomains from email contributions, preserving records.
|
|
642
|
+
* Refuses a domain covering any member's connected primary mailbox (400).
|
|
643
|
+
* Idempotent for permitted domains. Requires an admin/owner team role (403).
|
|
644
|
+
*/
|
|
645
|
+
blockCrmDomain<ThrowOnError extends boolean = false>(options: Options<BlockCrmDomainData, ThrowOnError>): RequestResult<BlockCrmDomainResponses, BlockCrmDomainErrors, ThrowOnError>;
|
|
646
|
+
/**
|
|
647
|
+
* Manually create a CRM company for the caller's team. Any team member
|
|
648
|
+
* may create one. A domain, when given, must not already be tracked by the team
|
|
649
|
+
* (409), and the team's CRM killswitch must be on (403). Returns the
|
|
650
|
+
* created company in the same shape as `GET /crm/companies/{id}` (its
|
|
651
|
+
* contact list is empty until emails populate it).
|
|
652
|
+
*/
|
|
653
|
+
createCrmCompany<ThrowOnError extends boolean = false>(options: Options<CreateCrmCompanyData, ThrowOnError>): RequestResult<CreateCrmCompanyResponses, CreateCrmCompanyErrors, ThrowOnError>;
|
|
654
|
+
/**
|
|
655
|
+
* Create the companies a CSV lists, and put its Stage, Owner and Revenue
|
|
656
|
+
* values on entries of a company pipeline.
|
|
657
|
+
*/
|
|
658
|
+
importCrmCompaniesCsv<ThrowOnError extends boolean = false>(options: Options<ImportCrmCompaniesCsvData, ThrowOnError>): RequestResult<ImportCrmCompaniesCsvResponses, ImportCrmCompaniesCsvErrors, ThrowOnError>;
|
|
659
|
+
/**
|
|
660
|
+
* Fetch a single CRM company by id, hydrated with its domains, the
|
|
661
|
+
* primary domain's directory display metadata (name + description),
|
|
662
|
+
* and the company's contacts. Access is enforced by
|
|
663
|
+
* [`CrmCompanyAccessLevelExtractor`]: the user must be on the team
|
|
664
|
+
* that owns the company, and hidden companies are invisible to plain
|
|
665
|
+
* members. Admin/owner callers see hidden companies and contacts so
|
|
666
|
+
* they can render the right unhide UI.
|
|
667
|
+
*/
|
|
668
|
+
getCompany<ThrowOnError extends boolean = false>(options: Options<GetCompanyData, ThrowOnError>): RequestResult<GetCompanyResponses, GetCompanyErrors, ThrowOnError>;
|
|
669
|
+
/**
|
|
670
|
+
* List the contacts of a CRM company. Access is enforced by
|
|
671
|
+
* [`CrmCompanyAccessLevelExtractor`]: the user must be on the team that
|
|
672
|
+
* owns the company. Hidden companies and hidden contacts are invisible
|
|
673
|
+
* to plain members; admin/owner callers see hidden rows so they can
|
|
674
|
+
* render the right unhide UI.
|
|
675
|
+
*/
|
|
676
|
+
listCompanyContacts<ThrowOnError extends boolean = false>(options: Options<ListCompanyContactsData, ThrowOnError>): RequestResult<ListCompanyContactsResponses, ListCompanyContactsErrors, ThrowOnError>;
|
|
677
|
+
/**
|
|
678
|
+
* Manually create a contact under a CRM company. Access is enforced by
|
|
679
|
+
* [`CrmCompanyAccessLevelExtractor`]: the caller must be on the team
|
|
680
|
+
* that owns the company (hidden companies are reachable for
|
|
681
|
+
* admin/owner only, and the new contact then inherits `hidden`). The
|
|
682
|
+
* company must not already track the email (409), and the team's CRM
|
|
683
|
+
* killswitch must be on (403).
|
|
684
|
+
*/
|
|
685
|
+
createCrmContact<ThrowOnError extends boolean = false>(options: Options<CreateCrmContactData, ThrowOnError>): RequestResult<CreateCrmContactResponses, CreateCrmContactErrors, ThrowOnError>;
|
|
686
|
+
/**
|
|
687
|
+
* List a CRM company's contacts a page at a time, filtered by archive
|
|
688
|
+
* state and an optional name or email search. Access is enforced by
|
|
689
|
+
* [`CrmCompanyAccessLevelExtractor`] as for
|
|
690
|
+
* `GET /crm/companies/{company_id}/contacts`; hidden contacts are
|
|
691
|
+
* invisible to plain members.
|
|
692
|
+
*/
|
|
693
|
+
listCompanyContactsPage<ThrowOnError extends boolean = false>(options: Options<ListCompanyContactsPageData, ThrowOnError>): RequestResult<ListCompanyContactsPageResponses, ListCompanyContactsPageErrors, ThrowOnError>;
|
|
694
|
+
/**
|
|
695
|
+
* Toggle email contribution for a CRM company without archiving its records.
|
|
696
|
+
* Individual consent and all remaining exclusions still apply.
|
|
697
|
+
*/
|
|
698
|
+
setEmailSync<ThrowOnError extends boolean = false>(options: Options<SetEmailSyncData, ThrowOnError>): RequestResult<SetEmailSyncResponses, SetEmailSyncErrors, ThrowOnError>;
|
|
699
|
+
/**
|
|
700
|
+
* Toggle `hidden` on a CRM company. Hiding also disables
|
|
701
|
+
* `email_sync` and soft-hides every contact under the company.
|
|
702
|
+
* Un-hide restores contact visibility only; `email_sync` is left
|
|
703
|
+
* untouched (the team must re-enable it explicitly). Contact rows
|
|
704
|
+
* and contact sources survive the cycle.
|
|
705
|
+
*/
|
|
706
|
+
setCompanyHidden<ThrowOnError extends boolean = false>(options: Options<SetCompanyHiddenData, ThrowOnError>): RequestResult<SetCompanyHiddenResponses, SetCompanyHiddenErrors, ThrowOnError>;
|
|
707
|
+
/**
|
|
708
|
+
* Rename a CRM company. Access is enforced by
|
|
709
|
+
* [`CrmCompanyAccessLevelExtractor`]: the caller must be on the team
|
|
710
|
+
* that owns the company (hidden companies are reachable for
|
|
711
|
+
* admin/owner only). The name is a team-scoped override
|
|
712
|
+
* (`custom_name`) and never touches the global domain directory.
|
|
713
|
+
*/
|
|
714
|
+
setCrmCompanyName<ThrowOnError extends boolean = false>(options: Options<SetCrmCompanyNameData, ThrowOnError>): RequestResult<SetCrmCompanyNameResponses, SetCrmCompanyNameErrors, ThrowOnError>;
|
|
715
|
+
/**
|
|
716
|
+
* Search the caller's team's CRM contacts by email or name. Any team member
|
|
717
|
+
* may search visible contacts; admin/owner callers also match hidden
|
|
718
|
+
* contacts and contacts under hidden companies.
|
|
719
|
+
*/
|
|
720
|
+
searchContacts<ThrowOnError extends boolean = false>(options?: Options<SearchContactsData, ThrowOnError>): RequestResult<SearchContactsResponses, SearchContactsErrors, ThrowOnError>;
|
|
721
|
+
/**
|
|
722
|
+
* Manually create a contact without a company for the caller's team.
|
|
723
|
+
* Any team member may create one. The team must not already have a
|
|
724
|
+
* company-less contact with the email (409), and the team's CRM
|
|
725
|
+
* killswitch must be on (403).
|
|
726
|
+
*/
|
|
727
|
+
createCrmTeamContact<ThrowOnError extends boolean = false>(options: Options<CreateCrmTeamContactData, ThrowOnError>): RequestResult<CreateCrmTeamContactResponses, CreateCrmTeamContactErrors, ThrowOnError>;
|
|
728
|
+
/**
|
|
729
|
+
* Look up a CRM contact by email in the caller's team. Returns a null
|
|
730
|
+
* `contact` when no visible contact exists. Any team member may resolve a
|
|
731
|
+
* visible contact; admin/owner callers may also resolve hidden contacts and
|
|
732
|
+
* contacts under hidden companies. Returns 400 when several visible contacts
|
|
733
|
+
* match; callers must choose an explicit contact ID instead.
|
|
734
|
+
*/
|
|
735
|
+
getContactByEmail<ThrowOnError extends boolean = false>(options: Options<GetContactByEmailData, ThrowOnError>): RequestResult<GetContactByEmailResponses, GetContactByEmailErrors, ThrowOnError>;
|
|
736
|
+
/**
|
|
737
|
+
* Fetch a single CRM contact by id, with its company's name and
|
|
738
|
+
* visibility. Access is enforced by [`CrmContactAccessLevelExtractor`]:
|
|
739
|
+
* the user must be on the team that owns the contact, and hidden
|
|
740
|
+
* contacts are invisible to plain members. Admin/owner callers see
|
|
741
|
+
* hidden contacts so they can render the right unhide UI.
|
|
742
|
+
*/
|
|
743
|
+
getContact<ThrowOnError extends boolean = false>(options: Options<GetContactData, ThrowOnError>): RequestResult<GetContactResponses, GetContactErrors, ThrowOnError>;
|
|
744
|
+
/**
|
|
745
|
+
* Remove a contact's company link. A contact with an address on one of its
|
|
746
|
+
* company's domains cannot be unlinked. Idempotent.
|
|
747
|
+
*/
|
|
748
|
+
unlinkCrmContactCompany<ThrowOnError extends boolean = false>(options: Options<UnlinkCrmContactCompanyData, ThrowOnError>): RequestResult<UnlinkCrmContactCompanyResponses, UnlinkCrmContactCompanyErrors, ThrowOnError>;
|
|
749
|
+
/**
|
|
750
|
+
* Update an existing team-owned contact without merging its identity.
|
|
751
|
+
*/
|
|
752
|
+
setCrmContactCompany<ThrowOnError extends boolean = false>(options: Options<SetCrmContactCompanyData, ThrowOnError>): RequestResult<SetCrmContactCompanyResponses, SetCrmContactCompanyErrors, ThrowOnError>;
|
|
753
|
+
/**
|
|
754
|
+
* Update an existing team-owned contact without merging its identity.
|
|
755
|
+
*/
|
|
756
|
+
setCrmContactEmail<ThrowOnError extends boolean = false>(options: Options<SetCrmContactEmailData, ThrowOnError>): RequestResult<SetCrmContactEmailResponses, SetCrmContactEmailErrors, ThrowOnError>;
|
|
757
|
+
/**
|
|
758
|
+
* Remove an address from a contact. Nothing else is deleted: the contact
|
|
759
|
+
* stops showing that address's email history. Removing the primary promotes
|
|
760
|
+
* the oldest address left. The last address on a domain of the contact's
|
|
761
|
+
* company cannot be removed while the contact is linked to it. Idempotent.
|
|
762
|
+
*/
|
|
763
|
+
removeCrmContactEmail<ThrowOnError extends boolean = false>(options: Options<RemoveCrmContactEmailData, ThrowOnError>): RequestResult<RemoveCrmContactEmailResponses, RemoveCrmContactEmailErrors, ThrowOnError>;
|
|
764
|
+
/**
|
|
765
|
+
* Add an address to a contact. It must not belong to another contact in the
|
|
766
|
+
* team, and becomes the primary only when the contact has none. Idempotent.
|
|
767
|
+
*/
|
|
768
|
+
addCrmContactEmail<ThrowOnError extends boolean = false>(options: Options<AddCrmContactEmailData, ThrowOnError>): RequestResult<AddCrmContactEmailResponses, AddCrmContactEmailErrors, ThrowOnError>;
|
|
769
|
+
/**
|
|
770
|
+
* Toggle `hidden` on a CRM contact. Hiding is a display-only opt-out
|
|
771
|
+
* scoped to the team that owns the contact's company.
|
|
772
|
+
*/
|
|
773
|
+
setContactHidden<ThrowOnError extends boolean = false>(options: Options<SetContactHiddenData, ThrowOnError>): RequestResult<SetContactHiddenResponses, SetContactHiddenErrors, ThrowOnError>;
|
|
774
|
+
/**
|
|
775
|
+
* Rename a CRM contact. Access is enforced by
|
|
776
|
+
* [`CrmContactAccessLevelExtractor`]: the caller must be on the team
|
|
777
|
+
* that owns the contact's company (hidden contacts are reachable for
|
|
778
|
+
* admin/owner only). The name overwrites the team-scoped
|
|
779
|
+
* `crm_contacts.name` column.
|
|
780
|
+
*/
|
|
781
|
+
setCrmContactName<ThrowOnError extends boolean = false>(options: Options<SetCrmContactNameData, ThrowOnError>): RequestResult<SetCrmContactNameResponses, SetCrmContactNameErrors, ThrowOnError>;
|
|
782
|
+
/**
|
|
783
|
+
* Read the caller's mailbox consent and both exclusion lists.
|
|
784
|
+
*/
|
|
785
|
+
getCrmEmailPrivacy<ThrowOnError extends boolean = false>(options?: Options<GetCrmEmailPrivacyData, ThrowOnError>): RequestResult<GetCrmEmailPrivacyResponses, unknown, ThrowOnError>;
|
|
786
|
+
/**
|
|
787
|
+
* Apply one consent, domain, or thread exclusion change as the member.
|
|
788
|
+
*/
|
|
789
|
+
updateCrmEmailPrivacy<ThrowOnError extends boolean = false>(options: Options<UpdateCrmEmailPrivacyData, ThrowOnError>): RequestResult<UpdateCrmEmailPrivacyResponses, unknown, ThrowOnError>;
|
|
790
|
+
/**
|
|
791
|
+
* Read sharing state without initializing consent or scheduling work.
|
|
792
|
+
*/
|
|
793
|
+
getCrmEmailPolicy<ThrowOnError extends boolean = false>(options?: Options<GetCrmEmailPolicyData, ThrowOnError>): RequestResult<GetCrmEmailPolicyResponses, unknown, ThrowOnError>;
|
|
794
|
+
/**
|
|
795
|
+
* Direct member/agent activation with CAS, idempotency and verified audit.
|
|
796
|
+
*/
|
|
797
|
+
updateCrmEmailPolicy<ThrowOnError extends boolean = false>(options: Options<UpdateCrmEmailPolicyData, ThrowOnError>): RequestResult<UpdateCrmEmailPolicyResponses, UpdateCrmEmailPolicyErrors, ThrowOnError>;
|
|
798
|
+
/**
|
|
799
|
+
* Read only the acting member's audit history.
|
|
800
|
+
*/
|
|
801
|
+
listCrmEmailPolicyHistory<ThrowOnError extends boolean = false>(options?: Options<ListCrmEmailPolicyHistoryData, ThrowOnError>): RequestResult<ListCrmEmailPolicyHistoryResponses, unknown, ThrowOnError>;
|
|
802
|
+
/**
|
|
803
|
+
* Inspect the owner's current count preview; no email content is returned.
|
|
804
|
+
*/
|
|
805
|
+
getCrmEmailRulePreview<ThrowOnError extends boolean = false>(options?: Options<GetCrmEmailRulePreviewData, ThrowOnError>): RequestResult<GetCrmEmailRulePreviewResponses, unknown, ThrowOnError>;
|
|
806
|
+
/**
|
|
807
|
+
* Start optional count-only work; this never initializes or activates consent.
|
|
808
|
+
*/
|
|
809
|
+
previewCrmEmailRules<ThrowOnError extends boolean = false>(options: Options<PreviewCrmEmailRulesData, ThrowOnError>): RequestResult<PreviewCrmEmailRulesResponses, unknown, ThrowOnError>;
|
|
810
|
+
/**
|
|
811
|
+
* Cancel the owner's current named preview, including while rollout is off.
|
|
812
|
+
*/
|
|
813
|
+
cancelCrmEmailRulePreview<ThrowOnError extends boolean = false>(options: Options<CancelCrmEmailRulePreviewData, ThrowOnError>): RequestResult<CancelCrmEmailRulePreviewResponses, unknown, ThrowOnError>;
|
|
814
|
+
/**
|
|
815
|
+
* Fetch one saved definition, independently of live CRM viewing permission.
|
|
816
|
+
*/
|
|
817
|
+
getCrmEmailRuleRevision<ThrowOnError extends boolean = false>(options: Options<GetCrmEmailRuleRevisionData, ThrowOnError>): RequestResult<GetCrmEmailRuleRevisionResponses, unknown, ThrowOnError>;
|
|
818
|
+
/**
|
|
819
|
+
* Canonicalize and authorize a definition without sharing mail.
|
|
820
|
+
*/
|
|
821
|
+
validateCrmEmailRules<ThrowOnError extends boolean = false>(options: Options<ValidateCrmEmailRulesData, ThrowOnError>): RequestResult<ValidateCrmEmailRulesResponses, unknown, ThrowOnError>;
|
|
822
|
+
/**
|
|
823
|
+
* List only the authenticated member's thread exclusions.
|
|
824
|
+
*/
|
|
825
|
+
listCrmExcludedEmailThreads<ThrowOnError extends boolean = false>(options?: Options<ListCrmExcludedEmailThreadsData, ThrowOnError>): RequestResult<ListCrmExcludedEmailThreadsResponses, unknown, ThrowOnError>;
|
|
826
|
+
/**
|
|
827
|
+
* Read fresh authority without requiring CRM access.
|
|
828
|
+
*/
|
|
829
|
+
getCrmMemberAccess<ThrowOnError extends boolean = false>(options?: Options<GetCrmMemberAccessData, ThrowOnError>): RequestResult<GetCrmMemberAccessResponses, unknown, ThrowOnError>;
|
|
830
|
+
/**
|
|
831
|
+
* List the caller's live pipelines in their CRM.
|
|
832
|
+
*/
|
|
833
|
+
listCrmPipelines<ThrowOnError extends boolean = false>(options?: Options<ListCrmPipelinesData, ThrowOnError>): RequestResult<ListCrmPipelinesResponses, unknown, ThrowOnError>;
|
|
834
|
+
/**
|
|
835
|
+
* Create a private or team-shared pipeline.
|
|
836
|
+
*/
|
|
837
|
+
createCrmPipeline<ThrowOnError extends boolean = false>(options: Options<CreateCrmPipelineData, ThrowOnError>): RequestResult<CreateCrmPipelineResponses, unknown, ThrowOnError>;
|
|
838
|
+
/**
|
|
839
|
+
* Create a pipeline with its stages, replacing the team's defaults, and its
|
|
840
|
+
* fields, in one call.
|
|
841
|
+
*/
|
|
842
|
+
createCrmPipelineWithFields<ThrowOnError extends boolean = false>(options: Options<CreateCrmPipelineWithFieldsData, ThrowOnError>): RequestResult<CreateCrmPipelineWithFieldsResponses, CreateCrmPipelineWithFieldsErrors, ThrowOnError>;
|
|
843
|
+
/**
|
|
844
|
+
* The caller's live pipelines, each with its fields in column order (a
|
|
845
|
+
* select field lists its options, so Stage lists the stages) and its table
|
|
846
|
+
* version: what `ListPipelines` gives the agent, in one call.
|
|
847
|
+
*/
|
|
848
|
+
listCrmPipelineDetails<ThrowOnError extends boolean = false>(options?: Options<ListCrmPipelineDetailsData, ThrowOnError>): RequestResult<ListCrmPipelineDetailsResponses, ListCrmPipelineDetailsErrors, ThrowOnError>;
|
|
849
|
+
/**
|
|
850
|
+
* Entries whose company or contact matches the search, across the caller's
|
|
851
|
+
* pipelines; pipelines without a match are left out.
|
|
852
|
+
*/
|
|
853
|
+
searchCrmPipelineEntries<ThrowOnError extends boolean = false>(options: Options<SearchCrmPipelineEntriesData, ThrowOnError>): RequestResult<SearchCrmPipelineEntriesResponses, SearchCrmPipelineEntriesErrors, ThrowOnError>;
|
|
854
|
+
/**
|
|
855
|
+
* Every entry tracking one of the records, across the caller's pipelines;
|
|
856
|
+
* pipelines without one are left out.
|
|
857
|
+
*/
|
|
858
|
+
listCrmRecordPipelineEntries<ThrowOnError extends boolean = false>(options: Options<ListCrmRecordPipelineEntriesData, ThrowOnError>): RequestResult<ListCrmRecordPipelineEntriesResponses, ListCrmRecordPipelineEntriesErrors, ThrowOnError>;
|
|
859
|
+
/**
|
|
860
|
+
* Read one pipeline by its entity identity.
|
|
861
|
+
*/
|
|
862
|
+
getCrmPipeline<ThrowOnError extends boolean = false>(options: Options<GetCrmPipelineData, ThrowOnError>): RequestResult<GetCrmPipelineResponses, unknown, ThrowOnError>;
|
|
863
|
+
/**
|
|
864
|
+
* Every entry as CSV text: Company and Domain (or Contact and Email), then
|
|
865
|
+
* one column per field, people as emails. An import reads the same layout.
|
|
866
|
+
*/
|
|
867
|
+
getCrmPipelineCsv<ThrowOnError extends boolean = false>(options: Options<GetCrmPipelineCsvData, ThrowOnError>): RequestResult<GetCrmPipelineCsvResponses, GetCrmPipelineCsvErrors, ThrowOnError>;
|
|
868
|
+
/**
|
|
869
|
+
* Rename or share a pipeline, and add, rename or delete its fields and
|
|
870
|
+
* options by name, in one change.
|
|
871
|
+
*/
|
|
872
|
+
editCrmPipeline<ThrowOnError extends boolean = false>(options: Options<EditCrmPipelineData, ThrowOnError>): RequestResult<EditCrmPipelineResponses, EditCrmPipelineErrors, ThrowOnError>;
|
|
873
|
+
/**
|
|
874
|
+
* Set fields of entries by name, all or nothing; a stage takes its label.
|
|
875
|
+
*/
|
|
876
|
+
updateCrmPipelineEntries<ThrowOnError extends boolean = false>(options: Options<UpdateCrmPipelineEntriesData, ThrowOnError>): RequestResult<UpdateCrmPipelineEntriesResponses, UpdateCrmPipelineEntriesErrors, ThrowOnError>;
|
|
877
|
+
/**
|
|
878
|
+
* Add entries, filling fields by name: companies or contacts in a tracked
|
|
879
|
+
* pipeline, free-form rows in a generic one. A record already in the
|
|
880
|
+
* pipeline is returned in `alreadyPresent` instead, unless `allowDuplicates`.
|
|
881
|
+
*/
|
|
882
|
+
addCrmPipelineEntries<ThrowOnError extends boolean = false>(options: Options<AddCrmPipelineEntriesData, ThrowOnError>): RequestResult<AddCrmPipelineEntriesResponses, AddCrmPipelineEntriesErrors, ThrowOnError>;
|
|
883
|
+
/**
|
|
884
|
+
* Entries of one pipeline matching filters, records or a search, with
|
|
885
|
+
* per-option counts and number totals over every match.
|
|
886
|
+
*/
|
|
887
|
+
findCrmPipelineEntries<ThrowOnError extends boolean = false>(options: Options<FindCrmPipelineEntriesData, ThrowOnError>): RequestResult<FindCrmPipelineEntriesResponses, FindCrmPipelineEntriesErrors, ThrowOnError>;
|
|
888
|
+
/**
|
|
889
|
+
* Delete entries by id, or every entry of the records; the companies and
|
|
890
|
+
* contacts stay in the CRM.
|
|
891
|
+
*/
|
|
892
|
+
removeCrmPipelineEntries<ThrowOnError extends boolean = false>(options: Options<RemoveCrmPipelineEntriesData, ThrowOnError>): RequestResult<RemoveCrmPipelineEntriesResponses, RemoveCrmPipelineEntriesErrors, ThrowOnError>;
|
|
893
|
+
/**
|
|
894
|
+
* Save every entry as a CSV file in the caller's files, laid out as
|
|
895
|
+
* `/csv` returns it.
|
|
896
|
+
*/
|
|
897
|
+
exportCrmPipelineCsv<ThrowOnError extends boolean = false>(options: Options<ExportCrmPipelineCsvData, ThrowOnError>): RequestResult<ExportCrmPipelineCsvResponses, ExportCrmPipelineCsvErrors, ThrowOnError>;
|
|
898
|
+
/**
|
|
899
|
+
* Add a CSV's rows as entries, matching its columns to fields by name and
|
|
900
|
+
* creating the companies or contacts the team lacks. Records already in the
|
|
901
|
+
* pipeline are not added again.
|
|
902
|
+
*/
|
|
903
|
+
importCrmPipelineCsv<ThrowOnError extends boolean = false>(options: Options<ImportCrmPipelineCsvData, ThrowOnError>): RequestResult<ImportCrmPipelineCsvResponses, ImportCrmPipelineCsvErrors, ThrowOnError>;
|
|
904
|
+
/**
|
|
905
|
+
* Rename a pipeline.
|
|
906
|
+
*/
|
|
907
|
+
renameCrmPipeline<ThrowOnError extends boolean = false>(options: Options<RenameCrmPipelineData, ThrowOnError>): RequestResult<RenameCrmPipelineResponses, unknown, ThrowOnError>;
|
|
908
|
+
/**
|
|
909
|
+
* Edit pipeline schema or records with the common typed operations.
|
|
910
|
+
*/
|
|
911
|
+
applyCrmPipelineOps<ThrowOnError extends boolean = false>(options: Options<ApplyCrmPipelineOpsData, ThrowOnError>): RequestResult<ApplyCrmPipelineOpsResponses, unknown, ThrowOnError>;
|
|
912
|
+
/**
|
|
913
|
+
* Read the owner, team grant and channel recipients of a pipeline the caller can edit.
|
|
914
|
+
*/
|
|
915
|
+
getCrmPipelinePermissions<ThrowOnError extends boolean = false>(options: Options<GetCrmPipelinePermissionsData, ThrowOnError>): RequestResult<GetCrmPipelinePermissionsResponses, unknown, ThrowOnError>;
|
|
916
|
+
/**
|
|
917
|
+
* Share a pipeline the caller can edit with channels, or change or remove
|
|
918
|
+
* their access. Team access changes through `/sharing`; there is no share link.
|
|
919
|
+
*/
|
|
920
|
+
updateCrmPipelinePermissions<ThrowOnError extends boolean = false>(options: Options<UpdateCrmPipelinePermissionsData, ThrowOnError>): RequestResult<UpdateCrmPipelinePermissionsResponses, unknown, ThrowOnError>;
|
|
921
|
+
/**
|
|
922
|
+
* Read pipeline records through pipeline access.
|
|
923
|
+
*/
|
|
924
|
+
getCrmPipelineRows<ThrowOnError extends boolean = false>(options: Options<GetCrmPipelineRowsData, ThrowOnError>): RequestResult<GetCrmPipelineRowsResponses, unknown, ThrowOnError>;
|
|
925
|
+
/**
|
|
926
|
+
* Query rows through pipeline access using the shared view protocol.
|
|
927
|
+
*/
|
|
928
|
+
queryCrmPipelineRows<ThrowOnError extends boolean = false>(options: Options<QueryCrmPipelineRowsData, ThrowOnError>): RequestResult<QueryCrmPipelineRowsResponses, unknown, ThrowOnError>;
|
|
929
|
+
/**
|
|
930
|
+
* Update sharing.
|
|
931
|
+
*/
|
|
932
|
+
shareCrmPipeline<ThrowOnError extends boolean = false>(options: Options<ShareCrmPipelineData, ThrowOnError>): RequestResult<ShareCrmPipelineResponses, unknown, ThrowOnError>;
|
|
933
|
+
/**
|
|
934
|
+
* Read requirements by stable stage and field identities.
|
|
935
|
+
*/
|
|
936
|
+
getCrmPipelineStageRequirements<ThrowOnError extends boolean = false>(options: Options<GetCrmPipelineStageRequirementsData, ThrowOnError>): RequestResult<GetCrmPipelineStageRequirementsResponses, unknown, ThrowOnError>;
|
|
937
|
+
/**
|
|
938
|
+
* Replace the required fields for one stage. An empty list removes its rule.
|
|
939
|
+
*/
|
|
940
|
+
setCrmPipelineStageRequirement<ThrowOnError extends boolean = false>(options: Options<SetCrmPipelineStageRequirementData, ThrowOnError>): RequestResult<SetCrmPipelineStageRequirementResponses, unknown, ThrowOnError>;
|
|
941
|
+
/**
|
|
942
|
+
* Read the host-owned table schema.
|
|
943
|
+
*/
|
|
944
|
+
getCrmPipelineTable<ThrowOnError extends boolean = false>(options: Options<GetCrmPipelineTableData, ThrowOnError>): RequestResult<GetCrmPipelineTableResponses, unknown, ThrowOnError>;
|
|
945
|
+
/**
|
|
946
|
+
* Trash or restore a pipeline.
|
|
947
|
+
*/
|
|
948
|
+
trashCrmPipeline<ThrowOnError extends boolean = false>(options: Options<TrashCrmPipelineData, ThrowOnError>): RequestResult<TrashCrmPipelineResponses, unknown, ThrowOnError>;
|
|
949
|
+
/**
|
|
950
|
+
* Read saved board positions through pipeline access.
|
|
951
|
+
*/
|
|
952
|
+
getCrmPipelineViewPositions<ThrowOnError extends boolean = false>(options: Options<GetCrmPipelineViewPositionsData, ThrowOnError>): RequestResult<GetCrmPipelineViewPositionsResponses, unknown, ThrowOnError>;
|
|
953
|
+
/**
|
|
954
|
+
* Title many CRM company and contact chips at once. Each record answers as
|
|
955
|
+
* its own read (`GET /crm/companies/{company_id}`,
|
|
956
|
+
* `GET /crm/contacts/{contact_id}`) would: a record the caller may not open,
|
|
957
|
+
* or that does not exist, is left out of the response.
|
|
958
|
+
*/
|
|
959
|
+
previewCrmRecords<ThrowOnError extends boolean = false>(options: Options<PreviewCrmRecordsData, ThrowOnError>): RequestResult<PreviewCrmRecordsResponses, PreviewCrmRecordsErrors, ThrowOnError>;
|
|
960
|
+
/**
|
|
961
|
+
* Read the caller's team CRM configuration. Any team member may read;
|
|
962
|
+
* teams without a settings row get the defaults.
|
|
963
|
+
*/
|
|
964
|
+
getCrmTeamSettings<ThrowOnError extends boolean = false>(options?: Options<GetCrmTeamSettingsData, ThrowOnError>): RequestResult<GetCrmTeamSettingsResponses, GetCrmTeamSettingsErrors, ThrowOnError>;
|
|
965
|
+
/**
|
|
966
|
+
* Partially update the caller's team CRM configuration. Any team
|
|
967
|
+
* member may update the views fields (`team_views`,
|
|
968
|
+
* `default_team_view_id`); the governance fields (permission
|
|
969
|
+
* thresholds, `closed_stage_ids`, `exclude_personal_emails`) require an admin/owner team role
|
|
970
|
+
* (403 otherwise). Omitted fields keep their current values;
|
|
971
|
+
* `team_views` is replaced whole. Returns the resulting settings.
|
|
972
|
+
*/
|
|
973
|
+
putCrmTeamSettings<ThrowOnError extends boolean = false>(options: Options<PutCrmTeamSettingsData, ThrowOnError>): RequestResult<PutCrmTeamSettingsResponses, PutCrmTeamSettingsErrors, ThrowOnError>;
|
|
974
|
+
/**
|
|
975
|
+
* Reset the team's deal stages to the defaults; gated like `PUT /crm/stages`.
|
|
976
|
+
*/
|
|
977
|
+
resetCrmTeamStages<ThrowOnError extends boolean = false>(options?: Options<ResetCrmTeamStagesData, ThrowOnError>): RequestResult<ResetCrmTeamStagesResponses, ResetCrmTeamStagesErrors, ThrowOnError>;
|
|
978
|
+
/**
|
|
979
|
+
* Replace the team's deal stages; requires `edit_stages_role` (403 otherwise).
|
|
980
|
+
*/
|
|
981
|
+
putCrmTeamStages<ThrowOnError extends boolean = false>(options: Options<PutCrmTeamStagesData, ThrowOnError>): RequestResult<PutCrmTeamStagesResponses, PutCrmTeamStagesErrors, ThrowOnError>;
|
|
982
|
+
/**
|
|
983
|
+
* List the caller's databases.
|
|
984
|
+
*/
|
|
985
|
+
listDatabases<ThrowOnError extends boolean = false>(options?: Options<ListDatabasesData, ThrowOnError>): RequestResult<ListDatabasesResponses, ListDatabasesErrors, ThrowOnError>;
|
|
986
|
+
/**
|
|
987
|
+
* Create a database owned by the caller; its first table, "Table 1" unless
|
|
988
|
+
* `firstTable` names it, holds a "Name" text column.
|
|
989
|
+
*/
|
|
990
|
+
createDatabase<ThrowOnError extends boolean = false>(options: Options<CreateDatabaseData, ThrowOnError>): RequestResult<CreateDatabaseResponses, CreateDatabaseErrors, ThrowOnError>;
|
|
991
|
+
/**
|
|
992
|
+
* Save a question: a `SELECT` that compiles against the caller's databases,
|
|
993
|
+
* whose chart columns, when given, are ones it returns. Saved questions
|
|
994
|
+
* never change; editing one saves a new one.
|
|
995
|
+
*/
|
|
996
|
+
saveDatabaseQuery<ThrowOnError extends boolean = false>(options: Options<SaveDatabaseQueryData, ThrowOnError>): RequestResult<SaveDatabaseQueryResponses, SaveDatabaseQueryErrors, ThrowOnError>;
|
|
997
|
+
/**
|
|
998
|
+
* A saved query's definition, for its creator or a viewer of its database.
|
|
999
|
+
*/
|
|
1000
|
+
getDatabaseQuery<ThrowOnError extends boolean = false>(options: Options<GetDatabaseQueryData, ThrowOnError>): RequestResult<GetDatabaseQueryResponses, GetDatabaseQueryErrors, ThrowOnError>;
|
|
1001
|
+
/**
|
|
1002
|
+
* Run one statement as the authenticated user. The viewer's catalog authorizes reads;
|
|
1003
|
+
* the SQL domain service obtains an edit receipt for every written database.
|
|
1004
|
+
*/
|
|
1005
|
+
queryDatabases<ThrowOnError extends boolean = false>(options: Options<QueryDatabasesData, ThrowOnError>): RequestResult<QueryDatabasesResponses, QueryDatabasesErrors, ThrowOnError>;
|
|
1006
|
+
/**
|
|
1007
|
+
* Create a small example once for the authenticated user, if they have no databases.
|
|
1008
|
+
*/
|
|
1009
|
+
ensureStarterHandler<ThrowOnError extends boolean = false>(options?: Options<EnsureStarterHandlerData, ThrowOnError>): RequestResult<EnsureStarterHandlerResponses, EnsureStarterHandlerErrors, ThrowOnError>;
|
|
1010
|
+
/**
|
|
1011
|
+
* Insert rows through a webhook. The body is a JSON object, one row, or
|
|
1012
|
+
* an array of up to 100 objects, one row each. Keys name columns by name
|
|
1013
|
+
* (ignoring case) or id; `null` leaves a cell empty. Values may be loose:
|
|
1014
|
+
* `"45"` for a number, `"true"` for a checkbox, a label or labels for a
|
|
1015
|
+
* select, `2026-10-09` for a date. Nothing is written unless every row fits.
|
|
1016
|
+
*/
|
|
1017
|
+
deliverDatabaseWebhook<ThrowOnError extends boolean = false>(options: Options<DeliverDatabaseWebhookData, ThrowOnError>): RequestResult<DeliverDatabaseWebhookResponses, DeliverDatabaseWebhookErrors, ThrowOnError>;
|
|
1018
|
+
/**
|
|
1019
|
+
* Schema detail of one database.
|
|
1020
|
+
*/
|
|
1021
|
+
getDatabase<ThrowOnError extends boolean = false>(options: Options<GetDatabaseData, ThrowOnError>): RequestResult<GetDatabaseResponses, GetDatabaseErrors, ThrowOnError>;
|
|
1022
|
+
/**
|
|
1023
|
+
* Replace a database's icon and color without changing its content timestamp.
|
|
1024
|
+
*/
|
|
1025
|
+
setDatabaseAppearance<ThrowOnError extends boolean = false>(options: Options<SetDatabaseAppearanceData, ThrowOnError>): RequestResult<SetDatabaseAppearanceResponses, SetDatabaseAppearanceErrors, ThrowOnError>;
|
|
1026
|
+
/**
|
|
1027
|
+
* Tell a database's other viewers where the caller is.
|
|
1028
|
+
*/
|
|
1029
|
+
shareDatabaseAwareness<ThrowOnError extends boolean = false>(options: Options<ShareDatabaseAwarenessData, ThrowOnError>): RequestResult<ShareDatabaseAwarenessResponses, ShareDatabaseAwarenessErrors, ThrowOnError>;
|
|
1030
|
+
/**
|
|
1031
|
+
* Undo one of your own committed changes: its inverse applies as a new,
|
|
1032
|
+
* journaled batch, under the table's lock, guarded against what others
|
|
1033
|
+
* changed since. A cell someone changed since is left alone and listed; a
|
|
1034
|
+
* row or column you added that someone else wrote since, or a name, option,
|
|
1035
|
+
* order, view or card place changed since, refuses the undo. Others'
|
|
1036
|
+
* changes always stay. Redo by undoing the undo's change.
|
|
1037
|
+
*/
|
|
1038
|
+
undoDatabaseChange<ThrowOnError extends boolean = false>(options: Options<UndoDatabaseChangeData, ThrowOnError>): RequestResult<UndoDatabaseChangeResponses, UndoDatabaseChangeErrors, ThrowOnError>;
|
|
1039
|
+
/**
|
|
1040
|
+
* Copy a database, with its tables, columns, views and rows, into a new one
|
|
1041
|
+
* the caller owns. Its sharing, forms, webhooks and history stay behind.
|
|
1042
|
+
*/
|
|
1043
|
+
duplicateDatabase<ThrowOnError extends boolean = false>(options: Options<DuplicateDatabaseData, ThrowOnError>): RequestResult<DuplicateDatabaseResponses, DuplicateDatabaseErrors, ThrowOnError>;
|
|
1044
|
+
/**
|
|
1045
|
+
* Import a new table and every row atomically; retries carry the same request ID.
|
|
1046
|
+
*/
|
|
1047
|
+
importDatabaseTable<ThrowOnError extends boolean = false>(options: Options<ImportDatabaseTableData, ThrowOnError>): RequestResult<ImportDatabaseTableResponses, ImportDatabaseTableErrors, ThrowOnError>;
|
|
1048
|
+
/**
|
|
1049
|
+
* Apply a batch of typed ops, the one write surface of a database: add,
|
|
1050
|
+
* rename, remove and order tables and columns, change a column's type, add
|
|
1051
|
+
* and change options, insert, update and delete rows, and write views and a
|
|
1052
|
+
* board's card places. The ops apply in order in one transaction, so a
|
|
1053
|
+
* later op may name a table, column, option or view an earlier one created
|
|
1054
|
+
* under the id its client minted. Ops are last-write-wins unless the batch names
|
|
1055
|
+
* base versions. A refused op, named by its index (and row and column where
|
|
1056
|
+
* relevant), leaves the whole batch unwritten.
|
|
1057
|
+
*/
|
|
1058
|
+
applyDatabaseOps<ThrowOnError extends boolean = false>(options: Options<ApplyDatabaseOpsData, ThrowOnError>): RequestResult<ApplyDatabaseOpsResponses, ApplyDatabaseOpsErrors, ThrowOnError>;
|
|
1059
|
+
/**
|
|
1060
|
+
* Read recipients and the team share for a database owned by the caller.
|
|
1061
|
+
* Link sharing is always `null`: databases do not support it.
|
|
1062
|
+
*/
|
|
1063
|
+
getDatabasePermissions<ThrowOnError extends boolean = false>(options: Options<GetDatabasePermissionsData, ThrowOnError>): RequestResult<GetDatabasePermissionsResponses, GetDatabasePermissionsErrors, ThrowOnError>;
|
|
1064
|
+
/**
|
|
1065
|
+
* Update channel recipients and the team share after proving database
|
|
1066
|
+
* ownership. Turning on link sharing is refused; ownership cannot be
|
|
1067
|
+
* changed here. Only the actual owner may change the team share, and a 409
|
|
1068
|
+
* means sharing changed since the request was authorized.
|
|
1069
|
+
*/
|
|
1070
|
+
updateDatabasePermissions<ThrowOnError extends boolean = false>(options: Options<UpdateDatabasePermissionsData, ThrowOnError>): RequestResult<UpdateDatabasePermissionsResponses, UpdateDatabasePermissionsErrors, ThrowOnError>;
|
|
1071
|
+
/**
|
|
1072
|
+
* What changed in a table since a version, from the change journal: the
|
|
1073
|
+
* rows that changed, each once as it stands now (`insert`, `update` or
|
|
1074
|
+
* `delete`), and the columns. A reader holding the table at `since` reads
|
|
1075
|
+
* just those rows; it reads the table whole when a column changed, the
|
|
1076
|
+
* journal is not `complete`, or the rows are `truncated`.
|
|
1077
|
+
*/
|
|
1078
|
+
getDatabaseTableChanges<ThrowOnError extends boolean = false>(options: Options<GetDatabaseTableChangesData, ThrowOnError>): RequestResult<GetDatabaseTableChangesResponses, GetDatabaseTableChangesErrors, ThrowOnError>;
|
|
1079
|
+
/**
|
|
1080
|
+
* What changing one column to each type of the type menu would do to its
|
|
1081
|
+
* values: safe, checked (with how many values would not convert and a few
|
|
1082
|
+
* of them), or never (with why). Changes nothing.
|
|
1083
|
+
*/
|
|
1084
|
+
listDatabaseColumnCasts<ThrowOnError extends boolean = false>(options: Options<ListDatabaseColumnCastsData, ThrowOnError>): RequestResult<ListDatabaseColumnCastsResponses, ListDatabaseColumnCastsErrors, ThrowOnError>;
|
|
1085
|
+
/**
|
|
1086
|
+
* What one column's values become under another type: the values that
|
|
1087
|
+
* convert, with the options they need, for a new column of that type beside
|
|
1088
|
+
* it. The column itself is left as it is: a client writes the conversion as
|
|
1089
|
+
* one ops batch, a `create_column` then an `update_rows`, with the answered
|
|
1090
|
+
* table version as its base version. Changes nothing.
|
|
1091
|
+
*/
|
|
1092
|
+
convertDatabaseColumn<ThrowOnError extends boolean = false>(options: Options<ConvertDatabaseColumnData, ThrowOnError>): RequestResult<ConvertDatabaseColumnResponses, ConvertDatabaseColumnErrors, ThrowOnError>;
|
|
1093
|
+
/**
|
|
1094
|
+
* Settle a new empty text column's type.
|
|
1095
|
+
*/
|
|
1096
|
+
inferDatabaseColumnType<ThrowOnError extends boolean = false>(options: Options<InferDatabaseColumnTypeData, ThrowOnError>): RequestResult<InferDatabaseColumnTypeResponses, InferDatabaseColumnTypeErrors, ThrowOnError>;
|
|
1097
|
+
/**
|
|
1098
|
+
* A row's history, from the change journal: every committed change that
|
|
1099
|
+
* touched it, newest first, with who made it, when, and the values of the
|
|
1100
|
+
* columns it touched before and after. It reads after the row is removed,
|
|
1101
|
+
* so a removed row's last values stay readable.
|
|
1102
|
+
*/
|
|
1103
|
+
getDatabaseRowHistory<ThrowOnError extends boolean = false>(options: Options<GetDatabaseRowHistoryData, ThrowOnError>): RequestResult<GetDatabaseRowHistoryResponses, GetDatabaseRowHistoryErrors, ThrowOnError>;
|
|
1104
|
+
/**
|
|
1105
|
+
* Where a board's cards sit, for drawing it: the views come with the
|
|
1106
|
+
* database's detail, their cards' places from here.
|
|
1107
|
+
*/
|
|
1108
|
+
getDatabaseViewPositions<ThrowOnError extends boolean = false>(options: Options<GetDatabaseViewPositionsData, ThrowOnError>): RequestResult<GetDatabaseViewPositionsResponses, GetDatabaseViewPositionsErrors, ThrowOnError>;
|
|
1109
|
+
/**
|
|
1110
|
+
* The database's webhooks.
|
|
1111
|
+
*/
|
|
1112
|
+
listDatabaseWebhooks<ThrowOnError extends boolean = false>(options: Options<ListDatabaseWebhooksData, ThrowOnError>): RequestResult<ListDatabaseWebhooksResponses, ListDatabaseWebhooksErrors, ThrowOnError>;
|
|
1113
|
+
/**
|
|
1114
|
+
* Create a webhook: a secret URL whose calls insert rows into one of the
|
|
1115
|
+
* database's tables, writing with the creator's access.
|
|
1116
|
+
*/
|
|
1117
|
+
createDatabaseWebhook<ThrowOnError extends boolean = false>(options: Options<CreateDatabaseWebhookData, ThrowOnError>): RequestResult<CreateDatabaseWebhookResponses, CreateDatabaseWebhookErrors, ThrowOnError>;
|
|
1118
|
+
/**
|
|
1119
|
+
* Delete a webhook; its URL stops working.
|
|
1120
|
+
*/
|
|
1121
|
+
deleteDatabaseWebhook<ThrowOnError extends boolean = false>(options: Options<DeleteDatabaseWebhookData, ThrowOnError>): RequestResult<DeleteDatabaseWebhookResponses, DeleteDatabaseWebhookErrors, ThrowOnError>;
|
|
1122
|
+
/**
|
|
1123
|
+
* Transcribe a transient recording with OpenAI Whisper.
|
|
1124
|
+
*
|
|
1125
|
+
* Available to every signed-in user on every plan; does not consume chat
|
|
1126
|
+
* credits. Audio and transcripts are never persisted.
|
|
1127
|
+
*/
|
|
1128
|
+
transcribeDictation<ThrowOnError extends boolean = false>(options: Options<TranscribeDictationData, ThrowOnError>): RequestResult<TranscribeDictationResponses, TranscribeDictationErrors, ThrowOnError>;
|
|
1129
|
+
/**
|
|
1130
|
+
* Gets the users documents to populate their recent document list
|
|
1131
|
+
*/
|
|
1132
|
+
getUserDocumentsHandler<ThrowOnError extends boolean = false>(options: Options<GetUserDocumentsHandlerData, ThrowOnError>): RequestResult<GetUserDocumentsHandlerResponses, GetUserDocumentsHandlerErrors, ThrowOnError>;
|
|
1133
|
+
/**
|
|
1134
|
+
* Handler for `POST /documents`.
|
|
1135
|
+
*
|
|
1136
|
+
* Creates a new document, generates an S3 presigned upload URL, and returns
|
|
1137
|
+
* the document metadata with the URL for the client to upload to.
|
|
1138
|
+
*/
|
|
1139
|
+
createDocument<ThrowOnError extends boolean = false>(options: Options<CreateDocumentData, ThrowOnError>): RequestResult<CreateDocumentResponses, CreateDocumentErrors, ThrowOnError>;
|
|
1140
|
+
/**
|
|
1141
|
+
* Creates and initializes a Canvas in one backend-owned lifecycle.
|
|
1142
|
+
*/
|
|
1143
|
+
createCanvasHandler<ThrowOnError extends boolean = false>(options: Options<CreateCanvasHandlerData, ThrowOnError>): RequestResult<CreateCanvasHandlerResponses, CreateCanvasHandlerErrors, ThrowOnError>;
|
|
1144
|
+
/**
|
|
1145
|
+
* Creates and initializes a markdown document in one backend-owned lifecycle.
|
|
1146
|
+
*/
|
|
1147
|
+
createMarkdownHandler<ThrowOnError extends boolean = false>(options: Options<CreateMarkdownHandlerData, ThrowOnError>): RequestResult<CreateMarkdownHandlerResponses, CreateMarkdownHandlerErrors, ThrowOnError>;
|
|
1148
|
+
/**
|
|
1149
|
+
* Creates a skill document with initialized markdown content and its
|
|
1150
|
+
* routing description in one backend-owned lifecycle. Skills are markdown documents containing
|
|
1151
|
+
* instructions that AI reads and follows when the skill is referenced in an
|
|
1152
|
+
* AI input.
|
|
1153
|
+
*/
|
|
1154
|
+
createSkillHandler<ThrowOnError extends boolean = false>(options: Options<CreateSkillHandlerData, ThrowOnError>): RequestResult<CreateSkillHandlerResponses, CreateSkillHandlerErrors, ThrowOnError>;
|
|
1155
|
+
/**
|
|
1156
|
+
* Creates a snippet document with initialized markdown content in one
|
|
1157
|
+
* backend-owned lifecycle. Snippets are created personal; team sharing is
|
|
1158
|
+
* toggled separately via `PUT /documents/{document_id}/team_share`.
|
|
1159
|
+
*/
|
|
1160
|
+
createSnippetHandler<ThrowOnError extends boolean = false>(options: Options<CreateSnippetHandlerData, ThrowOnError>): RequestResult<CreateSnippetHandlerResponses, CreateSnippetHandlerErrors, ThrowOnError>;
|
|
1161
|
+
/**
|
|
1162
|
+
* Create a blank native spreadsheet, ready to read and edit.
|
|
1163
|
+
*/
|
|
1164
|
+
createSpreadsheet<ThrowOnError extends boolean = false>(options: Options<CreateSpreadsheetData, ThrowOnError>): RequestResult<CreateSpreadsheetResponses, CreateSpreadsheetErrors, ThrowOnError>;
|
|
1165
|
+
/**
|
|
1166
|
+
* Creates a task document with properties and initialized markdown content in
|
|
1167
|
+
* one backend-owned lifecycle.
|
|
1168
|
+
*/
|
|
1169
|
+
createTaskHandler<ThrowOnError extends boolean = false>(options: Options<CreateTaskHandlerData, ThrowOnError>): RequestResult<CreateTaskHandlerResponses, CreateTaskHandlerErrors, ThrowOnError>;
|
|
1170
|
+
/**
|
|
1171
|
+
* Handler for `POST /documents/github_prs/tasks`.
|
|
1172
|
+
*
|
|
1173
|
+
* Returns the task documents each of up to 100 GitHub pull requests references, for the pull
|
|
1174
|
+
* requests the caller can see.
|
|
1175
|
+
*/
|
|
1176
|
+
getGithubPullRequestTasks<ThrowOnError extends boolean = false>(options: Options<GetGithubPullRequestTasksData, ThrowOnError>): RequestResult<GetGithubPullRequestTasksResponses, GetGithubPullRequestTasksErrors, ThrowOnError>;
|
|
1177
|
+
initializeUserDocuments<ThrowOnError extends boolean = false>(options?: Options<InitializeUserDocumentsData, ThrowOnError>): RequestResult<InitializeUserDocumentsResponses, InitializeUserDocumentsErrors, ThrowOnError>;
|
|
1178
|
+
/**
|
|
1179
|
+
* Gets a list of all the user's documents so they are able to be searched on
|
|
1180
|
+
*/
|
|
1181
|
+
getDocumentListHandler<ThrowOnError extends boolean = false>(options?: Options<GetDocumentListHandlerData, ThrowOnError>): RequestResult<GetDocumentListHandlerResponses, GetDocumentListHandlerErrors, ThrowOnError>;
|
|
1182
|
+
/**
|
|
1183
|
+
* Validates the provided document permissions token
|
|
1184
|
+
*/
|
|
1185
|
+
validateDocumentPermissionsToken<ThrowOnError extends boolean = false>(options: Options<ValidateDocumentPermissionsTokenData, ThrowOnError>): RequestResult<ValidateDocumentPermissionsTokenResponses, ValidateDocumentPermissionsTokenErrors, ThrowOnError>;
|
|
1186
|
+
/**
|
|
1187
|
+
* Generates a document permissions token for a provided document id
|
|
1188
|
+
*/
|
|
1189
|
+
getDocumentPermissionsToken<ThrowOnError extends boolean = false>(options: Options<GetDocumentPermissionsTokenData, ThrowOnError>): RequestResult<GetDocumentPermissionsTokenResponses, GetDocumentPermissionsTokenErrors, ThrowOnError>;
|
|
1190
|
+
/**
|
|
1191
|
+
* Takes the docx document bom parts and generates presigned urls to upload
|
|
1192
|
+
* any new content
|
|
1193
|
+
*
|
|
1194
|
+
* @deprecated
|
|
1195
|
+
*/
|
|
1196
|
+
presaveDocumentHandler<ThrowOnError extends boolean = false>(options: Options<PresaveDocumentHandlerData, ThrowOnError>): RequestResult<PresaveDocumentHandlerResponses, PresaveDocumentHandlerErrors, ThrowOnError>;
|
|
1197
|
+
getBatchPreviewHandler<ThrowOnError extends boolean = false>(options: Options<GetBatchPreviewHandlerData, ThrowOnError>): RequestResult<GetBatchPreviewHandlerResponses, GetBatchPreviewHandlerErrors, ThrowOnError>;
|
|
1198
|
+
/**
|
|
1199
|
+
* Handler for `POST /documents/similarity_search`.
|
|
1200
|
+
*
|
|
1201
|
+
* Returns existing tasks similar to an unsaved draft. Runs vector retrieval +
|
|
1202
|
+
* rerank only and persists nothing.
|
|
1203
|
+
*/
|
|
1204
|
+
taskSimilaritySearchHandler<ThrowOnError extends boolean = false>(options: Options<TaskSimilaritySearchHandlerData, ThrowOnError>): RequestResult<TaskSimilaritySearchHandlerResponses, TaskSimilaritySearchHandlerErrors, ThrowOnError>;
|
|
1205
|
+
/**
|
|
1206
|
+
* Handler for `GET /documents/slug/{slug}`.
|
|
1207
|
+
*
|
|
1208
|
+
* Returns document metadata, user access level, and view location.
|
|
1209
|
+
*/
|
|
1210
|
+
getDocumentByTeamSlug<ThrowOnError extends boolean = false>(options: Options<GetDocumentByTeamSlugData, ThrowOnError>): RequestResult<GetDocumentByTeamSlugResponses, GetDocumentByTeamSlugErrors, ThrowOnError>;
|
|
1211
|
+
/**
|
|
1212
|
+
* Resolves the current user's starter documents.
|
|
1213
|
+
*/
|
|
1214
|
+
handler<ThrowOnError extends boolean = false>(options?: Options<HandlerData, ThrowOnError>): RequestResult<HandlerResponses, HandlerErrors, ThrowOnError>;
|
|
1215
|
+
/**
|
|
1216
|
+
* Lists the built-in system skills. System skills are static, code-defined
|
|
1217
|
+
* AI instructions (see the `system_skills` crate); they surface in the
|
|
1218
|
+
* skills menu and AI skill tools like user skills, but have no document
|
|
1219
|
+
* behind them, so clients must not offer to open them.
|
|
1220
|
+
*/
|
|
1221
|
+
getSystemSkillsHandler<ThrowOnError extends boolean = false>(options?: Options<GetSystemSkillsHandlerData, ThrowOnError>): RequestResult<GetSystemSkillsHandlerResponses, GetSystemSkillsHandlerErrors, ThrowOnError>;
|
|
1222
|
+
/**
|
|
1223
|
+
* Upload a file's bytes as a new document, up to 25 MiB.
|
|
1224
|
+
*
|
|
1225
|
+
* The body is the raw file content. Preview generation and indexing may
|
|
1226
|
+
* finish after the response.
|
|
1227
|
+
*/
|
|
1228
|
+
uploadFile<ThrowOnError extends boolean = false>(options: Options<UploadFileData, ThrowOnError>): RequestResult<UploadFileResponses, UploadFileErrors, ThrowOnError>;
|
|
1229
|
+
/**
|
|
1230
|
+
* Handler for `DELETE /documents/{document_id}`.
|
|
1231
|
+
*
|
|
1232
|
+
* Soft-deletes a document (only owners can delete).
|
|
1233
|
+
*/
|
|
1234
|
+
deleteDocument<ThrowOnError extends boolean = false>(options: Options<DeleteDocumentData, ThrowOnError>): RequestResult<DeleteDocumentResponses, DeleteDocumentErrors, ThrowOnError>;
|
|
1235
|
+
/**
|
|
1236
|
+
* Handler for `GET /documents/{document_id}`.
|
|
1237
|
+
*
|
|
1238
|
+
* Returns document metadata, user access level, and view location.
|
|
1239
|
+
*/
|
|
1240
|
+
getDocument<ThrowOnError extends boolean = false>(options: Options<GetDocumentData, ThrowOnError>): RequestResult<GetDocumentResponses, GetDocumentErrors, ThrowOnError>;
|
|
1241
|
+
/**
|
|
1242
|
+
* Handler for `PATCH /documents/{document_id}`.
|
|
1243
|
+
*
|
|
1244
|
+
* Edits document metadata such as name or project, and modifies
|
|
1245
|
+
* the document's share permissions. Requires edit access to the document,
|
|
1246
|
+
* and edit access to the target project if moving the document.
|
|
1247
|
+
*/
|
|
1248
|
+
editDocument<ThrowOnError extends boolean = false>(options: Options<EditDocumentData, ThrowOnError>): RequestResult<EditDocumentResponses, EditDocumentErrors, ThrowOnError>;
|
|
1249
|
+
/**
|
|
1250
|
+
* Creates a new version of a document
|
|
1251
|
+
*/
|
|
1252
|
+
saveDocumentHandler<ThrowOnError extends boolean = false>(options: Options<SaveDocumentHandlerData, ThrowOnError>): RequestResult<SaveDocumentHandlerResponses, SaveDocumentHandlerErrors, ThrowOnError>;
|
|
1253
|
+
/**
|
|
1254
|
+
* Edit a markdown document or task by instructions with the caller's edit
|
|
1255
|
+
* access. Runs EditDocument's pipeline as a live collaborator, with its AI
|
|
1256
|
+
* admission and billing.
|
|
1257
|
+
*
|
|
1258
|
+
* A client that disconnects aborts the edit: axum drops this handler's
|
|
1259
|
+
* future, which drops the in-flight request to the editing worker, and the
|
|
1260
|
+
* worker aborts on its request signal. Steps already acknowledged stay.
|
|
1261
|
+
*/
|
|
1262
|
+
editDocumentWithAi<ThrowOnError extends boolean = false>(options: Options<EditDocumentWithAiData, ThrowOnError>): RequestResult<EditDocumentWithAiResponses, EditDocumentWithAiErrors, ThrowOnError>;
|
|
1263
|
+
/**
|
|
1264
|
+
* Replace a document's presentation overrides without editing its content.
|
|
1265
|
+
*/
|
|
1266
|
+
setDocumentAppearance<ThrowOnError extends boolean = false>(options: Options<SetDocumentAppearanceData, ThrowOnError>): RequestResult<SetDocumentAppearanceResponses, SetDocumentAppearanceErrors, ThrowOnError>;
|
|
1267
|
+
/**
|
|
1268
|
+
* Handler for `GET /documents/{document_id}/branch_name`.
|
|
1269
|
+
*
|
|
1270
|
+
* Returns the short UUID and git branch name for a task document.
|
|
1271
|
+
* Returns 400 if the document is not a task.
|
|
1272
|
+
*/
|
|
1273
|
+
getDocumentBranchName<ThrowOnError extends boolean = false>(options: Options<GetDocumentBranchNameData, ThrowOnError>): RequestResult<GetDocumentBranchNameResponses, GetDocumentBranchNameErrors, ThrowOnError>;
|
|
1274
|
+
/**
|
|
1275
|
+
* Edit a canvas by natural-language instructions with edit access, through
|
|
1276
|
+
* EditCanvas's editor, AI admission and billing.
|
|
1277
|
+
*/
|
|
1278
|
+
editCanvasWithAi<ThrowOnError extends boolean = false>(options: Options<EditCanvasWithAiData, ThrowOnError>): RequestResult<EditCanvasWithAiResponses, EditCanvasWithAiErrors, ThrowOnError>;
|
|
1279
|
+
/**
|
|
1280
|
+
* Apply one batch of CanvasEditor code with edit access, against the revision
|
|
1281
|
+
* it was planned on, without a model. The batch validates, measures text and
|
|
1282
|
+
* commits once, or not at all.
|
|
1283
|
+
*/
|
|
1284
|
+
applyCanvasEdits<ThrowOnError extends boolean = false>(options: Options<ApplyCanvasEditsData, ThrowOnError>): RequestResult<ApplyCanvasEditsResponses, ApplyCanvasEditsErrors, ThrowOnError>;
|
|
1285
|
+
/**
|
|
1286
|
+
* Render a canvas to a PNG with view access, with the Canvas renderer, and
|
|
1287
|
+
* keep it as a static file owned by the caller. No model runs.
|
|
1288
|
+
*/
|
|
1289
|
+
renderCanvas<ThrowOnError extends boolean = false>(options: Options<RenderCanvasData, ThrowOnError>): RequestResult<RenderCanvasResponses, RenderCanvasErrors, ThrowOnError>;
|
|
1290
|
+
/**
|
|
1291
|
+
* Read a canvas's live scene with view access: stable item ids, containment
|
|
1292
|
+
* and order, transforms, world bounds, shapes and text. No model runs.
|
|
1293
|
+
*/
|
|
1294
|
+
readCanvasScene<ThrowOnError extends boolean = false>(options: Options<ReadCanvasSceneData, ThrowOnError>): RequestResult<ReadCanvasSceneResponses, ReadCanvasSceneErrors, ThrowOnError>;
|
|
1295
|
+
/**
|
|
1296
|
+
* Start a comment thread anchored to a quoted passage of a markdown or Word
|
|
1297
|
+
* document, with the caller's comment access. On markdown the passage is
|
|
1298
|
+
* marked in the live document first, and nothing is posted when the quote is
|
|
1299
|
+
* ambiguous or missing.
|
|
1300
|
+
*/
|
|
1301
|
+
commentOnDocumentText<ThrowOnError extends boolean = false>(options: Options<CommentOnDocumentTextData, ThrowOnError>): RequestResult<CommentOnDocumentTextResponses, CommentOnDocumentTextErrors, ThrowOnError>;
|
|
1302
|
+
/**
|
|
1303
|
+
* Handler for `POST /documents/{document_id}/copy`.
|
|
1304
|
+
*
|
|
1305
|
+
* Copies an existing document, creating a new document with the same content.
|
|
1306
|
+
* Does not require re-uploading the document file.
|
|
1307
|
+
*/
|
|
1308
|
+
copyDocument<ThrowOnError extends boolean = false>(options: Options<CopyDocumentData, ThrowOnError>): RequestResult<CopyDocumentResponses, CopyDocumentErrors, ThrowOnError>;
|
|
1309
|
+
/**
|
|
1310
|
+
* Read a Figma (.fig) design as text with the caller's view access: its
|
|
1311
|
+
* pages, each page's top-level frames and sections with their text, the
|
|
1312
|
+
* components their instances use, and the file's components, styles and
|
|
1313
|
+
* variables.
|
|
1314
|
+
*/
|
|
1315
|
+
readDesign<ThrowOnError extends boolean = false>(options: Options<ReadDesignData, ThrowOnError>): RequestResult<ReadDesignResponses, ReadDesignErrors, ThrowOnError>;
|
|
1316
|
+
/**
|
|
1317
|
+
* Generates a presigned url to download the raw content of the document
|
|
1318
|
+
* For files with modification layers, they will not be applied in the downloaded file.
|
|
1319
|
+
*/
|
|
1320
|
+
exportDocument<ThrowOnError extends boolean = false>(options: Options<ExportDocumentData, ThrowOnError>): RequestResult<ExportDocumentResponses, ExportDocumentErrors, ThrowOnError>;
|
|
1321
|
+
/**
|
|
1322
|
+
* Handler for `GET /documents/{document_id}/github_prs`.
|
|
1323
|
+
*
|
|
1324
|
+
* Returns GitHub pull requests associated with a task document.
|
|
1325
|
+
* Returns 400 if the document is not a task.
|
|
1326
|
+
*/
|
|
1327
|
+
getDocumentGithubPullRequests<ThrowOnError extends boolean = false>(options: Options<GetDocumentGithubPullRequestsData, ThrowOnError>): RequestResult<GetDocumentGithubPullRequestsResponses, GetDocumentGithubPullRequestsErrors, ThrowOnError>;
|
|
1328
|
+
/**
|
|
1329
|
+
* Read an Illustrator (.ai) document as text with the caller's view access:
|
|
1330
|
+
* its artboards, its layer tree from top to bottom, and the text of its
|
|
1331
|
+
* text objects.
|
|
1332
|
+
*/
|
|
1333
|
+
readIllustratorDocument<ThrowOnError extends boolean = false>(options: Options<ReadIllustratorDocumentData, ThrowOnError>): RequestResult<ReadIllustratorDocumentResponses, ReadIllustratorDocumentErrors, ThrowOnError>;
|
|
1334
|
+
/**
|
|
1335
|
+
* Gets the presigned url(s) for the document. aka location
|
|
1336
|
+
*/
|
|
1337
|
+
getLocationHandler<ThrowOnError extends boolean = false>(options: Options<GetLocationHandlerData, ThrowOnError>): RequestResult<GetLocationHandlerResponses, GetLocationHandlerErrors, ThrowOnError>;
|
|
1338
|
+
/**
|
|
1339
|
+
* Handler for `GET /documents/{document_id}/location_v3`.
|
|
1340
|
+
*
|
|
1341
|
+
* Returns a presigned URL or sync service content for accessing the document.
|
|
1342
|
+
*/
|
|
1343
|
+
getDocumentLocationV3<ThrowOnError extends boolean = false>(options: Options<GetDocumentLocationV3Data, ThrowOnError>): RequestResult<GetDocumentLocationV3Responses, GetDocumentLocationV3Errors, ThrowOnError>;
|
|
1344
|
+
/**
|
|
1345
|
+
* Read a markdown document's or task's body with the revision it was read
|
|
1346
|
+
* at, to write it back with `PUT` without overwriting anyone's edits.
|
|
1347
|
+
*/
|
|
1348
|
+
getDocumentMarkdown<ThrowOnError extends boolean = false>(options: Options<GetDocumentMarkdownData, ThrowOnError>): RequestResult<GetDocumentMarkdownResponses, GetDocumentMarkdownErrors, ThrowOnError>;
|
|
1349
|
+
/**
|
|
1350
|
+
* Replace a markdown document's or task's body, only if the document is still
|
|
1351
|
+
* at the revision the caller read. Top-level blocks whose Markdown is
|
|
1352
|
+
* unchanged keep their comments and formatting; changed blocks are replaced.
|
|
1353
|
+
*/
|
|
1354
|
+
writeDocumentMarkdown<ThrowOnError extends boolean = false>(options: Options<WriteDocumentMarkdownData, ThrowOnError>): RequestResult<WriteDocumentMarkdownResponses, WriteDocumentMarkdownErrors, ThrowOnError>;
|
|
1355
|
+
/**
|
|
1356
|
+
* Permanently deletes a document.
|
|
1357
|
+
*/
|
|
1358
|
+
permanentlyDeleteDocument<ThrowOnError extends boolean = false>(options: Options<PermanentlyDeleteDocumentData, ThrowOnError>): RequestResult<PermanentlyDeleteDocumentResponses, PermanentlyDeleteDocumentErrors, ThrowOnError>;
|
|
1359
|
+
/**
|
|
1360
|
+
* Read a Photoshop (.psd or .psb) document as text with the caller's view
|
|
1361
|
+
* access: its canvas, its layer tree from top to bottom with each layer's
|
|
1362
|
+
* settings, and the text of its text layers.
|
|
1363
|
+
*/
|
|
1364
|
+
readPhotoshopDocument<ThrowOnError extends boolean = false>(options: Options<ReadPhotoshopDocumentData, ThrowOnError>): RequestResult<ReadPhotoshopDocumentResponses, ReadPhotoshopDocumentErrors, ThrowOnError>;
|
|
1365
|
+
/**
|
|
1366
|
+
* Read a PowerPoint deck as text with the caller's view access: every
|
|
1367
|
+
* slide's id and shapes with their ids, positions and text. Edits address
|
|
1368
|
+
* slides and shapes by these ids, which are not slide numbers.
|
|
1369
|
+
*/
|
|
1370
|
+
readPresentation<ThrowOnError extends boolean = false>(options: Options<ReadPresentationData, ThrowOnError>): RequestResult<ReadPresentationResponses, ReadPresentationErrors, ThrowOnError>;
|
|
1371
|
+
/**
|
|
1372
|
+
* Create an edited copy of a PowerPoint deck as a new presentation, leaving
|
|
1373
|
+
* the original unchanged. Needs view access to the deck and edit access to
|
|
1374
|
+
* the destination project; the outcome's `documentId` is the copy.
|
|
1375
|
+
*/
|
|
1376
|
+
copyPresentation<ThrowOnError extends boolean = false>(options: Options<CopyPresentationData, ThrowOnError>): RequestResult<CopyPresentationResponses, CopyPresentationErrors, ThrowOnError>;
|
|
1377
|
+
/**
|
|
1378
|
+
* Apply a batch of edit operations to a PowerPoint deck atomically with the
|
|
1379
|
+
* caller's edit access, saved as a new version. If any operation fails,
|
|
1380
|
+
* nothing is saved.
|
|
1381
|
+
*/
|
|
1382
|
+
editPresentation<ThrowOnError extends boolean = false>(options: Options<EditPresentationData, ThrowOnError>): RequestResult<EditPresentationResponses, EditPresentationErrors, ThrowOnError>;
|
|
1383
|
+
/**
|
|
1384
|
+
* Fetches the document pdf processing result for a given document id
|
|
1385
|
+
*/
|
|
1386
|
+
getDocumentProcessingResult<ThrowOnError extends boolean = false>(options: Options<GetDocumentProcessingResultData, ThrowOnError>): RequestResult<GetDocumentProcessingResultResponses, GetDocumentProcessingResultErrors, ThrowOnError>;
|
|
1387
|
+
/**
|
|
1388
|
+
* Fetches the document processing result for a given document id and job id
|
|
1389
|
+
*/
|
|
1390
|
+
jobProcessingResultHandler<ThrowOnError extends boolean = false>(options: Options<JobProcessingResultHandlerData, ThrowOnError>): RequestResult<JobProcessingResultHandlerResponses, JobProcessingResultHandlerErrors, ThrowOnError>;
|
|
1391
|
+
/**
|
|
1392
|
+
* Deletes a specific document
|
|
1393
|
+
*/
|
|
1394
|
+
revertDeleteDocument<ThrowOnError extends boolean = false>(options: Options<RevertDeleteDocumentData, ThrowOnError>): RequestResult<RevertDeleteDocumentResponses, RevertDeleteDocumentErrors, ThrowOnError>;
|
|
1395
|
+
/**
|
|
1396
|
+
* Handler for `GET /documents/{document_id}/short_id`.
|
|
1397
|
+
*
|
|
1398
|
+
* Returns the short UUID for a document.
|
|
1399
|
+
*/
|
|
1400
|
+
getDocumentShortId<ThrowOnError extends boolean = false>(options: Options<GetDocumentShortIdData, ThrowOnError>): RequestResult<GetDocumentShortIdResponses, GetDocumentShortIdErrors, ThrowOnError>;
|
|
1401
|
+
/**
|
|
1402
|
+
* For any file that isn't PDF or DOCX, use this endpoint for saving.
|
|
1403
|
+
* 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.
|
|
1404
|
+
* 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).
|
|
1405
|
+
*/
|
|
1406
|
+
simpleSave<ThrowOnError extends boolean = false>(options: Options<SimpleSaveData, ThrowOnError>): RequestResult<SimpleSaveResponses, SimpleSaveErrors, ThrowOnError>;
|
|
1407
|
+
/**
|
|
1408
|
+
* Gets when to use a skill. `description` is absent for a skill created
|
|
1409
|
+
* before descriptions existed.
|
|
1410
|
+
*/
|
|
1411
|
+
getSkillDescription<ThrowOnError extends boolean = false>(options: Options<GetSkillDescriptionData, ThrowOnError>): RequestResult<GetSkillDescriptionResponses, GetSkillDescriptionErrors, ThrowOnError>;
|
|
1412
|
+
/**
|
|
1413
|
+
* Sets when to use a skill: one line starting "Use when", at most 300
|
|
1414
|
+
* characters. Agents choose skills for a request by it.
|
|
1415
|
+
*/
|
|
1416
|
+
setSkillDescription<ThrowOnError extends boolean = false>(options: Options<SetSkillDescriptionData, ThrowOnError>): RequestResult<SetSkillDescriptionResponses, SetSkillDescriptionErrors, ThrowOnError>;
|
|
1417
|
+
/**
|
|
1418
|
+
* Edit a native spreadsheet by instructions with the caller's edit access:
|
|
1419
|
+
* a writer model reads the workbook and saves one atomic batch, with AI
|
|
1420
|
+
* admission and billing. A workbook changed while it worked saves nothing
|
|
1421
|
+
* and answers 409.
|
|
1422
|
+
*
|
|
1423
|
+
* A client that disconnects drops the worker request, which cancels the
|
|
1424
|
+
* edit before its save.
|
|
1425
|
+
*/
|
|
1426
|
+
editSpreadsheetWithAi<ThrowOnError extends boolean = false>(options: Options<EditSpreadsheetWithAiData, ThrowOnError>): RequestResult<EditSpreadsheetWithAiResponses, EditSpreadsheetWithAiErrors, ThrowOnError>;
|
|
1427
|
+
/**
|
|
1428
|
+
* Evaluate scratch formulas against a native spreadsheet with view access,
|
|
1429
|
+
* optionally with hypothetical inputs. Nothing is saved.
|
|
1430
|
+
*/
|
|
1431
|
+
calculateSpreadsheet<ThrowOnError extends boolean = false>(options: Options<CalculateSpreadsheetData, ThrowOnError>): RequestResult<CalculateSpreadsheetResponses, CalculateSpreadsheetErrors, ThrowOnError>;
|
|
1432
|
+
/**
|
|
1433
|
+
* Apply one atomic batch of operations to a native spreadsheet with edit
|
|
1434
|
+
* access. Every operation validates before anything is saved; a workbook that
|
|
1435
|
+
* changed since `expectedRevision` rejects the batch with 409.
|
|
1436
|
+
*/
|
|
1437
|
+
editSpreadsheet<ThrowOnError extends boolean = false>(options: Options<EditSpreadsheetData, ThrowOnError>): RequestResult<EditSpreadsheetResponses, EditSpreadsheetErrors, ThrowOnError>;
|
|
1438
|
+
/**
|
|
1439
|
+
* Read a native spreadsheet with view access: every sheet's summary, and the
|
|
1440
|
+
* cells of the requested ranges. Returns the revision an edit needs.
|
|
1441
|
+
*/
|
|
1442
|
+
readSpreadsheet<ThrowOnError extends boolean = false>(options: Options<ReadSpreadsheetData, ThrowOnError>): RequestResult<ReadSpreadsheetResponses, ReadSpreadsheetErrors, ThrowOnError>;
|
|
1443
|
+
/**
|
|
1444
|
+
* Gets the team-share state of a document. The team is resolved from the
|
|
1445
|
+
* document owner's team membership; `teamId` is omitted when the owner does
|
|
1446
|
+
* not belong to a team.
|
|
1447
|
+
*/
|
|
1448
|
+
getDocumentTeamShare<ThrowOnError extends boolean = false>(options: Options<GetDocumentTeamShareData, ThrowOnError>): RequestResult<GetDocumentTeamShareResponses, GetDocumentTeamShareErrors, ThrowOnError>;
|
|
1449
|
+
/**
|
|
1450
|
+
* Sets explicit team sharing. Requires a verified acting identity matching
|
|
1451
|
+
* the persisted document owner, not merely effective Edit or Owner access.
|
|
1452
|
+
* Initial enable defaults to Edit; repeated enable preserves the chosen level.
|
|
1453
|
+
* Clear removes only the managed direct grant, not inherited team access.
|
|
1454
|
+
*/
|
|
1455
|
+
setDocumentTeamShare<ThrowOnError extends boolean = false>(options: Options<SetDocumentTeamShareData, ThrowOnError>): RequestResult<SetDocumentTeamShareResponses, SetDocumentTeamShareErrors, ThrowOnError>;
|
|
1456
|
+
/**
|
|
1457
|
+
* Read current Markdown or extracted file text with the document's view receipt.
|
|
1458
|
+
*/
|
|
1459
|
+
getDocumentTextContent<ThrowOnError extends boolean = false>(options: Options<GetDocumentTextContentData, ThrowOnError>): RequestResult<GetDocumentTextContentResponses, GetDocumentTextContentErrors, ThrowOnError>;
|
|
1460
|
+
/**
|
|
1461
|
+
* Gets the list of users who have viewed a given document
|
|
1462
|
+
*/
|
|
1463
|
+
getDocumentViewsHandler<ThrowOnError extends boolean = false>(options: Options<GetDocumentViewsHandlerData, ThrowOnError>): RequestResult<GetDocumentViewsHandlerResponses, GetDocumentViewsHandlerErrors, ThrowOnError>;
|
|
1464
|
+
/**
|
|
1465
|
+
* Read an uploaded Word document as it stands now, including edits made in
|
|
1466
|
+
* Rox, with the caller's view access: every paragraph, table cell and
|
|
1467
|
+
* content control with its stable id, style and text, tracked changes, and
|
|
1468
|
+
* Word comments. Long documents are paged.
|
|
1469
|
+
*/
|
|
1470
|
+
readWordDocument<ThrowOnError extends boolean = false>(options: Options<ReadWordDocumentData, ThrowOnError>): RequestResult<ReadWordDocumentResponses, ReadWordDocumentErrors, ThrowOnError>;
|
|
1471
|
+
/**
|
|
1472
|
+
* Apply a batch of edits to an uploaded Word document's live copy
|
|
1473
|
+
* atomically with the caller's edit access. Nothing changes if any
|
|
1474
|
+
* operation fails. Returns the changed blocks as they now read.
|
|
1475
|
+
*/
|
|
1476
|
+
editWordDocument<ThrowOnError extends boolean = false>(options: Options<EditWordDocumentData, ThrowOnError>): RequestResult<EditWordDocumentResponses, EditWordDocumentErrors, ThrowOnError>;
|
|
1477
|
+
/**
|
|
1478
|
+
* Gets a particular document by its id
|
|
1479
|
+
*/
|
|
1480
|
+
getDocumentVersion<ThrowOnError extends boolean = false>(options: Options<GetDocumentVersionData, ThrowOnError>): RequestResult<GetDocumentVersionResponses, GetDocumentVersionErrors, ThrowOnError>;
|
|
1481
|
+
/**
|
|
1482
|
+
* State access request state through the domain service.
|
|
1483
|
+
*/
|
|
1484
|
+
accessRequestsState<ThrowOnError extends boolean = false>(options: Options<AccessRequestsStateData, ThrowOnError>): RequestResult<AccessRequestsStateResponses, AccessRequestsStateErrors, ThrowOnError>;
|
|
1485
|
+
/**
|
|
1486
|
+
* Cancel access request state through the domain service.
|
|
1487
|
+
*/
|
|
1488
|
+
accessRequestsCancel<ThrowOnError extends boolean = false>(options: Options<AccessRequestsCancelData, ThrowOnError>): RequestResult<AccessRequestsCancelResponses, AccessRequestsCancelErrors, ThrowOnError>;
|
|
1489
|
+
/**
|
|
1490
|
+
* Submit access request state through the domain service.
|
|
1491
|
+
*/
|
|
1492
|
+
accessRequestsSubmit<ThrowOnError extends boolean = false>(options: Options<AccessRequestsSubmitData, ThrowOnError>): RequestResult<AccessRequestsSubmitResponses, AccessRequestsSubmitErrors, ThrowOnError>;
|
|
1493
|
+
/**
|
|
1494
|
+
* Resolve access request state through the domain service.
|
|
1495
|
+
*/
|
|
1496
|
+
accessRequestsResolve<ThrowOnError extends boolean = false>(options: Options<AccessRequestsResolveData, ThrowOnError>): RequestResult<AccessRequestsResolveResponses, AccessRequestsResolveErrors, ThrowOnError>;
|
|
1497
|
+
/**
|
|
1498
|
+
* Direct access request state through the domain service.
|
|
1499
|
+
*/
|
|
1500
|
+
accessRequestsDirect<ThrowOnError extends boolean = false>(options: Options<AccessRequestsDirectData, ThrowOnError>): RequestResult<AccessRequestsDirectResponses, AccessRequestsDirectErrors, ThrowOnError>;
|
|
1501
|
+
/**
|
|
1502
|
+
* Remove direct access request state through the domain service.
|
|
1503
|
+
*/
|
|
1504
|
+
accessRequestsRemoveDirect<ThrowOnError extends boolean = false>(options: Options<AccessRequestsRemoveDirectData, ThrowOnError>): RequestResult<AccessRequestsRemoveDirectResponses, AccessRequestsRemoveDirectErrors, ThrowOnError>;
|
|
1505
|
+
/**
|
|
1506
|
+
* Set direct access request state through the domain service.
|
|
1507
|
+
*/
|
|
1508
|
+
accessRequestsSetDirect<ThrowOnError extends boolean = false>(options: Options<AccessRequestsSetDirectData, ThrowOnError>): RequestResult<AccessRequestsSetDirectResponses, AccessRequestsSetDirectErrors, ThrowOnError>;
|
|
1509
|
+
/**
|
|
1510
|
+
* Get the current user's permission for a given entity.
|
|
1511
|
+
*/
|
|
1512
|
+
getEntityPermission<ThrowOnError extends boolean = false>(options: Options<GetEntityPermissionData, ThrowOnError>): RequestResult<GetEntityPermissionResponses, GetEntityPermissionErrors, ThrowOnError>;
|
|
1513
|
+
/**
|
|
1514
|
+
* List external chats the caller can view, including without a provider account.
|
|
1515
|
+
*/
|
|
1516
|
+
externalChats<ThrowOnError extends boolean = false>(options?: Options<ExternalChatsData, ThrowOnError>): RequestResult<ExternalChatsResponses, unknown, ThrowOnError>;
|
|
1517
|
+
/**
|
|
1518
|
+
* Add one of the caller's provider chats as their own external chat.
|
|
1519
|
+
*/
|
|
1520
|
+
externalChatAdd<ThrowOnError extends boolean = false>(options: Options<ExternalChatAddData, ThrowOnError>): RequestResult<ExternalChatAddResponses, unknown, ThrowOnError>;
|
|
1521
|
+
/**
|
|
1522
|
+
* Stop syncing the chat, locally. Owner only, in their own session.
|
|
1523
|
+
*/
|
|
1524
|
+
externalChatRemove<ThrowOnError extends boolean = false>(options: Options<ExternalChatRemoveData, ThrowOnError>): RequestResult<ExternalChatRemoveResponses, unknown, ThrowOnError>;
|
|
1525
|
+
/**
|
|
1526
|
+
* An external chat the caller can read.
|
|
1527
|
+
*/
|
|
1528
|
+
externalChat<ThrowOnError extends boolean = false>(options: Options<ExternalChatData, ThrowOnError>): RequestResult<ExternalChatResponses, unknown, ThrowOnError>;
|
|
1529
|
+
/**
|
|
1530
|
+
* Stage one attachment for a later media send in this chat.
|
|
1531
|
+
*/
|
|
1532
|
+
externalChatUpload<ThrowOnError extends boolean = false>(options: Options<ExternalChatUploadData, ThrowOnError>): RequestResult<ExternalChatUploadResponses, unknown, ThrowOnError>;
|
|
1533
|
+
/**
|
|
1534
|
+
* The caller's send progress for intents or messages.
|
|
1535
|
+
*/
|
|
1536
|
+
externalChatDelivery<ThrowOnError extends boolean = false>(options: Options<ExternalChatDeliveryData, ThrowOnError>): RequestResult<ExternalChatDeliveryResponses, unknown, ThrowOnError>;
|
|
1537
|
+
/**
|
|
1538
|
+
* Newest-first timeline through ordinary view access.
|
|
1539
|
+
*/
|
|
1540
|
+
externalChatMessages<ThrowOnError extends boolean = false>(options: Options<ExternalChatMessagesData, ThrowOnError>): RequestResult<ExternalChatMessagesResponses, unknown, ThrowOnError>;
|
|
1541
|
+
/**
|
|
1542
|
+
* Attachment states of messages, by message id (at most 100).
|
|
1543
|
+
*/
|
|
1544
|
+
externalChatMessageAttachments<ThrowOnError extends boolean = false>(options: Options<ExternalChatMessageAttachmentsData, ThrowOnError>): RequestResult<ExternalChatMessageAttachmentsResponses, unknown, ThrowOnError>;
|
|
1545
|
+
/**
|
|
1546
|
+
* One message of the timeline, as the timeline shows it.
|
|
1547
|
+
*/
|
|
1548
|
+
externalChatMessage<ThrowOnError extends boolean = false>(options: Options<ExternalChatMessageData, ThrowOnError>): RequestResult<ExternalChatMessageResponses, unknown, ThrowOnError>;
|
|
1549
|
+
/**
|
|
1550
|
+
* Generic Share dialog policy.
|
|
1551
|
+
*/
|
|
1552
|
+
externalChatPermissions<ThrowOnError extends boolean = false>(options: Options<ExternalChatPermissionsData, ThrowOnError>): RequestResult<ExternalChatPermissionsResponses, unknown, ThrowOnError>;
|
|
1553
|
+
/**
|
|
1554
|
+
* The owner, in their own session, updates link, team and channel sharing.
|
|
1555
|
+
*/
|
|
1556
|
+
externalChatUpdatePermissions<ThrowOnError extends boolean = false>(options: Options<ExternalChatUpdatePermissionsData, ThrowOnError>): RequestResult<ExternalChatUpdatePermissionsResponses, unknown, ThrowOnError>;
|
|
1557
|
+
/**
|
|
1558
|
+
* Advance this viewer's read position.
|
|
1559
|
+
*/
|
|
1560
|
+
externalChatRead<ThrowOnError extends boolean = false>(options: Options<ExternalChatReadData, ThrowOnError>): RequestResult<ExternalChatReadResponses, unknown, ThrowOnError>;
|
|
1561
|
+
/**
|
|
1562
|
+
* Caller-owned pending, failed and uncertain sends.
|
|
1563
|
+
*/
|
|
1564
|
+
externalChatSends<ThrowOnError extends boolean = false>(options: Options<ExternalChatSendsData, ThrowOnError>): RequestResult<ExternalChatSendsResponses, unknown, ThrowOnError>;
|
|
1565
|
+
/**
|
|
1566
|
+
* Send to the chat from the caller's own provider account (one request per second per user).
|
|
1567
|
+
*/
|
|
1568
|
+
externalChatSend<ThrowOnError extends boolean = false>(options: Options<ExternalChatSendData, ThrowOnError>): RequestResult<ExternalChatSendResponses, ExternalChatSendErrors, ThrowOnError>;
|
|
1569
|
+
/**
|
|
1570
|
+
* List the caller's favorites.
|
|
1571
|
+
*/
|
|
1572
|
+
listFavorites<ThrowOnError extends boolean = false>(options?: Options<ListFavoritesData, ThrowOnError>): RequestResult<ListFavoritesResponses, ListFavoritesErrors, ThrowOnError>;
|
|
1573
|
+
/**
|
|
1574
|
+
* Favorite an entity in the caller's collection.
|
|
1575
|
+
*/
|
|
1576
|
+
addFavorite<ThrowOnError extends boolean = false>(options: Options<AddFavoriteData, ThrowOnError>): RequestResult<AddFavoriteResponses, AddFavoriteErrors, ThrowOnError>;
|
|
1577
|
+
/**
|
|
1578
|
+
* Persist a manual order for the caller's favorites.
|
|
1579
|
+
*/
|
|
1580
|
+
reorderFavorites<ThrowOnError extends boolean = false>(options: Options<ReorderFavoritesData, ThrowOnError>): RequestResult<ReorderFavoritesResponses, ReorderFavoritesErrors, ThrowOnError>;
|
|
1581
|
+
/**
|
|
1582
|
+
* Remove a favorite by entity.
|
|
1583
|
+
*/
|
|
1584
|
+
removeFavoriteByEntity<ThrowOnError extends boolean = false>(options: Options<RemoveFavoriteByEntityData, ThrowOnError>): RequestResult<RemoveFavoriteByEntityResponses, RemoveFavoriteByEntityErrors, ThrowOnError>;
|
|
1585
|
+
/**
|
|
1586
|
+
* Get a visible foreign entity by the identifier its source system assigned.
|
|
1587
|
+
*
|
|
1588
|
+
* `foreign_entity_id` is a wildcard path segment: sources store slashes inside
|
|
1589
|
+
* the identifier, for example `owner/repo/pull/12`.
|
|
1590
|
+
*
|
|
1591
|
+
* Authorization matches the by-id route. Internal service callers see every
|
|
1592
|
+
* record; an authenticated user sees a record only when they have view access
|
|
1593
|
+
* to it, and records they cannot view are reported as `404` so the route never
|
|
1594
|
+
* reveals that a mapping exists. Bot tokens are not accepted here — they use
|
|
1595
|
+
* the by-id route, which mints a bot-scoped receipt.
|
|
1596
|
+
*/
|
|
1597
|
+
getForeignEntityBySource<ThrowOnError extends boolean = false>(options: Options<GetForeignEntityBySourceData, ThrowOnError>): RequestResult<GetForeignEntityBySourceResponses, GetForeignEntityBySourceErrors, ThrowOnError>;
|
|
1598
|
+
/**
|
|
1599
|
+
* Get a visible foreign entity by its internal ID.
|
|
1600
|
+
*/
|
|
1601
|
+
getForeignEntity<ThrowOnError extends boolean = false>(options: Options<GetForeignEntityData, ThrowOnError>): RequestResult<GetForeignEntityResponses, GetForeignEntityErrors, ThrowOnError>;
|
|
1602
|
+
/**
|
|
1603
|
+
* The live forms over a database the caller can see, for the grid's chip
|
|
1604
|
+
* and the delete-table confirmation.
|
|
1605
|
+
*/
|
|
1606
|
+
listForms<ThrowOnError extends boolean = false>(options: Options<ListFormsData, ThrowOnError>): RequestResult<ListFormsResponses, ListFormsErrors, ThrowOnError>;
|
|
1607
|
+
/**
|
|
1608
|
+
* Create a form owned by the caller: over a new database named like it, or
|
|
1609
|
+
* over an existing table of a database the caller owns. Database Edit is
|
|
1610
|
+
* not enough to attach a form: the form's editors gain Edit on the
|
|
1611
|
+
* database through it.
|
|
1612
|
+
*/
|
|
1613
|
+
createForm<ThrowOnError extends boolean = false>(options: Options<CreateFormData, ThrowOnError>): RequestResult<CreateFormResponses, CreateFormErrors, ThrowOnError>;
|
|
1614
|
+
/**
|
|
1615
|
+
* Every live form the caller holds a grant on, newest first, with their
|
|
1616
|
+
* level: what Drive and Quick Access list. Public forms reached only by
|
|
1617
|
+
* their link are not listed.
|
|
1618
|
+
*/
|
|
1619
|
+
listAccessibleForms<ThrowOnError extends boolean = false>(options?: Options<ListAccessibleFormsData, ThrowOnError>): RequestResult<ListAccessibleFormsResponses, ListAccessibleFormsErrors, ThrowOnError>;
|
|
1620
|
+
/**
|
|
1621
|
+
* A form with its layout, each question joined with its column's title,
|
|
1622
|
+
* type and options. Never rows. Readable by anyone when the form is public.
|
|
1623
|
+
*/
|
|
1624
|
+
getForm<ThrowOnError extends boolean = false>(options: Options<GetFormData, ThrowOnError>): RequestResult<GetFormResponses, GetFormErrors, ThrowOnError>;
|
|
1625
|
+
/**
|
|
1626
|
+
* Change a form's facts. The description and confirmation message take
|
|
1627
|
+
* edit; who responds, open or closed, the closing time and tallies take
|
|
1628
|
+
* its owner.
|
|
1629
|
+
*/
|
|
1630
|
+
updateForm<ThrowOnError extends boolean = false>(options: Options<UpdateFormData, ThrowOnError>): RequestResult<UpdateFormResponses, UpdateFormErrors, ThrowOnError>;
|
|
1631
|
+
/**
|
|
1632
|
+
* Replace a form's icon and color without changing its content timestamp.
|
|
1633
|
+
*/
|
|
1634
|
+
setFormAppearance<ThrowOnError extends boolean = false>(options: Options<SetFormAppearanceData, ThrowOnError>): RequestResult<SetFormAppearanceResponses, SetFormAppearanceErrors, ThrowOnError>;
|
|
1635
|
+
/**
|
|
1636
|
+
* Open the editor-only collaborative layout, or publish its latest valid
|
|
1637
|
+
* revision. Content stays in the existing collaboration surface.
|
|
1638
|
+
*/
|
|
1639
|
+
collaborateForm<ThrowOnError extends boolean = false>(options: Options<CollaborateFormData, ThrowOnError>): RequestResult<CollaborateFormResponses, CollaborateFormErrors, ThrowOnError>;
|
|
1640
|
+
/**
|
|
1641
|
+
* Save a validated replacement in the shared layout and report publication.
|
|
1642
|
+
* A 200 response with `publicationError` means the draft is saved, while
|
|
1643
|
+
* respondents still see `detail`. Retrying collaboration retries publication.
|
|
1644
|
+
*/
|
|
1645
|
+
putFormLayout<ThrowOnError extends boolean = false>(options: Options<PutFormLayoutData, ThrowOnError>): RequestResult<PutFormLayoutResponses, PutFormLayoutErrors, ThrowOnError>;
|
|
1646
|
+
/**
|
|
1647
|
+
* A form's recipients, for its owner. Link and team sharing are always
|
|
1648
|
+
* `null`: a form's public audience is its own setting.
|
|
1649
|
+
*/
|
|
1650
|
+
getFormPermissions<ThrowOnError extends boolean = false>(options: Options<GetFormPermissionsData, ThrowOnError>): RequestResult<GetFormPermissionsResponses, GetFormPermissionsErrors, ThrowOnError>;
|
|
1651
|
+
/**
|
|
1652
|
+
* Change a form's channel recipients, for its owner. Turning on link or
|
|
1653
|
+
* team sharing is refused.
|
|
1654
|
+
*/
|
|
1655
|
+
updateFormPermissions<ThrowOnError extends boolean = false>(options: Options<UpdateFormPermissionsData, ThrowOnError>): RequestResult<UpdateFormPermissionsResponses, UpdateFormPermissionsErrors, ThrowOnError>;
|
|
1656
|
+
/**
|
|
1657
|
+
* Respond to a form. A gate that stops the response answers `stopped` and
|
|
1658
|
+
* writes nothing to the table. A public form takes anonymous responses.
|
|
1659
|
+
*/
|
|
1660
|
+
submitFormResponse<ThrowOnError extends boolean = false>(options: Options<SubmitFormResponseData, ThrowOnError>): RequestResult<SubmitFormResponseResponses, SubmitFormResponseErrors, ThrowOnError>;
|
|
1661
|
+
/**
|
|
1662
|
+
* The signed-in caller's own response, with the row's current cells.
|
|
1663
|
+
*/
|
|
1664
|
+
getMyFormResponse<ThrowOnError extends boolean = false>(options: Options<GetMyFormResponseData, ThrowOnError>): RequestResult<GetMyFormResponseResponses, GetMyFormResponseErrors, ThrowOnError>;
|
|
1665
|
+
/**
|
|
1666
|
+
* Replace the signed-in caller's answers while the form is open. A gate
|
|
1667
|
+
* that stops the edit leaves the saved response as it was.
|
|
1668
|
+
*/
|
|
1669
|
+
editMyFormResponse<ThrowOnError extends boolean = false>(options: Options<EditMyFormResponseData, ThrowOnError>): RequestResult<EditMyFormResponseResponses, EditMyFormResponseErrors, ThrowOnError>;
|
|
1670
|
+
/**
|
|
1671
|
+
* Response counts for the form's editors.
|
|
1672
|
+
*/
|
|
1673
|
+
getFormResponseSummary<ThrowOnError extends boolean = false>(options: Options<GetFormResponseSummaryData, ThrowOnError>): RequestResult<GetFormResponseSummaryResponses, GetFormResponseSummaryErrors, ThrowOnError>;
|
|
1674
|
+
/**
|
|
1675
|
+
* Option counts of the form's choice questions: for respondents when the
|
|
1676
|
+
* owner shows them, for editors always.
|
|
1677
|
+
*/
|
|
1678
|
+
getFormTally<ThrowOnError extends boolean = false>(options: Options<GetFormTallyData, ThrowOnError>): RequestResult<GetFormTallyResponses, GetFormTallyErrors, ThrowOnError>;
|
|
1679
|
+
/**
|
|
1680
|
+
* Redirects an authenticated user to the github sync app installation page.
|
|
1681
|
+
*/
|
|
1682
|
+
installSync<ThrowOnError extends boolean = false>(options?: Options<InstallSyncData, ThrowOnError>): RequestResult<unknown, InstallSyncErrors, ThrowOnError>;
|
|
1683
|
+
/**
|
|
1684
|
+
* List the repositories and authors among the GitHub pull requests visible to the caller.
|
|
1685
|
+
*/
|
|
1686
|
+
getGithubPullRequestFacets<ThrowOnError extends boolean = false>(options?: Options<GetGithubPullRequestFacetsData, ThrowOnError>): RequestResult<GetGithubPullRequestFacetsResponses, GetGithubPullRequestFacetsErrors, ThrowOnError>;
|
|
1687
|
+
/**
|
|
1688
|
+
* Get the pull request behind a foreign entity record the caller can view.
|
|
1689
|
+
*/
|
|
1690
|
+
getGithubPullRequest<ThrowOnError extends boolean = false>(options: Options<GetGithubPullRequestData, ThrowOnError>): RequestResult<GetGithubPullRequestResponses, GetGithubPullRequestErrors, ThrowOnError>;
|
|
1691
|
+
/**
|
|
1692
|
+
* Get the changes of the pull request behind a foreign entity record the caller can view.
|
|
1693
|
+
*/
|
|
1694
|
+
getGithubPullRequestChanges<ThrowOnError extends boolean = false>(options: Options<GetGithubPullRequestChangesData, ThrowOnError>): RequestResult<GetGithubPullRequestChangesResponses, GetGithubPullRequestChangesErrors, ThrowOnError>;
|
|
1695
|
+
/**
|
|
1696
|
+
* Get the patch of changes of the pull request behind a foreign entity record the caller can
|
|
1697
|
+
* view.
|
|
1698
|
+
*/
|
|
1699
|
+
getGithubPullRequestChangesPatch<ThrowOnError extends boolean = false>(options: Options<GetGithubPullRequestChangesPatchData, ThrowOnError>): RequestResult<GetGithubPullRequestChangesPatchResponses, GetGithubPullRequestChangesPatchErrors, ThrowOnError>;
|
|
1700
|
+
/**
|
|
1701
|
+
* Handler for `POST /harness-pairings`.
|
|
1702
|
+
*
|
|
1703
|
+
* Unauthenticated by design: the daemon has no credential yet - obtaining one
|
|
1704
|
+
* is the point. The pairing releases nothing until a signed-in user approves
|
|
1705
|
+
* it, and creation is throttled in the domain service.
|
|
1706
|
+
*/
|
|
1707
|
+
createHarnessPairing<ThrowOnError extends boolean = false>(options: Options<CreateHarnessPairingData, ThrowOnError>): RequestResult<CreateHarnessPairingResponses, CreateHarnessPairingErrors, ThrowOnError>;
|
|
1708
|
+
/**
|
|
1709
|
+
* Handler for `GET /harness-pairings/{code}`.
|
|
1710
|
+
*/
|
|
1711
|
+
getHarnessPairing<ThrowOnError extends boolean = false>(options: Options<GetHarnessPairingData, ThrowOnError>): RequestResult<GetHarnessPairingResponses, GetHarnessPairingErrors, ThrowOnError>;
|
|
1712
|
+
/**
|
|
1713
|
+
* Handler for `POST /harness-pairings/{code}/approve`.
|
|
1714
|
+
*/
|
|
1715
|
+
approveHarnessPairing<ThrowOnError extends boolean = false>(options: Options<ApproveHarnessPairingData, ThrowOnError>): RequestResult<ApproveHarnessPairingResponses, ApproveHarnessPairingErrors, ThrowOnError>;
|
|
1716
|
+
/**
|
|
1717
|
+
* Handler for `POST /harness-pairings/{pairing_id}/claim`.
|
|
1718
|
+
*
|
|
1719
|
+
* Unauthenticated like pairing creation; the device secret minted alongside
|
|
1720
|
+
* the pairing is the credential, and the pairing id (not the short user
|
|
1721
|
+
* code) addresses it.
|
|
1722
|
+
*/
|
|
1723
|
+
claimHarnessPairing<ThrowOnError extends boolean = false>(options: Options<ClaimHarnessPairingData, ThrowOnError>): RequestResult<ClaimHarnessPairingResponses, ClaimHarnessPairingErrors, ThrowOnError>;
|
|
1724
|
+
/**
|
|
1725
|
+
* Handler for `GET /harnesses`.
|
|
1726
|
+
*/
|
|
1727
|
+
listHarnesses<ThrowOnError extends boolean = false>(options?: Options<ListHarnessesData, ThrowOnError>): RequestResult<ListHarnessesResponses, ListHarnessesErrors, ThrowOnError>;
|
|
1728
|
+
/**
|
|
1729
|
+
* Handler for `GET /harnesses/directory`.
|
|
1730
|
+
*/
|
|
1731
|
+
listHarnessDirectory<ThrowOnError extends boolean = false>(options?: Options<ListHarnessDirectoryData, ThrowOnError>): RequestResult<ListHarnessDirectoryResponses, ListHarnessDirectoryErrors, ThrowOnError>;
|
|
1732
|
+
/**
|
|
1733
|
+
* Handler for `DELETE /harnesses/me`.
|
|
1734
|
+
*
|
|
1735
|
+
* A daemon retiring itself: the valid credential is the authorization.
|
|
1736
|
+
*/
|
|
1737
|
+
deleteSelfHarness<ThrowOnError extends boolean = false>(options?: Options<DeleteSelfHarnessData, ThrowOnError>): RequestResult<DeleteSelfHarnessResponses, DeleteSelfHarnessErrors, ThrowOnError>;
|
|
1738
|
+
/**
|
|
1739
|
+
* Handler for `GET /harnesses/me`.
|
|
1740
|
+
*/
|
|
1741
|
+
getSelfHarness<ThrowOnError extends boolean = false>(options?: Options<GetSelfHarnessData, ThrowOnError>): RequestResult<GetSelfHarnessResponses, GetSelfHarnessErrors, ThrowOnError>;
|
|
1742
|
+
/**
|
|
1743
|
+
* Handler for `GET /harnesses/me/agents`.
|
|
1744
|
+
*/
|
|
1745
|
+
listHarnessAgents<ThrowOnError extends boolean = false>(options?: Options<ListHarnessAgentsData, ThrowOnError>): RequestResult<ListHarnessAgentsResponses, ListHarnessAgentsErrors, ThrowOnError>;
|
|
1746
|
+
/**
|
|
1747
|
+
* Handler for `GET /harnesses/me/sessions`.
|
|
1748
|
+
*/
|
|
1749
|
+
listHarnessSessions<ThrowOnError extends boolean = false>(options?: Options<ListHarnessSessionsData, ThrowOnError>): RequestResult<ListHarnessSessionsResponses, ListHarnessSessionsErrors, ThrowOnError>;
|
|
1750
|
+
/**
|
|
1751
|
+
* Handler for `DELETE /harnesses/{harness_id}`.
|
|
1752
|
+
*/
|
|
1753
|
+
deleteHarness<ThrowOnError extends boolean = false>(options: Options<DeleteHarnessData, ThrowOnError>): RequestResult<DeleteHarnessResponses, DeleteHarnessErrors, ThrowOnError>;
|
|
1754
|
+
/**
|
|
1755
|
+
* Handler for `PATCH /harnesses/{harness_id}`.
|
|
1756
|
+
*/
|
|
1757
|
+
patchHarness<ThrowOnError extends boolean = false>(options: Options<PatchHarnessData, ThrowOnError>): RequestResult<PatchHarnessResponses, PatchHarnessErrors, ThrowOnError>;
|
|
1758
|
+
/**
|
|
1759
|
+
* Handler for `GET /harnesses/{harness_id}/residents`.
|
|
1760
|
+
*/
|
|
1761
|
+
listHarnessResidents<ThrowOnError extends boolean = false>(options: Options<ListHarnessResidentsData, ThrowOnError>): RequestResult<ListHarnessResidentsResponses, ListHarnessResidentsErrors, ThrowOnError>;
|
|
1762
|
+
/**
|
|
1763
|
+
* Handler for `PUT /harnesses/{harness_id}/team-access`.
|
|
1764
|
+
*
|
|
1765
|
+
* Requires the owner's own session: an agent can ask for access to a machine
|
|
1766
|
+
* but never open one, since that grants code execution on it.
|
|
1767
|
+
*/
|
|
1768
|
+
setHarnessTeamAccess<ThrowOnError extends boolean = false>(options: Options<SetHarnessTeamAccessData, ThrowOnError>): RequestResult<SetHarnessTeamAccessResponses, SetHarnessTeamAccessErrors, ThrowOnError>;
|
|
1769
|
+
/**
|
|
1770
|
+
* Health check
|
|
1771
|
+
*/
|
|
1772
|
+
healthHandler<ThrowOnError extends boolean = false>(options?: Options<HealthHandlerData, ThrowOnError>): RequestResult<HealthHandlerResponses, unknown, ThrowOnError>;
|
|
1773
|
+
/**
|
|
1774
|
+
* Gets the users history
|
|
1775
|
+
*/
|
|
1776
|
+
getHistoryHandler<ThrowOnError extends boolean = false>(options?: Options<GetHistoryHandlerData, ThrowOnError>): RequestResult<GetHistoryHandlerResponses, GetHistoryHandlerErrors, ThrowOnError>;
|
|
1777
|
+
/**
|
|
1778
|
+
* Deletes an item from the user's history
|
|
1779
|
+
*/
|
|
1780
|
+
deleteHistoryHandler<ThrowOnError extends boolean = false>(options: Options<DeleteHistoryHandlerData, ThrowOnError>): RequestResult<DeleteHistoryHandlerResponses, DeleteHistoryHandlerErrors, ThrowOnError>;
|
|
1781
|
+
/**
|
|
1782
|
+
* Upserts an item into the user's history and performs other necessary tracking actions
|
|
1783
|
+
*/
|
|
1784
|
+
upsertHistoryHandler<ThrowOnError extends boolean = false>(options: Options<UpsertHistoryHandlerData, ThrowOnError>): RequestResult<UpsertHistoryHandlerResponses, UpsertHistoryHandlerErrors, ThrowOnError>;
|
|
1785
|
+
/**
|
|
1786
|
+
* List initiatives the caller can view.
|
|
1787
|
+
*/
|
|
1788
|
+
listInitiatives<ThrowOnError extends boolean = false>(options?: Options<ListInitiativesData, ThrowOnError>): RequestResult<ListInitiativesResponses, ListInitiativesErrors, ThrowOnError>;
|
|
1789
|
+
/**
|
|
1790
|
+
* Create an initiative owned by the caller.
|
|
1791
|
+
*/
|
|
1792
|
+
createInitiative<ThrowOnError extends boolean = false>(options: Options<CreateInitiativeData, ThrowOnError>): RequestResult<CreateInitiativeResponses, CreateInitiativeErrors, ThrowOnError>;
|
|
1793
|
+
/**
|
|
1794
|
+
* Page the initiatives the caller can view, filtered by name and canonical properties,
|
|
1795
|
+
* with each row's properties and progress over the tasks the caller can view.
|
|
1796
|
+
*/
|
|
1797
|
+
pageInitiatives<ThrowOnError extends boolean = false>(options?: Options<PageInitiativesData, ThrowOnError>): RequestResult<PageInitiativesResponses, PageInitiativesErrors, ThrowOnError>;
|
|
1798
|
+
/**
|
|
1799
|
+
* Delete the initiative the caller owns.
|
|
1800
|
+
*/
|
|
1801
|
+
deleteInitiative<ThrowOnError extends boolean = false>(options: Options<DeleteInitiativeData, ThrowOnError>): RequestResult<DeleteInitiativeResponses, DeleteInitiativeErrors, ThrowOnError>;
|
|
1802
|
+
/**
|
|
1803
|
+
* Fetch one initiative the caller can view.
|
|
1804
|
+
*/
|
|
1805
|
+
getInitiative<ThrowOnError extends boolean = false>(options: Options<GetInitiativeData, ThrowOnError>): RequestResult<GetInitiativeResponses, GetInitiativeErrors, ThrowOnError>;
|
|
1806
|
+
/**
|
|
1807
|
+
* Update fields the caller can edit.
|
|
1808
|
+
*/
|
|
1809
|
+
updateInitiative<ThrowOnError extends boolean = false>(options: Options<UpdateInitiativeData, ThrowOnError>): RequestResult<UpdateInitiativeResponses, UpdateInitiativeErrors, ThrowOnError>;
|
|
1810
|
+
/**
|
|
1811
|
+
* Read an initiative's creation, edits, property changes and task membership
|
|
1812
|
+
* changes, newest first.
|
|
1813
|
+
*
|
|
1814
|
+
* Task references require current view access to the task, so a page can hold
|
|
1815
|
+
* fewer records than `limit`, even none. Follow `nextCursor` with the same
|
|
1816
|
+
* window until it is absent.
|
|
1817
|
+
*/
|
|
1818
|
+
getInitiativeActivity<ThrowOnError extends boolean = false>(options: Options<GetInitiativeActivityData, ThrowOnError>): RequestResult<GetInitiativeActivityResponses, GetInitiativeActivityErrors, ThrowOnError>;
|
|
1819
|
+
/**
|
|
1820
|
+
* Replace a project's appearance without changing content timestamps.
|
|
1821
|
+
*/
|
|
1822
|
+
setInitiativeAppearance<ThrowOnError extends boolean = false>(options: Options<SetInitiativeAppearanceData, ThrowOnError>): RequestResult<SetInitiativeAppearanceResponses, SetInitiativeAppearanceErrors, ThrowOnError>;
|
|
1823
|
+
/**
|
|
1824
|
+
* Read the description of an initiative the caller can view.
|
|
1825
|
+
*/
|
|
1826
|
+
getInitiativeDescription<ThrowOnError extends boolean = false>(options: Options<GetInitiativeDescriptionData, ThrowOnError>): RequestResult<GetInitiativeDescriptionResponses, GetInitiativeDescriptionErrors, ThrowOnError>;
|
|
1827
|
+
/**
|
|
1828
|
+
* Gets the instructions document for the current user
|
|
1829
|
+
*/
|
|
1830
|
+
getInstructionsHandler<ThrowOnError extends boolean = false>(options?: Options<GetInstructionsHandlerData, ThrowOnError>): RequestResult<GetInstructionsHandlerResponses, GetInstructionsHandlerErrors, ThrowOnError>;
|
|
1831
|
+
/**
|
|
1832
|
+
* Creates an instructions document for the current user
|
|
1833
|
+
*/
|
|
1834
|
+
createInstructionsHandler<ThrowOnError extends boolean = false>(options?: Options<CreateInstructionsHandlerData, ThrowOnError>): RequestResult<CreateInstructionsHandlerResponses, CreateInstructionsHandlerErrors, ThrowOnError>;
|
|
1835
|
+
/**
|
|
1836
|
+
* Gets the items the user has access to
|
|
1837
|
+
*/
|
|
1838
|
+
getItemsSoup<ThrowOnError extends boolean = false>(options?: Options<GetItemsSoupData, ThrowOnError>): RequestResult<GetItemsSoupResponses, GetItemsSoupErrors, ThrowOnError>;
|
|
1839
|
+
/**
|
|
1840
|
+
* Gets the items the user has access to
|
|
1841
|
+
*/
|
|
1842
|
+
postItemsSoup<ThrowOnError extends boolean = false>(options: Options<PostItemsSoupData, ThrowOnError>): RequestResult<PostItemsSoupResponses, PostItemsSoupErrors, ThrowOnError>;
|
|
1843
|
+
/**
|
|
1844
|
+
* Gets the items the user has access to using AST filters
|
|
1845
|
+
*/
|
|
1846
|
+
postItemsSoupAst<ThrowOnError extends boolean = false>(options: Options<PostItemsSoupAstData, ThrowOnError>): RequestResult<PostItemsSoupAstResponses, PostItemsSoupAstErrors, ThrowOnError>;
|
|
1847
|
+
/**
|
|
1848
|
+
* Gets the items grouped by the specified field using AST filters.
|
|
1849
|
+
*/
|
|
1850
|
+
postItemsSoupAstGrouped<ThrowOnError extends boolean = false>(options: Options<PostItemsSoupAstGroupedData, ThrowOnError>): RequestResult<PostItemsSoupAstGroupedResponses, PostItemsSoupAstGroupedErrors, ThrowOnError>;
|
|
1851
|
+
/**
|
|
1852
|
+
* Read a bounded timeline with lazy thread previews.
|
|
1853
|
+
*/
|
|
1854
|
+
messageTimeline<ThrowOnError extends boolean = false>(options: Options<MessageTimelineData, ThrowOnError>): RequestResult<MessageTimelineResponses, unknown, ThrowOnError>;
|
|
1855
|
+
/**
|
|
1856
|
+
* Create a root message or reply.
|
|
1857
|
+
*/
|
|
1858
|
+
entityMessageCreate<ThrowOnError extends boolean = false>(options: Options<EntityMessageCreateData, ThrowOnError>): RequestResult<EntityMessageCreateResponses, unknown, ThrowOnError>;
|
|
1859
|
+
/**
|
|
1860
|
+
* Tombstone one message; deleting a discussion's root deletes the discussion.
|
|
1861
|
+
*/
|
|
1862
|
+
entityMessageDeleteMessage<ThrowOnError extends boolean = false>(options: Options<EntityMessageDeleteMessageData, ThrowOnError>): RequestResult<EntityMessageDeleteMessageResponses, unknown, ThrowOnError>;
|
|
1863
|
+
/**
|
|
1864
|
+
* Resolve a message within its parent.
|
|
1865
|
+
*/
|
|
1866
|
+
entityMessageGetMessage<ThrowOnError extends boolean = false>(options: Options<EntityMessageGetMessageData, ThrowOnError>): RequestResult<EntityMessageGetMessageResponses, unknown, ThrowOnError>;
|
|
1867
|
+
/**
|
|
1868
|
+
* Edit an owned message.
|
|
1869
|
+
*/
|
|
1870
|
+
entityMessageEdit<ThrowOnError extends boolean = false>(options: Options<EntityMessageEditData, ThrowOnError>): RequestResult<EntityMessageEditResponses, unknown, ThrowOnError>;
|
|
1871
|
+
/**
|
|
1872
|
+
* Change the caller's reaction.
|
|
1873
|
+
*/
|
|
1874
|
+
entityMessageReact<ThrowOnError extends boolean = false>(options: Options<EntityMessageReactData, ThrowOnError>): RequestResult<EntityMessageReactResponses, unknown, ThrowOnError>;
|
|
1875
|
+
/**
|
|
1876
|
+
* Resolve an old link under current parent permissions.
|
|
1877
|
+
*/
|
|
1878
|
+
entityMessageLegacy<ThrowOnError extends boolean = false>(options: Options<EntityMessageLegacyData, ThrowOnError>): RequestResult<EntityMessageLegacyResponses, unknown, ThrowOnError>;
|
|
1879
|
+
/**
|
|
1880
|
+
* Explicitly remove a discussion.
|
|
1881
|
+
*/
|
|
1882
|
+
entityMessageDeleteThread<ThrowOnError extends boolean = false>(options: Options<EntityMessageDeleteThreadData, ThrowOnError>): RequestResult<EntityMessageDeleteThreadResponses, unknown, ThrowOnError>;
|
|
1883
|
+
/**
|
|
1884
|
+
* Open a specific discussion from a link or annotation.
|
|
1885
|
+
*/
|
|
1886
|
+
entityMessageGetThread<ThrowOnError extends boolean = false>(options: Options<EntityMessageGetThreadData, ThrowOnError>): RequestResult<EntityMessageGetThreadResponses, unknown, ThrowOnError>;
|
|
1887
|
+
/**
|
|
1888
|
+
* Update a discussion's lifecycle and placement.
|
|
1889
|
+
*/
|
|
1890
|
+
entityMessagePatchThread<ThrowOnError extends boolean = false>(options: Options<EntityMessagePatchThreadData, ThrowOnError>): RequestResult<EntityMessagePatchThreadResponses, unknown, ThrowOnError>;
|
|
1891
|
+
/**
|
|
1892
|
+
* Read a bounded window of messages and the parent's activity, ordered by the server.
|
|
1893
|
+
*/
|
|
1894
|
+
messageTimelineEntries<ThrowOnError extends boolean = false>(options: Options<MessageTimelineEntriesData, ThrowOnError>): RequestResult<MessageTimelineEntriesResponses, unknown, ThrowOnError>;
|
|
1895
|
+
/**
|
|
1896
|
+
* Broadcast typing within an authorized discussion.
|
|
1897
|
+
*/
|
|
1898
|
+
entityMessageTyping<ThrowOnError extends boolean = false>(options: Options<EntityMessageTypingData, ThrowOnError>): RequestResult<EntityMessageTypingResponses, unknown, ThrowOnError>;
|
|
1899
|
+
/**
|
|
1900
|
+
* Search the agent's catalog: metadata and current access only.
|
|
1901
|
+
*/
|
|
1902
|
+
passwordsAgentSearch<ThrowOnError extends boolean = false>(options: Options<PasswordsAgentSearchData, ThrowOnError>): RequestResult<PasswordsAgentSearchResponses, PasswordsAgentSearchErrors, ThrowOnError>;
|
|
1903
|
+
/**
|
|
1904
|
+
* Create a login or API item attributed to this agent.
|
|
1905
|
+
*/
|
|
1906
|
+
passwordsAgentCreate<ThrowOnError extends boolean = false>(options: Options<PasswordsAgentCreateData, ThrowOnError>): RequestResult<PasswordsAgentCreateResponses, PasswordsAgentCreateErrors, ThrowOnError>;
|
|
1907
|
+
/**
|
|
1908
|
+
* Replace supplied fields of a login or API item.
|
|
1909
|
+
*/
|
|
1910
|
+
passwordsAgentUpdate<ThrowOnError extends boolean = false>(options: Options<PasswordsAgentUpdateData, ThrowOnError>): RequestResult<PasswordsAgentUpdateResponses, PasswordsAgentUpdateErrors, ThrowOnError>;
|
|
1911
|
+
/**
|
|
1912
|
+
* Ask authorized humans for access to an item.
|
|
1913
|
+
*/
|
|
1914
|
+
passwordsAgentRequestAccess<ThrowOnError extends boolean = false>(options: Options<PasswordsAgentRequestAccessData, ThrowOnError>): RequestResult<PasswordsAgentRequestAccessResponses, PasswordsAgentRequestAccessErrors, ThrowOnError>;
|
|
1915
|
+
/**
|
|
1916
|
+
* This agent's own request state for the item.
|
|
1917
|
+
*/
|
|
1918
|
+
passwordsAgentMyRequest<ThrowOnError extends boolean = false>(options: Options<PasswordsAgentMyRequestData, ThrowOnError>): RequestResult<PasswordsAgentMyRequestResponses, PasswordsAgentMyRequestErrors, ThrowOnError>;
|
|
1919
|
+
/**
|
|
1920
|
+
* Disclose one selected field to the agent's capability.
|
|
1921
|
+
*/
|
|
1922
|
+
passwordsAgentDisclose<ThrowOnError extends boolean = false>(options: Options<PasswordsAgentDiscloseData, ThrowOnError>): RequestResult<PasswordsAgentDiscloseResponses, PasswordsAgentDiscloseErrors, ThrowOnError>;
|
|
1923
|
+
/**
|
|
1924
|
+
* Enroll a verification-code seed on an item this agent created.
|
|
1925
|
+
*/
|
|
1926
|
+
passwordsAgentSetTotp<ThrowOnError extends boolean = false>(options: Options<PasswordsAgentSetTotpData, ThrowOnError>): RequestResult<PasswordsAgentSetTotpResponses, PasswordsAgentSetTotpErrors, ThrowOnError>;
|
|
1927
|
+
/**
|
|
1928
|
+
* The current verification code of a login or verification-code item.
|
|
1929
|
+
*/
|
|
1930
|
+
passwordsAgentTotpCode<ThrowOnError extends boolean = false>(options: Options<PasswordsAgentTotpCodeData, ThrowOnError>): RequestResult<PasswordsAgentTotpCodeResponses, PasswordsAgentTotpCodeErrors, ThrowOnError>;
|
|
1931
|
+
/**
|
|
1932
|
+
* List current teams available to the authenticated human.
|
|
1933
|
+
*/
|
|
1934
|
+
passwordsTeams<ThrowOnError extends boolean = false>(options?: Options<PasswordsTeamsData, ThrowOnError>): RequestResult<PasswordsTeamsResponses, PasswordsTeamsErrors, ThrowOnError>;
|
|
1935
|
+
/**
|
|
1936
|
+
* Pending agent requests on items the caller may manage.
|
|
1937
|
+
*/
|
|
1938
|
+
passwordsAgentAccessRequests<ThrowOnError extends boolean = false>(options: Options<PasswordsAgentAccessRequestsData, ThrowOnError>): RequestResult<PasswordsAgentAccessRequestsResponses, PasswordsAgentAccessRequestsErrors, ThrowOnError>;
|
|
1939
|
+
/**
|
|
1940
|
+
* List the authenticated team’s folders.
|
|
1941
|
+
*/
|
|
1942
|
+
passwordsFolders<ThrowOnError extends boolean = false>(options: Options<PasswordsFoldersData, ThrowOnError>): RequestResult<PasswordsFoldersResponses, PasswordsFoldersErrors, ThrowOnError>;
|
|
1943
|
+
/**
|
|
1944
|
+
* Create a folder within the authenticated team.
|
|
1945
|
+
*/
|
|
1946
|
+
passwordsCreateFolder<ThrowOnError extends boolean = false>(options: Options<PasswordsCreateFolderData, ThrowOnError>): RequestResult<PasswordsCreateFolderResponses, PasswordsCreateFolderErrors, ThrowOnError>;
|
|
1947
|
+
/**
|
|
1948
|
+
* Delete a folder within the authenticated team.
|
|
1949
|
+
*/
|
|
1950
|
+
passwordsRemoveFolder<ThrowOnError extends boolean = false>(options: Options<PasswordsRemoveFolderData, ThrowOnError>): RequestResult<PasswordsRemoveFolderResponses, PasswordsRemoveFolderErrors, ThrowOnError>;
|
|
1951
|
+
/**
|
|
1952
|
+
* Rename a folder within the authenticated team.
|
|
1953
|
+
*/
|
|
1954
|
+
passwordsRenameFolder<ThrowOnError extends boolean = false>(options: Options<PasswordsRenameFolderData, ThrowOnError>): RequestResult<PasswordsRenameFolderResponses, PasswordsRenameFolderErrors, ThrowOnError>;
|
|
1955
|
+
/**
|
|
1956
|
+
* Move a folder under another folder of the team, or to the top level.
|
|
1957
|
+
*/
|
|
1958
|
+
passwordsMoveFolder<ThrowOnError extends boolean = false>(options: Options<PasswordsMoveFolderData, ThrowOnError>): RequestResult<PasswordsMoveFolderResponses, PasswordsMoveFolderErrors, ThrowOnError>;
|
|
1959
|
+
/**
|
|
1960
|
+
* Import normalized credentials with independently retryable per-item outcomes.
|
|
1961
|
+
*/
|
|
1962
|
+
passwordsImportBatch<ThrowOnError extends boolean = false>(options: Options<PasswordsImportBatchData, ThrowOnError>): RequestResult<PasswordsImportBatchResponses, PasswordsImportBatchErrors, ThrowOnError>;
|
|
1963
|
+
/**
|
|
1964
|
+
* Search authorized metadata without resolving private values.
|
|
1965
|
+
*/
|
|
1966
|
+
passwordsList<ThrowOnError extends boolean = false>(options: Options<PasswordsListData, ThrowOnError>): RequestResult<PasswordsListResponses, PasswordsListErrors, ThrowOnError>;
|
|
1967
|
+
/**
|
|
1968
|
+
* Create one item using an idempotent logical operation identifier.
|
|
1969
|
+
*/
|
|
1970
|
+
passwordsCreate<ThrowOnError extends boolean = false>(options: Options<PasswordsCreateData, ThrowOnError>): RequestResult<PasswordsCreateResponses, PasswordsCreateErrors, ThrowOnError>;
|
|
1971
|
+
/**
|
|
1972
|
+
* Visible items named like the given names, for an import's duplicate check;
|
|
1973
|
+
* names travel in the body so they stay out of URLs and access logs.
|
|
1974
|
+
*/
|
|
1975
|
+
passwordsMatch<ThrowOnError extends boolean = false>(options: Options<PasswordsMatchData, ThrowOnError>): RequestResult<PasswordsMatchResponses, PasswordsMatchErrors, ThrowOnError>;
|
|
1976
|
+
/**
|
|
1977
|
+
* Delete an owned item with a resumable provider fence.
|
|
1978
|
+
*/
|
|
1979
|
+
passwordsRemove<ThrowOnError extends boolean = false>(options: Options<PasswordsRemoveData, ThrowOnError>): RequestResult<PasswordsRemoveResponses, PasswordsRemoveErrors, ThrowOnError>;
|
|
1980
|
+
/**
|
|
1981
|
+
* Read authorized item metadata only.
|
|
1982
|
+
*/
|
|
1983
|
+
passwordsDetail<ThrowOnError extends boolean = false>(options: Options<PasswordsDetailData, ThrowOnError>): RequestResult<PasswordsDetailResponses, PasswordsDetailErrors, ThrowOnError>;
|
|
1984
|
+
/**
|
|
1985
|
+
* Change metadata without resolving private values.
|
|
1986
|
+
*/
|
|
1987
|
+
passwordsPatch<ThrowOnError extends boolean = false>(options: Options<PasswordsPatchData, ThrowOnError>): RequestResult<PasswordsPatchResponses, PasswordsPatchErrors, ThrowOnError>;
|
|
1988
|
+
/**
|
|
1989
|
+
* Save a new protected value version and its metadata.
|
|
1990
|
+
*/
|
|
1991
|
+
passwordsUpdate<ThrowOnError extends boolean = false>(options: Options<PasswordsUpdateData, ThrowOnError>): RequestResult<PasswordsUpdateResponses, PasswordsUpdateErrors, ThrowOnError>;
|
|
1992
|
+
/**
|
|
1993
|
+
* List recorded activity for an authorized item.
|
|
1994
|
+
*/
|
|
1995
|
+
passwordsActivity<ThrowOnError extends boolean = false>(options: Options<PasswordsActivityData, ThrowOnError>): RequestResult<PasswordsActivityResponses, PasswordsActivityErrors, ThrowOnError>;
|
|
1996
|
+
/**
|
|
1997
|
+
* Approve or deny a pending agent request.
|
|
1998
|
+
*/
|
|
1999
|
+
passwordsAgentResolveRequest<ThrowOnError extends boolean = false>(options: Options<PasswordsAgentResolveRequestData, ThrowOnError>): RequestResult<PasswordsAgentResolveRequestResponses, PasswordsAgentResolveRequestErrors, ThrowOnError>;
|
|
2000
|
+
/**
|
|
2001
|
+
* Revoke an agent's standing approval, or its grant and approval.
|
|
2002
|
+
*/
|
|
2003
|
+
passwordsAgentRevoke<ThrowOnError extends boolean = false>(options: Options<PasswordsAgentRevokeData, ThrowOnError>): RequestResult<PasswordsAgentRevokeResponses, PasswordsAgentRevokeErrors, ThrowOnError>;
|
|
2004
|
+
/**
|
|
2005
|
+
* Disclose values for an explicitly audited clipboard action.
|
|
2006
|
+
*/
|
|
2007
|
+
passwordsCopy<ThrowOnError extends boolean = false>(options: Options<PasswordsCopyData, ThrowOnError>): RequestResult<PasswordsCopyResponses, PasswordsCopyErrors, ThrowOnError>;
|
|
2008
|
+
/**
|
|
2009
|
+
* List protected-value version metadata.
|
|
2010
|
+
*/
|
|
2011
|
+
passwordsHistory<ThrowOnError extends boolean = false>(options: Options<PasswordsHistoryData, ThrowOnError>): RequestResult<PasswordsHistoryResponses, PasswordsHistoryErrors, ThrowOnError>;
|
|
2012
|
+
/**
|
|
2013
|
+
* Disclose a current or historical value with normal human-session item access.
|
|
2014
|
+
*/
|
|
2015
|
+
passwordsReveal<ThrowOnError extends boolean = false>(options: Options<PasswordsRevealData, ThrowOnError>): RequestResult<PasswordsRevealResponses, PasswordsRevealErrors, ThrowOnError>;
|
|
2016
|
+
/**
|
|
2017
|
+
* Read the owned item’s explicit recipient set.
|
|
2018
|
+
*/
|
|
2019
|
+
passwordsGrants<ThrowOnError extends boolean = false>(options: Options<PasswordsGrantsData, ThrowOnError>): RequestResult<PasswordsGrantsResponses, PasswordsGrantsErrors, ThrowOnError>;
|
|
2020
|
+
/**
|
|
2021
|
+
* Replace the owned item’s explicit recipient set.
|
|
2022
|
+
*/
|
|
2023
|
+
passwordsShare<ThrowOnError extends boolean = false>(options: Options<PasswordsShareData, ThrowOnError>): RequestResult<PasswordsShareResponses, PasswordsShareErrors, ThrowOnError>;
|
|
2024
|
+
/**
|
|
2025
|
+
* Remove a verification-code seed with normal human-session edit access.
|
|
2026
|
+
*/
|
|
2027
|
+
passwordsRemoveTotp<ThrowOnError extends boolean = false>(options: Options<PasswordsRemoveTotpData, ThrowOnError>): RequestResult<PasswordsRemoveTotpResponses, PasswordsRemoveTotpErrors, ThrowOnError>;
|
|
2028
|
+
/**
|
|
2029
|
+
* Enroll or replace a verification-code seed with normal human-session edit access.
|
|
2030
|
+
*/
|
|
2031
|
+
passwordsSetTotp<ThrowOnError extends boolean = false>(options: Options<PasswordsSetTotpData, ThrowOnError>): RequestResult<PasswordsSetTotpResponses, PasswordsSetTotpErrors, ThrowOnError>;
|
|
2032
|
+
/**
|
|
2033
|
+
* Resolve the current verification code with normal human-session item access.
|
|
2034
|
+
*/
|
|
2035
|
+
passwordsTotp<ThrowOnError extends boolean = false>(options: Options<PasswordsTotpData, ThrowOnError>): RequestResult<PasswordsTotpResponses, PasswordsTotpErrors, ThrowOnError>;
|
|
2036
|
+
/**
|
|
2037
|
+
* Read only the current account identifier with normal human view authorization.
|
|
2038
|
+
*/
|
|
2039
|
+
passwordsUsername<ThrowOnError extends boolean = false>(options: Options<PasswordsUsernameData, ThrowOnError>): RequestResult<PasswordsUsernameResponses, PasswordsUsernameErrors, ThrowOnError>;
|
|
2040
|
+
/**
|
|
2041
|
+
* Read only the current account identifier and record an explicit clipboard action.
|
|
2042
|
+
*/
|
|
2043
|
+
passwordsCopyUsername<ThrowOnError extends boolean = false>(options: Options<PasswordsCopyUsernameData, ThrowOnError>): RequestResult<PasswordsCopyUsernameResponses, PasswordsCopyUsernameErrors, ThrowOnError>;
|
|
2044
|
+
/**
|
|
2045
|
+
* Gets the users pinned items
|
|
2046
|
+
*/
|
|
2047
|
+
getPinsHandler<ThrowOnError extends boolean = false>(options?: Options<GetPinsHandlerData, ThrowOnError>): RequestResult<GetPinsHandlerResponses, GetPinsHandlerErrors, ThrowOnError>;
|
|
2048
|
+
/**
|
|
2049
|
+
* Saves the updated order of the pins for the user
|
|
2050
|
+
*/
|
|
2051
|
+
reorderPinsHandler<ThrowOnError extends boolean = false>(options: Options<ReorderPinsHandlerData, ThrowOnError>): RequestResult<ReorderPinsHandlerResponses, ReorderPinsHandlerErrors, ThrowOnError>;
|
|
2052
|
+
/**
|
|
2053
|
+
* Deletes the pin for the user
|
|
2054
|
+
*/
|
|
2055
|
+
removePinHandler<ThrowOnError extends boolean = false>(options: Options<RemovePinHandlerData, ThrowOnError>): RequestResult<RemovePinHandlerResponses, RemovePinHandlerErrors, ThrowOnError>;
|
|
2056
|
+
/**
|
|
2057
|
+
* Pins the item for the user
|
|
2058
|
+
*/
|
|
2059
|
+
addPinHandler<ThrowOnError extends boolean = false>(options: Options<AddPinHandlerData, ThrowOnError>): RequestResult<AddPinHandlerResponses, AddPinHandlerErrors, ThrowOnError>;
|
|
2060
|
+
/**
|
|
2061
|
+
* List projects visible to the authenticated user.
|
|
2062
|
+
*/
|
|
2063
|
+
getProjectsHandler<ThrowOnError extends boolean = false>(options?: Options<GetProjectsHandlerData, ThrowOnError>): RequestResult<GetProjectsHandlerResponses, GetProjectsHandlerErrors, ThrowOnError>;
|
|
2064
|
+
/**
|
|
2065
|
+
* Create a project, optionally beneath an existing project.
|
|
2066
|
+
*/
|
|
2067
|
+
createProjectHandler<ThrowOnError extends boolean = false>(options: Options<CreateProjectHandlerData, ThrowOnError>): RequestResult<CreateProjectHandlerResponses, CreateProjectHandlerErrors, ThrowOnError>;
|
|
2068
|
+
/**
|
|
2069
|
+
* List pending root projects owned by the authenticated user.
|
|
2070
|
+
*/
|
|
2071
|
+
getPendingProjectsHandler<ThrowOnError extends boolean = false>(options?: Options<GetPendingProjectsHandlerData, ThrowOnError>): RequestResult<GetPendingProjectsHandlerResponses, GetPendingProjectsHandlerErrors, ThrowOnError>;
|
|
2072
|
+
/**
|
|
2073
|
+
* Get previews for a batch of project IDs.
|
|
2074
|
+
*/
|
|
2075
|
+
getBatchProjectPreview<ThrowOnError extends boolean = false>(options: Options<GetBatchProjectPreviewData, ThrowOnError>): RequestResult<GetBatchProjectPreviewResponses, GetBatchProjectPreviewErrors, ThrowOnError>;
|
|
2076
|
+
/**
|
|
2077
|
+
* Upload a folder tree and create its upload destinations.
|
|
2078
|
+
*/
|
|
2079
|
+
uploadFolderHandler<ThrowOnError extends boolean = false>(options: Options<UploadFolderHandlerData, ThrowOnError>): RequestResult<UploadFolderHandlerResponses, UploadFolderHandlerErrors, ThrowOnError>;
|
|
2080
|
+
/**
|
|
2081
|
+
* Create a request for extracting an uploaded folder archive.
|
|
2082
|
+
*/
|
|
2083
|
+
uploadExtractFolderHandler<ThrowOnError extends boolean = false>(options: Options<UploadExtractFolderHandlerData, ThrowOnError>): RequestResult<UploadExtractFolderHandlerResponses, UploadExtractFolderHandlerErrors, ThrowOnError>;
|
|
2084
|
+
/**
|
|
2085
|
+
* Where the caller's folder upload stands, so the uploader can follow it to
|
|
2086
|
+
* the end even when a websocket update is missed.
|
|
2087
|
+
*/
|
|
2088
|
+
getUploadExtractStatusHandler<ThrowOnError extends boolean = false>(options: Options<GetUploadExtractStatusHandlerData, ThrowOnError>): RequestResult<GetUploadExtractStatusHandlerResponses, GetUploadExtractStatusHandlerErrors, ThrowOnError>;
|
|
2089
|
+
/**
|
|
2090
|
+
* Soft-delete a project and all of its children.
|
|
2091
|
+
*/
|
|
2092
|
+
deleteProjectHandler<ThrowOnError extends boolean = false>(options: Options<DeleteProjectHandlerData, ThrowOnError>): RequestResult<DeleteProjectHandlerResponses, DeleteProjectHandlerErrors, ThrowOnError>;
|
|
2093
|
+
/**
|
|
2094
|
+
* Get project metadata.
|
|
2095
|
+
*/
|
|
2096
|
+
getProjectHandler<ThrowOnError extends boolean = false>(options: Options<GetProjectHandlerData, ThrowOnError>): RequestResult<GetProjectHandlerResponses, GetProjectHandlerErrors, ThrowOnError>;
|
|
2097
|
+
/**
|
|
2098
|
+
* Get the caller's project access level.
|
|
2099
|
+
*/
|
|
2100
|
+
getProjectUserAccessLevel<ThrowOnError extends boolean = false>(options: Options<GetProjectUserAccessLevelData, ThrowOnError>): RequestResult<GetProjectUserAccessLevelResponses, GetProjectUserAccessLevelErrors, ThrowOnError>;
|
|
2101
|
+
/**
|
|
2102
|
+
* Get a project's immediate children.
|
|
2103
|
+
*/
|
|
2104
|
+
getProjectContentHandler<ThrowOnError extends boolean = false>(options: Options<GetProjectContentHandlerData, ThrowOnError>): RequestResult<GetProjectContentHandlerResponses, GetProjectContentHandlerErrors, ThrowOnError>;
|
|
2105
|
+
/**
|
|
2106
|
+
* Permanently delete a soft-deleted project and all of its children.
|
|
2107
|
+
*/
|
|
2108
|
+
permanentlyDeleteProject<ThrowOnError extends boolean = false>(options: Options<PermanentlyDeleteProjectData, ThrowOnError>): RequestResult<PermanentlyDeleteProjectResponses, PermanentlyDeleteProjectErrors, ThrowOnError>;
|
|
2109
|
+
/**
|
|
2110
|
+
* Get a project's share permissions.
|
|
2111
|
+
*/
|
|
2112
|
+
getProjectPermissionsV2<ThrowOnError extends boolean = false>(options: Options<GetProjectPermissionsV2Data, ThrowOnError>): RequestResult<GetProjectPermissionsV2Responses, GetProjectPermissionsV2Errors, ThrowOnError>;
|
|
2113
|
+
/**
|
|
2114
|
+
* Restore a soft-deleted project and its children.
|
|
2115
|
+
*/
|
|
2116
|
+
revertDeleteProject<ThrowOnError extends boolean = false>(options: Options<RevertDeleteProjectData, ThrowOnError>): RequestResult<RevertDeleteProjectResponses, RevertDeleteProjectErrors, ThrowOnError>;
|
|
2117
|
+
/**
|
|
2118
|
+
* Gets one page of the user's trashed documents, chats and folders, most
|
|
2119
|
+
* recently trashed first.
|
|
2120
|
+
*/
|
|
2121
|
+
recentlyDeleted<ThrowOnError extends boolean = false>(options?: Options<RecentlyDeletedData, ThrowOnError>): RequestResult<RecentlyDeletedResponses, RecentlyDeletedErrors, ThrowOnError>;
|
|
2122
|
+
/**
|
|
2123
|
+
* List original email threads with caller-private reminder work.
|
|
2124
|
+
*/
|
|
2125
|
+
listEmailReminders<ThrowOnError extends boolean = false>(options?: Options<ListEmailRemindersData, ThrowOnError>): RequestResult<ListEmailRemindersResponses, ListEmailRemindersErrors, ThrowOnError>;
|
|
2126
|
+
/**
|
|
2127
|
+
* Read an email follow-up and reconcile inbound reply cancellation.
|
|
2128
|
+
*/
|
|
2129
|
+
getEmailFollowup<ThrowOnError extends boolean = false>(options: Options<GetEmailFollowupData, ThrowOnError>): RequestResult<GetEmailFollowupResponses, GetEmailFollowupErrors, ThrowOnError>;
|
|
2130
|
+
/**
|
|
2131
|
+
* Schedule, edit or remove one email follow-up as an idempotent operation.
|
|
2132
|
+
*/
|
|
2133
|
+
setEmailFollowup<ThrowOnError extends boolean = false>(options: Options<SetEmailFollowupData, ThrowOnError>): RequestResult<SetEmailFollowupResponses, SetEmailFollowupErrors, ThrowOnError>;
|
|
2134
|
+
getViewsHandler<ThrowOnError extends boolean = false>(options?: Options<GetViewsHandlerData, ThrowOnError>): RequestResult<GetViewsHandlerResponses, GetViewsHandlerErrors, ThrowOnError>;
|
|
2135
|
+
createViewHandler<ThrowOnError extends boolean = false>(options: Options<CreateViewHandlerData, ThrowOnError>): RequestResult<CreateViewHandlerResponses, CreateViewHandlerErrors, ThrowOnError>;
|
|
2136
|
+
listSavedViewDefinitions<ThrowOnError extends boolean = false>(options?: Options<ListSavedViewDefinitionsData, ThrowOnError>): RequestResult<ListSavedViewDefinitionsResponses, ListSavedViewDefinitionsErrors, ThrowOnError>;
|
|
2137
|
+
createSavedViewDefinition<ThrowOnError extends boolean = false>(options: Options<CreateSavedViewDefinitionData, ThrowOnError>): RequestResult<CreateSavedViewDefinitionResponses, CreateSavedViewDefinitionErrors, ThrowOnError>;
|
|
2138
|
+
reorderSavedViewDefinitions<ThrowOnError extends boolean = false>(options: Options<ReorderSavedViewDefinitionsData, ThrowOnError>): RequestResult<ReorderSavedViewDefinitionsResponses, ReorderSavedViewDefinitionsErrors, ThrowOnError>;
|
|
2139
|
+
deleteSavedViewDefinition<ThrowOnError extends boolean = false>(options: Options<DeleteSavedViewDefinitionData, ThrowOnError>): RequestResult<DeleteSavedViewDefinitionResponses, DeleteSavedViewDefinitionErrors, ThrowOnError>;
|
|
2140
|
+
getSavedViewDefinition<ThrowOnError extends boolean = false>(options: Options<GetSavedViewDefinitionData, ThrowOnError>): RequestResult<GetSavedViewDefinitionResponses, GetSavedViewDefinitionErrors, ThrowOnError>;
|
|
2141
|
+
updateSavedViewDefinition<ThrowOnError extends boolean = false>(options: Options<UpdateSavedViewDefinitionData, ThrowOnError>): RequestResult<UpdateSavedViewDefinitionResponses, UpdateSavedViewDefinitionErrors, ThrowOnError>;
|
|
2142
|
+
excludeDefaultViewHandler<ThrowOnError extends boolean = false>(options: Options<ExcludeDefaultViewHandlerData, ThrowOnError>): RequestResult<ExcludeDefaultViewHandlerResponses, ExcludeDefaultViewHandlerErrors, ThrowOnError>;
|
|
2143
|
+
deleteViewHandler<ThrowOnError extends boolean = false>(options: Options<DeleteViewHandlerData, ThrowOnError>): RequestResult<DeleteViewHandlerResponses, DeleteViewHandlerErrors, ThrowOnError>;
|
|
2144
|
+
patchViewHandler<ThrowOnError extends boolean = false>(options: Options<PatchViewHandlerData, ThrowOnError>): RequestResult<PatchViewHandlerResponses, PatchViewHandlerErrors, ThrowOnError>;
|
|
2145
|
+
/**
|
|
2146
|
+
* List this administrator's team receipts, effective server limits and source binding.
|
|
2147
|
+
*/
|
|
2148
|
+
listSlackImports<ThrowOnError extends boolean = false>(options?: Options<ListSlackImportsData, ThrowOnError>): RequestResult<ListSlackImportsResponses, unknown, ThrowOnError>;
|
|
2149
|
+
/**
|
|
2150
|
+
* Create or replay a job using a scoped idempotency token and full selected metadata.
|
|
2151
|
+
* Missing creation timestamps and unknown message counts are represented as null.
|
|
2152
|
+
*/
|
|
2153
|
+
createSlackImport<ThrowOnError extends boolean = false>(options: Options<CreateSlackImportData, ThrowOnError>): RequestResult<CreateSlackImportResponses, CreateSlackImportErrors, ThrowOnError>;
|
|
2154
|
+
/**
|
|
2155
|
+
* Read sanitized progress; foreign jobs are indistinguishable from missing jobs.
|
|
2156
|
+
*/
|
|
2157
|
+
getSlackImport<ThrowOnError extends boolean = false>(options: Options<GetSlackImportData, ThrowOnError>): RequestResult<GetSlackImportResponses, GetSlackImportErrors, ThrowOnError>;
|
|
2158
|
+
/**
|
|
2159
|
+
* Stop unclaimed work. Active leases may settle; cancellation does not roll back history.
|
|
2160
|
+
*/
|
|
2161
|
+
cancelSlackImport<ThrowOnError extends boolean = false>(options: Options<CancelSlackImportData, ThrowOnError>): RequestResult<CancelSlackImportResponses, CancelSlackImportErrors, ThrowOnError>;
|
|
2162
|
+
/**
|
|
2163
|
+
* Close registration idempotently; never-ready conversations are skipped, not queued work.
|
|
2164
|
+
*/
|
|
2165
|
+
finalizeSlackImport<ThrowOnError extends boolean = false>(options: Options<FinalizeSlackImportData, ThrowOnError>): RequestResult<FinalizeSlackImportResponses, FinalizeSlackImportErrors, ThrowOnError>;
|
|
2166
|
+
/**
|
|
2167
|
+
* Issue short-lived, checksum/length-bound, create-only PUT grants. Do not log or persist URLs.
|
|
2168
|
+
* Retry a PUT returning 412 by completing/verifying the existing object, not overwriting it.
|
|
2169
|
+
*/
|
|
2170
|
+
registerSlackImportUploads<ThrowOnError extends boolean = false>(options: Options<RegisterSlackImportUploadsData, ThrowOnError>): RequestResult<RegisterSlackImportUploadsResponses, RegisterSlackImportUploadsErrors, ThrowOnError>;
|
|
2171
|
+
/**
|
|
2172
|
+
* Verify storage checksums and lengths for registered objects. A seal fixes the ENTIRE
|
|
2173
|
+
* descriptor set (contiguous indices, sizes and hashes), not just this completion batch.
|
|
2174
|
+
* Empty uploads with a zero-part seal support shape-only or empty-history imports.
|
|
2175
|
+
* Work becomes ready only after verified users metadata, a seal and every required part.
|
|
2176
|
+
*/
|
|
2177
|
+
completeSlackImportUploads<ThrowOnError extends boolean = false>(options: Options<CompleteSlackImportUploadsData, ThrowOnError>): RequestResult<CompleteSlackImportUploadsResponses, CompleteSlackImportUploadsErrors, ThrowOnError>;
|
|
2178
|
+
bulkWakeupSyncServiceDocuments<ThrowOnError extends boolean = false>(options: Options<BulkWakeupSyncServiceDocumentsData, ThrowOnError>): RequestResult<BulkWakeupSyncServiceDocumentsResponses, BulkWakeupSyncServiceDocumentsErrors, ThrowOnError>;
|
|
2179
|
+
/**
|
|
2180
|
+
* Edits the share permissions of a thread.
|
|
2181
|
+
*/
|
|
2182
|
+
editThreadV2<ThrowOnError extends boolean = false>(options: Options<EditThreadV2Data, ThrowOnError>): RequestResult<EditThreadV2Responses, EditThreadV2Errors, ThrowOnError>;
|
|
2183
|
+
/**
|
|
2184
|
+
* List the caller's API keys.
|
|
2185
|
+
*/
|
|
2186
|
+
listUserApiKeys<ThrowOnError extends boolean = false>(options?: Options<ListUserApiKeysData, ThrowOnError>): RequestResult<ListUserApiKeysResponses, ListUserApiKeysErrors, ThrowOnError>;
|
|
2187
|
+
/**
|
|
2188
|
+
* Mint a new API key for the caller.
|
|
2189
|
+
*/
|
|
2190
|
+
createUserApiKey<ThrowOnError extends boolean = false>(options: Options<CreateUserApiKeyData, ThrowOnError>): RequestResult<CreateUserApiKeyResponses, CreateUserApiKeyErrors, ThrowOnError>;
|
|
2191
|
+
/**
|
|
2192
|
+
* Delete one of the caller's API keys.
|
|
2193
|
+
*/
|
|
2194
|
+
deleteUserApiKey<ThrowOnError extends boolean = false>(options: Options<DeleteUserApiKeyData, ThrowOnError>): RequestResult<DeleteUserApiKeyResponses, DeleteUserApiKeyErrors, ThrowOnError>;
|
|
2195
|
+
/**
|
|
2196
|
+
* Deletes a document location for the user
|
|
2197
|
+
*/
|
|
2198
|
+
deleteUserDocumentViewLocation<ThrowOnError extends boolean = false>(options: Options<DeleteUserDocumentViewLocationData, ThrowOnError>): RequestResult<DeleteUserDocumentViewLocationResponses, DeleteUserDocumentViewLocationErrors, ThrowOnError>;
|
|
2199
|
+
/**
|
|
2200
|
+
* Gets a UserPdfDocumentLocation entry
|
|
2201
|
+
*/
|
|
2202
|
+
getUserDocumentViewLocation<ThrowOnError extends boolean = false>(options: Options<GetUserDocumentViewLocationData, ThrowOnError>): RequestResult<GetUserDocumentViewLocationResponses, GetUserDocumentViewLocationErrors, ThrowOnError>;
|
|
2203
|
+
upsertUserDocumentViewLocation<ThrowOnError extends boolean = false>(options: Options<UpsertUserDocumentViewLocationData, ThrowOnError>): RequestResult<UpsertUserDocumentViewLocationResponses, UpsertUserDocumentViewLocationErrors, ThrowOnError>;
|
|
2204
|
+
/**
|
|
2205
|
+
* Gets the current documents share permissions
|
|
2206
|
+
*/
|
|
2207
|
+
getDocumentPermissionsV2<ThrowOnError extends boolean = false>(options: Options<GetDocumentPermissionsV2Data, ThrowOnError>): RequestResult<GetDocumentPermissionsV2Responses, GetDocumentPermissionsV2Errors, ThrowOnError>;
|
|
2208
|
+
/**
|
|
2209
|
+
* Edit project metadata and sharing settings.
|
|
2210
|
+
*/
|
|
2211
|
+
editProjectV2<ThrowOnError extends boolean = false>(options: Options<EditProjectV2Data, ThrowOnError>): RequestResult<EditProjectV2Responses, EditProjectV2Errors, ThrowOnError>;
|
|
2212
|
+
/**
|
|
2213
|
+
* Stream matching broker events to the caller over Server-Sent Events.
|
|
2214
|
+
*/
|
|
2215
|
+
streamEvents<ThrowOnError extends boolean = false>(options: Options<StreamEventsData, ThrowOnError, StreamEventsResponse>): Promise<ServerSentEventsResult<StreamEventsResponses>>;
|
|
2216
|
+
/**
|
|
2217
|
+
* List the caller's webhooks.
|
|
2218
|
+
*/
|
|
2219
|
+
listWebhooks<ThrowOnError extends boolean = false>(options?: Options<ListWebhooksData, ThrowOnError>): RequestResult<ListWebhooksResponses, ListWebhooksErrors, ThrowOnError>;
|
|
2220
|
+
/**
|
|
2221
|
+
* Create a webhook.
|
|
2222
|
+
*/
|
|
2223
|
+
createWebhook<ThrowOnError extends boolean = false>(options: Options<CreateWebhookData, ThrowOnError>): RequestResult<CreateWebhookResponses, CreateWebhookErrors, ThrowOnError>;
|
|
2224
|
+
/**
|
|
2225
|
+
* Delete a webhook.
|
|
2226
|
+
*/
|
|
2227
|
+
deleteWebhook<ThrowOnError extends boolean = false>(options: Options<DeleteWebhookData, ThrowOnError>): RequestResult<DeleteWebhookResponses, DeleteWebhookErrors, ThrowOnError>;
|
|
2228
|
+
/**
|
|
2229
|
+
* Get a webhook.
|
|
2230
|
+
*/
|
|
2231
|
+
getWebhook<ThrowOnError extends boolean = false>(options: Options<GetWebhookData, ThrowOnError>): RequestResult<GetWebhookResponses, GetWebhookErrors, ThrowOnError>;
|
|
2232
|
+
/**
|
|
2233
|
+
* Patch a webhook.
|
|
2234
|
+
*/
|
|
2235
|
+
patchWebhook<ThrowOnError extends boolean = false>(options: Options<PatchWebhookData, ThrowOnError>): RequestResult<PatchWebhookResponses, PatchWebhookErrors, ThrowOnError>;
|
|
2236
|
+
/**
|
|
2237
|
+
* Validate a webhook endpoint.
|
|
2238
|
+
*/
|
|
2239
|
+
validateWebhook<ThrowOnError extends boolean = false>(options: Options<ValidateWebhookData, ThrowOnError>): RequestResult<ValidateWebhookResponses, ValidateWebhookErrors, ThrowOnError>;
|
|
2240
|
+
/**
|
|
2241
|
+
* The caller's own account.
|
|
2242
|
+
*/
|
|
2243
|
+
whatsappAccount<ThrowOnError extends boolean = false>(options?: Options<WhatsappAccountData, ThrowOnError>): RequestResult<WhatsappAccountResponses, unknown, ThrowOnError>;
|
|
2244
|
+
/**
|
|
2245
|
+
* The caller's WhatsApp chat list (groups and direct chats), newest
|
|
2246
|
+
* activity first, with what can be added to Rox.
|
|
2247
|
+
*/
|
|
2248
|
+
whatsappChats<ThrowOnError extends boolean = false>(options?: Options<WhatsappChatsData, ThrowOnError>): RequestResult<WhatsappChatsResponses, unknown, ThrowOnError>;
|
|
2249
|
+
/**
|
|
2250
|
+
* Start or resume the caller's pairing transaction.
|
|
2251
|
+
*/
|
|
2252
|
+
whatsappConnect<ThrowOnError extends boolean = false>(options: Options<WhatsappConnectData, ThrowOnError>): RequestResult<WhatsappConnectResponses, unknown, ThrowOnError>;
|
|
2253
|
+
/**
|
|
2254
|
+
* End the caller's observation consent.
|
|
2255
|
+
*/
|
|
2256
|
+
whatsappDisconnect<ThrowOnError extends boolean = false>(options: Options<WhatsappDisconnectData, ThrowOnError>): RequestResult<WhatsappDisconnectResponses, unknown, ThrowOnError>;
|
|
2257
|
+
/**
|
|
2258
|
+
* Import earlier messages of the caller's chats that wait for their phone
|
|
2259
|
+
* (`backfill.state` `waiting_for_phone`). WhatsApp must be open on the phone.
|
|
2260
|
+
*/
|
|
2261
|
+
whatsappImportHistory<ThrowOnError extends boolean = false>(options?: Options<WhatsappImportHistoryData, ThrowOnError>): RequestResult<WhatsappImportHistoryResponses, unknown, ThrowOnError>;
|
|
2262
|
+
/**
|
|
2263
|
+
* Ask whether a phone number has a WhatsApp account, to start a direct chat
|
|
2264
|
+
* with it; poll the lookup until it is no longer `pending`. Found numbers
|
|
2265
|
+
* join the chat list, so `POST /external-chats` adds them.
|
|
2266
|
+
*/
|
|
2267
|
+
whatsappStartLookup<ThrowOnError extends boolean = false>(options: Options<WhatsappStartLookupData, ThrowOnError>): RequestResult<WhatsappStartLookupResponses, unknown, ThrowOnError>;
|
|
2268
|
+
/**
|
|
2269
|
+
* Poll the caller's phone-number lookup.
|
|
2270
|
+
*/
|
|
2271
|
+
whatsappLookup<ThrowOnError extends boolean = false>(options: Options<WhatsappLookupData, ThrowOnError>): RequestResult<WhatsappLookupResponses, unknown, ThrowOnError>;
|
|
2272
|
+
/**
|
|
2273
|
+
* Cancel the caller's pairing transaction.
|
|
2274
|
+
*/
|
|
2275
|
+
whatsappCancelPairing<ThrowOnError extends boolean = false>(options: Options<WhatsappCancelPairingData, ThrowOnError>): RequestResult<WhatsappCancelPairingResponses, unknown, ThrowOnError>;
|
|
2276
|
+
/**
|
|
2277
|
+
* Poll the caller's pairing transaction, including its current QR code.
|
|
2278
|
+
*/
|
|
2279
|
+
whatsappPairing<ThrowOnError extends boolean = false>(options: Options<WhatsappPairingData, ThrowOnError>): RequestResult<WhatsappPairingResponses, unknown, ThrowOnError>;
|
|
2280
|
+
/**
|
|
2281
|
+
* Forward the owner's WebAuthn assertion to the pairing replica.
|
|
2282
|
+
*/
|
|
2283
|
+
whatsappPasskey<ThrowOnError extends boolean = false>(options: Options<WhatsappPasskeyData, ThrowOnError>): RequestResult<WhatsappPasskeyResponses, unknown, ThrowOnError>;
|
|
2284
|
+
}
|
|
2285
|
+
export {};
|