1432 lines · 41 KBtext/plain; charset=utf-8
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/apps": { |
| 8 | parameters: { |
| 9 | query?: never; |
| 10 | header?: never; |
| 11 | path?: never; |
| 12 | cookie?: never; |
| 13 | }; |
| 14 | /** List store apps */ |
| 15 | get: operations["listStoreApps"]; |
| 16 | put?: never; |
| 17 | /** Register a new app and initial release */ |
| 18 | post: operations["registerApp"]; |
| 19 | delete?: never; |
| 20 | options?: never; |
| 21 | head?: never; |
| 22 | patch?: never; |
| 23 | trace?: never; |
| 24 | }; |
| 25 | "/api/v1/apps/{appKey}": { |
| 26 | parameters: { |
| 27 | query?: never; |
| 28 | header?: never; |
| 29 | path?: never; |
| 30 | cookie?: never; |
| 31 | }; |
| 32 | /** Get a store app */ |
| 33 | get: operations["getStoreApp"]; |
| 34 | put?: never; |
| 35 | post?: never; |
| 36 | delete?: never; |
| 37 | options?: never; |
| 38 | head?: never; |
| 39 | patch?: never; |
| 40 | trace?: never; |
| 41 | }; |
| 42 | "/api/v1/apps/{appKey}/versions": { |
| 43 | parameters: { |
| 44 | query?: never; |
| 45 | header?: never; |
| 46 | path?: never; |
| 47 | cookie?: never; |
| 48 | }; |
| 49 | /** List approved versions for a store app */ |
| 50 | get: operations["listStoreAppVersions"]; |
| 51 | put?: never; |
| 52 | /** Create a new app version */ |
| 53 | post: operations["createAppVersion"]; |
| 54 | delete?: never; |
| 55 | options?: never; |
| 56 | head?: never; |
| 57 | patch?: never; |
| 58 | trace?: never; |
| 59 | }; |
| 60 | "/api/v1/apps/{appKey}/versions/{versionId}/submit": { |
| 61 | parameters: { |
| 62 | query?: never; |
| 63 | header?: never; |
| 64 | path?: never; |
| 65 | cookie?: never; |
| 66 | }; |
| 67 | get?: never; |
| 68 | put?: never; |
| 69 | /** Submit an app version for review */ |
| 70 | post: operations["submitAppVersionForReview"]; |
| 71 | delete?: never; |
| 72 | options?: never; |
| 73 | head?: never; |
| 74 | patch?: never; |
| 75 | trace?: never; |
| 76 | }; |
| 77 | "/api/v1/workspaces/{workspaceSlug}/apps": { |
| 78 | parameters: { |
| 79 | query?: never; |
| 80 | header?: never; |
| 81 | path?: never; |
| 82 | cookie?: never; |
| 83 | }; |
| 84 | /** List installed apps and workspace-visible catalog */ |
| 85 | get: operations["listWorkspaceApps"]; |
| 86 | put?: never; |
| 87 | /** Install an app into a workspace */ |
| 88 | post: operations["installWorkspaceApp"]; |
| 89 | delete?: never; |
| 90 | options?: never; |
| 91 | head?: never; |
| 92 | patch?: never; |
| 93 | trace?: never; |
| 94 | }; |
| 95 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}": { |
| 96 | parameters: { |
| 97 | query?: never; |
| 98 | header?: never; |
| 99 | path?: never; |
| 100 | cookie?: never; |
| 101 | }; |
| 102 | /** Get an installed workspace app */ |
| 103 | get: operations["getWorkspaceInstalledApp"]; |
| 104 | put?: never; |
| 105 | post?: never; |
| 106 | /** Uninstall a workspace app */ |
| 107 | delete: operations["uninstallWorkspaceApp"]; |
| 108 | options?: never; |
| 109 | head?: never; |
| 110 | patch?: never; |
| 111 | trace?: never; |
| 112 | }; |
| 113 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/permissions": { |
| 114 | parameters: { |
| 115 | query?: never; |
| 116 | header?: never; |
| 117 | path?: never; |
| 118 | cookie?: never; |
| 119 | }; |
| 120 | /** Get granted workspace app permissions */ |
| 121 | get: operations["getWorkspaceAppPermissions"]; |
| 122 | /** Update granted workspace app permissions */ |
| 123 | put: operations["updateWorkspaceAppPermissions"]; |
| 124 | post?: never; |
| 125 | delete?: never; |
| 126 | options?: never; |
| 127 | head?: never; |
| 128 | patch?: never; |
| 129 | trace?: never; |
| 130 | }; |
| 131 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/secrets": { |
| 132 | parameters: { |
| 133 | query?: never; |
| 134 | header?: never; |
| 135 | path?: never; |
| 136 | cookie?: never; |
| 137 | }; |
| 138 | /** List app secrets */ |
| 139 | get: operations["listWorkspaceAppSecrets"]; |
| 140 | put?: never; |
| 141 | /** Create or rotate app secret */ |
| 142 | post: operations["createWorkspaceAppSecret"]; |
| 143 | delete?: never; |
| 144 | options?: never; |
| 145 | head?: never; |
| 146 | patch?: never; |
| 147 | trace?: never; |
| 148 | }; |
| 149 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/secrets/{secretId}": { |
| 150 | parameters: { |
| 151 | query?: never; |
| 152 | header?: never; |
| 153 | path?: never; |
| 154 | cookie?: never; |
| 155 | }; |
| 156 | get?: never; |
| 157 | put?: never; |
| 158 | post?: never; |
| 159 | /** Delete app secret */ |
| 160 | delete: operations["deleteWorkspaceAppSecret"]; |
| 161 | options?: never; |
| 162 | head?: never; |
| 163 | patch?: never; |
| 164 | trace?: never; |
| 165 | }; |
| 166 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/oauth-connections": { |
| 167 | parameters: { |
| 168 | query?: never; |
| 169 | header?: never; |
| 170 | path?: never; |
| 171 | cookie?: never; |
| 172 | }; |
| 173 | /** List app OAuth connections */ |
| 174 | get: operations["listWorkspaceAppOauthConnections"]; |
| 175 | put?: never; |
| 176 | /** Create or update app OAuth connection */ |
| 177 | post: operations["createWorkspaceAppOauthConnection"]; |
| 178 | delete?: never; |
| 179 | options?: never; |
| 180 | head?: never; |
| 181 | patch?: never; |
| 182 | trace?: never; |
| 183 | }; |
| 184 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/oauth-connections/{connectionId}": { |
| 185 | parameters: { |
| 186 | query?: never; |
| 187 | header?: never; |
| 188 | path?: never; |
| 189 | cookie?: never; |
| 190 | }; |
| 191 | get?: never; |
| 192 | put?: never; |
| 193 | post?: never; |
| 194 | /** Delete app OAuth connection */ |
| 195 | delete: operations["deleteWorkspaceAppOauthConnection"]; |
| 196 | options?: never; |
| 197 | head?: never; |
| 198 | patch?: never; |
| 199 | trace?: never; |
| 200 | }; |
| 201 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/deliveries": { |
| 202 | parameters: { |
| 203 | query?: never; |
| 204 | header?: never; |
| 205 | path?: never; |
| 206 | cookie?: never; |
| 207 | }; |
| 208 | /** List app deliveries */ |
| 209 | get: operations["listWorkspaceAppDeliveries"]; |
| 210 | put?: never; |
| 211 | /** Send a signed test delivery */ |
| 212 | post: operations["sendWorkspaceAppTestDelivery"]; |
| 213 | delete?: never; |
| 214 | options?: never; |
| 215 | head?: never; |
| 216 | patch?: never; |
| 217 | trace?: never; |
| 218 | }; |
| 219 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/deliveries/{deliveryId}/replay": { |
| 220 | parameters: { |
| 221 | query?: never; |
| 222 | header?: never; |
| 223 | path?: never; |
| 224 | cookie?: never; |
| 225 | }; |
| 226 | get?: never; |
| 227 | put?: never; |
| 228 | /** Replay a stored app delivery */ |
| 229 | post: operations["replayWorkspaceAppDelivery"]; |
| 230 | delete?: never; |
| 231 | options?: never; |
| 232 | head?: never; |
| 233 | patch?: never; |
| 234 | trace?: never; |
| 235 | }; |
| 236 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/files/{fileId}": { |
| 237 | parameters: { |
| 238 | query?: never; |
| 239 | header?: never; |
| 240 | path?: never; |
| 241 | cookie?: never; |
| 242 | }; |
| 243 | /** Read an app-backed file document */ |
| 244 | get: operations["getAppFileDocument"]; |
| 245 | put?: never; |
| 246 | post?: never; |
| 247 | delete?: never; |
| 248 | options?: never; |
| 249 | head?: never; |
| 250 | /** Update an app-backed file document */ |
| 251 | patch: operations["updateAppFileDocument"]; |
| 252 | trace?: never; |
| 253 | }; |
| 254 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/notifications": { |
| 255 | parameters: { |
| 256 | query?: never; |
| 257 | header?: never; |
| 258 | path?: never; |
| 259 | cookie?: never; |
| 260 | }; |
| 261 | get?: never; |
| 262 | put?: never; |
| 263 | /** Create an app notification */ |
| 264 | post: operations["createAppNotification"]; |
| 265 | delete?: never; |
| 266 | options?: never; |
| 267 | head?: never; |
| 268 | patch?: never; |
| 269 | trace?: never; |
| 270 | }; |
| 271 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/index-documents": { |
| 272 | parameters: { |
| 273 | query?: never; |
| 274 | header?: never; |
| 275 | path?: never; |
| 276 | cookie?: never; |
| 277 | }; |
| 278 | get?: never; |
| 279 | put?: never; |
| 280 | /** Upsert app index documents */ |
| 281 | post: operations["upsertAppIndexDocuments"]; |
| 282 | /** Delete app index documents */ |
| 283 | delete: operations["deleteAppIndexDocuments"]; |
| 284 | options?: never; |
| 285 | head?: never; |
| 286 | patch?: never; |
| 287 | trace?: never; |
| 288 | }; |
| 289 | "/api/v1/workspaces/{workspaceSlug}/apps/{appKey}/ambient/events": { |
| 290 | parameters: { |
| 291 | query?: never; |
| 292 | header?: never; |
| 293 | path?: never; |
| 294 | cookie?: never; |
| 295 | }; |
| 296 | get?: never; |
| 297 | put?: never; |
| 298 | /** Emit app ambient events */ |
| 299 | post: operations["emitAppAmbientEvents"]; |
| 300 | delete?: never; |
| 301 | options?: never; |
| 302 | head?: never; |
| 303 | patch?: never; |
| 304 | trace?: never; |
| 305 | }; |
| 306 | } |
| 307 | export type webhooks = Record<string, never>; |
| 308 | export interface components { |
| 309 | schemas: { |
| 310 | ErrorEnvelope: { |
| 311 | error: { |
| 312 | code: string; |
| 313 | message: string; |
| 314 | }; |
| 315 | }; |
| 316 | OkResponse: { |
| 317 | data: { |
| 318 | /** @constant */ |
| 319 | ok: true; |
| 320 | }; |
| 321 | }; |
| 322 | AppCatalogItem: { |
| 323 | appId: string; |
| 324 | appKey: string; |
| 325 | name: string; |
| 326 | description: string | null; |
| 327 | iconUrl: string | null; |
| 328 | status: string; |
| 329 | latestPublishedVersion: string | null; |
| 330 | latestPublishedVersionId: string | null; |
| 331 | isInstalled: boolean; |
| 332 | }; |
| 333 | RegisteredAppDetail: { |
| 334 | appId: string; |
| 335 | appKey: string; |
| 336 | name: string; |
| 337 | description: string | null; |
| 338 | iconUrl: string | null; |
| 339 | status: string; |
| 340 | ownerUserId: string | null; |
| 341 | storeListed: boolean; |
| 342 | latestPublishedVersion: string | null; |
| 343 | latestPublishedVersionId: string | null; |
| 344 | }; |
| 345 | RegisteredAppVersionSummary: { |
| 346 | versionId: string; |
| 347 | version: string; |
| 348 | status: string; |
| 349 | reviewStatus: string; |
| 350 | apiBaseUrl: string; |
| 351 | permissions: string[]; |
| 352 | notificationChannels: { |
| 353 | key: string; |
| 354 | name: string; |
| 355 | description?: string; |
| 356 | defaultDeliveries: string[]; |
| 357 | defaultPriority: string; |
| 358 | }[]; |
| 359 | kairo: { |
| 360 | [key: string]: unknown; |
| 361 | } | null; |
| 362 | fileTypes: { |
| 363 | typeKey: string; |
| 364 | name: string; |
| 365 | description: string | null; |
| 366 | }[]; |
| 367 | /** Format: date-time */ |
| 368 | submittedAt: string | null; |
| 369 | /** Format: date-time */ |
| 370 | reviewedAt: string | null; |
| 371 | reviewNotes: string | null; |
| 372 | /** Format: date-time */ |
| 373 | publishedAt: string | null; |
| 374 | /** Format: date-time */ |
| 375 | createdAt: string; |
| 376 | /** Format: date-time */ |
| 377 | updatedAt: string; |
| 378 | }; |
| 379 | InstalledAppSummary: { |
| 380 | installId: string; |
| 381 | appId: string; |
| 382 | appKey: string; |
| 383 | name: string; |
| 384 | description: string | null; |
| 385 | iconUrl: string | null; |
| 386 | status: string; |
| 387 | installScope: string; |
| 388 | scopeSubjectId: string; |
| 389 | version: string | null; |
| 390 | }; |
| 391 | StoreAppsResponse: { |
| 392 | data: { |
| 393 | apps: components["schemas"]["RegisteredAppDetail"][]; |
| 394 | }; |
| 395 | }; |
| 396 | StoreAppResponse: { |
| 397 | data: { |
| 398 | app: components["schemas"]["RegisteredAppDetail"]; |
| 399 | }; |
| 400 | }; |
| 401 | StoreAppVersionsResponse: { |
| 402 | data: { |
| 403 | versions: components["schemas"]["RegisteredAppVersionSummary"][]; |
| 404 | }; |
| 405 | }; |
| 406 | WorkspaceAppsResponse: { |
| 407 | data: { |
| 408 | installedApps: components["schemas"]["InstalledAppSummary"][]; |
| 409 | catalog: components["schemas"]["AppCatalogItem"][]; |
| 410 | permissions: { |
| 411 | canManageApps: boolean; |
| 412 | }; |
| 413 | }; |
| 414 | }; |
| 415 | InstallWorkspaceAppInput: { |
| 416 | appId: string; |
| 417 | pinnedVersionId?: string; |
| 418 | grantedPermissions?: string[]; |
| 419 | }; |
| 420 | InstallWorkspaceAppResponse: { |
| 421 | data: { |
| 422 | installId: string; |
| 423 | appId: string; |
| 424 | appKey: string; |
| 425 | version: string; |
| 426 | grantedPermissions: string[]; |
| 427 | }; |
| 428 | }; |
| 429 | WorkspaceInstalledAppResponse: { |
| 430 | data: { |
| 431 | install: components["schemas"]["InstalledAppSummary"]; |
| 432 | permissions: { |
| 433 | canManageApps: boolean; |
| 434 | }; |
| 435 | }; |
| 436 | }; |
| 437 | WorkspaceAppPermissionsResponse: { |
| 438 | data: { |
| 439 | install: components["schemas"]["InstalledAppSummary"]; |
| 440 | availablePermissions: string[]; |
| 441 | grantedPermissions: string[]; |
| 442 | permissions: { |
| 443 | canManageApps: boolean; |
| 444 | }; |
| 445 | }; |
| 446 | }; |
| 447 | RegisterAppInput: { |
| 448 | version: string; |
| 449 | manifest: { |
| 450 | key: string; |
| 451 | name: string; |
| 452 | description?: string; |
| 453 | iconUrl?: string; |
| 454 | permissions: string[]; |
| 455 | notificationChannels: { |
| 456 | key: string; |
| 457 | name: string; |
| 458 | description?: string; |
| 459 | defaultDeliveries: string[]; |
| 460 | defaultPriority: string; |
| 461 | }[]; |
| 462 | kairo?: { |
| 463 | [key: string]: unknown; |
| 464 | }; |
| 465 | hosting: { |
| 466 | /** @constant */ |
| 467 | mode: "external"; |
| 468 | baseUrl: string; |
| 469 | }; |
| 470 | }; |
| 471 | fileTypes: { |
| 472 | typeKey: string; |
| 473 | name: string; |
| 474 | description?: string; |
| 475 | /** @constant */ |
| 476 | storage: "coline_document"; |
| 477 | indexable: boolean; |
| 478 | homeRenderMode: string; |
| 479 | }[]; |
| 480 | }; |
| 481 | AppVersionMutationResponse: { |
| 482 | data: { |
| 483 | appId: string; |
| 484 | appKey: string; |
| 485 | versionId: string; |
| 486 | version: string; |
| 487 | }; |
| 488 | }; |
| 489 | SubmitAppVersionForReviewResponse: { |
| 490 | data: { |
| 491 | appId: string; |
| 492 | appKey: string; |
| 493 | versionId: string; |
| 494 | version: string; |
| 495 | /** @constant */ |
| 496 | reviewStatus: "submitted"; |
| 497 | storeListed: boolean; |
| 498 | }; |
| 499 | }; |
| 500 | WorkspaceAppSecretsResponse: { |
| 501 | data: { |
| 502 | install: components["schemas"]["InstalledAppSummary"]; |
| 503 | secrets: { |
| 504 | id: string; |
| 505 | key: string; |
| 506 | /** Format: date-time */ |
| 507 | createdAt: string; |
| 508 | /** Format: date-time */ |
| 509 | updatedAt: string; |
| 510 | }[]; |
| 511 | permissions: { |
| 512 | canManageApps: boolean; |
| 513 | }; |
| 514 | }; |
| 515 | }; |
| 516 | CreateWorkspaceAppSecretResponse: { |
| 517 | data: { |
| 518 | secret: { |
| 519 | id: string; |
| 520 | key: string; |
| 521 | /** Format: date-time */ |
| 522 | createdAt: string; |
| 523 | /** Format: date-time */ |
| 524 | updatedAt: string; |
| 525 | }; |
| 526 | value: string; |
| 527 | }; |
| 528 | }; |
| 529 | WorkspaceAppOauthConnectionsResponse: { |
| 530 | data: { |
| 531 | install: components["schemas"]["InstalledAppSummary"]; |
| 532 | connections: { |
| 533 | id: string; |
| 534 | providerKey: string; |
| 535 | externalAccountId: string | null; |
| 536 | scopes: string[]; |
| 537 | /** Format: date-time */ |
| 538 | tokenExpiresAt: string | null; |
| 539 | /** Format: date-time */ |
| 540 | createdAt: string; |
| 541 | /** Format: date-time */ |
| 542 | updatedAt: string; |
| 543 | }[]; |
| 544 | permissions: { |
| 545 | canManageApps: boolean; |
| 546 | }; |
| 547 | }; |
| 548 | }; |
| 549 | CreateWorkspaceAppOauthConnectionResponse: { |
| 550 | data: { |
| 551 | connection: { |
| 552 | id: string; |
| 553 | providerKey: string; |
| 554 | externalAccountId: string | null; |
| 555 | scopes: string[]; |
| 556 | /** Format: date-time */ |
| 557 | tokenExpiresAt: string | null; |
| 558 | /** Format: date-time */ |
| 559 | createdAt: string; |
| 560 | /** Format: date-time */ |
| 561 | updatedAt: string; |
| 562 | }; |
| 563 | }; |
| 564 | }; |
| 565 | WorkspaceAppDeliveriesResponse: { |
| 566 | data: { |
| 567 | install: components["schemas"]["InstalledAppSummary"]; |
| 568 | deliveries: { |
| 569 | id: string; |
| 570 | eventType: string; |
| 571 | targetUrl: string; |
| 572 | status: string; |
| 573 | attemptCount: number; |
| 574 | lastStatusCode: number | null; |
| 575 | /** Format: date-time */ |
| 576 | createdAt: string; |
| 577 | /** Format: date-time */ |
| 578 | updatedAt: string; |
| 579 | }[]; |
| 580 | permissions: { |
| 581 | canManageApps: boolean; |
| 582 | }; |
| 583 | }; |
| 584 | }; |
| 585 | SendWorkspaceAppTestDeliveryResponse: { |
| 586 | data: { |
| 587 | delivery: { |
| 588 | id: string; |
| 589 | eventType: string; |
| 590 | targetUrl: string; |
| 591 | status: string; |
| 592 | attemptCount: number; |
| 593 | lastStatusCode: number | null; |
| 594 | /** Format: date-time */ |
| 595 | createdAt: string; |
| 596 | /** Format: date-time */ |
| 597 | updatedAt: string; |
| 598 | }; |
| 599 | }; |
| 600 | }; |
| 601 | AppFileDocumentResponse: { |
| 602 | data: { |
| 603 | file: { |
| 604 | id: string; |
| 605 | name: string; |
| 606 | fileType: string; |
| 607 | appKey: string; |
| 608 | appName: string; |
| 609 | typeLabel: string; |
| 610 | openHref: string; |
| 611 | /** Format: date-time */ |
| 612 | updatedAt: string; |
| 613 | }; |
| 614 | document: { |
| 615 | [key: string]: unknown; |
| 616 | }; |
| 617 | version: number; |
| 618 | capabilities: { |
| 619 | canRead: boolean; |
| 620 | canWrite: boolean; |
| 621 | canManage: boolean; |
| 622 | }; |
| 623 | }; |
| 624 | }; |
| 625 | AppFileDocumentUpdateResponse: { |
| 626 | data: { |
| 627 | document: { |
| 628 | [key: string]: unknown; |
| 629 | }; |
| 630 | version: number; |
| 631 | /** Format: date-time */ |
| 632 | updatedAt: string; |
| 633 | }; |
| 634 | }; |
| 635 | CreateAppNotificationInput: { |
| 636 | channelKey: string; |
| 637 | typeKey: string; |
| 638 | recipients: { |
| 639 | userId: string; |
| 640 | }[]; |
| 641 | title: string; |
| 642 | body?: string; |
| 643 | targetUrl?: string; |
| 644 | icon?: string; |
| 645 | priority?: string; |
| 646 | dedupeKey?: string; |
| 647 | metadata?: { |
| 648 | [key: string]: unknown; |
| 649 | }; |
| 650 | }; |
| 651 | UpsertAppIndexDocumentsInput: { |
| 652 | documents: { |
| 653 | documentKey: string; |
| 654 | documentType: string; |
| 655 | fileId?: string; |
| 656 | title: string; |
| 657 | body?: string; |
| 658 | url?: string; |
| 659 | metadata?: { |
| 660 | [key: string]: unknown; |
| 661 | }; |
| 662 | visibilityMode?: string; |
| 663 | visibility?: { |
| 664 | subjectType: string; |
| 665 | subjectId: string; |
| 666 | }[]; |
| 667 | }[]; |
| 668 | }; |
| 669 | UpsertAppIndexDocumentsResponse: { |
| 670 | data: { |
| 671 | documents: { |
| 672 | id: string; |
| 673 | documentKey: string; |
| 674 | visibilityMode: string; |
| 675 | }[]; |
| 676 | }; |
| 677 | }; |
| 678 | DeleteAppIndexDocumentsInput: { |
| 679 | documentKeys: string[]; |
| 680 | }; |
| 681 | DeleteAppIndexDocumentsResponse: { |
| 682 | data: { |
| 683 | deleted: { |
| 684 | id: string; |
| 685 | documentKey: string; |
| 686 | }[]; |
| 687 | }; |
| 688 | }; |
| 689 | EmitAppAmbientEventsInput: { |
| 690 | events: { |
| 691 | sourceKind: string; |
| 692 | action: string; |
| 693 | entityType: string; |
| 694 | entityId: string; |
| 695 | actorUserId?: string; |
| 696 | containerType?: string; |
| 697 | containerId?: string; |
| 698 | /** Format: date-time */ |
| 699 | occurredAt?: string; |
| 700 | dedupeKey: string; |
| 701 | payload?: { |
| 702 | [key: string]: unknown; |
| 703 | }; |
| 704 | metadata?: { |
| 705 | [key: string]: unknown; |
| 706 | }; |
| 707 | schemaVersion?: number; |
| 708 | }[]; |
| 709 | }; |
| 710 | EmitAppAmbientEventsResponse: { |
| 711 | data: { |
| 712 | events: { |
| 713 | id: string; |
| 714 | dedupeKey: string; |
| 715 | }[]; |
| 716 | }; |
| 717 | }; |
| 718 | }; |
| 719 | responses: never; |
| 720 | parameters: never; |
| 721 | requestBodies: never; |
| 722 | headers: never; |
| 723 | pathItems: never; |
| 724 | } |
| 725 | export type $defs = Record<string, never>; |
| 726 | export interface operations { |
| 727 | listStoreApps: { |
| 728 | parameters: { |
| 729 | query?: never; |
| 730 | header?: never; |
| 731 | path?: never; |
| 732 | cookie?: never; |
| 733 | }; |
| 734 | requestBody?: never; |
| 735 | responses: { |
| 736 | /** @description Store apps */ |
| 737 | 200: { |
| 738 | headers: { |
| 739 | [name: string]: unknown; |
| 740 | }; |
| 741 | content: { |
| 742 | "application/json": components["schemas"]["StoreAppsResponse"]; |
| 743 | }; |
| 744 | }; |
| 745 | }; |
| 746 | }; |
| 747 | registerApp: { |
| 748 | parameters: { |
| 749 | query?: never; |
| 750 | header?: never; |
| 751 | path?: never; |
| 752 | cookie?: never; |
| 753 | }; |
| 754 | requestBody: { |
| 755 | content: { |
| 756 | "application/json": components["schemas"]["RegisterAppInput"]; |
| 757 | }; |
| 758 | }; |
| 759 | responses: { |
| 760 | /** @description Registered app */ |
| 761 | 201: { |
| 762 | headers: { |
| 763 | [name: string]: unknown; |
| 764 | }; |
| 765 | content: { |
| 766 | "application/json": components["schemas"]["AppVersionMutationResponse"]; |
| 767 | }; |
| 768 | }; |
| 769 | }; |
| 770 | }; |
| 771 | getStoreApp: { |
| 772 | parameters: { |
| 773 | query?: never; |
| 774 | header?: never; |
| 775 | path: { |
| 776 | appKey: string; |
| 777 | }; |
| 778 | cookie?: never; |
| 779 | }; |
| 780 | requestBody?: never; |
| 781 | responses: { |
| 782 | /** @description Store app detail */ |
| 783 | 200: { |
| 784 | headers: { |
| 785 | [name: string]: unknown; |
| 786 | }; |
| 787 | content: { |
| 788 | "application/json": components["schemas"]["StoreAppResponse"]; |
| 789 | }; |
| 790 | }; |
| 791 | /** @description App not found */ |
| 792 | 404: { |
| 793 | headers: { |
| 794 | [name: string]: unknown; |
| 795 | }; |
| 796 | content: { |
| 797 | "application/json": components["schemas"]["ErrorEnvelope"]; |
| 798 | }; |
| 799 | }; |
| 800 | }; |
| 801 | }; |
| 802 | listStoreAppVersions: { |
| 803 | parameters: { |
| 804 | query?: never; |
| 805 | header?: never; |
| 806 | path: { |
| 807 | appKey: string; |
| 808 | }; |
| 809 | cookie?: never; |
| 810 | }; |
| 811 | requestBody?: never; |
| 812 | responses: { |
| 813 | /** @description Approved store app versions */ |
| 814 | 200: { |
| 815 | headers: { |
| 816 | [name: string]: unknown; |
| 817 | }; |
| 818 | content: { |
| 819 | "application/json": components["schemas"]["StoreAppVersionsResponse"]; |
| 820 | }; |
| 821 | }; |
| 822 | }; |
| 823 | }; |
| 824 | createAppVersion: { |
| 825 | parameters: { |
| 826 | query?: never; |
| 827 | header?: never; |
| 828 | path: { |
| 829 | appKey: string; |
| 830 | }; |
| 831 | cookie?: never; |
| 832 | }; |
| 833 | requestBody: { |
| 834 | content: { |
| 835 | "application/json": components["schemas"]["RegisterAppInput"]; |
| 836 | }; |
| 837 | }; |
| 838 | responses: { |
| 839 | /** @description Created app version */ |
| 840 | 201: { |
| 841 | headers: { |
| 842 | [name: string]: unknown; |
| 843 | }; |
| 844 | content: { |
| 845 | "application/json": components["schemas"]["AppVersionMutationResponse"]; |
| 846 | }; |
| 847 | }; |
| 848 | }; |
| 849 | }; |
| 850 | submitAppVersionForReview: { |
| 851 | parameters: { |
| 852 | query?: never; |
| 853 | header?: never; |
| 854 | path: { |
| 855 | appKey: string; |
| 856 | versionId: string; |
| 857 | }; |
| 858 | cookie?: never; |
| 859 | }; |
| 860 | requestBody: { |
| 861 | content: { |
| 862 | "application/json": { |
| 863 | storeListed?: boolean; |
| 864 | }; |
| 865 | }; |
| 866 | }; |
| 867 | responses: { |
| 868 | /** @description Submitted app version */ |
| 869 | 200: { |
| 870 | headers: { |
| 871 | [name: string]: unknown; |
| 872 | }; |
| 873 | content: { |
| 874 | "application/json": components["schemas"]["SubmitAppVersionForReviewResponse"]; |
| 875 | }; |
| 876 | }; |
| 877 | }; |
| 878 | }; |
| 879 | listWorkspaceApps: { |
| 880 | parameters: { |
| 881 | query?: never; |
| 882 | header?: never; |
| 883 | path: { |
| 884 | workspaceSlug: string; |
| 885 | }; |
| 886 | cookie?: never; |
| 887 | }; |
| 888 | requestBody?: never; |
| 889 | responses: { |
| 890 | /** @description Workspace app data */ |
| 891 | 200: { |
| 892 | headers: { |
| 893 | [name: string]: unknown; |
| 894 | }; |
| 895 | content: { |
| 896 | "application/json": components["schemas"]["WorkspaceAppsResponse"]; |
| 897 | }; |
| 898 | }; |
| 899 | }; |
| 900 | }; |
| 901 | installWorkspaceApp: { |
| 902 | parameters: { |
| 903 | query?: never; |
| 904 | header?: never; |
| 905 | path: { |
| 906 | workspaceSlug: string; |
| 907 | }; |
| 908 | cookie?: never; |
| 909 | }; |
| 910 | requestBody: { |
| 911 | content: { |
| 912 | "application/json": components["schemas"]["InstallWorkspaceAppInput"]; |
| 913 | }; |
| 914 | }; |
| 915 | responses: { |
| 916 | /** @description Installed app */ |
| 917 | 201: { |
| 918 | headers: { |
| 919 | [name: string]: unknown; |
| 920 | }; |
| 921 | content: { |
| 922 | "application/json": components["schemas"]["InstallWorkspaceAppResponse"]; |
| 923 | }; |
| 924 | }; |
| 925 | }; |
| 926 | }; |
| 927 | getWorkspaceInstalledApp: { |
| 928 | parameters: { |
| 929 | query?: never; |
| 930 | header?: never; |
| 931 | path: { |
| 932 | workspaceSlug: string; |
| 933 | appKey: string; |
| 934 | }; |
| 935 | cookie?: never; |
| 936 | }; |
| 937 | requestBody?: never; |
| 938 | responses: { |
| 939 | /** @description Installed app */ |
| 940 | 200: { |
| 941 | headers: { |
| 942 | [name: string]: unknown; |
| 943 | }; |
| 944 | content: { |
| 945 | "application/json": components["schemas"]["WorkspaceInstalledAppResponse"]; |
| 946 | }; |
| 947 | }; |
| 948 | }; |
| 949 | }; |
| 950 | uninstallWorkspaceApp: { |
| 951 | parameters: { |
| 952 | query?: never; |
| 953 | header?: never; |
| 954 | path: { |
| 955 | workspaceSlug: string; |
| 956 | appKey: string; |
| 957 | }; |
| 958 | cookie?: never; |
| 959 | }; |
| 960 | requestBody?: never; |
| 961 | responses: { |
| 962 | /** @description App uninstalled */ |
| 963 | 200: { |
| 964 | headers: { |
| 965 | [name: string]: unknown; |
| 966 | }; |
| 967 | content: { |
| 968 | "application/json": components["schemas"]["OkResponse"]; |
| 969 | }; |
| 970 | }; |
| 971 | }; |
| 972 | }; |
| 973 | getWorkspaceAppPermissions: { |
| 974 | parameters: { |
| 975 | query?: never; |
| 976 | header?: never; |
| 977 | path: { |
| 978 | workspaceSlug: string; |
| 979 | appKey: string; |
| 980 | }; |
| 981 | cookie?: never; |
| 982 | }; |
| 983 | requestBody?: never; |
| 984 | responses: { |
| 985 | /** @description Workspace app permissions */ |
| 986 | 200: { |
| 987 | headers: { |
| 988 | [name: string]: unknown; |
| 989 | }; |
| 990 | content: { |
| 991 | "application/json": components["schemas"]["WorkspaceAppPermissionsResponse"]; |
| 992 | }; |
| 993 | }; |
| 994 | }; |
| 995 | }; |
| 996 | updateWorkspaceAppPermissions: { |
| 997 | parameters: { |
| 998 | query?: never; |
| 999 | header?: never; |
| 1000 | path: { |
| 1001 | workspaceSlug: string; |
| 1002 | appKey: string; |
| 1003 | }; |
| 1004 | cookie?: never; |
| 1005 | }; |
| 1006 | requestBody: { |
| 1007 | content: { |
| 1008 | "application/json": { |
| 1009 | grantedPermissions: string[]; |
| 1010 | }; |
| 1011 | }; |
| 1012 | }; |
| 1013 | responses: { |
| 1014 | /** @description Updated permissions */ |
| 1015 | 200: { |
| 1016 | headers: { |
| 1017 | [name: string]: unknown; |
| 1018 | }; |
| 1019 | content: { |
| 1020 | "application/json": components["schemas"]["WorkspaceAppPermissionsResponse"]; |
| 1021 | }; |
| 1022 | }; |
| 1023 | }; |
| 1024 | }; |
| 1025 | listWorkspaceAppSecrets: { |
| 1026 | parameters: { |
| 1027 | query?: never; |
| 1028 | header?: never; |
| 1029 | path: { |
| 1030 | workspaceSlug: string; |
| 1031 | appKey: string; |
| 1032 | }; |
| 1033 | cookie?: never; |
| 1034 | }; |
| 1035 | requestBody?: never; |
| 1036 | responses: { |
| 1037 | /** @description App secrets */ |
| 1038 | 200: { |
| 1039 | headers: { |
| 1040 | [name: string]: unknown; |
| 1041 | }; |
| 1042 | content: { |
| 1043 | "application/json": components["schemas"]["WorkspaceAppSecretsResponse"]; |
| 1044 | }; |
| 1045 | }; |
| 1046 | }; |
| 1047 | }; |
| 1048 | createWorkspaceAppSecret: { |
| 1049 | parameters: { |
| 1050 | query?: never; |
| 1051 | header?: never; |
| 1052 | path: { |
| 1053 | workspaceSlug: string; |
| 1054 | appKey: string; |
| 1055 | }; |
| 1056 | cookie?: never; |
| 1057 | }; |
| 1058 | requestBody: { |
| 1059 | content: { |
| 1060 | "application/json": { |
| 1061 | key: string; |
| 1062 | value: string; |
| 1063 | }; |
| 1064 | }; |
| 1065 | }; |
| 1066 | responses: { |
| 1067 | /** @description App secret stored */ |
| 1068 | 201: { |
| 1069 | headers: { |
| 1070 | [name: string]: unknown; |
| 1071 | }; |
| 1072 | content: { |
| 1073 | "application/json": components["schemas"]["CreateWorkspaceAppSecretResponse"]; |
| 1074 | }; |
| 1075 | }; |
| 1076 | }; |
| 1077 | }; |
| 1078 | deleteWorkspaceAppSecret: { |
| 1079 | parameters: { |
| 1080 | query?: never; |
| 1081 | header?: never; |
| 1082 | path: { |
| 1083 | workspaceSlug: string; |
| 1084 | appKey: string; |
| 1085 | secretId: string; |
| 1086 | }; |
| 1087 | cookie?: never; |
| 1088 | }; |
| 1089 | requestBody?: never; |
| 1090 | responses: { |
| 1091 | /** @description App secret deleted */ |
| 1092 | 200: { |
| 1093 | headers: { |
| 1094 | [name: string]: unknown; |
| 1095 | }; |
| 1096 | content: { |
| 1097 | "application/json": components["schemas"]["OkResponse"]; |
| 1098 | }; |
| 1099 | }; |
| 1100 | }; |
| 1101 | }; |
| 1102 | listWorkspaceAppOauthConnections: { |
| 1103 | parameters: { |
| 1104 | query?: never; |
| 1105 | header?: never; |
| 1106 | path: { |
| 1107 | workspaceSlug: string; |
| 1108 | appKey: string; |
| 1109 | }; |
| 1110 | cookie?: never; |
| 1111 | }; |
| 1112 | requestBody?: never; |
| 1113 | responses: { |
| 1114 | /** @description App OAuth connections */ |
| 1115 | 200: { |
| 1116 | headers: { |
| 1117 | [name: string]: unknown; |
| 1118 | }; |
| 1119 | content: { |
| 1120 | "application/json": components["schemas"]["WorkspaceAppOauthConnectionsResponse"]; |
| 1121 | }; |
| 1122 | }; |
| 1123 | }; |
| 1124 | }; |
| 1125 | createWorkspaceAppOauthConnection: { |
| 1126 | parameters: { |
| 1127 | query?: never; |
| 1128 | header?: never; |
| 1129 | path: { |
| 1130 | workspaceSlug: string; |
| 1131 | appKey: string; |
| 1132 | }; |
| 1133 | cookie?: never; |
| 1134 | }; |
| 1135 | requestBody: { |
| 1136 | content: { |
| 1137 | "application/json": { |
| 1138 | providerKey: string; |
| 1139 | externalAccountId?: string; |
| 1140 | accessToken: string; |
| 1141 | refreshToken?: string; |
| 1142 | scopes: string[]; |
| 1143 | /** Format: date-time */ |
| 1144 | tokenExpiresAt?: string; |
| 1145 | metadata?: { |
| 1146 | [key: string]: unknown; |
| 1147 | }; |
| 1148 | }; |
| 1149 | }; |
| 1150 | }; |
| 1151 | responses: { |
| 1152 | /** @description App OAuth connection stored */ |
| 1153 | 201: { |
| 1154 | headers: { |
| 1155 | [name: string]: unknown; |
| 1156 | }; |
| 1157 | content: { |
| 1158 | "application/json": components["schemas"]["CreateWorkspaceAppOauthConnectionResponse"]; |
| 1159 | }; |
| 1160 | }; |
| 1161 | }; |
| 1162 | }; |
| 1163 | deleteWorkspaceAppOauthConnection: { |
| 1164 | parameters: { |
| 1165 | query?: never; |
| 1166 | header?: never; |
| 1167 | path: { |
| 1168 | workspaceSlug: string; |
| 1169 | appKey: string; |
| 1170 | connectionId: string; |
| 1171 | }; |
| 1172 | cookie?: never; |
| 1173 | }; |
| 1174 | requestBody?: never; |
| 1175 | responses: { |
| 1176 | /** @description App OAuth connection deleted */ |
| 1177 | 200: { |
| 1178 | headers: { |
| 1179 | [name: string]: unknown; |
| 1180 | }; |
| 1181 | content: { |
| 1182 | "application/json": components["schemas"]["OkResponse"]; |
| 1183 | }; |
| 1184 | }; |
| 1185 | }; |
| 1186 | }; |
| 1187 | listWorkspaceAppDeliveries: { |
| 1188 | parameters: { |
| 1189 | query?: never; |
| 1190 | header?: never; |
| 1191 | path: { |
| 1192 | workspaceSlug: string; |
| 1193 | appKey: string; |
| 1194 | }; |
| 1195 | cookie?: never; |
| 1196 | }; |
| 1197 | requestBody?: never; |
| 1198 | responses: { |
| 1199 | /** @description App deliveries */ |
| 1200 | 200: { |
| 1201 | headers: { |
| 1202 | [name: string]: unknown; |
| 1203 | }; |
| 1204 | content: { |
| 1205 | "application/json": components["schemas"]["WorkspaceAppDeliveriesResponse"]; |
| 1206 | }; |
| 1207 | }; |
| 1208 | }; |
| 1209 | }; |
| 1210 | sendWorkspaceAppTestDelivery: { |
| 1211 | parameters: { |
| 1212 | query?: never; |
| 1213 | header?: never; |
| 1214 | path: { |
| 1215 | workspaceSlug: string; |
| 1216 | appKey: string; |
| 1217 | }; |
| 1218 | cookie?: never; |
| 1219 | }; |
| 1220 | requestBody: { |
| 1221 | content: { |
| 1222 | "application/json": { |
| 1223 | eventType: string; |
| 1224 | targetUrl?: string; |
| 1225 | payload: { |
| 1226 | [key: string]: unknown; |
| 1227 | }; |
| 1228 | }; |
| 1229 | }; |
| 1230 | }; |
| 1231 | responses: { |
| 1232 | /** @description Test delivery recorded */ |
| 1233 | 201: { |
| 1234 | headers: { |
| 1235 | [name: string]: unknown; |
| 1236 | }; |
| 1237 | content: { |
| 1238 | "application/json": components["schemas"]["SendWorkspaceAppTestDeliveryResponse"]; |
| 1239 | }; |
| 1240 | }; |
| 1241 | }; |
| 1242 | }; |
| 1243 | replayWorkspaceAppDelivery: { |
| 1244 | parameters: { |
| 1245 | query?: never; |
| 1246 | header?: never; |
| 1247 | path: { |
| 1248 | workspaceSlug: string; |
| 1249 | appKey: string; |
| 1250 | deliveryId: string; |
| 1251 | }; |
| 1252 | cookie?: never; |
| 1253 | }; |
| 1254 | requestBody?: never; |
| 1255 | responses: { |
| 1256 | /** @description Delivery replayed */ |
| 1257 | 200: { |
| 1258 | headers: { |
| 1259 | [name: string]: unknown; |
| 1260 | }; |
| 1261 | content: { |
| 1262 | "application/json": components["schemas"]["SendWorkspaceAppTestDeliveryResponse"]; |
| 1263 | }; |
| 1264 | }; |
| 1265 | }; |
| 1266 | }; |
| 1267 | getAppFileDocument: { |
| 1268 | parameters: { |
| 1269 | query?: never; |
| 1270 | header?: never; |
| 1271 | path: { |
| 1272 | workspaceSlug: string; |
| 1273 | appKey: string; |
| 1274 | fileId: string; |
| 1275 | }; |
| 1276 | cookie?: never; |
| 1277 | }; |
| 1278 | requestBody?: never; |
| 1279 | responses: { |
| 1280 | /** @description App-backed file document */ |
| 1281 | 200: { |
| 1282 | headers: { |
| 1283 | [name: string]: unknown; |
| 1284 | }; |
| 1285 | content: { |
| 1286 | "application/json": components["schemas"]["AppFileDocumentResponse"]; |
| 1287 | }; |
| 1288 | }; |
| 1289 | }; |
| 1290 | }; |
| 1291 | updateAppFileDocument: { |
| 1292 | parameters: { |
| 1293 | query?: never; |
| 1294 | header?: never; |
| 1295 | path: { |
| 1296 | workspaceSlug: string; |
| 1297 | appKey: string; |
| 1298 | fileId: string; |
| 1299 | }; |
| 1300 | cookie?: never; |
| 1301 | }; |
| 1302 | requestBody: { |
| 1303 | content: { |
| 1304 | "application/json": { |
| 1305 | document: { |
| 1306 | [key: string]: unknown; |
| 1307 | }; |
| 1308 | }; |
| 1309 | }; |
| 1310 | }; |
| 1311 | responses: { |
| 1312 | /** @description Updated app-backed file document */ |
| 1313 | 200: { |
| 1314 | headers: { |
| 1315 | [name: string]: unknown; |
| 1316 | }; |
| 1317 | content: { |
| 1318 | "application/json": components["schemas"]["AppFileDocumentUpdateResponse"]; |
| 1319 | }; |
| 1320 | }; |
| 1321 | }; |
| 1322 | }; |
| 1323 | createAppNotification: { |
| 1324 | parameters: { |
| 1325 | query?: never; |
| 1326 | header?: never; |
| 1327 | path: { |
| 1328 | workspaceSlug: string; |
| 1329 | appKey: string; |
| 1330 | }; |
| 1331 | cookie?: never; |
| 1332 | }; |
| 1333 | requestBody: { |
| 1334 | content: { |
| 1335 | "application/json": components["schemas"]["CreateAppNotificationInput"]; |
| 1336 | }; |
| 1337 | }; |
| 1338 | responses: { |
| 1339 | /** @description Notification created */ |
| 1340 | 201: { |
| 1341 | headers: { |
| 1342 | [name: string]: unknown; |
| 1343 | }; |
| 1344 | content: { |
| 1345 | "application/json": components["schemas"]["OkResponse"]; |
| 1346 | }; |
| 1347 | }; |
| 1348 | }; |
| 1349 | }; |
| 1350 | upsertAppIndexDocuments: { |
| 1351 | parameters: { |
| 1352 | query?: never; |
| 1353 | header?: never; |
| 1354 | path: { |
| 1355 | workspaceSlug: string; |
| 1356 | appKey: string; |
| 1357 | }; |
| 1358 | cookie?: never; |
| 1359 | }; |
| 1360 | requestBody: { |
| 1361 | content: { |
| 1362 | "application/json": components["schemas"]["UpsertAppIndexDocumentsInput"]; |
| 1363 | }; |
| 1364 | }; |
| 1365 | responses: { |
| 1366 | /** @description Index documents upserted */ |
| 1367 | 201: { |
| 1368 | headers: { |
| 1369 | [name: string]: unknown; |
| 1370 | }; |
| 1371 | content: { |
| 1372 | "application/json": components["schemas"]["UpsertAppIndexDocumentsResponse"]; |
| 1373 | }; |
| 1374 | }; |
| 1375 | }; |
| 1376 | }; |
| 1377 | deleteAppIndexDocuments: { |
| 1378 | parameters: { |
| 1379 | query?: never; |
| 1380 | header?: never; |
| 1381 | path: { |
| 1382 | workspaceSlug: string; |
| 1383 | appKey: string; |
| 1384 | }; |
| 1385 | cookie?: never; |
| 1386 | }; |
| 1387 | requestBody: { |
| 1388 | content: { |
| 1389 | "application/json": components["schemas"]["DeleteAppIndexDocumentsInput"]; |
| 1390 | }; |
| 1391 | }; |
| 1392 | responses: { |
| 1393 | /** @description Index documents deleted */ |
| 1394 | 200: { |
| 1395 | headers: { |
| 1396 | [name: string]: unknown; |
| 1397 | }; |
| 1398 | content: { |
| 1399 | "application/json": components["schemas"]["DeleteAppIndexDocumentsResponse"]; |
| 1400 | }; |
| 1401 | }; |
| 1402 | }; |
| 1403 | }; |
| 1404 | emitAppAmbientEvents: { |
| 1405 | parameters: { |
| 1406 | query?: never; |
| 1407 | header?: never; |
| 1408 | path: { |
| 1409 | workspaceSlug: string; |
| 1410 | appKey: string; |
| 1411 | }; |
| 1412 | cookie?: never; |
| 1413 | }; |
| 1414 | requestBody: { |
| 1415 | content: { |
| 1416 | "application/json": components["schemas"]["EmitAppAmbientEventsInput"]; |
| 1417 | }; |
| 1418 | }; |
| 1419 | responses: { |
| 1420 | /** @description Ambient events accepted */ |
| 1421 | 201: { |
| 1422 | headers: { |
| 1423 | [name: string]: unknown; |
| 1424 | }; |
| 1425 | content: { |
| 1426 | "application/json": components["schemas"]["EmitAppAmbientEventsResponse"]; |
| 1427 | }; |
| 1428 | }; |
| 1429 | }; |
| 1430 | }; |
| 1431 | } |
| 1432 |