@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,291 @@
|
|
|
1
|
+
import type { RoxClient } from '../../utils/client';
|
|
2
|
+
import type { EmailAttachment } from '../email/attachment';
|
|
3
|
+
import type { Project } from '../projects/project';
|
|
4
|
+
import type { SearchOpts } from '../search/options';
|
|
5
|
+
import { Spreadsheet } from '../spreadsheets/spreadsheet';
|
|
6
|
+
import type { Team } from '../teams/team';
|
|
7
|
+
import { User } from '../users/user';
|
|
8
|
+
import { Document } from './document';
|
|
9
|
+
import { SystemSkill } from './system-skill';
|
|
10
|
+
/** One skill found by {@link DocumentNamespace.skills}. */
|
|
11
|
+
export interface SkillListing {
|
|
12
|
+
/**
|
|
13
|
+
* The skill: a skill document, or a built-in skill with no document. Read
|
|
14
|
+
* either one's instructions with `content()`.
|
|
15
|
+
*/
|
|
16
|
+
skill: Document | SystemSkill;
|
|
17
|
+
/** The skill's name. */
|
|
18
|
+
name: string;
|
|
19
|
+
/** When to use the skill, when it says. Built-in skills have none. */
|
|
20
|
+
description: string | undefined;
|
|
21
|
+
/** When the skill document was last updated (ISO 8601); built-in skills have none. */
|
|
22
|
+
updatedAt: string | undefined;
|
|
23
|
+
}
|
|
24
|
+
/** A file's content: its bytes, or text stored as UTF-8. */
|
|
25
|
+
export type FileContent = Uint8Array<ArrayBuffer> | ArrayBuffer | Blob | string;
|
|
26
|
+
/**
|
|
27
|
+
* @routing Use when writing, creating, reading or editing a document of any kind, such as a brief, notes, a spec, a canvas, a spreadsheet or a deck; not databases, tasks or email.
|
|
28
|
+
*
|
|
29
|
+
* @agent
|
|
30
|
+
* ## Changing a document's text
|
|
31
|
+
*
|
|
32
|
+
* Change the text of an existing Markdown document or task body in place, with `document.edit(instructions)` in code or the `EditDocument` tool where code isn't available. Never recreate the document or upload its Markdown to change its text. PDF, Word and other uploaded files can't be edited this way.
|
|
33
|
+
*
|
|
34
|
+
* When a program already holds the exact new Markdown, as an integration syncing from another system does, read `document.contentWithRevision()` and write with `document.setContent(markdown, {expectedRevision})`: the write lands only if nobody changed the document since the read, and throws `DocumentChangedError` otherwise, so read again and reapply instead of overwriting.
|
|
35
|
+
*
|
|
36
|
+
* `document.content()`, `contentWithRevision()` and `initiative.description()` return Macro's lossless Markdown: people, documents, dates and other chips, tables, images and equations are `<m-*>` tags with a JSON body, such as `<m-user-mention>{"userId":"…"}</m-user-mention>` for a person and `<m-table>` for a table. To write text back, take it and its revision from one `contentWithRevision()` read, and copy every tag you are not changing exactly as you read it: an edited tag changes its chip, and a dropped one deletes it.
|
|
37
|
+
*
|
|
38
|
+
* ## Uploaded Office and design files
|
|
39
|
+
*
|
|
40
|
+
* Edit an uploaded Word file with `readWord()` then `editWord(operations)`, and a PowerPoint deck with `readPresentation()` then `editPresentation(operations)` (or `copyPresentation()` for a new deck): both address paragraphs, slides and shapes by the ids the read reports. Read Figma, Photoshop and Illustrator files with `readDesign()`, `readPhotoshop()` and `readIllustrator()`; they can't be edited. Never rebuild these files from `bytes()`.
|
|
41
|
+
*
|
|
42
|
+
* ## New spreadsheets
|
|
43
|
+
*
|
|
44
|
+
* `createSpreadsheet` saves the spreadsheet before it returns, so it exists even when a later step of the program throws. Keep its id across that failure: fill it inside `try`/`catch` and return `{ data: { spreadsheet: sheet, error } }` (the handle serializes as its `id` and `url`). To retry, reopen it with `rox.documents.spreadsheet(rox.documents.byId(id))`; never search recent documents for it or create another.
|
|
45
|
+
*
|
|
46
|
+
* ## Linking Rox items inside document content
|
|
47
|
+
*
|
|
48
|
+
* `CreateDocument` content (the `fileContent` argument) is rendered with the same Markdown parser used for chat responses, channel messages, and email bodies inside the Rox app — but only for Markdown (`.md`) documents. Non-Markdown documents (e.g. PDF, CSV, PNG, XLSX, DOCX, created by passing a non-`md` `file_extension`) are stored as raw file bytes and must never contain Markdown syntax or mention tags.
|
|
49
|
+
*
|
|
50
|
+
* For Markdown document content, link to other Rox documents, channels, chats, projects, tasks, or email threads using `<m-document-mention>` XML mention tags, e.g.:
|
|
51
|
+
*
|
|
52
|
+
* `<m-document-mention>{"documentId":"{id}","documentName":"","blockName":"md","blockParams":{}}</m-document-mention>`
|
|
53
|
+
*
|
|
54
|
+
* The same Markdown parser also renders the other in-app chip tags: `<m-date-mention>` for a day or time, `<m-agent-session-mention>` for an agent session (add `"expanded":true` for the card that follows the latest turn), `<m-user-mention>` / `<m-contact-mention>` / `<m-group-mention>` for people and groups, `<m-pr-mention>` for a pull request, and `<m-booking-link-mention>` for a booking link. Use those tags in document content the same way you would in a chat reply.
|
|
55
|
+
*
|
|
56
|
+
* Reference a GitHub pull request with a PR chip rather than a Markdown link or bare URL: `<m-pr-mention>{"url":"https://github.com/{owner}/{repo}/pull/{number}","label":""}</m-pr-mention>`. Put the PR's github.com URL in `url`; no Macro id is needed. This applies to Markdown document content and to `SendChannelMessage` content, which uses the same Markdown syntax. The chip shows the PR's number, title, and live status and opens it in Macro, so leave `label` empty and do not repeat the number or title beside it. Issues, commits, and other GitHub pages stay Markdown links. Your own chat replies to the MCP client still link pull requests as plain Markdown URLs.
|
|
57
|
+
*
|
|
58
|
+
* Reference a Rox booking link with a booking-link chip rather than a Markdown link or bare URL: `<m-booking-link-mention>{"profileId":"{profile_id}","slug":"{slug}","url":"{booking_url}","label":""}</m-booking-link-mention>` (`slug` optional when linking the profile page). Put the shareable URL in `url` and the path's profile id (and slug when present) in `profileId`/`slug`. Leave `label` empty. Your own chat replies to the MCP client still link booking pages as plain Markdown URLs.
|
|
59
|
+
*
|
|
60
|
+
* This holds true even when `CreateDocument` is called through the MCP server, where you are otherwise told to link items in your own chat replies as plain Markdown URLs — that rule is about your conversational responses to the MCP client, not about content you write into a Rox document. Do NOT use plain Markdown links or bare URLs to reference other Rox items inside document content; only `<m-document-mention>` tags (and the other chip tags above) render as working links there.
|
|
61
|
+
*
|
|
62
|
+
* The same applies to `EditDocument`: when its `instructions` ask for a mention chip (person, date/time, document, agent session, booking link, and so on) or a document-card, include the referenced item's ids and details so the editing worker can construct the correct in-app markup itself. Date chips need an ISO datetime and displayFormat; they do not need a looked-up id. Booking-link chips need profileId, url, and slug when the URL has one.
|
|
63
|
+
*/
|
|
64
|
+
export declare class DocumentNamespace {
|
|
65
|
+
private readonly client;
|
|
66
|
+
/**
|
|
67
|
+
* Resolve a team task reference such as ENG-42.
|
|
68
|
+
*
|
|
69
|
+
* @readonly
|
|
70
|
+
*/
|
|
71
|
+
byTeamSlug(slug: string): Promise<Document>;
|
|
72
|
+
/**
|
|
73
|
+
* Validate a permissions token, returning its document and optional user handles.
|
|
74
|
+
*
|
|
75
|
+
* @readonly
|
|
76
|
+
*/
|
|
77
|
+
validatePermissionsToken(token: string): Promise<{
|
|
78
|
+
document: Document;
|
|
79
|
+
user: User | undefined;
|
|
80
|
+
accessLevel: import("../../../generated/storage").AccessLevel;
|
|
81
|
+
expiresAt: number;
|
|
82
|
+
issuer: string;
|
|
83
|
+
}>;
|
|
84
|
+
/**
|
|
85
|
+
* Upload a file as a new document, up to 25 MiB: generated output such as a
|
|
86
|
+
* CSV, a rendered PDF or an image, or bytes read with `Document.bytes()`.
|
|
87
|
+
* Use `create` for Markdown you want to edit in Rox.
|
|
88
|
+
*
|
|
89
|
+
* `name` is the filename with its extension, which sets the file type
|
|
90
|
+
* (`report.pdf`, `data.csv`). `content` is the file's bytes, or a string
|
|
91
|
+
* stored as UTF-8 text. Uploading into `project` needs edit access to it.
|
|
92
|
+
* The document is ready to read and attach when this resolves; its preview
|
|
93
|
+
* and search indexing finish shortly after.
|
|
94
|
+
*
|
|
95
|
+
* @example Upload a generated CSV and share it in a channel.
|
|
96
|
+
* ```js
|
|
97
|
+
* const rows = [['name', 'amount'], ['Acme', 1200]];
|
|
98
|
+
* const file = await rox.documents.upload({
|
|
99
|
+
* name: 'invoices.csv',
|
|
100
|
+
* content: rows.map((row) => row.join(',')).join('\n'),
|
|
101
|
+
* });
|
|
102
|
+
* await channel.send('Invoices attached.', { documents: [file] });
|
|
103
|
+
* ```
|
|
104
|
+
*
|
|
105
|
+
* @write
|
|
106
|
+
*/
|
|
107
|
+
upload(options: {
|
|
108
|
+
name: string;
|
|
109
|
+
content: FileContent;
|
|
110
|
+
project?: Project;
|
|
111
|
+
}): Promise<Document>;
|
|
112
|
+
/**
|
|
113
|
+
* Reserve a binary document and return a presigned URL to PUT its content
|
|
114
|
+
* to. The URL is outside the hosts code mode can reach; use `upload` there.
|
|
115
|
+
*
|
|
116
|
+
* @write
|
|
117
|
+
*/
|
|
118
|
+
createUpload(options: {
|
|
119
|
+
name: string;
|
|
120
|
+
sha: string;
|
|
121
|
+
fileType?: string;
|
|
122
|
+
mimeType?: string;
|
|
123
|
+
project?: Project;
|
|
124
|
+
team?: Team;
|
|
125
|
+
branchedFrom?: Document;
|
|
126
|
+
attachment?: EmailAttachment;
|
|
127
|
+
isTask?: boolean;
|
|
128
|
+
}): Promise<{
|
|
129
|
+
document: Document;
|
|
130
|
+
uploadUrl: string | undefined;
|
|
131
|
+
contentType: string;
|
|
132
|
+
content: import("../../../generated/storage").DocumentContent;
|
|
133
|
+
}>;
|
|
134
|
+
constructor(client: RoxClient);
|
|
135
|
+
/** A handle to a document by id. Details load on first access. */
|
|
136
|
+
byId(id: string): Document;
|
|
137
|
+
/**
|
|
138
|
+
* Create a markdown document.
|
|
139
|
+
*
|
|
140
|
+
* @write
|
|
141
|
+
*/
|
|
142
|
+
create(opts: {
|
|
143
|
+
name: string;
|
|
144
|
+
markdown?: string;
|
|
145
|
+
project?: Project;
|
|
146
|
+
}): Promise<Document>;
|
|
147
|
+
/**
|
|
148
|
+
* Create a native Canvas with shared content ready for reading and editing;
|
|
149
|
+
* work on it with `document.canvas()`.
|
|
150
|
+
*
|
|
151
|
+
* @write
|
|
152
|
+
*/
|
|
153
|
+
createCanvas(opts: {
|
|
154
|
+
name: string;
|
|
155
|
+
project?: Project;
|
|
156
|
+
}): Promise<Document>;
|
|
157
|
+
/**
|
|
158
|
+
* Create a blank native spreadsheet, ready to read and edit; fill it with
|
|
159
|
+
* `applyEdits`. It is saved before this returns: keep its `id` even when
|
|
160
|
+
* filling it fails, and reopen it by id rather than creating another.
|
|
161
|
+
*
|
|
162
|
+
* @example Create and fill a budget, keeping the spreadsheet if a step fails.
|
|
163
|
+
* ```js
|
|
164
|
+
* const sheet = await rox.documents.createSpreadsheet({ name: 'Q4 budget' });
|
|
165
|
+
* try {
|
|
166
|
+
* const { revision, sheets } = await sheet.read();
|
|
167
|
+
* await sheet.applyEdits(
|
|
168
|
+
* [{ type: 'set_cells', sheetId: sheets[0].id, cells: [
|
|
169
|
+
* { address: 'A1', value: 'Item' }, { address: 'B1', value: 'Cost' },
|
|
170
|
+
* { address: 'A2', value: 'Laptops' }, { address: 'B2', value: 4200 },
|
|
171
|
+
* { address: 'A3', value: 'Total' }, { address: 'B3', value: '=SUM(B2:B2)' },
|
|
172
|
+
* ] }],
|
|
173
|
+
* { expectedRevision: revision },
|
|
174
|
+
* );
|
|
175
|
+
* return { data: { spreadsheet: sheet } };
|
|
176
|
+
* } catch (error) {
|
|
177
|
+
* return { data: { spreadsheet: sheet, error: String(error) } };
|
|
178
|
+
* }
|
|
179
|
+
* ```
|
|
180
|
+
*
|
|
181
|
+
* @write
|
|
182
|
+
*/
|
|
183
|
+
createSpreadsheet(opts: {
|
|
184
|
+
name: string;
|
|
185
|
+
project?: Project;
|
|
186
|
+
}): Promise<Spreadsheet>;
|
|
187
|
+
/**
|
|
188
|
+
* Read, calculate and edit a document as a native spreadsheet, such as a
|
|
189
|
+
* search result or mention. Its methods refuse a document of another type.
|
|
190
|
+
*
|
|
191
|
+
* @readonly
|
|
192
|
+
*/
|
|
193
|
+
spreadsheet(document: Document): Spreadsheet;
|
|
194
|
+
/**
|
|
195
|
+
* Create a snippet: a reusable markdown document.
|
|
196
|
+
*
|
|
197
|
+
* @write
|
|
198
|
+
*/
|
|
199
|
+
createSnippet(opts: {
|
|
200
|
+
name: string;
|
|
201
|
+
markdown?: string;
|
|
202
|
+
project?: Project;
|
|
203
|
+
}): Promise<Document>;
|
|
204
|
+
/**
|
|
205
|
+
* Create a skill: markdown instructions that AI reads and follows.
|
|
206
|
+
*
|
|
207
|
+
* A skill is a markdown document, so read one with `content()`, by the id of
|
|
208
|
+
* a skill mention or of a search result:
|
|
209
|
+
*
|
|
210
|
+
* ```js
|
|
211
|
+
* const skill = rox.documents.byId(skillId);
|
|
212
|
+
* const instructions = await skill.content();
|
|
213
|
+
* ```
|
|
214
|
+
*
|
|
215
|
+
* Read a skill the request names before doing the task, and follow it for
|
|
216
|
+
* that request only. Find skills, built-in ones included, with `skills()`.
|
|
217
|
+
*
|
|
218
|
+
* `description` says when to use the skill, in one line starting "Use when"
|
|
219
|
+
* (at most 300 characters); agents load the skill for requests it describes.
|
|
220
|
+
*
|
|
221
|
+
* @write
|
|
222
|
+
*/
|
|
223
|
+
createSkill(opts: {
|
|
224
|
+
name: string;
|
|
225
|
+
description: string;
|
|
226
|
+
markdown?: string;
|
|
227
|
+
project?: Project;
|
|
228
|
+
}): Promise<Document>;
|
|
229
|
+
/**
|
|
230
|
+
* Find skills by name, or list them, built-in skills included; read the
|
|
231
|
+
* instructions of the one a request needs with `skill.content()` before
|
|
232
|
+
* doing the task, and follow them for that request only.
|
|
233
|
+
*
|
|
234
|
+
* With `query`, searches skill names: pass 1-3 words that literally appear
|
|
235
|
+
* in the name, matched as one adjacent phrase whose last word may be a
|
|
236
|
+
* prefix (`matchType: 'exact'` for whole words). Without it, lists the 100
|
|
237
|
+
* most recently updated skills. User skills come first, most recently
|
|
238
|
+
* updated first, then built-in skills.
|
|
239
|
+
*
|
|
240
|
+
* ```js
|
|
241
|
+
* const [match] = await rox.documents.skills({ query: 'deploy' });
|
|
242
|
+
* const instructions = match && (await match.skill.content());
|
|
243
|
+
* ```
|
|
244
|
+
*
|
|
245
|
+
* @readonly
|
|
246
|
+
*/
|
|
247
|
+
skills(opts?: {
|
|
248
|
+
query?: string;
|
|
249
|
+
matchType?: 'partial' | 'exact';
|
|
250
|
+
}): Promise<SkillListing[]>;
|
|
251
|
+
/**
|
|
252
|
+
* The built-in system skills: static AI instructions with no document
|
|
253
|
+
* behind them. Unlike user skills they cannot be opened or edited; read
|
|
254
|
+
* their instructions with `content()`.
|
|
255
|
+
*
|
|
256
|
+
* @readonly
|
|
257
|
+
*/
|
|
258
|
+
systemSkills(): Promise<SystemSkill[]>;
|
|
259
|
+
/**
|
|
260
|
+
* Search documents by name and content, most relevant first, auto-paginated; `maxItems` caps the total.
|
|
261
|
+
*
|
|
262
|
+
* @readonly
|
|
263
|
+
*/
|
|
264
|
+
search(query: string, opts?: SearchOpts): AsyncGenerator<Document>;
|
|
265
|
+
/**
|
|
266
|
+
* The user's recent documents, most recent first, auto-paginated; `maxItems` caps the total.
|
|
267
|
+
*
|
|
268
|
+
* @readonly
|
|
269
|
+
*/
|
|
270
|
+
recent(opts?: {
|
|
271
|
+
pageSize?: number;
|
|
272
|
+
fileType?: string;
|
|
273
|
+
maxItems?: number;
|
|
274
|
+
}): AsyncGenerator<Document>;
|
|
275
|
+
/**
|
|
276
|
+
* The documents among the user's 100 most recently trashed items; page
|
|
277
|
+
* through the whole trash with `trashed()`.
|
|
278
|
+
*
|
|
279
|
+
* @readonly
|
|
280
|
+
*/
|
|
281
|
+
recentlyDeleted(): Promise<Document[]>;
|
|
282
|
+
/**
|
|
283
|
+
* The user's trashed documents, most recently trashed first, auto-paginated; `maxItems` caps the total.
|
|
284
|
+
*
|
|
285
|
+
* @readonly
|
|
286
|
+
*/
|
|
287
|
+
trashed(opts?: {
|
|
288
|
+
pageSize?: number;
|
|
289
|
+
maxItems?: number;
|
|
290
|
+
}): AsyncGenerator<Document>;
|
|
291
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import type { CreatedItem, EditOp, WordDocumentOperation } from '../../../generated/storage/types.gen';
|
|
2
|
+
import type { Document } from './document';
|
|
3
|
+
/**
|
|
4
|
+
* One PowerPoint edit operation, discriminated by `op` (`setText`,
|
|
5
|
+
* `formatText`, `addShape`, `addSlide`, `setChartData`, `replaceText`, ...).
|
|
6
|
+
* Slides and shapes are addressed by the ids `readPresentation()` reports,
|
|
7
|
+
* positions and sizes are in points, and colors are RRGGBB hex or theme names.
|
|
8
|
+
*/
|
|
9
|
+
export type PresentationEditOperation = EditOp;
|
|
10
|
+
/**
|
|
11
|
+
* One Word edit operation, discriminated by `type` (`replaceText`, `setText`,
|
|
12
|
+
* `formatText`, `insertParagraph`, `delete`, `setStyle`, `addComment`).
|
|
13
|
+
* Paragraphs and blocks are addressed by the ids `readWord()` reports.
|
|
14
|
+
*/
|
|
15
|
+
export type WordEditOperation = WordDocumentOperation;
|
|
16
|
+
/** A slide, shape or section a presentation edit created. */
|
|
17
|
+
export type PresentationCreatedItem = CreatedItem;
|
|
18
|
+
/** What a presentation edit did. */
|
|
19
|
+
export interface PresentationEditResult {
|
|
20
|
+
/** Slides and shapes the operations created, in order. */
|
|
21
|
+
created: PresentationCreatedItem[];
|
|
22
|
+
/**
|
|
23
|
+
* Whether slides were added, removed or reordered, or the slide size or
|
|
24
|
+
* sections changed.
|
|
25
|
+
*/
|
|
26
|
+
structureChanged: boolean;
|
|
27
|
+
/** The changed slides as they now read. */
|
|
28
|
+
changedSlides: string;
|
|
29
|
+
}
|
|
30
|
+
/** An edited copy of a presentation, created as a new document. */
|
|
31
|
+
export interface PresentationCopy extends PresentationEditResult {
|
|
32
|
+
/** The new presentation. */
|
|
33
|
+
document: Document;
|
|
34
|
+
}
|
|
35
|
+
/** Options for `Document.editWord`. */
|
|
36
|
+
export interface WordEditOptions {
|
|
37
|
+
/**
|
|
38
|
+
* Record the edits as tracked changes (`true`) or apply them directly
|
|
39
|
+
* (`false`). Omit to follow the document's own Track Changes setting.
|
|
40
|
+
*/
|
|
41
|
+
trackChanges?: boolean;
|
|
42
|
+
/**
|
|
43
|
+
* Name the tracked changes and comments are attributed to. Omit to use the
|
|
44
|
+
* requesting user's name; pass one only when the user names someone else.
|
|
45
|
+
*/
|
|
46
|
+
author?: string;
|
|
47
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { RoxClient } from '../../utils/client';
|
|
2
|
+
/**
|
|
3
|
+
* A built-in system skill: static, code-defined AI instructions that surface
|
|
4
|
+
* to AI like skill documents but have no document behind them. System skills
|
|
5
|
+
* cannot be opened, edited, or deleted; reference them in AI inputs by id the
|
|
6
|
+
* same way as skill documents, and read their instructions with `content()`.
|
|
7
|
+
*
|
|
8
|
+
* @mcp-exclude Built from a listing record; no id-only reference an MCP call can pass.
|
|
9
|
+
*/
|
|
10
|
+
export declare class SystemSkill {
|
|
11
|
+
private readonly client;
|
|
12
|
+
/** The well-known id the skill is referenced by in mentions and AI tools. */
|
|
13
|
+
readonly id: string;
|
|
14
|
+
/** The skill's display name. */
|
|
15
|
+
readonly name: string;
|
|
16
|
+
private constructor();
|
|
17
|
+
/**
|
|
18
|
+
* The skill's complete markdown instructions. Read them before doing the
|
|
19
|
+
* task the skill was named for, and follow them for that request only.
|
|
20
|
+
*
|
|
21
|
+
* @readonly
|
|
22
|
+
*/
|
|
23
|
+
content(): Promise<string>;
|
|
24
|
+
/** Identity and name, without the authenticated client. */
|
|
25
|
+
toJSON(): {
|
|
26
|
+
id: string;
|
|
27
|
+
name: string;
|
|
28
|
+
};
|
|
29
|
+
/** The built-in system skills, in display order. */
|
|
30
|
+
static list(client: RoxClient): Promise<SystemSkill[]>;
|
|
31
|
+
/** Wrap a built-in skill from a record already in hand, such as a skill listing. */
|
|
32
|
+
static from(client: RoxClient, record: {
|
|
33
|
+
id: string;
|
|
34
|
+
name: string;
|
|
35
|
+
}): SystemSkill;
|
|
36
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import type { CommentOnTextRefused } from '../../../generated/storage/types.gen';
|
|
2
|
+
import { type RichMessage } from '../../mentions';
|
|
3
|
+
import type { RoxClient } from '../../utils/client';
|
|
4
|
+
import { RoxApiError } from '../../utils/unwrap';
|
|
5
|
+
import { Comment } from './comment';
|
|
6
|
+
import type { Document } from './document';
|
|
7
|
+
/** Where `Document.commentOnText` anchors its comment. */
|
|
8
|
+
export interface TextCommentOptions {
|
|
9
|
+
/**
|
|
10
|
+
* The passage to comment on, quoted exactly as the document reads: plain
|
|
11
|
+
* text without markdown syntax such as `**` or link brackets, within one
|
|
12
|
+
* paragraph, heading, list item or table cell. Keep it to the words the
|
|
13
|
+
* comment is about; a longer quote is more likely to be unique.
|
|
14
|
+
*/
|
|
15
|
+
quote: string;
|
|
16
|
+
/**
|
|
17
|
+
* Which appearance of the quote, counting from 1 in document order. Only
|
|
18
|
+
* needed when it appears more than once; a Word document takes only the
|
|
19
|
+
* first.
|
|
20
|
+
*/
|
|
21
|
+
occurrence?: number;
|
|
22
|
+
}
|
|
23
|
+
/** A comment anchored to text, and the text it is anchored to. */
|
|
24
|
+
export interface TextComment {
|
|
25
|
+
/** The posted comment, the root of a new thread. */
|
|
26
|
+
comment: Comment;
|
|
27
|
+
/** The text the comment is anchored to, as the document reads. */
|
|
28
|
+
markedText: string;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* The quote appears more than once, or not at all (HTTP 422). Nothing was
|
|
32
|
+
* posted. `reason` lists each appearance to choose from with `occurrence`, or
|
|
33
|
+
* says the text was not found: read the document again rather than guessing.
|
|
34
|
+
*/
|
|
35
|
+
export declare class CommentQuoteNotPlacedError extends RoxApiError {
|
|
36
|
+
/** Why the quote could not be anchored, in the document's words. */
|
|
37
|
+
readonly reason: string;
|
|
38
|
+
constructor(refusal: CommentOnTextRefused);
|
|
39
|
+
}
|
|
40
|
+
/** Post a comment on quoted text; `Document.commentOnText` calls this. */
|
|
41
|
+
export declare function commentOnText(client: RoxClient, document: Document, body: string | RichMessage, options: TextCommentOptions): Promise<TextComment>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import type { GetDocumentResponseData } from '../../../generated/storage/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import type { Document } from './document';
|
|
4
|
+
/** An immutable document version, scoped to its document. */
|
|
5
|
+
export declare class DocumentVersion {
|
|
6
|
+
private readonly client;
|
|
7
|
+
/** Parent document. */
|
|
8
|
+
readonly document: Document;
|
|
9
|
+
/** Version number. */
|
|
10
|
+
readonly id: number;
|
|
11
|
+
private readonly detail;
|
|
12
|
+
private constructor();
|
|
13
|
+
/** Construct a version handle. */
|
|
14
|
+
static byId(client: RoxClient, document: Document, id: number): DocumentVersion;
|
|
15
|
+
/**
|
|
16
|
+
* Version metadata and the caller's access.
|
|
17
|
+
*
|
|
18
|
+
* @readonly
|
|
19
|
+
*/
|
|
20
|
+
read(): Promise<GetDocumentResponseData>;
|
|
21
|
+
/** Serialize only scoped identity. */
|
|
22
|
+
toJSON(): {
|
|
23
|
+
id: number;
|
|
24
|
+
documentId: string;
|
|
25
|
+
};
|
|
26
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import type { GetAttachmentResponses } from '../../../generated/email/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import { Document } from '../documents/document';
|
|
4
|
+
import { RoxEntity } from '../entity';
|
|
5
|
+
/** The API's representation of an email attachment (`Attachment`). */
|
|
6
|
+
export type EmailAttachmentData = GetAttachmentResponses[200]['attachment'];
|
|
7
|
+
/**
|
|
8
|
+
* A file attached to an email message. A thin handle keyed by attachment id;
|
|
9
|
+
* the record loads lazily on first field access.
|
|
10
|
+
*/
|
|
11
|
+
export declare class EmailAttachment extends RoxEntity<EmailAttachmentData> {
|
|
12
|
+
protected fetch(): Promise<EmailAttachmentData>;
|
|
13
|
+
/** A handle to an attachment by id. Fields load on first access. */
|
|
14
|
+
static byId(client: RoxClient, id: string): EmailAttachment;
|
|
15
|
+
/** Build an attachment from an already-fetched record (pre-seeded, no fetch). */
|
|
16
|
+
static from(client: RoxClient, data: EmailAttachmentData): EmailAttachment;
|
|
17
|
+
/** The attachment's original filename. */
|
|
18
|
+
readonly filename: () => Promise<string | undefined>;
|
|
19
|
+
/** The attachment's MIME type. */
|
|
20
|
+
readonly mimeType: () => Promise<string | undefined>;
|
|
21
|
+
/** The attachment's size in bytes. */
|
|
22
|
+
readonly size: () => Promise<number | undefined>;
|
|
23
|
+
/** A URL to the attachment's raw data, when available. */
|
|
24
|
+
readonly dataUrl: () => Promise<string | undefined>;
|
|
25
|
+
/** The attachment's static-file-service id, when it has been stored there. */
|
|
26
|
+
readonly sfsId: () => Promise<string | undefined>;
|
|
27
|
+
/** The attachment's Content-ID header value (for inline attachments). */
|
|
28
|
+
readonly contentId: () => Promise<string | undefined>;
|
|
29
|
+
/**
|
|
30
|
+
* The Rox document holding this attachment's content. Get-or-create: the
|
|
31
|
+
* server returns the existing document's id, or downloads the attachment
|
|
32
|
+
* from the provider and uploads it as a new document first (deduplicated
|
|
33
|
+
* behind a server-side lock).
|
|
34
|
+
*
|
|
35
|
+
* @write
|
|
36
|
+
* @idempotent
|
|
37
|
+
*/
|
|
38
|
+
toDocument(): Promise<Document>;
|
|
39
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The editor document used to be the Macro body. Payloads written before the
|
|
3
|
+
* rename — stored drafts, queued sends, cached threads — can still carry the
|
|
4
|
+
* former names, so readers accept both and prefer the Rox ones. Writers emit
|
|
5
|
+
* only the Rox names.
|
|
6
|
+
*/
|
|
7
|
+
export type BodyNames = {
|
|
8
|
+
body_rox?: string | null;
|
|
9
|
+
bodyRox?: string | null;
|
|
10
|
+
body_macro?: string | null;
|
|
11
|
+
bodyMacro?: string | null;
|
|
12
|
+
};
|
|
13
|
+
export type RestoreBodyNames = {
|
|
14
|
+
restore_body_rox?: string | null;
|
|
15
|
+
restoreBodyRox?: string | null;
|
|
16
|
+
restore_body_macro?: string | null;
|
|
17
|
+
restoreBodyMacro?: string | null;
|
|
18
|
+
};
|
|
19
|
+
/** Read the editor body from a payload, preferring the Rox name over the former Macro one. */
|
|
20
|
+
export declare function readBodyRox(source: BodyNames | null | undefined): string | null;
|
|
21
|
+
/** Read the body a failed send restores to the editor, preferring the Rox name. */
|
|
22
|
+
export declare function readRestoreBodyRox(source: RestoreBodyNames | null | undefined): string | null;
|
|
@@ -0,0 +1,164 @@
|
|
|
1
|
+
import type { ApiDraftInput } from '../../../generated/email/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import type { EmailAttachment } from './attachment';
|
|
4
|
+
import { EmailMessage } from './message';
|
|
5
|
+
import type { EmailThread } from './thread';
|
|
6
|
+
/** Draft content; relationships use message and thread handles. */
|
|
7
|
+
export type DraftOptions = Omit<ApiDraftInput, 'db_id' | 'provider_id' | 'provider_thread_id' | 'replying_to_id' | 'thread_db_id' | 'body_text' | 'body_html' | 'body_rox' | 'headers_json' | 'include_signature' | 'draft_generation'> & {
|
|
8
|
+
/** Generation captured when editing began; defaults to the loaded draft. */
|
|
9
|
+
draftGeneration?: number;
|
|
10
|
+
/** Plain text body. */
|
|
11
|
+
bodyText?: string;
|
|
12
|
+
/** HTML body. */
|
|
13
|
+
bodyHtml?: string;
|
|
14
|
+
/** Rox body. */
|
|
15
|
+
bodyRox?: string;
|
|
16
|
+
/** Former name for `bodyRox`; payloads written before the rename still carry it. */
|
|
17
|
+
bodyMacro?: string;
|
|
18
|
+
/** Former wire name for `bodyRox`; accepted from older payloads. */
|
|
19
|
+
body_macro?: string;
|
|
20
|
+
/** Extra headers. */
|
|
21
|
+
headers?: ApiDraftInput['headers_json'];
|
|
22
|
+
/** Include the inbox signature. */
|
|
23
|
+
includeSignature?: boolean;
|
|
24
|
+
/** Thread receiving this draft. */
|
|
25
|
+
thread?: EmailThread;
|
|
26
|
+
/** Message being replied to. */
|
|
27
|
+
replyingTo?: EmailMessage;
|
|
28
|
+
};
|
|
29
|
+
/** Options for sending or scheduling a saved draft. */
|
|
30
|
+
export interface DraftSendOptions {
|
|
31
|
+
/** `false` leaves the inbox signature off this one email; omit for the inbox's default. */
|
|
32
|
+
includeSignature?: boolean;
|
|
33
|
+
/**
|
|
34
|
+
* The user's own reply approving this send, quoted verbatim. Required from
|
|
35
|
+
* an agent's program; never the request that asked for the email.
|
|
36
|
+
*/
|
|
37
|
+
userConfirmation?: string;
|
|
38
|
+
}
|
|
39
|
+
/** A draft email. Sending remains an explicit separate operation. */
|
|
40
|
+
export declare class EmailDraft extends EmailMessage {
|
|
41
|
+
private draftContext;
|
|
42
|
+
/** Construct a lazy draft handle. */
|
|
43
|
+
static byId(client: RoxClient, id: string): EmailDraft;
|
|
44
|
+
/** Edit generation to capture with content before saving or transferring it. */
|
|
45
|
+
readonly draftGeneration: () => Promise<number | undefined>;
|
|
46
|
+
/**
|
|
47
|
+
* Replace draft content without changing its identity or sending it.
|
|
48
|
+
*
|
|
49
|
+
* @destructive
|
|
50
|
+
* @openworld
|
|
51
|
+
* @idempotent
|
|
52
|
+
*/
|
|
53
|
+
update(options: DraftOptions): Promise<void>;
|
|
54
|
+
/**
|
|
55
|
+
* Delete the draft.
|
|
56
|
+
*
|
|
57
|
+
* @destructive
|
|
58
|
+
* @openworld
|
|
59
|
+
* @idempotent
|
|
60
|
+
*/
|
|
61
|
+
delete(): Promise<void>;
|
|
62
|
+
/**
|
|
63
|
+
* Schedule this draft for sending; an agent's program must quote the user's reply approving this send in `userConfirmation`, or it is refused (403).
|
|
64
|
+
*
|
|
65
|
+
* The draft goes out as saved, attachments included, at `sendTime` (ISO
|
|
66
|
+
* 8601, in the future). Write the draft out for the user and ask before
|
|
67
|
+
* scheduling it; the request that asked for the email is not the approval.
|
|
68
|
+
*
|
|
69
|
+
* @send
|
|
70
|
+
* @openworld
|
|
71
|
+
*/
|
|
72
|
+
schedule(sendTime: string, options?: DraftSendOptions): Promise<void>;
|
|
73
|
+
/**
|
|
74
|
+
* Send this draft now, as saved; an agent's program must quote the user's reply approving this send in `userConfirmation`, or it is refused (403).
|
|
75
|
+
*
|
|
76
|
+
* The draft is handed to the scheduled sender, which delivers it within
|
|
77
|
+
* about a minute; until then {@link unschedule} still stops it. Write the
|
|
78
|
+
* draft out for the user and ask before sending it.
|
|
79
|
+
*
|
|
80
|
+
* @send
|
|
81
|
+
* @openworld
|
|
82
|
+
*/
|
|
83
|
+
send(options?: DraftSendOptions): Promise<void>;
|
|
84
|
+
/**
|
|
85
|
+
* Remove a scheduled send.
|
|
86
|
+
*
|
|
87
|
+
* @write
|
|
88
|
+
* @openworld
|
|
89
|
+
* @idempotent
|
|
90
|
+
*/
|
|
91
|
+
unschedule(): Promise<void>;
|
|
92
|
+
/**
|
|
93
|
+
* Reserve an attachment upload. Upload to the returned URL, then call complete().
|
|
94
|
+
*
|
|
95
|
+
* @write
|
|
96
|
+
*/
|
|
97
|
+
addAttachment(options: {
|
|
98
|
+
fileName: string;
|
|
99
|
+
sha: string;
|
|
100
|
+
size: number;
|
|
101
|
+
uploadId?: string;
|
|
102
|
+
}): Promise<{
|
|
103
|
+
attachment: DraftAttachment;
|
|
104
|
+
uploadUrl: string;
|
|
105
|
+
contentType: string;
|
|
106
|
+
}>;
|
|
107
|
+
/**
|
|
108
|
+
* Forward an existing attachment into this draft.
|
|
109
|
+
*
|
|
110
|
+
* @write
|
|
111
|
+
*/
|
|
112
|
+
forwardAttachment(attachment: EmailAttachment): Promise<DraftAttachment>;
|
|
113
|
+
/**
|
|
114
|
+
* Remove a draft attachment.
|
|
115
|
+
*
|
|
116
|
+
* @destructive
|
|
117
|
+
* @idempotent
|
|
118
|
+
*/
|
|
119
|
+
removeAttachment(attachment: DraftAttachment): Promise<void>;
|
|
120
|
+
/**
|
|
121
|
+
* Complete verification of an uploaded attachment.
|
|
122
|
+
*
|
|
123
|
+
* @write
|
|
124
|
+
* @idempotent
|
|
125
|
+
*/
|
|
126
|
+
verifyAttachment(attachment: DraftAttachment): Promise<void>;
|
|
127
|
+
}
|
|
128
|
+
/** An uploaded or forwarded attachment belonging to a draft. */
|
|
129
|
+
export declare class DraftAttachment {
|
|
130
|
+
/** Parent draft. */
|
|
131
|
+
readonly draft: EmailDraft;
|
|
132
|
+
/** Attachment identity. */
|
|
133
|
+
readonly id: string;
|
|
134
|
+
/** Whether this attachment was forwarded. */
|
|
135
|
+
readonly forwarded: boolean;
|
|
136
|
+
/** Draft generation captured when the attachment was reserved. */
|
|
137
|
+
readonly draftGeneration: number;
|
|
138
|
+
private constructor();
|
|
139
|
+
/** Construct a draft scoped attachment handle. */
|
|
140
|
+
static byId(_client: RoxClient, draft: EmailDraft, id: string, forwarded?: boolean, draftGeneration?: number): DraftAttachment;
|
|
141
|
+
/**
|
|
142
|
+
* Complete verification after uploading the file.
|
|
143
|
+
*
|
|
144
|
+
* @write
|
|
145
|
+
* @idempotent
|
|
146
|
+
*/
|
|
147
|
+
complete(): Promise<void>;
|
|
148
|
+
/**
|
|
149
|
+
* Remove this attachment from its draft.
|
|
150
|
+
*
|
|
151
|
+
* @destructive
|
|
152
|
+
* @idempotent
|
|
153
|
+
*/
|
|
154
|
+
remove(): Promise<void>;
|
|
155
|
+
/** Serialize identity without credentials. */
|
|
156
|
+
toJSON(): {
|
|
157
|
+
id: string;
|
|
158
|
+
draftId: string;
|
|
159
|
+
forwarded: boolean;
|
|
160
|
+
draftGeneration: number;
|
|
161
|
+
};
|
|
162
|
+
}
|
|
163
|
+
/** Translate draft content to the generated contract. */
|
|
164
|
+
export declare function draftBody(options: DraftOptions): ApiDraftInput;
|