@rox-one/sdk 0.0.0-stage → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CALLS.md +82 -0
- package/README.md +1259 -2
- package/dist/chunk-AOHK5YXC.js +5585 -0
- package/dist/chunk-CATFKTFD.js +80 -0
- package/dist/chunk-FQGPXWPJ.js +1491 -0
- package/dist/chunk-G43PLP2U.js +1087 -0
- package/dist/chunk-LMJW65ML.js +836 -0
- package/dist/chunk-MCSQNZ4E.js +836 -0
- package/dist/chunk-NSJ3GKUC.js +1552 -0
- package/dist/chunk-OGFKJOK7.js +2068 -0
- package/dist/chunk-RDEJZJBZ.js +1351 -0
- package/dist/chunk-TMTYN2UK.js +1128 -0
- package/dist/chunk-V45LUJDI.js +838 -0
- package/dist/chunk-YRUXFEZM.js +1044 -0
- package/dist/chunk-ZYBAKW25.js +994 -0
- package/dist/generated/agent-fold/index.d.ts +4520 -0
- package/dist/generated/agent-fold/index.js +0 -0
- package/dist/generated/agent-harness/client/client.gen.d.ts +2 -0
- package/dist/generated/agent-harness/client/index.d.ts +10 -0
- package/dist/generated/agent-harness/client/types.gen.d.ts +120 -0
- package/dist/generated/agent-harness/client/utils.gen.d.ts +37 -0
- package/dist/generated/agent-harness/client.gen.d.ts +12 -0
- package/dist/generated/agent-harness/core/auth.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/agent-harness/core/params.gen.d.ts +43 -0
- package/dist/generated/agent-harness/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/agent-harness/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/agent-harness/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/agent-harness/core/types.gen.d.ts +83 -0
- package/dist/generated/agent-harness/core/utils.gen.d.ts +19 -0
- package/dist/generated/agent-harness/index.d.ts +2 -0
- package/dist/generated/agent-harness/index.js +6 -0
- package/dist/generated/agent-harness/sdk.gen.d.ts +375 -0
- package/dist/generated/agent-harness/types.gen.d.ts +4725 -0
- package/dist/generated/agent-reviews/index.d.ts +895 -0
- package/dist/generated/agent-reviews/index.js +0 -0
- package/dist/generated/auth/client/client.gen.d.ts +2 -0
- package/dist/generated/auth/client/index.d.ts +10 -0
- package/dist/generated/auth/client/types.gen.d.ts +120 -0
- package/dist/generated/auth/client/utils.gen.d.ts +37 -0
- package/dist/generated/auth/client.gen.d.ts +12 -0
- package/dist/generated/auth/core/auth.gen.d.ts +25 -0
- package/dist/generated/auth/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/auth/core/params.gen.d.ts +43 -0
- package/dist/generated/auth/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/auth/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/auth/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/auth/core/types.gen.d.ts +83 -0
- package/dist/generated/auth/core/utils.gen.d.ts +19 -0
- package/dist/generated/auth/index.d.ts +2 -0
- package/dist/generated/auth/index.js +6 -0
- package/dist/generated/auth/sdk.gen.d.ts +674 -0
- package/dist/generated/auth/types.gen.d.ts +5233 -0
- package/dist/generated/calendar/client/client.gen.d.ts +2 -0
- package/dist/generated/calendar/client/index.d.ts +10 -0
- package/dist/generated/calendar/client/types.gen.d.ts +120 -0
- package/dist/generated/calendar/client/utils.gen.d.ts +37 -0
- package/dist/generated/calendar/client.gen.d.ts +12 -0
- package/dist/generated/calendar/core/auth.gen.d.ts +25 -0
- package/dist/generated/calendar/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/calendar/core/params.gen.d.ts +43 -0
- package/dist/generated/calendar/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/calendar/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/calendar/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/calendar/core/types.gen.d.ts +83 -0
- package/dist/generated/calendar/core/utils.gen.d.ts +19 -0
- package/dist/generated/calendar/index.d.ts +2 -0
- package/dist/generated/calendar/index.js +6 -0
- package/dist/generated/calendar/sdk.gen.d.ts +157 -0
- package/dist/generated/calendar/types.gen.d.ts +2333 -0
- package/dist/generated/cognition/client/client.gen.d.ts +2 -0
- package/dist/generated/cognition/client/index.d.ts +10 -0
- package/dist/generated/cognition/client/types.gen.d.ts +120 -0
- package/dist/generated/cognition/client/utils.gen.d.ts +37 -0
- package/dist/generated/cognition/client.gen.d.ts +12 -0
- package/dist/generated/cognition/core/auth.gen.d.ts +25 -0
- package/dist/generated/cognition/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/cognition/core/params.gen.d.ts +43 -0
- package/dist/generated/cognition/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/cognition/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/cognition/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/cognition/core/types.gen.d.ts +83 -0
- package/dist/generated/cognition/core/utils.gen.d.ts +19 -0
- package/dist/generated/cognition/index.d.ts +2 -0
- package/dist/generated/cognition/index.js +6 -0
- package/dist/generated/cognition/sdk.gen.d.ts +348 -0
- package/dist/generated/cognition/types.gen.d.ts +4228 -0
- package/dist/generated/connection/client/client.gen.d.ts +2 -0
- package/dist/generated/connection/client/index.d.ts +10 -0
- package/dist/generated/connection/client/types.gen.d.ts +120 -0
- package/dist/generated/connection/client/utils.gen.d.ts +37 -0
- package/dist/generated/connection/client.gen.d.ts +12 -0
- package/dist/generated/connection/core/auth.gen.d.ts +25 -0
- package/dist/generated/connection/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/connection/core/params.gen.d.ts +43 -0
- package/dist/generated/connection/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/connection/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/connection/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/connection/core/types.gen.d.ts +83 -0
- package/dist/generated/connection/core/utils.gen.d.ts +19 -0
- package/dist/generated/connection/index.d.ts +2 -0
- package/dist/generated/connection/index.js +854 -0
- package/dist/generated/connection/sdk.gen.d.ts +43 -0
- package/dist/generated/connection/types.gen.d.ts +252 -0
- package/dist/generated/contacts/client/client.gen.d.ts +2 -0
- package/dist/generated/contacts/client/index.d.ts +10 -0
- package/dist/generated/contacts/client/types.gen.d.ts +120 -0
- package/dist/generated/contacts/client/utils.gen.d.ts +37 -0
- package/dist/generated/contacts/client.gen.d.ts +12 -0
- package/dist/generated/contacts/core/auth.gen.d.ts +25 -0
- package/dist/generated/contacts/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/contacts/core/params.gen.d.ts +43 -0
- package/dist/generated/contacts/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/contacts/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/contacts/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/contacts/core/types.gen.d.ts +83 -0
- package/dist/generated/contacts/core/utils.gen.d.ts +19 -0
- package/dist/generated/contacts/index.d.ts +2 -0
- package/dist/generated/contacts/index.js +6 -0
- package/dist/generated/contacts/sdk.gen.d.ts +47 -0
- package/dist/generated/contacts/types.gen.d.ts +108 -0
- package/dist/generated/email/client/client.gen.d.ts +2 -0
- package/dist/generated/email/client/index.d.ts +10 -0
- package/dist/generated/email/client/types.gen.d.ts +120 -0
- package/dist/generated/email/client/utils.gen.d.ts +37 -0
- package/dist/generated/email/client.gen.d.ts +12 -0
- package/dist/generated/email/core/auth.gen.d.ts +25 -0
- package/dist/generated/email/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/email/core/params.gen.d.ts +43 -0
- package/dist/generated/email/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/email/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/email/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/email/core/types.gen.d.ts +83 -0
- package/dist/generated/email/core/utils.gen.d.ts +19 -0
- package/dist/generated/email/index.d.ts +2 -0
- package/dist/generated/email/index.js +6 -0
- package/dist/generated/email/sdk.gen.d.ts +301 -0
- package/dist/generated/email/types.gen.d.ts +3262 -0
- package/dist/generated/notification/client/client.gen.d.ts +2 -0
- package/dist/generated/notification/client/index.d.ts +10 -0
- package/dist/generated/notification/client/types.gen.d.ts +120 -0
- package/dist/generated/notification/client/utils.gen.d.ts +37 -0
- package/dist/generated/notification/client.gen.d.ts +12 -0
- package/dist/generated/notification/core/auth.gen.d.ts +25 -0
- package/dist/generated/notification/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/notification/core/params.gen.d.ts +43 -0
- package/dist/generated/notification/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/notification/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/notification/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/notification/core/types.gen.d.ts +83 -0
- package/dist/generated/notification/core/utils.gen.d.ts +19 -0
- package/dist/generated/notification/index.d.ts +2 -0
- package/dist/generated/notification/index.js +6 -0
- package/dist/generated/notification/sdk.gen.d.ts +127 -0
- package/dist/generated/notification/types.gen.d.ts +2084 -0
- package/dist/generated/properties/client/client.gen.d.ts +2 -0
- package/dist/generated/properties/client/index.d.ts +10 -0
- package/dist/generated/properties/client/types.gen.d.ts +120 -0
- package/dist/generated/properties/client/utils.gen.d.ts +37 -0
- package/dist/generated/properties/client.gen.d.ts +12 -0
- package/dist/generated/properties/core/auth.gen.d.ts +25 -0
- package/dist/generated/properties/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/properties/core/params.gen.d.ts +43 -0
- package/dist/generated/properties/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/properties/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/properties/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/properties/core/types.gen.d.ts +83 -0
- package/dist/generated/properties/core/utils.gen.d.ts +19 -0
- package/dist/generated/properties/index.d.ts +2 -0
- package/dist/generated/properties/index.js +6 -0
- package/dist/generated/properties/sdk.gen.d.ts +158 -0
- package/dist/generated/properties/types.gen.d.ts +1311 -0
- package/dist/generated/scheduled-action/client/client.gen.d.ts +2 -0
- package/dist/generated/scheduled-action/client/index.d.ts +10 -0
- package/dist/generated/scheduled-action/client/types.gen.d.ts +120 -0
- package/dist/generated/scheduled-action/client/utils.gen.d.ts +37 -0
- package/dist/generated/scheduled-action/client.gen.d.ts +12 -0
- package/dist/generated/scheduled-action/core/auth.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/scheduled-action/core/params.gen.d.ts +43 -0
- package/dist/generated/scheduled-action/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/scheduled-action/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/scheduled-action/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/scheduled-action/core/types.gen.d.ts +83 -0
- package/dist/generated/scheduled-action/core/utils.gen.d.ts +19 -0
- package/dist/generated/scheduled-action/index.d.ts +2 -0
- package/dist/generated/scheduled-action/index.js +6 -0
- package/dist/generated/scheduled-action/sdk.gen.d.ts +156 -0
- package/dist/generated/scheduled-action/types.gen.d.ts +3099 -0
- package/dist/generated/search/client/client.gen.d.ts +2 -0
- package/dist/generated/search/client/index.d.ts +10 -0
- package/dist/generated/search/client/types.gen.d.ts +120 -0
- package/dist/generated/search/client/utils.gen.d.ts +37 -0
- package/dist/generated/search/client.gen.d.ts +12 -0
- package/dist/generated/search/core/auth.gen.d.ts +25 -0
- package/dist/generated/search/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/search/core/params.gen.d.ts +43 -0
- package/dist/generated/search/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/search/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/search/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/search/core/types.gen.d.ts +83 -0
- package/dist/generated/search/core/utils.gen.d.ts +19 -0
- package/dist/generated/search/index.d.ts +2 -0
- package/dist/generated/search/index.js +6 -0
- package/dist/generated/search/sdk.gen.d.ts +44 -0
- package/dist/generated/search/types.gen.d.ts +2532 -0
- package/dist/generated/static-files/client/client.gen.d.ts +2 -0
- package/dist/generated/static-files/client/index.d.ts +10 -0
- package/dist/generated/static-files/client/types.gen.d.ts +120 -0
- package/dist/generated/static-files/client/utils.gen.d.ts +37 -0
- package/dist/generated/static-files/client.gen.d.ts +12 -0
- package/dist/generated/static-files/core/auth.gen.d.ts +25 -0
- package/dist/generated/static-files/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/static-files/core/params.gen.d.ts +43 -0
- package/dist/generated/static-files/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/static-files/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/static-files/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/static-files/core/types.gen.d.ts +83 -0
- package/dist/generated/static-files/core/utils.gen.d.ts +19 -0
- package/dist/generated/static-files/index.d.ts +2 -0
- package/dist/generated/static-files/index.js +842 -0
- package/dist/generated/static-files/sdk.gen.d.ts +43 -0
- package/dist/generated/static-files/types.gen.d.ts +220 -0
- package/dist/generated/storage/client/client.gen.d.ts +2 -0
- package/dist/generated/storage/client/index.d.ts +10 -0
- package/dist/generated/storage/client/types.gen.d.ts +120 -0
- package/dist/generated/storage/client/utils.gen.d.ts +37 -0
- package/dist/generated/storage/client.gen.d.ts +12 -0
- package/dist/generated/storage/core/auth.gen.d.ts +25 -0
- package/dist/generated/storage/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/storage/core/params.gen.d.ts +43 -0
- package/dist/generated/storage/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/storage/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/storage/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/storage/core/types.gen.d.ts +83 -0
- package/dist/generated/storage/core/utils.gen.d.ts +19 -0
- package/dist/generated/storage/index.d.ts +2 -0
- package/dist/generated/storage/index.js +6 -0
- package/dist/generated/storage/sdk.gen.d.ts +2285 -0
- package/dist/generated/storage/types.gen.d.ts +34546 -0
- package/dist/generated/unfurl/client/client.gen.d.ts +2 -0
- package/dist/generated/unfurl/client/index.d.ts +10 -0
- package/dist/generated/unfurl/client/types.gen.d.ts +120 -0
- package/dist/generated/unfurl/client/utils.gen.d.ts +37 -0
- package/dist/generated/unfurl/client.gen.d.ts +12 -0
- package/dist/generated/unfurl/core/auth.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/bodySerializer.gen.d.ts +25 -0
- package/dist/generated/unfurl/core/params.gen.d.ts +43 -0
- package/dist/generated/unfurl/core/pathSerializer.gen.d.ts +33 -0
- package/dist/generated/unfurl/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/generated/unfurl/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/generated/unfurl/core/types.gen.d.ts +83 -0
- package/dist/generated/unfurl/core/utils.gen.d.ts +19 -0
- package/dist/generated/unfurl/index.d.ts +2 -0
- package/dist/generated/unfurl/index.js +6 -0
- package/dist/generated/unfurl/sdk.gen.d.ts +47 -0
- package/dist/generated/unfurl/types.gen.d.ts +145 -0
- package/dist/src/calls/browser.d.ts +14 -0
- package/dist/src/calls/browser.js +102 -0
- package/dist/src/calls/common.d.ts +18 -0
- package/dist/src/calls/node.d.ts +24 -0
- package/dist/src/calls/node.js +145 -0
- package/dist/src/calls/telemetry.d.ts +5 -0
- package/dist/src/config.d.ts +71 -0
- package/dist/src/entities/account-managers/grant.d.ts +62 -0
- package/dist/src/entities/account-managers/namespace.d.ts +29 -0
- package/dist/src/entities/activity/entity.d.ts +7 -0
- package/dist/src/entities/activity/namespace.d.ts +58 -0
- package/dist/src/entities/activity/namespace.test.d.ts +1 -0
- package/dist/src/entities/agent-sessions/activity.d.ts +48 -0
- package/dist/src/entities/agent-sessions/agent-session.d.ts +518 -0
- package/dist/src/entities/agent-sessions/code-execution.d.ts +60 -0
- package/dist/src/entities/agent-sessions/conversation.d.ts +91 -0
- package/dist/src/entities/agent-sessions/namespace.d.ts +142 -0
- package/dist/src/entities/agent-sessions/origin.d.ts +94 -0
- package/dist/src/entities/agent-sessions/queued-action.d.ts +60 -0
- package/dist/src/entities/agent-sessions/review.d.ts +114 -0
- package/dist/src/entities/agent-sessions/tool-approval.d.ts +25 -0
- package/dist/src/entities/agent-sessions/view.d.ts +11 -0
- package/dist/src/entities/agents/agent.d.ts +142 -0
- package/dist/src/entities/agents/namespace.d.ts +66 -0
- package/dist/src/entities/ai/namespace.d.ts +36 -0
- package/dist/src/entities/api-keys/api-key.d.ts +22 -0
- package/dist/src/entities/api-keys/namespace.d.ts +37 -0
- package/dist/src/entities/bots/bot.d.ts +143 -0
- package/dist/src/entities/bots/namespace.d.ts +50 -0
- package/dist/src/entities/bots/token.d.ts +39 -0
- package/dist/src/entities/calendar/booking-link.d.ts +55 -0
- package/dist/src/entities/calendar/booking-namespace.d.ts +143 -0
- package/dist/src/entities/calendar/booking-namespace.test.d.ts +1 -0
- package/dist/src/entities/calendar/booking.d.ts +97 -0
- package/dist/src/entities/calendar/calendar.d.ts +49 -0
- package/dist/src/entities/calendar/create-confirmed.test.d.ts +1 -0
- package/dist/src/entities/calendar/event.d.ts +283 -0
- package/dist/src/entities/calendar/event.test.d.ts +1 -0
- package/dist/src/entities/calendar/namespace.d.ts +334 -0
- package/dist/src/entities/calendar/namespace.test.d.ts +1 -0
- package/dist/src/entities/calendar/replacement.d.ts +31 -0
- package/dist/src/entities/calls/call-record.d.ts +231 -0
- package/dist/src/entities/calls/connection.d.ts +59 -0
- package/dist/src/entities/calls/errors.d.ts +15 -0
- package/dist/src/entities/calls/message.d.ts +55 -0
- package/dist/src/entities/calls/namespace.d.ts +41 -0
- package/dist/src/entities/calls/participant.d.ts +22 -0
- package/dist/src/entities/canvases/canvas.d.ts +329 -0
- package/dist/src/entities/channels/access-request.d.ts +42 -0
- package/dist/src/entities/channels/activity.d.ts +40 -0
- package/dist/src/entities/channels/channel.d.ts +302 -0
- package/dist/src/entities/channels/labels.d.ts +73 -0
- package/dist/src/entities/channels/message.d.ts +153 -0
- package/dist/src/entities/channels/message.test.d.ts +1 -0
- package/dist/src/entities/channels/namespace.d.ts +82 -0
- package/dist/src/entities/channels/namespace.test.d.ts +1 -0
- package/dist/src/entities/channels/picture.d.ts +11 -0
- package/dist/src/entities/channels/post.d.ts +37 -0
- package/dist/src/entities/channels/post.test.d.ts +1 -0
- package/dist/src/entities/channels/share.d.ts +9 -0
- package/dist/src/entities/channels/share.test.d.ts +1 -0
- package/dist/src/entities/channels/thread.d.ts +64 -0
- package/dist/src/entities/chats/chat.d.ts +121 -0
- package/dist/src/entities/chats/generation.d.ts +55 -0
- package/dist/src/entities/chats/namespace.d.ts +35 -0
- package/dist/src/entities/connected-apps/connected-app.d.ts +121 -0
- package/dist/src/entities/connected-apps/connector.d.ts +59 -0
- package/dist/src/entities/connected-apps/namespace.d.ts +92 -0
- package/dist/src/entities/crm/company.d.ts +154 -0
- package/dist/src/entities/crm/contact.d.ts +168 -0
- package/dist/src/entities/crm/namespace.d.ts +163 -0
- package/dist/src/entities/crm/pipeline-entry.d.ts +109 -0
- package/dist/src/entities/crm/pipeline.d.ts +426 -0
- package/dist/src/entities/crm/pipelines.d.ts +79 -0
- package/dist/src/entities/crm-email-privacy/email-privacy.d.ts +238 -0
- package/dist/src/entities/crm-email-privacy/email-rule-preview.d.ts +55 -0
- package/dist/src/entities/crm-email-privacy/email-rule-revision.d.ts +27 -0
- package/dist/src/entities/crm-email-privacy/email-rules.d.ts +32 -0
- package/dist/src/entities/databases/column.d.ts +122 -0
- package/dist/src/entities/databases/database.d.ts +431 -0
- package/dist/src/entities/databases/namespace.d.ts +109 -0
- package/dist/src/entities/databases/query.d.ts +86 -0
- package/dist/src/entities/databases/row.d.ts +29 -0
- package/dist/src/entities/databases/saved-query.d.ts +151 -0
- package/dist/src/entities/databases/table.d.ts +124 -0
- package/dist/src/entities/databases/view.d.ts +72 -0
- package/dist/src/entities/databases/webhook.d.ts +39 -0
- package/dist/src/entities/documents/ai-edit.d.ts +54 -0
- package/dist/src/entities/documents/anchor.d.ts +39 -0
- package/dist/src/entities/documents/comment.d.ts +68 -0
- package/dist/src/entities/documents/create.test.d.ts +1 -0
- package/dist/src/entities/documents/document.d.ts +675 -0
- package/dist/src/entities/documents/markdown.d.ts +25 -0
- package/dist/src/entities/documents/namespace.d.ts +291 -0
- package/dist/src/entities/documents/office-files.d.ts +47 -0
- package/dist/src/entities/documents/skills.test.d.ts +1 -0
- package/dist/src/entities/documents/system-skill.d.ts +36 -0
- package/dist/src/entities/documents/text-comment.d.ts +41 -0
- package/dist/src/entities/documents/text-comment.test.d.ts +1 -0
- package/dist/src/entities/documents/version.d.ts +26 -0
- package/dist/src/entities/email/attachment.d.ts +39 -0
- package/dist/src/entities/email/draft.d.ts +160 -0
- package/dist/src/entities/email/filter.d.ts +44 -0
- package/dist/src/entities/email/label.d.ts +37 -0
- package/dist/src/entities/email/link.d.ts +35 -0
- package/dist/src/entities/email/message.d.ts +223 -0
- package/dist/src/entities/email/namespace.d.ts +235 -0
- package/dist/src/entities/email/namespace.test.d.ts +1 -0
- package/dist/src/entities/email/thread.d.ts +268 -0
- package/dist/src/entities/entity-mentions/mention.d.ts +21 -0
- package/dist/src/entities/entity-mentions/namespace.d.ts +20 -0
- package/dist/src/entities/entity.d.ts +167 -0
- package/dist/src/entities/external-chat/chat.d.ts +173 -0
- package/dist/src/entities/external-chat/message.d.ts +54 -0
- package/dist/src/entities/external-chat/namespace.d.ts +22 -0
- package/dist/src/entities/external-chat/participant.d.ts +28 -0
- package/dist/src/entities/external-chat/send.d.ts +40 -0
- package/dist/src/entities/external-chat/upload.d.ts +25 -0
- package/dist/src/entities/favorites/namespace.d.ts +52 -0
- package/dist/src/entities/foreign/foreign-entity.d.ts +36 -0
- package/dist/src/entities/foreign/namespace.d.ts +54 -0
- package/dist/src/entities/forms/form.d.ts +319 -0
- package/dist/src/entities/forms/namespace.d.ts +30 -0
- package/dist/src/entities/forms/question.d.ts +65 -0
- package/dist/src/entities/forms/response.d.ts +52 -0
- package/dist/src/entities/forms/section.d.ts +31 -0
- package/dist/src/entities/github-pull-requests/namespace.d.ts +20 -0
- package/dist/src/entities/github-pull-requests/pull-request.d.ts +64 -0
- package/dist/src/entities/harnesses/harness.d.ts +76 -0
- package/dist/src/entities/harnesses/namespace.d.ts +83 -0
- package/dist/src/entities/harnesses/pairing.d.ts +50 -0
- package/dist/src/entities/images/image.d.ts +88 -0
- package/dist/src/entities/images/namespace.d.ts +55 -0
- package/dist/src/entities/images/namespace.test.d.ts +1 -0
- package/dist/src/entities/imports/entry.d.ts +65 -0
- package/dist/src/entities/imports/namespace.d.ts +103 -0
- package/dist/src/entities/imports/namespace.test.d.ts +1 -0
- package/dist/src/entities/initiatives/initiative.d.ts +185 -0
- package/dist/src/entities/initiatives/initiative.test.d.ts +1 -0
- package/dist/src/entities/initiatives/namespace.d.ts +90 -0
- package/dist/src/entities/me/namespace.d.ts +68 -0
- package/dist/src/entities/meetings/meeting.d.ts +81 -0
- package/dist/src/entities/meetings/namespace.d.ts +38 -0
- package/dist/src/entities/memory/namespace.d.ts +49 -0
- package/dist/src/entities/memory/namespace.test.d.ts +1 -0
- package/dist/src/entities/messages/discussion.d.ts +84 -0
- package/dist/src/entities/messages/thread.d.ts +115 -0
- package/dist/src/entities/notifications/namespace.d.ts +66 -0
- package/dist/src/entities/notifications/notification.d.ts +78 -0
- package/dist/src/entities/notifications/notification.test.d.ts +1 -0
- package/dist/src/entities/passwords/item.d.ts +118 -0
- package/dist/src/entities/passwords/namespace.d.ts +45 -0
- package/dist/src/entities/pins/namespace.d.ts +42 -0
- package/dist/src/entities/projects/namespace.d.ts +45 -0
- package/dist/src/entities/projects/project.d.ts +108 -0
- package/dist/src/entities/properties/namespace.d.ts +105 -0
- package/dist/src/entities/properties/namespace.test.d.ts +1 -0
- package/dist/src/entities/properties/property-definition.d.ts +70 -0
- package/dist/src/entities/properties/property-option.d.ts +44 -0
- package/dist/src/entities/reference.d.ts +82 -0
- package/dist/src/entities/referrals/namespace.d.ts +40 -0
- package/dist/src/entities/routines/namespace.d.ts +239 -0
- package/dist/src/entities/routines/routine.d.ts +341 -0
- package/dist/src/entities/routines/suggestion.d.ts +38 -0
- package/dist/src/entities/saved-views/namespace.d.ts +58 -0
- package/dist/src/entities/saved-views/saved-view.d.ts +78 -0
- package/dist/src/entities/search/exclusions.d.ts +6 -0
- package/dist/src/entities/search/namespace.d.ts +71 -0
- package/dist/src/entities/search/options.d.ts +30 -0
- package/dist/src/entities/search/types.d.ts +90 -0
- package/dist/src/entities/sharing/access.d.ts +120 -0
- package/dist/src/entities/sharing/permissions.d.ts +13 -0
- package/dist/src/entities/spreadsheets/spreadsheet.d.ts +201 -0
- package/dist/src/entities/suggestions/namespace.d.ts +118 -0
- package/dist/src/entities/suggestions/suggestion.d.ts +172 -0
- package/dist/src/entities/suggestions/suggestion.test.d.ts +1 -0
- package/dist/src/entities/tasks/namespace.d.ts +77 -0
- package/dist/src/entities/tasks/task.d.ts +99 -0
- package/dist/src/entities/teams/invite.d.ts +33 -0
- package/dist/src/entities/teams/namespace.d.ts +23 -0
- package/dist/src/entities/teams/team.d.ts +129 -0
- package/dist/src/entities/ui/app-link.d.ts +24 -0
- package/dist/src/entities/ui/namespace.d.ts +75 -0
- package/dist/src/entities/unfurls/namespace.d.ts +24 -0
- package/dist/src/entities/users/namespace.d.ts +41 -0
- package/dist/src/entities/users/profile-picture.d.ts +29 -0
- package/dist/src/entities/users/profile-picture.test.d.ts +1 -0
- package/dist/src/entities/users/user.d.ts +102 -0
- package/dist/src/entities/web/namespace.d.ts +67 -0
- package/dist/src/entities/web/namespace.test.d.ts +1 -0
- package/dist/src/entities/webhooks/namespace.d.ts +38 -0
- package/dist/src/entities/webhooks/webhook.d.ts +130 -0
- package/dist/src/entities/whatsapp/account.d.ts +24 -0
- package/dist/src/entities/whatsapp/chat.d.ts +62 -0
- package/dist/src/entities/whatsapp/namespace.d.ts +29 -0
- package/dist/src/entities/workspace/items.d.ts +14 -0
- package/dist/src/entities/workspace/namespace.d.ts +96 -0
- package/dist/src/entities/workspace/query.d.ts +39 -0
- package/dist/src/entities/workspace/query.test.d.ts +1 -0
- package/dist/src/entities/workspace/types.d.ts +99 -0
- package/dist/src/events/hydrate/agentSession.d.ts +192 -0
- package/dist/src/events/hydrate/call.d.ts +101 -0
- package/dist/src/events/hydrate/channel.d.ts +55 -0
- package/dist/src/events/hydrate/document.d.ts +59 -0
- package/dist/src/events/hydrate/message.d.ts +70 -0
- package/dist/src/events/hydrate/user.d.ts +14 -0
- package/dist/src/events/receiver.d.ts +91 -0
- package/dist/src/events/types.d.ts +44 -0
- package/dist/src/events/verify.d.ts +13 -0
- package/dist/src/local-portmap.d.ts +8 -0
- package/dist/src/mentions.d.ts +42 -0
- package/dist/src/raw.d.ts +12 -0
- package/dist/src/rox.d.ts +267 -0
- package/dist/src/rox.js +23217 -0
- package/dist/src/utils/activity.d.ts +34 -0
- package/dist/src/utils/activity.test.d.ts +1 -0
- package/dist/src/utils/client.d.ts +62 -0
- package/dist/src/utils/concurrency.d.ts +5 -0
- package/dist/src/utils/index.d.ts +5 -0
- package/dist/src/utils/lazy.d.ts +37 -0
- package/dist/src/utils/options.d.ts +7 -0
- package/dist/src/utils/pagination.d.ts +28 -0
- package/dist/src/utils/unwrap.d.ts +48 -0
- package/dist/src/utils/verbs.d.ts +3 -0
- package/package.json +82 -4
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import type { BookingAttendance, Booking as BookingRecord, BookingSlot } from '../../../generated/calendar/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import { RoxEntity } from '../entity';
|
|
4
|
+
import { User } from '../users/user';
|
|
5
|
+
/**
|
|
6
|
+
* A meeting someone booked through one of the user's or their team's booking
|
|
7
|
+
* links. Detail loads through the host's management view, so it needs the
|
|
8
|
+
* personal owner, a host of the meeting or a team administrator.
|
|
9
|
+
*/
|
|
10
|
+
export declare class Booking extends RoxEntity<BookingRecord> {
|
|
11
|
+
protected fetch(): Promise<BookingRecord>;
|
|
12
|
+
/** A handle to a booking by id. Detail loads on first access. */
|
|
13
|
+
static byId(client: RoxClient, id: string): Booking;
|
|
14
|
+
/** A handle seeded with a booking record the service returned. */
|
|
15
|
+
static fromRecord(client: RoxClient, record: BookingRecord): Booking;
|
|
16
|
+
/** Meeting title, as it was when the meeting was booked. */
|
|
17
|
+
readonly title: () => Promise<string>;
|
|
18
|
+
/** The guest's name. */
|
|
19
|
+
readonly name: () => Promise<string>;
|
|
20
|
+
/** The guest's email. */
|
|
21
|
+
readonly email: () => Promise<string>;
|
|
22
|
+
/** Absolute start. */
|
|
23
|
+
readonly startsAt: () => Promise<string>;
|
|
24
|
+
/** Absolute end. */
|
|
25
|
+
readonly endsAt: () => Promise<string>;
|
|
26
|
+
/** The guest's IANA display time zone. */
|
|
27
|
+
readonly timeZone: () => Promise<string>;
|
|
28
|
+
/** Lifecycle state. `failed` and `processing` need reconciliation, never a blind retry. */
|
|
29
|
+
readonly status: () => Promise<import("../../../generated/calendar").BookingStatus>;
|
|
30
|
+
/** Recorded attendance; `unknown` until a host records it. */
|
|
31
|
+
readonly attendance: () => Promise<NonNullable<BookingAttendance | undefined> | undefined>;
|
|
32
|
+
/** How many times the meeting moved to another start. */
|
|
33
|
+
readonly rescheduleCount: () => Promise<number | undefined>;
|
|
34
|
+
/** When the meeting last moved, if it ever did. */
|
|
35
|
+
readonly rescheduledAt: () => Promise<string | undefined>;
|
|
36
|
+
/** When Macro stopped trying to update the host's calendar. A `failed` booking with this set is not retried; only a cancellation that returns it `cancelled` releases its time. */
|
|
37
|
+
readonly abandonedAt: () => Promise<string | undefined>;
|
|
38
|
+
/** Final location or conference URL. */
|
|
39
|
+
readonly location: () => Promise<string>;
|
|
40
|
+
/** The guest's answers, keyed by question id; {@link questionLabels} names each question. */
|
|
41
|
+
readonly answers: () => Promise<{
|
|
42
|
+
[key: string]: string;
|
|
43
|
+
}>;
|
|
44
|
+
/** Question labels as they were when the meeting was booked, keyed by question id. */
|
|
45
|
+
readonly questionLabels: () => Promise<{
|
|
46
|
+
[key: string]: string;
|
|
47
|
+
} | undefined>;
|
|
48
|
+
/** The hosts assigned to the meeting. */
|
|
49
|
+
readonly hosts: () => Promise<User[]>;
|
|
50
|
+
/**
|
|
51
|
+
* Available replacement starts on one date (`YYYY-MM-DD`, in the booking
|
|
52
|
+
* schedule's time zone), for {@link reschedule}. Availability is checked
|
|
53
|
+
* again when the meeting moves.
|
|
54
|
+
*
|
|
55
|
+
* @readonly
|
|
56
|
+
*/
|
|
57
|
+
rescheduleSlots(date: string): Promise<BookingSlot[]>;
|
|
58
|
+
/**
|
|
59
|
+
* Move the meeting to a start returned by {@link rescheduleSlots}; only on
|
|
60
|
+
* the user's go-ahead, since the guest and hosts are notified. Returns the
|
|
61
|
+
* saved booking.
|
|
62
|
+
*
|
|
63
|
+
* @destructive
|
|
64
|
+
* @openworld
|
|
65
|
+
*/
|
|
66
|
+
reschedule(startsAt: string): Promise<Booking>;
|
|
67
|
+
/**
|
|
68
|
+
* Cancel the meeting; only on the user's go-ahead, since the guest and
|
|
69
|
+
* hosts are notified. The booking link stays as it is. Returns the saved
|
|
70
|
+
* booking. `cancelled` means its time is released. `failed` means the
|
|
71
|
+
* calendar has not confirmed the cancellation: with `abandonedAt` set Macro
|
|
72
|
+
* stopped retrying and the reservation stays held; otherwise Macro keeps
|
|
73
|
+
* retrying. Treat the time as released only once the booking is `cancelled`.
|
|
74
|
+
*
|
|
75
|
+
* @destructive
|
|
76
|
+
* @openworld
|
|
77
|
+
* @idempotent
|
|
78
|
+
*/
|
|
79
|
+
cancel(): Promise<Booking>;
|
|
80
|
+
/**
|
|
81
|
+
* Approve a legacy pending booking and send its invitations; only on the
|
|
82
|
+
* user's go-ahead. Returns the saved booking.
|
|
83
|
+
*
|
|
84
|
+
* @destructive
|
|
85
|
+
* @openworld
|
|
86
|
+
*/
|
|
87
|
+
approve(): Promise<Booking>;
|
|
88
|
+
/**
|
|
89
|
+
* Record or clear attendance once a confirmed meeting has ended. Returns
|
|
90
|
+
* the saved booking.
|
|
91
|
+
*
|
|
92
|
+
* @write
|
|
93
|
+
* @idempotent
|
|
94
|
+
*/
|
|
95
|
+
setAttendance(attendance: BookingAttendance): Promise<Booking>;
|
|
96
|
+
private change;
|
|
97
|
+
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import type { VisibleCalendar } from '../../../generated/calendar/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import { Link } from '../email/link';
|
|
4
|
+
import { RoxEntity } from '../entity';
|
|
5
|
+
/**
|
|
6
|
+
* A calendar visible to the requester across their connected inboxes: a
|
|
7
|
+
* free-to-construct handle whose detail resolves from the caller's calendar
|
|
8
|
+
* list. There is no fetch-by-id endpoint, so a bare {@link Calendar.byId}
|
|
9
|
+
* handle loads its detail by listing the caller's calendars and matching on id.
|
|
10
|
+
*/
|
|
11
|
+
export declare class Calendar extends RoxEntity<VisibleCalendar> {
|
|
12
|
+
/**
|
|
13
|
+
* Set whether this calendar contributes to the caller's availability.
|
|
14
|
+
*
|
|
15
|
+
* @write
|
|
16
|
+
* @openworld
|
|
17
|
+
* @idempotent
|
|
18
|
+
*/
|
|
19
|
+
setContributesToAvailability(contributesToAvailability: boolean): Promise<void>;
|
|
20
|
+
protected fetch(): Promise<VisibleCalendar>;
|
|
21
|
+
/** A handle to a calendar by id. Detail loads on first access. */
|
|
22
|
+
static byId(client: RoxClient, id: string): Calendar;
|
|
23
|
+
/** The caller's visible calendars, primaries and writable first. */
|
|
24
|
+
static list(client: RoxClient): Promise<Calendar[]>;
|
|
25
|
+
/** Provider display name. Often says whose calendar it is: Google names a
|
|
26
|
+
* person's primary calendar after them or their address. */
|
|
27
|
+
readonly name: () => Promise<string>;
|
|
28
|
+
/** Connected inbox address that syncs this calendar. It stays the user's
|
|
29
|
+
* own address on a calendar someone else shared with them. */
|
|
30
|
+
readonly emailAddress: () => Promise<string>;
|
|
31
|
+
/** Whether this is its account's primary calendar. The user's other
|
|
32
|
+
* calendars are not primary either, so false does not mean it isn't theirs. */
|
|
33
|
+
readonly isPrimary: () => Promise<boolean>;
|
|
34
|
+
/** Whether the grant can create and modify events on this calendar. People
|
|
35
|
+
* can hold that on someone else's calendar, so it does not mean it is theirs. */
|
|
36
|
+
readonly isWritable: () => Promise<boolean>;
|
|
37
|
+
/** Whether this calendar counts toward the caller's busy time: their Busy
|
|
38
|
+
* switch in Settings → Calendar, on for every calendar until they turn it
|
|
39
|
+
* off. Booking links, team availability and agents all read it. */
|
|
40
|
+
readonly contributesToAvailability: () => Promise<NonNullable<boolean | undefined> | undefined>;
|
|
41
|
+
/** Whether this is a subscribed system calendar (holidays, birthdays). */
|
|
42
|
+
readonly isSubscription: () => Promise<boolean>;
|
|
43
|
+
/** Provider color, when set. */
|
|
44
|
+
readonly color: () => Promise<string | undefined>;
|
|
45
|
+
/** A persistent per-calendar sync failure, surfaced for settings badges. */
|
|
46
|
+
readonly syncError: () => Promise<string | undefined>;
|
|
47
|
+
/** The connected inbox (email link) that syncs this calendar. */
|
|
48
|
+
readonly emailLink: () => Promise<Link>;
|
|
49
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,283 @@
|
|
|
1
|
+
import type { AttendeeResponseStatus, CalendarAttendeeInputBody, CalendarDeletionScopeParam, CalendarEvent as CalendarEventRecord, CalendarGuestInputBody, CalendarRsvpScopeParam, CalendarUpdateScopeParam, ConferenceChange, EventReminders, EventTime, EventTransparency, EventVisibility, GuestPolicy, OutOfOfficeProperties } from '../../../generated/calendar/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import type { Channel } from '../channels/channel';
|
|
4
|
+
import { RoxEntity } from '../entity';
|
|
5
|
+
import { Calendar } from './calendar';
|
|
6
|
+
import { CalendarReplacement } from './replacement';
|
|
7
|
+
/** Fields to change on an event; omitted fields are left untouched. */
|
|
8
|
+
export interface UpdateEventOptions {
|
|
9
|
+
/** Replacement title; an empty string clears it. */
|
|
10
|
+
title?: string;
|
|
11
|
+
/** Replacement description; an empty string clears it. */
|
|
12
|
+
description?: string;
|
|
13
|
+
/** Replacement location; an empty string clears it. */
|
|
14
|
+
location?: string;
|
|
15
|
+
/** Replacement time. */
|
|
16
|
+
time?: EventTime;
|
|
17
|
+
/** Replacement attendee list. */
|
|
18
|
+
attendees?: CalendarAttendeeInputBody[];
|
|
19
|
+
/** Replacement recurrence properties; an empty list clears them. */
|
|
20
|
+
recurrenceLines?: string[];
|
|
21
|
+
/** Replacement visibility. */
|
|
22
|
+
visibility?: EventVisibility;
|
|
23
|
+
/** Replacement availability behavior. */
|
|
24
|
+
transparency?: EventTransparency;
|
|
25
|
+
/** Replacement reminder configuration. */
|
|
26
|
+
reminders?: EventReminders;
|
|
27
|
+
/** Provider conference change; omit to retain it. Outlook removal requires a
|
|
28
|
+
* separately confirmed replacement via prepareReplacement(). */
|
|
29
|
+
conference?: ConferenceChange;
|
|
30
|
+
/** Switch the event to a Rox call in this update: create one, write its
|
|
31
|
+
* join link into the description and location, and remove any Google Meet or
|
|
32
|
+
* other conference. An event already holding a Rox call keeps it. Cannot be
|
|
33
|
+
* combined with `conference`. */
|
|
34
|
+
macroCall?: boolean;
|
|
35
|
+
/** Replacement out-of-office properties, applied only to an event that is
|
|
36
|
+
* already out-of-office. */
|
|
37
|
+
outOfOffice?: OutOfOfficeProperties;
|
|
38
|
+
/** Replacement guest policy; only the organizer of a Google event may change
|
|
39
|
+
* it (`viewerCan.setGuestPolicy`). It applies to the whole series, so an
|
|
40
|
+
* update scoped to one occurrence (`scope: 'this_event'`, or a `recurrenceId`)
|
|
41
|
+
* that changes it is rejected; use scope `'all'`. */
|
|
42
|
+
guestPolicy?: GuestPolicy;
|
|
43
|
+
/** How much of a recurring series the update covers. Omit to let
|
|
44
|
+
* `recurrenceId` decide. */
|
|
45
|
+
scope?: CalendarUpdateScopeParam;
|
|
46
|
+
/** Original-start key of the occurrence the update targets. */
|
|
47
|
+
recurrenceId?: string;
|
|
48
|
+
/** Calendar whose copy of the event is patched, for a multi-calendar event.
|
|
49
|
+
* Omit to patch the canonical copy. */
|
|
50
|
+
calendar?: Calendar;
|
|
51
|
+
/** Address of the inbox holding the copy this call changes (an occurrence
|
|
52
|
+
* listing's `inbox`). When the meeting is on more than one of the user's
|
|
53
|
+
* inboxes, an agent must name it: the call is refused with
|
|
54
|
+
* `copy_choice_required`, listing each copy's inbox, role and event, until
|
|
55
|
+
* it does. It must be the inbox holding this copy. */
|
|
56
|
+
inbox?: string;
|
|
57
|
+
}
|
|
58
|
+
/** How a deletion is scoped across a recurring series. */
|
|
59
|
+
export interface DeleteEventOptions {
|
|
60
|
+
/** Deletion scope; defaults to the entire event or series. */
|
|
61
|
+
scope?: CalendarDeletionScopeParam;
|
|
62
|
+
/** Original-start key of the occurrence a scoped deletion targets. */
|
|
63
|
+
recurrenceId?: string;
|
|
64
|
+
/** Calendar whose copy of the event is deleted, for a multi-calendar event.
|
|
65
|
+
* Omit to delete the canonical copy. */
|
|
66
|
+
calendar?: Calendar;
|
|
67
|
+
/** Address of the inbox holding the copy this call deletes (an occurrence
|
|
68
|
+
* listing's `inbox`). When the meeting is on more than one of the user's
|
|
69
|
+
* inboxes, an agent must name it: the call is refused with
|
|
70
|
+
* `copy_choice_required`, listing each copy's inbox, role and event, until
|
|
71
|
+
* it does. It must be the inbox holding this copy. */
|
|
72
|
+
inbox?: string;
|
|
73
|
+
}
|
|
74
|
+
/** Guests to add and how much of a recurring series gains them. */
|
|
75
|
+
export interface InviteGuestsOptions {
|
|
76
|
+
/** Guests to add; anyone already on the event is skipped. */
|
|
77
|
+
guests: CalendarGuestInputBody[];
|
|
78
|
+
/** How much of a recurring series gains the guests. Omit to let
|
|
79
|
+
* `recurrenceId` decide. */
|
|
80
|
+
scope?: CalendarUpdateScopeParam;
|
|
81
|
+
/** Original-start key of the occurrence the guests are added to. */
|
|
82
|
+
recurrenceId?: string;
|
|
83
|
+
/** Calendar whose copy of the event is written, for a multi-calendar event.
|
|
84
|
+
* Omit to write the canonical copy. */
|
|
85
|
+
calendar?: Calendar;
|
|
86
|
+
/** Address of the inbox holding the copy this call changes (an occurrence
|
|
87
|
+
* listing's `inbox`). When the meeting is on more than one of the user's
|
|
88
|
+
* inboxes, an agent must name it: the call is refused with
|
|
89
|
+
* `copy_choice_required`, listing each copy's inbox, role and event, until
|
|
90
|
+
* it does. It must be the inbox holding this copy. */
|
|
91
|
+
inbox?: string;
|
|
92
|
+
}
|
|
93
|
+
/** The RSVP to record and how it is scoped across a recurring series. */
|
|
94
|
+
export interface RsvpEventOptions {
|
|
95
|
+
/** The response to record for the connected account. */
|
|
96
|
+
response: AttendeeResponseStatus;
|
|
97
|
+
/** How much of a recurring series the response covers. Omit to let
|
|
98
|
+
* `recurrenceId` decide. */
|
|
99
|
+
scope?: CalendarRsvpScopeParam;
|
|
100
|
+
/** Original-start key of the occurrence the response targets. */
|
|
101
|
+
recurrenceId?: string;
|
|
102
|
+
/** Calendar whose copy of the event is answered, for a multi-calendar event.
|
|
103
|
+
* Omit to answer on the canonical copy. */
|
|
104
|
+
calendar?: Calendar;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* A Rox calendar event: a handle exposing the event's synced fields and the
|
|
108
|
+
* mutations that act on it ({@link CalendarEvent.update},
|
|
109
|
+
* {@link CalendarEvent.delete}, {@link CalendarEvent.rsvp}).
|
|
110
|
+
*
|
|
111
|
+
* The calendar service has no fetch-by-id endpoint, so a handle reads its
|
|
112
|
+
* fields only when seeded with a record — as returned by
|
|
113
|
+
* {@link CalendarEvent.update}, {@link CalendarEvent.rsvp}, or
|
|
114
|
+
* `calendar.createEvent`. A bare {@link CalendarEvent.byId} handle can drive
|
|
115
|
+
* mutations, but reading a field on it throws.
|
|
116
|
+
*/
|
|
117
|
+
export declare class CalendarEvent extends RoxEntity<CalendarEventRecord> {
|
|
118
|
+
protected fetch(): Promise<CalendarEventRecord>;
|
|
119
|
+
/** A handle to a calendar event by id, for driving mutations. Reading a
|
|
120
|
+
* field on it throws (there is no fetch-by-id endpoint). */
|
|
121
|
+
static byId(client: RoxClient, id: string): CalendarEvent;
|
|
122
|
+
/** A handle seeded with a synced event record; reads resolve without a fetch. */
|
|
123
|
+
static fromRecord(client: RoxClient, record: CalendarEventRecord): CalendarEvent;
|
|
124
|
+
/** Display title. */
|
|
125
|
+
readonly title: () => Promise<string>;
|
|
126
|
+
/** Optional event body. */
|
|
127
|
+
readonly description: () => Promise<string | undefined>;
|
|
128
|
+
/** Optional physical or virtual location label. */
|
|
129
|
+
readonly location: () => Promise<string | undefined>;
|
|
130
|
+
/** Timed or all-day shape. */
|
|
131
|
+
readonly time: () => Promise<EventTime>;
|
|
132
|
+
/** Event status. */
|
|
133
|
+
readonly status: () => Promise<import("../../../generated/calendar").EventStatus>;
|
|
134
|
+
/** Attendees on the canonical copy. */
|
|
135
|
+
readonly attendees: () => Promise<import("../../../generated/calendar").CalendarAttendee[]>;
|
|
136
|
+
/** Availability behavior. */
|
|
137
|
+
readonly transparency: () => Promise<EventTransparency>;
|
|
138
|
+
/** Whether the canonical source's calendar prohibits editing. */
|
|
139
|
+
readonly isReadOnly: () => Promise<boolean>;
|
|
140
|
+
/** Raw RFC 5545 recurrence properties (`RRULE`, `RDATE`, `EXDATE`). */
|
|
141
|
+
readonly recurrenceLines: () => Promise<string[]>;
|
|
142
|
+
/** What the organizer lets guests do: modify, invite others, see the guest list. */
|
|
143
|
+
readonly guestPolicy: () => Promise<GuestPolicy>;
|
|
144
|
+
/** What the connected account may do with this event under its guest policy. */
|
|
145
|
+
readonly viewerCan: () => Promise<import("../../../generated/calendar").ViewerCapabilities>;
|
|
146
|
+
/** The calendar the canonical source belongs to, when known. */
|
|
147
|
+
readonly calendar: () => Promise<Calendar | undefined>;
|
|
148
|
+
/** The full synced event record. Available on a seeded handle (from create /
|
|
149
|
+
* update / rsvp); a bare `byId` handle throws (no fetch-by-id endpoint).
|
|
150
|
+
*
|
|
151
|
+
* @readonly
|
|
152
|
+
*/
|
|
153
|
+
record(): Promise<CalendarEventRecord>;
|
|
154
|
+
/** Update the event and return a handle to its synced record.
|
|
155
|
+
*
|
|
156
|
+
* A meeting on more than one of the user's inboxes is one event per inbox,
|
|
157
|
+
* each with its own id (see the occurrence listing's `inbox` and `role`).
|
|
158
|
+
* Before changing its details, guests or guest permissions, ask the user
|
|
159
|
+
* which inbox's copy to change, then pass that copy's `inbox`. Never choose
|
|
160
|
+
* between the user's inboxes yourself, whatever they look like: a test,
|
|
161
|
+
* secondary or unfamiliar address is still the user's own inbox. Skip the
|
|
162
|
+
* question only when the user already named the inbox, when only one copy's
|
|
163
|
+
* `viewerCan` allows the change (use it and say why), or when adding guests
|
|
164
|
+
* to a meeting the user organizes from one of the inboxes (add them from
|
|
165
|
+
* that copy and say why). Reminders belong to one copy, so set them on one
|
|
166
|
+
* copy and say which inbox you used. Without `inbox` the call is refused
|
|
167
|
+
* with `copy_choice_required`, listing each copy and the question to ask.
|
|
168
|
+
*
|
|
169
|
+
* To change a meeting's link to a Rox call pass `macroCall: true`; never
|
|
170
|
+
* delete and recreate the event for it. The Teams meeting of an Outlook event
|
|
171
|
+
* cannot be removed this way: use {@link CalendarEvent.prepareReplacement}.
|
|
172
|
+
*
|
|
173
|
+
* @destructive
|
|
174
|
+
* @openworld
|
|
175
|
+
* @idempotent
|
|
176
|
+
*/
|
|
177
|
+
update(options: UpdateEventOptions): Promise<CalendarEvent>;
|
|
178
|
+
/** Delete the event (or a scoped part of a recurring series) at its provider.
|
|
179
|
+
*
|
|
180
|
+
* A meeting on more than one of the user's inboxes is one event per inbox.
|
|
181
|
+
* Before deleting any of them, ask the user which inbox's copy to delete,
|
|
182
|
+
* then pass that copy's `inbox`. Never choose between the user's inboxes
|
|
183
|
+
* yourself, whatever they look like: a test, secondary or unfamiliar address
|
|
184
|
+
* is still the user's own inbox. Skip the question only when the user
|
|
185
|
+
* already named the inbox, or when only one copy can be deleted; then delete
|
|
186
|
+
* that copy and say why. Without `inbox` the call is refused with
|
|
187
|
+
* `copy_choice_required`, listing each copy and the question to ask.
|
|
188
|
+
*
|
|
189
|
+
* Deleting the copy the user organizes cancels the meeting for every guest.
|
|
190
|
+
* Deleting a copy where they are a guest takes the meeting off that inbox's
|
|
191
|
+
* calendar: on Google it also declines the invitation and tells the
|
|
192
|
+
* organizer, while on Outlook the organizer is not told and still sees the
|
|
193
|
+
* invitation unanswered.
|
|
194
|
+
*
|
|
195
|
+
* @destructive
|
|
196
|
+
* @openworld
|
|
197
|
+
* @idempotent
|
|
198
|
+
*/
|
|
199
|
+
delete(options?: DeleteEventOptions): Promise<void>;
|
|
200
|
+
/** Preview an organizer replacement without cancelling or sending invitations.
|
|
201
|
+
* Review replacement.status() before explicitly calling replacement.confirm().
|
|
202
|
+
*
|
|
203
|
+
* @write
|
|
204
|
+
*/
|
|
205
|
+
prepareReplacement(options: {
|
|
206
|
+
removeConference: boolean;
|
|
207
|
+
recurrenceId?: string;
|
|
208
|
+
calendar?: Calendar;
|
|
209
|
+
}): Promise<CalendarReplacement>;
|
|
210
|
+
/**
|
|
211
|
+
* Open this calendar copy in its provider for actions unavailable through its API.
|
|
212
|
+
*
|
|
213
|
+
* @readonly
|
|
214
|
+
*/
|
|
215
|
+
providerUrl(options?: {
|
|
216
|
+
recurrenceId?: string;
|
|
217
|
+
calendar?: Calendar;
|
|
218
|
+
}): Promise<string | undefined>;
|
|
219
|
+
/** Add guests without touching anyone already invited, and return a handle
|
|
220
|
+
* to the synced record.
|
|
221
|
+
*
|
|
222
|
+
* When the meeting is on more than one of the user's inboxes, add from the
|
|
223
|
+
* copy the user organizes when there is one (it invites directly, while a
|
|
224
|
+
* guest's copy invites only as far as the organizer allows) and say why;
|
|
225
|
+
* otherwise ask the user which inbox's copy to add them from. Never choose
|
|
226
|
+
* between the user's inboxes any other way, whatever they look like. Pass
|
|
227
|
+
* that copy's `inbox`; without it the call is refused with
|
|
228
|
+
* `copy_choice_required`, listing each copy and the question to ask.
|
|
229
|
+
*
|
|
230
|
+
* The organizer may add guests, and so may a guest the organizer lets
|
|
231
|
+
* invite others (see {@link CalendarEvent.viewerCan}); Google emails the
|
|
232
|
+
* new guests.
|
|
233
|
+
*
|
|
234
|
+
* @destructive
|
|
235
|
+
* @openworld
|
|
236
|
+
* @idempotent
|
|
237
|
+
*/
|
|
238
|
+
inviteGuests(options: InviteGuestsOptions): Promise<CalendarEvent>;
|
|
239
|
+
/** Add a snapshot of an event shared with one of the requester's
|
|
240
|
+
* channels to one of their Google calendars, and return a handle to the
|
|
241
|
+
* synced snapshot. The snapshot keeps the meeting's iCalendar UID and
|
|
242
|
+
* organizer, lists only the requester as a guest, and carries no join link;
|
|
243
|
+
* nobody is notified, and answers or guests on it never reach the meeting.
|
|
244
|
+
* Refused with `already_on_calendar` when the meeting is already on one of
|
|
245
|
+
* their calendars, whichever calendar is named, so it cannot be added to
|
|
246
|
+
* another of their calendars either; with `join_request_open` while their
|
|
247
|
+
* request to join it is pending or accepted (the meeting then arrives as an
|
|
248
|
+
* invitation); and with `copy_refused` when Google will not import it.
|
|
249
|
+
*
|
|
250
|
+
* @write
|
|
251
|
+
* @openworld
|
|
252
|
+
*/
|
|
253
|
+
addToCalendar(options?: {
|
|
254
|
+
calendar?: Calendar;
|
|
255
|
+
}): Promise<CalendarEvent>;
|
|
256
|
+
/** Share the event with a channel's current members, as posting it in the
|
|
257
|
+
* channel does: they can then preview it, export it with {@link ics}, add it
|
|
258
|
+
* to their calendar with {@link addToCalendar} and ask to join. The caller
|
|
259
|
+
* must be in the channel and hold the event on their own calendar; private
|
|
260
|
+
* and confidential events are refused with a 403. Sharing again changes
|
|
261
|
+
* nothing.
|
|
262
|
+
*
|
|
263
|
+
* @write
|
|
264
|
+
* @idempotent
|
|
265
|
+
*/
|
|
266
|
+
shareWithChannel(channel: Channel): Promise<void>;
|
|
267
|
+
/** The event as an iCalendar (`.ics`) document: its series, title,
|
|
268
|
+
* description, location and organizer, never its guests or join link.
|
|
269
|
+
* Available for the requester's own events and ones shared with a channel
|
|
270
|
+
* they belong to.
|
|
271
|
+
*
|
|
272
|
+
* @readonly
|
|
273
|
+
*/
|
|
274
|
+
ics(): Promise<string>;
|
|
275
|
+
/**
|
|
276
|
+
* Record the requester's RSVP and return a handle to the synced record.
|
|
277
|
+
*
|
|
278
|
+
* @destructive
|
|
279
|
+
* @openworld
|
|
280
|
+
* @idempotent
|
|
281
|
+
*/
|
|
282
|
+
rsvp(options: RsvpEventOptions): Promise<CalendarEvent>;
|
|
283
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|