@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,108 @@
|
|
|
1
|
+
import type { GetProjectContentHandlerResponses, GetProjectHandlerResponses } from '../../../generated/storage/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import type { Channel } from '../channels/channel';
|
|
4
|
+
import { PropertiedEntity } from '../entity';
|
|
5
|
+
import { EntityAccess } from '../sharing/access';
|
|
6
|
+
import { type SharePermissionOptions } from '../sharing/permissions';
|
|
7
|
+
type ProjectDetail = GetProjectHandlerResponses[200]['data']['projectMetadata'];
|
|
8
|
+
type ProjectItem = GetProjectContentHandlerResponses[200]['data'][number]['item'];
|
|
9
|
+
/** A Rox project: a folder-like container for documents, chats, and subprojects. */
|
|
10
|
+
export declare class Project extends PropertiedEntity<ProjectDetail> {
|
|
11
|
+
/**
|
|
12
|
+
* Read this project's sharing configuration.
|
|
13
|
+
*
|
|
14
|
+
* @readonly
|
|
15
|
+
*/
|
|
16
|
+
sharePermissions(): Promise<import("../../../generated/storage").SharePermissionV2>;
|
|
17
|
+
/**
|
|
18
|
+
* Change who can open the project and its contents: the link share and its
|
|
19
|
+
* access level, the owner's team, and channel grants. Omitted fields are
|
|
20
|
+
* left as they are.
|
|
21
|
+
*
|
|
22
|
+
* @write
|
|
23
|
+
* @idempotent
|
|
24
|
+
*/
|
|
25
|
+
updateSharePermissions(options: SharePermissionOptions): Promise<void>;
|
|
26
|
+
/**
|
|
27
|
+
* Read the caller's effective access level.
|
|
28
|
+
*
|
|
29
|
+
* @readonly
|
|
30
|
+
*/
|
|
31
|
+
accessLevel(): Promise<"view" | "comment" | "edit" | "owner">;
|
|
32
|
+
/** Access requests and direct user grants. */
|
|
33
|
+
readonly access: EntityAccess;
|
|
34
|
+
/** Favorites identify projects as `project`. */
|
|
35
|
+
readonly entityType = "project";
|
|
36
|
+
/**
|
|
37
|
+
* Share this project with a channel's current members, as posting it in the
|
|
38
|
+
* channel does. The caller must be in the channel and able to share the
|
|
39
|
+
* project; sharing again changes nothing.
|
|
40
|
+
*
|
|
41
|
+
* @write
|
|
42
|
+
* @idempotent
|
|
43
|
+
*/
|
|
44
|
+
shareWithChannel(channel: Channel): Promise<void>;
|
|
45
|
+
/** The properties service identifies projects as `PROJECT`. */
|
|
46
|
+
protected readonly propertyEntityType = "PROJECT";
|
|
47
|
+
protected fetch(): Promise<ProjectDetail>;
|
|
48
|
+
/**
|
|
49
|
+
* The project's URL in the Rox web app; hand it to users as the link.
|
|
50
|
+
*
|
|
51
|
+
* @readonly
|
|
52
|
+
*/
|
|
53
|
+
webUrl(): string;
|
|
54
|
+
/** Identity, loaded detail and {@link webUrl}, so serialized handles carry their link. */
|
|
55
|
+
toJSON(): {
|
|
56
|
+
url: string;
|
|
57
|
+
id: string;
|
|
58
|
+
detail?: import("../../../generated/storage").Project | undefined;
|
|
59
|
+
};
|
|
60
|
+
/** A handle to a project by id. Details load on first access. */
|
|
61
|
+
static byId(client: RoxClient, id: string): Project;
|
|
62
|
+
/** Create a project, optionally nested inside a parent project. */
|
|
63
|
+
static create(client: RoxClient, opts: {
|
|
64
|
+
name: string;
|
|
65
|
+
parent?: Project;
|
|
66
|
+
}): Promise<Project>;
|
|
67
|
+
/** The project's display name. */
|
|
68
|
+
readonly name: () => Promise<string>;
|
|
69
|
+
/** The parent project, if this project is nested. */
|
|
70
|
+
readonly parent: () => Promise<Project | undefined>;
|
|
71
|
+
/** When the project was created (RFC 3339 timestamp). */
|
|
72
|
+
readonly createdAt: () => Promise<string | undefined>;
|
|
73
|
+
/**
|
|
74
|
+
* The items (documents, chats, subprojects) directly inside this project.
|
|
75
|
+
* Agent sessions are never project items; link one from a document in the
|
|
76
|
+
* project instead (see `ProjectNamespace`).
|
|
77
|
+
*
|
|
78
|
+
* @readonly
|
|
79
|
+
*/
|
|
80
|
+
items(): Promise<ProjectItem[]>;
|
|
81
|
+
/**
|
|
82
|
+
* Rename the project.
|
|
83
|
+
*
|
|
84
|
+
* @write
|
|
85
|
+
* @idempotent
|
|
86
|
+
*/
|
|
87
|
+
rename(name: string): Promise<void>;
|
|
88
|
+
/**
|
|
89
|
+
* Delete the project and its contents. Soft by default (reversible with
|
|
90
|
+
* {@link restore}); pass `permanent: true` to delete irreversibly.
|
|
91
|
+
*
|
|
92
|
+
* @destructive
|
|
93
|
+
* @idempotent
|
|
94
|
+
*/
|
|
95
|
+
delete(opts?: {
|
|
96
|
+
permanent?: boolean;
|
|
97
|
+
}): Promise<void>;
|
|
98
|
+
/**
|
|
99
|
+
* Restore a soft-deleted project.
|
|
100
|
+
*
|
|
101
|
+
* @write
|
|
102
|
+
* @idempotent
|
|
103
|
+
*/
|
|
104
|
+
restore(): Promise<void>;
|
|
105
|
+
/** Search projects by name and content, most relevant first, auto-paginated; `maxItems` caps the total. */
|
|
106
|
+
static search: (client: RoxClient, query: string, searchOpts?: import("../search/options").SearchOpts) => AsyncGenerator<Project, any, any>;
|
|
107
|
+
}
|
|
108
|
+
export {};
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import type { BulkEntityOptionUpdateResult, BulkEntityPropertiesRequest, CreatePropertyScope, EntityPropertiesResponse, PropertyDataType, PropertyDefinition as PropertyDefinitionRecord, PropertyTargetEntityType as PropertyEntityType, PropertyScope, TagScope, TagSetResponse } from '../../../generated/properties/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import type { PropertiedEntity, PropertyOptionDelta } from '../entity';
|
|
4
|
+
import { PropertyDefinition } from './property-definition';
|
|
5
|
+
import { PropertyOption } from './property-option';
|
|
6
|
+
export type { BulkEntityPropertiesRequest, CreatePropertyScope, EntityPropertiesResponse, PropertyDataType, PropertyDefinitionRecord, PropertyEntityType, PropertyScope, TagScope, TagSetResponse, };
|
|
7
|
+
export { PropertyDefinition, PropertyOption };
|
|
8
|
+
/**
|
|
9
|
+
* Property definitions and tag sets. Entity-level reads and writes live on
|
|
10
|
+
* the entity handles ({@link PropertiedEntity.properties}, `setProperty`,
|
|
11
|
+
* `deleteProperty`).
|
|
12
|
+
*
|
|
13
|
+
* @routing Use when the request is about an item's custom properties or tags themselves, such as defining a property, creating or editing a tag, or bulk-setting options; not creating or updating a task, deal, event or row, whose own methods set their fields.
|
|
14
|
+
*/
|
|
15
|
+
export declare class PropertiesNamespace {
|
|
16
|
+
private readonly client;
|
|
17
|
+
constructor(client: RoxClient);
|
|
18
|
+
/**
|
|
19
|
+
* List property definitions visible to the user, pre-hydrated with their records.
|
|
20
|
+
*
|
|
21
|
+
* @readonly
|
|
22
|
+
*/
|
|
23
|
+
list(opts?: {
|
|
24
|
+
scope?: PropertyScope;
|
|
25
|
+
forEntityType?: PropertyEntityType;
|
|
26
|
+
}): Promise<PropertyDefinition[]>;
|
|
27
|
+
/**
|
|
28
|
+
* Create a new custom property definition.
|
|
29
|
+
*
|
|
30
|
+
* @write
|
|
31
|
+
*/
|
|
32
|
+
create(opts: {
|
|
33
|
+
displayName: string;
|
|
34
|
+
scope: CreatePropertyScope;
|
|
35
|
+
dataType: PropertyDataType;
|
|
36
|
+
}): Promise<PropertyDefinition>;
|
|
37
|
+
/**
|
|
38
|
+
* A handle to an existing property definition by id.
|
|
39
|
+
*
|
|
40
|
+
* @readonly
|
|
41
|
+
*/
|
|
42
|
+
definition(id: string): PropertyDefinition;
|
|
43
|
+
/**
|
|
44
|
+
* Get properties for multiple entities in a single request.
|
|
45
|
+
*
|
|
46
|
+
* @readonly
|
|
47
|
+
*/
|
|
48
|
+
bulkEntityProperties(request: BulkEntityPropertiesRequest): Promise<Record<string, EntityPropertiesResponse>>;
|
|
49
|
+
/**
|
|
50
|
+
* Apply one multi-select option delta to several entity handles.
|
|
51
|
+
*
|
|
52
|
+
* @write
|
|
53
|
+
* @idempotent
|
|
54
|
+
* @mcp-exclude Takes a handle built from a listing record, which an MCP call can't reference.
|
|
55
|
+
*/
|
|
56
|
+
updateEntityPropertyOptions(entities: PropertiedEntity<unknown>[], change: PropertyOptionDelta): Promise<BulkEntityOptionUpdateResult[]>;
|
|
57
|
+
/**
|
|
58
|
+
* Add a select option to a multi-select property value on an entity.
|
|
59
|
+
*
|
|
60
|
+
* @write
|
|
61
|
+
* @idempotent
|
|
62
|
+
* @mcp-exclude Takes a handle built from a listing record, which an MCP call can't reference.
|
|
63
|
+
*/
|
|
64
|
+
addEntityPropertyOption(opts: {
|
|
65
|
+
entity: PropertiedEntity<unknown>;
|
|
66
|
+
property: PropertyDefinition;
|
|
67
|
+
option: PropertyOption;
|
|
68
|
+
}): Promise<void>;
|
|
69
|
+
/**
|
|
70
|
+
* Remove a select option from a multi-select property value on an entity.
|
|
71
|
+
*
|
|
72
|
+
* @write
|
|
73
|
+
* @idempotent
|
|
74
|
+
* @mcp-exclude Takes a handle built from a listing record, which an MCP call can't reference.
|
|
75
|
+
*/
|
|
76
|
+
removeEntityPropertyOption(opts: {
|
|
77
|
+
entity: PropertiedEntity<unknown>;
|
|
78
|
+
property: PropertyDefinition;
|
|
79
|
+
option: PropertyOption;
|
|
80
|
+
}): Promise<void>;
|
|
81
|
+
/**
|
|
82
|
+
* The user's tag sets: their personal set, plus their team's when on a team.
|
|
83
|
+
* A set without a `definition` has no tags yet; {@link createTag} creates it.
|
|
84
|
+
* Edit or delete a tag through `definition(set.definition.id).options()`.
|
|
85
|
+
*
|
|
86
|
+
* @readonly
|
|
87
|
+
*/
|
|
88
|
+
tags(): Promise<TagSetResponse[]>;
|
|
89
|
+
/**
|
|
90
|
+
* Create a tag, provisioning the tag set on its first tag. Tags match by
|
|
91
|
+
* label, so check {@link tags} first and never duplicate one in the same set.
|
|
92
|
+
* Apply it with `item.updatePropertyOptions([{ property, add: [tag] }])`,
|
|
93
|
+
* where `property` is `definition(tag.definitionId)`.
|
|
94
|
+
*
|
|
95
|
+
* @write
|
|
96
|
+
*/
|
|
97
|
+
createTag(opts: {
|
|
98
|
+
/** The label, e.g. "Urgent". */
|
|
99
|
+
label: string;
|
|
100
|
+
/** A hex color such as `#46A758`. */
|
|
101
|
+
color?: string;
|
|
102
|
+
/** `user` (the default) for the user's own tags, `team` for their team's shared tags. */
|
|
103
|
+
scope?: TagScope;
|
|
104
|
+
}): Promise<PropertyOption>;
|
|
105
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import type { AddPropertyOptionRequest, DataType, PropertyDefinition as PropertyDefinitionRecord, PropertyOwner } from '../../../generated/properties/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
import type { CreatePropertyScope, PropertyDataType } from './namespace';
|
|
4
|
+
import { PropertyOption, type UpdatePropertyOptionRequest } from './property-option';
|
|
5
|
+
export type { AddPropertyOptionRequest, UpdatePropertyOptionRequest };
|
|
6
|
+
export { PropertyOption };
|
|
7
|
+
/**
|
|
8
|
+
* A property definition: schema for a custom field that can be attached to
|
|
9
|
+
* entities. Obtain instances via {@link PropertiesNamespace.create},
|
|
10
|
+
* {@link PropertiesNamespace.list}, or {@link PropertiesNamespace.definition}.
|
|
11
|
+
*/
|
|
12
|
+
export declare class PropertyDefinition {
|
|
13
|
+
private readonly client;
|
|
14
|
+
readonly id: string;
|
|
15
|
+
private readonly detail;
|
|
16
|
+
private constructor();
|
|
17
|
+
private fetch;
|
|
18
|
+
/** Create a new property definition. */
|
|
19
|
+
static create(client: RoxClient, opts: {
|
|
20
|
+
displayName: string;
|
|
21
|
+
scope: CreatePropertyScope;
|
|
22
|
+
dataType: PropertyDataType;
|
|
23
|
+
}): Promise<PropertyDefinition>;
|
|
24
|
+
/** A handle to an existing definition by id. Fields load lazily on first access. */
|
|
25
|
+
static byId(client: RoxClient, id: string): PropertyDefinition;
|
|
26
|
+
/** Wrap a record already in hand (e.g. from a list response). */
|
|
27
|
+
static fromRecord(client: RoxClient, record: PropertyDefinitionRecord): PropertyDefinition;
|
|
28
|
+
get displayName(): Promise<string>;
|
|
29
|
+
get dataType(): Promise<DataType>;
|
|
30
|
+
get owner(): Promise<PropertyOwner>;
|
|
31
|
+
get isSystem(): Promise<boolean>;
|
|
32
|
+
get isMultiSelect(): Promise<boolean>;
|
|
33
|
+
get createdAt(): Promise<string>;
|
|
34
|
+
get updatedAt(): Promise<string>;
|
|
35
|
+
/**
|
|
36
|
+
* Delete this property definition.
|
|
37
|
+
*
|
|
38
|
+
* @destructive
|
|
39
|
+
* @idempotent
|
|
40
|
+
*/
|
|
41
|
+
delete(): Promise<void>;
|
|
42
|
+
/**
|
|
43
|
+
* The selectable options for this definition (select-type properties).
|
|
44
|
+
*
|
|
45
|
+
* @readonly
|
|
46
|
+
*/
|
|
47
|
+
options(): Promise<PropertyOption[]>;
|
|
48
|
+
/**
|
|
49
|
+
* Add an option to this select-type property.
|
|
50
|
+
*
|
|
51
|
+
* @write
|
|
52
|
+
*/
|
|
53
|
+
addOption(option: AddPropertyOptionRequest): Promise<PropertyOption>;
|
|
54
|
+
/**
|
|
55
|
+
* Update an option (label, color, display order).
|
|
56
|
+
*
|
|
57
|
+
* @write
|
|
58
|
+
* @idempotent
|
|
59
|
+
* @mcp-exclude Takes a handle built from a listing record, which an MCP call can't reference.
|
|
60
|
+
*/
|
|
61
|
+
updateOption(option: PropertyOption, updates: UpdatePropertyOptionRequest): Promise<PropertyOption>;
|
|
62
|
+
/**
|
|
63
|
+
* Delete an option from this property.
|
|
64
|
+
*
|
|
65
|
+
* @destructive
|
|
66
|
+
* @idempotent
|
|
67
|
+
* @mcp-exclude Takes a handle built from a listing record, which an MCP call can't reference.
|
|
68
|
+
*/
|
|
69
|
+
deleteOption(option: PropertyOption): Promise<void>;
|
|
70
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import type { PropertyOption as PropertyOptionRecord, UpdatePropertyOptionRequest } from '../../../generated/properties/types.gen';
|
|
2
|
+
import type { RoxClient } from '../../utils/client';
|
|
3
|
+
export type { UpdatePropertyOptionRequest };
|
|
4
|
+
/**
|
|
5
|
+
* A selectable option on a select-type property definition. There is no
|
|
6
|
+
* single-option GET, so instances are only built from a seed record — via
|
|
7
|
+
* {@link PropertyDefinition.options} or {@link PropertyDefinition.addOption}.
|
|
8
|
+
*
|
|
9
|
+
* @mcp-exclude Built from a listing record; no id-only reference an MCP call can pass.
|
|
10
|
+
*/
|
|
11
|
+
export declare class PropertyOption {
|
|
12
|
+
private readonly client;
|
|
13
|
+
/** The property definition this option belongs to. */
|
|
14
|
+
readonly definitionId: string;
|
|
15
|
+
readonly id: string;
|
|
16
|
+
private record;
|
|
17
|
+
private constructor();
|
|
18
|
+
/** Wrap a record already in hand (e.g. from a list or create response). */
|
|
19
|
+
static from(client: RoxClient, definitionId: string, record: PropertyOptionRecord): PropertyOption;
|
|
20
|
+
/** The option's value (string or number, per the property's data type). */
|
|
21
|
+
get value(): PropertyOptionRecord['value'];
|
|
22
|
+
/** The option's display color, if set. */
|
|
23
|
+
get color(): string | undefined;
|
|
24
|
+
/** The option's position among its definition's options. */
|
|
25
|
+
get displayOrder(): number;
|
|
26
|
+
/** When the option was created. */
|
|
27
|
+
get createdAt(): string;
|
|
28
|
+
/** When the option was last updated. */
|
|
29
|
+
get updatedAt(): string;
|
|
30
|
+
/**
|
|
31
|
+
* Update this option's label, color, or display order.
|
|
32
|
+
*
|
|
33
|
+
* @write
|
|
34
|
+
* @idempotent
|
|
35
|
+
*/
|
|
36
|
+
update(updates: UpdatePropertyOptionRequest): Promise<this>;
|
|
37
|
+
/**
|
|
38
|
+
* Delete this option from its property definition.
|
|
39
|
+
*
|
|
40
|
+
* @destructive
|
|
41
|
+
* @idempotent
|
|
42
|
+
*/
|
|
43
|
+
delete(): Promise<void>;
|
|
44
|
+
}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import type { AgentSession } from './agent-sessions/agent-session';
|
|
2
|
+
import type { CalendarEvent } from './calendar/event';
|
|
3
|
+
import type { CallRecord } from './calls/call-record';
|
|
4
|
+
import type { Channel } from './channels/channel';
|
|
5
|
+
import type { Message } from './channels/message';
|
|
6
|
+
import type { Chat } from './chats/chat';
|
|
7
|
+
import type { Company } from './crm/company';
|
|
8
|
+
import type { Contact } from './crm/contact';
|
|
9
|
+
import type { CrmPipeline } from './crm/pipeline';
|
|
10
|
+
import type { Database } from './databases/database';
|
|
11
|
+
import type { DatabaseRow } from './databases/row';
|
|
12
|
+
import type { Document } from './documents/document';
|
|
13
|
+
import type { EmailThread } from './email/thread';
|
|
14
|
+
import type { ForeignEntity } from './foreign/foreign-entity';
|
|
15
|
+
import type { Form } from './forms/form';
|
|
16
|
+
import type { Initiative } from './initiatives/initiative';
|
|
17
|
+
import type { Project } from './projects/project';
|
|
18
|
+
import type { Routine } from './routines/routine';
|
|
19
|
+
import type { Team } from './teams/team';
|
|
20
|
+
import type { User } from './users/user';
|
|
21
|
+
/** Typed entity references accepted by cross-resource APIs. */
|
|
22
|
+
export type EntityReference = {
|
|
23
|
+
type: 'user';
|
|
24
|
+
entity: User;
|
|
25
|
+
} | {
|
|
26
|
+
type: 'team';
|
|
27
|
+
entity: Team;
|
|
28
|
+
} | {
|
|
29
|
+
type: 'document';
|
|
30
|
+
entity: Document;
|
|
31
|
+
} | {
|
|
32
|
+
type: 'chat';
|
|
33
|
+
entity: Chat;
|
|
34
|
+
} | {
|
|
35
|
+
type: 'channel';
|
|
36
|
+
entity: Channel;
|
|
37
|
+
} | {
|
|
38
|
+
type: 'channel_message';
|
|
39
|
+
entity: Message;
|
|
40
|
+
} | {
|
|
41
|
+
type: 'project';
|
|
42
|
+
entity: Project;
|
|
43
|
+
} | {
|
|
44
|
+
type: 'email_thread';
|
|
45
|
+
entity: EmailThread;
|
|
46
|
+
} | {
|
|
47
|
+
type: 'calendar_event';
|
|
48
|
+
entity: CalendarEvent;
|
|
49
|
+
} | {
|
|
50
|
+
type: 'call';
|
|
51
|
+
entity: CallRecord;
|
|
52
|
+
} | {
|
|
53
|
+
type: 'foreign_entity';
|
|
54
|
+
entity: ForeignEntity;
|
|
55
|
+
} | {
|
|
56
|
+
type: 'crm_company';
|
|
57
|
+
entity: Company;
|
|
58
|
+
} | {
|
|
59
|
+
type: 'crm_contact';
|
|
60
|
+
entity: Contact;
|
|
61
|
+
} | {
|
|
62
|
+
type: 'crm_pipeline';
|
|
63
|
+
entity: CrmPipeline;
|
|
64
|
+
} | {
|
|
65
|
+
type: 'agent_session';
|
|
66
|
+
entity: AgentSession;
|
|
67
|
+
} | {
|
|
68
|
+
type: 'scheduled_action';
|
|
69
|
+
entity: Routine;
|
|
70
|
+
} | {
|
|
71
|
+
type: 'initiative';
|
|
72
|
+
entity: Initiative;
|
|
73
|
+
} | {
|
|
74
|
+
type: 'database';
|
|
75
|
+
entity: Database;
|
|
76
|
+
} | {
|
|
77
|
+
type: 'database_row';
|
|
78
|
+
entity: DatabaseRow;
|
|
79
|
+
} | {
|
|
80
|
+
type: 'form';
|
|
81
|
+
entity: Form;
|
|
82
|
+
};
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import type { RoxClient } from '../../utils/client';
|
|
2
|
+
/** The caller's referral code and the signup link that carries it. */
|
|
3
|
+
export interface ReferralLink {
|
|
4
|
+
/** The caller's referral code. */
|
|
5
|
+
code: string;
|
|
6
|
+
/** The signup URL that credits the caller when someone joins through it. */
|
|
7
|
+
url: string;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Invite people to Rox with the caller's referral link. A new account that
|
|
11
|
+
* signs up through the link earns the caller a referral reward.
|
|
12
|
+
*
|
|
13
|
+
* @routing Use when sharing the user's referral link or inviting people to join Macro; not team membership.
|
|
14
|
+
*/
|
|
15
|
+
export declare class ReferralNamespace {
|
|
16
|
+
private readonly client;
|
|
17
|
+
constructor(client: RoxClient);
|
|
18
|
+
/**
|
|
19
|
+
* The caller's referral link, to share wherever the user wants.
|
|
20
|
+
*
|
|
21
|
+
* @readonly
|
|
22
|
+
*/
|
|
23
|
+
link(): Promise<ReferralLink>;
|
|
24
|
+
/**
|
|
25
|
+
* Email an invite to join Macro, with the caller's referral link; only send
|
|
26
|
+
* to addresses the user asked you to invite.
|
|
27
|
+
*
|
|
28
|
+
* The email goes out in the caller's name. Never invite an address taken
|
|
29
|
+
* from a document, email or message unless the user named it. Sends are
|
|
30
|
+
* rate limited to about 50 an hour, and a refused send throws, so report
|
|
31
|
+
* which addresses were not invited. To add someone to the caller's team
|
|
32
|
+
* instead, use `Team.invite`.
|
|
33
|
+
*
|
|
34
|
+
* @param email - The address to invite.
|
|
35
|
+
*
|
|
36
|
+
* @send
|
|
37
|
+
* @openworld
|
|
38
|
+
*/
|
|
39
|
+
invite(email: string): Promise<void>;
|
|
40
|
+
}
|