@rox-one/sdk 0.0.0-stage → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CALLS.md +82 -0
- package/README.md +1259 -2
- package/dist/chunk-AOHK5YXC.js +5585 -0
- package/dist/chunk-CATFKTFD.js +80 -0
- package/dist/chunk-FQGPXWPJ.js +1491 -0
- package/dist/chunk-G43PLP2U.js +1087 -0
- package/dist/chunk-LMJW65ML.js +836 -0
- package/dist/chunk-MCSQNZ4E.js +836 -0
- package/dist/chunk-NSJ3GKUC.js +1552 -0
- package/dist/chunk-OGFKJOK7.js +2068 -0
- package/dist/chunk-RDEJZJBZ.js +1351 -0
- package/dist/chunk-TMTYN2UK.js +1128 -0
- package/dist/chunk-V45LUJDI.js +838 -0
- package/dist/chunk-YRUXFEZM.js +1044 -0
- package/dist/chunk-ZYBAKW25.js +994 -0
- package/dist/generated/agent-fold/index.d.ts +4520 -0
- package/dist/generated/agent-fold/index.js +0 -0
- package/dist/generated/agent-harness/client/client.gen.d.ts +2 -0
- package/dist/generated/agent-harness/client/index.d.ts +10 -0
- package/dist/generated/agent-harness/client/types.gen.d.ts +120 -0
- package/dist/generated/agent-harness/client/utils.gen.d.ts +37 -0
- package/dist/generated/agent-harness/client.gen.d.ts +12 -0
- package/dist/generated/agent-harness/core/auth.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/params.gen.d.ts +43 -0
- package/dist/generated/agent-harness/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/agent-harness/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/agent-harness/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/agent-harness/core/types.gen.d.ts +83 -0
- package/dist/generated/agent-harness/core/utils.gen.d.ts +19 -0
- package/dist/generated/agent-harness/index.d.ts +2 -0
- package/dist/generated/agent-harness/index.js +6 -0
- package/dist/generated/agent-harness/sdk.gen.d.ts +375 -0
- package/dist/generated/agent-harness/types.gen.d.ts +4725 -0
- package/dist/generated/agent-reviews/index.d.ts +895 -0
- package/dist/generated/agent-reviews/index.js +0 -0
- package/dist/generated/auth/client/client.gen.d.ts +2 -0
- package/dist/generated/auth/client/index.d.ts +10 -0
- package/dist/generated/auth/client/types.gen.d.ts +120 -0
- package/dist/generated/auth/client/utils.gen.d.ts +37 -0
- package/dist/generated/auth/client.gen.d.ts +12 -0
- package/dist/generated/auth/core/auth.gen.d.ts +25 -0
- package/dist/generated/auth/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/auth/core/params.gen.d.ts +43 -0
- package/dist/generated/auth/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/auth/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/auth/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/auth/core/types.gen.d.ts +83 -0
- package/dist/generated/auth/core/utils.gen.d.ts +19 -0
- package/dist/generated/auth/index.d.ts +2 -0
- package/dist/generated/auth/index.js +6 -0
- package/dist/generated/auth/sdk.gen.d.ts +674 -0
- package/dist/generated/auth/types.gen.d.ts +5233 -0
- package/dist/generated/calendar/client/client.gen.d.ts +2 -0
- package/dist/generated/calendar/client/index.d.ts +10 -0
- package/dist/generated/calendar/client/types.gen.d.ts +120 -0
- package/dist/generated/calendar/client/utils.gen.d.ts +37 -0
- package/dist/generated/calendar/client.gen.d.ts +12 -0
- package/dist/generated/calendar/core/auth.gen.d.ts +25 -0
- package/dist/generated/calendar/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/calendar/core/params.gen.d.ts +43 -0
- package/dist/generated/calendar/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/calendar/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/calendar/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/calendar/core/types.gen.d.ts +83 -0
- package/dist/generated/calendar/core/utils.gen.d.ts +19 -0
- package/dist/generated/calendar/index.d.ts +2 -0
- package/dist/generated/calendar/index.js +6 -0
- package/dist/generated/calendar/sdk.gen.d.ts +157 -0
- package/dist/generated/calendar/types.gen.d.ts +2333 -0
- package/dist/generated/cognition/client/client.gen.d.ts +2 -0
- package/dist/generated/cognition/client/index.d.ts +10 -0
- package/dist/generated/cognition/client/types.gen.d.ts +120 -0
- package/dist/generated/cognition/client/utils.gen.d.ts +37 -0
- package/dist/generated/cognition/client.gen.d.ts +12 -0
- package/dist/generated/cognition/core/auth.gen.d.ts +25 -0
- package/dist/generated/cognition/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/cognition/core/params.gen.d.ts +43 -0
- package/dist/generated/cognition/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/cognition/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/cognition/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/cognition/core/types.gen.d.ts +83 -0
- package/dist/generated/cognition/core/utils.gen.d.ts +19 -0
- package/dist/generated/cognition/index.d.ts +2 -0
- package/dist/generated/cognition/index.js +6 -0
- package/dist/generated/cognition/sdk.gen.d.ts +348 -0
- package/dist/generated/cognition/types.gen.d.ts +4228 -0
- package/dist/generated/connection/client/client.gen.d.ts +2 -0
- package/dist/generated/connection/client/index.d.ts +10 -0
- package/dist/generated/connection/client/types.gen.d.ts +120 -0
- package/dist/generated/connection/client/utils.gen.d.ts +37 -0
- package/dist/generated/connection/client.gen.d.ts +12 -0
- package/dist/generated/connection/core/auth.gen.d.ts +25 -0
- package/dist/generated/connection/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/connection/core/params.gen.d.ts +43 -0
- package/dist/generated/connection/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/connection/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/connection/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/connection/core/types.gen.d.ts +83 -0
- package/dist/generated/connection/core/utils.gen.d.ts +19 -0
- package/dist/generated/connection/index.d.ts +2 -0
- package/dist/generated/connection/index.js +854 -0
- package/dist/generated/connection/sdk.gen.d.ts +43 -0
- package/dist/generated/connection/types.gen.d.ts +252 -0
- package/dist/generated/contacts/client/client.gen.d.ts +2 -0
- package/dist/generated/contacts/client/index.d.ts +10 -0
- package/dist/generated/contacts/client/types.gen.d.ts +120 -0
- package/dist/generated/contacts/client/utils.gen.d.ts +37 -0
- package/dist/generated/contacts/client.gen.d.ts +12 -0
- package/dist/generated/contacts/core/auth.gen.d.ts +25 -0
- package/dist/generated/contacts/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/contacts/core/params.gen.d.ts +43 -0
- package/dist/generated/contacts/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/contacts/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/contacts/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/contacts/core/types.gen.d.ts +83 -0
- package/dist/generated/contacts/core/utils.gen.d.ts +19 -0
- package/dist/generated/contacts/index.d.ts +2 -0
- package/dist/generated/contacts/index.js +6 -0
- package/dist/generated/contacts/sdk.gen.d.ts +47 -0
- package/dist/generated/contacts/types.gen.d.ts +108 -0
- package/dist/generated/email/client/client.gen.d.ts +2 -0
- package/dist/generated/email/client/index.d.ts +10 -0
- package/dist/generated/email/client/types.gen.d.ts +120 -0
- package/dist/generated/email/client/utils.gen.d.ts +37 -0
- package/dist/generated/email/client.gen.d.ts +12 -0
- package/dist/generated/email/core/auth.gen.d.ts +25 -0
- package/dist/generated/email/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/email/core/params.gen.d.ts +43 -0
- package/dist/generated/email/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/email/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/email/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/email/core/types.gen.d.ts +83 -0
- package/dist/generated/email/core/utils.gen.d.ts +19 -0
- package/dist/generated/email/index.d.ts +2 -0
- package/dist/generated/email/index.js +6 -0
- package/dist/generated/email/sdk.gen.d.ts +301 -0
- package/dist/generated/email/types.gen.d.ts +3262 -0
- package/dist/generated/notification/client/client.gen.d.ts +2 -0
- package/dist/generated/notification/client/index.d.ts +10 -0
- package/dist/generated/notification/client/types.gen.d.ts +120 -0
- package/dist/generated/notification/client/utils.gen.d.ts +37 -0
- package/dist/generated/notification/client.gen.d.ts +12 -0
- package/dist/generated/notification/core/auth.gen.d.ts +25 -0
- package/dist/generated/notification/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/notification/core/params.gen.d.ts +43 -0
- package/dist/generated/notification/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/notification/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/notification/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/notification/core/types.gen.d.ts +83 -0
- package/dist/generated/notification/core/utils.gen.d.ts +19 -0
- package/dist/generated/notification/index.d.ts +2 -0
- package/dist/generated/notification/index.js +6 -0
- package/dist/generated/notification/sdk.gen.d.ts +127 -0
- package/dist/generated/notification/types.gen.d.ts +2084 -0
- package/dist/generated/properties/client/client.gen.d.ts +2 -0
- package/dist/generated/properties/client/index.d.ts +10 -0
- package/dist/generated/properties/client/types.gen.d.ts +120 -0
- package/dist/generated/properties/client/utils.gen.d.ts +37 -0
- package/dist/generated/properties/client.gen.d.ts +12 -0
- package/dist/generated/properties/core/auth.gen.d.ts +25 -0
- package/dist/generated/properties/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/properties/core/params.gen.d.ts +43 -0
- package/dist/generated/properties/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/properties/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/properties/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/properties/core/types.gen.d.ts +83 -0
- package/dist/generated/properties/core/utils.gen.d.ts +19 -0
- package/dist/generated/properties/index.d.ts +2 -0
- package/dist/generated/properties/index.js +6 -0
- package/dist/generated/properties/sdk.gen.d.ts +158 -0
- package/dist/generated/properties/types.gen.d.ts +1311 -0
- package/dist/generated/scheduled-action/client/client.gen.d.ts +2 -0
- package/dist/generated/scheduled-action/client/index.d.ts +10 -0
- package/dist/generated/scheduled-action/client/types.gen.d.ts +120 -0
- package/dist/generated/scheduled-action/client/utils.gen.d.ts +37 -0
- package/dist/generated/scheduled-action/client.gen.d.ts +12 -0
- package/dist/generated/scheduled-action/core/auth.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/params.gen.d.ts +43 -0
- package/dist/generated/scheduled-action/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/scheduled-action/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/scheduled-action/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/scheduled-action/core/types.gen.d.ts +83 -0
- package/dist/generated/scheduled-action/core/utils.gen.d.ts +19 -0
- package/dist/generated/scheduled-action/index.d.ts +2 -0
- package/dist/generated/scheduled-action/index.js +6 -0
- package/dist/generated/scheduled-action/sdk.gen.d.ts +156 -0
- package/dist/generated/scheduled-action/types.gen.d.ts +3099 -0
- package/dist/generated/search/client/client.gen.d.ts +2 -0
- package/dist/generated/search/client/index.d.ts +10 -0
- package/dist/generated/search/client/types.gen.d.ts +120 -0
- package/dist/generated/search/client/utils.gen.d.ts +37 -0
- package/dist/generated/search/client.gen.d.ts +12 -0
- package/dist/generated/search/core/auth.gen.d.ts +25 -0
- package/dist/generated/search/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/search/core/params.gen.d.ts +43 -0
- package/dist/generated/search/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/search/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/search/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/search/core/types.gen.d.ts +83 -0
- package/dist/generated/search/core/utils.gen.d.ts +19 -0
- package/dist/generated/search/index.d.ts +2 -0
- package/dist/generated/search/index.js +6 -0
- package/dist/generated/search/sdk.gen.d.ts +44 -0
- package/dist/generated/search/types.gen.d.ts +2532 -0
- package/dist/generated/static-files/client/client.gen.d.ts +2 -0
- package/dist/generated/static-files/client/index.d.ts +10 -0
- package/dist/generated/static-files/client/types.gen.d.ts +120 -0
- package/dist/generated/static-files/client/utils.gen.d.ts +37 -0
- package/dist/generated/static-files/client.gen.d.ts +12 -0
- package/dist/generated/static-files/core/auth.gen.d.ts +25 -0
- package/dist/generated/static-files/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/static-files/core/params.gen.d.ts +43 -0
- package/dist/generated/static-files/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/static-files/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/static-files/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/static-files/core/types.gen.d.ts +83 -0
- package/dist/generated/static-files/core/utils.gen.d.ts +19 -0
- package/dist/generated/static-files/index.d.ts +2 -0
- package/dist/generated/static-files/index.js +842 -0
- package/dist/generated/static-files/sdk.gen.d.ts +43 -0
- package/dist/generated/static-files/types.gen.d.ts +220 -0
- package/dist/generated/storage/client/client.gen.d.ts +2 -0
- package/dist/generated/storage/client/index.d.ts +10 -0
- package/dist/generated/storage/client/types.gen.d.ts +120 -0
- package/dist/generated/storage/client/utils.gen.d.ts +37 -0
- package/dist/generated/storage/client.gen.d.ts +12 -0
- package/dist/generated/storage/core/auth.gen.d.ts +25 -0
- package/dist/generated/storage/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/storage/core/params.gen.d.ts +43 -0
- package/dist/generated/storage/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/storage/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/storage/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/storage/core/types.gen.d.ts +83 -0
- package/dist/generated/storage/core/utils.gen.d.ts +19 -0
- package/dist/generated/storage/index.d.ts +2 -0
- package/dist/generated/storage/index.js +6 -0
- package/dist/generated/storage/sdk.gen.d.ts +2285 -0
- package/dist/generated/storage/types.gen.d.ts +34546 -0
- package/dist/generated/unfurl/client/client.gen.d.ts +2 -0
- package/dist/generated/unfurl/client/index.d.ts +10 -0
- package/dist/generated/unfurl/client/types.gen.d.ts +120 -0
- package/dist/generated/unfurl/client/utils.gen.d.ts +37 -0
- package/dist/generated/unfurl/client.gen.d.ts +12 -0
- package/dist/generated/unfurl/core/auth.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/params.gen.d.ts +43 -0
- package/dist/generated/unfurl/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/unfurl/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/unfurl/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/unfurl/core/types.gen.d.ts +83 -0
- package/dist/generated/unfurl/core/utils.gen.d.ts +19 -0
- package/dist/generated/unfurl/index.d.ts +2 -0
- package/dist/generated/unfurl/index.js +6 -0
- package/dist/generated/unfurl/sdk.gen.d.ts +47 -0
- package/dist/generated/unfurl/types.gen.d.ts +145 -0
- package/dist/src/calls/browser.d.ts +14 -0
- package/dist/src/calls/browser.js +102 -0
- package/dist/src/calls/common.d.ts +18 -0
- package/dist/src/calls/node.d.ts +24 -0
- package/dist/src/calls/node.js +145 -0
- package/dist/src/calls/telemetry.d.ts +5 -0
- package/dist/src/config.d.ts +71 -0
- package/dist/src/entities/account-managers/grant.d.ts +62 -0
- package/dist/src/entities/account-managers/namespace.d.ts +29 -0
- package/dist/src/entities/activity/entity.d.ts +7 -0
- package/dist/src/entities/activity/namespace.d.ts +58 -0
- package/dist/src/entities/activity/namespace.test.d.ts +1 -0
- package/dist/src/entities/agent-sessions/activity.d.ts +48 -0
- package/dist/src/entities/agent-sessions/agent-session.d.ts +518 -0
- package/dist/src/entities/agent-sessions/code-execution.d.ts +60 -0
- package/dist/src/entities/agent-sessions/conversation.d.ts +91 -0
- package/dist/src/entities/agent-sessions/namespace.d.ts +142 -0
- package/dist/src/entities/agent-sessions/origin.d.ts +94 -0
- package/dist/src/entities/agent-sessions/queued-action.d.ts +60 -0
- package/dist/src/entities/agent-sessions/review.d.ts +114 -0
- package/dist/src/entities/agent-sessions/tool-approval.d.ts +25 -0
- package/dist/src/entities/agent-sessions/view.d.ts +11 -0
- package/dist/src/entities/agents/agent.d.ts +142 -0
- package/dist/src/entities/agents/namespace.d.ts +66 -0
- package/dist/src/entities/ai/namespace.d.ts +36 -0
- package/dist/src/entities/api-keys/api-key.d.ts +22 -0
- package/dist/src/entities/api-keys/namespace.d.ts +37 -0
- package/dist/src/entities/bots/bot.d.ts +143 -0
- package/dist/src/entities/bots/namespace.d.ts +50 -0
- package/dist/src/entities/bots/token.d.ts +39 -0
- package/dist/src/entities/calendar/booking-link.d.ts +55 -0
- package/dist/src/entities/calendar/booking-namespace.d.ts +143 -0
- package/dist/src/entities/calendar/booking-namespace.test.d.ts +1 -0
- package/dist/src/entities/calendar/booking.d.ts +97 -0
- package/dist/src/entities/calendar/calendar.d.ts +49 -0
- package/dist/src/entities/calendar/create-confirmed.test.d.ts +1 -0
- package/dist/src/entities/calendar/event.d.ts +283 -0
- package/dist/src/entities/calendar/event.test.d.ts +1 -0
- package/dist/src/entities/calendar/namespace.d.ts +334 -0
- package/dist/src/entities/calendar/namespace.test.d.ts +1 -0
- package/dist/src/entities/calendar/replacement.d.ts +31 -0
- package/dist/src/entities/calls/call-record.d.ts +231 -0
- package/dist/src/entities/calls/connection.d.ts +59 -0
- package/dist/src/entities/calls/errors.d.ts +15 -0
- package/dist/src/entities/calls/message.d.ts +55 -0
- package/dist/src/entities/calls/namespace.d.ts +41 -0
- package/dist/src/entities/calls/participant.d.ts +22 -0
- package/dist/src/entities/canvases/canvas.d.ts +329 -0
- package/dist/src/entities/channels/access-request.d.ts +42 -0
- package/dist/src/entities/channels/activity.d.ts +40 -0
- package/dist/src/entities/channels/channel.d.ts +302 -0
- package/dist/src/entities/channels/labels.d.ts +73 -0
- package/dist/src/entities/channels/message.d.ts +153 -0
- package/dist/src/entities/channels/message.test.d.ts +1 -0
- package/dist/src/entities/channels/namespace.d.ts +82 -0
- package/dist/src/entities/channels/namespace.test.d.ts +1 -0
- package/dist/src/entities/channels/picture.d.ts +11 -0
- package/dist/src/entities/channels/post.d.ts +37 -0
- package/dist/src/entities/channels/post.test.d.ts +1 -0
- package/dist/src/entities/channels/share.d.ts +9 -0
- package/dist/src/entities/channels/share.test.d.ts +1 -0
- package/dist/src/entities/channels/thread.d.ts +64 -0
- package/dist/src/entities/chats/chat.d.ts +121 -0
- package/dist/src/entities/chats/generation.d.ts +55 -0
- package/dist/src/entities/chats/namespace.d.ts +35 -0
- package/dist/src/entities/connected-apps/connected-app.d.ts +121 -0
- package/dist/src/entities/connected-apps/connector.d.ts +59 -0
- package/dist/src/entities/connected-apps/namespace.d.ts +92 -0
- package/dist/src/entities/crm/company.d.ts +154 -0
- package/dist/src/entities/crm/contact.d.ts +168 -0
- package/dist/src/entities/crm/namespace.d.ts +163 -0
- package/dist/src/entities/crm/pipeline-entry.d.ts +109 -0
- package/dist/src/entities/crm/pipeline.d.ts +426 -0
- package/dist/src/entities/crm/pipelines.d.ts +79 -0
- package/dist/src/entities/crm-email-privacy/email-privacy.d.ts +238 -0
- package/dist/src/entities/crm-email-privacy/email-rule-preview.d.ts +55 -0
- package/dist/src/entities/crm-email-privacy/email-rule-revision.d.ts +27 -0
- package/dist/src/entities/crm-email-privacy/email-rules.d.ts +32 -0
- package/dist/src/entities/databases/column.d.ts +122 -0
- package/dist/src/entities/databases/database.d.ts +431 -0
- package/dist/src/entities/databases/namespace.d.ts +109 -0
- package/dist/src/entities/databases/query.d.ts +86 -0
- package/dist/src/entities/databases/row.d.ts +29 -0
- package/dist/src/entities/databases/saved-query.d.ts +151 -0
- package/dist/src/entities/databases/table.d.ts +124 -0
- package/dist/src/entities/databases/view.d.ts +72 -0
- package/dist/src/entities/databases/webhook.d.ts +39 -0
- package/dist/src/entities/documents/ai-edit.d.ts +54 -0
- package/dist/src/entities/documents/anchor.d.ts +39 -0
- package/dist/src/entities/documents/comment.d.ts +68 -0
- package/dist/src/entities/documents/create.test.d.ts +1 -0
- package/dist/src/entities/documents/document.d.ts +675 -0
- package/dist/src/entities/documents/markdown.d.ts +25 -0
- package/dist/src/entities/documents/namespace.d.ts +291 -0
- package/dist/src/entities/documents/office-files.d.ts +47 -0
- package/dist/src/entities/documents/skills.test.d.ts +1 -0
- package/dist/src/entities/documents/system-skill.d.ts +36 -0
- package/dist/src/entities/documents/text-comment.d.ts +41 -0
- package/dist/src/entities/documents/text-comment.test.d.ts +1 -0
- package/dist/src/entities/documents/version.d.ts +26 -0
- package/dist/src/entities/email/attachment.d.ts +39 -0
- package/dist/src/entities/email/body-rox-compat.d.ts +22 -0
- package/dist/src/entities/email/draft.d.ts +164 -0
- package/dist/src/entities/email/filter.d.ts +44 -0
- package/dist/src/entities/email/label.d.ts +37 -0
- package/dist/src/entities/email/link.d.ts +35 -0
- package/dist/src/entities/email/message.d.ts +223 -0
- package/dist/src/entities/email/namespace.d.ts +235 -0
- package/dist/src/entities/email/namespace.test.d.ts +1 -0
- package/dist/src/entities/email/thread.d.ts +268 -0
- package/dist/src/entities/entity-mentions/mention.d.ts +21 -0
- package/dist/src/entities/entity-mentions/namespace.d.ts +20 -0
- package/dist/src/entities/entity.d.ts +167 -0
- package/dist/src/entities/external-chat/chat.d.ts +173 -0
- package/dist/src/entities/external-chat/message.d.ts +54 -0
- package/dist/src/entities/external-chat/namespace.d.ts +22 -0
- package/dist/src/entities/external-chat/participant.d.ts +28 -0
- package/dist/src/entities/external-chat/send.d.ts +40 -0
- package/dist/src/entities/external-chat/upload.d.ts +25 -0
- package/dist/src/entities/favorites/namespace.d.ts +52 -0
- package/dist/src/entities/foreign/foreign-entity.d.ts +36 -0
- package/dist/src/entities/foreign/namespace.d.ts +54 -0
- package/dist/src/entities/forms/form.d.ts +319 -0
- package/dist/src/entities/forms/namespace.d.ts +30 -0
- package/dist/src/entities/forms/question.d.ts +65 -0
- package/dist/src/entities/forms/response.d.ts +52 -0
- package/dist/src/entities/forms/section.d.ts +31 -0
- package/dist/src/entities/github-pull-requests/namespace.d.ts +20 -0
- package/dist/src/entities/github-pull-requests/pull-request.d.ts +64 -0
- package/dist/src/entities/harnesses/harness.d.ts +76 -0
- package/dist/src/entities/harnesses/namespace.d.ts +83 -0
- package/dist/src/entities/harnesses/pairing.d.ts +50 -0
- package/dist/src/entities/images/image.d.ts +88 -0
- package/dist/src/entities/images/namespace.d.ts +55 -0
- package/dist/src/entities/images/namespace.test.d.ts +1 -0
- package/dist/src/entities/imports/entry.d.ts +65 -0
- package/dist/src/entities/imports/namespace.d.ts +103 -0
- package/dist/src/entities/imports/namespace.test.d.ts +1 -0
- package/dist/src/entities/initiatives/initiative.d.ts +185 -0
- package/dist/src/entities/initiatives/initiative.test.d.ts +1 -0
- package/dist/src/entities/initiatives/namespace.d.ts +90 -0
- package/dist/src/entities/me/namespace.d.ts +68 -0
- package/dist/src/entities/meetings/meeting.d.ts +81 -0
- package/dist/src/entities/meetings/namespace.d.ts +38 -0
- package/dist/src/entities/memory/namespace.d.ts +49 -0
- package/dist/src/entities/memory/namespace.test.d.ts +1 -0
- package/dist/src/entities/messages/discussion.d.ts +84 -0
- package/dist/src/entities/messages/thread.d.ts +115 -0
- package/dist/src/entities/notifications/namespace.d.ts +66 -0
- package/dist/src/entities/notifications/notification.d.ts +78 -0
- package/dist/src/entities/notifications/notification.test.d.ts +1 -0
- package/dist/src/entities/passwords/item.d.ts +118 -0
- package/dist/src/entities/passwords/namespace.d.ts +45 -0
- package/dist/src/entities/pins/namespace.d.ts +42 -0
- package/dist/src/entities/projects/namespace.d.ts +45 -0
- package/dist/src/entities/projects/project.d.ts +108 -0
- package/dist/src/entities/properties/namespace.d.ts +105 -0
- package/dist/src/entities/properties/namespace.test.d.ts +1 -0
- package/dist/src/entities/properties/property-definition.d.ts +70 -0
- package/dist/src/entities/properties/property-option.d.ts +44 -0
- package/dist/src/entities/reference.d.ts +82 -0
- package/dist/src/entities/referrals/namespace.d.ts +40 -0
- package/dist/src/entities/routines/namespace.d.ts +239 -0
- package/dist/src/entities/routines/routine.d.ts +341 -0
- package/dist/src/entities/routines/suggestion.d.ts +38 -0
- package/dist/src/entities/saved-views/namespace.d.ts +58 -0
- package/dist/src/entities/saved-views/saved-view.d.ts +78 -0
- package/dist/src/entities/search/exclusions.d.ts +6 -0
- package/dist/src/entities/search/namespace.d.ts +71 -0
- package/dist/src/entities/search/options.d.ts +30 -0
- package/dist/src/entities/search/types.d.ts +90 -0
- package/dist/src/entities/sharing/access.d.ts +120 -0
- package/dist/src/entities/sharing/permissions.d.ts +13 -0
- package/dist/src/entities/spreadsheets/spreadsheet.d.ts +201 -0
- package/dist/src/entities/suggestions/namespace.d.ts +118 -0
- package/dist/src/entities/suggestions/suggestion.d.ts +172 -0
- package/dist/src/entities/suggestions/suggestion.test.d.ts +1 -0
- package/dist/src/entities/tasks/namespace.d.ts +77 -0
- package/dist/src/entities/tasks/task.d.ts +99 -0
- package/dist/src/entities/teams/invite.d.ts +33 -0
- package/dist/src/entities/teams/namespace.d.ts +23 -0
- package/dist/src/entities/teams/team.d.ts +129 -0
- package/dist/src/entities/ui/app-link.d.ts +24 -0
- package/dist/src/entities/ui/namespace.d.ts +75 -0
- package/dist/src/entities/unfurls/namespace.d.ts +24 -0
- package/dist/src/entities/users/namespace.d.ts +41 -0
- package/dist/src/entities/users/profile-picture.d.ts +29 -0
- package/dist/src/entities/users/profile-picture.test.d.ts +1 -0
- package/dist/src/entities/users/user.d.ts +102 -0
- package/dist/src/entities/web/namespace.d.ts +67 -0
- package/dist/src/entities/web/namespace.test.d.ts +1 -0
- package/dist/src/entities/webhooks/namespace.d.ts +38 -0
- package/dist/src/entities/webhooks/webhook.d.ts +130 -0
- package/dist/src/entities/whatsapp/account.d.ts +24 -0
- package/dist/src/entities/whatsapp/chat.d.ts +62 -0
- package/dist/src/entities/whatsapp/namespace.d.ts +29 -0
- package/dist/src/entities/workspace/items.d.ts +14 -0
- package/dist/src/entities/workspace/namespace.d.ts +96 -0
- package/dist/src/entities/workspace/query.d.ts +39 -0
- package/dist/src/entities/workspace/query.test.d.ts +1 -0
- package/dist/src/entities/workspace/types.d.ts +99 -0
- package/dist/src/events/hydrate/agentSession.d.ts +192 -0
- package/dist/src/events/hydrate/call.d.ts +101 -0
- package/dist/src/events/hydrate/channel.d.ts +55 -0
- package/dist/src/events/hydrate/document.d.ts +59 -0
- package/dist/src/events/hydrate/message.d.ts +70 -0
- package/dist/src/events/hydrate/user.d.ts +14 -0
- package/dist/src/events/receiver.d.ts +91 -0
- package/dist/src/events/types.d.ts +44 -0
- package/dist/src/events/verify.d.ts +13 -0
- package/dist/src/local-portmap.d.ts +8 -0
- package/dist/src/mentions.d.ts +42 -0
- package/dist/src/raw.d.ts +12 -0
- package/dist/src/rox.d.ts +268 -0
- package/dist/src/rox.js +23231 -0
- package/dist/src/utils/activity.d.ts +34 -0
- package/dist/src/utils/activity.test.d.ts +1 -0
- package/dist/src/utils/client.d.ts +62 -0
- package/dist/src/utils/concurrency.d.ts +5 -0
- package/dist/src/utils/index.d.ts +5 -0
- package/dist/src/utils/lazy.d.ts +37 -0
- package/dist/src/utils/options.d.ts +7 -0
- package/dist/src/utils/pagination.d.ts +28 -0
- package/dist/src/utils/unwrap.d.ts +48 -0
- package/dist/src/utils/verbs.d.ts +3 -0
- package/package.json +82 -4
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { type RichMessage } from '../../mentions';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import type { Document } from '../documents/document';
|
|
4
|
+
import type { StaticImage } from '../images/image';
|
|
5
|
+
import { Channel } from './channel';
|
|
6
|
+
import { Message } from './message';
|
|
7
|
+
/**
|
|
8
|
+
* A thread within a channel, rooted at a top-level message. Replies and
|
|
9
|
+
* thread-scoped posting live here.
|
|
10
|
+
*/
|
|
11
|
+
export declare class Thread {
|
|
12
|
+
private readonly client;
|
|
13
|
+
readonly channelId: string;
|
|
14
|
+
/** The id of the message this thread hangs off. */
|
|
15
|
+
readonly rootId: string;
|
|
16
|
+
constructor(client: RoxClient, channelId: string,
|
|
17
|
+
/** The id of the message this thread hangs off. */
|
|
18
|
+
rootId: string);
|
|
19
|
+
/** A handle to the thread under the message `rootId` in `channel`. */
|
|
20
|
+
static byId(client: RoxClient, channel: Channel, rootId: string): Thread;
|
|
21
|
+
/** Serialize the thread identity without its authenticated client. */
|
|
22
|
+
toJSON(): {
|
|
23
|
+
channelId: string;
|
|
24
|
+
rootId: string;
|
|
25
|
+
};
|
|
26
|
+
/**
|
|
27
|
+
* The channel this thread is in.
|
|
28
|
+
*
|
|
29
|
+
* @readonly
|
|
30
|
+
*/
|
|
31
|
+
channel(): Channel;
|
|
32
|
+
/**
|
|
33
|
+
* The message this thread hangs off.
|
|
34
|
+
*
|
|
35
|
+
* @readonly
|
|
36
|
+
*/
|
|
37
|
+
root(): Message;
|
|
38
|
+
/**
|
|
39
|
+
* List the replies in this thread, oldest first.
|
|
40
|
+
*
|
|
41
|
+
* @readonly
|
|
42
|
+
*/
|
|
43
|
+
replies(): Promise<Message[]>;
|
|
44
|
+
/**
|
|
45
|
+
* Post a reply in this thread; pass `silent: true` for a routine update
|
|
46
|
+
* that should notify nobody.
|
|
47
|
+
*
|
|
48
|
+
* @param body - Plain text, or a rich body composed with {@link msg}.
|
|
49
|
+
* @param opts.images - Static images to attach, such as one from
|
|
50
|
+
* `rox.images.generate()`.
|
|
51
|
+
* @param opts.documents - Rox documents to attach as file chips, such as
|
|
52
|
+
* a file from `rox.documents.upload()`.
|
|
53
|
+
* @param opts.silent - Send no push, email or inbox entry to anyone,
|
|
54
|
+
* mentioned people included; the reply still appears in the thread.
|
|
55
|
+
* @returns The created reply.
|
|
56
|
+
*
|
|
57
|
+
* @write
|
|
58
|
+
*/
|
|
59
|
+
reply(body: string | RichMessage, opts?: {
|
|
60
|
+
images?: StaticImage[];
|
|
61
|
+
documents?: Document[];
|
|
62
|
+
silent?: boolean;
|
|
63
|
+
}): Promise<Message>;
|
|
64
|
+
}
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import type { GetChatHistoryHandlerResponses, GetChatResponses, HttpSendChatMessageRequest } from '../../../generated/cognition/types.gen';
|
|
2
|
+
import { type Mentionable, type MentionPart } from '../../mentions';
|
|
3
|
+
import type { RoxClient } from '../../utils/client';
|
|
4
|
+
import { PropertiedEntity } from '../entity';
|
|
5
|
+
import { Project } from '../projects/project';
|
|
6
|
+
import type { EntityReference } from '../reference';
|
|
7
|
+
import { EntityAccess } from '../sharing/access';
|
|
8
|
+
import { type SharePermissionOptions } from '../sharing/permissions';
|
|
9
|
+
import { ChatGeneration } from './generation';
|
|
10
|
+
type ChatDetail = GetChatResponses[200]['chat'];
|
|
11
|
+
type ChatHistory = GetChatHistoryHandlerResponses[200]['conversation'];
|
|
12
|
+
/** A Rox AI chat. */
|
|
13
|
+
export declare class Chat extends PropertiedEntity<ChatDetail> implements Mentionable {
|
|
14
|
+
/**
|
|
15
|
+
* Send a message and start a background generation. Tools may perform writes.
|
|
16
|
+
*
|
|
17
|
+
* @write
|
|
18
|
+
* @openworld
|
|
19
|
+
*/
|
|
20
|
+
send(options: Omit<HttpSendChatMessageRequest, 'chat_id' | 'attachments' | 'additional_instructions'> & {
|
|
21
|
+
attachments?: EntityReference[];
|
|
22
|
+
additionalInstructions?: string;
|
|
23
|
+
}): Promise<ChatGeneration>;
|
|
24
|
+
/** Access requests and direct user grants. */
|
|
25
|
+
readonly access: EntityAccess;
|
|
26
|
+
/** Favorites identify chats as `chat`. */
|
|
27
|
+
readonly entityType = "chat";
|
|
28
|
+
/** The properties service identifies chats as `CHAT`. */
|
|
29
|
+
protected readonly propertyEntityType = "CHAT";
|
|
30
|
+
protected fetch(): Promise<ChatDetail>;
|
|
31
|
+
/** A handle to a chat by id. Details load on first access. */
|
|
32
|
+
static byId(client: RoxClient, id: string): Chat;
|
|
33
|
+
/** Create a chat, optionally named and attached to a project. */
|
|
34
|
+
static create(client: RoxClient, opts?: {
|
|
35
|
+
name?: string;
|
|
36
|
+
project?: Project;
|
|
37
|
+
}): Promise<Chat>;
|
|
38
|
+
/** The chat's display name. */
|
|
39
|
+
readonly name: () => Promise<string>;
|
|
40
|
+
/** The model used to generate the chat (`provider/model` id), if set. */
|
|
41
|
+
readonly model: () => Promise<string | undefined>;
|
|
42
|
+
/** The project this chat belongs to, if any. */
|
|
43
|
+
readonly project: () => Promise<Project | undefined>;
|
|
44
|
+
/** When the chat was created. */
|
|
45
|
+
readonly createdAt: () => Promise<string | undefined>;
|
|
46
|
+
/** When the chat was last updated. */
|
|
47
|
+
readonly updatedAt: () => Promise<string | undefined>;
|
|
48
|
+
/** The messages in the chat, with their attachments. */
|
|
49
|
+
readonly messages: () => Promise<import("../../../generated/cognition").ChatMessageWithAttachments[]>;
|
|
50
|
+
/**
|
|
51
|
+
* Sharing configuration.
|
|
52
|
+
*
|
|
53
|
+
* @readonly
|
|
54
|
+
*/
|
|
55
|
+
sharePermissions(): Promise<import("../../../generated/cognition").GetChatPermissionsResponse>;
|
|
56
|
+
/**
|
|
57
|
+
* Change who can open the chat: the link share and its access level, the
|
|
58
|
+
* owner's team, and channel grants. Omitted fields are left as they are.
|
|
59
|
+
*
|
|
60
|
+
* @write
|
|
61
|
+
* @idempotent
|
|
62
|
+
*/
|
|
63
|
+
updateSharePermissions(options: SharePermissionOptions): Promise<void>;
|
|
64
|
+
/**
|
|
65
|
+
* Rename the chat.
|
|
66
|
+
*
|
|
67
|
+
* @write
|
|
68
|
+
* @idempotent
|
|
69
|
+
*/
|
|
70
|
+
rename(name: string): Promise<void>;
|
|
71
|
+
/**
|
|
72
|
+
* Delete the chat. Soft by default (reversible with {@link restore});
|
|
73
|
+
* pass `permanent: true` to delete irreversibly.
|
|
74
|
+
*
|
|
75
|
+
* @destructive
|
|
76
|
+
* @idempotent
|
|
77
|
+
*/
|
|
78
|
+
delete(opts?: {
|
|
79
|
+
permanent?: boolean;
|
|
80
|
+
}): Promise<void>;
|
|
81
|
+
/**
|
|
82
|
+
* Copy the chat, returning a handle to the new copy.
|
|
83
|
+
*
|
|
84
|
+
* @write
|
|
85
|
+
*/
|
|
86
|
+
copy(): Promise<Chat>;
|
|
87
|
+
/**
|
|
88
|
+
* Restore a soft-deleted chat.
|
|
89
|
+
*
|
|
90
|
+
* @write
|
|
91
|
+
* @idempotent
|
|
92
|
+
*/
|
|
93
|
+
restore(): Promise<void>;
|
|
94
|
+
/**
|
|
95
|
+
* The chat's conversation history: titled records of messages with attachment ids.
|
|
96
|
+
*
|
|
97
|
+
* @readonly
|
|
98
|
+
*/
|
|
99
|
+
history(): Promise<ChatHistory>;
|
|
100
|
+
/**
|
|
101
|
+
* The chat's URL in the Rox web app.
|
|
102
|
+
*
|
|
103
|
+
* @readonly
|
|
104
|
+
*/
|
|
105
|
+
webUrl(): string;
|
|
106
|
+
/** Identity, loaded detail and {@link webUrl}, so serialized handles carry their link. */
|
|
107
|
+
toJSON(): {
|
|
108
|
+
url: string;
|
|
109
|
+
id: string;
|
|
110
|
+
detail?: import("../../../generated/cognition").ChatResponse | undefined;
|
|
111
|
+
};
|
|
112
|
+
/** Search chats by name and content, most relevant first, auto-paginated; `maxItems` caps the total. */
|
|
113
|
+
static search: (client: RoxClient, query: string, searchOpts?: import("../search/options").SearchOpts) => AsyncGenerator<Chat, any, any>;
|
|
114
|
+
/**
|
|
115
|
+
* Render this chat as a mention for a message body.
|
|
116
|
+
*
|
|
117
|
+
* @readonly
|
|
118
|
+
*/
|
|
119
|
+
toMention(): MentionPart;
|
|
120
|
+
}
|
|
121
|
+
export {};
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import type { ChatMessageWithAttachments } from '../../../generated/cognition/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import { RoxEntity } from '../entity';
|
|
4
|
+
import type { Chat } from './chat';
|
|
5
|
+
/** A background chat generation. The stream belongs to exactly one chat. */
|
|
6
|
+
export declare class ChatGeneration {
|
|
7
|
+
private readonly client;
|
|
8
|
+
/** Parent chat. */
|
|
9
|
+
readonly chat: Chat;
|
|
10
|
+
/** Stream identity. */
|
|
11
|
+
readonly id: string;
|
|
12
|
+
/** AI response message for this generation. */
|
|
13
|
+
readonly message: ChatMessage;
|
|
14
|
+
private constructor();
|
|
15
|
+
/** Construct from a send receipt. */
|
|
16
|
+
static byId(client: RoxClient, chat: Chat, id: string, message: ChatMessage): ChatGeneration;
|
|
17
|
+
/**
|
|
18
|
+
* Request cancellation of this generation.
|
|
19
|
+
*
|
|
20
|
+
* @destructive
|
|
21
|
+
* @idempotent
|
|
22
|
+
*/
|
|
23
|
+
stop(): Promise<void>;
|
|
24
|
+
/** Serialize scoped identity. */
|
|
25
|
+
toJSON(): {
|
|
26
|
+
id: string;
|
|
27
|
+
chatId: string;
|
|
28
|
+
messageId: string;
|
|
29
|
+
};
|
|
30
|
+
}
|
|
31
|
+
/** A message scoped to an AI chat. */
|
|
32
|
+
export declare class ChatMessage extends RoxEntity<ChatMessageWithAttachments> {
|
|
33
|
+
/** Parent chat. */
|
|
34
|
+
readonly chat: Chat;
|
|
35
|
+
private constructor();
|
|
36
|
+
/** Construct a chat message handle. */
|
|
37
|
+
static byId(client: RoxClient, chat: Chat, id: string): ChatMessage;
|
|
38
|
+
protected fetch(): Promise<ChatMessageWithAttachments>;
|
|
39
|
+
/** The message's generated content. */
|
|
40
|
+
readonly content: () => Promise<import("../../../generated/cognition").ChatMessageContent>;
|
|
41
|
+
/** Role of the message author. */
|
|
42
|
+
readonly role: () => Promise<import("../../../generated/cognition").Role>;
|
|
43
|
+
/**
|
|
44
|
+
* Reload after a running generation changes or finishes.
|
|
45
|
+
*
|
|
46
|
+
* @readonly
|
|
47
|
+
*/
|
|
48
|
+
refresh(): Promise<void>;
|
|
49
|
+
/** Serialize scoped identity and any loaded message. */
|
|
50
|
+
toJSON(): {
|
|
51
|
+
chatId: string;
|
|
52
|
+
id: string;
|
|
53
|
+
detail?: ChatMessageWithAttachments | undefined;
|
|
54
|
+
};
|
|
55
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { RoxClient } from '../../utils/client';
|
|
2
|
+
import type { Project } from '../projects/project';
|
|
3
|
+
import type { SearchOpts } from '../search/options';
|
|
4
|
+
import { Chat } from './chat';
|
|
5
|
+
/**
|
|
6
|
+
* The user's AI chats: earlier conversations with Rox's assistant, each
|
|
7
|
+
* with its message history. Find one with {@link ChatNamespace.search},
|
|
8
|
+
* `rox.search.all(query, {types: ['chat']})` or
|
|
9
|
+
* `rox.workspace.list({includeTypes: ['ai_chat']})`, then read it with
|
|
10
|
+
* `chat.history()`. Agent work and coding sessions are agent sessions, not
|
|
11
|
+
* chats.
|
|
12
|
+
*
|
|
13
|
+
* @routing Use when reading or continuing one of the user's AI chats with Rox's assistant; not agent sessions or channels.
|
|
14
|
+
*/
|
|
15
|
+
export declare class ChatNamespace {
|
|
16
|
+
private readonly client;
|
|
17
|
+
constructor(client: RoxClient);
|
|
18
|
+
/** A handle to an AI chat by id; read its messages with `history()`. */
|
|
19
|
+
byId(id: string): Chat;
|
|
20
|
+
/**
|
|
21
|
+
* Create an empty AI chat, optionally named and in a project.
|
|
22
|
+
*
|
|
23
|
+
* @write
|
|
24
|
+
*/
|
|
25
|
+
create(opts?: {
|
|
26
|
+
name?: string;
|
|
27
|
+
project?: Project;
|
|
28
|
+
}): Promise<Chat>;
|
|
29
|
+
/**
|
|
30
|
+
* Search AI chats by name and content, most relevant first, auto-paginated; `maxItems` caps the total.
|
|
31
|
+
*
|
|
32
|
+
* @readonly
|
|
33
|
+
*/
|
|
34
|
+
search(query: string, opts?: SearchOpts): AsyncGenerator<Chat>;
|
|
35
|
+
}
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
import type { ConnectedAppKind, ConnectedApp as ConnectedAppRecord, ConnectedTool as ConnectedToolRecord } from '../../../generated/agent-harness/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import type { CodeExecution } from '../agent-sessions/code-execution';
|
|
4
|
+
export type { ConnectedAppKind };
|
|
5
|
+
/** A connected tool's answer, MCP's `CallToolResult`. */
|
|
6
|
+
export type ConnectedToolResult = {
|
|
7
|
+
/** The tool failed or could not run; `content` says why. */
|
|
8
|
+
isError: boolean;
|
|
9
|
+
/** MCP content blocks, e.g. `{type: 'text', text}`. */
|
|
10
|
+
content: Array<Record<string, unknown>>;
|
|
11
|
+
/** Structured output, for tools that declare an output schema. */
|
|
12
|
+
structuredContent?: Record<string, unknown>;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* An app the session's agent was given: one the user connected through
|
|
16
|
+
* Rox Connect (Slack, Linear, GitHub, Notion, Gmail, ...) or a custom MCP
|
|
17
|
+
* server they added. Read its tools, then call one.
|
|
18
|
+
*/
|
|
19
|
+
export declare class ConnectedApp {
|
|
20
|
+
private readonly client;
|
|
21
|
+
/** The running execution this app is reached through. */
|
|
22
|
+
readonly execution: CodeExecution;
|
|
23
|
+
/** `app` for a connected app, `custom` for a custom MCP server. */
|
|
24
|
+
readonly kind: ConnectedAppKind;
|
|
25
|
+
/** The app's slug, e.g. `slack`, or the custom server's key. */
|
|
26
|
+
readonly key: string;
|
|
27
|
+
/** Display name, e.g. `Slack`. */
|
|
28
|
+
readonly name: string;
|
|
29
|
+
private constructor();
|
|
30
|
+
/** The apps `execution`'s session agent was given. */
|
|
31
|
+
static list(client: RoxClient, execution: CodeExecution): Promise<ConnectedApp[]>;
|
|
32
|
+
/** @internal A handle for an app record the harness answered. */
|
|
33
|
+
static fromRecord(client: RoxClient, execution: CodeExecution, record: ConnectedAppRecord): ConnectedApp;
|
|
34
|
+
/**
|
|
35
|
+
* Find tools across every app the execution's agent was given, by
|
|
36
|
+
* keywords matched against tool names and descriptions, best first (at
|
|
37
|
+
* most 20). `unsearched` lists apps whose tools could not be read.
|
|
38
|
+
*/
|
|
39
|
+
static searchTools(client: RoxClient, execution: CodeExecution, query: string): Promise<{
|
|
40
|
+
matches: ConnectedTool[];
|
|
41
|
+
unsearched: ConnectedApp[];
|
|
42
|
+
}>;
|
|
43
|
+
/**
|
|
44
|
+
* The tools this app serves, with each one's description and argument
|
|
45
|
+
* schema. Read a tool's `inputSchema` before calling it.
|
|
46
|
+
*
|
|
47
|
+
* @readonly
|
|
48
|
+
* @openworld
|
|
49
|
+
* @mcp-exclude Needs the CodeExecution of a running program.
|
|
50
|
+
*/
|
|
51
|
+
tools(): Promise<ConnectedTool[]>;
|
|
52
|
+
/**
|
|
53
|
+
* @internal The harness route that names this app.
|
|
54
|
+
*
|
|
55
|
+
* @readonly
|
|
56
|
+
* @mcp-exclude Internal route helper.
|
|
57
|
+
*/
|
|
58
|
+
path(): {
|
|
59
|
+
session_id: string;
|
|
60
|
+
execution_id: string;
|
|
61
|
+
kind: ConnectedAppKind;
|
|
62
|
+
key: string;
|
|
63
|
+
};
|
|
64
|
+
/** Serialize identity only. */
|
|
65
|
+
toJSON(): {
|
|
66
|
+
kind: ConnectedAppKind;
|
|
67
|
+
key: string;
|
|
68
|
+
name: string;
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
/** One tool a connected app serves. */
|
|
72
|
+
export declare class ConnectedTool {
|
|
73
|
+
private readonly client;
|
|
74
|
+
/** The app serving this tool. */
|
|
75
|
+
readonly app: ConnectedApp;
|
|
76
|
+
/** The tool's name on its server. */
|
|
77
|
+
readonly name: string;
|
|
78
|
+
/** What the server says the tool does. */
|
|
79
|
+
readonly description: string | undefined;
|
|
80
|
+
/** JSON Schema for the tool's arguments. */
|
|
81
|
+
readonly inputSchema: Record<string, unknown>;
|
|
82
|
+
/** @internal */
|
|
83
|
+
constructor(client: RoxClient,
|
|
84
|
+
/** The app serving this tool. */
|
|
85
|
+
app: ConnectedApp,
|
|
86
|
+
/** The tool's name on its server. */
|
|
87
|
+
name: string,
|
|
88
|
+
/** What the server says the tool does. */
|
|
89
|
+
description: string | undefined,
|
|
90
|
+
/** JSON Schema for the tool's arguments. */
|
|
91
|
+
inputSchema: Record<string, unknown>);
|
|
92
|
+
/** @internal A handle for a tool record the harness answered. */
|
|
93
|
+
static fromRecord(client: RoxClient, app: ConnectedApp, record: ConnectedToolRecord): ConnectedTool;
|
|
94
|
+
/**
|
|
95
|
+
* Call the tool as the execution's account, with arguments matching
|
|
96
|
+
* `inputSchema`. Writes take effect immediately, in the user's real
|
|
97
|
+
* account. In a turn someone other than the session's owner prompted, a
|
|
98
|
+
* call as the owner waits for the owner to approve it, and a declined or
|
|
99
|
+
* unanswered call comes back with `isError`. Check `isError` on the result: an app that is not connected,
|
|
100
|
+
* or whose connection expired, answers with `isError` and text telling you
|
|
101
|
+
* what to say to the user, including any connect markup to put in your
|
|
102
|
+
* reply verbatim. Throws when the app is still rate limiting the account
|
|
103
|
+
* after Macro paced and retried the call; the call did not run.
|
|
104
|
+
*
|
|
105
|
+
* @destructive
|
|
106
|
+
* @openworld
|
|
107
|
+
* @mcp-exclude Needs the CodeExecution of a running program.
|
|
108
|
+
*/
|
|
109
|
+
call(args?: Record<string, unknown>): Promise<ConnectedToolResult>;
|
|
110
|
+
/** Serialize the tool's description, not its client. */
|
|
111
|
+
toJSON(): {
|
|
112
|
+
app: {
|
|
113
|
+
kind: ConnectedAppKind;
|
|
114
|
+
key: string;
|
|
115
|
+
name: string;
|
|
116
|
+
};
|
|
117
|
+
name: string;
|
|
118
|
+
description: string | undefined;
|
|
119
|
+
inputSchema: Record<string, unknown>;
|
|
120
|
+
};
|
|
121
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import type { RoxClient } from '../../utils/client';
|
|
2
|
+
import type { CodeExecution } from '../agent-sessions/code-execution';
|
|
3
|
+
/** One action a connectable app advertises; not callable until connected. */
|
|
4
|
+
export type ConnectorAction = {
|
|
5
|
+
/** The upstream tool name. */
|
|
6
|
+
name: string;
|
|
7
|
+
/** What the action supports. */
|
|
8
|
+
description: string;
|
|
9
|
+
};
|
|
10
|
+
/** A connector's verified capabilities and the account's connection status. */
|
|
11
|
+
export type ConnectorInspection = {
|
|
12
|
+
/** Whether the execution's account has the app connected and enabled. */
|
|
13
|
+
connected: boolean;
|
|
14
|
+
/** The actions the app advertises. */
|
|
15
|
+
actions: ConnectorAction[];
|
|
16
|
+
/** True when some advertised actions were left out. */
|
|
17
|
+
actionsTruncated: boolean;
|
|
18
|
+
/**
|
|
19
|
+
* Markup that gives the user a button to connect the app, present only for
|
|
20
|
+
* an unconnected app with advertised actions. Put it in your reply
|
|
21
|
+
* verbatim, and only when one of `actions` supports the user's task.
|
|
22
|
+
*/
|
|
23
|
+
connectMarkup: string | undefined;
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* An app the user could connect, found in the connector catalog. Its
|
|
27
|
+
* description is the catalog's; inspect it to see what it can actually do.
|
|
28
|
+
*/
|
|
29
|
+
export declare class Connector {
|
|
30
|
+
private readonly client;
|
|
31
|
+
/** The running execution the catalog is read through. */
|
|
32
|
+
readonly execution: CodeExecution;
|
|
33
|
+
/** The app's catalog slug, e.g. `linear`. */
|
|
34
|
+
readonly slug: string;
|
|
35
|
+
/** Display name, e.g. `Linear`. */
|
|
36
|
+
readonly name: string;
|
|
37
|
+
/** The catalog's description. */
|
|
38
|
+
readonly description: string | undefined;
|
|
39
|
+
private constructor();
|
|
40
|
+
/** Search the connector catalog by app name. */
|
|
41
|
+
static search(client: RoxClient, execution: CodeExecution, appName: string): Promise<{
|
|
42
|
+
connectors: Connector[];
|
|
43
|
+
moreResults: boolean;
|
|
44
|
+
}>;
|
|
45
|
+
/**
|
|
46
|
+
* Read the actions this app advertises and whether the execution's account
|
|
47
|
+
* has it connected. Inspection never calls the app or changes a connection.
|
|
48
|
+
*
|
|
49
|
+
* @readonly
|
|
50
|
+
* @mcp-exclude Needs the CodeExecution of a running program.
|
|
51
|
+
*/
|
|
52
|
+
inspect(): Promise<ConnectorInspection>;
|
|
53
|
+
/** Serialize the catalog entry, not its client. */
|
|
54
|
+
toJSON(): {
|
|
55
|
+
slug: string;
|
|
56
|
+
name: string;
|
|
57
|
+
description: string | undefined;
|
|
58
|
+
};
|
|
59
|
+
}
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
import type { ConnectMcpServerResponse } from '../../../generated/agent-harness/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import type { CodeExecution } from '../agent-sessions/code-execution';
|
|
4
|
+
import { ConnectedApp, type ConnectedTool } from './connected-app';
|
|
5
|
+
import { Connector } from './connector';
|
|
6
|
+
export type { ConnectMcpServerResponse };
|
|
7
|
+
/**
|
|
8
|
+
* The apps the user connected for their agents (Slack, Linear, GitHub,
|
|
9
|
+
* Notion, Gmail and others through Rox Connect) and the custom MCP servers
|
|
10
|
+
* they added, reached from a session's code execution.
|
|
11
|
+
*
|
|
12
|
+
* @routing Use when the work needs a connected third-party app or MCP server (Slack, Linear, GitHub, Notion, Jira, Google Sheets, a custom MCP server): reading or changing data in it, or calling one of its tools; not Rox's own documents, email, channels or calendar.
|
|
13
|
+
*
|
|
14
|
+
* @agent
|
|
15
|
+
* ## Connected apps
|
|
16
|
+
*
|
|
17
|
+
* Connected apps are reached only from an agent session's ExecuteCode program: pass the `execution` that `main` receives. `rox.connectedApps.list(execution)` returns the apps this agent was given (every app the user connected, or the agent's own selection); an app missing from it is not connected for this agent. Find a tool across every app with `rox.connectedApps.searchTools(execution, 'linear issue')`, or read one app's tools with `app.tools()`; pick one by name and description, read its `inputSchema`, then `tool.call(args)`.
|
|
18
|
+
*
|
|
19
|
+
* Calls run in the user's real account through Rox's server, as the account this execution acts as, and take effect at once; the program never sees a credential. In a turn someone other than the session's owner prompted, each call that uses the owner's account waits for the owner to approve it, so make few such calls and expect a long wait or a refusal. Read before writing, and never repeat a write whose outcome is unknown: check the app's state first. A result with `isError` explains itself: when it says an app is not connected, tell the user and include the connect markup it gives you in your reply verbatim, then stop.
|
|
20
|
+
*
|
|
21
|
+
* Each account's calls to one app share a budget across its running programs on the same Macro server: a few run at once, paced, and the rest queue. Narrow first with the app's search or list tools and their own limits and filters (e.g. open PRs updated this week), then call per item only for the few items you need, in small batches; never `Promise.all` a call per item over a whole list. A call the app keeps refusing with HTTP 429 is retried after its `Retry-After`; one still refused throws a rate-limit error and did not run, so stop and report partial results rather than retrying in a loop.
|
|
22
|
+
*
|
|
23
|
+
* When an app the work needs is missing, find it with `rox.connectedApps.discover(execution, appName)` and `connector.inspect()` its advertised actions and connection status. Recommend connecting only when an advertised action supports the task; an app's name is not evidence. For a suitable unconnected app, put the inspection's `connectMarkup` in your reply verbatim and say what connecting enables. To add a remote MCP server the user gives you the URL of, use `rox.connectedApps.addServer(execution, {url, serverName})`; never guess a URL, and tell the user to sign in under Settings → Connections when its summary says so.
|
|
24
|
+
*
|
|
25
|
+
* ```javascript
|
|
26
|
+
* export async function main({macro, execution}) {
|
|
27
|
+
* const apps = await rox.connectedApps.list(execution);
|
|
28
|
+
* const linear = apps.find((app) => app.key === 'linear');
|
|
29
|
+
* if (!linear) return {data: {error: 'Linear is not connected', available: apps.map((app) => app.name)}};
|
|
30
|
+
* const tools = await linear.tools();
|
|
31
|
+
* const search = tools.find((tool) => tool.name === 'list_issues');
|
|
32
|
+
* const result = await search.call({query: 'login bug', limit: 5});
|
|
33
|
+
* return {data: result.isError ? {error: result.content} : result.structuredContent ?? result.content};
|
|
34
|
+
* }
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
export declare class ConnectedAppNamespace {
|
|
38
|
+
private readonly client;
|
|
39
|
+
constructor(client: RoxClient);
|
|
40
|
+
/**
|
|
41
|
+
* List the apps a running code execution's session agent may use; pass the
|
|
42
|
+
* `execution` given to `main`. Fails outside a running execution of the
|
|
43
|
+
* session's current turn.
|
|
44
|
+
*
|
|
45
|
+
* @readonly
|
|
46
|
+
* @openworld
|
|
47
|
+
* @mcp-exclude Needs the CodeExecution of a running program.
|
|
48
|
+
*/
|
|
49
|
+
list(execution: CodeExecution): Promise<ConnectedApp[]>;
|
|
50
|
+
/**
|
|
51
|
+
* Find tools across every connected app the execution's agent was given,
|
|
52
|
+
* by keywords matched against tool names and descriptions (e.g. `linear
|
|
53
|
+
* issue`), best first, at most 20. Apps whose tools could not be read come
|
|
54
|
+
* back in `unsearched`, not as an error.
|
|
55
|
+
*
|
|
56
|
+
* @readonly
|
|
57
|
+
* @openworld
|
|
58
|
+
* @mcp-exclude Needs the CodeExecution of a running program.
|
|
59
|
+
*/
|
|
60
|
+
searchTools(execution: CodeExecution, query: string): Promise<{
|
|
61
|
+
matches: ConnectedTool[];
|
|
62
|
+
unsearched: ConnectedApp[];
|
|
63
|
+
}>;
|
|
64
|
+
/**
|
|
65
|
+
* Search the catalog of apps the user could connect, by app name (e.g.
|
|
66
|
+
* `Linear`, not a task description). Inspect a result before recommending
|
|
67
|
+
* it: its description alone does not show what it can do.
|
|
68
|
+
*
|
|
69
|
+
* @readonly
|
|
70
|
+
* @mcp-exclude Needs the CodeExecution of a running program.
|
|
71
|
+
*/
|
|
72
|
+
discover(execution: CodeExecution, appName: string): Promise<{
|
|
73
|
+
connectors: Connector[];
|
|
74
|
+
moreResults: boolean;
|
|
75
|
+
}>;
|
|
76
|
+
/**
|
|
77
|
+
* Add a remote MCP server to the execution account's connections by its
|
|
78
|
+
* URL: only one the user gave you, or an official URL you are sure of;
|
|
79
|
+
* never guess. Most servers then need the user to sign in under
|
|
80
|
+
* Settings → Connections, which the result's `summary` says. A URL the
|
|
81
|
+
* user already has is left as it is.
|
|
82
|
+
*
|
|
83
|
+
* @write
|
|
84
|
+
* @idempotent
|
|
85
|
+
* @openworld
|
|
86
|
+
* @mcp-exclude Needs the CodeExecution of a running program.
|
|
87
|
+
*/
|
|
88
|
+
addServer(execution: CodeExecution, server: {
|
|
89
|
+
url: string;
|
|
90
|
+
serverName: string;
|
|
91
|
+
}): Promise<ConnectMcpServerResponse>;
|
|
92
|
+
}
|