@rox-one/sdk 0.0.0-stage → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/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/draft.d.ts +160 -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 +267 -0
- package/dist/src/rox.js +23217 -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,4228 @@
|
|
|
1
|
+
export type ClientOptions = {
|
|
2
|
+
baseUrl: `${string}://${string}` | (string & {});
|
|
3
|
+
};
|
|
4
|
+
/**
|
|
5
|
+
* Ordered from least to most access top -> bottom
|
|
6
|
+
*/
|
|
7
|
+
export type AccessLevel = 'view' | 'comment' | 'edit' | 'owner';
|
|
8
|
+
/**
|
|
9
|
+
* A privacy-reviewed activity report; period_end is inclusive.
|
|
10
|
+
*/
|
|
11
|
+
export type Activity = {
|
|
12
|
+
content: string;
|
|
13
|
+
granularity: Granularity;
|
|
14
|
+
periodEnd: string;
|
|
15
|
+
periodStart: string;
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* Error body for activity reads.
|
|
19
|
+
*/
|
|
20
|
+
export type ActivityErrorBody = {
|
|
21
|
+
/**
|
|
22
|
+
* Error description.
|
|
23
|
+
*/
|
|
24
|
+
error: string;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* Activity reports for one user, ordered by period.
|
|
28
|
+
*/
|
|
29
|
+
export type ActivityReports = {
|
|
30
|
+
reports: Array<Activity>;
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
* Request body for adding a new MCP server.
|
|
34
|
+
*/
|
|
35
|
+
export type AddServerRequest = {
|
|
36
|
+
/**
|
|
37
|
+
* Human-readable name for the server.
|
|
38
|
+
*/
|
|
39
|
+
server_name: string;
|
|
40
|
+
/**
|
|
41
|
+
* The MCP server's streamable HTTP URL.
|
|
42
|
+
*/
|
|
43
|
+
url: string;
|
|
44
|
+
};
|
|
45
|
+
/**
|
|
46
|
+
* Everything we use AI for. The wire / DB form of each variant is its
|
|
47
|
+
* `snake_case` name.
|
|
48
|
+
*/
|
|
49
|
+
export type AiFeature = 'chat' | 'memory' | 'automation' | 'dynamic_completions_api' | 'chat_rename' | 'call_summary' | 'channel_bot' | 'ai_projection' | 'ai_editing' | 'import' | 'agent_session' | 'agent_repository_choice' | 'agent_mode_choice' | 'agent_activity_summary' | 'dictation' | 'image_generation' | 'email_focus' | 'web_search' | 'non_billable_agent_session';
|
|
50
|
+
/**
|
|
51
|
+
* A structured part within an assistant message.
|
|
52
|
+
*
|
|
53
|
+
* When the model responds with tool calls the full turn is persisted as a
|
|
54
|
+
* flat sequence of these parts. [`crate::convert::to_rig_messages`]
|
|
55
|
+
* reconstructs the turn boundaries that providers expect.
|
|
56
|
+
*/
|
|
57
|
+
export type AssistantMessagePart = {
|
|
58
|
+
/**
|
|
59
|
+
* The text content.
|
|
60
|
+
*/
|
|
61
|
+
text: string;
|
|
62
|
+
type: 'text';
|
|
63
|
+
} | {
|
|
64
|
+
/**
|
|
65
|
+
* Provider-assigned call id.
|
|
66
|
+
*/
|
|
67
|
+
id: string;
|
|
68
|
+
/**
|
|
69
|
+
* Tool arguments as JSON.
|
|
70
|
+
*/
|
|
71
|
+
json: unknown;
|
|
72
|
+
/**
|
|
73
|
+
* Tool name.
|
|
74
|
+
*/
|
|
75
|
+
name: string;
|
|
76
|
+
type: 'toolCall';
|
|
77
|
+
} | {
|
|
78
|
+
/**
|
|
79
|
+
* Optional human-readable name.
|
|
80
|
+
*/
|
|
81
|
+
display_name?: string | null;
|
|
82
|
+
/**
|
|
83
|
+
* Provider-assigned call id.
|
|
84
|
+
*/
|
|
85
|
+
id: string;
|
|
86
|
+
/**
|
|
87
|
+
* Tool arguments as JSON.
|
|
88
|
+
*/
|
|
89
|
+
json: unknown;
|
|
90
|
+
/**
|
|
91
|
+
* Tool name.
|
|
92
|
+
*/
|
|
93
|
+
name: string;
|
|
94
|
+
/**
|
|
95
|
+
* MCP service identifier.
|
|
96
|
+
*/
|
|
97
|
+
service: string;
|
|
98
|
+
type: 'mcpToolCall';
|
|
99
|
+
} | {
|
|
100
|
+
/**
|
|
101
|
+
* Corresponding call id.
|
|
102
|
+
*/
|
|
103
|
+
id: string;
|
|
104
|
+
/**
|
|
105
|
+
* Response payload.
|
|
106
|
+
*/
|
|
107
|
+
json: unknown;
|
|
108
|
+
/**
|
|
109
|
+
* Tool name.
|
|
110
|
+
*/
|
|
111
|
+
name: string;
|
|
112
|
+
type: 'toolCallResponseJson';
|
|
113
|
+
} | {
|
|
114
|
+
/**
|
|
115
|
+
* Human-readable error description.
|
|
116
|
+
*/
|
|
117
|
+
description: string;
|
|
118
|
+
/**
|
|
119
|
+
* Corresponding call id.
|
|
120
|
+
*/
|
|
121
|
+
id: string;
|
|
122
|
+
/**
|
|
123
|
+
* Tool name.
|
|
124
|
+
*/
|
|
125
|
+
name: string;
|
|
126
|
+
type: 'toolCallErr';
|
|
127
|
+
} | {
|
|
128
|
+
/**
|
|
129
|
+
* The thinking text content.
|
|
130
|
+
*/
|
|
131
|
+
thinking: string;
|
|
132
|
+
type: 'thinking';
|
|
133
|
+
};
|
|
134
|
+
export type AttachmentMetadata = {
|
|
135
|
+
/**
|
|
136
|
+
* Name of the document
|
|
137
|
+
*/
|
|
138
|
+
document_name: string;
|
|
139
|
+
/**
|
|
140
|
+
* Type of the document ['pdf' | 'docx' | 'md']
|
|
141
|
+
*/
|
|
142
|
+
document_type: FileType;
|
|
143
|
+
type: 'document';
|
|
144
|
+
} | {
|
|
145
|
+
project_name: string;
|
|
146
|
+
type: 'project';
|
|
147
|
+
} | {
|
|
148
|
+
/**
|
|
149
|
+
* jpg | png | etc
|
|
150
|
+
*/
|
|
151
|
+
image_extension: FileType;
|
|
152
|
+
/**
|
|
153
|
+
* image name
|
|
154
|
+
*/
|
|
155
|
+
image_name: string;
|
|
156
|
+
type: 'image';
|
|
157
|
+
} | {
|
|
158
|
+
channel_name: string;
|
|
159
|
+
channel_type: ChannelType;
|
|
160
|
+
type: 'channel';
|
|
161
|
+
} | {
|
|
162
|
+
email_subject: string;
|
|
163
|
+
type: 'email';
|
|
164
|
+
};
|
|
165
|
+
export type AttachmentType = 'document' | 'image' | 'channel' | 'email' | 'project' | 'skill';
|
|
166
|
+
/**
|
|
167
|
+
* Request body for executing a pending tool call.
|
|
168
|
+
*/
|
|
169
|
+
export type CallToolRequest = {
|
|
170
|
+
/**
|
|
171
|
+
* Optional updated arguments. Uses original args if omitted.
|
|
172
|
+
*/
|
|
173
|
+
args?: unknown;
|
|
174
|
+
/**
|
|
175
|
+
* The message ID containing the tool call.
|
|
176
|
+
*/
|
|
177
|
+
messageId: string;
|
|
178
|
+
/**
|
|
179
|
+
* The tool call ID to execute.
|
|
180
|
+
*/
|
|
181
|
+
toolCallId: string;
|
|
182
|
+
};
|
|
183
|
+
/**
|
|
184
|
+
* Response body for a successful tool call.
|
|
185
|
+
*/
|
|
186
|
+
export type CallToolResponse = {
|
|
187
|
+
/**
|
|
188
|
+
* The tool execution result.
|
|
189
|
+
*/
|
|
190
|
+
result: unknown;
|
|
191
|
+
};
|
|
192
|
+
/**
|
|
193
|
+
* The channel share permission
|
|
194
|
+
*/
|
|
195
|
+
export type ChannelSharePermission = {
|
|
196
|
+
/**
|
|
197
|
+
* The access level for the channel
|
|
198
|
+
*/
|
|
199
|
+
access_level: AccessLevel;
|
|
200
|
+
/**
|
|
201
|
+
* The channel id
|
|
202
|
+
*/
|
|
203
|
+
channel_id: string;
|
|
204
|
+
};
|
|
205
|
+
export type ChannelType = 'public' | 'private' | 'direct_message' | 'team';
|
|
206
|
+
export type Chat = {
|
|
207
|
+
/**
|
|
208
|
+
* The time the chat was created
|
|
209
|
+
*/
|
|
210
|
+
createdAt?: string | null;
|
|
211
|
+
/**
|
|
212
|
+
* The time the chat was deleted
|
|
213
|
+
*/
|
|
214
|
+
deletedAt?: string | null;
|
|
215
|
+
/**
|
|
216
|
+
* The chat uuid
|
|
217
|
+
*/
|
|
218
|
+
id: string;
|
|
219
|
+
isPersistent: boolean;
|
|
220
|
+
/**
|
|
221
|
+
* The model used to generate the chat
|
|
222
|
+
*/
|
|
223
|
+
model?: string | null;
|
|
224
|
+
/**
|
|
225
|
+
* The name of the chat
|
|
226
|
+
*/
|
|
227
|
+
name: string;
|
|
228
|
+
/**
|
|
229
|
+
* The project id of the chat
|
|
230
|
+
*/
|
|
231
|
+
projectId?: string | null;
|
|
232
|
+
tokenCount?: number | null;
|
|
233
|
+
/**
|
|
234
|
+
* The time the chat was last updated
|
|
235
|
+
*/
|
|
236
|
+
updatedAt?: string | null;
|
|
237
|
+
/**
|
|
238
|
+
* Who the chat belongs to
|
|
239
|
+
*/
|
|
240
|
+
userId: string;
|
|
241
|
+
};
|
|
242
|
+
export type ChatAttachment = {
|
|
243
|
+
/**
|
|
244
|
+
* The id of the attachment
|
|
245
|
+
* either a `document_id` or `project_id` or `chat_id`
|
|
246
|
+
*/
|
|
247
|
+
attachment_id: string;
|
|
248
|
+
/**
|
|
249
|
+
* The type of attachment
|
|
250
|
+
*/
|
|
251
|
+
attachment_type: AttachmentType;
|
|
252
|
+
/**
|
|
253
|
+
* The id of the chat if the attachment is a chat
|
|
254
|
+
*/
|
|
255
|
+
chat_id?: string | null;
|
|
256
|
+
/**
|
|
257
|
+
* db attachment id - unused
|
|
258
|
+
*/
|
|
259
|
+
id: string;
|
|
260
|
+
/**
|
|
261
|
+
* The id of the message if the attachment is a message
|
|
262
|
+
*/
|
|
263
|
+
message_id?: string | null;
|
|
264
|
+
};
|
|
265
|
+
export type ChatHistory = {
|
|
266
|
+
conversation: Array<ConversationRecord>;
|
|
267
|
+
};
|
|
268
|
+
export type ChatHistoryBatchMessagesRequest = {
|
|
269
|
+
message_ids: Array<string>;
|
|
270
|
+
};
|
|
271
|
+
export type ChatMessage = {
|
|
272
|
+
/**
|
|
273
|
+
* Message content
|
|
274
|
+
*/
|
|
275
|
+
content: ChatMessageContent;
|
|
276
|
+
/**
|
|
277
|
+
* The chat message id
|
|
278
|
+
*/
|
|
279
|
+
id: string;
|
|
280
|
+
/**
|
|
281
|
+
* the model used to generate the message
|
|
282
|
+
*/
|
|
283
|
+
model?: string | null;
|
|
284
|
+
/**
|
|
285
|
+
* Whether the chat is from the user or system
|
|
286
|
+
*/
|
|
287
|
+
role: Role;
|
|
288
|
+
};
|
|
289
|
+
/**
|
|
290
|
+
* The content of a [`ChatMessage`].
|
|
291
|
+
*
|
|
292
|
+
* For user and system messages the content is plain [`Text`](Self::Text).
|
|
293
|
+
* For assistant messages it may additionally be a sequence of
|
|
294
|
+
* [`AssistantMessagePart`]s that encode tool-call round trips.
|
|
295
|
+
*/
|
|
296
|
+
export type ChatMessageContent = string | Array<AssistantMessagePart>;
|
|
297
|
+
/**
|
|
298
|
+
* Error response for chat message endpoints
|
|
299
|
+
*/
|
|
300
|
+
export type ChatMessageError = {
|
|
301
|
+
/**
|
|
302
|
+
* Stable machine-readable code for admission errors (402 or 503).
|
|
303
|
+
*/
|
|
304
|
+
code?: string | null;
|
|
305
|
+
error: string;
|
|
306
|
+
stream_id?: string | null;
|
|
307
|
+
};
|
|
308
|
+
export type ChatMessageWithAttachments = {
|
|
309
|
+
/**
|
|
310
|
+
* The ids of the attachments used to generate the message
|
|
311
|
+
*/
|
|
312
|
+
attachments: Array<Entity>;
|
|
313
|
+
/**
|
|
314
|
+
* Message content
|
|
315
|
+
*/
|
|
316
|
+
content: ChatMessageContent;
|
|
317
|
+
/**
|
|
318
|
+
* The chat message id
|
|
319
|
+
*/
|
|
320
|
+
id: string;
|
|
321
|
+
/**
|
|
322
|
+
* Whether the chat is from the user or system
|
|
323
|
+
*/
|
|
324
|
+
role: Role;
|
|
325
|
+
};
|
|
326
|
+
export type ChatPreview = (ChatPreviewData & {
|
|
327
|
+
type: 'access';
|
|
328
|
+
}) | (WithChatId & {
|
|
329
|
+
type: 'no_access';
|
|
330
|
+
}) | (WithChatId & {
|
|
331
|
+
type: 'does_not_exist';
|
|
332
|
+
});
|
|
333
|
+
export type ChatPreviewData = {
|
|
334
|
+
chat_id: string;
|
|
335
|
+
chat_name: string;
|
|
336
|
+
owner: string;
|
|
337
|
+
updated_at?: string | null;
|
|
338
|
+
};
|
|
339
|
+
/**
|
|
340
|
+
* The full chat response, matching the DCS API response shape.
|
|
341
|
+
*/
|
|
342
|
+
export type ChatResponse = {
|
|
343
|
+
/**
|
|
344
|
+
* The time the chat was created.
|
|
345
|
+
*/
|
|
346
|
+
createdAt?: string | null;
|
|
347
|
+
/**
|
|
348
|
+
* The chat uuid.
|
|
349
|
+
*/
|
|
350
|
+
id: string;
|
|
351
|
+
/**
|
|
352
|
+
* The messages in the chat.
|
|
353
|
+
*/
|
|
354
|
+
messages: Array<ChatMessageWithAttachments>;
|
|
355
|
+
/**
|
|
356
|
+
* The model used to generate the chat (`provider/model` id).
|
|
357
|
+
*/
|
|
358
|
+
model?: string | null;
|
|
359
|
+
/**
|
|
360
|
+
* The name of the chat.
|
|
361
|
+
*/
|
|
362
|
+
name: string;
|
|
363
|
+
/**
|
|
364
|
+
* The project id the chat belongs to.
|
|
365
|
+
*/
|
|
366
|
+
projectId?: string | null;
|
|
367
|
+
/**
|
|
368
|
+
* The time the chat was last updated.
|
|
369
|
+
*/
|
|
370
|
+
updatedAt?: string | null;
|
|
371
|
+
/**
|
|
372
|
+
* Who the chat belongs to.
|
|
373
|
+
*/
|
|
374
|
+
userId: string;
|
|
375
|
+
};
|
|
376
|
+
export type ChatStream = (StreamError & {
|
|
377
|
+
type: 'error';
|
|
378
|
+
}) | {
|
|
379
|
+
attachments: Array<Entity>;
|
|
380
|
+
chat_id: string;
|
|
381
|
+
content: string;
|
|
382
|
+
message_id: string;
|
|
383
|
+
stream_id: string;
|
|
384
|
+
type: 'chat_user_message';
|
|
385
|
+
} | {
|
|
386
|
+
chat_id: string;
|
|
387
|
+
content: AssistantMessagePart;
|
|
388
|
+
message_id: string;
|
|
389
|
+
stream_id: string;
|
|
390
|
+
type: 'chat_message_response';
|
|
391
|
+
} | {
|
|
392
|
+
stream_id: string;
|
|
393
|
+
type: 'stream_end';
|
|
394
|
+
};
|
|
395
|
+
/**
|
|
396
|
+
* Body for completing onboarding.
|
|
397
|
+
*/
|
|
398
|
+
export type CompleteOnboardingRequest = {
|
|
399
|
+
/**
|
|
400
|
+
* Whether the user skipped rather than finished.
|
|
401
|
+
*/
|
|
402
|
+
skipped?: boolean;
|
|
403
|
+
};
|
|
404
|
+
/**
|
|
405
|
+
* How much a model may think before it gives a structured answer.
|
|
406
|
+
*/
|
|
407
|
+
export type CompletionThinking = 'default' | 'low';
|
|
408
|
+
/**
|
|
409
|
+
* User and feature attribution for one invocation.
|
|
410
|
+
*/
|
|
411
|
+
export type CompletionUsage = {
|
|
412
|
+
/**
|
|
413
|
+
* Measured usage and resolved cost.
|
|
414
|
+
*/
|
|
415
|
+
cost: Usage;
|
|
416
|
+
/**
|
|
417
|
+
* Related entity, if any.
|
|
418
|
+
*/
|
|
419
|
+
entity?: string | null;
|
|
420
|
+
/**
|
|
421
|
+
* Feature that performed the invocation.
|
|
422
|
+
*/
|
|
423
|
+
feature: AiFeature;
|
|
424
|
+
/**
|
|
425
|
+
* User the invocation was performed for.
|
|
426
|
+
*/
|
|
427
|
+
user: RoxUserIdStr;
|
|
428
|
+
};
|
|
429
|
+
/**
|
|
430
|
+
* One of the user's MCP server connections, as the setup page sees it.
|
|
431
|
+
*/
|
|
432
|
+
export type ConnectedServer = {
|
|
433
|
+
/**
|
|
434
|
+
* Whether the user has completed OAuth against it.
|
|
435
|
+
*/
|
|
436
|
+
authenticated: boolean;
|
|
437
|
+
/**
|
|
438
|
+
* The server's display name.
|
|
439
|
+
*/
|
|
440
|
+
name: string;
|
|
441
|
+
/**
|
|
442
|
+
* The server URL.
|
|
443
|
+
*/
|
|
444
|
+
url: string;
|
|
445
|
+
};
|
|
446
|
+
export type ConversationRecord = {
|
|
447
|
+
chat_id: string;
|
|
448
|
+
messages: Array<MessageWithAttachments>;
|
|
449
|
+
title: string;
|
|
450
|
+
};
|
|
451
|
+
/**
|
|
452
|
+
* Request body for creating a chat.
|
|
453
|
+
*/
|
|
454
|
+
export type CreateChatRequest = {
|
|
455
|
+
/**
|
|
456
|
+
* Optional name for the chat.
|
|
457
|
+
*/
|
|
458
|
+
name?: string | null;
|
|
459
|
+
/**
|
|
460
|
+
* Optional project to associate the chat with.
|
|
461
|
+
*/
|
|
462
|
+
projectId?: string | null;
|
|
463
|
+
};
|
|
464
|
+
/**
|
|
465
|
+
* What a successful tool call committed to the user's databases.
|
|
466
|
+
*/
|
|
467
|
+
export type DatabaseChange = {
|
|
468
|
+
kind: 'none';
|
|
469
|
+
} | {
|
|
470
|
+
kind: 'schema';
|
|
471
|
+
} | {
|
|
472
|
+
count: number;
|
|
473
|
+
kind: 'rows';
|
|
474
|
+
};
|
|
475
|
+
/**
|
|
476
|
+
* A proposal, never stored results or permission to read the named database.
|
|
477
|
+
*/
|
|
478
|
+
export type DatabaseQueryAnswer = {
|
|
479
|
+
answerable: boolean;
|
|
480
|
+
chart?: null | DatabaseQueryChart;
|
|
481
|
+
databaseId?: string | null;
|
|
482
|
+
displayMode: DatabaseQueryDisplayMode;
|
|
483
|
+
explanation: string;
|
|
484
|
+
sql: string;
|
|
485
|
+
title: string;
|
|
486
|
+
};
|
|
487
|
+
/**
|
|
488
|
+
* Chart fields name the proposal's result columns exactly.
|
|
489
|
+
*/
|
|
490
|
+
export type DatabaseQueryChart = {
|
|
491
|
+
color?: string | null;
|
|
492
|
+
stack: boolean;
|
|
493
|
+
title: string;
|
|
494
|
+
x: string;
|
|
495
|
+
y: Array<string>;
|
|
496
|
+
};
|
|
497
|
+
/**
|
|
498
|
+
* Supported live-answer presentations.
|
|
499
|
+
*/
|
|
500
|
+
export type DatabaseQueryDisplayMode = 'scalar' | 'table' | 'bar' | 'line' | 'area' | 'scatter' | 'pie';
|
|
501
|
+
/**
|
|
502
|
+
* The question and untrusted schema hints; authorization remains in the read services.
|
|
503
|
+
*/
|
|
504
|
+
export type DatabaseQueryRequest = {
|
|
505
|
+
/**
|
|
506
|
+
* The SQL engine's error from one failed proposal, used for a bounded repair.
|
|
507
|
+
*/
|
|
508
|
+
error?: string | null;
|
|
509
|
+
model: string;
|
|
510
|
+
prompt: string;
|
|
511
|
+
schema: unknown;
|
|
512
|
+
sql: string;
|
|
513
|
+
};
|
|
514
|
+
/**
|
|
515
|
+
* Sanitized, machine-readable failure of a decision request.
|
|
516
|
+
*/
|
|
517
|
+
export type DecisionErrorBody = {
|
|
518
|
+
/**
|
|
519
|
+
* Stable failure code.
|
|
520
|
+
*/
|
|
521
|
+
code: string;
|
|
522
|
+
/**
|
|
523
|
+
* Human-readable explanation without provider credentials or diagnostics.
|
|
524
|
+
*/
|
|
525
|
+
error: string;
|
|
526
|
+
};
|
|
527
|
+
/**
|
|
528
|
+
* Named yes/no questions to evaluate against one arbitrary JSON input.
|
|
529
|
+
*/
|
|
530
|
+
export type DecisionRequest = {
|
|
531
|
+
/**
|
|
532
|
+
* Data to classify. The entire compact request must fit in 64 KiB.
|
|
533
|
+
*/
|
|
534
|
+
input: unknown;
|
|
535
|
+
/**
|
|
536
|
+
* One to 32 questions, each at most 500 characters. Keys must be nonblank
|
|
537
|
+
* and at most 80 UTF-8 bytes; they are preserved in the response.
|
|
538
|
+
*/
|
|
539
|
+
questions: {
|
|
540
|
+
[key: string]: string;
|
|
541
|
+
};
|
|
542
|
+
};
|
|
543
|
+
/**
|
|
544
|
+
* The probability of yes for every requested question, under its original key.
|
|
545
|
+
*/
|
|
546
|
+
export type DecisionResponse = {
|
|
547
|
+
/**
|
|
548
|
+
* Probabilities between zero and one, inclusive; not boolean decisions.
|
|
549
|
+
*/
|
|
550
|
+
probabilities: {
|
|
551
|
+
[key: string]: number;
|
|
552
|
+
};
|
|
553
|
+
};
|
|
554
|
+
/**
|
|
555
|
+
* The prompts the user dismissed, on any device.
|
|
556
|
+
*/
|
|
557
|
+
export type DismissedPrompts = {
|
|
558
|
+
/**
|
|
559
|
+
* Dismissed prompt ids, oldest dismissal first.
|
|
560
|
+
*/
|
|
561
|
+
dismissed: Array<string>;
|
|
562
|
+
};
|
|
563
|
+
export type DocumentCognitionServiceApiVersion = 'v1' | 'v2';
|
|
564
|
+
export type DocumentReference = UserPdfRect & {
|
|
565
|
+
kind: 'pdf';
|
|
566
|
+
};
|
|
567
|
+
export type DocumentTextPart = {
|
|
568
|
+
document_id: string;
|
|
569
|
+
id: string;
|
|
570
|
+
reference: DocumentReference;
|
|
571
|
+
};
|
|
572
|
+
/**
|
|
573
|
+
* Schema definition for dynamic structured completions.
|
|
574
|
+
*/
|
|
575
|
+
export type DynamicSchema = {
|
|
576
|
+
/**
|
|
577
|
+
* Optional description of what the schema represents.
|
|
578
|
+
*/
|
|
579
|
+
description?: string | null;
|
|
580
|
+
/**
|
|
581
|
+
* Name of the schema.
|
|
582
|
+
*/
|
|
583
|
+
name: string;
|
|
584
|
+
/**
|
|
585
|
+
* The JSON schema to validate against.
|
|
586
|
+
*/
|
|
587
|
+
schema: unknown;
|
|
588
|
+
};
|
|
589
|
+
/**
|
|
590
|
+
* The Entity describes the minimum amount of information required to describe a unique thing in Macro
|
|
591
|
+
* This contains the type of the entity [EntityType] and the string id of that entity
|
|
592
|
+
*/
|
|
593
|
+
export type Entity = {
|
|
594
|
+
/**
|
|
595
|
+
* The id of that entity
|
|
596
|
+
*/
|
|
597
|
+
entity_id: string;
|
|
598
|
+
/**
|
|
599
|
+
* The type of entity we are describing
|
|
600
|
+
*/
|
|
601
|
+
entity_type: EntityType;
|
|
602
|
+
};
|
|
603
|
+
/**
|
|
604
|
+
* The type of an entity in Macro
|
|
605
|
+
*/
|
|
606
|
+
export type EntityType = 'user' | 'chat' | 'channel' | 'channel_message' | 'document' | 'project' | 'email_thread' | 'calendar_event' | 'team' | 'call' | 'foreign_entity' | 'static_file' | 'crm_company' | 'crm_contact' | 'crm_pipeline' | 'reminder' | 'harness' | 'skill' | 'agent_session' | 'scheduled_action' | 'initiative' | 'database' | 'database_row' | 'form' | 'external_chat';
|
|
607
|
+
/**
|
|
608
|
+
* Error response body.
|
|
609
|
+
*/
|
|
610
|
+
export type ErrorBody = {
|
|
611
|
+
/**
|
|
612
|
+
* Human-readable error description.
|
|
613
|
+
*/
|
|
614
|
+
error: string;
|
|
615
|
+
};
|
|
616
|
+
/**
|
|
617
|
+
* A plain old json error response for use with axum.
|
|
618
|
+
* yup, thats it.
|
|
619
|
+
*/
|
|
620
|
+
export type ErrorResponse = {
|
|
621
|
+
/**
|
|
622
|
+
* Message to explain failure
|
|
623
|
+
*/
|
|
624
|
+
message: string;
|
|
625
|
+
};
|
|
626
|
+
/**
|
|
627
|
+
* A private explicit memory document and its optimistic concurrency token.
|
|
628
|
+
*/
|
|
629
|
+
export type ExplicitMemory = {
|
|
630
|
+
content: string;
|
|
631
|
+
revision: number;
|
|
632
|
+
};
|
|
633
|
+
/**
|
|
634
|
+
* Recorded invocations and total for one feature.
|
|
635
|
+
*/
|
|
636
|
+
export type FeatureUsage = {
|
|
637
|
+
/**
|
|
638
|
+
* Recorded invocations.
|
|
639
|
+
*/
|
|
640
|
+
entries: Array<CompletionUsage>;
|
|
641
|
+
/**
|
|
642
|
+
* Feature attribution.
|
|
643
|
+
*/
|
|
644
|
+
feature: AiFeature;
|
|
645
|
+
/**
|
|
646
|
+
* Total cost (USD).
|
|
647
|
+
*/
|
|
648
|
+
total: number;
|
|
649
|
+
};
|
|
650
|
+
/**
|
|
651
|
+
* Generates a FileType enum and associated ContentType enum with their implementations.
|
|
652
|
+
*
|
|
653
|
+
* This macro takes a list of tuples in the format:
|
|
654
|
+
* (Variant, "extension", "mime_type", CONTENT_TYPE_VARIANT)
|
|
655
|
+
*
|
|
656
|
+
* For each tuple it generates:
|
|
657
|
+
* - A variant in the FileType enum
|
|
658
|
+
* - A variant in the ContentType enum
|
|
659
|
+
* - Implementations for:
|
|
660
|
+
* - FileType::to_str() - Converts FileType to extension string
|
|
661
|
+
* - FileType::from_str() - Converts extension string to FileType
|
|
662
|
+
* - From<FileType> for ContentType - Maps FileType to ContentType
|
|
663
|
+
* - ContentType::mime_type() - Gets MIME type for ContentType
|
|
664
|
+
*
|
|
665
|
+
*/
|
|
666
|
+
export type FileType = 'docx' | 'pdf' | 'md' | 'spreadsheet' | 'canvas' | 'coffee' | 'cson' | 'iced' | 'c' | 'i' | 'cpp' | 'cppm' | 'cc' | 'ccm' | 'cxx' | 'cxxm' | 'cplusplus' | 'cplusplusm' | 'hpp' | 'hh' | 'hxx' | 'hplusplus' | 'h' | 'ii' | 'ino' | 'inl' | 'ipp' | 'ixx' | 'tpp' | 'txx' | 'hppin' | 'hin' | 'cu' | 'cuh' | 'cs' | 'csx' | 'cake' | 'css' | 'dart' | 'diff' | 'patch' | 'rej' | 'dockerfile' | 'containerfile' | 'go' | 'handlebars' | 'hbs' | 'hjs' | 'hlsl' | 'hlsli' | 'fx' | 'fxh' | 'vsh' | 'psh' | 'cginc' | 'compute' | 'html' | 'htm' | 'shtml' | 'xhtml' | 'xht' | 'mdoc' | 'jsp' | 'asp' | 'aspx' | 'jshtm' | 'volt' | 'ejs' | 'rhtml' | 'ini' | 'conf' | 'properties' | 'cfg' | 'directory' | 'gitattributes' | 'gitconfig' | 'gitmodules' | 'editorconfig' | 'repo' | 'java' | 'jav' | 'jsx' | 'js' | 'es6' | 'mjs' | 'cjs' | 'pac' | 'json' | 'bowerrc' | 'jscsrc' | 'webmanifest' | 'jsmap' | 'cssmap' | 'tsmap' | 'har' | 'jslintrc' | 'jsonld' | 'geojson' | 'ipynb' | 'vuerc' | 'jsonc' | 'eslintrc' | 'eslintrcjson' | 'jsfmtrc' | 'jshintrc' | 'swcrc' | 'hintrc' | 'babelrc' | 'jsonl' | 'ndjson' | 'codesnippets' | 'jl' | 'jmd' | 'sty' | 'cls' | 'bbx' | 'cbx' | 'tex' | 'ltx' | 'ctx' | 'bib' | 'less' | 'log' | 'lua' | 'mak' | 'mk' | 'mkd' | 'mdwn' | 'mdown' | 'markdown' | 'markdn' | 'mdtxt' | 'mdtext' | 'workbook' | 'm' | 'mm' | 'pl' | 'pm' | 'pod' | 't' | 'psgi' | 'raku' | 'rakumod' | 'rakutest' | 'rakudoc' | 'nqp' | 'p6' | 'pl6' | 'pm6' | 'php' | 'php4' | 'php5' | 'phtml' | 'ctp' | 'ps1' | 'psm1' | 'psd1' | 'pssc' | 'psrc' | 'py' | 'rpy' | 'pyw' | 'cpy' | 'gyp' | 'gypi' | 'pyi' | 'ipy' | 'pyt' | 'r' | 'rhistory' | 'rprofile' | 'rt' | 'cshtml' | 'razor' | 'rb' | 'rbx' | 'rjs' | 'gemspec' | 'rake' | 'ru' | 'erb' | 'podspec' | 'rbi' | 'rs' | 'scss' | 'sass' | 'shader' | 'sh' | 'bash' | 'bashrc' | 'bashaliases' | 'bashprofile' | 'bashlogin' | 'ebuild' | 'eclass' | 'profile' | 'bashlogout' | 'xprofile' | 'xsession' | 'xsessionrc' | 'zsh' | 'zshrc' | 'zprofile' | 'zlogin' | 'zlogout' | 'zshenv' | 'zshtheme' | 'fish' | 'ksh' | 'csh' | 'cshrc' | 'tcshrc' | 'yashrc' | 'yashprofile' | 'sql' | 'dsql' | 'swift' | 'ts' | 'cts' | 'mts' | 'tsx' | 'tsbuildinfo' | 'xml' | 'xsd' | 'ascx' | 'atom' | 'axml' | 'axaml' | 'bpmn' | 'cpt' | 'csl' | 'csproj' | 'csprojuser' | 'dita' | 'ditamap' | 'dtd' | 'ent' | 'mod' | 'dtml' | 'fsproj' | 'fxml' | 'iml' | 'isml' | 'jmx' | 'launch' | 'menu' | 'mxml' | 'nuspec' | 'opml' | 'owl' | 'proj' | 'props' | 'pt' | 'publishsettings' | 'pubxml' | 'pubxmluser' | 'rbxlx' | 'rbxmx' | 'rdf' | 'rng' | 'rss' | 'shproj' | 'storyboard' | 'targets' | 'tld' | 'tmx' | 'vbproj' | 'vbprojuser' | 'vcxproj' | 'vcxprojfilters' | 'wsdl' | 'wxi' | 'wxl' | 'wxs' | 'xaml' | 'xbl' | 'xib' | 'xlf' | 'xliff' | 'xpdl' | 'xul' | 'xoml' | 'xsl' | 'xslt' | 'yaml' | 'yml' | 'eyaml' | 'eyml' | 'cff' | 'yamltmlanguage' | 'yamltmpreferences' | 'yamltmtheme' | 'winget' | 'txt' | 'csv' | 'tsv' | 'jpeg' | 'jpg' | 'png' | 'gif' | 'svg' | 'webp' | 'avif' | 'bmp' | 'ico' | 'tiff' | 'tif' | 'heic' | 'heif' | 'tar' | 'targz' | 'tgz' | 'gz' | 'bz2' | 'tarbz2' | 'tbz2' | 'z' | 'tarz' | 'lz' | 'tarlz' | 'xz' | 'tarxz' | 'txz' | 'lzma' | 'tarlzma' | 'rar' | 'sevenz' | 'zst' | 'tarzst' | 'tzst' | 'zip' | 'exe' | 'msi' | 'dll' | 'bat' | 'cmd' | 'com' | 'appimage' | 'app' | 'bin' | 'deb' | 'rpm' | 'apk' | 'dmg' | 'pkg' | 'crx' | 'xpi' | 'mp3' | 'wav' | 'ogg' | 'flac' | 'aac' | 'm4a' | 'wma' | 'mid' | 'midi' | 'mp4' | 'mkv' | 'webm' | 'avi' | 'mov' | 'wmv' | 'mpg' | 'mpeg' | 'm4v' | 'flv' | 'f4v' | 'threegp' | 'ttf' | 'otf' | 'woff' | 'woff2' | 'eot' | 'rtf' | 'odt' | 'ods' | 'odp' | 'odg' | 'odf' | 'epub' | 'mobi' | 'azw' | 'azw3' | 'djvu' | 'xls' | 'xlsm' | 'ppt' | 'doc' | 'pptx' | 'xlsx' | 'db' | 'sqlite' | 'sqlite3' | 'mdb' | 'accdb' | 'dbf' | 'plist' | 'toml' | 'env' | 'dot' | 'gv' | 'torrent' | 'ics' | 'vcf' | 'ai' | 'eps' | 'ps' | 'dxf' | 'dwg' | 'fig' | 'psd' | 'psb' | 'stl' | 'obj' | 'fbx' | 'blend' | 'dae' | 'threeds' | 'gltf' | 'glb' | 'vhd' | 'vhdx' | 'vmdk' | 'ova' | 'ovf' | 'iso' | 'img' | 'swf';
|
|
667
|
+
/**
|
|
668
|
+
* A `provider/model` id every user may request without professional features.
|
|
669
|
+
*/
|
|
670
|
+
export type FreeTierModel = 'google/gemini-3.8-flash';
|
|
671
|
+
/**
|
|
672
|
+
* Shape of the generated image.
|
|
673
|
+
*/
|
|
674
|
+
export type GenerateImageAspectRatio = 'square' | 'landscape' | 'portrait' | 'widescreen' | 'tall';
|
|
675
|
+
/**
|
|
676
|
+
* Sanitized, machine-readable failure of an image request.
|
|
677
|
+
*/
|
|
678
|
+
export type GenerateImageErrorBody = {
|
|
679
|
+
/**
|
|
680
|
+
* Stable failure code.
|
|
681
|
+
*/
|
|
682
|
+
code: string;
|
|
683
|
+
/**
|
|
684
|
+
* Explanation without provider or storage diagnostics.
|
|
685
|
+
*/
|
|
686
|
+
error: string;
|
|
687
|
+
};
|
|
688
|
+
/**
|
|
689
|
+
* A reference image already stored in Rox.
|
|
690
|
+
*/
|
|
691
|
+
export type GenerateImageReference = {
|
|
692
|
+
/**
|
|
693
|
+
* The Rox document ID.
|
|
694
|
+
*/
|
|
695
|
+
id: string;
|
|
696
|
+
type: 'document';
|
|
697
|
+
} | {
|
|
698
|
+
/**
|
|
699
|
+
* The static file ID.
|
|
700
|
+
*/
|
|
701
|
+
id: string;
|
|
702
|
+
type: 'staticFile';
|
|
703
|
+
};
|
|
704
|
+
/**
|
|
705
|
+
* What image to generate.
|
|
706
|
+
*/
|
|
707
|
+
export type GenerateImageRequest = {
|
|
708
|
+
aspectRatio?: null | GenerateImageAspectRatio;
|
|
709
|
+
/**
|
|
710
|
+
* Description of the image: subject, style, composition, colours, and any text to render.
|
|
711
|
+
*/
|
|
712
|
+
prompt: string;
|
|
713
|
+
/**
|
|
714
|
+
* Up to three reference images, in the order the prompt refers to them.
|
|
715
|
+
*/
|
|
716
|
+
referenceImages?: Array<GenerateImageReference>;
|
|
717
|
+
};
|
|
718
|
+
/**
|
|
719
|
+
* The stored generated image.
|
|
720
|
+
*/
|
|
721
|
+
export type GenerateImageResponse = {
|
|
722
|
+
/**
|
|
723
|
+
* Intrinsic pixel height.
|
|
724
|
+
*/
|
|
725
|
+
height: number;
|
|
726
|
+
/**
|
|
727
|
+
* IANA media type of the image, e.g. `image/png`.
|
|
728
|
+
*/
|
|
729
|
+
mimeType: string;
|
|
730
|
+
/**
|
|
731
|
+
* Commentary the model produced alongside the image, when any.
|
|
732
|
+
*/
|
|
733
|
+
note?: string | null;
|
|
734
|
+
/**
|
|
735
|
+
* Size of the image in bytes.
|
|
736
|
+
*/
|
|
737
|
+
sizeBytes: number;
|
|
738
|
+
/**
|
|
739
|
+
* Static file ID, reusable as a reference image or a message attachment.
|
|
740
|
+
*/
|
|
741
|
+
staticFileId: string;
|
|
742
|
+
/**
|
|
743
|
+
* Permanent URL of the image.
|
|
744
|
+
*/
|
|
745
|
+
url: string;
|
|
746
|
+
/**
|
|
747
|
+
* Intrinsic pixel width.
|
|
748
|
+
*/
|
|
749
|
+
width: number;
|
|
750
|
+
};
|
|
751
|
+
export type GenericErrorResponse = {
|
|
752
|
+
/**
|
|
753
|
+
* Indicates if an error occurred
|
|
754
|
+
*/
|
|
755
|
+
error: boolean;
|
|
756
|
+
/**
|
|
757
|
+
* Message to explain failure
|
|
758
|
+
*/
|
|
759
|
+
message: string;
|
|
760
|
+
};
|
|
761
|
+
export type GetBatchPreviewRequest = {
|
|
762
|
+
chat_ids: Array<string>;
|
|
763
|
+
};
|
|
764
|
+
export type GetBatchPreviewResponse = {
|
|
765
|
+
previews: Array<ChatPreview>;
|
|
766
|
+
};
|
|
767
|
+
/**
|
|
768
|
+
* Response body for get chat permissions.
|
|
769
|
+
*/
|
|
770
|
+
export type GetChatPermissionsResponse = {
|
|
771
|
+
/**
|
|
772
|
+
* The share permissions for the chat.
|
|
773
|
+
*/
|
|
774
|
+
permissions: SharePermissionV2;
|
|
775
|
+
};
|
|
776
|
+
/**
|
|
777
|
+
* Wrapper response for get_chat, matching the DCS API response shape.
|
|
778
|
+
*/
|
|
779
|
+
export type GetChatResponse = {
|
|
780
|
+
/**
|
|
781
|
+
* The full chat data.
|
|
782
|
+
*/
|
|
783
|
+
chat: ChatResponse;
|
|
784
|
+
/**
|
|
785
|
+
* The requesting user's access level on this chat.
|
|
786
|
+
*/
|
|
787
|
+
userAccessLevel: AccessLevel;
|
|
788
|
+
};
|
|
789
|
+
export type GetChatsForAttachmentResponse = {
|
|
790
|
+
all_chats: Array<Chat>;
|
|
791
|
+
recent_chat?: null | Chat;
|
|
792
|
+
};
|
|
793
|
+
/**
|
|
794
|
+
* Fixed calendar granularity, always in UTC, with Monday-start weeks.
|
|
795
|
+
*/
|
|
796
|
+
export type Granularity = 'day' | 'week' | 'month' | 'summary';
|
|
797
|
+
/**
|
|
798
|
+
* HTTP request payload for sending a chat message.
|
|
799
|
+
* Unlike the WebSocket payload, this does not include stream_id as it's generated server-side.
|
|
800
|
+
*/
|
|
801
|
+
export type HttpSendChatMessageRequest = {
|
|
802
|
+
/**
|
|
803
|
+
* Additional system instructions appended to the base system prompt
|
|
804
|
+
*/
|
|
805
|
+
additional_instructions?: string | null;
|
|
806
|
+
/**
|
|
807
|
+
* Attachments for the message
|
|
808
|
+
*/
|
|
809
|
+
attachments?: Array<Entity> | null;
|
|
810
|
+
/**
|
|
811
|
+
* Id of the chat the message belongs to (optional - if not provided, a new chat is created)
|
|
812
|
+
*/
|
|
813
|
+
chat_id?: string | null;
|
|
814
|
+
/**
|
|
815
|
+
* The content of the message
|
|
816
|
+
*/
|
|
817
|
+
content: string;
|
|
818
|
+
/**
|
|
819
|
+
* The model to respond with (`provider/model` id)
|
|
820
|
+
*/
|
|
821
|
+
model: string;
|
|
822
|
+
/**
|
|
823
|
+
* Inference speed, validated against the selected model. Defaults to standard.
|
|
824
|
+
*/
|
|
825
|
+
speed?: ModelSpeed;
|
|
826
|
+
/**
|
|
827
|
+
* Which toolset to use. Defaults to `all`
|
|
828
|
+
*/
|
|
829
|
+
toolset?: ToolSet;
|
|
830
|
+
};
|
|
831
|
+
/**
|
|
832
|
+
* The caller's ledger rows.
|
|
833
|
+
*/
|
|
834
|
+
export type ImportEntitiesResponse = {
|
|
835
|
+
/**
|
|
836
|
+
* The caller's own rows and their team's imported rows, newest first.
|
|
837
|
+
*/
|
|
838
|
+
entities: Array<ImportEntity>;
|
|
839
|
+
};
|
|
840
|
+
/**
|
|
841
|
+
* One row of the import ledger.
|
|
842
|
+
*/
|
|
843
|
+
export type ImportEntity = {
|
|
844
|
+
/**
|
|
845
|
+
* When the row was first staged.
|
|
846
|
+
*/
|
|
847
|
+
created_at: string;
|
|
848
|
+
/**
|
|
849
|
+
* The Rox entity it became, once imported.
|
|
850
|
+
*/
|
|
851
|
+
entity_id?: string | null;
|
|
852
|
+
/**
|
|
853
|
+
* The Rox entity type (`task` | `md` | `channel`), once imported.
|
|
854
|
+
*/
|
|
855
|
+
entity_type?: string | null;
|
|
856
|
+
/**
|
|
857
|
+
* Stable id in the source system (see
|
|
858
|
+
* [`ImportSource::normalize_foreign_id`]).
|
|
859
|
+
*/
|
|
860
|
+
foreign_id: string;
|
|
861
|
+
/**
|
|
862
|
+
* Ledger row id.
|
|
863
|
+
*/
|
|
864
|
+
id: string;
|
|
865
|
+
/**
|
|
866
|
+
* Where it was first staged from.
|
|
867
|
+
*/
|
|
868
|
+
initiator: Initiator;
|
|
869
|
+
/**
|
|
870
|
+
* What the item is in its source system.
|
|
871
|
+
*/
|
|
872
|
+
kind: ImportKind;
|
|
873
|
+
/**
|
|
874
|
+
* Failure detail from the last import attempt, when one failed.
|
|
875
|
+
*/
|
|
876
|
+
last_error?: string | null;
|
|
877
|
+
/**
|
|
878
|
+
* Per-source metadata (shape depends on `source`; see
|
|
879
|
+
* [`LinearIssueMeta`], [`NotionDocMeta`], [`SlackChannelMeta`]).
|
|
880
|
+
*/
|
|
881
|
+
metadata: unknown;
|
|
882
|
+
/**
|
|
883
|
+
* The import row this item was imported under (a subpage's parent page,
|
|
884
|
+
* a row's database), when it was imported as part of a tree.
|
|
885
|
+
*/
|
|
886
|
+
parent_id?: string | null;
|
|
887
|
+
/**
|
|
888
|
+
* The agent session review that approved importing this item, when it
|
|
889
|
+
* came from one.
|
|
890
|
+
*/
|
|
891
|
+
review_id?: string | null;
|
|
892
|
+
/**
|
|
893
|
+
* The external system the item comes from.
|
|
894
|
+
*/
|
|
895
|
+
source: ImportSource;
|
|
896
|
+
/**
|
|
897
|
+
* Where the row is in its lifecycle.
|
|
898
|
+
*/
|
|
899
|
+
status: ImportStatus;
|
|
900
|
+
/**
|
|
901
|
+
* The team the created entity was shared with, when it was.
|
|
902
|
+
*/
|
|
903
|
+
team_id?: string | null;
|
|
904
|
+
/**
|
|
905
|
+
* When the row last changed.
|
|
906
|
+
*/
|
|
907
|
+
updated_at: string;
|
|
908
|
+
/**
|
|
909
|
+
* The user who staged/imported it. Team-imported rows from teammates
|
|
910
|
+
* are visible with their owner's id, so clients can say "created by a
|
|
911
|
+
* teammate".
|
|
912
|
+
*/
|
|
913
|
+
user_id: string;
|
|
914
|
+
/**
|
|
915
|
+
* The teammate's row this one waits on: that teammate is writing the
|
|
916
|
+
* same object for the team, and this row links to their copy once it
|
|
917
|
+
* is imported.
|
|
918
|
+
*/
|
|
919
|
+
waiting_on?: string | null;
|
|
920
|
+
};
|
|
921
|
+
/**
|
|
922
|
+
* What an imported item is in its source system. Each source has its own
|
|
923
|
+
* kinds; a Notion database and a Notion page, or a Linear project and a
|
|
924
|
+
* Linear issue, are tracked and deduplicated separately.
|
|
925
|
+
*/
|
|
926
|
+
export type ImportKind = 'issue' | 'project' | 'document' | 'page' | 'database' | 'data_source' | 'row' | 'jira_issue' | 'jira_project' | 'jira_epic' | 'channel';
|
|
927
|
+
/**
|
|
928
|
+
* Body for importing one Notion page.
|
|
929
|
+
*/
|
|
930
|
+
export type ImportNotionPageRequest = {
|
|
931
|
+
/**
|
|
932
|
+
* The Notion page URL or 32-character page id.
|
|
933
|
+
*/
|
|
934
|
+
page: string;
|
|
935
|
+
};
|
|
936
|
+
/**
|
|
937
|
+
* The outcome of importing a Notion page, with its ledger row.
|
|
938
|
+
*/
|
|
939
|
+
export type ImportNotionPageResponse = {
|
|
940
|
+
/**
|
|
941
|
+
* The row behind the outcome; `entity_id` is the document once imported.
|
|
942
|
+
*/
|
|
943
|
+
entity: ImportEntity;
|
|
944
|
+
/**
|
|
945
|
+
* What happened.
|
|
946
|
+
*/
|
|
947
|
+
outcome: ImportNotionPageResult;
|
|
948
|
+
};
|
|
949
|
+
/**
|
|
950
|
+
* What importing one Notion page did.
|
|
951
|
+
*/
|
|
952
|
+
export type ImportNotionPageResult = 'imported' | 'already_imported' | 'already_imported_by_teammate' | 'previously_declined' | 'import_in_progress';
|
|
953
|
+
/**
|
|
954
|
+
* Discovery-run state for one user × source.
|
|
955
|
+
*/
|
|
956
|
+
export type ImportRun = {
|
|
957
|
+
/**
|
|
958
|
+
* Discovery failure detail, when the run failed.
|
|
959
|
+
*/
|
|
960
|
+
error?: string | null;
|
|
961
|
+
/**
|
|
962
|
+
* The review presenting the run's plan, once one does. A Notion plan is
|
|
963
|
+
* presented while it is still `running`; rows staged after that take it.
|
|
964
|
+
*/
|
|
965
|
+
review_id?: string | null;
|
|
966
|
+
/**
|
|
967
|
+
* The agent session presenting that review.
|
|
968
|
+
*/
|
|
969
|
+
review_session_id?: string | null;
|
|
970
|
+
scanned?: null | ScanCounts;
|
|
971
|
+
/**
|
|
972
|
+
* The source this run discovered from.
|
|
973
|
+
*/
|
|
974
|
+
source: ImportSource;
|
|
975
|
+
/**
|
|
976
|
+
* Where the run is in its lifecycle.
|
|
977
|
+
*/
|
|
978
|
+
status: RunStatus;
|
|
979
|
+
/**
|
|
980
|
+
* When the run state last changed.
|
|
981
|
+
*/
|
|
982
|
+
updated_at: string;
|
|
983
|
+
};
|
|
984
|
+
/**
|
|
985
|
+
* External systems items can be imported from.
|
|
986
|
+
*/
|
|
987
|
+
export type ImportSource = 'linear' | 'jira' | 'notion' | 'slack';
|
|
988
|
+
/**
|
|
989
|
+
* The full import aggregate for a user: discovery runs plus visible ledger
|
|
990
|
+
* rows (their own, and teammates' team-imported rows).
|
|
991
|
+
*/
|
|
992
|
+
export type ImportState = {
|
|
993
|
+
/**
|
|
994
|
+
* Visible import entities, newest first.
|
|
995
|
+
*/
|
|
996
|
+
entities: Array<ImportEntity>;
|
|
997
|
+
/**
|
|
998
|
+
* Discovery runs, one per source that ever ran discovery.
|
|
999
|
+
*/
|
|
1000
|
+
runs: Array<ImportRun>;
|
|
1001
|
+
};
|
|
1002
|
+
/**
|
|
1003
|
+
* Lifecycle of one import entity.
|
|
1004
|
+
*/
|
|
1005
|
+
export type ImportStatus = 'staged' | 'importing' | 'imported' | 'discarded';
|
|
1006
|
+
/**
|
|
1007
|
+
* Where an import entity was first staged from. Provenance only — never a
|
|
1008
|
+
* visibility filter.
|
|
1009
|
+
*/
|
|
1010
|
+
export type Initiator = 'onboarding' | 'chat' | 'archive' | 'manual';
|
|
1011
|
+
export type JwtPayload = {
|
|
1012
|
+
token: string;
|
|
1013
|
+
};
|
|
1014
|
+
/**
|
|
1015
|
+
* Metadata for one staged Linear issue.
|
|
1016
|
+
*/
|
|
1017
|
+
export type LinearIssueMeta = {
|
|
1018
|
+
/**
|
|
1019
|
+
* Assignee display name as Linear reports it.
|
|
1020
|
+
*/
|
|
1021
|
+
assignee?: string | null;
|
|
1022
|
+
/**
|
|
1023
|
+
* Assignee email, when Linear exposes it.
|
|
1024
|
+
*/
|
|
1025
|
+
assignee_email?: string | null;
|
|
1026
|
+
/**
|
|
1027
|
+
* Short markdown description.
|
|
1028
|
+
*/
|
|
1029
|
+
description?: string | null;
|
|
1030
|
+
/**
|
|
1031
|
+
* Due date as an ISO date (`YYYY-MM-DD`), when set.
|
|
1032
|
+
*/
|
|
1033
|
+
due_date?: string | null;
|
|
1034
|
+
/**
|
|
1035
|
+
* Linear's human identifier (e.g. `ENG-142`).
|
|
1036
|
+
*/
|
|
1037
|
+
identifier?: string | null;
|
|
1038
|
+
/**
|
|
1039
|
+
* Priority label (e.g. `Urgent`).
|
|
1040
|
+
*/
|
|
1041
|
+
priority?: string | null;
|
|
1042
|
+
/**
|
|
1043
|
+
* Workflow status name (e.g. `In Progress`).
|
|
1044
|
+
*/
|
|
1045
|
+
status?: string | null;
|
|
1046
|
+
/**
|
|
1047
|
+
* Issue title.
|
|
1048
|
+
*/
|
|
1049
|
+
title: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* Deep link back to the issue in Linear.
|
|
1052
|
+
*/
|
|
1053
|
+
url?: string | null;
|
|
1054
|
+
};
|
|
1055
|
+
/**
|
|
1056
|
+
* Defines who can access an item through its share link.
|
|
1057
|
+
*/
|
|
1058
|
+
export type LinkShare = 'PUBLIC' | 'TEAM';
|
|
1059
|
+
export type RoxUserIdStr = string;
|
|
1060
|
+
/**
|
|
1061
|
+
* An edit to one one-based line. A revision is required to prevent replay
|
|
1062
|
+
* or concurrent edits from inserting twice or deleting a different line.
|
|
1063
|
+
*/
|
|
1064
|
+
export type MemoryEdit = {
|
|
1065
|
+
action: 'insert';
|
|
1066
|
+
content: string;
|
|
1067
|
+
line: number;
|
|
1068
|
+
} | {
|
|
1069
|
+
action: 'replace';
|
|
1070
|
+
content: string;
|
|
1071
|
+
line: number;
|
|
1072
|
+
} | {
|
|
1073
|
+
action: 'delete';
|
|
1074
|
+
line: number;
|
|
1075
|
+
};
|
|
1076
|
+
export type MemoryErrorBody = {
|
|
1077
|
+
/**
|
|
1078
|
+
* Error description.
|
|
1079
|
+
*/
|
|
1080
|
+
error: string;
|
|
1081
|
+
};
|
|
1082
|
+
/**
|
|
1083
|
+
* The user's latest memory.
|
|
1084
|
+
*/
|
|
1085
|
+
export type MemoryResponse = {
|
|
1086
|
+
/**
|
|
1087
|
+
* The generated memory text.
|
|
1088
|
+
*/
|
|
1089
|
+
memory: string;
|
|
1090
|
+
};
|
|
1091
|
+
export type MessageWithAttachments = {
|
|
1092
|
+
attachmentIds: Array<string>;
|
|
1093
|
+
content: string;
|
|
1094
|
+
date: string;
|
|
1095
|
+
};
|
|
1096
|
+
/**
|
|
1097
|
+
* The requested inference speed. Standard is backward compatible with old clients.
|
|
1098
|
+
*/
|
|
1099
|
+
export type ModelSpeed = 'standard' | 'priority' | 'fast' | 'ultrafast';
|
|
1100
|
+
export type NewAttachment = {
|
|
1101
|
+
attachment_id: string;
|
|
1102
|
+
attachment_type: AttachmentType;
|
|
1103
|
+
};
|
|
1104
|
+
export type NewChatMessage = {
|
|
1105
|
+
/**
|
|
1106
|
+
* The ids of the attachments used to generate the message
|
|
1107
|
+
*/
|
|
1108
|
+
attachments?: Array<NewAttachment> | null;
|
|
1109
|
+
/**
|
|
1110
|
+
* Content of the message
|
|
1111
|
+
*/
|
|
1112
|
+
content: ChatMessageContent;
|
|
1113
|
+
createdAt: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* Optional pre-generated ID. If None, the database generates one.
|
|
1116
|
+
*/
|
|
1117
|
+
id?: string | null;
|
|
1118
|
+
/**
|
|
1119
|
+
* The model used to generate the chat (provider api id)
|
|
1120
|
+
*/
|
|
1121
|
+
model: string;
|
|
1122
|
+
/**
|
|
1123
|
+
* Whether the chat is from the user or system
|
|
1124
|
+
*/
|
|
1125
|
+
role: Role;
|
|
1126
|
+
updatedAt: string;
|
|
1127
|
+
};
|
|
1128
|
+
export type NewMessageAttachment = {
|
|
1129
|
+
attachmentId: string;
|
|
1130
|
+
attachmentType: AttachmentType;
|
|
1131
|
+
messageId: string;
|
|
1132
|
+
};
|
|
1133
|
+
/**
|
|
1134
|
+
* A teammate's copy of a Notion object, shared with the user's team.
|
|
1135
|
+
*/
|
|
1136
|
+
export type NotionAlreadyImported = {
|
|
1137
|
+
/**
|
|
1138
|
+
* The teammate who imported it, by email.
|
|
1139
|
+
*/
|
|
1140
|
+
by: string;
|
|
1141
|
+
/**
|
|
1142
|
+
* The Rox entity it became.
|
|
1143
|
+
*/
|
|
1144
|
+
entityId: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* That entity's type (`md`, `project`).
|
|
1147
|
+
*/
|
|
1148
|
+
entityType: string;
|
|
1149
|
+
};
|
|
1150
|
+
/**
|
|
1151
|
+
* What a workspace import does with one Notion object.
|
|
1152
|
+
*/
|
|
1153
|
+
export type NotionDecision = 'copy' | 'tasks' | 'skip' | 'hand';
|
|
1154
|
+
/**
|
|
1155
|
+
* Metadata for one staged Notion page. Deliberately has NO content field:
|
|
1156
|
+
* page bodies are fetched at import time, for accepted pages only.
|
|
1157
|
+
*/
|
|
1158
|
+
export type NotionDocMeta = {
|
|
1159
|
+
plan?: null | NotionPlanItem;
|
|
1160
|
+
/**
|
|
1161
|
+
* One-line summary of what the page contains.
|
|
1162
|
+
*/
|
|
1163
|
+
summary?: string | null;
|
|
1164
|
+
/**
|
|
1165
|
+
* Page title.
|
|
1166
|
+
*/
|
|
1167
|
+
title: string;
|
|
1168
|
+
/**
|
|
1169
|
+
* Deep link back to the page in Notion.
|
|
1170
|
+
*/
|
|
1171
|
+
url?: string | null;
|
|
1172
|
+
};
|
|
1173
|
+
/**
|
|
1174
|
+
* Where a Notion workspace import stands.
|
|
1175
|
+
*/
|
|
1176
|
+
export type NotionImportReport = {
|
|
1177
|
+
/**
|
|
1178
|
+
* Who imported the objects already in Rox, most first.
|
|
1179
|
+
*/
|
|
1180
|
+
alreadyImportedBy?: Array<NotionImporter>;
|
|
1181
|
+
/**
|
|
1182
|
+
* Plan objects a teammate already imported and shared with the team;
|
|
1183
|
+
* they link to that copy and are not counted as copies.
|
|
1184
|
+
*/
|
|
1185
|
+
alreadyInMacro?: number;
|
|
1186
|
+
/**
|
|
1187
|
+
* Objects to copy as they are.
|
|
1188
|
+
*/
|
|
1189
|
+
copy: number;
|
|
1190
|
+
/**
|
|
1191
|
+
* Data sources (database tables) in the plan.
|
|
1192
|
+
*/
|
|
1193
|
+
dataSources: number;
|
|
1194
|
+
/**
|
|
1195
|
+
* Rows those databases hold, every one counted while planning.
|
|
1196
|
+
*/
|
|
1197
|
+
databaseRows: number;
|
|
1198
|
+
/**
|
|
1199
|
+
* Data sources written as databases.
|
|
1200
|
+
*/
|
|
1201
|
+
databases: number;
|
|
1202
|
+
/**
|
|
1203
|
+
* Plan objects the decision model has not answered for yet, while
|
|
1204
|
+
* planning is still `running`.
|
|
1205
|
+
*/
|
|
1206
|
+
deciding?: number;
|
|
1207
|
+
/**
|
|
1208
|
+
* Pages written as documents.
|
|
1209
|
+
*/
|
|
1210
|
+
documents: number;
|
|
1211
|
+
/**
|
|
1212
|
+
* Why the run failed, when it did.
|
|
1213
|
+
*/
|
|
1214
|
+
error?: string | null;
|
|
1215
|
+
/**
|
|
1216
|
+
* Objects that failed to import, with the failure.
|
|
1217
|
+
*/
|
|
1218
|
+
failures?: Array<NotionReportItem>;
|
|
1219
|
+
/**
|
|
1220
|
+
* Objects that need handling by hand.
|
|
1221
|
+
*/
|
|
1222
|
+
hand: number;
|
|
1223
|
+
/**
|
|
1224
|
+
* Objects that need handling by hand, with reasons.
|
|
1225
|
+
*/
|
|
1226
|
+
handItems?: Array<NotionReportItem>;
|
|
1227
|
+
/**
|
|
1228
|
+
* Plan objects already imported.
|
|
1229
|
+
*/
|
|
1230
|
+
imported: number;
|
|
1231
|
+
/**
|
|
1232
|
+
* Tracker issues in the plan.
|
|
1233
|
+
*/
|
|
1234
|
+
issues?: number;
|
|
1235
|
+
/**
|
|
1236
|
+
* Whether the user is on a team. Without one, everything the import
|
|
1237
|
+
* writes stays visible only to them.
|
|
1238
|
+
*/
|
|
1239
|
+
onTeam?: boolean;
|
|
1240
|
+
/**
|
|
1241
|
+
* Pages in the plan.
|
|
1242
|
+
*/
|
|
1243
|
+
pages: number;
|
|
1244
|
+
/**
|
|
1245
|
+
* Tracker groups written as Rox projects.
|
|
1246
|
+
*/
|
|
1247
|
+
projects?: number;
|
|
1248
|
+
/**
|
|
1249
|
+
* The review the plan is tied to, once presented.
|
|
1250
|
+
*/
|
|
1251
|
+
reviewId?: string | null;
|
|
1252
|
+
scanned?: null | ScanCounts;
|
|
1253
|
+
/**
|
|
1254
|
+
* Written plan objects shared with the user's team.
|
|
1255
|
+
*/
|
|
1256
|
+
sharedWithTeam?: number;
|
|
1257
|
+
/**
|
|
1258
|
+
* Objects left in Notion.
|
|
1259
|
+
*/
|
|
1260
|
+
skip: number;
|
|
1261
|
+
status?: null | RunStatus;
|
|
1262
|
+
/**
|
|
1263
|
+
* Tasks the task lists become, one per row.
|
|
1264
|
+
*/
|
|
1265
|
+
taskRows: number;
|
|
1266
|
+
/**
|
|
1267
|
+
* Data sources whose rows become tasks.
|
|
1268
|
+
*/
|
|
1269
|
+
tasks: number;
|
|
1270
|
+
/**
|
|
1271
|
+
* Plan objects still waiting to be written.
|
|
1272
|
+
*/
|
|
1273
|
+
waiting: number;
|
|
1274
|
+
/**
|
|
1275
|
+
* Plan objects waiting for a teammate who is writing the same object
|
|
1276
|
+
* for the team; they link to the teammate's copy once it is written.
|
|
1277
|
+
*/
|
|
1278
|
+
waitingOnTeammates?: number;
|
|
1279
|
+
/**
|
|
1280
|
+
* Provider items skipped because they were unreadable, or optional features unavailable.
|
|
1281
|
+
*/
|
|
1282
|
+
warnings?: Array<string>;
|
|
1283
|
+
/**
|
|
1284
|
+
* Plan objects being written now.
|
|
1285
|
+
*/
|
|
1286
|
+
writing: number;
|
|
1287
|
+
};
|
|
1288
|
+
/**
|
|
1289
|
+
* A teammate who already imported some of a plan's objects.
|
|
1290
|
+
*/
|
|
1291
|
+
export type NotionImporter = {
|
|
1292
|
+
/**
|
|
1293
|
+
* The teammate, by email.
|
|
1294
|
+
*/
|
|
1295
|
+
by: string;
|
|
1296
|
+
/**
|
|
1297
|
+
* How many of the plan's objects they imported.
|
|
1298
|
+
*/
|
|
1299
|
+
count: number;
|
|
1300
|
+
};
|
|
1301
|
+
/**
|
|
1302
|
+
* One object's place in a workspace import plan.
|
|
1303
|
+
*/
|
|
1304
|
+
export type NotionPlanItem = {
|
|
1305
|
+
alreadyImported?: null | NotionAlreadyImported;
|
|
1306
|
+
decision?: null | NotionDecision;
|
|
1307
|
+
/**
|
|
1308
|
+
* Titles of the pages above it, outermost first.
|
|
1309
|
+
*/
|
|
1310
|
+
path?: Array<string>;
|
|
1311
|
+
/**
|
|
1312
|
+
* Why, in a short sentence, when the decision model gave one.
|
|
1313
|
+
*/
|
|
1314
|
+
reason?: string | null;
|
|
1315
|
+
/**
|
|
1316
|
+
* For a data source: rows counted while planning.
|
|
1317
|
+
*/
|
|
1318
|
+
rows?: number | null;
|
|
1319
|
+
/**
|
|
1320
|
+
* For a data source: the titles of a few of its rows.
|
|
1321
|
+
*/
|
|
1322
|
+
sampleTitles?: Array<string>;
|
|
1323
|
+
/**
|
|
1324
|
+
* Whether the user may change `shared`: false for users without a team.
|
|
1325
|
+
*/
|
|
1326
|
+
shareable?: boolean;
|
|
1327
|
+
/**
|
|
1328
|
+
* Whether what it becomes is shared with the user's team.
|
|
1329
|
+
*/
|
|
1330
|
+
shared?: boolean;
|
|
1331
|
+
/**
|
|
1332
|
+
* Why it is (or is not) shared, when the decision model chose or the
|
|
1333
|
+
* import could not share it.
|
|
1334
|
+
*/
|
|
1335
|
+
sharedReason?: string | null;
|
|
1336
|
+
taskFields?: null | NotionTaskFields;
|
|
1337
|
+
};
|
|
1338
|
+
/**
|
|
1339
|
+
* One object a workspace import report calls out.
|
|
1340
|
+
*/
|
|
1341
|
+
export type NotionReportItem = {
|
|
1342
|
+
/**
|
|
1343
|
+
* The ledger row.
|
|
1344
|
+
*/
|
|
1345
|
+
importId: string;
|
|
1346
|
+
/**
|
|
1347
|
+
* What the object is.
|
|
1348
|
+
*/
|
|
1349
|
+
kind: ImportKind;
|
|
1350
|
+
/**
|
|
1351
|
+
* Why it is called out: the decision model's reason, or the failure.
|
|
1352
|
+
*/
|
|
1353
|
+
reason?: string | null;
|
|
1354
|
+
/**
|
|
1355
|
+
* The object's title.
|
|
1356
|
+
*/
|
|
1357
|
+
title: string;
|
|
1358
|
+
/**
|
|
1359
|
+
* Its Notion URL.
|
|
1360
|
+
*/
|
|
1361
|
+
url?: string | null;
|
|
1362
|
+
};
|
|
1363
|
+
/**
|
|
1364
|
+
* Which Notion columns hold a task list's task fields, by property name.
|
|
1365
|
+
*/
|
|
1366
|
+
export type NotionTaskFields = {
|
|
1367
|
+
/**
|
|
1368
|
+
* The assignee column.
|
|
1369
|
+
*/
|
|
1370
|
+
assignee?: string | null;
|
|
1371
|
+
/**
|
|
1372
|
+
* The due date column.
|
|
1373
|
+
*/
|
|
1374
|
+
due?: string | null;
|
|
1375
|
+
/**
|
|
1376
|
+
* The priority column.
|
|
1377
|
+
*/
|
|
1378
|
+
priority?: string | null;
|
|
1379
|
+
/**
|
|
1380
|
+
* The status column.
|
|
1381
|
+
*/
|
|
1382
|
+
status?: string | null;
|
|
1383
|
+
};
|
|
1384
|
+
/**
|
|
1385
|
+
* One user's onboarding row.
|
|
1386
|
+
*/
|
|
1387
|
+
export type OnboardingRow = {
|
|
1388
|
+
/**
|
|
1389
|
+
* When the flow completed, if it has.
|
|
1390
|
+
*/
|
|
1391
|
+
completed_at?: string | null;
|
|
1392
|
+
/**
|
|
1393
|
+
* Whether the user skipped rather than finished.
|
|
1394
|
+
*/
|
|
1395
|
+
skipped: boolean;
|
|
1396
|
+
/**
|
|
1397
|
+
* When the flow was first touched.
|
|
1398
|
+
*/
|
|
1399
|
+
started_at: string;
|
|
1400
|
+
/**
|
|
1401
|
+
* Where the flow is in its lifecycle.
|
|
1402
|
+
*/
|
|
1403
|
+
status: OnboardingStatus;
|
|
1404
|
+
};
|
|
1405
|
+
/**
|
|
1406
|
+
* The onboarding aggregate served to the setup page. Import runs and
|
|
1407
|
+
* staged entities are served separately by `GET /import/state`.
|
|
1408
|
+
*/
|
|
1409
|
+
export type OnboardingState = {
|
|
1410
|
+
/**
|
|
1411
|
+
* The user's MCP server connections.
|
|
1412
|
+
*/
|
|
1413
|
+
connected_servers: Array<ConnectedServer>;
|
|
1414
|
+
/**
|
|
1415
|
+
* The user's onboarding row.
|
|
1416
|
+
*/
|
|
1417
|
+
row: OnboardingRow;
|
|
1418
|
+
/**
|
|
1419
|
+
* The account email's domain when it can back a domain team — i.e. it
|
|
1420
|
+
* is not a generic consumer provider — `None` otherwise. Judged with
|
|
1421
|
+
* the same list the teams service uses for domain auto-join and
|
|
1422
|
+
* claiming, so the client never suggests a domain team the server
|
|
1423
|
+
* would refuse.
|
|
1424
|
+
*/
|
|
1425
|
+
suggested_team_domain?: string | null;
|
|
1426
|
+
};
|
|
1427
|
+
/**
|
|
1428
|
+
* Lifecycle of the onboarding flow itself.
|
|
1429
|
+
*/
|
|
1430
|
+
export type OnboardingStatus = 'active' | 'completed';
|
|
1431
|
+
/**
|
|
1432
|
+
* Request body for patching a chat.
|
|
1433
|
+
*/
|
|
1434
|
+
export type PatchChatRequest = {
|
|
1435
|
+
/**
|
|
1436
|
+
* New name for the chat.
|
|
1437
|
+
*/
|
|
1438
|
+
name?: string | null;
|
|
1439
|
+
/**
|
|
1440
|
+
* New project ID for the chat. Empty string clears the project.
|
|
1441
|
+
*/
|
|
1442
|
+
projectId?: string | null;
|
|
1443
|
+
sharePermission?: null | UpdateSharePermissionRequestV2;
|
|
1444
|
+
};
|
|
1445
|
+
/**
|
|
1446
|
+
* One connectable app in the catalog.
|
|
1447
|
+
*/
|
|
1448
|
+
export type PipedreamCatalogEntryResponse = {
|
|
1449
|
+
/**
|
|
1450
|
+
* Pipedream app name slug — pass this to the connect flow.
|
|
1451
|
+
*/
|
|
1452
|
+
app_slug: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* Categories assigned by Pipedream.
|
|
1455
|
+
*/
|
|
1456
|
+
categories?: Array<string>;
|
|
1457
|
+
/**
|
|
1458
|
+
* One-line description of the app.
|
|
1459
|
+
*/
|
|
1460
|
+
description?: string | null;
|
|
1461
|
+
/**
|
|
1462
|
+
* Human-readable name to display.
|
|
1463
|
+
*/
|
|
1464
|
+
display_name: string;
|
|
1465
|
+
/**
|
|
1466
|
+
* URL of the app's icon, when available.
|
|
1467
|
+
*/
|
|
1468
|
+
icon_url?: string | null;
|
|
1469
|
+
};
|
|
1470
|
+
/**
|
|
1471
|
+
* A page of the connector catalog.
|
|
1472
|
+
*/
|
|
1473
|
+
export type PipedreamCatalogResponse = {
|
|
1474
|
+
/**
|
|
1475
|
+
* Cursor for the next page. Absent on the last page.
|
|
1476
|
+
*/
|
|
1477
|
+
next_cursor?: string | null;
|
|
1478
|
+
/**
|
|
1479
|
+
* Catalog entries in display order (most popular first).
|
|
1480
|
+
*/
|
|
1481
|
+
servers: Array<PipedreamCatalogEntryResponse>;
|
|
1482
|
+
};
|
|
1483
|
+
/**
|
|
1484
|
+
* Request body for completing a Pipedream connect flow.
|
|
1485
|
+
*/
|
|
1486
|
+
export type PipedreamCompleteRequest = {
|
|
1487
|
+
/**
|
|
1488
|
+
* The connected-account ID reported by the Connect UI on success.
|
|
1489
|
+
*/
|
|
1490
|
+
account_id: string;
|
|
1491
|
+
/**
|
|
1492
|
+
* Optional display name for the connector. Defaults to the app's name
|
|
1493
|
+
* for new connections; existing connections keep their name.
|
|
1494
|
+
*/
|
|
1495
|
+
server_name?: string | null;
|
|
1496
|
+
};
|
|
1497
|
+
/**
|
|
1498
|
+
* Request body for recording a finished Rox Connect flow.
|
|
1499
|
+
*/
|
|
1500
|
+
export type PipedreamConnectCompleteRequest = {
|
|
1501
|
+
/**
|
|
1502
|
+
* The app that was connected, by Pipedream slug.
|
|
1503
|
+
*/
|
|
1504
|
+
app_slug: string;
|
|
1505
|
+
/**
|
|
1506
|
+
* Optional display name for the connector, as for completion.
|
|
1507
|
+
*/
|
|
1508
|
+
server_name?: string | null;
|
|
1509
|
+
};
|
|
1510
|
+
/**
|
|
1511
|
+
* A connected MCP app as returned by the API.
|
|
1512
|
+
*/
|
|
1513
|
+
export type PipedreamConnectionResponse = {
|
|
1514
|
+
/**
|
|
1515
|
+
* Pipedream app name slug, e.g. `linear`.
|
|
1516
|
+
*/
|
|
1517
|
+
app_slug: string;
|
|
1518
|
+
/**
|
|
1519
|
+
* Whether the connector is enabled for tool use.
|
|
1520
|
+
*/
|
|
1521
|
+
enabled: boolean;
|
|
1522
|
+
/**
|
|
1523
|
+
* The backend holding the grant.
|
|
1524
|
+
*/
|
|
1525
|
+
provider: PipedreamProviderResponse;
|
|
1526
|
+
/**
|
|
1527
|
+
* Human-readable display name.
|
|
1528
|
+
*/
|
|
1529
|
+
server_name: string;
|
|
1530
|
+
};
|
|
1531
|
+
/**
|
|
1532
|
+
* A catalog app that connects through its own MCP server instead of
|
|
1533
|
+
* Pipedream.
|
|
1534
|
+
*/
|
|
1535
|
+
export type PipedreamOverlayResponse = {
|
|
1536
|
+
/**
|
|
1537
|
+
* Pipedream app name slug, as it appears in the catalog.
|
|
1538
|
+
*/
|
|
1539
|
+
app_slug: string;
|
|
1540
|
+
/**
|
|
1541
|
+
* The MCP server to authorize with the native MCP OAuth flow.
|
|
1542
|
+
*/
|
|
1543
|
+
server_url: string;
|
|
1544
|
+
};
|
|
1545
|
+
/**
|
|
1546
|
+
* Which backend a connection or connect flow uses.
|
|
1547
|
+
*/
|
|
1548
|
+
export type PipedreamProviderResponse = 'pipedream' | 'connect';
|
|
1549
|
+
/**
|
|
1550
|
+
* Request body for recovering a connect flow whose result the Connect UI
|
|
1551
|
+
* never reported.
|
|
1552
|
+
*/
|
|
1553
|
+
export type PipedreamRecoverRequest = {
|
|
1554
|
+
/**
|
|
1555
|
+
* The Pipedream app the flow was connecting, by name slug.
|
|
1556
|
+
*/
|
|
1557
|
+
app_slug: string;
|
|
1558
|
+
/**
|
|
1559
|
+
* Optional display name for the connector, as for completion.
|
|
1560
|
+
*/
|
|
1561
|
+
server_name?: string | null;
|
|
1562
|
+
};
|
|
1563
|
+
/**
|
|
1564
|
+
* Request body for starting a connect flow.
|
|
1565
|
+
*/
|
|
1566
|
+
export type PipedreamTokenRequest = {
|
|
1567
|
+
/**
|
|
1568
|
+
* The app to connect, by Pipedream slug. With it, an app Rox Connect
|
|
1569
|
+
* serves can answer with a Connect URL instead of a Pipedream token.
|
|
1570
|
+
*/
|
|
1571
|
+
app_slug?: string | null;
|
|
1572
|
+
};
|
|
1573
|
+
/**
|
|
1574
|
+
* Response from starting a connect flow: a Pipedream Connect token, or for
|
|
1575
|
+
* `provider = connect` a Rox Connect URL.
|
|
1576
|
+
*/
|
|
1577
|
+
export type PipedreamTokenResponse = {
|
|
1578
|
+
/**
|
|
1579
|
+
* Shareable link that opens the same connect flow in a browser tab.
|
|
1580
|
+
* Pipedream only.
|
|
1581
|
+
*/
|
|
1582
|
+
connect_link_url?: string | null;
|
|
1583
|
+
/**
|
|
1584
|
+
* URL to open in a popup or browser tab for Rox Connect's consent
|
|
1585
|
+
* flow; once it finishes, call `/pipedream/mcp/connect/complete`.
|
|
1586
|
+
* Connect only.
|
|
1587
|
+
*/
|
|
1588
|
+
connect_url?: string | null;
|
|
1589
|
+
/**
|
|
1590
|
+
* RFC 3339 expiry of the token. Pipedream only.
|
|
1591
|
+
*/
|
|
1592
|
+
expires_at?: string | null;
|
|
1593
|
+
/**
|
|
1594
|
+
* The backend this flow connects through.
|
|
1595
|
+
*/
|
|
1596
|
+
provider: PipedreamProviderResponse;
|
|
1597
|
+
/**
|
|
1598
|
+
* Short-lived token to open the Pipedream Connect UI with. Pipedream only.
|
|
1599
|
+
*/
|
|
1600
|
+
token?: string | null;
|
|
1601
|
+
};
|
|
1602
|
+
/**
|
|
1603
|
+
* Request body for updating a connected app.
|
|
1604
|
+
*/
|
|
1605
|
+
export type PipedreamUpdateRequest = {
|
|
1606
|
+
/**
|
|
1607
|
+
* The app slug to update.
|
|
1608
|
+
*/
|
|
1609
|
+
app_slug: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* Enable or disable the connector.
|
|
1612
|
+
*/
|
|
1613
|
+
enabled?: boolean | null;
|
|
1614
|
+
/**
|
|
1615
|
+
* New display name for the connector.
|
|
1616
|
+
*/
|
|
1617
|
+
server_name?: string | null;
|
|
1618
|
+
};
|
|
1619
|
+
/**
|
|
1620
|
+
* Rates applied to an invocation and its resolved dollar cost.
|
|
1621
|
+
*/
|
|
1622
|
+
export type Price = {
|
|
1623
|
+
/**
|
|
1624
|
+
* Price per audio minute (USD), absent for token and credit billing.
|
|
1625
|
+
*/
|
|
1626
|
+
price_per_audio_minute?: number | null;
|
|
1627
|
+
/**
|
|
1628
|
+
* Price per million cache-read input tokens (USD), absent when the model
|
|
1629
|
+
* has no published rate and for audio and credit billing.
|
|
1630
|
+
*/
|
|
1631
|
+
price_per_million_cache_read?: number | null;
|
|
1632
|
+
/**
|
|
1633
|
+
* Price per million cache-write input tokens (USD), absent when the model
|
|
1634
|
+
* has no published rate and for audio and credit billing.
|
|
1635
|
+
*/
|
|
1636
|
+
price_per_million_cache_write?: number | null;
|
|
1637
|
+
/**
|
|
1638
|
+
* Price per million input tokens (USD); zero for audio and credit billing.
|
|
1639
|
+
*/
|
|
1640
|
+
price_per_million_in: number;
|
|
1641
|
+
/**
|
|
1642
|
+
* Price per million output tokens (USD); zero for audio and credit billing.
|
|
1643
|
+
*/
|
|
1644
|
+
price_per_million_out: number;
|
|
1645
|
+
/**
|
|
1646
|
+
* Price per vendor credit (USD), absent for token and audio billing.
|
|
1647
|
+
*/
|
|
1648
|
+
price_per_provider_credit?: number | null;
|
|
1649
|
+
/**
|
|
1650
|
+
* Total cost (USD).
|
|
1651
|
+
*/
|
|
1652
|
+
total: number;
|
|
1653
|
+
};
|
|
1654
|
+
/**
|
|
1655
|
+
* Response from [`ReadActivity`].
|
|
1656
|
+
*/
|
|
1657
|
+
export type ReadActivityResponse = {
|
|
1658
|
+
/**
|
|
1659
|
+
* Matching activity events, newest first.
|
|
1660
|
+
*/
|
|
1661
|
+
activities: Array<ToolActivityEvent>;
|
|
1662
|
+
/**
|
|
1663
|
+
* Whether more than 100 events matched the requested range.
|
|
1664
|
+
*/
|
|
1665
|
+
truncated: boolean;
|
|
1666
|
+
};
|
|
1667
|
+
/**
|
|
1668
|
+
* Request body for rejecting a pending tool call.
|
|
1669
|
+
*/
|
|
1670
|
+
export type RejectToolCallRequest = {
|
|
1671
|
+
/**
|
|
1672
|
+
* The message ID containing the tool call.
|
|
1673
|
+
*/
|
|
1674
|
+
messageId: string;
|
|
1675
|
+
/**
|
|
1676
|
+
* The tool call ID to reject.
|
|
1677
|
+
*/
|
|
1678
|
+
toolCallId: string;
|
|
1679
|
+
};
|
|
1680
|
+
/**
|
|
1681
|
+
* The role of a message participant.
|
|
1682
|
+
*/
|
|
1683
|
+
export type Role = 'user' | 'assistant' | 'system';
|
|
1684
|
+
/**
|
|
1685
|
+
* Outcome of accepting/declining staged rows via `POST /import/run`.
|
|
1686
|
+
*/
|
|
1687
|
+
export type RunImportOutcome = {
|
|
1688
|
+
/**
|
|
1689
|
+
* How many rows were discarded.
|
|
1690
|
+
*/
|
|
1691
|
+
discarded: number;
|
|
1692
|
+
/**
|
|
1693
|
+
* How many rows flipped to `importing` (jobs are now copying them in).
|
|
1694
|
+
*/
|
|
1695
|
+
importing: number;
|
|
1696
|
+
};
|
|
1697
|
+
/**
|
|
1698
|
+
* Body for accepting/declining staged imports.
|
|
1699
|
+
*/
|
|
1700
|
+
export type RunImportRequest = {
|
|
1701
|
+
/**
|
|
1702
|
+
* Staged rows to discard.
|
|
1703
|
+
*/
|
|
1704
|
+
discard_ids?: Array<string>;
|
|
1705
|
+
/**
|
|
1706
|
+
* Staged rows to import.
|
|
1707
|
+
*/
|
|
1708
|
+
import_ids?: Array<string>;
|
|
1709
|
+
};
|
|
1710
|
+
/**
|
|
1711
|
+
* Lifecycle of a discovery run (one per user × source).
|
|
1712
|
+
*/
|
|
1713
|
+
export type RunStatus = 'running' | 'ready' | 'importing' | 'completed' | 'failed' | 'dismissed';
|
|
1714
|
+
/**
|
|
1715
|
+
* What a planning run has found in the source so far.
|
|
1716
|
+
*/
|
|
1717
|
+
export type ScanCounts = {
|
|
1718
|
+
/**
|
|
1719
|
+
* Data sources (database tables) found.
|
|
1720
|
+
*/
|
|
1721
|
+
dataSources: number;
|
|
1722
|
+
/**
|
|
1723
|
+
* Pages found.
|
|
1724
|
+
*/
|
|
1725
|
+
pages: number;
|
|
1726
|
+
};
|
|
1727
|
+
export type SendChatMessagePayload = JwtPayload & {
|
|
1728
|
+
/**
|
|
1729
|
+
* Additional system instructions appended to the base system prompt
|
|
1730
|
+
*/
|
|
1731
|
+
additional_instructions?: string | null;
|
|
1732
|
+
/**
|
|
1733
|
+
* Use citation prompt
|
|
1734
|
+
*/
|
|
1735
|
+
attachments?: Array<Entity> | null;
|
|
1736
|
+
/**
|
|
1737
|
+
* Id of the chat the message belongs to
|
|
1738
|
+
*/
|
|
1739
|
+
chat_id: string;
|
|
1740
|
+
/**
|
|
1741
|
+
* The content of the message
|
|
1742
|
+
*/
|
|
1743
|
+
content: string;
|
|
1744
|
+
/**
|
|
1745
|
+
* the chat model to respond with (`provider/model` id)
|
|
1746
|
+
*/
|
|
1747
|
+
model: string;
|
|
1748
|
+
/**
|
|
1749
|
+
* Stream ID for tracking the response
|
|
1750
|
+
*/
|
|
1751
|
+
stream_id: string;
|
|
1752
|
+
/**
|
|
1753
|
+
* Which toolset to use. Defaults to `all`
|
|
1754
|
+
*/
|
|
1755
|
+
toolset?: ToolSet;
|
|
1756
|
+
};
|
|
1757
|
+
/**
|
|
1758
|
+
* Response for initiating a chat message stream
|
|
1759
|
+
*/
|
|
1760
|
+
export type SendChatMessageResponse = {
|
|
1761
|
+
/**
|
|
1762
|
+
* The chat ID (may differ from request if a new chat was created)
|
|
1763
|
+
*/
|
|
1764
|
+
chat_id: string;
|
|
1765
|
+
/**
|
|
1766
|
+
* The message ID for the AI response
|
|
1767
|
+
*/
|
|
1768
|
+
message_id: string;
|
|
1769
|
+
/**
|
|
1770
|
+
* The stream ID that will receive the response chunks (same as message_id)
|
|
1771
|
+
*/
|
|
1772
|
+
stream_id: string;
|
|
1773
|
+
};
|
|
1774
|
+
/**
|
|
1775
|
+
* An MCP server record as returned by the API.
|
|
1776
|
+
*/
|
|
1777
|
+
export type ServerResponse = {
|
|
1778
|
+
/**
|
|
1779
|
+
* Whether the server has valid stored credentials.
|
|
1780
|
+
*/
|
|
1781
|
+
authenticated: boolean;
|
|
1782
|
+
/**
|
|
1783
|
+
* Whether the server is enabled for tool use.
|
|
1784
|
+
*/
|
|
1785
|
+
enabled: boolean;
|
|
1786
|
+
/**
|
|
1787
|
+
* Human-readable server name.
|
|
1788
|
+
*/
|
|
1789
|
+
server_name: string;
|
|
1790
|
+
/**
|
|
1791
|
+
* The MCP server URL.
|
|
1792
|
+
*/
|
|
1793
|
+
url: string;
|
|
1794
|
+
};
|
|
1795
|
+
/**
|
|
1796
|
+
* Request body for [`set_pricing_handler`].
|
|
1797
|
+
*/
|
|
1798
|
+
export type SetPricingRequest = {
|
|
1799
|
+
/**
|
|
1800
|
+
* The model api id to (re)price.
|
|
1801
|
+
*/
|
|
1802
|
+
model: string;
|
|
1803
|
+
/**
|
|
1804
|
+
* Price per minute of audio (USD), or null for token-only pricing.
|
|
1805
|
+
*/
|
|
1806
|
+
price_per_audio_minute?: number | null;
|
|
1807
|
+
/**
|
|
1808
|
+
* Price per million cache-read input tokens (USD). Omit it when the model
|
|
1809
|
+
* has no published rate: calls that report cache reads then stay unpriced.
|
|
1810
|
+
*/
|
|
1811
|
+
price_per_mil_cache_read?: number | null;
|
|
1812
|
+
/**
|
|
1813
|
+
* Price per million cache-write input tokens (USD). Omit it when the model
|
|
1814
|
+
* has no published rate: calls that report cache writes then stay unpriced.
|
|
1815
|
+
*/
|
|
1816
|
+
price_per_mil_cache_write?: number | null;
|
|
1817
|
+
/**
|
|
1818
|
+
* New price per million input tokens (USD). Required for token pricing.
|
|
1819
|
+
*/
|
|
1820
|
+
price_per_mil_in?: number | null;
|
|
1821
|
+
/**
|
|
1822
|
+
* New price per million output tokens (USD). Required for token pricing.
|
|
1823
|
+
*/
|
|
1824
|
+
price_per_mil_out?: number | null;
|
|
1825
|
+
/**
|
|
1826
|
+
* Price per vendor credit (USD), or null unless the model bills in credits.
|
|
1827
|
+
*/
|
|
1828
|
+
price_per_provider_credit?: number | null;
|
|
1829
|
+
};
|
|
1830
|
+
export type SharePermissionV2 = {
|
|
1831
|
+
/**
|
|
1832
|
+
* The channel share permissions for the item
|
|
1833
|
+
*/
|
|
1834
|
+
channelSharePermissions?: Array<ChannelSharePermission> | null;
|
|
1835
|
+
/**
|
|
1836
|
+
* The share permission id
|
|
1837
|
+
*/
|
|
1838
|
+
id: string;
|
|
1839
|
+
linkShare?: null | LinkShare;
|
|
1840
|
+
linkShareAccessLevel?: null | AccessLevel;
|
|
1841
|
+
/**
|
|
1842
|
+
* The owner of the item
|
|
1843
|
+
*/
|
|
1844
|
+
owner: string;
|
|
1845
|
+
teamShareAccessLevel?: null | AccessLevel;
|
|
1846
|
+
};
|
|
1847
|
+
/**
|
|
1848
|
+
* A skill's complete instructions.
|
|
1849
|
+
*/
|
|
1850
|
+
export type SkillContentResponse = {
|
|
1851
|
+
/**
|
|
1852
|
+
* Whether this is a built-in skill, with no document behind it.
|
|
1853
|
+
*/
|
|
1854
|
+
builtIn: boolean;
|
|
1855
|
+
/**
|
|
1856
|
+
* The skill's full markdown instructions.
|
|
1857
|
+
*/
|
|
1858
|
+
content: string;
|
|
1859
|
+
/**
|
|
1860
|
+
* The skill's id.
|
|
1861
|
+
*/
|
|
1862
|
+
id: string;
|
|
1863
|
+
/**
|
|
1864
|
+
* The skill's name.
|
|
1865
|
+
*/
|
|
1866
|
+
name: string;
|
|
1867
|
+
};
|
|
1868
|
+
/**
|
|
1869
|
+
* Machine-readable failure of a skill request.
|
|
1870
|
+
*/
|
|
1871
|
+
export type SkillErrorBody = {
|
|
1872
|
+
/**
|
|
1873
|
+
* Stable failure code.
|
|
1874
|
+
*/
|
|
1875
|
+
code: string;
|
|
1876
|
+
/**
|
|
1877
|
+
* Explanation without backend diagnostics.
|
|
1878
|
+
*/
|
|
1879
|
+
error: string;
|
|
1880
|
+
};
|
|
1881
|
+
/**
|
|
1882
|
+
* One skill the caller can read.
|
|
1883
|
+
*/
|
|
1884
|
+
export type SkillListing = {
|
|
1885
|
+
/**
|
|
1886
|
+
* Whether this is a built-in skill, with no document behind it.
|
|
1887
|
+
*/
|
|
1888
|
+
builtIn: boolean;
|
|
1889
|
+
/**
|
|
1890
|
+
* When to use the skill, when it says.
|
|
1891
|
+
*/
|
|
1892
|
+
description?: string | null;
|
|
1893
|
+
/**
|
|
1894
|
+
* The skill document's id, or a built-in skill's well-known id.
|
|
1895
|
+
*/
|
|
1896
|
+
id: string;
|
|
1897
|
+
/**
|
|
1898
|
+
* The skill's name.
|
|
1899
|
+
*/
|
|
1900
|
+
name: string;
|
|
1901
|
+
/**
|
|
1902
|
+
* When the skill document was last updated; built-in skills have none.
|
|
1903
|
+
*/
|
|
1904
|
+
updatedAt?: string | null;
|
|
1905
|
+
};
|
|
1906
|
+
/**
|
|
1907
|
+
* How search terms are matched against skill names.
|
|
1908
|
+
*/
|
|
1909
|
+
export type SkillsMatchType = 'partial' | 'exact';
|
|
1910
|
+
/**
|
|
1911
|
+
* The skills matching a listing or search, most recently updated first,
|
|
1912
|
+
* built-in skills last.
|
|
1913
|
+
*/
|
|
1914
|
+
export type SkillsResponse = {
|
|
1915
|
+
/**
|
|
1916
|
+
* The matching skills.
|
|
1917
|
+
*/
|
|
1918
|
+
skills: Array<SkillListing>;
|
|
1919
|
+
};
|
|
1920
|
+
/**
|
|
1921
|
+
* Metadata for one staged Slack channel.
|
|
1922
|
+
*/
|
|
1923
|
+
export type SlackChannelMeta = {
|
|
1924
|
+
/**
|
|
1925
|
+
* Whether Slack has archived this channel.
|
|
1926
|
+
*/
|
|
1927
|
+
archived?: boolean;
|
|
1928
|
+
/**
|
|
1929
|
+
* Slack's channel id (e.g. `C0123456789`), stable across renames.
|
|
1930
|
+
*/
|
|
1931
|
+
channel_id?: string | null;
|
|
1932
|
+
/**
|
|
1933
|
+
* Total human members in the Slack channel.
|
|
1934
|
+
*/
|
|
1935
|
+
member_count?: number | null;
|
|
1936
|
+
/**
|
|
1937
|
+
* Whether `participants` reflects a live membership read.
|
|
1938
|
+
*/
|
|
1939
|
+
members_resolved?: boolean;
|
|
1940
|
+
/**
|
|
1941
|
+
* Channel name without the leading `#`.
|
|
1942
|
+
*/
|
|
1943
|
+
name: string;
|
|
1944
|
+
/**
|
|
1945
|
+
* Slack members matched to the Rox team roster when discovery resolved membership.
|
|
1946
|
+
*/
|
|
1947
|
+
participants?: Array<SlackParticipant>;
|
|
1948
|
+
/**
|
|
1949
|
+
* The channel's purpose/topic, when set.
|
|
1950
|
+
*/
|
|
1951
|
+
purpose?: string | null;
|
|
1952
|
+
};
|
|
1953
|
+
/**
|
|
1954
|
+
* A person active in a staged Slack channel.
|
|
1955
|
+
*/
|
|
1956
|
+
export type SlackParticipant = {
|
|
1957
|
+
/**
|
|
1958
|
+
* Email, when the workspace exposes it.
|
|
1959
|
+
*/
|
|
1960
|
+
email?: string | null;
|
|
1961
|
+
/**
|
|
1962
|
+
* Display name or Slack handle.
|
|
1963
|
+
*/
|
|
1964
|
+
name: string;
|
|
1965
|
+
};
|
|
1966
|
+
/**
|
|
1967
|
+
* Request body for starting an OAuth authorization flow.
|
|
1968
|
+
*/
|
|
1969
|
+
export type StartAuthRequest = {
|
|
1970
|
+
/**
|
|
1971
|
+
* Human-readable name for the server.
|
|
1972
|
+
*/
|
|
1973
|
+
server_name: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* The MCP server URL to authorize against.
|
|
1976
|
+
*/
|
|
1977
|
+
server_url: string;
|
|
1978
|
+
};
|
|
1979
|
+
/**
|
|
1980
|
+
* Response from starting an OAuth authorization flow.
|
|
1981
|
+
*/
|
|
1982
|
+
export type StartAuthResponse = {
|
|
1983
|
+
/**
|
|
1984
|
+
* The OAuth authorization URL to redirect the user to.
|
|
1985
|
+
*/
|
|
1986
|
+
authorization_url: string;
|
|
1987
|
+
};
|
|
1988
|
+
/**
|
|
1989
|
+
* Error response for the stop endpoint.
|
|
1990
|
+
*/
|
|
1991
|
+
export type StopChatStreamError = {
|
|
1992
|
+
/**
|
|
1993
|
+
* Human-readable error message.
|
|
1994
|
+
*/
|
|
1995
|
+
error: string;
|
|
1996
|
+
};
|
|
1997
|
+
/**
|
|
1998
|
+
* Request body for stopping an in-flight chat stream.
|
|
1999
|
+
*/
|
|
2000
|
+
export type StopChatStreamRequest = {
|
|
2001
|
+
/**
|
|
2002
|
+
* The chat the stream belongs to. Used to verify the caller has
|
|
2003
|
+
* permission to stop the stream.
|
|
2004
|
+
*/
|
|
2005
|
+
chat_id: string;
|
|
2006
|
+
/**
|
|
2007
|
+
* The stream/message ID to stop.
|
|
2008
|
+
*/
|
|
2009
|
+
stream_id: string;
|
|
2010
|
+
};
|
|
2011
|
+
/**
|
|
2012
|
+
* Response from a stop request.
|
|
2013
|
+
*/
|
|
2014
|
+
export type StopChatStreamResponse = {
|
|
2015
|
+
/**
|
|
2016
|
+
* `true` if a matching in-flight stream was found and cancellation was
|
|
2017
|
+
* triggered, `false` if the stream had already finished or was unknown.
|
|
2018
|
+
*/
|
|
2019
|
+
stopped: boolean;
|
|
2020
|
+
};
|
|
2021
|
+
export type StreamError = {
|
|
2022
|
+
model: string;
|
|
2023
|
+
stream_error: 'provider_error';
|
|
2024
|
+
stream_id: string;
|
|
2025
|
+
} | {
|
|
2026
|
+
stream_error: 'model_context_overflow';
|
|
2027
|
+
stream_id: string;
|
|
2028
|
+
} | {
|
|
2029
|
+
stream_error: 'internal_error';
|
|
2030
|
+
stream_id: string;
|
|
2031
|
+
};
|
|
2032
|
+
export type StringIdResponse = {
|
|
2033
|
+
id: string;
|
|
2034
|
+
};
|
|
2035
|
+
export type StructuredCompletionError = {
|
|
2036
|
+
/**
|
|
2037
|
+
* Stable machine-readable code for admission errors (402 or 503).
|
|
2038
|
+
*/
|
|
2039
|
+
code?: string | null;
|
|
2040
|
+
error: string;
|
|
2041
|
+
};
|
|
2042
|
+
export type StructuredCompletionOutcome = {
|
|
2043
|
+
result: unknown;
|
|
2044
|
+
status: 'completed';
|
|
2045
|
+
} | {
|
|
2046
|
+
reason: string;
|
|
2047
|
+
status: 'interrupted';
|
|
2048
|
+
};
|
|
2049
|
+
export type StructuredCompletionRequest = {
|
|
2050
|
+
additional_instructions?: string | null;
|
|
2051
|
+
model: string;
|
|
2052
|
+
output_schema: DynamicSchema;
|
|
2053
|
+
prompt: string;
|
|
2054
|
+
/**
|
|
2055
|
+
* How much the model may think first; `low` answers faster. Applies to
|
|
2056
|
+
* completions without tools.
|
|
2057
|
+
*/
|
|
2058
|
+
thinking?: CompletionThinking;
|
|
2059
|
+
toolset?: ToolSet;
|
|
2060
|
+
};
|
|
2061
|
+
export type StructuredCompletionResponse = {
|
|
2062
|
+
outcome: StructuredCompletionOutcome;
|
|
2063
|
+
/**
|
|
2064
|
+
* Actual completed tools, independent of the model's claims.
|
|
2065
|
+
*/
|
|
2066
|
+
toolActivity: Array<StructuredToolActivity>;
|
|
2067
|
+
};
|
|
2068
|
+
/**
|
|
2069
|
+
* One tool call the agent finished, and what it did.
|
|
2070
|
+
*/
|
|
2071
|
+
export type StructuredToolActivity = {
|
|
2072
|
+
name: string;
|
|
2073
|
+
outcome: ToolOutcome;
|
|
2074
|
+
};
|
|
2075
|
+
/**
|
|
2076
|
+
* One activity action returned to the AI.
|
|
2077
|
+
*/
|
|
2078
|
+
export type ToolActivityAction = {
|
|
2079
|
+
type: 'created';
|
|
2080
|
+
} | {
|
|
2081
|
+
type: 'edited';
|
|
2082
|
+
} | {
|
|
2083
|
+
type: 'opened';
|
|
2084
|
+
} | {
|
|
2085
|
+
type: 'deleted';
|
|
2086
|
+
} | {
|
|
2087
|
+
type: 'messaged';
|
|
2088
|
+
} | {
|
|
2089
|
+
type: 'sent';
|
|
2090
|
+
} | {
|
|
2091
|
+
type: 'responded';
|
|
2092
|
+
} | {
|
|
2093
|
+
/**
|
|
2094
|
+
* The previous value, when known.
|
|
2095
|
+
*/
|
|
2096
|
+
from?: unknown;
|
|
2097
|
+
/**
|
|
2098
|
+
* Previous select/tag option ids resolved to display labels.
|
|
2099
|
+
*/
|
|
2100
|
+
from_labels?: Array<string> | null;
|
|
2101
|
+
/**
|
|
2102
|
+
* The property definition id.
|
|
2103
|
+
*/
|
|
2104
|
+
property: string;
|
|
2105
|
+
/**
|
|
2106
|
+
* The property definition's human-readable display name, when it is
|
|
2107
|
+
* still visible to the caller.
|
|
2108
|
+
*/
|
|
2109
|
+
property_name?: string | null;
|
|
2110
|
+
/**
|
|
2111
|
+
* The property's canonical data type, including `tag` for tag sets.
|
|
2112
|
+
*/
|
|
2113
|
+
property_type?: string | null;
|
|
2114
|
+
/**
|
|
2115
|
+
* The new value, or `None` when cleared.
|
|
2116
|
+
*/
|
|
2117
|
+
to?: unknown;
|
|
2118
|
+
/**
|
|
2119
|
+
* New select/tag option ids resolved to display labels.
|
|
2120
|
+
*/
|
|
2121
|
+
to_labels?: Array<string> | null;
|
|
2122
|
+
type: 'propertyChanged';
|
|
2123
|
+
} | {
|
|
2124
|
+
/**
|
|
2125
|
+
* The added principal.
|
|
2126
|
+
*/
|
|
2127
|
+
participant: string;
|
|
2128
|
+
type: 'participantAdded';
|
|
2129
|
+
} | {
|
|
2130
|
+
/**
|
|
2131
|
+
* The removed principal.
|
|
2132
|
+
*/
|
|
2133
|
+
participant: string;
|
|
2134
|
+
type: 'participantRemoved';
|
|
2135
|
+
} | {
|
|
2136
|
+
/**
|
|
2137
|
+
* The started call's id.
|
|
2138
|
+
*/
|
|
2139
|
+
call_id: string;
|
|
2140
|
+
type: 'callStarted';
|
|
2141
|
+
} | {
|
|
2142
|
+
type: 'taskAdded';
|
|
2143
|
+
} | {
|
|
2144
|
+
type: 'taskRemoved';
|
|
2145
|
+
} | {
|
|
2146
|
+
/**
|
|
2147
|
+
* The stored payload, verbatim.
|
|
2148
|
+
*/
|
|
2149
|
+
payload?: unknown;
|
|
2150
|
+
/**
|
|
2151
|
+
* The stored action tag.
|
|
2152
|
+
*/
|
|
2153
|
+
tag: string;
|
|
2154
|
+
type: 'unknown';
|
|
2155
|
+
};
|
|
2156
|
+
/**
|
|
2157
|
+
* One activity event returned by [`ReadActivity`].
|
|
2158
|
+
*/
|
|
2159
|
+
export type ToolActivityEvent = {
|
|
2160
|
+
/**
|
|
2161
|
+
* What the principal did.
|
|
2162
|
+
*/
|
|
2163
|
+
action: ToolActivityAction;
|
|
2164
|
+
/**
|
|
2165
|
+
* The principal that mechanically performed the action.
|
|
2166
|
+
*/
|
|
2167
|
+
actorId: string;
|
|
2168
|
+
/**
|
|
2169
|
+
* The entity acted on.
|
|
2170
|
+
*/
|
|
2171
|
+
entityId: string;
|
|
2172
|
+
/**
|
|
2173
|
+
* The kind of entity acted on.
|
|
2174
|
+
*/
|
|
2175
|
+
entityType: string;
|
|
2176
|
+
/**
|
|
2177
|
+
* When the action occurred.
|
|
2178
|
+
*/
|
|
2179
|
+
occurredAt: string;
|
|
2180
|
+
};
|
|
2181
|
+
export type ToolOutcome = {
|
|
2182
|
+
changes: DatabaseChange;
|
|
2183
|
+
status: 'succeeded';
|
|
2184
|
+
} | {
|
|
2185
|
+
status: 'failed';
|
|
2186
|
+
};
|
|
2187
|
+
export type ToolSet = {
|
|
2188
|
+
type: 'all';
|
|
2189
|
+
} | {
|
|
2190
|
+
type: 'none';
|
|
2191
|
+
} | {
|
|
2192
|
+
type: 'databases';
|
|
2193
|
+
} | {
|
|
2194
|
+
type: 'databases_read_only';
|
|
2195
|
+
};
|
|
2196
|
+
/**
|
|
2197
|
+
* Body for tracking one external item in the ledger.
|
|
2198
|
+
*/
|
|
2199
|
+
export type TrackImportEntityRequest = {
|
|
2200
|
+
/**
|
|
2201
|
+
* The Rox entity created from the item; required when `status` is
|
|
2202
|
+
* `imported`.
|
|
2203
|
+
*/
|
|
2204
|
+
entityId?: string | null;
|
|
2205
|
+
/**
|
|
2206
|
+
* Stable id of the item in its source: a Linear identifier such as
|
|
2207
|
+
* `ENG-142`, a Notion page URL or id, or a Slack channel id.
|
|
2208
|
+
*/
|
|
2209
|
+
foreignId: string;
|
|
2210
|
+
/**
|
|
2211
|
+
* Per-source metadata. Linear: `{identifier, title, …}`; Notion:
|
|
2212
|
+
* `{title, url?, summary?}`; Slack: `{name, …}`.
|
|
2213
|
+
*/
|
|
2214
|
+
metadata: {
|
|
2215
|
+
[key: string]: unknown;
|
|
2216
|
+
};
|
|
2217
|
+
/**
|
|
2218
|
+
* The external system the item comes from.
|
|
2219
|
+
*/
|
|
2220
|
+
source: ImportSource;
|
|
2221
|
+
/**
|
|
2222
|
+
* `staged` to propose the item, `imported` to record an entity already
|
|
2223
|
+
* created from it.
|
|
2224
|
+
*/
|
|
2225
|
+
status: TrackImportStatus;
|
|
2226
|
+
};
|
|
2227
|
+
/**
|
|
2228
|
+
* The outcome of tracking an item, with its ledger row.
|
|
2229
|
+
*/
|
|
2230
|
+
export type TrackImportEntityResponse = {
|
|
2231
|
+
/**
|
|
2232
|
+
* The row behind the outcome.
|
|
2233
|
+
*/
|
|
2234
|
+
entity: ImportEntity;
|
|
2235
|
+
/**
|
|
2236
|
+
* What happened.
|
|
2237
|
+
*/
|
|
2238
|
+
outcome: TrackImportOutcome;
|
|
2239
|
+
};
|
|
2240
|
+
/**
|
|
2241
|
+
* What tracking an item did.
|
|
2242
|
+
*/
|
|
2243
|
+
export type TrackImportOutcome = 'staged' | 'recorded_imported' | 'already_imported' | 'already_imported_by_teammate' | 'previously_declined' | 'import_in_progress';
|
|
2244
|
+
/**
|
|
2245
|
+
* Whether a tracked item is a candidate or an import already made.
|
|
2246
|
+
*/
|
|
2247
|
+
export type TrackImportStatus = 'staged' | 'imported';
|
|
2248
|
+
export type UpdateChannelSharePermission = {
|
|
2249
|
+
accessLevel?: null | AccessLevel;
|
|
2250
|
+
/**
|
|
2251
|
+
* The channel id
|
|
2252
|
+
*/
|
|
2253
|
+
channelId: string;
|
|
2254
|
+
/**
|
|
2255
|
+
* The type of operation to be performed on the chanel share permission
|
|
2256
|
+
* You can add, remove or replace and existing permission
|
|
2257
|
+
*/
|
|
2258
|
+
operation: UpdateOperation;
|
|
2259
|
+
};
|
|
2260
|
+
/**
|
|
2261
|
+
* One explicit memory edit at the revision it was based on.
|
|
2262
|
+
*/
|
|
2263
|
+
export type UpdateExplicitMemoryRequest = {
|
|
2264
|
+
/**
|
|
2265
|
+
* The one-based line edit to apply.
|
|
2266
|
+
*/
|
|
2267
|
+
edit: MemoryEdit;
|
|
2268
|
+
/**
|
|
2269
|
+
* The revision returned by the last read or successful edit.
|
|
2270
|
+
*/
|
|
2271
|
+
revision: number;
|
|
2272
|
+
};
|
|
2273
|
+
export type UpdateOperation = 'add' | 'remove' | 'replace';
|
|
2274
|
+
/**
|
|
2275
|
+
* Request body for updating an MCP server.
|
|
2276
|
+
*/
|
|
2277
|
+
export type UpdateServerRequest = {
|
|
2278
|
+
/**
|
|
2279
|
+
* Enable or disable the server.
|
|
2280
|
+
*/
|
|
2281
|
+
enabled?: boolean | null;
|
|
2282
|
+
/**
|
|
2283
|
+
* New name for the server.
|
|
2284
|
+
*/
|
|
2285
|
+
server_name?: string | null;
|
|
2286
|
+
/**
|
|
2287
|
+
* The server URL to update.
|
|
2288
|
+
*/
|
|
2289
|
+
url: string;
|
|
2290
|
+
};
|
|
2291
|
+
export type UpdateSharePermissionRequestV2 = {
|
|
2292
|
+
/**
|
|
2293
|
+
* Any channel share permissions to be created/updated/removed
|
|
2294
|
+
*/
|
|
2295
|
+
channelSharePermissions?: Array<UpdateChannelSharePermission> | null;
|
|
2296
|
+
linkShare?: null | LinkShare;
|
|
2297
|
+
linkShareAccessLevel?: null | AccessLevel;
|
|
2298
|
+
teamShareAccessLevel?: null | AccessLevel;
|
|
2299
|
+
};
|
|
2300
|
+
/**
|
|
2301
|
+
* Request body for updating a tool call's arguments.
|
|
2302
|
+
*/
|
|
2303
|
+
export type UpdateToolCallRequest = {
|
|
2304
|
+
/**
|
|
2305
|
+
* The new arguments for the tool call.
|
|
2306
|
+
*/
|
|
2307
|
+
args: unknown;
|
|
2308
|
+
/**
|
|
2309
|
+
* The message ID containing the tool call.
|
|
2310
|
+
*/
|
|
2311
|
+
messageId: string;
|
|
2312
|
+
/**
|
|
2313
|
+
* The tool call ID to update.
|
|
2314
|
+
*/
|
|
2315
|
+
toolCallId: string;
|
|
2316
|
+
};
|
|
2317
|
+
/**
|
|
2318
|
+
* Request body for updating a tool response.
|
|
2319
|
+
*/
|
|
2320
|
+
export type UpdateToolResponseRequest = {
|
|
2321
|
+
/**
|
|
2322
|
+
* The message ID containing the tool response.
|
|
2323
|
+
*/
|
|
2324
|
+
messageId: string;
|
|
2325
|
+
/**
|
|
2326
|
+
* The new user tool response.
|
|
2327
|
+
*/
|
|
2328
|
+
response: UserToolResponseValue;
|
|
2329
|
+
/**
|
|
2330
|
+
* The tool call ID whose response should be updated.
|
|
2331
|
+
*/
|
|
2332
|
+
toolCallId: string;
|
|
2333
|
+
};
|
|
2334
|
+
/**
|
|
2335
|
+
* Measured usage for one invocation.
|
|
2336
|
+
*/
|
|
2337
|
+
export type Usage = {
|
|
2338
|
+
/**
|
|
2339
|
+
* Audio duration in seconds, absent for token and credit billing.
|
|
2340
|
+
*/
|
|
2341
|
+
audio_seconds?: number | null;
|
|
2342
|
+
/**
|
|
2343
|
+
* Input tokens read from a prompt cache; zero for audio and credit billing.
|
|
2344
|
+
*/
|
|
2345
|
+
cache_read_input_tokens: number;
|
|
2346
|
+
/**
|
|
2347
|
+
* Input tokens written to a prompt cache; zero for audio and credit billing.
|
|
2348
|
+
*/
|
|
2349
|
+
cache_write_input_tokens: number;
|
|
2350
|
+
/**
|
|
2351
|
+
* Recording timestamp.
|
|
2352
|
+
*/
|
|
2353
|
+
created_at: string;
|
|
2354
|
+
/**
|
|
2355
|
+
* Uncached input tokens; zero for audio and credit billing.
|
|
2356
|
+
*/
|
|
2357
|
+
input_tokens: number;
|
|
2358
|
+
/**
|
|
2359
|
+
* Provider model identifier.
|
|
2360
|
+
*/
|
|
2361
|
+
model: string;
|
|
2362
|
+
/**
|
|
2363
|
+
* Output tokens; zero for audio and credit billing.
|
|
2364
|
+
*/
|
|
2365
|
+
output_tokens: number;
|
|
2366
|
+
price?: null | Price;
|
|
2367
|
+
/**
|
|
2368
|
+
* Vendor credits consumed, absent for token and audio billing.
|
|
2369
|
+
*/
|
|
2370
|
+
provider_credits?: number | null;
|
|
2371
|
+
};
|
|
2372
|
+
/**
|
|
2373
|
+
* Request body for [`get_usage_handler`].
|
|
2374
|
+
*/
|
|
2375
|
+
export type UsageRequest = {
|
|
2376
|
+
/**
|
|
2377
|
+
* If empty, include all features.
|
|
2378
|
+
*/
|
|
2379
|
+
features?: Array<AiFeature>;
|
|
2380
|
+
/**
|
|
2381
|
+
* Inclusive lower bound on `created_at`.
|
|
2382
|
+
*/
|
|
2383
|
+
from?: string | null;
|
|
2384
|
+
/**
|
|
2385
|
+
* If empty, include all users.
|
|
2386
|
+
*/
|
|
2387
|
+
include_users?: Array<string>;
|
|
2388
|
+
/**
|
|
2389
|
+
* Exclusive upper bound on `created_at`.
|
|
2390
|
+
*/
|
|
2391
|
+
until?: string | null;
|
|
2392
|
+
};
|
|
2393
|
+
/**
|
|
2394
|
+
* Per-feature breakdown and grand total.
|
|
2395
|
+
*/
|
|
2396
|
+
export type UsageSummary = {
|
|
2397
|
+
/**
|
|
2398
|
+
* Per-feature usage.
|
|
2399
|
+
*/
|
|
2400
|
+
entries: Array<FeatureUsage>;
|
|
2401
|
+
/**
|
|
2402
|
+
* Grand total (USD).
|
|
2403
|
+
*/
|
|
2404
|
+
total: number;
|
|
2405
|
+
};
|
|
2406
|
+
/**
|
|
2407
|
+
* UserPdfRect is in UserSpace
|
|
2408
|
+
* (0,0) top left
|
|
2409
|
+
* percent page units
|
|
2410
|
+
* 1-based page index
|
|
2411
|
+
*/
|
|
2412
|
+
export type UserPdfRect = {
|
|
2413
|
+
height: number;
|
|
2414
|
+
left: number;
|
|
2415
|
+
page_index: number;
|
|
2416
|
+
top: number;
|
|
2417
|
+
width: number;
|
|
2418
|
+
};
|
|
2419
|
+
/**
|
|
2420
|
+
* User tools are pending until a user executes them
|
|
2421
|
+
*/
|
|
2422
|
+
export type UserToolResponseValue = 'PendingUserExecution' | 'Rejected' | {
|
|
2423
|
+
UserAction: unknown;
|
|
2424
|
+
};
|
|
2425
|
+
/**
|
|
2426
|
+
* A web citation associated with a chat message.
|
|
2427
|
+
*/
|
|
2428
|
+
export type WebCitation = {
|
|
2429
|
+
/**
|
|
2430
|
+
* A description of the cited page.
|
|
2431
|
+
*/
|
|
2432
|
+
description?: string | null;
|
|
2433
|
+
/**
|
|
2434
|
+
* The URL of the page's favicon.
|
|
2435
|
+
*/
|
|
2436
|
+
favicon_url?: string | null;
|
|
2437
|
+
/**
|
|
2438
|
+
* The URL of the page's image.
|
|
2439
|
+
*/
|
|
2440
|
+
image_url?: string | null;
|
|
2441
|
+
/**
|
|
2442
|
+
* The title of the cited page.
|
|
2443
|
+
*/
|
|
2444
|
+
title: string;
|
|
2445
|
+
/**
|
|
2446
|
+
* The URL of the citation.
|
|
2447
|
+
*/
|
|
2448
|
+
url: string;
|
|
2449
|
+
};
|
|
2450
|
+
/**
|
|
2451
|
+
* Machine-readable failure of a web request.
|
|
2452
|
+
*/
|
|
2453
|
+
export type WebErrorBody = {
|
|
2454
|
+
/**
|
|
2455
|
+
* Stable failure code.
|
|
2456
|
+
*/
|
|
2457
|
+
code: string;
|
|
2458
|
+
/**
|
|
2459
|
+
* Explanation without provider diagnostics.
|
|
2460
|
+
*/
|
|
2461
|
+
error: string;
|
|
2462
|
+
};
|
|
2463
|
+
/**
|
|
2464
|
+
* Read one public web page.
|
|
2465
|
+
*/
|
|
2466
|
+
export type WebFetch = {
|
|
2467
|
+
/**
|
|
2468
|
+
* Most characters of page text to return, 1 to 100,000 (default 20,000).
|
|
2469
|
+
*/
|
|
2470
|
+
maxChars?: number | null;
|
|
2471
|
+
/**
|
|
2472
|
+
* The `http` or `https` URL of the page.
|
|
2473
|
+
*/
|
|
2474
|
+
url: string;
|
|
2475
|
+
};
|
|
2476
|
+
/**
|
|
2477
|
+
* The text of a fetched page.
|
|
2478
|
+
*/
|
|
2479
|
+
export type WebFetchResponse = {
|
|
2480
|
+
/**
|
|
2481
|
+
* The page text as Markdown, cut to `maxChars`.
|
|
2482
|
+
*/
|
|
2483
|
+
content: string;
|
|
2484
|
+
/**
|
|
2485
|
+
* The page title, when the provider reports one.
|
|
2486
|
+
*/
|
|
2487
|
+
title?: string | null;
|
|
2488
|
+
/**
|
|
2489
|
+
* Whether `content` was cut to `maxChars`.
|
|
2490
|
+
*/
|
|
2491
|
+
truncated: boolean;
|
|
2492
|
+
/**
|
|
2493
|
+
* The URL that was read.
|
|
2494
|
+
*/
|
|
2495
|
+
url: string;
|
|
2496
|
+
};
|
|
2497
|
+
/**
|
|
2498
|
+
* Search the public web.
|
|
2499
|
+
*/
|
|
2500
|
+
export type WebSearch = {
|
|
2501
|
+
/**
|
|
2502
|
+
* Only return pages from these domains, e.g. `["docs.rs", "github.com"]`.
|
|
2503
|
+
*/
|
|
2504
|
+
domains?: Array<string> | null;
|
|
2505
|
+
/**
|
|
2506
|
+
* Never return pages from these domains.
|
|
2507
|
+
*/
|
|
2508
|
+
excludeDomains?: Array<string> | null;
|
|
2509
|
+
/**
|
|
2510
|
+
* Also return each page's text as Markdown (up to 8,000 characters per result).
|
|
2511
|
+
*/
|
|
2512
|
+
includeContent?: boolean | null;
|
|
2513
|
+
/**
|
|
2514
|
+
* How many results to return, 1 to 20 (default 5).
|
|
2515
|
+
*/
|
|
2516
|
+
maxResults?: number | null;
|
|
2517
|
+
/**
|
|
2518
|
+
* What to search for, in natural language or keywords (at most 400 characters).
|
|
2519
|
+
*/
|
|
2520
|
+
query: string;
|
|
2521
|
+
/**
|
|
2522
|
+
* Only return pages published on or after this date (`YYYY-MM-DD`).
|
|
2523
|
+
*/
|
|
2524
|
+
since?: string | null;
|
|
2525
|
+
topic?: null | WebSearchTopic;
|
|
2526
|
+
};
|
|
2527
|
+
/**
|
|
2528
|
+
* The pages a search found, best match first.
|
|
2529
|
+
*/
|
|
2530
|
+
export type WebSearchResponse = {
|
|
2531
|
+
/**
|
|
2532
|
+
* Results, best match first. Empty when nothing matched.
|
|
2533
|
+
*/
|
|
2534
|
+
results: Array<WebSearchResult>;
|
|
2535
|
+
};
|
|
2536
|
+
/**
|
|
2537
|
+
* One page a search found.
|
|
2538
|
+
*/
|
|
2539
|
+
export type WebSearchResult = {
|
|
2540
|
+
/**
|
|
2541
|
+
* The page text as Markdown, when `includeContent` was set.
|
|
2542
|
+
*/
|
|
2543
|
+
content?: string | null;
|
|
2544
|
+
/**
|
|
2545
|
+
* When the page was published, as the search provider reports it.
|
|
2546
|
+
*/
|
|
2547
|
+
publishedAt?: string | null;
|
|
2548
|
+
/**
|
|
2549
|
+
* The part of the page most relevant to the query.
|
|
2550
|
+
*/
|
|
2551
|
+
snippet: string;
|
|
2552
|
+
/**
|
|
2553
|
+
* The page title.
|
|
2554
|
+
*/
|
|
2555
|
+
title: string;
|
|
2556
|
+
/**
|
|
2557
|
+
* The page URL; cite it when you use the result.
|
|
2558
|
+
*/
|
|
2559
|
+
url: string;
|
|
2560
|
+
};
|
|
2561
|
+
/**
|
|
2562
|
+
* The kind of results a search favours.
|
|
2563
|
+
*/
|
|
2564
|
+
export type WebSearchTopic = 'general' | 'news';
|
|
2565
|
+
export type WithChatId = {
|
|
2566
|
+
chat_id: string;
|
|
2567
|
+
};
|
|
2568
|
+
export type ReadMyActivityData = {
|
|
2569
|
+
body?: never;
|
|
2570
|
+
path?: never;
|
|
2571
|
+
query: {
|
|
2572
|
+
/**
|
|
2573
|
+
* Inclusive start, RFC 3339.
|
|
2574
|
+
*/
|
|
2575
|
+
from: string;
|
|
2576
|
+
/**
|
|
2577
|
+
* Exclusive end, RFC 3339; must be after `from`.
|
|
2578
|
+
*/
|
|
2579
|
+
to: string;
|
|
2580
|
+
};
|
|
2581
|
+
url: '/activity';
|
|
2582
|
+
};
|
|
2583
|
+
export type ReadMyActivityErrors = {
|
|
2584
|
+
/**
|
|
2585
|
+
* `from` is not before `to`
|
|
2586
|
+
*/
|
|
2587
|
+
400: ActivityErrorBody;
|
|
2588
|
+
/**
|
|
2589
|
+
* Internal server error
|
|
2590
|
+
*/
|
|
2591
|
+
500: ActivityErrorBody;
|
|
2592
|
+
};
|
|
2593
|
+
export type ReadMyActivityError = ReadMyActivityErrors[keyof ReadMyActivityErrors];
|
|
2594
|
+
export type ReadMyActivityResponses = {
|
|
2595
|
+
/**
|
|
2596
|
+
* Activity in the range
|
|
2597
|
+
*/
|
|
2598
|
+
200: ReadActivityResponse;
|
|
2599
|
+
};
|
|
2600
|
+
export type ReadMyActivityResponse = ReadMyActivityResponses[keyof ReadMyActivityResponses];
|
|
2601
|
+
export type SetPricingHandlerData = {
|
|
2602
|
+
body: SetPricingRequest;
|
|
2603
|
+
path?: never;
|
|
2604
|
+
query?: never;
|
|
2605
|
+
url: '/ai-cost/pricing';
|
|
2606
|
+
};
|
|
2607
|
+
export type SetPricingHandlerErrors = {
|
|
2608
|
+
/**
|
|
2609
|
+
* Invalid pricing
|
|
2610
|
+
*/
|
|
2611
|
+
400: ErrorBody;
|
|
2612
|
+
/**
|
|
2613
|
+
* Admin access required
|
|
2614
|
+
*/
|
|
2615
|
+
403: ErrorBody;
|
|
2616
|
+
/**
|
|
2617
|
+
* Internal server error
|
|
2618
|
+
*/
|
|
2619
|
+
500: ErrorBody;
|
|
2620
|
+
};
|
|
2621
|
+
export type SetPricingHandlerError = SetPricingHandlerErrors[keyof SetPricingHandlerErrors];
|
|
2622
|
+
export type SetPricingHandlerResponses = {
|
|
2623
|
+
/**
|
|
2624
|
+
* Pricing updated
|
|
2625
|
+
*/
|
|
2626
|
+
200: unknown;
|
|
2627
|
+
};
|
|
2628
|
+
export type GetUsageHandlerData = {
|
|
2629
|
+
body: UsageRequest;
|
|
2630
|
+
path?: never;
|
|
2631
|
+
query?: never;
|
|
2632
|
+
url: '/ai-cost/usage';
|
|
2633
|
+
};
|
|
2634
|
+
export type GetUsageHandlerErrors = {
|
|
2635
|
+
/**
|
|
2636
|
+
* Invalid request
|
|
2637
|
+
*/
|
|
2638
|
+
400: ErrorBody;
|
|
2639
|
+
/**
|
|
2640
|
+
* Admin access required
|
|
2641
|
+
*/
|
|
2642
|
+
403: ErrorBody;
|
|
2643
|
+
/**
|
|
2644
|
+
* Internal server error
|
|
2645
|
+
*/
|
|
2646
|
+
500: ErrorBody;
|
|
2647
|
+
};
|
|
2648
|
+
export type GetUsageHandlerError = GetUsageHandlerErrors[keyof GetUsageHandlerErrors];
|
|
2649
|
+
export type GetUsageHandlerResponses = {
|
|
2650
|
+
/**
|
|
2651
|
+
* Usage summary
|
|
2652
|
+
*/
|
|
2653
|
+
200: UsageSummary;
|
|
2654
|
+
};
|
|
2655
|
+
export type GetUsageHandlerResponse = GetUsageHandlerResponses[keyof GetUsageHandlerResponses];
|
|
2656
|
+
export type GetChatsForAttachmentHandlerData = {
|
|
2657
|
+
body?: never;
|
|
2658
|
+
path: {
|
|
2659
|
+
/**
|
|
2660
|
+
* id of the attachment
|
|
2661
|
+
*/
|
|
2662
|
+
attachment_id: string;
|
|
2663
|
+
};
|
|
2664
|
+
query?: never;
|
|
2665
|
+
url: '/attachments/{attachment_id}/chats';
|
|
2666
|
+
};
|
|
2667
|
+
export type GetChatsForAttachmentHandlerErrors = {
|
|
2668
|
+
401: string;
|
|
2669
|
+
404: string;
|
|
2670
|
+
500: string;
|
|
2671
|
+
};
|
|
2672
|
+
export type GetChatsForAttachmentHandlerError = GetChatsForAttachmentHandlerErrors[keyof GetChatsForAttachmentHandlerErrors];
|
|
2673
|
+
export type GetChatsForAttachmentHandlerResponses = {
|
|
2674
|
+
200: GetChatsForAttachmentResponse;
|
|
2675
|
+
};
|
|
2676
|
+
export type GetChatsForAttachmentHandlerResponse = GetChatsForAttachmentHandlerResponses[keyof GetChatsForAttachmentHandlerResponses];
|
|
2677
|
+
export type CreateConfirmedCalendarEventData = {
|
|
2678
|
+
/**
|
|
2679
|
+
* CreateConfirmedCalendarEvent arguments: CreateCalendarEvent's, plus userConfirmation
|
|
2680
|
+
*/
|
|
2681
|
+
body: {
|
|
2682
|
+
[key: string]: unknown;
|
|
2683
|
+
};
|
|
2684
|
+
path?: never;
|
|
2685
|
+
query?: never;
|
|
2686
|
+
url: '/calendar/events/create-confirmed';
|
|
2687
|
+
};
|
|
2688
|
+
export type CreateConfirmedCalendarEventErrors = {
|
|
2689
|
+
/**
|
|
2690
|
+
* Malformed, or missing userConfirmation
|
|
2691
|
+
*/
|
|
2692
|
+
400: GenericErrorResponse;
|
|
2693
|
+
/**
|
|
2694
|
+
* Unauthorized
|
|
2695
|
+
*/
|
|
2696
|
+
401: unknown;
|
|
2697
|
+
/**
|
|
2698
|
+
* Not created: a blank confirmation, a calendar the user cannot write, or a provider failure
|
|
2699
|
+
*/
|
|
2700
|
+
422: GenericErrorResponse;
|
|
2701
|
+
};
|
|
2702
|
+
export type CreateConfirmedCalendarEventError = CreateConfirmedCalendarEventErrors[keyof CreateConfirmedCalendarEventErrors];
|
|
2703
|
+
export type CreateConfirmedCalendarEventResponses = {
|
|
2704
|
+
/**
|
|
2705
|
+
* ToolCalendarEvent
|
|
2706
|
+
*/
|
|
2707
|
+
200: {
|
|
2708
|
+
[key: string]: unknown;
|
|
2709
|
+
};
|
|
2710
|
+
};
|
|
2711
|
+
export type CreateConfirmedCalendarEventResponse = CreateConfirmedCalendarEventResponses[keyof CreateConfirmedCalendarEventResponses];
|
|
2712
|
+
export type DeleteChatData = {
|
|
2713
|
+
body?: never;
|
|
2714
|
+
path: {
|
|
2715
|
+
/**
|
|
2716
|
+
* ID of the chat
|
|
2717
|
+
*/
|
|
2718
|
+
chat_id: string;
|
|
2719
|
+
};
|
|
2720
|
+
query?: never;
|
|
2721
|
+
url: '/chat/{chat_id}';
|
|
2722
|
+
};
|
|
2723
|
+
export type DeleteChatErrors = {
|
|
2724
|
+
401: string;
|
|
2725
|
+
500: string;
|
|
2726
|
+
};
|
|
2727
|
+
export type DeleteChatError = DeleteChatErrors[keyof DeleteChatErrors];
|
|
2728
|
+
export type DeleteChatResponses = {
|
|
2729
|
+
200: unknown;
|
|
2730
|
+
};
|
|
2731
|
+
export type PatchChatData = {
|
|
2732
|
+
body: PatchChatRequest;
|
|
2733
|
+
path: {
|
|
2734
|
+
/**
|
|
2735
|
+
* ID of the chat
|
|
2736
|
+
*/
|
|
2737
|
+
chat_id: string;
|
|
2738
|
+
};
|
|
2739
|
+
query?: never;
|
|
2740
|
+
url: '/chat/{chat_id}';
|
|
2741
|
+
};
|
|
2742
|
+
export type PatchChatErrors = {
|
|
2743
|
+
401: string;
|
|
2744
|
+
500: string;
|
|
2745
|
+
};
|
|
2746
|
+
export type PatchChatError = PatchChatErrors[keyof PatchChatErrors];
|
|
2747
|
+
export type PatchChatResponses = {
|
|
2748
|
+
200: unknown;
|
|
2749
|
+
};
|
|
2750
|
+
export type PermanentlyDeleteChatData = {
|
|
2751
|
+
body?: never;
|
|
2752
|
+
path: {
|
|
2753
|
+
/**
|
|
2754
|
+
* ID of the chat
|
|
2755
|
+
*/
|
|
2756
|
+
chat_id: string;
|
|
2757
|
+
};
|
|
2758
|
+
query?: never;
|
|
2759
|
+
url: '/chat/{chat_id}/permanent';
|
|
2760
|
+
};
|
|
2761
|
+
export type PermanentlyDeleteChatErrors = {
|
|
2762
|
+
401: string;
|
|
2763
|
+
500: string;
|
|
2764
|
+
};
|
|
2765
|
+
export type PermanentlyDeleteChatError = PermanentlyDeleteChatErrors[keyof PermanentlyDeleteChatErrors];
|
|
2766
|
+
export type PermanentlyDeleteChatResponses = {
|
|
2767
|
+
200: unknown;
|
|
2768
|
+
};
|
|
2769
|
+
export type CreateChatData = {
|
|
2770
|
+
body: CreateChatRequest;
|
|
2771
|
+
path?: never;
|
|
2772
|
+
query?: never;
|
|
2773
|
+
url: '/chats';
|
|
2774
|
+
};
|
|
2775
|
+
export type CreateChatErrors = {
|
|
2776
|
+
401: string;
|
|
2777
|
+
403: string;
|
|
2778
|
+
500: string;
|
|
2779
|
+
};
|
|
2780
|
+
export type CreateChatError = CreateChatErrors[keyof CreateChatErrors];
|
|
2781
|
+
export type CreateChatResponses = {
|
|
2782
|
+
200: StringIdResponse;
|
|
2783
|
+
};
|
|
2784
|
+
export type CreateChatResponse = CreateChatResponses[keyof CreateChatResponses];
|
|
2785
|
+
export type GetChatHistoryHandlerData = {
|
|
2786
|
+
body?: never;
|
|
2787
|
+
path: {
|
|
2788
|
+
/**
|
|
2789
|
+
* Chat ID to retrieve history for
|
|
2790
|
+
*/
|
|
2791
|
+
chat_id: string;
|
|
2792
|
+
};
|
|
2793
|
+
query?: never;
|
|
2794
|
+
url: '/chats/history/{chat_id}';
|
|
2795
|
+
};
|
|
2796
|
+
export type GetChatHistoryHandlerErrors = {
|
|
2797
|
+
/**
|
|
2798
|
+
* Chat not found
|
|
2799
|
+
*/
|
|
2800
|
+
404: string;
|
|
2801
|
+
/**
|
|
2802
|
+
* Internal server error
|
|
2803
|
+
*/
|
|
2804
|
+
500: string;
|
|
2805
|
+
};
|
|
2806
|
+
export type GetChatHistoryHandlerError = GetChatHistoryHandlerErrors[keyof GetChatHistoryHandlerErrors];
|
|
2807
|
+
export type GetChatHistoryHandlerResponses = {
|
|
2808
|
+
200: ChatHistory;
|
|
2809
|
+
};
|
|
2810
|
+
export type GetChatHistoryHandlerResponse = GetChatHistoryHandlerResponses[keyof GetChatHistoryHandlerResponses];
|
|
2811
|
+
export type GetChatHistoryBatchMessagesHandlerData = {
|
|
2812
|
+
body: ChatHistoryBatchMessagesRequest;
|
|
2813
|
+
path?: never;
|
|
2814
|
+
query?: never;
|
|
2815
|
+
url: '/chats/history_batch_messages';
|
|
2816
|
+
};
|
|
2817
|
+
export type GetChatHistoryBatchMessagesHandlerErrors = {
|
|
2818
|
+
/**
|
|
2819
|
+
* Access denied to chat
|
|
2820
|
+
*/
|
|
2821
|
+
403: string;
|
|
2822
|
+
/**
|
|
2823
|
+
* Messages not found
|
|
2824
|
+
*/
|
|
2825
|
+
404: string;
|
|
2826
|
+
/**
|
|
2827
|
+
* Internal server error
|
|
2828
|
+
*/
|
|
2829
|
+
500: string;
|
|
2830
|
+
};
|
|
2831
|
+
export type GetChatHistoryBatchMessagesHandlerError = GetChatHistoryBatchMessagesHandlerErrors[keyof GetChatHistoryBatchMessagesHandlerErrors];
|
|
2832
|
+
export type GetChatHistoryBatchMessagesHandlerResponses = {
|
|
2833
|
+
200: ChatHistory;
|
|
2834
|
+
};
|
|
2835
|
+
export type GetChatHistoryBatchMessagesHandlerResponse = GetChatHistoryBatchMessagesHandlerResponses[keyof GetChatHistoryBatchMessagesHandlerResponses];
|
|
2836
|
+
export type GetChatData = {
|
|
2837
|
+
body?: never;
|
|
2838
|
+
path: {
|
|
2839
|
+
/**
|
|
2840
|
+
* ID of the chat
|
|
2841
|
+
*/
|
|
2842
|
+
chat_id: string;
|
|
2843
|
+
};
|
|
2844
|
+
query?: never;
|
|
2845
|
+
url: '/chats/{chat_id}';
|
|
2846
|
+
};
|
|
2847
|
+
export type GetChatErrors = {
|
|
2848
|
+
401: string;
|
|
2849
|
+
404: string;
|
|
2850
|
+
500: string;
|
|
2851
|
+
};
|
|
2852
|
+
export type GetChatError = GetChatErrors[keyof GetChatErrors];
|
|
2853
|
+
export type GetChatResponses = {
|
|
2854
|
+
200: GetChatResponse;
|
|
2855
|
+
};
|
|
2856
|
+
export type GetChatResponse2 = GetChatResponses[keyof GetChatResponses];
|
|
2857
|
+
export type CopyChatData = {
|
|
2858
|
+
body?: never;
|
|
2859
|
+
path: {
|
|
2860
|
+
/**
|
|
2861
|
+
* ID of the chat to copy
|
|
2862
|
+
*/
|
|
2863
|
+
chat_id: string;
|
|
2864
|
+
};
|
|
2865
|
+
query?: never;
|
|
2866
|
+
url: '/chats/{chat_id}/copy';
|
|
2867
|
+
};
|
|
2868
|
+
export type CopyChatErrors = {
|
|
2869
|
+
401: string;
|
|
2870
|
+
404: string;
|
|
2871
|
+
500: string;
|
|
2872
|
+
};
|
|
2873
|
+
export type CopyChatError = CopyChatErrors[keyof CopyChatErrors];
|
|
2874
|
+
export type CopyChatResponses = {
|
|
2875
|
+
200: StringIdResponse;
|
|
2876
|
+
};
|
|
2877
|
+
export type CopyChatResponse = CopyChatResponses[keyof CopyChatResponses];
|
|
2878
|
+
export type GetChatPermissionsData = {
|
|
2879
|
+
body?: never;
|
|
2880
|
+
path: {
|
|
2881
|
+
/**
|
|
2882
|
+
* ID of the chat
|
|
2883
|
+
*/
|
|
2884
|
+
chat_id: string;
|
|
2885
|
+
};
|
|
2886
|
+
query?: never;
|
|
2887
|
+
url: '/chats/{chat_id}/permissions';
|
|
2888
|
+
};
|
|
2889
|
+
export type GetChatPermissionsErrors = {
|
|
2890
|
+
401: string;
|
|
2891
|
+
500: string;
|
|
2892
|
+
};
|
|
2893
|
+
export type GetChatPermissionsError = GetChatPermissionsErrors[keyof GetChatPermissionsErrors];
|
|
2894
|
+
export type GetChatPermissionsResponses = {
|
|
2895
|
+
200: GetChatPermissionsResponse;
|
|
2896
|
+
};
|
|
2897
|
+
export type GetChatPermissionsResponse2 = GetChatPermissionsResponses[keyof GetChatPermissionsResponses];
|
|
2898
|
+
export type RevertDeleteChatData = {
|
|
2899
|
+
body?: never;
|
|
2900
|
+
path: {
|
|
2901
|
+
/**
|
|
2902
|
+
* ID of the chat to restore
|
|
2903
|
+
*/
|
|
2904
|
+
chat_id: string;
|
|
2905
|
+
};
|
|
2906
|
+
query?: never;
|
|
2907
|
+
url: '/chats/{chat_id}/revert_delete';
|
|
2908
|
+
};
|
|
2909
|
+
export type RevertDeleteChatErrors = {
|
|
2910
|
+
401: string;
|
|
2911
|
+
500: string;
|
|
2912
|
+
};
|
|
2913
|
+
export type RevertDeleteChatError = RevertDeleteChatErrors[keyof RevertDeleteChatErrors];
|
|
2914
|
+
export type RevertDeleteChatResponses = {
|
|
2915
|
+
200: unknown;
|
|
2916
|
+
};
|
|
2917
|
+
export type CallToolData = {
|
|
2918
|
+
body: CallToolRequest;
|
|
2919
|
+
path: {
|
|
2920
|
+
/**
|
|
2921
|
+
* ID of the chat
|
|
2922
|
+
*/
|
|
2923
|
+
chat_id: string;
|
|
2924
|
+
};
|
|
2925
|
+
query?: never;
|
|
2926
|
+
url: '/chats/{chat_id}/tool/call';
|
|
2927
|
+
};
|
|
2928
|
+
export type CallToolErrors = {
|
|
2929
|
+
/**
|
|
2930
|
+
* Validation or execution failed
|
|
2931
|
+
*/
|
|
2932
|
+
400: string;
|
|
2933
|
+
/**
|
|
2934
|
+
* Tool call not found
|
|
2935
|
+
*/
|
|
2936
|
+
404: string;
|
|
2937
|
+
500: string;
|
|
2938
|
+
};
|
|
2939
|
+
export type CallToolError = CallToolErrors[keyof CallToolErrors];
|
|
2940
|
+
export type CallToolResponses = {
|
|
2941
|
+
/**
|
|
2942
|
+
* Tool executed successfully
|
|
2943
|
+
*/
|
|
2944
|
+
200: CallToolResponse;
|
|
2945
|
+
};
|
|
2946
|
+
export type CallToolResponse2 = CallToolResponses[keyof CallToolResponses];
|
|
2947
|
+
export type RejectToolCallData = {
|
|
2948
|
+
body: RejectToolCallRequest;
|
|
2949
|
+
path: {
|
|
2950
|
+
/**
|
|
2951
|
+
* ID of the chat
|
|
2952
|
+
*/
|
|
2953
|
+
chat_id: string;
|
|
2954
|
+
};
|
|
2955
|
+
query?: never;
|
|
2956
|
+
url: '/chats/{chat_id}/tool/reject';
|
|
2957
|
+
};
|
|
2958
|
+
export type RejectToolCallErrors = {
|
|
2959
|
+
/**
|
|
2960
|
+
* Tool call not found
|
|
2961
|
+
*/
|
|
2962
|
+
404: string;
|
|
2963
|
+
500: string;
|
|
2964
|
+
};
|
|
2965
|
+
export type RejectToolCallError = RejectToolCallErrors[keyof RejectToolCallErrors];
|
|
2966
|
+
export type RejectToolCallResponses = {
|
|
2967
|
+
/**
|
|
2968
|
+
* Tool call rejected
|
|
2969
|
+
*/
|
|
2970
|
+
200: unknown;
|
|
2971
|
+
};
|
|
2972
|
+
export type UpdateToolResponseData = {
|
|
2973
|
+
body: UpdateToolResponseRequest;
|
|
2974
|
+
path: {
|
|
2975
|
+
/**
|
|
2976
|
+
* ID of the chat
|
|
2977
|
+
*/
|
|
2978
|
+
chat_id: string;
|
|
2979
|
+
};
|
|
2980
|
+
query?: never;
|
|
2981
|
+
url: '/chats/{chat_id}/tool/response/update';
|
|
2982
|
+
};
|
|
2983
|
+
export type UpdateToolResponseErrors = {
|
|
2984
|
+
/**
|
|
2985
|
+
* Tool call not found
|
|
2986
|
+
*/
|
|
2987
|
+
404: string;
|
|
2988
|
+
500: string;
|
|
2989
|
+
};
|
|
2990
|
+
export type UpdateToolResponseError = UpdateToolResponseErrors[keyof UpdateToolResponseErrors];
|
|
2991
|
+
export type UpdateToolResponseResponses = {
|
|
2992
|
+
/**
|
|
2993
|
+
* Tool response updated
|
|
2994
|
+
*/
|
|
2995
|
+
200: unknown;
|
|
2996
|
+
};
|
|
2997
|
+
export type UpdateToolCallData = {
|
|
2998
|
+
body: UpdateToolCallRequest;
|
|
2999
|
+
path: {
|
|
3000
|
+
/**
|
|
3001
|
+
* ID of the chat
|
|
3002
|
+
*/
|
|
3003
|
+
chat_id: string;
|
|
3004
|
+
};
|
|
3005
|
+
query?: never;
|
|
3006
|
+
url: '/chats/{chat_id}/tool/update';
|
|
3007
|
+
};
|
|
3008
|
+
export type UpdateToolCallErrors = {
|
|
3009
|
+
/**
|
|
3010
|
+
* Validation failed
|
|
3011
|
+
*/
|
|
3012
|
+
400: string;
|
|
3013
|
+
/**
|
|
3014
|
+
* Tool call not found
|
|
3015
|
+
*/
|
|
3016
|
+
404: string;
|
|
3017
|
+
500: string;
|
|
3018
|
+
};
|
|
3019
|
+
export type UpdateToolCallError = UpdateToolCallErrors[keyof UpdateToolCallErrors];
|
|
3020
|
+
export type UpdateToolCallResponses = {
|
|
3021
|
+
/**
|
|
3022
|
+
* Tool call args updated
|
|
3023
|
+
*/
|
|
3024
|
+
200: unknown;
|
|
3025
|
+
};
|
|
3026
|
+
export type GetCitationHandlerData = {
|
|
3027
|
+
body?: never;
|
|
3028
|
+
path: {
|
|
3029
|
+
/**
|
|
3030
|
+
* id of the citation
|
|
3031
|
+
*/
|
|
3032
|
+
id: string;
|
|
3033
|
+
};
|
|
3034
|
+
query?: never;
|
|
3035
|
+
url: '/citations/{id}';
|
|
3036
|
+
};
|
|
3037
|
+
export type GetCitationHandlerErrors = {
|
|
3038
|
+
404: string;
|
|
3039
|
+
500: string;
|
|
3040
|
+
};
|
|
3041
|
+
export type GetCitationHandlerError = GetCitationHandlerErrors[keyof GetCitationHandlerErrors];
|
|
3042
|
+
export type GetCitationHandlerResponses = {
|
|
3043
|
+
200: DocumentTextPart;
|
|
3044
|
+
};
|
|
3045
|
+
export type GetCitationHandlerResponse = GetCitationHandlerResponses[keyof GetCitationHandlerResponses];
|
|
3046
|
+
export type GenerateDatabaseQueryData = {
|
|
3047
|
+
body: DatabaseQueryRequest;
|
|
3048
|
+
path?: never;
|
|
3049
|
+
query?: never;
|
|
3050
|
+
url: '/database-query';
|
|
3051
|
+
};
|
|
3052
|
+
export type GenerateDatabaseQueryErrors = {
|
|
3053
|
+
/**
|
|
3054
|
+
* Unauthorized
|
|
3055
|
+
*/
|
|
3056
|
+
401: unknown;
|
|
3057
|
+
402: StructuredCompletionError;
|
|
3058
|
+
403: StructuredCompletionError;
|
|
3059
|
+
500: StructuredCompletionError;
|
|
3060
|
+
503: StructuredCompletionError;
|
|
3061
|
+
504: StructuredCompletionError;
|
|
3062
|
+
};
|
|
3063
|
+
export type GenerateDatabaseQueryError = GenerateDatabaseQueryErrors[keyof GenerateDatabaseQueryErrors];
|
|
3064
|
+
export type GenerateDatabaseQueryResponses = {
|
|
3065
|
+
200: DatabaseQueryAnswer;
|
|
3066
|
+
};
|
|
3067
|
+
export type GenerateDatabaseQueryResponse = GenerateDatabaseQueryResponses[keyof GenerateDatabaseQueryResponses];
|
|
3068
|
+
export type DecisionsData = {
|
|
3069
|
+
body: DecisionRequest;
|
|
3070
|
+
path?: never;
|
|
3071
|
+
query?: never;
|
|
3072
|
+
url: '/decisions';
|
|
3073
|
+
};
|
|
3074
|
+
export type DecisionsErrors = {
|
|
3075
|
+
/**
|
|
3076
|
+
* Invalid or oversized compact request
|
|
3077
|
+
*/
|
|
3078
|
+
400: DecisionErrorBody;
|
|
3079
|
+
/**
|
|
3080
|
+
* Unauthorized
|
|
3081
|
+
*/
|
|
3082
|
+
401: unknown;
|
|
3083
|
+
/**
|
|
3084
|
+
* AI allowance exhausted
|
|
3085
|
+
*/
|
|
3086
|
+
402: DecisionErrorBody;
|
|
3087
|
+
/**
|
|
3088
|
+
* HTTP body exceeds 128 KiB
|
|
3089
|
+
*/
|
|
3090
|
+
413: unknown;
|
|
3091
|
+
/**
|
|
3092
|
+
* Decision task failed
|
|
3093
|
+
*/
|
|
3094
|
+
500: DecisionErrorBody;
|
|
3095
|
+
/**
|
|
3096
|
+
* Classifier could not produce a valid result
|
|
3097
|
+
*/
|
|
3098
|
+
502: DecisionErrorBody;
|
|
3099
|
+
/**
|
|
3100
|
+
* Decision capacity, provider, or usage validation unavailable
|
|
3101
|
+
*/
|
|
3102
|
+
503: DecisionErrorBody;
|
|
3103
|
+
/**
|
|
3104
|
+
* Decision deadline exceeded
|
|
3105
|
+
*/
|
|
3106
|
+
504: DecisionErrorBody;
|
|
3107
|
+
};
|
|
3108
|
+
export type DecisionsError = DecisionsErrors[keyof DecisionsErrors];
|
|
3109
|
+
export type DecisionsResponses = {
|
|
3110
|
+
/**
|
|
3111
|
+
* Probability of yes for each named question
|
|
3112
|
+
*/
|
|
3113
|
+
200: DecisionResponse;
|
|
3114
|
+
};
|
|
3115
|
+
export type DecisionsResponse = DecisionsResponses[keyof DecisionsResponses];
|
|
3116
|
+
export type SendConfirmedEmailData = {
|
|
3117
|
+
/**
|
|
3118
|
+
* SendConfirmedEmail arguments: SendEmail's, plus userConfirmation
|
|
3119
|
+
*/
|
|
3120
|
+
body: {
|
|
3121
|
+
[key: string]: unknown;
|
|
3122
|
+
};
|
|
3123
|
+
path?: never;
|
|
3124
|
+
query?: never;
|
|
3125
|
+
url: '/email/send-confirmed';
|
|
3126
|
+
};
|
|
3127
|
+
export type SendConfirmedEmailErrors = {
|
|
3128
|
+
/**
|
|
3129
|
+
* Malformed, or missing userConfirmation
|
|
3130
|
+
*/
|
|
3131
|
+
400: GenericErrorResponse;
|
|
3132
|
+
/**
|
|
3133
|
+
* Unauthorized
|
|
3134
|
+
*/
|
|
3135
|
+
401: unknown;
|
|
3136
|
+
/**
|
|
3137
|
+
* Not sent: a blank confirmation, an inbox or attachment the user cannot use, or a delivery failure
|
|
3138
|
+
*/
|
|
3139
|
+
422: GenericErrorResponse;
|
|
3140
|
+
};
|
|
3141
|
+
export type SendConfirmedEmailError = SendConfirmedEmailErrors[keyof SendConfirmedEmailErrors];
|
|
3142
|
+
export type SendConfirmedEmailResponses = {
|
|
3143
|
+
/**
|
|
3144
|
+
* SendEmailResponse
|
|
3145
|
+
*/
|
|
3146
|
+
200: {
|
|
3147
|
+
[key: string]: unknown;
|
|
3148
|
+
};
|
|
3149
|
+
};
|
|
3150
|
+
export type SendConfirmedEmailResponse = SendConfirmedEmailResponses[keyof SendConfirmedEmailResponses];
|
|
3151
|
+
export type HealthHandlerData = {
|
|
3152
|
+
body?: never;
|
|
3153
|
+
path?: never;
|
|
3154
|
+
query?: never;
|
|
3155
|
+
url: '/health';
|
|
3156
|
+
};
|
|
3157
|
+
export type HealthHandlerResponses = {
|
|
3158
|
+
/**
|
|
3159
|
+
* health
|
|
3160
|
+
*/
|
|
3161
|
+
200: string;
|
|
3162
|
+
};
|
|
3163
|
+
export type HealthHandlerResponse = HealthHandlerResponses[keyof HealthHandlerResponses];
|
|
3164
|
+
export type GenerateImageData = {
|
|
3165
|
+
body: GenerateImageRequest;
|
|
3166
|
+
path?: never;
|
|
3167
|
+
query?: never;
|
|
3168
|
+
url: '/images/generate';
|
|
3169
|
+
};
|
|
3170
|
+
export type GenerateImageErrors = {
|
|
3171
|
+
/**
|
|
3172
|
+
* Invalid prompt or reference
|
|
3173
|
+
*/
|
|
3174
|
+
400: GenerateImageErrorBody;
|
|
3175
|
+
/**
|
|
3176
|
+
* Unauthorized
|
|
3177
|
+
*/
|
|
3178
|
+
401: unknown;
|
|
3179
|
+
/**
|
|
3180
|
+
* AI allowance exhausted
|
|
3181
|
+
*/
|
|
3182
|
+
402: GenerateImageErrorBody;
|
|
3183
|
+
/**
|
|
3184
|
+
* A reference is not accessible, or no user to bill
|
|
3185
|
+
*/
|
|
3186
|
+
403: GenerateImageErrorBody;
|
|
3187
|
+
/**
|
|
3188
|
+
* The model declined to render the prompt
|
|
3189
|
+
*/
|
|
3190
|
+
422: GenerateImageErrorBody;
|
|
3191
|
+
/**
|
|
3192
|
+
* The image could not be read or stored
|
|
3193
|
+
*/
|
|
3194
|
+
500: GenerateImageErrorBody;
|
|
3195
|
+
/**
|
|
3196
|
+
* The image model request failed
|
|
3197
|
+
*/
|
|
3198
|
+
502: GenerateImageErrorBody;
|
|
3199
|
+
/**
|
|
3200
|
+
* Image generation or usage validation unavailable
|
|
3201
|
+
*/
|
|
3202
|
+
503: GenerateImageErrorBody;
|
|
3203
|
+
};
|
|
3204
|
+
export type GenerateImageError = GenerateImageErrors[keyof GenerateImageErrors];
|
|
3205
|
+
export type GenerateImageResponses = {
|
|
3206
|
+
/**
|
|
3207
|
+
* The stored image
|
|
3208
|
+
*/
|
|
3209
|
+
200: GenerateImageResponse;
|
|
3210
|
+
};
|
|
3211
|
+
export type GenerateImageResponse2 = GenerateImageResponses[keyof GenerateImageResponses];
|
|
3212
|
+
export type ListImportEntitiesData = {
|
|
3213
|
+
body?: never;
|
|
3214
|
+
path?: never;
|
|
3215
|
+
query?: {
|
|
3216
|
+
/**
|
|
3217
|
+
* Only rows from this source.
|
|
3218
|
+
*/
|
|
3219
|
+
source?: ImportSource;
|
|
3220
|
+
/**
|
|
3221
|
+
* Only rows in this status.
|
|
3222
|
+
*/
|
|
3223
|
+
status?: ImportStatus;
|
|
3224
|
+
};
|
|
3225
|
+
url: '/import/entities';
|
|
3226
|
+
};
|
|
3227
|
+
export type ListImportEntitiesErrors = {
|
|
3228
|
+
/**
|
|
3229
|
+
* Internal server error
|
|
3230
|
+
*/
|
|
3231
|
+
500: unknown;
|
|
3232
|
+
};
|
|
3233
|
+
export type ListImportEntitiesResponses = {
|
|
3234
|
+
200: ImportEntitiesResponse;
|
|
3235
|
+
};
|
|
3236
|
+
export type ListImportEntitiesResponse = ListImportEntitiesResponses[keyof ListImportEntitiesResponses];
|
|
3237
|
+
export type TrackImportEntityData = {
|
|
3238
|
+
body: TrackImportEntityRequest;
|
|
3239
|
+
path?: never;
|
|
3240
|
+
query?: never;
|
|
3241
|
+
url: '/import/entities';
|
|
3242
|
+
};
|
|
3243
|
+
export type TrackImportEntityErrors = {
|
|
3244
|
+
/**
|
|
3245
|
+
* Invalid item or metadata
|
|
3246
|
+
*/
|
|
3247
|
+
400: unknown;
|
|
3248
|
+
/**
|
|
3249
|
+
* The import service refused the item
|
|
3250
|
+
*/
|
|
3251
|
+
422: unknown;
|
|
3252
|
+
/**
|
|
3253
|
+
* Internal server error
|
|
3254
|
+
*/
|
|
3255
|
+
500: unknown;
|
|
3256
|
+
};
|
|
3257
|
+
export type TrackImportEntityResponses = {
|
|
3258
|
+
200: TrackImportEntityResponse;
|
|
3259
|
+
};
|
|
3260
|
+
export type TrackImportEntityResponse2 = TrackImportEntityResponses[keyof TrackImportEntityResponses];
|
|
3261
|
+
export type DeclineImportEntityData = {
|
|
3262
|
+
body?: never;
|
|
3263
|
+
path: {
|
|
3264
|
+
/**
|
|
3265
|
+
* Ledger row id
|
|
3266
|
+
*/
|
|
3267
|
+
id: string;
|
|
3268
|
+
};
|
|
3269
|
+
query?: never;
|
|
3270
|
+
url: '/import/entities/{id}';
|
|
3271
|
+
};
|
|
3272
|
+
export type DeclineImportEntityErrors = {
|
|
3273
|
+
/**
|
|
3274
|
+
* No such row belongs to the caller
|
|
3275
|
+
*/
|
|
3276
|
+
404: unknown;
|
|
3277
|
+
/**
|
|
3278
|
+
* Only staged rows can be declined
|
|
3279
|
+
*/
|
|
3280
|
+
409: unknown;
|
|
3281
|
+
/**
|
|
3282
|
+
* Internal server error
|
|
3283
|
+
*/
|
|
3284
|
+
500: unknown;
|
|
3285
|
+
};
|
|
3286
|
+
export type DeclineImportEntityResponses = {
|
|
3287
|
+
/**
|
|
3288
|
+
* Declined
|
|
3289
|
+
*/
|
|
3290
|
+
204: void;
|
|
3291
|
+
};
|
|
3292
|
+
export type DeclineImportEntityResponse = DeclineImportEntityResponses[keyof DeclineImportEntityResponses];
|
|
3293
|
+
export type NotionReportHandlerData = {
|
|
3294
|
+
body?: never;
|
|
3295
|
+
path?: never;
|
|
3296
|
+
query?: never;
|
|
3297
|
+
url: '/import/notion';
|
|
3298
|
+
};
|
|
3299
|
+
export type NotionReportHandlerErrors = {
|
|
3300
|
+
/**
|
|
3301
|
+
* Internal server error
|
|
3302
|
+
*/
|
|
3303
|
+
500: unknown;
|
|
3304
|
+
};
|
|
3305
|
+
export type NotionReportHandlerResponses = {
|
|
3306
|
+
200: NotionImportReport;
|
|
3307
|
+
};
|
|
3308
|
+
export type NotionReportHandlerResponse = NotionReportHandlerResponses[keyof NotionReportHandlerResponses];
|
|
3309
|
+
export type CancelNotionHandlerData = {
|
|
3310
|
+
body?: never;
|
|
3311
|
+
path?: never;
|
|
3312
|
+
query?: never;
|
|
3313
|
+
url: '/import/notion/cancel';
|
|
3314
|
+
};
|
|
3315
|
+
export type CancelNotionHandlerErrors = {
|
|
3316
|
+
/**
|
|
3317
|
+
* Internal server error
|
|
3318
|
+
*/
|
|
3319
|
+
500: unknown;
|
|
3320
|
+
};
|
|
3321
|
+
export type CancelNotionHandlerResponses = {
|
|
3322
|
+
/**
|
|
3323
|
+
* Where the import stands after cancelling
|
|
3324
|
+
*/
|
|
3325
|
+
200: NotionImportReport;
|
|
3326
|
+
};
|
|
3327
|
+
export type CancelNotionHandlerResponse = CancelNotionHandlerResponses[keyof CancelNotionHandlerResponses];
|
|
3328
|
+
export type ImportNotionPageData = {
|
|
3329
|
+
body: ImportNotionPageRequest;
|
|
3330
|
+
path?: never;
|
|
3331
|
+
query?: never;
|
|
3332
|
+
url: '/import/notion/pages';
|
|
3333
|
+
};
|
|
3334
|
+
export type ImportNotionPageErrors = {
|
|
3335
|
+
/**
|
|
3336
|
+
* No page given
|
|
3337
|
+
*/
|
|
3338
|
+
400: unknown;
|
|
3339
|
+
/**
|
|
3340
|
+
* Not a page that can be imported, or Notion is not connected
|
|
3341
|
+
*/
|
|
3342
|
+
422: unknown;
|
|
3343
|
+
/**
|
|
3344
|
+
* Internal server error
|
|
3345
|
+
*/
|
|
3346
|
+
500: unknown;
|
|
3347
|
+
};
|
|
3348
|
+
export type ImportNotionPageResponses = {
|
|
3349
|
+
200: ImportNotionPageResponse;
|
|
3350
|
+
};
|
|
3351
|
+
export type ImportNotionPageResponse2 = ImportNotionPageResponses[keyof ImportNotionPageResponses];
|
|
3352
|
+
export type RunImportHandlerData = {
|
|
3353
|
+
body: RunImportRequest;
|
|
3354
|
+
path?: never;
|
|
3355
|
+
query?: never;
|
|
3356
|
+
url: '/import/run';
|
|
3357
|
+
};
|
|
3358
|
+
export type RunImportHandlerErrors = {
|
|
3359
|
+
/**
|
|
3360
|
+
* Internal server error
|
|
3361
|
+
*/
|
|
3362
|
+
500: unknown;
|
|
3363
|
+
};
|
|
3364
|
+
export type RunImportHandlerResponses = {
|
|
3365
|
+
/**
|
|
3366
|
+
* Import run outcome
|
|
3367
|
+
*/
|
|
3368
|
+
200: RunImportOutcome;
|
|
3369
|
+
};
|
|
3370
|
+
export type RunImportHandlerResponse = RunImportHandlerResponses[keyof RunImportHandlerResponses];
|
|
3371
|
+
export type DiscoverHandlerData = {
|
|
3372
|
+
body?: never;
|
|
3373
|
+
path: {
|
|
3374
|
+
/**
|
|
3375
|
+
* Import source
|
|
3376
|
+
*/
|
|
3377
|
+
source: string;
|
|
3378
|
+
};
|
|
3379
|
+
query?: never;
|
|
3380
|
+
url: '/import/runs/{source}/discover';
|
|
3381
|
+
};
|
|
3382
|
+
export type DiscoverHandlerErrors = {
|
|
3383
|
+
/**
|
|
3384
|
+
* Unknown import source or discovery not supported
|
|
3385
|
+
*/
|
|
3386
|
+
400: unknown;
|
|
3387
|
+
/**
|
|
3388
|
+
* Internal server error
|
|
3389
|
+
*/
|
|
3390
|
+
500: unknown;
|
|
3391
|
+
};
|
|
3392
|
+
export type DiscoverHandlerResponses = {
|
|
3393
|
+
/**
|
|
3394
|
+
* Discovery accepted (idempotent)
|
|
3395
|
+
*/
|
|
3396
|
+
204: void;
|
|
3397
|
+
};
|
|
3398
|
+
export type DiscoverHandlerResponse = DiscoverHandlerResponses[keyof DiscoverHandlerResponses];
|
|
3399
|
+
export type GetStateHandlerData = {
|
|
3400
|
+
body?: never;
|
|
3401
|
+
path?: never;
|
|
3402
|
+
query?: never;
|
|
3403
|
+
url: '/import/state';
|
|
3404
|
+
};
|
|
3405
|
+
export type GetStateHandlerErrors = {
|
|
3406
|
+
/**
|
|
3407
|
+
* Internal server error
|
|
3408
|
+
*/
|
|
3409
|
+
500: unknown;
|
|
3410
|
+
};
|
|
3411
|
+
export type GetStateHandlerResponses = {
|
|
3412
|
+
/**
|
|
3413
|
+
* Current import state
|
|
3414
|
+
*/
|
|
3415
|
+
200: ImportState;
|
|
3416
|
+
};
|
|
3417
|
+
export type GetStateHandlerResponse = GetStateHandlerResponses[keyof GetStateHandlerResponses];
|
|
3418
|
+
export type WorkspaceReportHandlerData = {
|
|
3419
|
+
body?: never;
|
|
3420
|
+
path: {
|
|
3421
|
+
source: ImportSource;
|
|
3422
|
+
};
|
|
3423
|
+
query?: never;
|
|
3424
|
+
url: '/import/workspaces/{source}';
|
|
3425
|
+
};
|
|
3426
|
+
export type WorkspaceReportHandlerResponses = {
|
|
3427
|
+
200: NotionImportReport;
|
|
3428
|
+
};
|
|
3429
|
+
export type WorkspaceReportHandlerResponse = WorkspaceReportHandlerResponses[keyof WorkspaceReportHandlerResponses];
|
|
3430
|
+
export type CancelWorkspaceHandlerData = {
|
|
3431
|
+
body?: never;
|
|
3432
|
+
path: {
|
|
3433
|
+
source: ImportSource;
|
|
3434
|
+
};
|
|
3435
|
+
query?: never;
|
|
3436
|
+
url: '/import/workspaces/{source}/cancel';
|
|
3437
|
+
};
|
|
3438
|
+
export type CancelWorkspaceHandlerResponses = {
|
|
3439
|
+
200: NotionImportReport;
|
|
3440
|
+
};
|
|
3441
|
+
export type CancelWorkspaceHandlerResponse = CancelWorkspaceHandlerResponses[keyof CancelWorkspaceHandlerResponses];
|
|
3442
|
+
export type DeleteMcpServerData = {
|
|
3443
|
+
body?: never;
|
|
3444
|
+
path?: never;
|
|
3445
|
+
query: {
|
|
3446
|
+
/**
|
|
3447
|
+
* The server URL to delete.
|
|
3448
|
+
*/
|
|
3449
|
+
url: string;
|
|
3450
|
+
};
|
|
3451
|
+
url: '/mcp/servers';
|
|
3452
|
+
};
|
|
3453
|
+
export type DeleteMcpServerErrors = {
|
|
3454
|
+
401: string;
|
|
3455
|
+
500: ErrorResponse;
|
|
3456
|
+
};
|
|
3457
|
+
export type DeleteMcpServerError = DeleteMcpServerErrors[keyof DeleteMcpServerErrors];
|
|
3458
|
+
export type DeleteMcpServerResponses = {
|
|
3459
|
+
204: void;
|
|
3460
|
+
};
|
|
3461
|
+
export type DeleteMcpServerResponse = DeleteMcpServerResponses[keyof DeleteMcpServerResponses];
|
|
3462
|
+
export type ListMcpServersData = {
|
|
3463
|
+
body?: never;
|
|
3464
|
+
path?: never;
|
|
3465
|
+
query?: never;
|
|
3466
|
+
url: '/mcp/servers';
|
|
3467
|
+
};
|
|
3468
|
+
export type ListMcpServersErrors = {
|
|
3469
|
+
401: string;
|
|
3470
|
+
500: ErrorResponse;
|
|
3471
|
+
};
|
|
3472
|
+
export type ListMcpServersError = ListMcpServersErrors[keyof ListMcpServersErrors];
|
|
3473
|
+
export type ListMcpServersResponses = {
|
|
3474
|
+
200: Array<ServerResponse>;
|
|
3475
|
+
};
|
|
3476
|
+
export type ListMcpServersResponse = ListMcpServersResponses[keyof ListMcpServersResponses];
|
|
3477
|
+
export type AddMcpServerData = {
|
|
3478
|
+
body: AddServerRequest;
|
|
3479
|
+
path?: never;
|
|
3480
|
+
query?: never;
|
|
3481
|
+
url: '/mcp/servers';
|
|
3482
|
+
};
|
|
3483
|
+
export type AddMcpServerErrors = {
|
|
3484
|
+
400: ErrorResponse;
|
|
3485
|
+
401: string;
|
|
3486
|
+
500: ErrorResponse;
|
|
3487
|
+
};
|
|
3488
|
+
export type AddMcpServerError = AddMcpServerErrors[keyof AddMcpServerErrors];
|
|
3489
|
+
export type AddMcpServerResponses = {
|
|
3490
|
+
201: ServerResponse;
|
|
3491
|
+
};
|
|
3492
|
+
export type AddMcpServerResponse = AddMcpServerResponses[keyof AddMcpServerResponses];
|
|
3493
|
+
export type UpdateMcpServerData = {
|
|
3494
|
+
body: UpdateServerRequest;
|
|
3495
|
+
path?: never;
|
|
3496
|
+
query?: never;
|
|
3497
|
+
url: '/mcp/servers';
|
|
3498
|
+
};
|
|
3499
|
+
export type UpdateMcpServerErrors = {
|
|
3500
|
+
401: string;
|
|
3501
|
+
404: ErrorResponse;
|
|
3502
|
+
500: ErrorResponse;
|
|
3503
|
+
};
|
|
3504
|
+
export type UpdateMcpServerError = UpdateMcpServerErrors[keyof UpdateMcpServerErrors];
|
|
3505
|
+
export type UpdateMcpServerResponses = {
|
|
3506
|
+
200: ServerResponse;
|
|
3507
|
+
};
|
|
3508
|
+
export type UpdateMcpServerResponse = UpdateMcpServerResponses[keyof UpdateMcpServerResponses];
|
|
3509
|
+
export type McpAuthCallbackData = {
|
|
3510
|
+
body?: never;
|
|
3511
|
+
path?: never;
|
|
3512
|
+
query?: {
|
|
3513
|
+
/**
|
|
3514
|
+
* Authorization code from the OAuth provider. Present on success.
|
|
3515
|
+
*/
|
|
3516
|
+
code?: string;
|
|
3517
|
+
/**
|
|
3518
|
+
* CSRF state parameter.
|
|
3519
|
+
*/
|
|
3520
|
+
state?: string;
|
|
3521
|
+
/**
|
|
3522
|
+
* OAuth error code from the provider, e.g. `access_denied`. Present on failure.
|
|
3523
|
+
*/
|
|
3524
|
+
error?: string;
|
|
3525
|
+
/**
|
|
3526
|
+
* Human-readable error description from the provider.
|
|
3527
|
+
*/
|
|
3528
|
+
error_description?: string;
|
|
3529
|
+
};
|
|
3530
|
+
url: '/mcp/servers/auth/callback';
|
|
3531
|
+
};
|
|
3532
|
+
export type McpAuthCallbackErrors = {
|
|
3533
|
+
/**
|
|
3534
|
+
* Provider rejected authorization, or the callback was malformed
|
|
3535
|
+
*/
|
|
3536
|
+
400: ErrorResponse;
|
|
3537
|
+
500: ErrorResponse;
|
|
3538
|
+
};
|
|
3539
|
+
export type McpAuthCallbackError = McpAuthCallbackErrors[keyof McpAuthCallbackErrors];
|
|
3540
|
+
export type McpAuthCallbackResponses = {
|
|
3541
|
+
/**
|
|
3542
|
+
* OAuth flow completed successfully
|
|
3543
|
+
*/
|
|
3544
|
+
200: unknown;
|
|
3545
|
+
};
|
|
3546
|
+
export type McpOauthClientMetadataData = {
|
|
3547
|
+
body?: never;
|
|
3548
|
+
path?: never;
|
|
3549
|
+
query?: never;
|
|
3550
|
+
url: '/mcp/servers/auth/client-metadata';
|
|
3551
|
+
};
|
|
3552
|
+
export type McpOauthClientMetadataResponses = {
|
|
3553
|
+
/**
|
|
3554
|
+
* Rox OAuth client metadata document
|
|
3555
|
+
*/
|
|
3556
|
+
200: unknown;
|
|
3557
|
+
};
|
|
3558
|
+
export type StartMcpAuthData = {
|
|
3559
|
+
body: StartAuthRequest;
|
|
3560
|
+
path?: never;
|
|
3561
|
+
query?: never;
|
|
3562
|
+
url: '/mcp/servers/auth/start';
|
|
3563
|
+
};
|
|
3564
|
+
export type StartMcpAuthErrors = {
|
|
3565
|
+
401: string;
|
|
3566
|
+
500: ErrorResponse;
|
|
3567
|
+
};
|
|
3568
|
+
export type StartMcpAuthError = StartMcpAuthErrors[keyof StartMcpAuthErrors];
|
|
3569
|
+
export type StartMcpAuthResponses = {
|
|
3570
|
+
200: StartAuthResponse;
|
|
3571
|
+
};
|
|
3572
|
+
export type StartMcpAuthResponse = StartMcpAuthResponses[keyof StartMcpAuthResponses];
|
|
3573
|
+
export type GetMemoryHandlerData = {
|
|
3574
|
+
body?: never;
|
|
3575
|
+
path?: never;
|
|
3576
|
+
query?: never;
|
|
3577
|
+
url: '/memory';
|
|
3578
|
+
};
|
|
3579
|
+
export type GetMemoryHandlerErrors = {
|
|
3580
|
+
/**
|
|
3581
|
+
* No composed memory exists for this user yet
|
|
3582
|
+
*/
|
|
3583
|
+
404: unknown;
|
|
3584
|
+
/**
|
|
3585
|
+
* Internal server error
|
|
3586
|
+
*/
|
|
3587
|
+
500: MemoryErrorBody;
|
|
3588
|
+
};
|
|
3589
|
+
export type GetMemoryHandlerError = GetMemoryHandlerErrors[keyof GetMemoryHandlerErrors];
|
|
3590
|
+
export type GetMemoryHandlerResponses = {
|
|
3591
|
+
/**
|
|
3592
|
+
* Latest memory for the user
|
|
3593
|
+
*/
|
|
3594
|
+
200: MemoryResponse;
|
|
3595
|
+
};
|
|
3596
|
+
export type GetMemoryHandlerResponse = GetMemoryHandlerResponses[keyof GetMemoryHandlerResponses];
|
|
3597
|
+
export type GetUserActivityData = {
|
|
3598
|
+
body?: never;
|
|
3599
|
+
path?: never;
|
|
3600
|
+
query: {
|
|
3601
|
+
/**
|
|
3602
|
+
* A `macro|` user id; omit for the caller.
|
|
3603
|
+
*/
|
|
3604
|
+
user?: string;
|
|
3605
|
+
/**
|
|
3606
|
+
* Inclusive first UTC date.
|
|
3607
|
+
*/
|
|
3608
|
+
start: string;
|
|
3609
|
+
/**
|
|
3610
|
+
* Inclusive last UTC date, at most 366 days after `start`.
|
|
3611
|
+
*/
|
|
3612
|
+
end: string;
|
|
3613
|
+
};
|
|
3614
|
+
url: '/memory/activity';
|
|
3615
|
+
};
|
|
3616
|
+
export type GetUserActivityErrors = {
|
|
3617
|
+
/**
|
|
3618
|
+
* Invalid user id or date range
|
|
3619
|
+
*/
|
|
3620
|
+
400: MemoryErrorBody;
|
|
3621
|
+
/**
|
|
3622
|
+
* The user is not the caller or a current teammate
|
|
3623
|
+
*/
|
|
3624
|
+
403: MemoryErrorBody;
|
|
3625
|
+
/**
|
|
3626
|
+
* Internal server error
|
|
3627
|
+
*/
|
|
3628
|
+
500: MemoryErrorBody;
|
|
3629
|
+
};
|
|
3630
|
+
export type GetUserActivityError = GetUserActivityErrors[keyof GetUserActivityErrors];
|
|
3631
|
+
export type GetUserActivityResponses = {
|
|
3632
|
+
/**
|
|
3633
|
+
* Activity reports in the range
|
|
3634
|
+
*/
|
|
3635
|
+
200: ActivityReports;
|
|
3636
|
+
};
|
|
3637
|
+
export type GetUserActivityResponse = GetUserActivityResponses[keyof GetUserActivityResponses];
|
|
3638
|
+
export type ReadExplicitMemoryData = {
|
|
3639
|
+
body?: never;
|
|
3640
|
+
path?: never;
|
|
3641
|
+
query?: never;
|
|
3642
|
+
url: '/memory/explicit';
|
|
3643
|
+
};
|
|
3644
|
+
export type ReadExplicitMemoryErrors = {
|
|
3645
|
+
/**
|
|
3646
|
+
* Internal server error
|
|
3647
|
+
*/
|
|
3648
|
+
500: MemoryErrorBody;
|
|
3649
|
+
};
|
|
3650
|
+
export type ReadExplicitMemoryError = ReadExplicitMemoryErrors[keyof ReadExplicitMemoryErrors];
|
|
3651
|
+
export type ReadExplicitMemoryResponses = {
|
|
3652
|
+
/**
|
|
3653
|
+
* The caller's explicit memory
|
|
3654
|
+
*/
|
|
3655
|
+
200: ExplicitMemory;
|
|
3656
|
+
};
|
|
3657
|
+
export type ReadExplicitMemoryResponse = ReadExplicitMemoryResponses[keyof ReadExplicitMemoryResponses];
|
|
3658
|
+
export type EditExplicitMemoryData = {
|
|
3659
|
+
body: UpdateExplicitMemoryRequest;
|
|
3660
|
+
path?: never;
|
|
3661
|
+
query?: never;
|
|
3662
|
+
url: '/memory/explicit';
|
|
3663
|
+
};
|
|
3664
|
+
export type EditExplicitMemoryErrors = {
|
|
3665
|
+
/**
|
|
3666
|
+
* Invalid line or content
|
|
3667
|
+
*/
|
|
3668
|
+
400: MemoryErrorBody;
|
|
3669
|
+
/**
|
|
3670
|
+
* The revision is stale
|
|
3671
|
+
*/
|
|
3672
|
+
409: MemoryErrorBody;
|
|
3673
|
+
/**
|
|
3674
|
+
* Rejected by privacy review
|
|
3675
|
+
*/
|
|
3676
|
+
422: MemoryErrorBody;
|
|
3677
|
+
/**
|
|
3678
|
+
* Internal server error
|
|
3679
|
+
*/
|
|
3680
|
+
500: MemoryErrorBody;
|
|
3681
|
+
/**
|
|
3682
|
+
* Privacy review is unavailable; nothing was saved
|
|
3683
|
+
*/
|
|
3684
|
+
503: MemoryErrorBody;
|
|
3685
|
+
};
|
|
3686
|
+
export type EditExplicitMemoryError = EditExplicitMemoryErrors[keyof EditExplicitMemoryErrors];
|
|
3687
|
+
export type EditExplicitMemoryResponses = {
|
|
3688
|
+
/**
|
|
3689
|
+
* The edited explicit memory
|
|
3690
|
+
*/
|
|
3691
|
+
200: ExplicitMemory;
|
|
3692
|
+
};
|
|
3693
|
+
export type EditExplicitMemoryResponse = EditExplicitMemoryResponses[keyof EditExplicitMemoryResponses];
|
|
3694
|
+
export type GetStateHandler2Data = {
|
|
3695
|
+
body?: never;
|
|
3696
|
+
path?: never;
|
|
3697
|
+
query?: never;
|
|
3698
|
+
url: '/onboarding';
|
|
3699
|
+
};
|
|
3700
|
+
export type GetStateHandler2Errors = {
|
|
3701
|
+
/**
|
|
3702
|
+
* Internal server error
|
|
3703
|
+
*/
|
|
3704
|
+
500: unknown;
|
|
3705
|
+
};
|
|
3706
|
+
export type GetStateHandler2Responses = {
|
|
3707
|
+
/**
|
|
3708
|
+
* Current onboarding state
|
|
3709
|
+
*/
|
|
3710
|
+
200: OnboardingState;
|
|
3711
|
+
};
|
|
3712
|
+
export type GetStateHandler2Response = GetStateHandler2Responses[keyof GetStateHandler2Responses];
|
|
3713
|
+
export type CompleteHandlerData = {
|
|
3714
|
+
body: CompleteOnboardingRequest;
|
|
3715
|
+
path?: never;
|
|
3716
|
+
query?: never;
|
|
3717
|
+
url: '/onboarding/complete';
|
|
3718
|
+
};
|
|
3719
|
+
export type CompleteHandlerErrors = {
|
|
3720
|
+
/**
|
|
3721
|
+
* Internal server error
|
|
3722
|
+
*/
|
|
3723
|
+
500: unknown;
|
|
3724
|
+
};
|
|
3725
|
+
export type CompleteHandlerResponses = {
|
|
3726
|
+
/**
|
|
3727
|
+
* Completed onboarding row
|
|
3728
|
+
*/
|
|
3729
|
+
200: OnboardingRow;
|
|
3730
|
+
};
|
|
3731
|
+
export type CompleteHandlerResponse = CompleteHandlerResponses[keyof CompleteHandlerResponses];
|
|
3732
|
+
export type DismissedPromptsHandlerData = {
|
|
3733
|
+
body?: never;
|
|
3734
|
+
path?: never;
|
|
3735
|
+
query?: never;
|
|
3736
|
+
url: '/onboarding/prompts';
|
|
3737
|
+
};
|
|
3738
|
+
export type DismissedPromptsHandlerErrors = {
|
|
3739
|
+
/**
|
|
3740
|
+
* Internal server error
|
|
3741
|
+
*/
|
|
3742
|
+
500: unknown;
|
|
3743
|
+
};
|
|
3744
|
+
export type DismissedPromptsHandlerResponses = {
|
|
3745
|
+
/**
|
|
3746
|
+
* Dismissed prompt ids
|
|
3747
|
+
*/
|
|
3748
|
+
200: DismissedPrompts;
|
|
3749
|
+
};
|
|
3750
|
+
export type DismissedPromptsHandlerResponse = DismissedPromptsHandlerResponses[keyof DismissedPromptsHandlerResponses];
|
|
3751
|
+
export type DismissPromptHandlerData = {
|
|
3752
|
+
body?: never;
|
|
3753
|
+
path: {
|
|
3754
|
+
/**
|
|
3755
|
+
* Prompt id, e.g. `import:files`
|
|
3756
|
+
*/
|
|
3757
|
+
prompt_id: string;
|
|
3758
|
+
};
|
|
3759
|
+
query?: never;
|
|
3760
|
+
url: '/onboarding/prompts/{prompt_id}/dismiss';
|
|
3761
|
+
};
|
|
3762
|
+
export type DismissPromptHandlerErrors = {
|
|
3763
|
+
/**
|
|
3764
|
+
* Malformed prompt id
|
|
3765
|
+
*/
|
|
3766
|
+
400: unknown;
|
|
3767
|
+
/**
|
|
3768
|
+
* Internal server error
|
|
3769
|
+
*/
|
|
3770
|
+
500: unknown;
|
|
3771
|
+
};
|
|
3772
|
+
export type DismissPromptHandlerResponses = {
|
|
3773
|
+
/**
|
|
3774
|
+
* Dismissed
|
|
3775
|
+
*/
|
|
3776
|
+
204: void;
|
|
3777
|
+
};
|
|
3778
|
+
export type DismissPromptHandlerResponse = DismissPromptHandlerResponses[keyof DismissPromptHandlerResponses];
|
|
3779
|
+
export type BrowsePipedreamMcpCatalogData = {
|
|
3780
|
+
body?: never;
|
|
3781
|
+
path?: never;
|
|
3782
|
+
query?: {
|
|
3783
|
+
/**
|
|
3784
|
+
* Search query to filter apps by name. Omit to browse.
|
|
3785
|
+
*/
|
|
3786
|
+
search?: string;
|
|
3787
|
+
/**
|
|
3788
|
+
* Opaque pagination cursor from a previous response.
|
|
3789
|
+
*/
|
|
3790
|
+
cursor?: string;
|
|
3791
|
+
/**
|
|
3792
|
+
* Page size (default 20, max 50).
|
|
3793
|
+
*/
|
|
3794
|
+
limit?: number;
|
|
3795
|
+
};
|
|
3796
|
+
url: '/pipedream/mcp/catalog';
|
|
3797
|
+
};
|
|
3798
|
+
export type BrowsePipedreamMcpCatalogErrors = {
|
|
3799
|
+
401: string;
|
|
3800
|
+
500: ErrorResponse;
|
|
3801
|
+
501: ErrorResponse;
|
|
3802
|
+
};
|
|
3803
|
+
export type BrowsePipedreamMcpCatalogError = BrowsePipedreamMcpCatalogErrors[keyof BrowsePipedreamMcpCatalogErrors];
|
|
3804
|
+
export type BrowsePipedreamMcpCatalogResponses = {
|
|
3805
|
+
200: PipedreamCatalogResponse;
|
|
3806
|
+
};
|
|
3807
|
+
export type BrowsePipedreamMcpCatalogResponse = BrowsePipedreamMcpCatalogResponses[keyof BrowsePipedreamMcpCatalogResponses];
|
|
3808
|
+
export type CompletePipedreamMcpConnectionData = {
|
|
3809
|
+
body: PipedreamCompleteRequest;
|
|
3810
|
+
path?: never;
|
|
3811
|
+
query?: never;
|
|
3812
|
+
url: '/pipedream/mcp/complete';
|
|
3813
|
+
};
|
|
3814
|
+
export type CompletePipedreamMcpConnectionErrors = {
|
|
3815
|
+
401: string;
|
|
3816
|
+
404: ErrorResponse;
|
|
3817
|
+
409: ErrorResponse;
|
|
3818
|
+
500: ErrorResponse;
|
|
3819
|
+
501: ErrorResponse;
|
|
3820
|
+
};
|
|
3821
|
+
export type CompletePipedreamMcpConnectionError = CompletePipedreamMcpConnectionErrors[keyof CompletePipedreamMcpConnectionErrors];
|
|
3822
|
+
export type CompletePipedreamMcpConnectionResponses = {
|
|
3823
|
+
200: PipedreamConnectionResponse;
|
|
3824
|
+
};
|
|
3825
|
+
export type CompletePipedreamMcpConnectionResponse = CompletePipedreamMcpConnectionResponses[keyof CompletePipedreamMcpConnectionResponses];
|
|
3826
|
+
export type CompletePipedreamMcpConnectData = {
|
|
3827
|
+
body: PipedreamConnectCompleteRequest;
|
|
3828
|
+
path?: never;
|
|
3829
|
+
query?: never;
|
|
3830
|
+
url: '/pipedream/mcp/connect/complete';
|
|
3831
|
+
};
|
|
3832
|
+
export type CompletePipedreamMcpConnectErrors = {
|
|
3833
|
+
401: string;
|
|
3834
|
+
404: ErrorResponse;
|
|
3835
|
+
500: ErrorResponse;
|
|
3836
|
+
501: ErrorResponse;
|
|
3837
|
+
};
|
|
3838
|
+
export type CompletePipedreamMcpConnectError = CompletePipedreamMcpConnectErrors[keyof CompletePipedreamMcpConnectErrors];
|
|
3839
|
+
export type CompletePipedreamMcpConnectResponses = {
|
|
3840
|
+
200: PipedreamConnectionResponse;
|
|
3841
|
+
};
|
|
3842
|
+
export type CompletePipedreamMcpConnectResponse = CompletePipedreamMcpConnectResponses[keyof CompletePipedreamMcpConnectResponses];
|
|
3843
|
+
export type DeletePipedreamMcpConnectionData = {
|
|
3844
|
+
body?: never;
|
|
3845
|
+
path?: never;
|
|
3846
|
+
query: {
|
|
3847
|
+
/**
|
|
3848
|
+
* The app slug to disconnect.
|
|
3849
|
+
*/
|
|
3850
|
+
app_slug: string;
|
|
3851
|
+
};
|
|
3852
|
+
url: '/pipedream/mcp/connections';
|
|
3853
|
+
};
|
|
3854
|
+
export type DeletePipedreamMcpConnectionErrors = {
|
|
3855
|
+
401: string;
|
|
3856
|
+
500: ErrorResponse;
|
|
3857
|
+
};
|
|
3858
|
+
export type DeletePipedreamMcpConnectionError = DeletePipedreamMcpConnectionErrors[keyof DeletePipedreamMcpConnectionErrors];
|
|
3859
|
+
export type DeletePipedreamMcpConnectionResponses = {
|
|
3860
|
+
204: void;
|
|
3861
|
+
};
|
|
3862
|
+
export type DeletePipedreamMcpConnectionResponse = DeletePipedreamMcpConnectionResponses[keyof DeletePipedreamMcpConnectionResponses];
|
|
3863
|
+
export type ListPipedreamMcpConnectionsData = {
|
|
3864
|
+
body?: never;
|
|
3865
|
+
path?: never;
|
|
3866
|
+
query?: never;
|
|
3867
|
+
url: '/pipedream/mcp/connections';
|
|
3868
|
+
};
|
|
3869
|
+
export type ListPipedreamMcpConnectionsErrors = {
|
|
3870
|
+
401: string;
|
|
3871
|
+
500: ErrorResponse;
|
|
3872
|
+
};
|
|
3873
|
+
export type ListPipedreamMcpConnectionsError = ListPipedreamMcpConnectionsErrors[keyof ListPipedreamMcpConnectionsErrors];
|
|
3874
|
+
export type ListPipedreamMcpConnectionsResponses = {
|
|
3875
|
+
200: Array<PipedreamConnectionResponse>;
|
|
3876
|
+
};
|
|
3877
|
+
export type ListPipedreamMcpConnectionsResponse = ListPipedreamMcpConnectionsResponses[keyof ListPipedreamMcpConnectionsResponses];
|
|
3878
|
+
export type UpdatePipedreamMcpConnectionData = {
|
|
3879
|
+
body: PipedreamUpdateRequest;
|
|
3880
|
+
path?: never;
|
|
3881
|
+
query?: never;
|
|
3882
|
+
url: '/pipedream/mcp/connections';
|
|
3883
|
+
};
|
|
3884
|
+
export type UpdatePipedreamMcpConnectionErrors = {
|
|
3885
|
+
401: string;
|
|
3886
|
+
404: ErrorResponse;
|
|
3887
|
+
500: ErrorResponse;
|
|
3888
|
+
};
|
|
3889
|
+
export type UpdatePipedreamMcpConnectionError = UpdatePipedreamMcpConnectionErrors[keyof UpdatePipedreamMcpConnectionErrors];
|
|
3890
|
+
export type UpdatePipedreamMcpConnectionResponses = {
|
|
3891
|
+
200: PipedreamConnectionResponse;
|
|
3892
|
+
};
|
|
3893
|
+
export type UpdatePipedreamMcpConnectionResponse = UpdatePipedreamMcpConnectionResponses[keyof UpdatePipedreamMcpConnectionResponses];
|
|
3894
|
+
export type ListPipedreamMcpOverlaysData = {
|
|
3895
|
+
body?: never;
|
|
3896
|
+
path?: never;
|
|
3897
|
+
query?: never;
|
|
3898
|
+
url: '/pipedream/mcp/overlays';
|
|
3899
|
+
};
|
|
3900
|
+
export type ListPipedreamMcpOverlaysErrors = {
|
|
3901
|
+
401: string;
|
|
3902
|
+
500: ErrorResponse;
|
|
3903
|
+
};
|
|
3904
|
+
export type ListPipedreamMcpOverlaysError = ListPipedreamMcpOverlaysErrors[keyof ListPipedreamMcpOverlaysErrors];
|
|
3905
|
+
export type ListPipedreamMcpOverlaysResponses = {
|
|
3906
|
+
200: Array<PipedreamOverlayResponse>;
|
|
3907
|
+
};
|
|
3908
|
+
export type ListPipedreamMcpOverlaysResponse = ListPipedreamMcpOverlaysResponses[keyof ListPipedreamMcpOverlaysResponses];
|
|
3909
|
+
export type RecoverPipedreamMcpConnectionData = {
|
|
3910
|
+
body: PipedreamRecoverRequest;
|
|
3911
|
+
path?: never;
|
|
3912
|
+
query?: never;
|
|
3913
|
+
url: '/pipedream/mcp/recover';
|
|
3914
|
+
};
|
|
3915
|
+
export type RecoverPipedreamMcpConnectionErrors = {
|
|
3916
|
+
401: string;
|
|
3917
|
+
404: ErrorResponse;
|
|
3918
|
+
409: ErrorResponse;
|
|
3919
|
+
500: ErrorResponse;
|
|
3920
|
+
501: ErrorResponse;
|
|
3921
|
+
};
|
|
3922
|
+
export type RecoverPipedreamMcpConnectionError = RecoverPipedreamMcpConnectionErrors[keyof RecoverPipedreamMcpConnectionErrors];
|
|
3923
|
+
export type RecoverPipedreamMcpConnectionResponses = {
|
|
3924
|
+
200: PipedreamConnectionResponse;
|
|
3925
|
+
};
|
|
3926
|
+
export type RecoverPipedreamMcpConnectionResponse = RecoverPipedreamMcpConnectionResponses[keyof RecoverPipedreamMcpConnectionResponses];
|
|
3927
|
+
export type CreatePipedreamMcpTokenData = {
|
|
3928
|
+
body?: null | PipedreamTokenRequest;
|
|
3929
|
+
path?: never;
|
|
3930
|
+
query?: never;
|
|
3931
|
+
url: '/pipedream/mcp/token';
|
|
3932
|
+
};
|
|
3933
|
+
export type CreatePipedreamMcpTokenErrors = {
|
|
3934
|
+
401: string;
|
|
3935
|
+
500: ErrorResponse;
|
|
3936
|
+
501: ErrorResponse;
|
|
3937
|
+
};
|
|
3938
|
+
export type CreatePipedreamMcpTokenError = CreatePipedreamMcpTokenErrors[keyof CreatePipedreamMcpTokenErrors];
|
|
3939
|
+
export type CreatePipedreamMcpTokenResponses = {
|
|
3940
|
+
200: PipedreamTokenResponse;
|
|
3941
|
+
};
|
|
3942
|
+
export type CreatePipedreamMcpTokenResponse = CreatePipedreamMcpTokenResponses[keyof CreatePipedreamMcpTokenResponses];
|
|
3943
|
+
export type GetBatchPreviewData = {
|
|
3944
|
+
body: GetBatchPreviewRequest;
|
|
3945
|
+
path?: never;
|
|
3946
|
+
query?: never;
|
|
3947
|
+
url: '/preview';
|
|
3948
|
+
};
|
|
3949
|
+
export type GetBatchPreviewErrors = {
|
|
3950
|
+
401: string;
|
|
3951
|
+
500: string;
|
|
3952
|
+
};
|
|
3953
|
+
export type GetBatchPreviewError = GetBatchPreviewErrors[keyof GetBatchPreviewErrors];
|
|
3954
|
+
export type GetBatchPreviewResponses = {
|
|
3955
|
+
200: GetBatchPreviewResponse;
|
|
3956
|
+
};
|
|
3957
|
+
export type GetBatchPreviewResponse2 = GetBatchPreviewResponses[keyof GetBatchPreviewResponses];
|
|
3958
|
+
export type ListSkillsData = {
|
|
3959
|
+
body?: never;
|
|
3960
|
+
path?: never;
|
|
3961
|
+
query?: {
|
|
3962
|
+
/**
|
|
3963
|
+
* Words from the skill's name, matched as one adjacent phrase. Omit to
|
|
3964
|
+
* list the 100 most recently updated skills.
|
|
3965
|
+
*/
|
|
3966
|
+
query?: string;
|
|
3967
|
+
/**
|
|
3968
|
+
* How `query` is matched; `partial` when omitted.
|
|
3969
|
+
*/
|
|
3970
|
+
matchType?: SkillsMatchType;
|
|
3971
|
+
};
|
|
3972
|
+
url: '/skills';
|
|
3973
|
+
};
|
|
3974
|
+
export type ListSkillsErrors = {
|
|
3975
|
+
/**
|
|
3976
|
+
* Blank query
|
|
3977
|
+
*/
|
|
3978
|
+
400: SkillErrorBody;
|
|
3979
|
+
/**
|
|
3980
|
+
* Unauthorized
|
|
3981
|
+
*/
|
|
3982
|
+
401: unknown;
|
|
3983
|
+
/**
|
|
3984
|
+
* Listing failed
|
|
3985
|
+
*/
|
|
3986
|
+
500: SkillErrorBody;
|
|
3987
|
+
/**
|
|
3988
|
+
* Search failed
|
|
3989
|
+
*/
|
|
3990
|
+
502: SkillErrorBody;
|
|
3991
|
+
};
|
|
3992
|
+
export type ListSkillsError = ListSkillsErrors[keyof ListSkillsErrors];
|
|
3993
|
+
export type ListSkillsResponses = {
|
|
3994
|
+
/**
|
|
3995
|
+
* Matching skills, most recently updated first
|
|
3996
|
+
*/
|
|
3997
|
+
200: SkillsResponse;
|
|
3998
|
+
};
|
|
3999
|
+
export type ListSkillsResponse = ListSkillsResponses[keyof ListSkillsResponses];
|
|
4000
|
+
export type ReadSkillData = {
|
|
4001
|
+
body?: never;
|
|
4002
|
+
path: {
|
|
4003
|
+
/**
|
|
4004
|
+
* The skill's id
|
|
4005
|
+
*/
|
|
4006
|
+
id: string;
|
|
4007
|
+
};
|
|
4008
|
+
query?: never;
|
|
4009
|
+
url: '/skills/{id}';
|
|
4010
|
+
};
|
|
4011
|
+
export type ReadSkillErrors = {
|
|
4012
|
+
/**
|
|
4013
|
+
* Unauthorized
|
|
4014
|
+
*/
|
|
4015
|
+
401: unknown;
|
|
4016
|
+
/**
|
|
4017
|
+
* No skill the caller can view has this id
|
|
4018
|
+
*/
|
|
4019
|
+
404: SkillErrorBody;
|
|
4020
|
+
/**
|
|
4021
|
+
* Reading failed
|
|
4022
|
+
*/
|
|
4023
|
+
500: SkillErrorBody;
|
|
4024
|
+
/**
|
|
4025
|
+
* Access check unavailable
|
|
4026
|
+
*/
|
|
4027
|
+
503: SkillErrorBody;
|
|
4028
|
+
};
|
|
4029
|
+
export type ReadSkillError = ReadSkillErrors[keyof ReadSkillErrors];
|
|
4030
|
+
export type ReadSkillResponses = {
|
|
4031
|
+
/**
|
|
4032
|
+
* The skill's instructions
|
|
4033
|
+
*/
|
|
4034
|
+
200: SkillContentResponse;
|
|
4035
|
+
};
|
|
4036
|
+
export type ReadSkillResponse = ReadSkillResponses[keyof ReadSkillResponses];
|
|
4037
|
+
export type SendChatMessageData = {
|
|
4038
|
+
body: HttpSendChatMessageRequest;
|
|
4039
|
+
path?: never;
|
|
4040
|
+
query?: never;
|
|
4041
|
+
url: '/stream/chat/message';
|
|
4042
|
+
};
|
|
4043
|
+
export type SendChatMessageErrors = {
|
|
4044
|
+
/**
|
|
4045
|
+
* Bad request
|
|
4046
|
+
*/
|
|
4047
|
+
400: ChatMessageError;
|
|
4048
|
+
/**
|
|
4049
|
+
* Unauthorized
|
|
4050
|
+
*/
|
|
4051
|
+
401: unknown;
|
|
4052
|
+
/**
|
|
4053
|
+
* Payment required — the user's AI allowance is used up
|
|
4054
|
+
*/
|
|
4055
|
+
402: ChatMessageError;
|
|
4056
|
+
/**
|
|
4057
|
+
* Forbidden — user lacks access to the requested model
|
|
4058
|
+
*/
|
|
4059
|
+
403: ChatMessageError;
|
|
4060
|
+
/**
|
|
4061
|
+
* AI usage validation unavailable — retry later
|
|
4062
|
+
*/
|
|
4063
|
+
503: ChatMessageError;
|
|
4064
|
+
};
|
|
4065
|
+
export type SendChatMessageError = SendChatMessageErrors[keyof SendChatMessageErrors];
|
|
4066
|
+
export type SendChatMessageResponses = {
|
|
4067
|
+
/**
|
|
4068
|
+
* Stream initiated successfully
|
|
4069
|
+
*/
|
|
4070
|
+
200: SendChatMessageResponse;
|
|
4071
|
+
};
|
|
4072
|
+
export type SendChatMessageResponse2 = SendChatMessageResponses[keyof SendChatMessageResponses];
|
|
4073
|
+
export type StopChatStreamData = {
|
|
4074
|
+
body: StopChatStreamRequest;
|
|
4075
|
+
path?: never;
|
|
4076
|
+
query?: never;
|
|
4077
|
+
url: '/stream/chat/message/stop';
|
|
4078
|
+
};
|
|
4079
|
+
export type StopChatStreamErrors = {
|
|
4080
|
+
/**
|
|
4081
|
+
* Forbidden
|
|
4082
|
+
*/
|
|
4083
|
+
403: StopChatStreamError;
|
|
4084
|
+
};
|
|
4085
|
+
export type StopChatStreamError2 = StopChatStreamErrors[keyof StopChatStreamErrors];
|
|
4086
|
+
export type StopChatStreamResponses = {
|
|
4087
|
+
/**
|
|
4088
|
+
* Stop signal sent (or stream already finished)
|
|
4089
|
+
*/
|
|
4090
|
+
200: StopChatStreamResponse;
|
|
4091
|
+
};
|
|
4092
|
+
export type StopChatStreamResponse2 = StopChatStreamResponses[keyof StopChatStreamResponses];
|
|
4093
|
+
export type StructuredCompletionData = {
|
|
4094
|
+
body: StructuredCompletionRequest;
|
|
4095
|
+
path?: never;
|
|
4096
|
+
query?: never;
|
|
4097
|
+
url: '/structured-completion';
|
|
4098
|
+
};
|
|
4099
|
+
export type StructuredCompletionErrors = {
|
|
4100
|
+
/**
|
|
4101
|
+
* Bad request
|
|
4102
|
+
*/
|
|
4103
|
+
400: StructuredCompletionError;
|
|
4104
|
+
/**
|
|
4105
|
+
* Unauthorized
|
|
4106
|
+
*/
|
|
4107
|
+
401: unknown;
|
|
4108
|
+
/**
|
|
4109
|
+
* Payment required
|
|
4110
|
+
*/
|
|
4111
|
+
402: StructuredCompletionError;
|
|
4112
|
+
/**
|
|
4113
|
+
* No access to the requested model
|
|
4114
|
+
*/
|
|
4115
|
+
403: StructuredCompletionError;
|
|
4116
|
+
/**
|
|
4117
|
+
* Internal error
|
|
4118
|
+
*/
|
|
4119
|
+
500: StructuredCompletionError;
|
|
4120
|
+
/**
|
|
4121
|
+
* AI usage validation unavailable — retry later
|
|
4122
|
+
*/
|
|
4123
|
+
503: StructuredCompletionError;
|
|
4124
|
+
/**
|
|
4125
|
+
* Tool-free completion deadline exceeded
|
|
4126
|
+
*/
|
|
4127
|
+
504: StructuredCompletionError;
|
|
4128
|
+
};
|
|
4129
|
+
export type StructuredCompletionError2 = StructuredCompletionErrors[keyof StructuredCompletionErrors];
|
|
4130
|
+
export type StructuredCompletionResponses = {
|
|
4131
|
+
/**
|
|
4132
|
+
* Structured completion result
|
|
4133
|
+
*/
|
|
4134
|
+
200: StructuredCompletionResponse;
|
|
4135
|
+
};
|
|
4136
|
+
export type StructuredCompletionResponse2 = StructuredCompletionResponses[keyof StructuredCompletionResponses];
|
|
4137
|
+
export type FetchWebPageData = {
|
|
4138
|
+
body: WebFetch;
|
|
4139
|
+
path?: never;
|
|
4140
|
+
query?: never;
|
|
4141
|
+
url: '/web/fetch';
|
|
4142
|
+
};
|
|
4143
|
+
export type FetchWebPageErrors = {
|
|
4144
|
+
/**
|
|
4145
|
+
* Invalid URL or length
|
|
4146
|
+
*/
|
|
4147
|
+
400: WebErrorBody;
|
|
4148
|
+
/**
|
|
4149
|
+
* Unauthorized
|
|
4150
|
+
*/
|
|
4151
|
+
401: unknown;
|
|
4152
|
+
/**
|
|
4153
|
+
* AI allowance exhausted
|
|
4154
|
+
*/
|
|
4155
|
+
402: WebErrorBody;
|
|
4156
|
+
/**
|
|
4157
|
+
* Web fetch is not configured in this deployment
|
|
4158
|
+
*/
|
|
4159
|
+
404: WebErrorBody;
|
|
4160
|
+
/**
|
|
4161
|
+
* The page could not be read
|
|
4162
|
+
*/
|
|
4163
|
+
422: WebErrorBody;
|
|
4164
|
+
/**
|
|
4165
|
+
* Per-user hourly rate limit exceeded
|
|
4166
|
+
*/
|
|
4167
|
+
429: unknown;
|
|
4168
|
+
/**
|
|
4169
|
+
* The fetch provider failed
|
|
4170
|
+
*/
|
|
4171
|
+
502: WebErrorBody;
|
|
4172
|
+
/**
|
|
4173
|
+
* Web fetch busy, or usage validation unavailable
|
|
4174
|
+
*/
|
|
4175
|
+
503: WebErrorBody;
|
|
4176
|
+
};
|
|
4177
|
+
export type FetchWebPageError = FetchWebPageErrors[keyof FetchWebPageErrors];
|
|
4178
|
+
export type FetchWebPageResponses = {
|
|
4179
|
+
/**
|
|
4180
|
+
* The page text
|
|
4181
|
+
*/
|
|
4182
|
+
200: WebFetchResponse;
|
|
4183
|
+
};
|
|
4184
|
+
export type FetchWebPageResponse = FetchWebPageResponses[keyof FetchWebPageResponses];
|
|
4185
|
+
export type SearchWebData = {
|
|
4186
|
+
body: WebSearch;
|
|
4187
|
+
path?: never;
|
|
4188
|
+
query?: never;
|
|
4189
|
+
url: '/web/search';
|
|
4190
|
+
};
|
|
4191
|
+
export type SearchWebErrors = {
|
|
4192
|
+
/**
|
|
4193
|
+
* Invalid query or filters
|
|
4194
|
+
*/
|
|
4195
|
+
400: WebErrorBody;
|
|
4196
|
+
/**
|
|
4197
|
+
* Unauthorized
|
|
4198
|
+
*/
|
|
4199
|
+
401: unknown;
|
|
4200
|
+
/**
|
|
4201
|
+
* AI allowance exhausted
|
|
4202
|
+
*/
|
|
4203
|
+
402: WebErrorBody;
|
|
4204
|
+
/**
|
|
4205
|
+
* Web search is not configured in this deployment
|
|
4206
|
+
*/
|
|
4207
|
+
404: WebErrorBody;
|
|
4208
|
+
/**
|
|
4209
|
+
* Per-user hourly rate limit exceeded
|
|
4210
|
+
*/
|
|
4211
|
+
429: unknown;
|
|
4212
|
+
/**
|
|
4213
|
+
* The search provider failed
|
|
4214
|
+
*/
|
|
4215
|
+
502: WebErrorBody;
|
|
4216
|
+
/**
|
|
4217
|
+
* Web search busy, or usage validation unavailable
|
|
4218
|
+
*/
|
|
4219
|
+
503: WebErrorBody;
|
|
4220
|
+
};
|
|
4221
|
+
export type SearchWebError = SearchWebErrors[keyof SearchWebErrors];
|
|
4222
|
+
export type SearchWebResponses = {
|
|
4223
|
+
/**
|
|
4224
|
+
* Results, best match first
|
|
4225
|
+
*/
|
|
4226
|
+
200: WebSearchResponse;
|
|
4227
|
+
};
|
|
4228
|
+
export type SearchWebResponse = SearchWebResponses[keyof SearchWebResponses];
|