The Coline App SDK: apps, tools, file types and surfaces that run inside Coline workspaces, and public websites with Coline Sites. TypeScript, with an in-memory test workspace. MIT.
| 6 |
| export interface paths { |
| 7 | "/api/v1/tab/models": { |
| 8 | parameters: { |
| 9 | query?: never; |
| 10 | header?: never; |
| 11 | path?: never; |
| 12 | cookie?: never; |
| 13 | }; |
| 14 | /** List Tab models */ |
| 15 | get: operations["listTabModels"]; |
| 16 | put?: never; |
| 17 | post?: never; |
| 18 | delete?: never; |
| 19 | options?: never; |
| 20 | head?: never; |
| 21 | patch?: never; |
| 22 | trace?: never; |
| 23 | }; |
| 24 | "/api/v1/tab/chat/completions": { |
| 25 | parameters: { |
| 26 | query?: never; |
| 27 | header?: never; |
| 28 | path?: never; |
| 29 | cookie?: never; |
| 30 | }; |
| 31 | get?: never; |
| 32 | put?: never; |
| 33 | /** Create an OpenAI-compatible Tab chat completion */ |
| 34 | post: operations["createTabChatCompletion"]; |
| 35 | delete?: never; |
| 36 | options?: never; |
| 37 | head?: never; |
| 38 | patch?: never; |
| 39 | trace?: never; |
| 40 | }; |
| 41 | "/api/v1/oauth/authorize": { |
| 42 | parameters: { |
| 43 | query?: never; |
| 44 | header?: never; |
| 45 | path?: never; |
| 46 | cookie?: never; |
| 47 | }; |
| 48 | /** Authorize an OAuth client */ |
| 49 | get: operations["authorizeOauthClient"]; |
| 50 | put?: never; |
| 51 | post?: never; |
| 52 | delete?: never; |
| 53 | options?: never; |
| 54 | head?: never; |
| 55 | patch?: never; |
| 56 | trace?: never; |
| 57 | }; |
| 58 | "/api/v1/oauth/token": { |
| 59 | parameters: { |
| 60 | query?: never; |
| 61 | header?: never; |
| 62 | path?: never; |
| 63 | cookie?: never; |
| 64 | }; |
| 65 | get?: never; |
| 66 | put?: never; |
| 67 | /** Exchange an authorization code for tokens */ |
| 68 | post: operations["exchangeOauthAuthorizationCode"]; |
| 69 | delete?: never; |
| 70 | options?: never; |
| 71 | head?: never; |
| 72 | patch?: never; |
| 73 | trace?: never; |
| 74 | }; |
| 75 | "/api/v1/oauth/userinfo": { |
| 76 | parameters: { |
| 77 | query?: never; |
| 78 | header?: never; |
| 79 | path?: never; |
| 80 | cookie?: never; |
| 81 | }; |
| 82 | /** Resolve OAuth userinfo */ |
| 83 | get: operations["getOauthUserInfo"]; |
| 84 | put?: never; |
| 85 | post?: never; |
| 86 | delete?: never; |
| 87 | options?: never; |
| 88 | head?: never; |
| 89 | patch?: never; |
| 90 | trace?: never; |
| 91 | }; |
| 92 | "/api/v1/apps": { |
| 93 | parameters: { |
| 94 | query?: never; |
| 95 | header?: never; |
| 96 | path?: never; |
| 97 | cookie?: never; |
| 98 | }; |
| 99 | /** List store apps */ |
| 100 | get: operations["listStoreApps"]; |
| 101 | put?: never; |
| 102 | /** Register a new app and initial release */ |
| 103 | post: operations["registerApp"]; |
| 104 | delete?: never; |
| 105 | options?: never; |
| 106 | head?: never; |
| 107 | patch?: never; |
| 108 | trace?: never; |
| 109 | }; |
| 110 | "/api/v1/apps/{appKey}": { |
| 111 | parameters: { |
| 112 | query?: never; |
| 113 | header?: never; |
| 114 | path?: never; |
| 115 | cookie?: never; |
| 116 | }; |
| 117 | /** Get a store app */ |
| 118 | get: operations["getStoreApp"]; |
| 119 | put?: never; |
| 120 | post?: never; |
| 121 | delete?: never; |
| 122 | options?: never; |
| 123 | head?: never; |
| 124 | patch?: never; |
| 125 | trace?: never; |
| 126 | }; |
| 127 | "/api/v1/apps/{appKey}/versions": { |
| 128 | parameters: { |
| 129 | query?: never; |
| 130 | header?: never; |
| 131 | path?: never; |
| 132 | cookie?: never; |
| 133 | }; |
| 134 | /** List approved versions for a store app */ |
| 135 | get: operations["listStoreAppVersions"]; |
| 136 | put?: never; |
| 137 | /** Create a new app version */ |
| 138 | post: operations["createAppVersion"]; |
| 139 | delete?: never; |
| 140 | options?: never; |
| 141 | head?: never; |
| 142 | patch?: never; |
| 143 | trace?: never; |
| 144 | }; |
| 145 | "/api/v1/apps/{appKey}/versions/{versionId}/submit": { |
| 146 | parameters: { |
| 147 | query?: never; |
| 148 | header?: never; |
| 149 | path?: never; |
| 150 | cookie?: never; |
| 151 | }; |
| 152 | get?: never; |
| 153 | put?: never; |
| 154 | /** Submit an app version for review */ |
| 155 | post: operations["submitAppVersionForReview"]; |
| 156 | delete?: never; |
| 157 | options?: never; |
| 158 | head?: never; |
| 159 | patch?: never; |
| 160 | trace?: never; |
| 161 | }; |
| 162 | "/api/v1/workspaces/{workspaceSlug}/apps": { |
| 163 | parameters: { |
| 164 | query?: never; |
| 165 | header?: never; |
| 166 | path?: never; |
| 167 | cookie?: never; |
| 168 | }; |
| 169 | /** List installed apps and workspace-visible catalog */ |
| 170 | get: operations["listWorkspaceApps"]; |
| 171 | put?: never; |
| 172 | /** Install an app into a workspace */ |
| 173 | post: operations["installWorkspaceApp"]; |
| 174 | delete?: never; |
| 175 | options?: never; |
| 176 | head?: never; |
| 177 | patch?: never; |
| 178 | trace?: never; |
| 179 | }; |
| 180 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}": { |
| 181 | parameters: { |
| 182 | query?: never; |
| 183 | header?: never; |
| 184 | path?: never; |
| 185 | cookie?: never; |
| 186 | }; |
| 187 | /** Get an installed workspace app */ |
| 188 | get: operations["getWorkspaceInstalledApp"]; |
| 189 | put?: never; |
| 190 | post?: never; |
| 191 | /** Uninstall a workspace app */ |
| 192 | delete: operations["uninstallWorkspaceApp"]; |
| 193 | options?: never; |
| 194 | head?: never; |
| 195 | patch?: never; |
| 196 | trace?: never; |
| 197 | }; |
| 198 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/permissions": { |
| 199 | parameters: { |
| 200 | query?: never; |
| 201 | header?: never; |
| 202 | path?: never; |
| 203 | cookie?: never; |
| 204 | }; |
| 205 | /** Get granted workspace app permissions */ |
| 206 | get: operations["getWorkspaceAppPermissions"]; |
| 207 | /** Update granted workspace app permissions */ |
| 208 | put: operations["updateWorkspaceAppPermissions"]; |
| 209 | post?: never; |
| 210 | delete?: never; |
| 211 | options?: never; |
| 212 | head?: never; |
| 213 | patch?: never; |
| 214 | trace?: never; |
| 215 | }; |
| 216 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/secrets": { |
| 217 | parameters: { |
| 218 | query?: never; |
| 219 | header?: never; |
| 220 | path?: never; |
| 221 | cookie?: never; |
| 222 | }; |
| 223 | /** List app secrets */ |
| 224 | get: operations["listWorkspaceAppSecrets"]; |
| 225 | put?: never; |
| 226 | /** Create or rotate app secret */ |
| 227 | post: operations["createWorkspaceAppSecret"]; |
| 228 | delete?: never; |
| 229 | options?: never; |
| 230 | head?: never; |
| 231 | patch?: never; |
| 232 | trace?: never; |
| 233 | }; |
| 234 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/secrets/{secretId}": { |
| 235 | parameters: { |
| 236 | query?: never; |
| 237 | header?: never; |
| 238 | path?: never; |
| 239 | cookie?: never; |
| 240 | }; |
| 241 | get?: never; |
| 242 | put?: never; |
| 243 | post?: never; |
| 244 | /** Delete app secret */ |
| 245 | delete: operations["deleteWorkspaceAppSecret"]; |
| 246 | options?: never; |
| 247 | head?: never; |
| 248 | patch?: never; |
| 249 | trace?: never; |
| 250 | }; |
| 251 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/oauth-connections": { |
| 252 | parameters: { |
| 253 | query?: never; |
| 254 | header?: never; |
| 255 | path?: never; |
| 256 | cookie?: never; |
| 257 | }; |
| 258 | /** List app OAuth connections */ |
| 259 | get: operations["listWorkspaceAppOauthConnections"]; |
| 260 | put?: never; |
| 261 | /** Create or update app OAuth connection */ |
| 262 | post: operations["createWorkspaceAppOauthConnection"]; |
| 263 | delete?: never; |
| 264 | options?: never; |
| 265 | head?: never; |
| 266 | patch?: never; |
| 267 | trace?: never; |
| 268 | }; |
| 269 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/oauth-connections/{connectionId}": { |
| 270 | parameters: { |
| 271 | query?: never; |
| 272 | header?: never; |
| 273 | path?: never; |
| 274 | cookie?: never; |
| 275 | }; |
| 276 | get?: never; |
| 277 | put?: never; |
| 278 | post?: never; |
| 279 | /** Delete app OAuth connection */ |
| 280 | delete: operations["deleteWorkspaceAppOauthConnection"]; |
| 281 | options?: never; |
| 282 | head?: never; |
| 283 | patch?: never; |
| 284 | trace?: never; |
| 285 | }; |
| 286 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/deliveries": { |
| 287 | parameters: { |
| 288 | query?: never; |
| 289 | header?: never; |
| 290 | path?: never; |
| 291 | cookie?: never; |
| 292 | }; |
| 293 | /** List app deliveries */ |
| 294 | get: operations["listWorkspaceAppDeliveries"]; |
| 295 | put?: never; |
| 296 | /** Send a signed test delivery */ |
| 297 | post: operations["sendWorkspaceAppTestDelivery"]; |
| 298 | delete?: never; |
| 299 | options?: never; |
| 300 | head?: never; |
| 301 | patch?: never; |
| 302 | trace?: never; |
| 303 | }; |
| 304 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/deliveries/{deliveryId}/replay": { |
| 305 | parameters: { |
| 306 | query?: never; |
| 307 | header?: never; |
| 308 | path?: never; |
| 309 | cookie?: never; |
| 310 | }; |
| 311 | get?: never; |
| 312 | put?: never; |
| 313 | /** Replay a stored app delivery */ |
| 314 | post: operations["replayWorkspaceAppDelivery"]; |
| 315 | delete?: never; |
| 316 | options?: never; |
| 317 | head?: never; |
| 318 | patch?: never; |
| 319 | trace?: never; |
| 320 | }; |
| 321 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/files/{fileId}": { |
| 322 | parameters: { |
| 323 | query?: never; |
| 324 | header?: never; |
| 325 | path?: never; |
| 326 | cookie?: never; |
| 327 | }; |
| 328 | /** Read an app-backed file document */ |
| 329 | get: operations["getAppFileDocument"]; |
| 330 | put?: never; |
| 331 | post?: never; |
| 332 | delete?: never; |
| 333 | options?: never; |
| 334 | head?: never; |
| 335 | /** Update an app-backed file document */ |
| 336 | patch: operations["updateAppFileDocument"]; |
| 337 | trace?: never; |
| 338 | }; |
| 339 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/files": { |
| 340 | parameters: { |
| 341 | query?: never; |
| 342 | header?: never; |
| 343 | path?: never; |
| 344 | cookie?: never; |
| 345 | }; |
| 346 | /** List app-backed files */ |
| 347 | get: operations["listAppFiles"]; |
| 348 | put?: never; |
| 349 | /** Create an app-backed file */ |
| 350 | post: operations["createAppFile"]; |
| 351 | delete?: never; |
| 352 | options?: never; |
| 353 | head?: never; |
| 354 | patch?: never; |
| 355 | trace?: never; |
| 356 | }; |
| 357 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/actions": { |
| 358 | parameters: { |
| 359 | query?: never; |
| 360 | header?: never; |
| 361 | path?: never; |
| 362 | cookie?: never; |
| 363 | }; |
| 364 | get?: never; |
| 365 | put?: never; |
| 366 | /** Execute a hosted app action */ |
| 367 | post: operations["executeAppAction"]; |
| 368 | delete?: never; |
| 369 | options?: never; |
| 370 | head?: never; |
| 371 | patch?: never; |
| 372 | trace?: never; |
| 373 | }; |
| 374 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/notifications": { |
| 375 | parameters: { |
| 376 | query?: never; |
| 377 | header?: never; |
| 378 | path?: never; |
| 379 | cookie?: never; |
| 380 | }; |
| 381 | get?: never; |
| 382 | put?: never; |
| 383 | /** Create an app notification */ |
| 384 | post: operations["createAppNotification"]; |
| 385 | delete?: never; |
| 386 | options?: never; |
| 387 | head?: never; |
| 388 | patch?: never; |
| 389 | trace?: never; |
| 390 | }; |
| 391 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/index-documents": { |
| 392 | parameters: { |
| 393 | query?: never; |
| 394 | header?: never; |
| 395 | path?: never; |
| 396 | cookie?: never; |
| 397 | }; |
| 398 | get?: never; |
| 399 | put?: never; |
| 400 | /** Upsert app index documents */ |
| 401 | post: operations["upsertAppIndexDocuments"]; |
| 402 | /** Delete app index documents */ |
| 403 | delete: operations["deleteAppIndexDocuments"]; |
| 404 | options?: never; |
| 405 | head?: never; |
| 406 | patch?: never; |
| 407 | trace?: never; |
| 408 | }; |
| 409 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/ambient/events": { |
| 410 | parameters: { |
| 411 | query?: never; |
| 412 | header?: never; |
| 413 | path?: never; |
| 414 | cookie?: never; |
| 415 | }; |
| 416 | get?: never; |
| 417 | put?: never; |
| 418 | /** Emit app ambient events */ |
| 419 | post: operations["emitAppAmbientEvents"]; |
| 420 | delete?: never; |
| 421 | options?: never; |
| 422 | head?: never; |
| 423 | patch?: never; |
| 424 | trace?: never; |
| 425 | }; |
| 426 | } |
| 427 | export type webhooks = Record<string, never>; |
| 428 | export interface components { |
| 429 | schemas: { |
| 430 | ErrorEnvelope: { |
| 431 | error: { |
| 432 | code: string; |
| 433 | message: string; |
| 434 | }; |
| 435 | }; |
| 436 | OAuthErrorResponse: { |
| 437 | error: string; |
| 438 | error_description: string; |
| 439 | }; |
| 440 | OAuthTokenExchangeInput: { |
| 441 | /** @constant */ |
| 442 | grant_type: "authorization_code"; |
| 443 | client_id: string; |
| 444 | client_secret: string; |
| 445 | code: string; |
| 446 | /** Format: uri */ |
| 447 | redirect_uri: string; |
| 448 | code_verifier?: string; |
| 449 | }; |
| 450 | OAuthTokenResponse: { |
| 451 | access_token: string; |
| 452 | /** @constant */ |
| 453 | token_type: "Bearer"; |
| 454 | expires_in: number; |
| 455 | refresh_token: string; |
| 456 | scope: string; |
| 457 | }; |
| 458 | OAuthUserInfoResponse: { |
| 459 | sub: string; |
| 460 | email: string; |
| 461 | email_verified: boolean; |
| 462 | name: string; |
| 463 | given_name: string | null; |
| 464 | family_name: string | null; |
| 465 | picture: string | null; |
| 466 | preferred_username: string | null; |
| 467 | scope: string; |
| 468 | }; |
| 469 | TabModelRecord: { |
| 470 | id: string; |
| 471 | /** @constant */ |
| 472 | object: "model"; |
| 473 | created: number; |
| 474 | owned_by: string; |
| 475 | providerModelId: string; |
| 476 | pricing: { |
| 477 | inputPerMillionUsd: number; |
| 478 | outputPerMillionUsd: number; |
| 479 | }; |
| 480 | capabilities: { |
| 481 | streaming: boolean; |
| 482 | surfaces: string[]; |
| 483 | }; |
| 484 | }; |
| 485 | TabModelsResponse: { |
| 486 | data: { |
| 487 | /** @constant */ |
| 488 | object: "list"; |
| 489 | data: components["schemas"]["TabModelRecord"][]; |
| 490 | }; |
| 491 | }; |
| 492 | TabChatCompletionInput: { |
| 493 | model: string; |
| 494 | messages?: { |
| 495 | role?: string; |
| 496 | content?: string; |
| 497 | }[]; |
| 498 | stream?: boolean; |
| 499 | max_tokens?: number; |
| 500 | max_completion_tokens?: number; |
| 501 | temperature?: number; |
| 502 | top_p?: number; |
| 503 | tab_context: { |
| 504 | [key: string]: unknown; |
| 505 | }; |
| 506 | }; |
| 507 | TabChatCompletionResponseEnvelope: { |
| 508 | data: { |
| 509 | id: string; |
| 510 | /** @constant */ |
| 511 | object: "chat.completion"; |
| 512 | created: number; |
| 513 | model: string; |
| 514 | choices: { |
| 515 | index: number; |
| 516 | message: { |
| 517 | /** @constant */ |
| 518 | role: "assistant"; |
| 519 | content: string; |
| 520 | }; |
| 521 | /** @constant */ |
| 522 | finish_reason: "stop"; |
| 523 | }[]; |
| 524 | usage: { |
| 525 | prompt_tokens: number; |
| 526 | completion_tokens: number; |
| 527 | total_tokens: number; |
| 528 | }; |
| 529 | }; |
| 530 | }; |
| 531 | OkResponse: { |
| 532 | data: { |
| 533 | /** @constant */ |
| 534 | ok: true; |
| 535 | }; |
| 536 | }; |
| 537 | AppCatalogItem: { |
| 538 | appId: string; |
| 539 | appKey: string; |
| 540 | name: string; |
| 541 | description: string | null; |
| 542 | iconUrl: string | null; |
| 543 | status: string; |
| 544 | latestPublishedVersion: string | null; |
| 545 | latestPublishedVersionId: string | null; |
| 546 | isInstalled: boolean; |
| 547 | }; |
| 548 | RegisteredAppDetail: { |
| 549 | appId: string; |
| 550 | appKey: string; |
| 551 | name: string; |
| 552 | description: string | null; |
| 553 | iconUrl: string | null; |
| 554 | status: string; |
| 555 | ownerUserId: string | null; |
| 556 | storeListed: boolean; |
| 557 | latestPublishedVersion: string | null; |
| 558 | latestPublishedVersionId: string | null; |
| 559 | }; |
| 560 | RegisteredAppVersionSummary: { |
| 561 | versionId: string; |
| 562 | version: string; |
| 563 | status: string; |
| 564 | reviewStatus: string; |
| 565 | apiBaseUrl: string; |
| 566 | permissions: string[]; |
| 567 | notificationChannels: { |
| 568 | key: string; |
| 569 | name: string; |
| 570 | description?: string; |
| 571 | defaultDeliveries: string[]; |
| 572 | defaultPriority: string; |
| 573 | }[]; |
| 574 | kairo: { |
| 575 | [key: string]: unknown; |
| 576 | } | null; |
| 577 | fileTypes: { |
| 578 | typeKey: string; |
| 579 | name: string; |
| 580 | description: string | null; |
| 581 | }[]; |
| 582 | /** Format: date-time */ |
| 583 | submittedAt: string | null; |
| 584 | /** Format: date-time */ |
| 585 | reviewedAt: string | null; |
| 586 | reviewNotes: string | null; |
| 587 | /** Format: date-time */ |
| 588 | publishedAt: string | null; |
| 589 | /** Format: date-time */ |
| 590 | createdAt: string; |
| 591 | /** Format: date-time */ |
| 592 | updatedAt: string; |
| 593 | }; |
| 594 | InstalledAppSummary: { |
| 595 | installId: string; |
| 596 | appId: string; |
| 597 | appKey: string; |
| 598 | name: string; |
| 599 | description: string | null; |
| 600 | iconUrl: string | null; |
| 601 | status: string; |
| 602 | installScope: string; |
| 603 | scopeSubjectId: string; |
| 604 | version: string | null; |
| 605 | }; |
| 606 | StoreAppsResponse: { |
| 607 | data: { |
| 608 | apps: components["schemas"]["RegisteredAppDetail"][]; |
| 609 | }; |
| 610 | }; |
| 611 | StoreAppResponse: { |
| 612 | data: { |
| 613 | app: components["schemas"]["RegisteredAppDetail"]; |
| 614 | }; |
| 615 | }; |
| 616 | StoreAppVersionsResponse: { |
| 617 | data: { |
| 618 | versions: components["schemas"]["RegisteredAppVersionSummary"][]; |
| 619 | }; |
| 620 | }; |
| 621 | WorkspaceAppsResponse: { |
| 622 | data: { |
| 623 | installedApps: components["schemas"]["InstalledAppSummary"][]; |
| 624 | catalog: components["schemas"]["AppCatalogItem"][]; |
| 625 | permissions: { |
| 626 | canManageApps: boolean; |
| 627 | }; |
| 628 | }; |
| 629 | }; |
| 630 | InstallWorkspaceAppInput: { |
| 631 | appId: string; |
| 632 | pinnedVersionId?: string; |
| 633 | grantedPermissions?: string[]; |
| 634 | }; |
| 635 | InstallWorkspaceAppResponse: { |
| 636 | data: { |
| 637 | installId: string; |
| 638 | appId: string; |
| 639 | appKey: string; |
| 640 | version: string; |
| 641 | grantedPermissions: string[]; |
| 642 | }; |
| 643 | }; |
| 644 | WorkspaceInstalledAppResponse: { |
| 645 | data: { |
| 646 | install: components["schemas"]["InstalledAppSummary"]; |
| 647 | permissions: { |
| 648 | canManageApps: boolean; |
| 649 | }; |
| 650 | }; |
| 651 | }; |
| 652 | WorkspaceAppPermissionsResponse: { |
| 653 | data: { |
| 654 | install: components["schemas"]["InstalledAppSummary"]; |
| 655 | availablePermissions: string[]; |
| 656 | grantedPermissions: string[]; |
| 657 | permissions: { |
| 658 | canManageApps: boolean; |
| 659 | }; |
| 660 | }; |
| 661 | }; |
| 662 | RegisterAppInput: { |
| 663 | version: string; |
| 664 | manifest: { |
| 665 | key: string; |
| 666 | name: string; |
| 667 | description?: string; |
| 668 | iconUrl?: string; |
| 669 | permissions: string[]; |
| 670 | notificationChannels: { |
| 671 | key: string; |
| 672 | name: string; |
| 673 | description?: string; |
| 674 | defaultDeliveries: string[]; |
| 675 | defaultPriority: string; |
| 676 | }[]; |
| 677 | kairo?: { |
| 678 | [key: string]: unknown; |
| 679 | }; |
| 680 | hosting: { |
| 681 | /** @constant */ |
| 682 | mode: "external"; |
| 683 | baseUrl: string; |
| 684 | }; |
| 685 | }; |
| 686 | fileTypes: { |
| 687 | typeKey: string; |
| 688 | name: string; |
| 689 | description?: string; |
| 690 | /** @constant */ |
| 691 | storage: "coline_document"; |
| 692 | indexable: boolean; |
| 693 | homeRenderMode: string; |
| 694 | }[]; |
| 695 | }; |
| 696 | AppVersionMutationResponse: { |
| 697 | data: { |
| 698 | appId: string; |
| 699 | appKey: string; |
| 700 | versionId: string; |
| 701 | version: string; |
| 702 | }; |
| 703 | }; |
| 704 | SubmitAppVersionForReviewResponse: { |
| 705 | data: { |
| 706 | appId: string; |
| 707 | appKey: string; |
| 708 | versionId: string; |
| 709 | version: string; |
| 710 | /** @constant */ |
| 711 | reviewStatus: "submitted"; |
| 712 | storeListed: boolean; |
| 713 | }; |
| 714 | }; |
| 715 | WorkspaceAppSecretsResponse: { |
| 716 | data: { |
| 717 | install: components["schemas"]["InstalledAppSummary"]; |
| 718 | secrets: { |
| 719 | id: string; |
| 720 | key: string; |
| 721 | /** Format: date-time */ |
| 722 | createdAt: string; |
| 723 | /** Format: date-time */ |
| 724 | updatedAt: string; |
| 725 | }[]; |
| 726 | permissions: { |
| 727 | canManageApps: boolean; |
| 728 | }; |
| 729 | }; |
| 730 | }; |
| 731 | CreateWorkspaceAppSecretResponse: { |
| 732 | data: { |
| 733 | secret: { |
| 734 | id: string; |
| 735 | key: string; |
| 736 | /** Format: date-time */ |
| 737 | createdAt: string; |
| 738 | /** Format: date-time */ |
| 739 | updatedAt: string; |
| 740 | }; |
| 741 | value: string; |
| 742 | }; |
| 743 | }; |
| 744 | WorkspaceAppOauthConnectionsResponse: { |
| 745 | data: { |
| 746 | install: components["schemas"]["InstalledAppSummary"]; |
| 747 | connections: { |
| 748 | id: string; |
| 749 | providerKey: string; |
| 750 | externalAccountId: string | null; |
| 751 | scopes: string[]; |
| 752 | /** Format: date-time */ |
| 753 | tokenExpiresAt: string | null; |
| 754 | /** Format: date-time */ |
| 755 | createdAt: string; |
| 756 | /** Format: date-time */ |
| 757 | updatedAt: string; |
| 758 | }[]; |
| 759 | permissions: { |
| 760 | canManageApps: boolean; |
| 761 | }; |
| 762 | }; |
| 763 | }; |
| 764 | CreateWorkspaceAppOauthConnectionResponse: { |
| 765 | data: { |
| 766 | connection: { |
| 767 | id: string; |
| 768 | providerKey: string; |
| 769 | externalAccountId: string | null; |
| 770 | scopes: string[]; |
| 771 | /** Format: date-time */ |
| 772 | tokenExpiresAt: string | null; |
| 773 | /** Format: date-time */ |
| 774 | createdAt: string; |
| 775 | /** Format: date-time */ |
| 776 | updatedAt: string; |
| 777 | }; |
| 778 | }; |
| 779 | }; |
| 780 | WorkspaceAppDeliveriesResponse: { |
| 781 | data: { |
| 782 | install: components["schemas"]["InstalledAppSummary"]; |
| 783 | deliveries: { |
| 784 | id: string; |
| 785 | eventType: string; |
| 786 | targetUrl: string; |
| 787 | status: string; |
| 788 | attemptCount: number; |
| 789 | lastStatusCode: number | null; |
| 790 | /** Format: date-time */ |
| 791 | createdAt: string; |
| 792 | /** Format: date-time */ |
| 793 | updatedAt: string; |
| 794 | }[]; |
| 795 | permissions: { |
| 796 | canManageApps: boolean; |
| 797 | }; |
| 798 | }; |
| 799 | }; |
| 800 | SendWorkspaceAppTestDeliveryResponse: { |
| 801 | data: { |
| 802 | delivery: { |
| 803 | id: string; |
| 804 | eventType: string; |
| 805 | targetUrl: string; |
| 806 | status: string; |
| 807 | attemptCount: number; |
| 808 | lastStatusCode: number | null; |
| 809 | /** Format: date-time */ |
| 810 | createdAt: string; |
| 811 | /** Format: date-time */ |
| 812 | updatedAt: string; |
| 813 | }; |
| 814 | }; |
| 815 | }; |
| 816 | AppFilesListResponse: { |
| 817 | data: { |
| 818 | files: { |
| 819 | id: string; |
| 820 | driveId: string; |
| 821 | parentId: string | null; |
| 822 | name: string; |
| 823 | fileType: string; |
| 824 | typeLabel: string; |
| 825 | appKey: string; |
| 826 | appName: string; |
| 827 | openHref: string; |
| 828 | /** Format: date-time */ |
| 829 | updatedAt: string; |
| 830 | /** Format: date-time */ |
| 831 | createdAt: string; |
| 832 | version: number; |
| 833 | capabilities: { |
| 834 | canRead: boolean; |
| 835 | canWrite: boolean; |
| 836 | canManage: boolean; |
| 837 | }; |
| 838 | }[]; |
| 839 | availableFileTypes: { |
| 840 | typeKey: string; |
| 841 | name: string; |
| 842 | description: string | null; |
| 843 | }[]; |
| 844 | }; |
| 845 | }; |
| 846 | CreateAppFileInput: { |
| 847 | name: string; |
| 848 | typeKey?: string; |
| 849 | driveId?: string; |
| 850 | parentId?: string | null; |
| 851 | document?: { |
| 852 | [key: string]: unknown; |
| 853 | }; |
| 854 | }; |
| 855 | CreateAppFileResponse: { |
| 856 | data: { |
| 857 | file: { |
| 858 | id: string; |
| 859 | driveId: string; |
| 860 | parentId: string | null; |
| 861 | name: string; |
| 862 | fileType: string; |
| 863 | typeLabel: string; |
| 864 | appKey: string; |
| 865 | appName: string; |
| 866 | openHref: string; |
| 867 | /** Format: date-time */ |
| 868 | updatedAt: string; |
| 869 | /** Format: date-time */ |
| 870 | createdAt: string; |
| 871 | version: number; |
| 872 | capabilities: { |
| 873 | canRead: boolean; |
| 874 | canWrite: boolean; |
| 875 | canManage: boolean; |
| 876 | }; |
| 877 | }; |
| 878 | document: { |
| 879 | [key: string]: unknown; |
| 880 | }; |
| 881 | version: number; |
| 882 | }; |
| 883 | }; |
| 884 | ExecuteAppActionInput: { |
| 885 | action: { |
| 886 | type: string; |
| 887 | payload?: { |
| 888 | [key: string]: unknown; |
| 889 | }; |
| 890 | }; |
| 891 | fileId?: string | null; |
| 892 | }; |
| 893 | ExecuteAppActionResponse: { |
| 894 | data: { |
| 895 | /** @enum {string} */ |
| 896 | type: "ok" | "refresh"; |
| 897 | } | { |
| 898 | /** @enum {string} */ |
| 899 | type: "navigate"; |
| 900 | href: string; |
| 901 | } | { |
| 902 | /** @enum {string} */ |
| 903 | type: "open_file"; |
| 904 | fileId: string; |
| 905 | }; |
| 906 | }; |
| 907 | AppFileDocumentResponse: { |
| 908 | data: { |
| 909 | file: { |
| 910 | id: string; |
| 911 | name: string; |
| 912 | fileType: string; |
| 913 | appKey: string; |
| 914 | appName: string; |
| 915 | typeLabel: string; |
| 916 | openHref: string; |
| 917 | /** Format: date-time */ |
| 918 | updatedAt: string; |
| 919 | }; |
| 920 | document: { |
| 921 | [key: string]: unknown; |
| 922 | }; |
| 923 | version: number; |
| 924 | capabilities: { |
| 925 | canRead: boolean; |
| 926 | canWrite: boolean; |
| 927 | canManage: boolean; |
| 928 | }; |
| 929 | }; |
| 930 | }; |
| 931 | AppFileDocumentUpdateResponse: { |
| 932 | data: { |
| 933 | document: { |
| 934 | [key: string]: unknown; |
| 935 | }; |
| 936 | version: number; |
| 937 | /** Format: date-time */ |
| 938 | updatedAt: string; |
| 939 | }; |
| 940 | }; |
| 941 | CreateAppNotificationInput: { |
| 942 | channelKey: string; |
| 943 | typeKey: string; |
| 944 | recipients: { |
| 945 | userId: string; |
| 946 | }[]; |
| 947 | title: string; |
| 948 | body?: string; |
| 949 | targetUrl?: string; |
| 950 | icon?: string; |
| 951 | priority?: string; |
| 952 | dedupeKey?: string; |
| 953 | metadata?: { |
| 954 | [key: string]: unknown; |
| 955 | }; |
| 956 | }; |
| 957 | UpsertAppIndexDocumentsInput: { |
| 958 | documents: { |
| 959 | documentKey: string; |
| 960 | documentType: string; |
| 961 | fileId?: string; |
| 962 | title: string; |
| 963 | body?: string; |
| 964 | url?: string; |
| 965 | metadata?: { |
| 966 | [key: string]: unknown; |
| 967 | }; |
| 968 | visibilityMode?: string; |
| 969 | visibility?: { |
| 970 | subjectType: string; |
| 971 | subjectId: string; |
| 972 | }[]; |
| 973 | }[]; |
| 974 | }; |
| 975 | UpsertAppIndexDocumentsResponse: { |
| 976 | data: { |
| 977 | documents: { |
| 978 | id: string; |
| 979 | documentKey: string; |
| 980 | visibilityMode: string; |
| 981 | }[]; |
| 982 | }; |
| 983 | }; |
| 984 | DeleteAppIndexDocumentsInput: { |
| 985 | documentKeys: string[]; |
| 986 | }; |
| 987 | DeleteAppIndexDocumentsResponse: { |
| 988 | data: { |
| 989 | deleted: { |
| 990 | id: string; |
| 991 | documentKey: string; |
| 992 | }[]; |
| 993 | }; |
| 994 | }; |
| 995 | EmitAppAmbientEventsInput: { |
| 996 | events: { |
| 997 | sourceKind: string; |
| 998 | action: string; |
| 999 | entityType: string; |
| 1000 | entityId: string; |
| 1001 | actorUserId?: string; |
| 1002 | containerType?: string; |
| 1003 | containerId?: string; |
| 1004 | /** Format: date-time */ |
| 1005 | occurredAt?: string; |
| 1006 | dedupeKey: string; |
| 1007 | payload?: { |
| 1008 | [key: string]: unknown; |
| 1009 | }; |
| 1010 | metadata?: { |
| 1011 | [key: string]: unknown; |
| 1012 | }; |
| 1013 | schemaVersion?: number; |
| 1014 | }[]; |
| 1015 | }; |
| 1016 | EmitAppAmbientEventsResponse: { |
| 1017 | data: { |
| 1018 | events: { |
| 1019 | id: string; |
| 1020 | dedupeKey: string; |
| 1021 | }[]; |
| 1022 | }; |
| 1023 | }; |
| 1024 | }; |
| 1025 | responses: never; |
| 1026 | parameters: never; |
| 1027 | requestBodies: never; |
| 1028 | headers: never; |
| 1029 | pathItems: never; |
| 1030 | } |
| 1031 | export type $defs = Record<string, never>; |
| 1032 | export interface operations { |
| 1033 | listTabModels: { |
| 1034 | parameters: { |
| 1035 | query?: never; |
| 1036 | header?: never; |
| 1037 | path?: never; |
| 1038 | cookie?: never; |
| 1039 | }; |
| 1040 | requestBody?: never; |
| 1041 | responses: { |
| 1042 | /** @description Tab model list */ |
| 1043 | 200: { |
| 1044 | headers: { |
| 1045 | [name: string]: unknown; |
| 1046 | }; |
| 1047 | content: { |
| 1048 | "application/json": components["schemas"]["TabModelsResponse"]; |
| 1049 | }; |
| 1050 | }; |
| 1051 | }; |
| 1052 | }; |
| 1053 | createTabChatCompletion: { |
| 1054 | parameters: { |
| 1055 | query?: never; |
| 1056 | header?: never; |
| 1057 | path?: never; |
| 1058 | cookie?: never; |
| 1059 | }; |
| 1060 | requestBody: { |
| 1061 | content: { |
| 1062 | "application/json": components["schemas"]["TabChatCompletionInput"]; |
| 1063 | }; |
| 1064 | }; |
| 1065 | responses: { |
| 1066 | /** @description OpenAI-compatible Tab chat completion */ |
| 1067 | 200: { |
| 1068 | headers: { |
| 1069 | [name: string]: unknown; |
| 1070 | }; |
| 1071 | content: { |
| 1072 | "application/json": components["schemas"]["TabChatCompletionResponseEnvelope"]; |
| 1073 | }; |
| 1074 | }; |
| 1075 | /** @description Validation or model error */ |
| 1076 | 400: { |
| 1077 | headers: { |
| 1078 | [name: string]: unknown; |
| 1079 | }; |
| 1080 | content: { |
| 1081 | "application/json": components["schemas"]["ErrorEnvelope"]; |
| 1082 | }; |
| 1083 | }; |
| 1084 | /** @description Insufficient credits */ |
| 1085 | 402: { |
| 1086 | headers: { |
| 1087 | [name: string]: unknown; |
| 1088 | }; |
| 1089 | content: { |
| 1090 | "application/json": components["schemas"]["ErrorEnvelope"]; |
| 1091 | }; |
| 1092 | }; |
| 1093 | }; |
| 1094 | }; |
| 1095 | authorizeOauthClient: { |
| 1096 | parameters: { |
| 1097 | query: { |
| 1098 | response_type: "code"; |
| 1099 | client_id: string; |
| 1100 | redirect_uri: string; |
| 1101 | scope?: string; |
| 1102 | state?: string; |
| 1103 | code_challenge?: string; |
| 1104 | code_challenge_method?: string; |
| 1105 | }; |
| 1106 | header?: never; |
| 1107 | path?: never; |
| 1108 | cookie?: never; |
| 1109 | }; |
| 1110 | requestBody?: never; |
| 1111 | responses: { |
| 1112 | /** @description Redirect to sign-in or back to the client redirect URI */ |
| 1113 | 302: { |
| 1114 | headers: { |
| 1115 | [name: string]: unknown; |
| 1116 | }; |
| 1117 | content?: never; |
| 1118 | }; |
| 1119 | /** @description Invalid authorization request */ |
| 1120 | 400: { |
| 1121 | headers: { |
| 1122 | [name: string]: unknown; |
| 1123 | }; |
| 1124 | content: { |
| 1125 | "application/json": components["schemas"]["ErrorEnvelope"]; |
| 1126 | }; |
| 1127 | }; |
| 1128 | }; |
| 1129 | }; |
| 1130 | exchangeOauthAuthorizationCode: { |
| 1131 | parameters: { |
| 1132 | query?: never; |
| 1133 | header?: never; |
| 1134 | path?: never; |
| 1135 | cookie?: never; |
| 1136 | }; |
| 1137 | requestBody: { |
| 1138 | content: { |
| 1139 | "application/json": components["schemas"]["OAuthTokenExchangeInput"]; |
| 1140 | "application/x-www-form-urlencoded": components["schemas"]["OAuthTokenExchangeInput"]; |
| 1141 | }; |
| 1142 | }; |
| 1143 | responses: { |
| 1144 | /** @description Token response */ |
| 1145 | 200: { |
| 1146 | headers: { |
| 1147 | [name: string]: unknown; |
| 1148 | }; |
| 1149 | content: { |
| 1150 | "application/json": components["schemas"]["OAuthTokenResponse"]; |
| 1151 | }; |
| 1152 | }; |
| 1153 | /** @description Invalid token request */ |
| 1154 | 400: { |
| 1155 | headers: { |
| 1156 | [name: string]: unknown; |
| 1157 | }; |
| 1158 | content: { |
| 1159 | "application/json": components["schemas"]["OAuthErrorResponse"]; |
| 1160 | }; |
| 1161 | }; |
| 1162 | }; |
| 1163 | }; |
| 1164 | getOauthUserInfo: { |
| 1165 | parameters: { |
| 1166 | query?: never; |
| 1167 | header?: never; |
| 1168 | path?: never; |
| 1169 | cookie?: never; |
| 1170 | }; |
| 1171 | requestBody?: never; |
| 1172 | responses: { |
| 1173 | /** @description User info */ |
| 1174 | 200: { |
| 1175 | headers: { |
| 1176 | [name: string]: unknown; |
| 1177 | }; |
| 1178 | content: { |
| 1179 | "application/json": components["schemas"]["OAuthUserInfoResponse"]; |
| 1180 | }; |
| 1181 | }; |
| 1182 | /** @description Invalid token */ |
| 1183 | 401: { |
| 1184 | headers: { |
| 1185 | [name: string]: unknown; |
| 1186 | }; |
| 1187 | content: { |
| 1188 | "application/json": components["schemas"]["OAuthErrorResponse"]; |
| 1189 | }; |
| 1190 | }; |
| 1191 | }; |
| 1192 | }; |
| 1193 | listStoreApps: { |
| 1194 | parameters: { |
| 1195 | query?: never; |
| 1196 | header?: never; |
| 1197 | path?: never; |
| 1198 | cookie?: never; |
| 1199 | }; |
| 1200 | requestBody?: never; |
| 1201 | responses: { |
| 1202 | /** @description Store apps */ |
| 1203 | 200: { |
| 1204 | headers: { |
| 1205 | [name: string]: unknown; |
| 1206 | }; |
| 1207 | content: { |
| 1208 | "application/json": components["schemas"]["StoreAppsResponse"]; |
| 1209 | }; |
| 1210 | }; |
| 1211 | }; |
| 1212 | }; |
| 1213 | registerApp: { |
| 1214 | parameters: { |
| 1215 | query?: never; |
| 1216 | header?: never; |
| 1217 | path?: never; |
| 1218 | cookie?: never; |
| 1219 | }; |
| 1220 | requestBody: { |
| 1221 | content: { |
| 1222 | "application/json": components["schemas"]["RegisterAppInput"]; |
| 1223 | }; |
| 1224 | }; |
| 1225 | responses: { |
| 1226 | /** @description Registered app */ |
| 1227 | 201: { |
| 1228 | headers: { |
| 1229 | [name: string]: unknown; |
| 1230 | }; |
| 1231 | content: { |
| 1232 | "application/json": components["schemas"]["AppVersionMutationResponse"]; |
| 1233 | }; |
| 1234 | }; |
| 1235 | }; |
| 1236 | }; |
| 1237 | getStoreApp: { |
| 1238 | parameters: { |
| 1239 | query?: never; |
| 1240 | header?: never; |
| 1241 | path: { |
| 1242 | appKey: string; |
| 1243 | }; |
| 1244 | cookie?: never; |
| 1245 | }; |
| 1246 | requestBody?: never; |
| 1247 | responses: { |
| 1248 | /** @description Store app detail */ |
| 1249 | 200: { |
| 1250 | headers: { |
| 1251 | [name: string]: unknown; |
| 1252 | }; |
| 1253 | content: { |
| 1254 | "application/json": components["schemas"]["StoreAppResponse"]; |
| 1255 | }; |
| 1256 | }; |
| 1257 | /** @description App not found */ |
| 1258 | 404: { |
| 1259 | headers: { |
| 1260 | [name: string]: unknown; |
| 1261 | }; |
| 1262 | content: { |
| 1263 | "application/json": components["schemas"]["ErrorEnvelope"]; |
| 1264 | }; |
| 1265 | }; |
| 1266 | }; |
| 1267 | }; |
| 1268 | listStoreAppVersions: { |
| 1269 | parameters: { |
| 1270 | query?: never; |
| 1271 | header?: never; |
| 1272 | path: { |
| 1273 | appKey: string; |
| 1274 | }; |
| 1275 | cookie?: never; |
| 1276 | }; |
| 1277 | requestBody?: never; |
| 1278 | responses: { |
| 1279 | /** @description Approved store app versions */ |
| 1280 | 200: { |
| 1281 | headers: { |
| 1282 | [name: string]: unknown; |
| 1283 | }; |
| 1284 | content: { |
| 1285 | "application/json": components["schemas"]["StoreAppVersionsResponse"]; |
| 1286 | }; |
| 1287 | }; |
| 1288 | }; |
| 1289 | }; |
| 1290 | createAppVersion: { |
| 1291 | parameters: { |
| 1292 | query?: never; |
| 1293 | header?: never; |
| 1294 | path: { |
| 1295 | appKey: string; |
| 1296 | }; |
| 1297 | cookie?: never; |
| 1298 | }; |
| 1299 | requestBody: { |
| 1300 | content: { |
| 1301 | "application/json": components["schemas"]["RegisterAppInput"]; |
| 1302 | }; |
| 1303 | }; |
| 1304 | responses: { |
| 1305 | /** @description Created app version */ |
| 1306 | 201: { |
| 1307 | headers: { |
| 1308 | [name: string]: unknown; |
| 1309 | }; |
| 1310 | content: { |
| 1311 | "application/json": components["schemas"]["AppVersionMutationResponse"]; |
| 1312 | }; |
| 1313 | }; |
| 1314 | }; |
| 1315 | }; |
| 1316 | submitAppVersionForReview: { |
| 1317 | parameters: { |
| 1318 | query?: never; |
| 1319 | header?: never; |
| 1320 | path: { |
| 1321 | appKey: string; |
| 1322 | versionId: string; |
| 1323 | }; |
| 1324 | cookie?: never; |
| 1325 | }; |
| 1326 | requestBody: { |
| 1327 | content: { |
| 1328 | "application/json": { |
| 1329 | storeListed?: boolean; |
| 1330 | }; |
| 1331 | }; |
| 1332 | }; |
| 1333 | responses: { |
| 1334 | /** @description Submitted app version */ |
| 1335 | 200: { |
| 1336 | headers: { |
| 1337 | [name: string]: unknown; |
| 1338 | }; |
| 1339 | content: { |
| 1340 | "application/json": components["schemas"]["SubmitAppVersionForReviewResponse"]; |
| 1341 | }; |
| 1342 | }; |
| 1343 | }; |
| 1344 | }; |
| 1345 | listWorkspaceApps: { |
| 1346 | parameters: { |
| 1347 | query?: never; |
| 1348 | header?: never; |
| 1349 | path: { |
| 1350 | workspaceSlug: string; |
| 1351 | }; |
| 1352 | cookie?: never; |
| 1353 | }; |
| 1354 | requestBody?: never; |
| 1355 | responses: { |
| 1356 | /** @description Workspace app data */ |
| 1357 | 200: { |
| 1358 | headers: { |
| 1359 | [name: string]: unknown; |
| 1360 | }; |
| 1361 | content: { |
| 1362 | "application/json": components["schemas"]["WorkspaceAppsResponse"]; |
| 1363 | }; |
| 1364 | }; |
| 1365 | }; |
| 1366 | }; |
| 1367 | installWorkspaceApp: { |
| 1368 | parameters: { |
| 1369 | query?: never; |
| 1370 | header?: never; |
| 1371 | path: { |
| 1372 | workspaceSlug: string; |
| 1373 | }; |
| 1374 | cookie?: never; |
| 1375 | }; |
| 1376 | requestBody: { |
| 1377 | content: { |
| 1378 | "application/json": components["schemas"]["InstallWorkspaceAppInput"]; |
| 1379 | }; |
| 1380 | }; |
| 1381 | responses: { |
| 1382 | /** @description Installed app */ |
| 1383 | 201: { |
| 1384 | headers: { |
| 1385 | [name: string]: unknown; |
| 1386 | }; |
| 1387 | content: { |
| 1388 | "application/json": components["schemas"]["InstallWorkspaceAppResponse"]; |
| 1389 | }; |
| 1390 | }; |
| 1391 | }; |
| 1392 | }; |
| 1393 | getWorkspaceInstalledApp: { |
| 1394 | parameters: { |
| 1395 | query?: never; |
| 1396 | header?: never; |
| 1397 | path: { |
| 1398 | workspaceSlug: string; |
| 1399 | appKey: string; |
| 1400 | }; |
| 1401 | cookie?: never; |
| 1402 | }; |
| 1403 | requestBody?: never; |
| 1404 | responses: { |
| 1405 | /** @description Installed app */ |
| 1406 | 200: { |
| 1407 | headers: { |
| 1408 | [name: string]: unknown; |
| 1409 | }; |
| 1410 | content: { |
| 1411 | "application/json": components["schemas"]["WorkspaceInstalledAppResponse"]; |
| 1412 | }; |
| 1413 | }; |
| 1414 | }; |
| 1415 | }; |
| 1416 | uninstallWorkspaceApp: { |
| 1417 | parameters: { |
| 1418 | query?: never; |
| 1419 | header?: never; |
| 1420 | path: { |
| 1421 | workspaceSlug: string; |
| 1422 | appKey: string; |
| 1423 | }; |
| 1424 | cookie?: never; |
| 1425 | }; |
| 1426 | requestBody?: never; |
| 1427 | responses: { |
| 1428 | /** @description App uninstalled */ |
| 1429 | 200: { |
| 1430 | headers: { |
| 1431 | [name: string]: unknown; |
| 1432 | }; |
| 1433 | content: { |
| 1434 | "application/json": components["schemas"]["OkResponse"]; |
| 1435 | }; |
| 1436 | }; |
| 1437 | }; |
| 1438 | }; |
| 1439 | getWorkspaceAppPermissions: { |
| 1440 | parameters: { |
| 1441 | query?: never; |
| 1442 | header?: never; |
| 1443 | path: { |
| 1444 | workspaceSlug: string; |
| 1445 | appKey: string; |
| 1446 | }; |
| 1447 | cookie?: never; |
| 1448 | }; |
| 1449 | requestBody?: never; |
| 1450 | responses: { |
| 1451 | /** @description Workspace app permissions */ |
| 1452 | 200: { |
| 1453 | headers: { |
| 1454 | [name: string]: unknown; |
| 1455 | }; |
| 1456 | content: { |
| 1457 | "application/json": components["schemas"]["WorkspaceAppPermissionsResponse"]; |
| 1458 | }; |
| 1459 | }; |
| 1460 | }; |
| 1461 | }; |
| 1462 | updateWorkspaceAppPermissions: { |
| 1463 | parameters: { |
| 1464 | query?: never; |
| 1465 | header?: never; |
| 1466 | path: { |
| 1467 | workspaceSlug: string; |
| 1468 | appKey: string; |
| 1469 | }; |
| 1470 | cookie?: never; |
| 1471 | }; |
| 1472 | requestBody: { |
| 1473 | content: { |
| 1474 | "application/json": { |
| 1475 | grantedPermissions: string[]; |
| 1476 | }; |
| 1477 | }; |
| 1478 | }; |
| 1479 | responses: { |
| 1480 | /** @description Updated permissions */ |
| 1481 | 200: { |
| 1482 | headers: { |
| 1483 | [name: string]: unknown; |
| 1484 | }; |
| 1485 | content: { |
| 1486 | "application/json": components["schemas"]["WorkspaceAppPermissionsResponse"]; |
| 1487 | }; |
| 1488 | }; |
| 1489 | }; |
| 1490 | }; |
| 1491 | listWorkspaceAppSecrets: { |
| 1492 | parameters: { |
| 1493 | query?: never; |
| 1494 | header?: never; |
| 1495 | path: { |
| 1496 | workspaceSlug: string; |
| 1497 | appKey: string; |
| 1498 | }; |
| 1499 | cookie?: never; |
| 1500 | }; |
| 1501 | requestBody?: never; |
| 1502 | responses: { |
| 1503 | /** @description App secrets */ |
| 1504 | 200: { |
| 1505 | headers: { |
| 1506 | [name: string]: unknown; |
| 1507 | }; |
| 1508 | content: { |
| 1509 | "application/json": components["schemas"]["WorkspaceAppSecretsResponse"]; |
| 1510 | }; |
| 1511 | }; |
| 1512 | }; |
| 1513 | }; |
| 1514 | createWorkspaceAppSecret: { |
| 1515 | parameters: { |
| 1516 | query?: never; |
| 1517 | header?: never; |
| 1518 | path: { |
| 1519 | workspaceSlug: string; |
| 1520 | appKey: string; |
| 1521 | }; |
| 1522 | cookie?: never; |
| 1523 | }; |
| 1524 | requestBody: { |
| 1525 | content: { |
| 1526 | "application/json": { |
| 1527 | key: string; |
| 1528 | value: string; |
| 1529 | }; |
| 1530 | }; |
| 1531 | }; |
| 1532 | responses: { |
| 1533 | /** @description App secret stored */ |
| 1534 | 201: { |
| 1535 | headers: { |
| 1536 | [name: string]: unknown; |
| 1537 | }; |
| 1538 | content: { |
| 1539 | "application/json": components["schemas"]["CreateWorkspaceAppSecretResponse"]; |
| 1540 | }; |
| 1541 | }; |
| 1542 | }; |
| 1543 | }; |
| 1544 | deleteWorkspaceAppSecret: { |
| 1545 | parameters: { |
| 1546 | query?: never; |
| 1547 | header?: never; |
| 1548 | path: { |
| 1549 | workspaceSlug: string; |
| 1550 | appKey: string; |
| 1551 | secretId: string; |
| 1552 | }; |
| 1553 | cookie?: never; |
| 1554 | }; |
| 1555 | requestBody?: never; |
| 1556 | responses: { |
| 1557 | /** @description App secret deleted */ |
| 1558 | 200: { |
| 1559 | headers: { |
| 1560 | [name: string]: unknown; |
| 1561 | }; |
| 1562 | content: { |
| 1563 | "application/json": components["schemas"]["OkResponse"]; |
| 1564 | }; |
| 1565 | }; |
| 1566 | }; |
| 1567 | }; |
| 1568 | listWorkspaceAppOauthConnections: { |
| 1569 | parameters: { |
| 1570 | query?: never; |
| 1571 | header?: never; |
| 1572 | path: { |
| 1573 | workspaceSlug: string; |
| 1574 | appKey: string; |
| 1575 | }; |
| 1576 | cookie?: never; |
| 1577 | }; |
| 1578 | requestBody?: never; |
| 1579 | responses: { |
| 1580 | /** @description App OAuth connections */ |
| 1581 | 200: { |
| 1582 | headers: { |
| 1583 | [name: string]: unknown; |
| 1584 | }; |
| 1585 | content: { |
| 1586 | "application/json": components["schemas"]["WorkspaceAppOauthConnectionsResponse"]; |
| 1587 | }; |
| 1588 | }; |
| 1589 | }; |
| 1590 | }; |
| 1591 | createWorkspaceAppOauthConnection: { |
| 1592 | parameters: { |
| 1593 | query?: never; |
| 1594 | header?: never; |
| 1595 | path: { |
| 1596 | workspaceSlug: string; |
| 1597 | appKey: string; |
| 1598 | }; |
| 1599 | cookie?: never; |
| 1600 | }; |
| 1601 | requestBody: { |
| 1602 | content: { |
| 1603 | "application/json": { |
| 1604 | providerKey: string; |
| 1605 | externalAccountId?: string; |
| 1606 | accessToken: string; |
| 1607 | refreshToken?: string; |
| 1608 | scopes: string[]; |
| 1609 | /** Format: date-time */ |
| 1610 | tokenExpiresAt?: string; |
| 1611 | metadata?: { |
| 1612 | [key: string]: unknown; |
| 1613 | }; |
| 1614 | }; |
| 1615 | }; |
| 1616 | }; |
| 1617 | responses: { |
| 1618 | /** @description App OAuth connection stored */ |
| 1619 | 201: { |
| 1620 | headers: { |
| 1621 | [name: string]: unknown; |
| 1622 | }; |
| 1623 | content: { |
| 1624 | "application/json": components["schemas"]["CreateWorkspaceAppOauthConnectionResponse"]; |
| 1625 | }; |
| 1626 | }; |
| 1627 | }; |
| 1628 | }; |
| 1629 | deleteWorkspaceAppOauthConnection: { |
| 1630 | parameters: { |
| 1631 | query?: never; |
| 1632 | header?: never; |
| 1633 | path: { |
| 1634 | workspaceSlug: string; |
| 1635 | appKey: string; |
| 1636 | connectionId: string; |
| 1637 | }; |
| 1638 | cookie?: never; |
| 1639 | }; |
| 1640 | requestBody?: never; |
| 1641 | responses: { |
| 1642 | /** @description App OAuth connection deleted */ |
| 1643 | 200: { |
| 1644 | headers: { |
| 1645 | [name: string]: unknown; |
| 1646 | }; |
| 1647 | content: { |
| 1648 | "application/json": components["schemas"]["OkResponse"]; |
| 1649 | }; |
| 1650 | }; |
| 1651 | }; |
| 1652 | }; |
| 1653 | listWorkspaceAppDeliveries: { |
| 1654 | parameters: { |
| 1655 | query?: never; |
| 1656 | header?: never; |
| 1657 | path: { |
| 1658 | workspaceSlug: string; |
| 1659 | appKey: string; |
| 1660 | }; |
| 1661 | cookie?: never; |
| 1662 | }; |
| 1663 | requestBody?: never; |
| 1664 | responses: { |
| 1665 | /** @description App deliveries */ |
| 1666 | 200: { |
| 1667 | headers: { |
| 1668 | [name: string]: unknown; |
| 1669 | }; |
| 1670 | content: { |
| 1671 | "application/json": components["schemas"]["WorkspaceAppDeliveriesResponse"]; |
| 1672 | }; |
| 1673 | }; |
| 1674 | }; |
| 1675 | }; |
| 1676 | sendWorkspaceAppTestDelivery: { |
| 1677 | parameters: { |
| 1678 | query?: never; |
| 1679 | header?: never; |
| 1680 | path: { |
| 1681 | workspaceSlug: string; |
| 1682 | appKey: string; |
| 1683 | }; |
| 1684 | cookie?: never; |
| 1685 | }; |
| 1686 | requestBody: { |
| 1687 | content: { |
| 1688 | "application/json": { |
| 1689 | eventType: string; |
| 1690 | targetUrl?: string; |
| 1691 | payload: { |
| 1692 | [key: string]: unknown; |
| 1693 | }; |
| 1694 | }; |
| 1695 | }; |
| 1696 | }; |
| 1697 | responses: { |
| 1698 | /** @description Test delivery recorded */ |
| 1699 | 201: { |
| 1700 | headers: { |
| 1701 | [name: string]: unknown; |
| 1702 | }; |
| 1703 | content: { |
| 1704 | "application/json": components["schemas"]["SendWorkspaceAppTestDeliveryResponse"]; |
| 1705 | }; |
| 1706 | }; |
| 1707 | }; |
| 1708 | }; |
| 1709 | replayWorkspaceAppDelivery: { |
| 1710 | parameters: { |
| 1711 | query?: never; |
| 1712 | header?: never; |
| 1713 | path: { |
| 1714 | workspaceSlug: string; |
| 1715 | appKey: string; |
| 1716 | deliveryId: string; |
| 1717 | }; |
| 1718 | cookie?: never; |
| 1719 | }; |
| 1720 | requestBody?: never; |
| 1721 | responses: { |
| 1722 | /** @description Delivery replayed */ |
| 1723 | 200: { |
| 1724 | headers: { |
| 1725 | [name: string]: unknown; |
| 1726 | }; |
| 1727 | content: { |
| 1728 | "application/json": components["schemas"]["SendWorkspaceAppTestDeliveryResponse"]; |
| 1729 | }; |
| 1730 | }; |
| 1731 | }; |
| 1732 | }; |
| 1733 | getAppFileDocument: { |
| 1734 | parameters: { |
| 1735 | query?: never; |
| 1736 | header?: never; |
| 1737 | path: { |
| 1738 | workspaceSlug: string; |
| 1739 | appKey: string; |
| 1740 | fileId: string; |
| 1741 | }; |
| 1742 | cookie?: never; |
| 1743 | }; |
| 1744 | requestBody?: never; |
| 1745 | responses: { |
| 1746 | /** @description App-backed file document */ |
| 1747 | 200: { |
| 1748 | headers: { |
| 1749 | [name: string]: unknown; |
| 1750 | }; |
| 1751 | content: { |
| 1752 | "application/json": components["schemas"]["AppFileDocumentResponse"]; |
| 1753 | }; |
| 1754 | }; |
| 1755 | }; |
| 1756 | }; |
| 1757 | updateAppFileDocument: { |
| 1758 | parameters: { |
| 1759 | query?: never; |
| 1760 | header?: never; |
| 1761 | path: { |
| 1762 | workspaceSlug: string; |
| 1763 | appKey: string; |
| 1764 | fileId: string; |
| 1765 | }; |
| 1766 | cookie?: never; |
| 1767 | }; |
| 1768 | requestBody: { |
| 1769 | content: { |
| 1770 | "application/json": { |
| 1771 | document: { |
| 1772 | [key: string]: unknown; |
| 1773 | }; |
| 1774 | }; |
| 1775 | }; |
| 1776 | }; |
| 1777 | responses: { |
| 1778 | /** @description Updated app-backed file document */ |
| 1779 | 200: { |
| 1780 | headers: { |
| 1781 | [name: string]: unknown; |
| 1782 | }; |
| 1783 | content: { |
| 1784 | "application/json": components["schemas"]["AppFileDocumentUpdateResponse"]; |
| 1785 | }; |
| 1786 | }; |
| 1787 | }; |
| 1788 | }; |
| 1789 | listAppFiles: { |
| 1790 | parameters: { |
| 1791 | query?: { |
| 1792 | driveId?: string; |
| 1793 | typeKey?: string; |
| 1794 | limit?: number; |
| 1795 | }; |
| 1796 | header?: never; |
| 1797 | path: { |
| 1798 | workspaceSlug: string; |
| 1799 | appKey: string; |
| 1800 | }; |
| 1801 | cookie?: never; |
| 1802 | }; |
| 1803 | requestBody?: never; |
| 1804 | responses: { |
| 1805 | /** @description App-backed file list */ |
| 1806 | 200: { |
| 1807 | headers: { |
| 1808 | [name: string]: unknown; |
| 1809 | }; |
| 1810 | content: { |
| 1811 | "application/json": components["schemas"]["AppFilesListResponse"]; |
| 1812 | }; |
| 1813 | }; |
| 1814 | }; |
| 1815 | }; |
| 1816 | createAppFile: { |
| 1817 | parameters: { |
| 1818 | query?: never; |
| 1819 | header?: never; |
| 1820 | path: { |
| 1821 | workspaceSlug: string; |
| 1822 | appKey: string; |
| 1823 | }; |
| 1824 | cookie?: never; |
| 1825 | }; |
| 1826 | requestBody: { |
| 1827 | content: { |
| 1828 | "application/json": components["schemas"]["CreateAppFileInput"]; |
| 1829 | }; |
| 1830 | }; |
| 1831 | responses: { |
| 1832 | /** @description Created app-backed file */ |
| 1833 | 201: { |
| 1834 | headers: { |
| 1835 | [name: string]: unknown; |
| 1836 | }; |
| 1837 | content: { |
| 1838 | "application/json": components["schemas"]["CreateAppFileResponse"]; |
| 1839 | }; |
| 1840 | }; |
| 1841 | }; |
| 1842 | }; |
| 1843 | executeAppAction: { |
| 1844 | parameters: { |
| 1845 | query?: never; |
| 1846 | header?: never; |
| 1847 | path: { |
| 1848 | workspaceSlug: string; |
| 1849 | appKey: string; |
| 1850 | }; |
| 1851 | cookie?: never; |
| 1852 | }; |
| 1853 | requestBody: { |
| 1854 | content: { |
| 1855 | "application/json": components["schemas"]["ExecuteAppActionInput"]; |
| 1856 | }; |
| 1857 | }; |
| 1858 | responses: { |
| 1859 | /** @description Hosted app action result */ |
| 1860 | 200: { |
| 1861 | headers: { |
| 1862 | [name: string]: unknown; |
| 1863 | }; |
| 1864 | content: { |
| 1865 | "application/json": components["schemas"]["ExecuteAppActionResponse"]; |
| 1866 | }; |
| 1867 | }; |
| 1868 | }; |
| 1869 | }; |
| 1870 | createAppNotification: { |
| 1871 | parameters: { |
| 1872 | query?: never; |
| 1873 | header?: never; |
| 1874 | path: { |
| 1875 | workspaceSlug: string; |
| 1876 | appKey: string; |
| 1877 | }; |
| 1878 | cookie?: never; |
| 1879 | }; |
| 1880 | requestBody: { |
| 1881 | content: { |
| 1882 | "application/json": components["schemas"]["CreateAppNotificationInput"]; |
| 1883 | }; |
| 1884 | }; |
| 1885 | responses: { |
| 1886 | /** @description Notification created */ |
| 1887 | 201: { |
| 1888 | headers: { |
| 1889 | [name: string]: unknown; |
| 1890 | }; |
| 1891 | content: { |
| 1892 | "application/json": components["schemas"]["OkResponse"]; |
| 1893 | }; |
| 1894 | }; |
| 1895 | }; |
| 1896 | }; |
| 1897 | upsertAppIndexDocuments: { |
| 1898 | parameters: { |
| 1899 | query?: never; |
| 1900 | header?: never; |
| 1901 | path: { |
| 1902 | workspaceSlug: string; |
| 1903 | appKey: string; |
| 1904 | }; |
| 1905 | cookie?: never; |
| 1906 | }; |
| 1907 | requestBody: { |
| 1908 | content: { |
| 1909 | "application/json": components["schemas"]["UpsertAppIndexDocumentsInput"]; |
| 1910 | }; |
| 1911 | }; |
| 1912 | responses: { |
| 1913 | /** @description Index documents upserted */ |
| 1914 | 201: { |
| 1915 | headers: { |
| 1916 | [name: string]: unknown; |
| 1917 | }; |
| 1918 | content: { |
| 1919 | "application/json": components["schemas"]["UpsertAppIndexDocumentsResponse"]; |
| 1920 | }; |
| 1921 | }; |
| 1922 | }; |
| 1923 | }; |
| 1924 | deleteAppIndexDocuments: { |
| 1925 | parameters: { |
| 1926 | query?: never; |
| 1927 | header?: never; |
| 1928 | path: { |
| 1929 | workspaceSlug: string; |
| 1930 | appKey: string; |
| 1931 | }; |
| 1932 | cookie?: never; |
| 1933 | }; |
| 1934 | requestBody: { |
| 1935 | content: { |
| 1936 | "application/json": components["schemas"]["DeleteAppIndexDocumentsInput"]; |
| 1937 | }; |
| 1938 | }; |
| 1939 | responses: { |
| 1940 | /** @description Index documents deleted */ |
| 1941 | 200: { |
| 1942 | headers: { |
| 1943 | [name: string]: unknown; |
| 1944 | }; |
| 1945 | content: { |
| 1946 | "application/json": components["schemas"]["DeleteAppIndexDocumentsResponse"]; |
| 1947 | }; |
| 1948 | }; |
| 1949 | }; |
| 1950 | }; |
| 1951 | emitAppAmbientEvents: { |
| 1952 | parameters: { |
| 1953 | query?: never; |
| 1954 | header?: never; |
| 1955 | path: { |
| 1956 | workspaceSlug: string; |
| 1957 | appKey: string; |
| 1958 | }; |
| 1959 | cookie?: never; |
| 1960 | }; |
| 1961 | requestBody: { |
| 1962 | content: { |
| 1963 | "application/json": components["schemas"]["EmitAppAmbientEventsInput"]; |
| 1964 | }; |
| 1965 | }; |
| 1966 | responses: { |
| 1967 | /** @description Ambient events accepted */ |
| 1968 | 201: { |
| 1969 | headers: { |
| 1970 | [name: string]: unknown; |
| 1971 | }; |
| 1972 | content: { |
| 1973 | "application/json": components["schemas"]["EmitAppAmbientEventsResponse"]; |
| 1974 | }; |
| 1975 | }; |
| 1976 | }; |
| 1977 | }; |
| 1978 | } |
| 1979 |