@botpress/api 1.48.0 → 1.48.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/.eslintrc.js +6 -0
  2. package/.turbo/turbo-openapi.log +6 -6
  3. package/dist/index.js +18984 -30184
  4. package/dist/src/gen/admin/state.d.ts +7 -1004
  5. package/dist/src/gen/files/state.d.ts +3 -3004
  6. package/dist/src/gen/runtime/state.d.ts +101 -2690
  7. package/dist/src/gen/state.d.ts +3 -0
  8. package/dist/src/gen/tables/state.d.ts +6 -2753
  9. package/dist/src/index.d.ts +10 -10
  10. package/package.json +19 -17
  11. package/src/gen/admin/metadata.json +1 -1
  12. package/src/gen/admin/openapi.json +1 -1
  13. package/src/gen/admin/state.ts +23 -1227
  14. package/src/gen/files/metadata.json +1 -1
  15. package/src/gen/files/openapi.json +1 -1
  16. package/src/gen/files/state.ts +4 -3593
  17. package/src/gen/openapi.json +1 -1
  18. package/src/gen/runtime/metadata.json +1 -1
  19. package/src/gen/runtime/openapi.json +1 -1
  20. package/src/gen/runtime/state.ts +6 -3117
  21. package/src/gen/state.ts +7 -4
  22. package/src/gen/tables/metadata.json +1 -1
  23. package/src/gen/tables/openapi.json +1 -1
  24. package/src/gen/tables/state.ts +95 -3394
package/src/gen/tables/state.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /* prettier-ignore */
4
4
  import * as opapi from '@bpinternal/opapi'
5
- export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'tag' | 'bot' | 'integration' | 'interface' | 'plugin' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>
5
+ export type State = opapi.State<'Table' | 'Column' | 'Row', never, 'tables'>
6
6
  export const state = {
7
7
  "operations": {
8
8
  "listTables": {
@@ -1007,7 +1007,8 @@ export const state = {
1007
1007
  "ids": {
1008
1008
  "type": "array",
1009
1009
  "items": {
1010
- "type": "number"
1010
+ "type": "number",
1011
+ "maximum": 2147483647
1011
1012
  },
1012
1013
  "maxItems": 1000
1013
1014
  },
@@ -1067,7 +1068,8 @@ export const state = {
1067
1068
  "type": "object",
1068
1069
  "properties": {
1069
1070
  "id": {
1070
- "type": "number"
1071
+ "type": "number",
1072
+ "maximum": 2147483647
1071
1073
  }
1072
1074
  },
1073
1075
  "required": [
@@ -1149,7 +1151,8 @@ export const state = {
1149
1151
  "type": "object",
1150
1152
  "properties": {
1151
1153
  "id": {
1152
- "type": "number"
1154
+ "type": "number",
1155
+ "maximum": 2147483647
1153
1156
  }
1154
1157
  },
1155
1158
  "additionalProperties": true
@@ -1220,10 +1223,10 @@ export const state = {
1220
1223
  }
1221
1224
  },
1222
1225
  "metadata": {
1223
- "title": "Botpress API",
1224
- "description": "API for Botpress Cloud",
1226
+ "title": "Botpress Tables API",
1227
+ "description": "API for Botpress Tables",
1225
1228
  "server": "https://api.botpress.cloud",
1226
- "version": "1.48.0",
1229
+ "version": "1.48.2",
1227
1230
  "prefix": "v1"
1228
1231
  },
1229
1232
  "errors": [
@@ -1307,3105 +1310,93 @@ export const state = {
1307
1310
  "type": "ResourceGone",
1308
1311
  "description": "The requested resource is no longer available."
1309
1312
  },
1310
- {
1311
- "status": 400,
1312
- "type": "ReferenceNotFound",
1313
- "description": "The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."
1314
- },
1315
- {
1316
- "status": 400,
1317
- "type": "InvalidQuery",
1318
- "description": "The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."
1319
- },
1320
- {
1321
- "status": 400,
1322
- "type": "Runtime",
1323
- "description": "An error happened during the execution of a runtime (bot or integration)."
1324
- },
1325
- {
1326
- "status": 409,
1327
- "type": "AlreadyExists",
1328
- "description": "The record attempted to be created already exists."
1329
- },
1330
- {
1331
- "status": 429,
1332
- "type": "RateLimited",
1333
- "description": "The request has been rate limited."
1334
- },
1335
- {
1336
- "status": 402,
1337
- "type": "PaymentRequired",
1338
- "description": "A payment is required to perform this request."
1339
- },
1340
- {
1341
- "status": 403,
1342
- "type": "QuotaExceeded",
1343
- "description": "The request exceeds the allowed quota. Quotas are a soft limit that can be increased."
1344
- },
1345
- {
1346
- "status": 413,
1347
- "type": "LimitExceeded",
1348
- "description": "The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."
1349
- },
1350
- {
1351
- "status": 400,
1352
- "type": "BreakingChanges",
1353
- "description": "Request payload contains breaking changes which is not allowed for this resource without a version increment."
1354
- }
1355
- ],
1356
- "refs": {
1357
- "parameters": {},
1358
- "requestBodies": {
1359
- "getOrCreateTableBody": true,
1360
- "createTableBody": true,
1361
- "duplicateTableBody": true,
1362
- "importTableBody": true,
1363
- "updateTableBody": true,
1364
- "renameTableColumnBody": true,
1365
- "findTableRowsBody": true,
1366
- "createTableRowsBody": true,
1367
- "deleteTableRowsBody": true,
1368
- "updateTableRowsBody": true,
1369
- "upsertTableRowsBody": true
1370
- },
1371
- "responses": {
1372
- "listTablesResponse": true,
1373
- "getTableResponse": true,
1374
- "getOrCreateTableResponse": true,
1375
- "createTableResponse": true,
1376
- "duplicateTableResponse": true,
1377
- "exportTableResponse": true,
1378
- "getTableJobsResponse": true,
1379
- "importTableResponse": true,
1380
- "updateTableResponse": true,
1381
- "renameTableColumnResponse": true,
1382
- "deleteTableResponse": true,
1383
- "getTableRowResponse": true,
1384
- "findTableRowsResponse": true,
1385
- "createTableRowsResponse": true,
1386
- "deleteTableRowsResponse": true,
1387
- "updateTableRowsResponse": true,
1388
- "upsertTableRowsResponse": true
1389
- },
1390
- "schemas": {
1391
- "Bot": true,
1392
- "Integration": true,
1393
- "Interface": true,
1394
- "Plugin": true,
1395
- "Workspace": true,
1396
- "WorkspaceMember": true,
1397
- "Account": true,
1398
- "Usage": true,
1399
- "Issue": true,
1400
- "IssueEvent": true,
1401
- "Activity": true,
1402
- "Version": true,
1403
- "User": true,
1404
- "Conversation": true,
1405
- "Event": true,
1406
- "Message": true,
1407
- "State": true,
1408
- "Task": true,
1409
- "Workflow": true,
1410
- "Table": true,
1411
- "Column": true,
1412
- "Row": true,
1413
- "File": true
1414
- }
1415
- },
1416
- "schemas": {
1417
- "Bot": {
1418
- "section": "bot",
1419
- "schema": {
1420
- "type": "object",
1421
- "properties": {
1422
- "id": {
1423
- "type": "string",
1424
- "minLength": 28,
1425
- "maxLength": 36,
1426
- "description": "Id of the [Bot](#schema_bot)"
1427
- },
1428
- "createdAt": {
1429
- "type": "string",
1430
- "format": "date-time",
1431
- "description": "Creation date of the [Bot](#schema_bot) in ISO 8601 format"
1432
- },
1433
- "updatedAt": {
1434
- "type": "string",
1435
- "format": "date-time",
1436
- "description": "Updating date of the [Bot](#schema_bot) in ISO 8601 format"
1437
- },
1438
- "signingSecret": {
1439
- "type": "string",
1440
- "maxLength": 2000,
1441
- "description": "Signing secret of the [Bot](#schema_bot)"
1442
- },
1443
- "integrations": {
1444
- "type": "object",
1445
- "additionalProperties": {
1446
- "type": "object",
1447
- "properties": {
1448
- "enabled": {
1449
- "type": "boolean"
1450
- },
1451
- "name": {
1452
- "type": "string",
1453
- "maxLength": 200,
1454
- "description": "Name of the [Integration](#schema_integration)"
1455
- },
1456
- "version": {
1457
- "type": "string",
1458
- "maxLength": 200,
1459
- "description": "Version of the [Integration](#schema_integration)"
1460
- },
1461
- "webhookUrl": {
1462
- "type": "string",
1463
- "maxLength": 2000
1464
- },
1465
- "webhookId": {
1466
- "type": "string",
1467
- "maxLength": 200
1468
- },
1469
- "identifier": {
1470
- "type": "string",
1471
- "maxLength": 2000
1472
- },
1473
- "configurationType": {
1474
- "type": "string",
1475
- "maxLength": 200,
1476
- "nullable": true
1477
- },
1478
- "configuration": {
1479
- "type": "object",
1480
- "additionalProperties": true
1481
- },
1482
- "status": {
1483
- "type": "string",
1484
- "enum": [
1485
- "registration_pending",
1486
- "registered",
1487
- "registration_failed",
1488
- "unregistration_pending",
1489
- "unregistered",
1490
- "unregistration_failed"
1491
- ]
1492
- },
1493
- "statusReason": {
1494
- "type": "string",
1495
- "maxLength": 2000,
1496
- "nullable": true
1497
- },
1498
- "disabledChannels": {
1499
- "type": "array",
1500
- "items": {
1501
- "type": "string",
1502
- "description": "Channel name"
1503
- },
1504
- "description": "Disabled channels for this integration"
1505
- },
1506
- "id": {
1507
- "type": "string",
1508
- "minLength": 28,
1509
- "maxLength": 36,
1510
- "description": "ID of the [Integration](#schema_integration)"
1511
- },
1512
- "createdAt": {
1513
- "type": "string",
1514
- "format": "date-time",
1515
- "description": "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
1516
- },
1517
- "updatedAt": {
1518
- "type": "string",
1519
- "format": "date-time",
1520
- "description": "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
1521
- },
1522
- "title": {
1523
- "type": "string",
1524
- "minLength": 1,
1525
- "maxLength": 64,
1526
- "description": "Title of the integration. This is the name that will be displayed in the UI"
1527
- },
1528
- "description": {
1529
- "type": "string",
1530
- "maxLength": 256,
1531
- "description": "Description of the integration. This is the description that will be displayed in the UI"
1532
- },
1533
- "iconUrl": {
1534
- "type": "string",
1535
- "description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
1536
- },
1537
- "public": {
1538
- "type": "boolean",
1539
- "description": "[DEPRECATED] Indicates whether the integration is public. Please use the \"visibility\" parameter instead.",
1540
- "deprecated": true
1541
- },
1542
- "visibility": {
1543
- "type": "string",
1544
- "enum": [
1545
- "public",
1546
- "private",
1547
- "unlisted"
1548
- ],
1549
- "description": "The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them."
1550
- },
1551
- "verificationStatus": {
1552
- "type": "string",
1553
- "enum": [
1554
- "unapproved",
1555
- "pending",
1556
- "approved",
1557
- "rejected"
1558
- ],
1559
- "description": "Status of the integration version verification"
1560
- }
1561
- },
1562
- "required": [
1563
- "enabled",
1564
- "name",
1565
- "version",
1566
- "webhookUrl",
1567
- "webhookId",
1568
- "configurationType",
1569
- "configuration",
1570
- "status",
1571
- "statusReason",
1572
- "disabledChannels",
1573
- "id",
1574
- "createdAt",
1575
- "updatedAt",
1576
- "title",
1577
- "description",
1578
- "iconUrl",
1579
- "public",
1580
- "visibility",
1581
- "verificationStatus"
1582
- ],
1583
- "additionalProperties": false
1584
- },
1585
- "description": "A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids."
1586
- },
1587
- "plugins": {
1588
- "type": "object",
1589
- "additionalProperties": {
1590
- "type": "object",
1591
- "properties": {
1592
- "enabled": {
1593
- "type": "boolean"
1594
- },
1595
- "name": {
1596
- "type": "string",
1597
- "maxLength": 200,
1598
- "description": "Name of the [Plugin](#schema_plugin)"
1599
- },
1600
- "version": {
1601
- "type": "string",
1602
- "maxLength": 200,
1603
- "description": "Version of the [Plugin](#schema_plugin)"
1604
- },
1605
- "configuration": {
1606
- "type": "object",
1607
- "additionalProperties": true
1608
- },
1609
- "interfaces": {
1610
- "type": "object",
1611
- "additionalProperties": {
1612
- "type": "object",
1613
- "properties": {
1614
- "integrationId": {
1615
- "type": "string",
1616
- "minLength": 28,
1617
- "maxLength": 36
1618
- },
1619
- "integrationAlias": {
1620
- "type": "string",
1621
- "maxLength": 200
1622
- },
1623
- "integrationInterfaceAlias": {
1624
- "type": "string",
1625
- "maxLength": 200
1626
- },
1627
- "interfaceId": {
1628
- "type": "string",
1629
- "minLength": 28,
1630
- "maxLength": 36
1631
- }
1632
- },
1633
- "required": [
1634
- "integrationId",
1635
- "integrationAlias",
1636
- "interfaceId"
1637
- ],
1638
- "additionalProperties": false
1639
- },
1640
- "description": "A mapping of plugin interface aliases to their backing integrations"
1641
- },
1642
- "integrations": {
1643
- "type": "object",
1644
- "additionalProperties": {
1645
- "type": "object",
1646
- "properties": {
1647
- "integrationId": {
1648
- "type": "string",
1649
- "minLength": 28,
1650
- "maxLength": 36
1651
- },
1652
- "integrationAlias": {
1653
- "type": "string",
1654
- "maxLength": 200
1655
- }
1656
- },
1657
- "required": [
1658
- "integrationId",
1659
- "integrationAlias"
1660
- ],
1661
- "additionalProperties": false
1662
- },
1663
- "description": "A mapping of plugin integration aliases to their backing integrations"
1664
- },
1665
- "id": {
1666
- "type": "string",
1667
- "minLength": 28,
1668
- "maxLength": 36,
1669
- "description": "ID of the [Plugin](#schema_plugin)"
1670
- },
1671
- "createdAt": {
1672
- "type": "string",
1673
- "format": "date-time",
1674
- "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
1675
- },
1676
- "updatedAt": {
1677
- "type": "string",
1678
- "format": "date-time",
1679
- "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
1680
- },
1681
- "title": {
1682
- "type": "string",
1683
- "minLength": 1,
1684
- "maxLength": 64,
1685
- "description": "Title of the plugin. This is the name that will be displayed in the UI"
1686
- },
1687
- "description": {
1688
- "type": "string",
1689
- "maxLength": 256,
1690
- "description": "Description of the plugin. This is the description that will be displayed in the UI"
1691
- },
1692
- "iconUrl": {
1693
- "type": "string",
1694
- "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
1695
- },
1696
- "readmeUrl": {
1697
- "type": "string",
1698
- "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
1699
- },
1700
- "public": {
1701
- "type": "boolean",
1702
- "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
1703
- }
1704
- },
1705
- "required": [
1706
- "enabled",
1707
- "name",
1708
- "version",
1709
- "configuration",
1710
- "id",
1711
- "createdAt",
1712
- "updatedAt",
1713
- "title",
1714
- "description",
1715
- "iconUrl",
1716
- "readmeUrl",
1717
- "public"
1718
- ],
1719
- "additionalProperties": false
1720
- },
1721
- "description": "A mapping of plugin aliases to their configuration"
1722
- },
1723
- "maxExecutionTime": {
1724
- "type": "number",
1725
- "description": "Maximum execution time of the bot (in seconds)."
1726
- },
1727
- "user": {
1728
- "type": "object",
1729
- "properties": {
1730
- "tags": {
1731
- "type": "object",
1732
- "additionalProperties": {
1733
- "type": "object",
1734
- "properties": {
1735
- "title": {
1736
- "type": "string",
1737
- "maxLength": 64,
1738
- "description": "Title of the tag"
1739
- },
1740
- "description": {
1741
- "type": "string",
1742
- "maxLength": 256,
1743
- "description": "Description of the tag"
1744
- }
1745
- },
1746
- "description": "Definition of a tag that can be provided on the object",
1747
- "additionalProperties": false
1748
- }
1749
- }
1750
- },
1751
- "required": [
1752
- "tags"
1753
- ],
1754
- "description": "User object configuration",
1755
- "additionalProperties": false
1756
- },
1757
- "conversation": {
1758
- "type": "object",
1759
- "properties": {
1760
- "tags": {
1761
- "type": "object",
1762
- "additionalProperties": {
1763
- "type": "object",
1764
- "properties": {
1765
- "title": {
1766
- "type": "string",
1767
- "maxLength": 64,
1768
- "description": "Title of the tag"
1769
- },
1770
- "description": {
1771
- "type": "string",
1772
- "maxLength": 256,
1773
- "description": "Description of the tag"
1774
- }
1775
- },
1776
- "description": "Definition of a tag that can be provided on the object",
1777
- "additionalProperties": false
1778
- }
1779
- }
1780
- },
1781
- "required": [
1782
- "tags"
1783
- ],
1784
- "description": "Conversation object configuration",
1785
- "additionalProperties": false
1786
- },
1787
- "message": {
1788
- "type": "object",
1789
- "properties": {
1790
- "tags": {
1791
- "type": "object",
1792
- "additionalProperties": {
1793
- "type": "object",
1794
- "properties": {
1795
- "title": {
1796
- "type": "string",
1797
- "maxLength": 64,
1798
- "description": "Title of the tag"
1799
- },
1800
- "description": {
1801
- "type": "string",
1802
- "maxLength": 256,
1803
- "description": "Description of the tag"
1804
- }
1805
- },
1806
- "description": "Definition of a tag that can be provided on the object",
1807
- "additionalProperties": false
1808
- }
1809
- }
1810
- },
1811
- "required": [
1812
- "tags"
1813
- ],
1814
- "description": "Message object configuration",
1815
- "additionalProperties": false
1816
- },
1817
- "states": {
1818
- "type": "object",
1819
- "additionalProperties": {
1820
- "type": "object",
1821
- "properties": {
1822
- "type": {
1823
- "type": "string",
1824
- "enum": [
1825
- "conversation",
1826
- "user",
1827
- "bot",
1828
- "task"
1829
- ],
1830
- "description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
1831
- },
1832
- "schema": {
1833
- "type": "object",
1834
- "additionalProperties": true,
1835
- "description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
1836
- },
1837
- "expiry": {
1838
- "type": "number",
1839
- "minimum": 1,
1840
- "description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
1841
- }
1842
- },
1843
- "required": [
1844
- "type",
1845
- "schema"
1846
- ],
1847
- "additionalProperties": false
1848
- },
1849
- "description": "A mapping of states to their definition"
1850
- },
1851
- "configuration": {
1852
- "type": "object",
1853
- "properties": {
1854
- "data": {
1855
- "type": "object",
1856
- "additionalProperties": true,
1857
- "description": "Configuration data"
1858
- },
1859
- "schema": {
1860
- "type": "object",
1861
- "additionalProperties": true,
1862
- "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
1863
- }
1864
- },
1865
- "required": [
1866
- "data",
1867
- "schema"
1868
- ],
1869
- "description": "Configuration of the bot",
1870
- "additionalProperties": false
1871
- },
1872
- "events": {
1873
- "type": "object",
1874
- "additionalProperties": {
1875
- "type": "object",
1876
- "properties": {
1877
- "title": {
1878
- "type": "string",
1879
- "maxLength": 64,
1880
- "description": "Title of the event"
1881
- },
1882
- "description": {
1883
- "type": "string",
1884
- "maxLength": 256,
1885
- "description": "Description of the event"
1886
- },
1887
- "schema": {
1888
- "type": "object",
1889
- "additionalProperties": true
1890
- },
1891
- "attributes": {
1892
- "type": "object",
1893
- "additionalProperties": {
1894
- "type": "string",
1895
- "maxLength": 200
1896
- },
1897
- "description": "Optional attributes"
1898
- }
1899
- },
1900
- "required": [
1901
- "schema"
1902
- ],
1903
- "description": "Event Definition",
1904
- "additionalProperties": false
1905
- },
1906
- "description": "Events definition"
1907
- },
1908
- "recurringEvents": {
1909
- "type": "object",
1910
- "additionalProperties": {
1911
- "type": "object",
1912
- "properties": {
1913
- "schedule": {
1914
- "type": "object",
1915
- "properties": {
1916
- "cron": {
1917
- "type": "string",
1918
- "maxLength": 200
1919
- }
1920
- },
1921
- "required": [
1922
- "cron"
1923
- ],
1924
- "additionalProperties": false
1925
- },
1926
- "type": {
1927
- "type": "string",
1928
- "maxLength": 200
1929
- },
1930
- "payload": {
1931
- "type": "object",
1932
- "additionalProperties": true
1933
- },
1934
- "failedAttempts": {
1935
- "type": "number",
1936
- "description": "The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully."
1937
- },
1938
- "lastFailureReason": {
1939
- "type": "string",
1940
- "maxLength": 2000,
1941
- "description": "The reason why the recurring event failed to run in the last attempt.",
1942
- "nullable": true
1943
- }
1944
- },
1945
- "required": [
1946
- "schedule",
1947
- "type",
1948
- "payload",
1949
- "failedAttempts",
1950
- "lastFailureReason"
1951
- ],
1952
- "additionalProperties": false
1953
- },
1954
- "description": "Recurring events"
1955
- },
1956
- "subscriptions": {
1957
- "type": "object",
1958
- "properties": {
1959
- "events": {
1960
- "type": "object",
1961
- "additionalProperties": {
1962
- "type": "object",
1963
- "additionalProperties": false
1964
- },
1965
- "nullable": true,
1966
- "description": "Events that the bot is currently subscribed on (ex: \"slack:reactionAdded\"). If null, the bot is subscribed to all events."
1967
- }
1968
- },
1969
- "required": [
1970
- "events"
1971
- ],
1972
- "description": "Subscriptions of the bot",
1973
- "additionalProperties": false
1974
- },
1975
- "actions": {
1976
- "type": "object",
1977
- "additionalProperties": {
1978
- "type": "object",
1979
- "properties": {
1980
- "title": {
1981
- "type": "string",
1982
- "maxLength": 64,
1983
- "description": "Title of the action"
1984
- },
1985
- "description": {
1986
- "type": "string",
1987
- "maxLength": 256,
1988
- "description": "Description of the action"
1989
- },
1990
- "billable": {
1991
- "type": "boolean"
1992
- },
1993
- "cacheable": {
1994
- "type": "boolean"
1995
- },
1996
- "input": {
1997
- "type": "object",
1998
- "properties": {
1999
- "schema": {
2000
- "type": "object",
2001
- "additionalProperties": true
2002
- }
2003
- },
2004
- "required": [
2005
- "schema"
2006
- ],
2007
- "additionalProperties": false
2008
- },
2009
- "output": {
2010
- "type": "object",
2011
- "properties": {
2012
- "schema": {
2013
- "type": "object",
2014
- "additionalProperties": true
2015
- }
2016
- },
2017
- "required": [
2018
- "schema"
2019
- ],
2020
- "additionalProperties": false
2021
- },
2022
- "attributes": {
2023
- "type": "object",
2024
- "additionalProperties": {
2025
- "type": "string",
2026
- "maxLength": 200
2027
- },
2028
- "description": "Optional attributes"
2029
- }
2030
- },
2031
- "required": [
2032
- "input",
2033
- "output"
2034
- ],
2035
- "description": "Action definition",
2036
- "additionalProperties": false
2037
- },
2038
- "description": "Actions definition"
2039
- },
2040
- "tags": {
2041
- "type": "object",
2042
- "additionalProperties": {
2043
- "type": "string"
2044
- },
2045
- "description": "Tags of [Bot](#schema_bot)"
2046
- },
2047
- "name": {
2048
- "type": "string",
2049
- "description": "Name of the [Bot](#schema_bot)"
2050
- },
2051
- "deployedAt": {
2052
- "type": "string",
2053
- "format": "date-time",
2054
- "description": "Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format"
2055
- },
2056
- "dev": {
2057
- "type": "boolean",
2058
- "description": "Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations"
2059
- },
2060
- "createdBy": {
2061
- "type": "string",
2062
- "description": "Id of the user that created the bot"
2063
- },
2064
- "alwaysAlive": {
2065
- "type": "boolean",
2066
- "description": "Indicates if the [Bot](#schema_bot) should be in always alive mode"
2067
- },
2068
- "status": {
2069
- "type": "string",
2070
- "enum": [
2071
- "active",
2072
- "deploying"
2073
- ],
2074
- "description": "Status of the bot"
2075
- },
2076
- "medias": {
2077
- "type": "array",
2078
- "items": {
2079
- "type": "object",
2080
- "properties": {
2081
- "url": {
2082
- "type": "string",
2083
- "description": "URL of the media file"
2084
- },
2085
- "name": {
2086
- "type": "string",
2087
- "description": "Name of the media file"
2088
- }
2089
- },
2090
- "required": [
2091
- "url",
2092
- "name"
2093
- ]
2094
- },
2095
- "description": "Media files associated with the [Bot](#schema_bot)"
2096
- }
2097
- },
2098
- "required": [
2099
- "id",
2100
- "createdAt",
2101
- "updatedAt",
2102
- "signingSecret",
2103
- "integrations",
2104
- "plugins",
2105
- "user",
2106
- "conversation",
2107
- "message",
2108
- "states",
2109
- "configuration",
2110
- "events",
2111
- "recurringEvents",
2112
- "subscriptions",
2113
- "actions",
2114
- "tags",
2115
- "name",
2116
- "dev",
2117
- "alwaysAlive",
2118
- "status",
2119
- "medias"
2120
- ],
2121
- "additionalProperties": false
2122
- }
2123
- },
2124
- "Integration": {
2125
- "section": "integration",
2126
- "schema": {
2127
- "type": "object",
2128
- "properties": {
2129
- "id": {
2130
- "type": "string",
2131
- "minLength": 28,
2132
- "maxLength": 36,
2133
- "description": "ID of the [Integration](#schema_integration)"
2134
- },
2135
- "createdAt": {
2136
- "type": "string",
2137
- "format": "date-time",
2138
- "description": "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
2139
- },
2140
- "updatedAt": {
2141
- "type": "string",
2142
- "format": "date-time",
2143
- "description": "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
2144
- },
2145
- "identifier": {
2146
- "type": "object",
2147
- "properties": {
2148
- "fallbackHandlerScript": {
2149
- "type": "string",
2150
- "maxLength": 2000,
2151
- "description": "VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier"
2152
- },
2153
- "extractScript": {
2154
- "type": "string",
2155
- "maxLength": 2000,
2156
- "description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth"
2157
- }
2158
- },
2159
- "description": "Global identifier configuration of the [Integration](#schema_integration)",
2160
- "additionalProperties": false
2161
- },
2162
- "sandbox": {
2163
- "type": "object",
2164
- "properties": {
2165
- "identifierExtractScript": {
2166
- "type": "string",
2167
- "maxLength": 2000,
2168
- "description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox"
2169
- },
2170
- "messageExtractScript": {
2171
- "type": "string",
2172
- "maxLength": 2000,
2173
- "description": "VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox"
2174
- }
2175
- },
2176
- "additionalProperties": false
2177
- },
2178
- "maxExecutionTime": {
2179
- "type": "number",
2180
- "description": "Maximum execution time of the integration (in seconds)."
2181
- },
2182
- "url": {
2183
- "type": "string",
2184
- "maxLength": 2000,
2185
- "description": "URL of the [Integration](#schema_integration)"
2186
- },
2187
- "name": {
2188
- "type": "string",
2189
- "maxLength": 200,
2190
- "description": "Name of the [Integration](#schema_integration)"
2191
- },
2192
- "version": {
2193
- "type": "string",
2194
- "maxLength": 200,
2195
- "description": "Version of the [Integration](#schema_integration)"
2196
- },
2197
- "interfaces": {
2198
- "type": "object",
2199
- "additionalProperties": {
2200
- "type": "object",
2201
- "properties": {
2202
- "id": {
2203
- "type": "string",
2204
- "minLength": 28,
2205
- "maxLength": 36,
2206
- "description": "ID of the interface"
2207
- },
2208
- "name": {
2209
- "type": "string",
2210
- "maxLength": 200,
2211
- "description": "Name of the interface"
2212
- },
2213
- "version": {
2214
- "type": "string",
2215
- "maxLength": 200,
2216
- "description": "Version of the interface"
2217
- },
2218
- "entities": {
2219
- "type": "object",
2220
- "additionalProperties": {
2221
- "type": "object",
2222
- "properties": {
2223
- "name": {
2224
- "type": "string",
2225
- "maxLength": 200
2226
- }
2227
- },
2228
- "required": [
2229
- "name"
2230
- ],
2231
- "additionalProperties": false
2232
- }
2233
- },
2234
- "actions": {
2235
- "type": "object",
2236
- "additionalProperties": {
2237
- "type": "object",
2238
- "properties": {
2239
- "name": {
2240
- "type": "string",
2241
- "maxLength": 200
2242
- }
2243
- },
2244
- "required": [
2245
- "name"
2246
- ],
2247
- "additionalProperties": false
2248
- }
2249
- },
2250
- "events": {
2251
- "type": "object",
2252
- "additionalProperties": {
2253
- "type": "object",
2254
- "properties": {
2255
- "name": {
2256
- "type": "string",
2257
- "maxLength": 200
2258
- }
2259
- },
2260
- "required": [
2261
- "name"
2262
- ],
2263
- "additionalProperties": false
2264
- }
2265
- },
2266
- "channels": {
2267
- "type": "object",
2268
- "additionalProperties": {
2269
- "type": "object",
2270
- "properties": {
2271
- "name": {
2272
- "type": "string",
2273
- "maxLength": 200
2274
- }
2275
- },
2276
- "required": [
2277
- "name"
2278
- ],
2279
- "additionalProperties": false
2280
- }
2281
- }
2282
- },
2283
- "required": [
2284
- "id",
2285
- "name",
2286
- "version",
2287
- "entities",
2288
- "actions",
2289
- "events",
2290
- "channels"
2291
- ],
2292
- "additionalProperties": false
2293
- }
2294
- },
2295
- "configuration": {
2296
- "type": "object",
2297
- "properties": {
2298
- "title": {
2299
- "type": "string",
2300
- "maxLength": 64,
2301
- "description": "Title of the configuration"
2302
- },
2303
- "description": {
2304
- "type": "string",
2305
- "maxLength": 256,
2306
- "description": "Description of the configuration"
2307
- },
2308
- "identifier": {
2309
- "type": "object",
2310
- "properties": {
2311
- "linkTemplateScript": {
2312
- "type": "string",
2313
- "maxLength": 2000
2314
- },
2315
- "required": {
2316
- "type": "boolean"
2317
- }
2318
- },
2319
- "required": [
2320
- "required"
2321
- ],
2322
- "description": "Identifier configuration of the [Integration](#schema_integration)",
2323
- "additionalProperties": false
2324
- },
2325
- "schema": {
2326
- "type": "object",
2327
- "additionalProperties": true,
2328
- "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
2329
- }
2330
- },
2331
- "required": [
2332
- "identifier",
2333
- "schema"
2334
- ],
2335
- "description": "Configuration definition",
2336
- "additionalProperties": false
2337
- },
2338
- "configurations": {
2339
- "type": "object",
2340
- "additionalProperties": {
2341
- "type": "object",
2342
- "properties": {
2343
- "title": {
2344
- "type": "string",
2345
- "maxLength": 64,
2346
- "description": "Title of the configuration"
2347
- },
2348
- "description": {
2349
- "type": "string",
2350
- "maxLength": 256,
2351
- "description": "Description of the configuration"
2352
- },
2353
- "identifier": {
2354
- "type": "object",
2355
- "properties": {
2356
- "linkTemplateScript": {
2357
- "type": "string",
2358
- "maxLength": 2000
2359
- },
2360
- "required": {
2361
- "type": "boolean"
2362
- }
2363
- },
2364
- "required": [
2365
- "required"
2366
- ],
2367
- "description": "Identifier configuration of the [Integration](#schema_integration)",
2368
- "additionalProperties": false
2369
- },
2370
- "schema": {
2371
- "type": "object",
2372
- "additionalProperties": true,
2373
- "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
2374
- }
2375
- },
2376
- "required": [
2377
- "identifier",
2378
- "schema"
2379
- ],
2380
- "description": "Configuration definition",
2381
- "additionalProperties": false
2382
- }
2383
- },
2384
- "channels": {
2385
- "type": "object",
2386
- "additionalProperties": {
2387
- "type": "object",
2388
- "properties": {
2389
- "title": {
2390
- "type": "string",
2391
- "maxLength": 64,
2392
- "description": "Title of the channel"
2393
- },
2394
- "description": {
2395
- "type": "string",
2396
- "maxLength": 256,
2397
- "description": "Description of the channel"
2398
- },
2399
- "messages": {
2400
- "type": "object",
2401
- "additionalProperties": {
2402
- "type": "object",
2403
- "properties": {
2404
- "schema": {
2405
- "type": "object",
2406
- "additionalProperties": true
2407
- }
2408
- },
2409
- "required": [
2410
- "schema"
2411
- ],
2412
- "description": "Message definition",
2413
- "additionalProperties": false
2414
- }
2415
- },
2416
- "conversation": {
2417
- "type": "object",
2418
- "properties": {
2419
- "tags": {
2420
- "type": "object",
2421
- "additionalProperties": {
2422
- "type": "object",
2423
- "properties": {
2424
- "title": {
2425
- "type": "string",
2426
- "maxLength": 64,
2427
- "description": "Title of the tag"
2428
- },
2429
- "description": {
2430
- "type": "string",
2431
- "maxLength": 256,
2432
- "description": "Description of the tag"
2433
- }
2434
- },
2435
- "description": "Definition of a tag that can be provided on the object",
2436
- "additionalProperties": false
2437
- }
2438
- },
2439
- "creation": {
2440
- "type": "object",
2441
- "properties": {
2442
- "enabled": {
2443
- "type": "boolean",
2444
- "description": "Enable conversation creation"
2445
- },
2446
- "requiredTags": {
2447
- "type": "array",
2448
- "items": {
2449
- "type": "string"
2450
- },
2451
- "description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
2452
- }
2453
- },
2454
- "required": [
2455
- "enabled",
2456
- "requiredTags"
2457
- ],
2458
- "description": "The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.",
2459
- "additionalProperties": false
2460
- }
2461
- },
2462
- "required": [
2463
- "tags",
2464
- "creation"
2465
- ],
2466
- "description": "Conversation object configuration",
2467
- "additionalProperties": false
2468
- },
2469
- "message": {
2470
- "type": "object",
2471
- "properties": {
2472
- "tags": {
2473
- "type": "object",
2474
- "additionalProperties": {
2475
- "type": "object",
2476
- "properties": {
2477
- "title": {
2478
- "type": "string",
2479
- "maxLength": 64,
2480
- "description": "Title of the tag"
2481
- },
2482
- "description": {
2483
- "type": "string",
2484
- "maxLength": 256,
2485
- "description": "Description of the tag"
2486
- }
2487
- },
2488
- "description": "Definition of a tag that can be provided on the object",
2489
- "additionalProperties": false
2490
- }
2491
- }
2492
- },
2493
- "required": [
2494
- "tags"
2495
- ],
2496
- "description": "Message object configuration",
2497
- "additionalProperties": false
2498
- }
2499
- },
2500
- "required": [
2501
- "messages",
2502
- "conversation",
2503
- "message"
2504
- ],
2505
- "description": "Channel definition",
2506
- "additionalProperties": false
2507
- }
2508
- },
2509
- "states": {
2510
- "type": "object",
2511
- "additionalProperties": {
2512
- "type": "object",
2513
- "properties": {
2514
- "type": {
2515
- "type": "string",
2516
- "enum": [
2517
- "conversation",
2518
- "user",
2519
- "integration"
2520
- ],
2521
- "description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
2522
- },
2523
- "schema": {
2524
- "type": "object",
2525
- "additionalProperties": true,
2526
- "description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
2527
- }
2528
- },
2529
- "required": [
2530
- "type",
2531
- "schema"
2532
- ],
2533
- "description": "State definition",
2534
- "additionalProperties": false
2535
- }
2536
- },
2537
- "events": {
2538
- "type": "object",
2539
- "additionalProperties": {
2540
- "type": "object",
2541
- "properties": {
2542
- "title": {
2543
- "type": "string",
2544
- "maxLength": 64,
2545
- "description": "Title of the event"
2546
- },
2547
- "description": {
2548
- "type": "string",
2549
- "maxLength": 256,
2550
- "description": "Description of the event"
2551
- },
2552
- "schema": {
2553
- "type": "object",
2554
- "additionalProperties": true
2555
- },
2556
- "attributes": {
2557
- "type": "object",
2558
- "additionalProperties": {
2559
- "type": "string",
2560
- "maxLength": 200
2561
- },
2562
- "description": "Optional attributes"
2563
- }
2564
- },
2565
- "required": [
2566
- "schema"
2567
- ],
2568
- "description": "Event Definition",
2569
- "additionalProperties": false
2570
- }
2571
- },
2572
- "actions": {
2573
- "type": "object",
2574
- "additionalProperties": {
2575
- "type": "object",
2576
- "properties": {
2577
- "title": {
2578
- "type": "string",
2579
- "maxLength": 64,
2580
- "description": "Title of the action"
2581
- },
2582
- "description": {
2583
- "type": "string",
2584
- "maxLength": 256,
2585
- "description": "Description of the action"
2586
- },
2587
- "billable": {
2588
- "type": "boolean"
2589
- },
2590
- "cacheable": {
2591
- "type": "boolean"
2592
- },
2593
- "input": {
2594
- "type": "object",
2595
- "properties": {
2596
- "schema": {
2597
- "type": "object",
2598
- "additionalProperties": true
2599
- }
2600
- },
2601
- "required": [
2602
- "schema"
2603
- ],
2604
- "additionalProperties": false
2605
- },
2606
- "output": {
2607
- "type": "object",
2608
- "properties": {
2609
- "schema": {
2610
- "type": "object",
2611
- "additionalProperties": true
2612
- }
2613
- },
2614
- "required": [
2615
- "schema"
2616
- ],
2617
- "additionalProperties": false
2618
- },
2619
- "attributes": {
2620
- "type": "object",
2621
- "additionalProperties": {
2622
- "type": "string",
2623
- "maxLength": 200
2624
- },
2625
- "description": "Optional attributes"
2626
- }
2627
- },
2628
- "required": [
2629
- "input",
2630
- "output"
2631
- ],
2632
- "description": "Action definition",
2633
- "additionalProperties": false
2634
- }
2635
- },
2636
- "user": {
2637
- "type": "object",
2638
- "properties": {
2639
- "tags": {
2640
- "type": "object",
2641
- "additionalProperties": {
2642
- "type": "object",
2643
- "properties": {
2644
- "title": {
2645
- "type": "string",
2646
- "maxLength": 64,
2647
- "description": "Title of the tag"
2648
- },
2649
- "description": {
2650
- "type": "string",
2651
- "maxLength": 256,
2652
- "description": "Description of the tag"
2653
- }
2654
- },
2655
- "description": "Definition of a tag that can be provided on the object",
2656
- "additionalProperties": false
2657
- }
2658
- },
2659
- "creation": {
2660
- "type": "object",
2661
- "properties": {
2662
- "enabled": {
2663
- "type": "boolean",
2664
- "description": "Enable user creation"
2665
- },
2666
- "requiredTags": {
2667
- "type": "array",
2668
- "items": {
2669
- "type": "string"
2670
- },
2671
- "description": "The list of tags that are required to be specified when calling the API directly to create a user."
2672
- }
2673
- },
2674
- "required": [
2675
- "enabled",
2676
- "requiredTags"
2677
- ],
2678
- "description": "The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.",
2679
- "additionalProperties": false
2680
- }
2681
- },
2682
- "required": [
2683
- "tags",
2684
- "creation"
2685
- ],
2686
- "description": "User object configuration",
2687
- "additionalProperties": false
2688
- },
2689
- "entities": {
2690
- "type": "object",
2691
- "additionalProperties": {
2692
- "type": "object",
2693
- "properties": {
2694
- "title": {
2695
- "type": "string",
2696
- "maxLength": 64,
2697
- "description": "Title of the entity"
2698
- },
2699
- "description": {
2700
- "type": "string",
2701
- "maxLength": 256,
2702
- "description": "Description of the entity"
2703
- },
2704
- "schema": {
2705
- "type": "object",
2706
- "additionalProperties": true
2707
- }
2708
- },
2709
- "required": [
2710
- "schema"
2711
- ],
2712
- "description": "Entity definition",
2713
- "additionalProperties": false
2714
- }
2715
- },
2716
- "attributes": {
2717
- "type": "object",
2718
- "additionalProperties": {
2719
- "type": "string",
2720
- "maxLength": 200
2721
- },
2722
- "description": "Optional attributes"
2723
- },
2724
- "dev": {
2725
- "type": "boolean",
2726
- "description": "Indicates if the integration is a development integration; Dev integrations run locally"
2727
- },
2728
- "title": {
2729
- "type": "string",
2730
- "minLength": 1,
2731
- "maxLength": 64,
2732
- "description": "Title of the integration. This is the name that will be displayed in the UI"
2733
- },
2734
- "description": {
2735
- "type": "string",
2736
- "maxLength": 256,
2737
- "description": "Description of the integration. This is the description that will be displayed in the UI"
2738
- },
2739
- "iconUrl": {
2740
- "type": "string",
2741
- "description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
2742
- },
2743
- "readmeUrl": {
2744
- "type": "string",
2745
- "description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
2746
- },
2747
- "public": {
2748
- "type": "boolean",
2749
- "description": "[DEPRECATED] Indicates whether the integration is public. Please use the \"visibility\" parameter instead.",
2750
- "deprecated": true
2751
- },
2752
- "visibility": {
2753
- "type": "string",
2754
- "enum": [
2755
- "public",
2756
- "private",
2757
- "unlisted"
2758
- ],
2759
- "description": "The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them."
2760
- },
2761
- "verificationStatus": {
2762
- "type": "string",
2763
- "enum": [
2764
- "unapproved",
2765
- "pending",
2766
- "approved",
2767
- "rejected"
2768
- ],
2769
- "description": "Status of the integration version verification"
2770
- },
2771
- "secrets": {
2772
- "type": "array",
2773
- "items": {
2774
- "type": "string"
2775
- },
2776
- "description": "Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing."
2777
- }
2778
- },
2779
- "required": [
2780
- "id",
2781
- "createdAt",
2782
- "updatedAt",
2783
- "identifier",
2784
- "url",
2785
- "name",
2786
- "version",
2787
- "interfaces",
2788
- "configuration",
2789
- "configurations",
2790
- "channels",
2791
- "states",
2792
- "events",
2793
- "actions",
2794
- "user",
2795
- "entities",
2796
- "dev",
2797
- "title",
2798
- "description",
2799
- "iconUrl",
2800
- "readmeUrl",
2801
- "public",
2802
- "visibility",
2803
- "verificationStatus",
2804
- "secrets"
2805
- ],
2806
- "additionalProperties": false
2807
- }
2808
- },
2809
- "Interface": {
2810
- "section": "interface",
2811
- "schema": {
2812
- "type": "object",
2813
- "properties": {
2814
- "id": {
2815
- "type": "string",
2816
- "minLength": 28,
2817
- "maxLength": 36,
2818
- "description": "ID of the [Interface](#schema_interface)"
2819
- },
2820
- "createdAt": {
2821
- "type": "string",
2822
- "format": "date-time",
2823
- "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
2824
- },
2825
- "updatedAt": {
2826
- "type": "string",
2827
- "format": "date-time",
2828
- "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
2829
- },
2830
- "name": {
2831
- "type": "string",
2832
- "maxLength": 200,
2833
- "description": "Name of the [Interface](#schema_interface)"
2834
- },
2835
- "version": {
2836
- "type": "string",
2837
- "maxLength": 200,
2838
- "description": "Version of the [Interface](#schema_interface)"
2839
- },
2840
- "entities": {
2841
- "type": "object",
2842
- "additionalProperties": {
2843
- "type": "object",
2844
- "properties": {
2845
- "title": {
2846
- "type": "string",
2847
- "maxLength": 64,
2848
- "description": "Title of the entity"
2849
- },
2850
- "description": {
2851
- "type": "string",
2852
- "maxLength": 256,
2853
- "description": "Description of the entity"
2854
- },
2855
- "schema": {
2856
- "type": "object",
2857
- "additionalProperties": true
2858
- }
2859
- },
2860
- "required": [
2861
- "schema"
2862
- ],
2863
- "description": "Entity definition",
2864
- "additionalProperties": false
2865
- }
2866
- },
2867
- "events": {
2868
- "type": "object",
2869
- "additionalProperties": {
2870
- "type": "object",
2871
- "properties": {
2872
- "title": {
2873
- "type": "string",
2874
- "maxLength": 64,
2875
- "description": "Title of the event"
2876
- },
2877
- "description": {
2878
- "type": "string",
2879
- "maxLength": 256,
2880
- "description": "Description of the event"
2881
- },
2882
- "schema": {
2883
- "type": "object",
2884
- "additionalProperties": true
2885
- },
2886
- "attributes": {
2887
- "type": "object",
2888
- "additionalProperties": {
2889
- "type": "string",
2890
- "maxLength": 200
2891
- },
2892
- "description": "Optional attributes"
2893
- }
2894
- },
2895
- "required": [
2896
- "schema"
2897
- ],
2898
- "description": "Event Definition",
2899
- "additionalProperties": false
2900
- }
2901
- },
2902
- "actions": {
2903
- "type": "object",
2904
- "additionalProperties": {
2905
- "type": "object",
2906
- "properties": {
2907
- "title": {
2908
- "type": "string",
2909
- "maxLength": 64,
2910
- "description": "Title of the action"
2911
- },
2912
- "description": {
2913
- "type": "string",
2914
- "maxLength": 256,
2915
- "description": "Description of the action"
2916
- },
2917
- "billable": {
2918
- "type": "boolean"
2919
- },
2920
- "cacheable": {
2921
- "type": "boolean"
2922
- },
2923
- "input": {
2924
- "type": "object",
2925
- "properties": {
2926
- "schema": {
2927
- "type": "object",
2928
- "additionalProperties": true
2929
- }
2930
- },
2931
- "required": [
2932
- "schema"
2933
- ],
2934
- "additionalProperties": false
2935
- },
2936
- "output": {
2937
- "type": "object",
2938
- "properties": {
2939
- "schema": {
2940
- "type": "object",
2941
- "additionalProperties": true
2942
- }
2943
- },
2944
- "required": [
2945
- "schema"
2946
- ],
2947
- "additionalProperties": false
2948
- },
2949
- "attributes": {
2950
- "type": "object",
2951
- "additionalProperties": {
2952
- "type": "string",
2953
- "maxLength": 200
2954
- },
2955
- "description": "Optional attributes"
2956
- }
2957
- },
2958
- "required": [
2959
- "input",
2960
- "output"
2961
- ],
2962
- "description": "Action definition",
2963
- "additionalProperties": false
2964
- }
2965
- },
2966
- "channels": {
2967
- "type": "object",
2968
- "additionalProperties": {
2969
- "type": "object",
2970
- "properties": {
2971
- "title": {
2972
- "type": "string",
2973
- "maxLength": 64,
2974
- "description": "Title of the channel"
2975
- },
2976
- "description": {
2977
- "type": "string",
2978
- "maxLength": 256,
2979
- "description": "Description of the channel"
2980
- },
2981
- "messages": {
2982
- "type": "object",
2983
- "additionalProperties": {
2984
- "type": "object",
2985
- "properties": {
2986
- "schema": {
2987
- "type": "object",
2988
- "additionalProperties": true
2989
- }
2990
- },
2991
- "required": [
2992
- "schema"
2993
- ],
2994
- "description": "Message definition",
2995
- "additionalProperties": false
2996
- }
2997
- }
2998
- },
2999
- "required": [
3000
- "messages"
3001
- ],
3002
- "additionalProperties": false
3003
- }
3004
- },
3005
- "nameTemplate": {
3006
- "type": "object",
3007
- "properties": {
3008
- "script": {
3009
- "type": "string",
3010
- "maxLength": 2000
3011
- },
3012
- "language": {
3013
- "type": "string",
3014
- "maxLength": 200
3015
- }
3016
- },
3017
- "required": [
3018
- "script",
3019
- "language"
3020
- ],
3021
- "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
3022
- "additionalProperties": false
3023
- },
3024
- "attributes": {
3025
- "type": "object",
3026
- "additionalProperties": {
3027
- "type": "string",
3028
- "maxLength": 200
3029
- },
3030
- "description": "Optional attributes"
3031
- },
3032
- "title": {
3033
- "type": "string",
3034
- "minLength": 1,
3035
- "maxLength": 64,
3036
- "description": "Title of the interface. This is the name that will be displayed in the UI"
3037
- },
3038
- "description": {
3039
- "type": "string",
3040
- "maxLength": 256,
3041
- "description": "Description of the interface. This is the description that will be displayed in the UI"
3042
- },
3043
- "iconUrl": {
3044
- "type": "string",
3045
- "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
3046
- },
3047
- "readmeUrl": {
3048
- "type": "string",
3049
- "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
3050
- },
3051
- "public": {
3052
- "type": "boolean",
3053
- "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
3054
- }
3055
- },
3056
- "required": [
3057
- "id",
3058
- "createdAt",
3059
- "updatedAt",
3060
- "name",
3061
- "version",
3062
- "entities",
3063
- "events",
3064
- "actions",
3065
- "channels",
3066
- "title",
3067
- "description",
3068
- "iconUrl",
3069
- "readmeUrl",
3070
- "public"
3071
- ],
3072
- "additionalProperties": false
3073
- }
3074
- },
3075
- "Plugin": {
3076
- "section": "plugin",
3077
- "schema": {
3078
- "type": "object",
3079
- "properties": {
3080
- "id": {
3081
- "type": "string",
3082
- "minLength": 28,
3083
- "maxLength": 36,
3084
- "description": "ID of the [Plugin](#schema_plugin)"
3085
- },
3086
- "name": {
3087
- "type": "string",
3088
- "maxLength": 200,
3089
- "description": "Name of the [Plugin](#schema_plugin)"
3090
- },
3091
- "version": {
3092
- "type": "string",
3093
- "maxLength": 200,
3094
- "description": "Version of the [Plugin](#schema_plugin)"
3095
- },
3096
- "createdAt": {
3097
- "type": "string",
3098
- "format": "date-time",
3099
- "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
3100
- },
3101
- "updatedAt": {
3102
- "type": "string",
3103
- "format": "date-time",
3104
- "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
3105
- },
3106
- "configuration": {
3107
- "type": "object",
3108
- "properties": {
3109
- "title": {
3110
- "type": "string",
3111
- "maxLength": 64,
3112
- "description": "Title of the configuration"
3113
- },
3114
- "description": {
3115
- "type": "string",
3116
- "maxLength": 256,
3117
- "description": "Description of the configuration"
3118
- },
3119
- "schema": {
3120
- "type": "object",
3121
- "additionalProperties": true,
3122
- "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
3123
- }
3124
- },
3125
- "required": [
3126
- "schema"
3127
- ],
3128
- "description": "Configuration definition",
3129
- "additionalProperties": false
3130
- },
3131
- "states": {
3132
- "type": "object",
3133
- "additionalProperties": {
3134
- "type": "object",
3135
- "properties": {
3136
- "type": {
3137
- "type": "string",
3138
- "enum": [
3139
- "conversation",
3140
- "user",
3141
- "bot",
3142
- "task"
3143
- ],
3144
- "description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
3145
- },
3146
- "schema": {
3147
- "type": "object",
3148
- "additionalProperties": true,
3149
- "description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
3150
- },
3151
- "expiry": {
3152
- "type": "number",
3153
- "minimum": 1,
3154
- "description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
3155
- }
3156
- },
3157
- "required": [
3158
- "type",
3159
- "schema"
3160
- ],
3161
- "additionalProperties": false
3162
- }
3163
- },
3164
- "events": {
3165
- "type": "object",
3166
- "additionalProperties": {
3167
- "type": "object",
3168
- "properties": {
3169
- "title": {
3170
- "type": "string",
3171
- "maxLength": 64,
3172
- "description": "Title of the event"
3173
- },
3174
- "description": {
3175
- "type": "string",
3176
- "maxLength": 256,
3177
- "description": "Description of the event"
3178
- },
3179
- "schema": {
3180
- "type": "object",
3181
- "additionalProperties": true
3182
- },
3183
- "attributes": {
3184
- "type": "object",
3185
- "additionalProperties": {
3186
- "type": "string",
3187
- "maxLength": 200
3188
- },
3189
- "description": "Optional attributes"
3190
- }
3191
- },
3192
- "required": [
3193
- "schema"
3194
- ],
3195
- "description": "Event Definition",
3196
- "additionalProperties": false
3197
- }
3198
- },
3199
- "actions": {
3200
- "type": "object",
3201
- "additionalProperties": {
3202
- "type": "object",
3203
- "properties": {
3204
- "title": {
3205
- "type": "string",
3206
- "maxLength": 64,
3207
- "description": "Title of the action"
3208
- },
3209
- "description": {
3210
- "type": "string",
3211
- "maxLength": 256,
3212
- "description": "Description of the action"
3213
- },
3214
- "billable": {
3215
- "type": "boolean"
3216
- },
3217
- "cacheable": {
3218
- "type": "boolean"
3219
- },
3220
- "input": {
3221
- "type": "object",
3222
- "properties": {
3223
- "schema": {
3224
- "type": "object",
3225
- "additionalProperties": true
3226
- }
3227
- },
3228
- "required": [
3229
- "schema"
3230
- ],
3231
- "additionalProperties": false
3232
- },
3233
- "output": {
3234
- "type": "object",
3235
- "properties": {
3236
- "schema": {
3237
- "type": "object",
3238
- "additionalProperties": true
3239
- }
3240
- },
3241
- "required": [
3242
- "schema"
3243
- ],
3244
- "additionalProperties": false
3245
- },
3246
- "attributes": {
3247
- "type": "object",
3248
- "additionalProperties": {
3249
- "type": "string",
3250
- "maxLength": 200
3251
- },
3252
- "description": "Optional attributes"
3253
- }
3254
- },
3255
- "required": [
3256
- "input",
3257
- "output"
3258
- ],
3259
- "description": "Action definition",
3260
- "additionalProperties": false
3261
- }
3262
- },
3263
- "dependencies": {
3264
- "type": "object",
3265
- "properties": {
3266
- "interfaces": {
3267
- "type": "object",
3268
- "additionalProperties": {
3269
- "type": "object",
3270
- "properties": {
3271
- "id": {
3272
- "type": "string",
3273
- "minLength": 28,
3274
- "maxLength": 36
3275
- },
3276
- "name": {
3277
- "type": "string",
3278
- "maxLength": 200
3279
- },
3280
- "version": {
3281
- "type": "string",
3282
- "maxLength": 200
3283
- }
3284
- },
3285
- "required": [
3286
- "id",
3287
- "name",
3288
- "version"
3289
- ],
3290
- "additionalProperties": false
3291
- }
3292
- },
3293
- "integrations": {
3294
- "type": "object",
3295
- "additionalProperties": {
3296
- "type": "object",
3297
- "properties": {
3298
- "id": {
3299
- "type": "string",
3300
- "minLength": 28,
3301
- "maxLength": 36
3302
- },
3303
- "name": {
3304
- "type": "string",
3305
- "maxLength": 200
3306
- },
3307
- "version": {
3308
- "type": "string",
3309
- "maxLength": 200
3310
- }
3311
- },
3312
- "required": [
3313
- "id",
3314
- "name",
3315
- "version"
3316
- ],
3317
- "additionalProperties": false
3318
- }
3319
- }
3320
- },
3321
- "required": [
3322
- "interfaces",
3323
- "integrations"
3324
- ],
3325
- "additionalProperties": false
3326
- },
3327
- "user": {
3328
- "type": "object",
3329
- "properties": {
3330
- "tags": {
3331
- "type": "object",
3332
- "additionalProperties": {
3333
- "type": "object",
3334
- "properties": {
3335
- "title": {
3336
- "type": "string",
3337
- "maxLength": 64,
3338
- "description": "Title of the tag"
3339
- },
3340
- "description": {
3341
- "type": "string",
3342
- "maxLength": 256,
3343
- "description": "Description of the tag"
3344
- }
3345
- },
3346
- "description": "Definition of a tag that can be provided on the object",
3347
- "additionalProperties": false
3348
- }
3349
- }
3350
- },
3351
- "required": [
3352
- "tags"
3353
- ],
3354
- "description": "User object configuration",
3355
- "additionalProperties": false
3356
- },
3357
- "conversation": {
3358
- "type": "object",
3359
- "properties": {
3360
- "tags": {
3361
- "type": "object",
3362
- "additionalProperties": {
3363
- "type": "object",
3364
- "properties": {
3365
- "title": {
3366
- "type": "string",
3367
- "maxLength": 64,
3368
- "description": "Title of the tag"
3369
- },
3370
- "description": {
3371
- "type": "string",
3372
- "maxLength": 256,
3373
- "description": "Description of the tag"
3374
- }
3375
- },
3376
- "description": "Definition of a tag that can be provided on the object",
3377
- "additionalProperties": false
3378
- }
3379
- }
3380
- },
3381
- "required": [
3382
- "tags"
3383
- ],
3384
- "description": "Conversation object configuration",
3385
- "additionalProperties": false
3386
- },
3387
- "attributes": {
3388
- "type": "object",
3389
- "additionalProperties": {
3390
- "type": "string",
3391
- "maxLength": 200
3392
- },
3393
- "description": "Optional attributes"
3394
- },
3395
- "title": {
3396
- "type": "string",
3397
- "minLength": 1,
3398
- "maxLength": 64,
3399
- "description": "Title of the plugin. This is the name that will be displayed in the UI"
3400
- },
3401
- "description": {
3402
- "type": "string",
3403
- "maxLength": 256,
3404
- "description": "Description of the plugin. This is the description that will be displayed in the UI"
3405
- },
3406
- "iconUrl": {
3407
- "type": "string",
3408
- "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
3409
- },
3410
- "readmeUrl": {
3411
- "type": "string",
3412
- "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
3413
- },
3414
- "public": {
3415
- "type": "boolean",
3416
- "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
3417
- }
3418
- },
3419
- "required": [
3420
- "id",
3421
- "name",
3422
- "version",
3423
- "createdAt",
3424
- "updatedAt",
3425
- "configuration",
3426
- "states",
3427
- "events",
3428
- "actions",
3429
- "dependencies",
3430
- "user",
3431
- "conversation",
3432
- "title",
3433
- "description",
3434
- "iconUrl",
3435
- "readmeUrl",
3436
- "public"
3437
- ],
3438
- "additionalProperties": false
3439
- }
3440
- },
3441
- "Workspace": {
3442
- "section": "workspace",
3443
- "schema": {
3444
- "type": "object",
3445
- "properties": {
3446
- "id": {
3447
- "type": "string"
3448
- },
3449
- "name": {
3450
- "type": "string"
3451
- },
3452
- "ownerId": {
3453
- "type": "string"
3454
- },
3455
- "createdAt": {
3456
- "type": "string"
3457
- },
3458
- "updatedAt": {
3459
- "type": "string"
3460
- },
3461
- "botCount": {
3462
- "type": "number"
3463
- },
3464
- "billingVersion": {
3465
- "type": "string",
3466
- "enum": [
3467
- "v1",
3468
- "v2",
3469
- "v3"
3470
- ]
3471
- },
3472
- "plan": {
3473
- "type": "string",
3474
- "enum": [
3475
- "community",
3476
- "team",
3477
- "enterprise",
3478
- "plus"
3479
- ]
3480
- },
3481
- "blocked": {
3482
- "type": "boolean"
3483
- },
3484
- "spendingLimit": {
3485
- "type": "number"
3486
- },
3487
- "about": {
3488
- "default": "",
3489
- "type": "string"
3490
- },
3491
- "profilePicture": {
3492
- "default": "",
3493
- "type": "string"
3494
- },
3495
- "contactEmail": {
3496
- "default": "",
3497
- "type": "string"
3498
- },
3499
- "website": {
3500
- "default": "",
3501
- "type": "string"
3502
- },
3503
- "socialAccounts": {
3504
- "default": [],
3505
- "type": "array",
3506
- "items": {
3507
- "type": "string"
3508
- }
3509
- },
3510
- "isPublic": {
3511
- "type": "boolean"
3512
- },
3513
- "handle": {
3514
- "type": "string"
3515
- },
3516
- "activeTrialId": {
3517
- "type": "string",
3518
- "nullable": true
3519
- }
3520
- },
3521
- "required": [
3522
- "id",
3523
- "name",
3524
- "ownerId",
3525
- "createdAt",
3526
- "updatedAt",
3527
- "botCount",
3528
- "billingVersion",
3529
- "plan",
3530
- "blocked",
3531
- "spendingLimit",
3532
- "activeTrialId"
3533
- ],
3534
- "title": "updateWorkspaceResponse",
3535
- "additionalProperties": false
3536
- }
3537
- },
3538
- "WorkspaceMember": {
3539
- "section": "workspaceMember",
3540
- "schema": {
3541
- "type": "object",
3542
- "properties": {
3543
- "id": {
3544
- "type": "string"
3545
- },
3546
- "userId": {
3547
- "type": "string",
3548
- "format": "uuid"
3549
- },
3550
- "email": {
3551
- "type": "string"
3552
- },
3553
- "createdAt": {
3554
- "type": "string"
3555
- },
3556
- "role": {
3557
- "type": "string",
3558
- "enum": [
3559
- "viewer",
3560
- "billing",
3561
- "developer",
3562
- "manager",
3563
- "administrator",
3564
- "owner"
3565
- ]
3566
- },
3567
- "profilePicture": {
3568
- "type": "string"
3569
- },
3570
- "displayName": {
3571
- "type": "string",
3572
- "maxLength": 100
3573
- }
3574
- },
3575
- "required": [
3576
- "id",
3577
- "email",
3578
- "createdAt",
3579
- "role"
3580
- ],
3581
- "title": "updateWorkspaceMemberResponse",
3582
- "additionalProperties": false
3583
- }
3584
- },
3585
- "Account": {
3586
- "section": "account",
3587
- "schema": {
3588
- "type": "object",
3589
- "properties": {
3590
- "id": {
3591
- "type": "string"
3592
- },
3593
- "email": {
3594
- "type": "string"
3595
- },
3596
- "displayName": {
3597
- "type": "string",
3598
- "maxLength": 100
3599
- },
3600
- "emailVerified": {
3601
- "type": "boolean"
3602
- },
3603
- "profilePicture": {
3604
- "type": "string"
3605
- },
3606
- "createdAt": {
3607
- "type": "string",
3608
- "format": "date-time",
3609
- "description": "Creation date of the [Account](#schema_account) in ISO 8601 format"
3610
- }
3611
- },
3612
- "required": [
3613
- "id",
3614
- "email",
3615
- "emailVerified",
3616
- "createdAt"
3617
- ],
3618
- "additionalProperties": false
3619
- }
3620
- },
3621
- "Usage": {
3622
- "section": "usage",
3623
- "schema": {
3624
- "type": "object",
3625
- "properties": {
3626
- "id": {
3627
- "type": "string",
3628
- "description": "Id of the usage that it is linked to. It can either be a workspace id or a bot id"
3629
- },
3630
- "period": {
3631
- "type": "string",
3632
- "description": "Period of the quota that it is applied to"
3633
- },
3634
- "value": {
3635
- "type": "number",
3636
- "description": "Value of the current usage"
3637
- },
3638
- "quota": {
3639
- "type": "number",
3640
- "description": "Quota of the current usage"
3641
- },
3642
- "type": {
3643
- "type": "string",
3644
- "enum": [
3645
- "invocation_timeout",
3646
- "invocation_calls",
3647
- "storage_count",
3648
- "bot_count",
3649
- "knowledgebase_vector_storage",
3650
- "workspace_ratelimit",
3651
- "table_row_count",
3652
- "workspace_member_count",
3653
- "integrations_owned_count",
3654
- "ai_spend",
3655
- "openai_spend",
3656
- "bing_search_spend",
3657
- "always_alive"
3658
- ],
3659
- "description": "Usage type that can be used"
3660
- }
3661
- },
3662
- "required": [
3663
- "id",
3664
- "period",
3665
- "value",
3666
- "quota",
3667
- "type"
3668
- ],
3669
- "additionalProperties": false
3670
- }
3671
- },
3672
- "Issue": {
3673
- "section": "bot",
3674
- "schema": {
3675
- "type": "object",
3676
- "properties": {
3677
- "id": {
3678
- "type": "string"
3679
- },
3680
- "code": {
3681
- "type": "string"
3682
- },
3683
- "createdAt": {
3684
- "type": "string",
3685
- "format": "date-time"
3686
- },
3687
- "lastSeenAt": {
3688
- "type": "string",
3689
- "format": "date-time"
3690
- },
3691
- "title": {
3692
- "type": "string"
3693
- },
3694
- "description": {
3695
- "type": "string"
3696
- },
3697
- "groupedData": {
3698
- "type": "object",
3699
- "additionalProperties": {
3700
- "type": "object",
3701
- "properties": {
3702
- "raw": {
3703
- "type": "string"
3704
- },
3705
- "pretty": {
3706
- "type": "string"
3707
- }
3708
- },
3709
- "required": [
3710
- "raw"
3711
- ],
3712
- "additionalProperties": false
3713
- }
3714
- },
3715
- "eventsCount": {
3716
- "type": "number"
3717
- },
3718
- "category": {
3719
- "type": "string",
3720
- "enum": [
3721
- "user_code",
3722
- "limits",
3723
- "configuration",
3724
- "other"
3725
- ]
3726
- },
3727
- "resolutionLink": {
3728
- "type": "string",
3729
- "nullable": true
3730
- }
3731
- },
3732
- "required": [
3733
- "id",
3734
- "code",
3735
- "createdAt",
3736
- "lastSeenAt",
3737
- "title",
3738
- "description",
3739
- "groupedData",
3740
- "eventsCount",
3741
- "category",
3742
- "resolutionLink"
3743
- ],
3744
- "additionalProperties": false
3745
- }
3746
- },
3747
- "IssueEvent": {
3748
- "section": "bot",
3749
- "schema": {
3750
- "type": "object",
3751
- "properties": {
3752
- "id": {
3753
- "type": "string"
3754
- },
3755
- "createdAt": {
3756
- "type": "string",
3757
- "format": "date-time"
3758
- },
3759
- "data": {
3760
- "type": "object",
3761
- "additionalProperties": {
3762
- "type": "object",
3763
- "properties": {
3764
- "raw": {
3765
- "type": "string"
3766
- },
3767
- "pretty": {
3768
- "type": "string"
3769
- }
3770
- },
3771
- "required": [
3772
- "raw"
3773
- ],
3774
- "additionalProperties": false
3775
- }
3776
- }
3777
- },
3778
- "required": [
3779
- "id",
3780
- "createdAt",
3781
- "data"
3782
- ],
3783
- "additionalProperties": false
3784
- }
3785
- },
3786
- "Activity": {
3787
- "section": "activity",
3788
- "schema": {
3789
- "type": "object",
3790
- "properties": {
3791
- "id": {
3792
- "type": "string"
3793
- },
3794
- "description": {
3795
- "type": "string"
3796
- },
3797
- "taskId": {
3798
- "type": "string"
3799
- },
3800
- "category": {
3801
- "type": "string",
3802
- "enum": [
3803
- "unknown",
3804
- "capture",
3805
- "bot_message",
3806
- "user_message",
3807
- "agent_message",
3808
- "event",
3809
- "action",
3810
- "task_status",
3811
- "subtask_status",
3812
- "exception"
3813
- ]
3814
- },
3815
- "data": {
3816
- "type": "object",
3817
- "additionalProperties": true
3818
- },
3819
- "createdAt": {
3820
- "type": "string",
3821
- "format": "date-time",
3822
- "description": "Creation date of the activity in ISO 8601 format"
3823
- }
3824
- },
3825
- "required": [
3826
- "id",
3827
- "description",
3828
- "taskId",
3829
- "category",
3830
- "data",
3831
- "createdAt"
3832
- ],
3833
- "additionalProperties": false
3834
- }
3835
- },
3836
- "Version": {
3837
- "section": "bot",
3838
- "schema": {
3839
- "type": "object",
3840
- "properties": {
3841
- "id": {
3842
- "type": "string"
3843
- },
3844
- "name": {
3845
- "type": "string"
3846
- },
3847
- "description": {
3848
- "type": "string"
3849
- }
3850
- },
3851
- "required": [
3852
- "id",
3853
- "name"
3854
- ],
3855
- "additionalProperties": false
3856
- }
3857
- },
3858
- "User": {
3859
- "section": "user",
3860
- "schema": {
3861
- "type": "object",
3862
- "properties": {
3863
- "id": {
3864
- "type": "string",
3865
- "minLength": 28,
3866
- "maxLength": 36,
3867
- "description": "Id of the [User](#schema_user)"
3868
- },
3869
- "createdAt": {
3870
- "type": "string",
3871
- "format": "date-time",
3872
- "description": "Creation date of the [User](#schema_user) in ISO 8601 format"
3873
- },
3874
- "updatedAt": {
3875
- "type": "string",
3876
- "format": "date-time",
3877
- "description": "Updating date of the [User](#schema_user) in ISO 8601 format"
3878
- },
3879
- "tags": {
3880
- "type": "object",
3881
- "additionalProperties": {
3882
- "type": "string"
3883
- },
3884
- "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [User](#schema_user). The set of [Tags](/docs/developers/concepts/tags) available on a [User](#schema_user) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them."
3885
- },
3886
- "name": {
3887
- "type": "string",
3888
- "maxLength": 200,
3889
- "description": "Name of the [User](#schema_user)"
3890
- },
3891
- "pictureUrl": {
3892
- "type": "string",
3893
- "maxLength": 40000,
3894
- "description": "Picture URL of the [User](#schema_user)"
3895
- }
3896
- },
3897
- "required": [
3898
- "id",
3899
- "createdAt",
3900
- "updatedAt",
3901
- "tags"
3902
- ],
3903
- "description": "The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.",
3904
- "additionalProperties": false
3905
- }
3906
- },
3907
- "Conversation": {
3908
- "section": "conversation",
3909
- "schema": {
3910
- "type": "object",
3911
- "properties": {
3912
- "id": {
3913
- "type": "string",
3914
- "minLength": 28,
3915
- "maxLength": 36,
3916
- "description": "Id of the [Conversation](#schema_conversation)"
3917
- },
3918
- "currentTaskId": {
3919
- "type": "string",
3920
- "minLength": 28,
3921
- "maxLength": 36,
3922
- "description": "Id of the current [Task](#schema_task)"
3923
- },
3924
- "currentWorkflowId": {
3925
- "type": "string",
3926
- "minLength": 28,
3927
- "maxLength": 36,
3928
- "description": "Id of the current [Workflow](#schema_workflow)"
3929
- },
3930
- "createdAt": {
3931
- "type": "string",
3932
- "format": "date-time",
3933
- "description": "Creation date of the [Conversation](#schema_conversation) in ISO 8601 format"
3934
- },
3935
- "updatedAt": {
3936
- "type": "string",
3937
- "format": "date-time",
3938
- "description": "Updating date of the [Conversation](#schema_conversation) in ISO 8601 format"
3939
- },
3940
- "channel": {
3941
- "type": "string",
3942
- "description": "Name of the channel where the [Conversation](#schema_conversation) is happening"
3943
- },
3944
- "integration": {
3945
- "type": "string",
3946
- "description": "Name of the integration that created the [Conversation](#schema_conversation)"
3947
- },
3948
- "tags": {
3949
- "type": "object",
3950
- "additionalProperties": {
3951
- "type": "string"
3952
- },
3953
- "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them."
3954
- }
3955
- },
3956
- "required": [
3957
- "id",
3958
- "createdAt",
3959
- "updatedAt",
3960
- "channel",
3961
- "integration",
3962
- "tags"
3963
- ],
3964
- "description": "The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.",
3965
- "additionalProperties": false
3966
- }
3967
- },
3968
- "Event": {
3969
- "section": "event",
3970
- "schema": {
3971
- "type": "object",
3972
- "properties": {
3973
- "id": {
3974
- "type": "string",
3975
- "minLength": 28,
3976
- "maxLength": 36,
3977
- "description": "Id of the [Event](#schema_event)"
3978
- },
3979
- "createdAt": {
3980
- "type": "string",
3981
- "format": "date-time",
3982
- "description": "Creation date of the [Event](#schema_event) in ISO 8601 format"
3983
- },
3984
- "type": {
3985
- "type": "string",
3986
- "maxLength": 200,
3987
- "description": "Type of the [Event](#schema_event)."
3988
- },
3989
- "payload": {
3990
- "type": "object",
3991
- "additionalProperties": true,
3992
- "description": "Payload is the content of the event defined by the integration installed on your bot or one of the default events created by our api."
3993
- },
3994
- "conversationId": {
3995
- "type": "string",
3996
- "minLength": 28,
3997
- "maxLength": 36,
3998
- "description": "ID of the [Conversation](#schema_conversation) to link the event to."
3999
- },
4000
- "userId": {
4001
- "type": "string",
4002
- "minLength": 28,
4003
- "maxLength": 36,
4004
- "description": "ID of the [User](#schema_user) to link the event to."
4005
- },
4006
- "messageId": {
4007
- "type": "string",
4008
- "minLength": 28,
4009
- "maxLength": 36,
4010
- "description": "ID of the [Message](#schema_message) to link the event to."
4011
- },
4012
- "status": {
4013
- "type": "string",
4014
- "enum": [
4015
- "pending",
4016
- "processed",
4017
- "ignored",
4018
- "failed",
4019
- "scheduled"
4020
- ]
4021
- },
4022
- "failureReason": {
4023
- "type": "string",
4024
- "maxLength": 2000,
4025
- "nullable": true,
4026
- "description": "Reason why the event failed to be processed"
4027
- }
4028
- },
4029
- "required": [
4030
- "id",
4031
- "createdAt",
4032
- "type",
4033
- "payload",
4034
- "status",
4035
- "failureReason"
4036
- ],
4037
- "description": "The event object represents an action or an occurrence.",
4038
- "additionalProperties": false
4039
- }
4040
- },
4041
- "Message": {
4042
- "section": "message",
4043
- "schema": {
4044
- "type": "object",
4045
- "properties": {
4046
- "id": {
4047
- "type": "string",
4048
- "minLength": 28,
4049
- "maxLength": 36,
4050
- "description": "Id of the [Message](#schema_message)"
4051
- },
4052
- "createdAt": {
4053
- "type": "string",
4054
- "format": "date-time",
4055
- "description": "Creation date of the [Message](#schema_message) in ISO 8601 format"
4056
- },
4057
- "updatedAt": {
4058
- "type": "string",
4059
- "format": "date-time",
4060
- "description": "Update date of the [Message](#schema_message) in ISO 8601 format"
4061
- },
4062
- "type": {
4063
- "type": "string",
4064
- "maxLength": 200,
4065
- "description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
4066
- },
4067
- "payload": {
4068
- "type": "object",
4069
- "additionalProperties": true,
4070
- "description": "Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location"
4071
- },
4072
- "direction": {
4073
- "type": "string",
4074
- "enum": [
4075
- "incoming",
4076
- "outgoing"
4077
- ],
4078
- "description": "Direction of the message (`incoming` or `outgoing`)."
4079
- },
4080
- "userId": {
4081
- "type": "string",
4082
- "minLength": 28,
4083
- "maxLength": 36,
4084
- "description": "ID of the [User](#schema_user)"
4085
- },
4086
- "conversationId": {
4087
- "type": "string",
4088
- "minLength": 28,
4089
- "maxLength": 36,
4090
- "description": "ID of the [Conversation](#schema_conversation)"
4091
- },
4092
- "tags": {
4093
- "type": "object",
4094
- "additionalProperties": {
4095
- "type": "string"
4096
- },
4097
- "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them."
4098
- },
4099
- "origin": {
4100
- "type": "string",
4101
- "enum": [
4102
- "synthetic"
4103
- ],
4104
- "description": "Origin of the message (`synthetic`)."
4105
- }
4106
- },
4107
- "required": [
4108
- "id",
4109
- "createdAt",
4110
- "updatedAt",
4111
- "type",
4112
- "payload",
4113
- "direction",
4114
- "userId",
4115
- "conversationId",
4116
- "tags"
4117
- ],
4118
- "description": "The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).",
4119
- "additionalProperties": false
4120
- }
4121
- },
4122
- "State": {
4123
- "section": "state",
4124
- "schema": {
4125
- "type": "object",
4126
- "properties": {
4127
- "id": {
4128
- "type": "string",
4129
- "minLength": 28,
4130
- "maxLength": 36,
4131
- "description": "Id of the [State](#schema_state)"
4132
- },
4133
- "createdAt": {
4134
- "type": "string",
4135
- "format": "date-time",
4136
- "description": "Creation date of the [State](#schema_state) in ISO 8601 format"
4137
- },
4138
- "updatedAt": {
4139
- "type": "string",
4140
- "format": "date-time",
4141
- "description": "Updating date of the [State](#schema_state) in ISO 8601 format"
4142
- },
4143
- "botId": {
4144
- "type": "string",
4145
- "minLength": 28,
4146
- "maxLength": 36,
4147
- "description": "Id of the [Bot](#schema_bot)"
4148
- },
4149
- "conversationId": {
4150
- "type": "string",
4151
- "minLength": 28,
4152
- "maxLength": 36,
4153
- "description": "Id of the [Conversation](#schema_conversation)"
4154
- },
4155
- "userId": {
4156
- "type": "string",
4157
- "minLength": 28,
4158
- "maxLength": 36,
4159
- "description": "Id of the [User](#schema_user)"
4160
- },
4161
- "name": {
4162
- "type": "string",
4163
- "maxLength": 200,
4164
- "description": "Name of the [State](#schema_state) which is declared inside the bot definition"
4165
- },
4166
- "type": {
4167
- "type": "string",
4168
- "enum": [
4169
- "conversation",
4170
- "user",
4171
- "bot",
4172
- "task",
4173
- "integration",
4174
- "workflow"
4175
- ],
4176
- "description": "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to"
4177
- },
4178
- "payload": {
4179
- "type": "object",
4180
- "additionalProperties": true,
4181
- "description": "Payload is the content of the state defined by your bot."
4182
- }
4183
- },
4184
- "required": [
4185
- "id",
4186
- "createdAt",
4187
- "updatedAt",
4188
- "botId",
4189
- "name",
4190
- "type",
4191
- "payload"
4192
- ],
4193
- "description": "The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.",
4194
- "additionalProperties": false
4195
- }
4196
- },
4197
- "Task": {
4198
- "section": "task",
4199
- "schema": {
4200
- "type": "object",
4201
- "properties": {
4202
- "id": {
4203
- "type": "string",
4204
- "minLength": 28,
4205
- "maxLength": 36,
4206
- "description": "Id of the [Task](#schema_task)"
4207
- },
4208
- "title": {
4209
- "type": "string",
4210
- "maxLength": 64,
4211
- "description": "Title describing the task"
4212
- },
4213
- "description": {
4214
- "type": "string",
4215
- "maxLength": 256,
4216
- "description": "All the notes related to the execution of the current task"
4217
- },
4218
- "type": {
4219
- "type": "string",
4220
- "description": "Type of the task"
4221
- },
4222
- "data": {
4223
- "type": "object",
4224
- "additionalProperties": true,
4225
- "description": "Content related to the task"
4226
- },
4227
- "status": {
4228
- "type": "string",
4229
- "enum": [
4230
- "pending",
4231
- "in_progress",
4232
- "failed",
4233
- "completed",
4234
- "blocked",
4235
- "paused",
4236
- "timeout",
4237
- "cancelled"
4238
- ],
4239
- "description": "Status of the task"
4240
- },
4241
- "parentTaskId": {
4242
- "type": "string",
4243
- "minLength": 28,
4244
- "maxLength": 36,
4245
- "description": "Parent task id is the parent task that created this task"
4246
- },
4247
- "conversationId": {
4248
- "type": "string",
4249
- "minLength": 28,
4250
- "maxLength": 36,
4251
- "description": "Conversation id related to this task"
4252
- },
4253
- "userId": {
4254
- "type": "string",
4255
- "minLength": 28,
4256
- "maxLength": 36,
4257
- "description": "Specific user related to this task"
4258
- },
4259
- "timeoutAt": {
4260
- "type": "string",
4261
- "format": "date-time",
4262
- "description": "The timeout date where the task should be failed in the ISO 8601 format"
4263
- },
4264
- "createdAt": {
4265
- "type": "string",
4266
- "format": "date-time",
4267
- "description": "Creation date of the task in ISO 8601 format"
4268
- },
4269
- "updatedAt": {
4270
- "type": "string",
4271
- "format": "date-time",
4272
- "description": "Updating date of the task in ISO 8601 format"
4273
- },
4274
- "failureReason": {
4275
- "type": "string",
4276
- "maxLength": 2000,
4277
- "description": "If the task fails this is the reason behind it"
4278
- },
4279
- "tags": {
4280
- "type": "object",
4281
- "additionalProperties": {
4282
- "type": "string"
4283
- },
4284
- "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them."
4285
- }
4286
- },
4287
- "required": [
4288
- "id",
4289
- "title",
4290
- "description",
4291
- "type",
4292
- "data",
4293
- "status",
4294
- "timeoutAt",
4295
- "createdAt",
4296
- "updatedAt",
4297
- "tags"
4298
- ],
4299
- "description": "Task definition",
4300
- "additionalProperties": false
4301
- }
1313
+ {
1314
+ "status": 400,
1315
+ "type": "ReferenceNotFound",
1316
+ "description": "The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."
4302
1317
  },
4303
- "Workflow": {
4304
- "section": "workflow",
4305
- "schema": {
4306
- "type": "object",
4307
- "properties": {
4308
- "id": {
4309
- "type": "string",
4310
- "minLength": 28,
4311
- "maxLength": 36,
4312
- "description": "Id of the [Workflow](#schema_workflow)"
4313
- },
4314
- "name": {
4315
- "type": "string",
4316
- "maxLength": 200,
4317
- "description": "Name of the workflow"
4318
- },
4319
- "status": {
4320
- "type": "string",
4321
- "enum": [
4322
- "pending",
4323
- "in_progress",
4324
- "failed",
4325
- "completed",
4326
- "listening",
4327
- "paused",
4328
- "timedout",
4329
- "cancelled"
4330
- ],
4331
- "description": "Status of the [Workflow](#schema_workflow)"
4332
- },
4333
- "input": {
4334
- "type": "object",
4335
- "additionalProperties": true,
4336
- "description": "Input provided to the [Workflow](#schema_workflow)"
4337
- },
4338
- "output": {
4339
- "type": "object",
4340
- "additionalProperties": true,
4341
- "description": "Data returned by the [Workflow](#schema_workflow) output"
4342
- },
4343
- "parentWorkflowId": {
4344
- "type": "string",
4345
- "minLength": 28,
4346
- "maxLength": 36,
4347
- "description": "Parent [Workflow](#schema_workflow) id is the parent [Workflow](#schema_workflow) that created this [Workflow](#schema_workflow)"
4348
- },
4349
- "conversationId": {
4350
- "type": "string",
4351
- "minLength": 28,
4352
- "maxLength": 36,
4353
- "description": "Conversation id related to this [Workflow](#schema_workflow)"
4354
- },
4355
- "userId": {
4356
- "type": "string",
4357
- "minLength": 28,
4358
- "maxLength": 36,
4359
- "description": "User id related to this [Workflow](#schema_workflow)"
4360
- },
4361
- "createdAt": {
4362
- "type": "string",
4363
- "format": "date-time",
4364
- "description": "Creation date of the [Workflow](#schema_workflow) in ISO 8601 format"
4365
- },
4366
- "updatedAt": {
4367
- "type": "string",
4368
- "format": "date-time",
4369
- "description": "Updating date of the [Workflow](#schema_workflow) in ISO 8601 format"
4370
- },
4371
- "completedAt": {
4372
- "type": "string",
4373
- "format": "date-time",
4374
- "description": "The date when the [Workflow](#schema_workflow) completed in ISO 8601 format"
4375
- },
4376
- "failureReason": {
4377
- "type": "string",
4378
- "maxLength": 2000,
4379
- "description": "If the [Workflow](#schema_workflow) fails this is the reason behind it"
4380
- },
4381
- "timeoutAt": {
4382
- "type": "string",
4383
- "format": "date-time",
4384
- "description": "The timeout date when the [Workflow](#schema_workflow) will fail in the ISO 8601 format"
4385
- },
4386
- "tags": {
4387
- "type": "object",
4388
- "additionalProperties": {
4389
- "type": "string"
4390
- },
4391
- "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Workflow](#schema_workflow). Individual keys can be unset by posting an empty value to them."
4392
- }
4393
- },
4394
- "required": [
4395
- "id",
4396
- "name",
4397
- "status",
4398
- "input",
4399
- "output",
4400
- "createdAt",
4401
- "updatedAt",
4402
- "timeoutAt",
4403
- "tags"
4404
- ],
4405
- "description": "Workflow definition",
4406
- "additionalProperties": false
4407
- }
1318
+ {
1319
+ "status": 400,
1320
+ "type": "InvalidQuery",
1321
+ "description": "The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."
1322
+ },
1323
+ {
1324
+ "status": 400,
1325
+ "type": "Runtime",
1326
+ "description": "An error happened during the execution of a runtime (bot or integration)."
1327
+ },
1328
+ {
1329
+ "status": 409,
1330
+ "type": "AlreadyExists",
1331
+ "description": "The record attempted to be created already exists."
1332
+ },
1333
+ {
1334
+ "status": 429,
1335
+ "type": "RateLimited",
1336
+ "description": "The request has been rate limited."
1337
+ },
1338
+ {
1339
+ "status": 402,
1340
+ "type": "PaymentRequired",
1341
+ "description": "A payment is required to perform this request."
1342
+ },
1343
+ {
1344
+ "status": 403,
1345
+ "type": "QuotaExceeded",
1346
+ "description": "The request exceeds the allowed quota. Quotas are a soft limit that can be increased."
1347
+ },
1348
+ {
1349
+ "status": 413,
1350
+ "type": "LimitExceeded",
1351
+ "description": "The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."
1352
+ },
1353
+ {
1354
+ "status": 400,
1355
+ "type": "BreakingChanges",
1356
+ "description": "Request payload contains breaking changes which is not allowed for this resource without a version increment."
1357
+ }
1358
+ ],
1359
+ "refs": {
1360
+ "parameters": {},
1361
+ "requestBodies": {
1362
+ "getOrCreateTableBody": true,
1363
+ "createTableBody": true,
1364
+ "duplicateTableBody": true,
1365
+ "importTableBody": true,
1366
+ "updateTableBody": true,
1367
+ "renameTableColumnBody": true,
1368
+ "findTableRowsBody": true,
1369
+ "createTableRowsBody": true,
1370
+ "deleteTableRowsBody": true,
1371
+ "updateTableRowsBody": true,
1372
+ "upsertTableRowsBody": true
1373
+ },
1374
+ "responses": {
1375
+ "listTablesResponse": true,
1376
+ "getTableResponse": true,
1377
+ "getOrCreateTableResponse": true,
1378
+ "createTableResponse": true,
1379
+ "duplicateTableResponse": true,
1380
+ "exportTableResponse": true,
1381
+ "getTableJobsResponse": true,
1382
+ "importTableResponse": true,
1383
+ "updateTableResponse": true,
1384
+ "renameTableColumnResponse": true,
1385
+ "deleteTableResponse": true,
1386
+ "getTableRowResponse": true,
1387
+ "findTableRowsResponse": true,
1388
+ "createTableRowsResponse": true,
1389
+ "deleteTableRowsResponse": true,
1390
+ "updateTableRowsResponse": true,
1391
+ "upsertTableRowsResponse": true
4408
1392
  },
1393
+ "schemas": {
1394
+ "Table": true,
1395
+ "Column": true,
1396
+ "Row": true
1397
+ }
1398
+ },
1399
+ "schemas": {
4409
1400
  "Table": {
4410
1401
  "section": "tables",
4411
1402
  "schema": {
@@ -4831,292 +1822,9 @@ export const state = {
4831
1822
  ],
4832
1823
  "additionalProperties": true
4833
1824
  }
4834
- },
4835
- "File": {
4836
- "section": "files",
4837
- "schema": {
4838
- "type": "object",
4839
- "properties": {
4840
- "id": {
4841
- "type": "string",
4842
- "description": "File ID"
4843
- },
4844
- "botId": {
4845
- "type": "string",
4846
- "description": "The ID of the bot the file belongs to"
4847
- },
4848
- "key": {
4849
- "type": "string",
4850
- "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
4851
- },
4852
- "url": {
4853
- "type": "string",
4854
- "description": "URL to retrieve the file content. This URL will be ready to use once the file is uploaded.\n\nIf the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe."
4855
- },
4856
- "size": {
4857
- "type": "number",
4858
- "description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
4859
- "nullable": true
4860
- },
4861
- "contentType": {
4862
- "type": "string",
4863
- "description": "MIME type of the file's content"
4864
- },
4865
- "tags": {
4866
- "type": "object",
4867
- "additionalProperties": {
4868
- "type": "string",
4869
- "maxLength": 1000
4870
- },
4871
- "description": "The tags of the file as an object of key/value pairs"
4872
- },
4873
- "metadata": {
4874
- "type": "object",
4875
- "additionalProperties": {
4876
- "nullable": true
4877
- },
4878
- "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
4879
- },
4880
- "createdAt": {
4881
- "type": "string",
4882
- "description": "File creation timestamp in ISO 8601 format"
4883
- },
4884
- "updatedAt": {
4885
- "type": "string",
4886
- "description": "File last update timestamp in ISO 8601 format"
4887
- },
4888
- "accessPolicies": {
4889
- "type": "array",
4890
- "items": {
4891
- "type": "string",
4892
- "enum": [
4893
- "integrations",
4894
- "public_content"
4895
- ]
4896
- },
4897
- "description": "Access policies configured for the file."
4898
- },
4899
- "index": {
4900
- "type": "boolean",
4901
- "description": "Whether the file was requested to be indexed for search or not."
4902
- },
4903
- "status": {
4904
- "type": "string",
4905
- "enum": [
4906
- "upload_pending",
4907
- "upload_failed",
4908
- "upload_completed",
4909
- "indexing_pending",
4910
- "indexing_failed",
4911
- "indexing_completed"
4912
- ],
4913
- "description": "Status of the file. If the status is `upload_pending`, the file content has not been uploaded yet. The status will be set to `upload_completed` once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to `upload_failed` and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the `indexing_pending` status (the `upload_completed` status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to `indexing_completed`. If the indexing failed the status will be set to `indexing_failed` and the reason for the failure will be available in the `failedStatusReason` field."
4914
- },
4915
- "failedStatusReason": {
4916
- "type": "string",
4917
- "description": "If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure."
4918
- },
4919
- "expiresAt": {
4920
- "type": "string",
4921
- "description": "File expiry timestamp in ISO 8601 format"
4922
- },
4923
- "owner": {
4924
- "type": "object",
4925
- "properties": {
4926
- "type": {
4927
- "type": "string",
4928
- "enum": [
4929
- "bot",
4930
- "integration",
4931
- "user"
4932
- ]
4933
- },
4934
- "id": {
4935
- "type": "string",
4936
- "description": "This field is present if `type` is \"user\" or \"bot\". If `type` is \"user\", this is the user ID. If `type` is \"bot\", this is the bot ID."
4937
- },
4938
- "name": {
4939
- "type": "string",
4940
- "description": "This field is present if the `type` is \"integration\". If `type` is \"integration\", this is the integration name."
4941
- }
4942
- },
4943
- "required": [
4944
- "type"
4945
- ],
4946
- "additionalProperties": false
4947
- },
4948
- "indexingStack": {
4949
- "type": "string",
4950
- "enum": [
4951
- "v1",
4952
- "v2"
4953
- ],
4954
- "description": "Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of \"v2\" denotes the latest stack, \"v1\" denotes the legacy stack."
4955
- }
4956
- },
4957
- "required": [
4958
- "id",
4959
- "botId",
4960
- "key",
4961
- "url",
4962
- "size",
4963
- "contentType",
4964
- "tags",
4965
- "metadata",
4966
- "createdAt",
4967
- "updatedAt",
4968
- "accessPolicies",
4969
- "index",
4970
- "status",
4971
- "owner"
4972
- ],
4973
- "additionalProperties": false
4974
- }
4975
1825
  }
4976
1826
  },
4977
1827
  "sections": [
4978
- {
4979
- "description": "",
4980
- "title": "User",
4981
- "name": "user",
4982
- "operations": [],
4983
- "schema": "User"
4984
- },
4985
- {
4986
- "description": "",
4987
- "title": "Conversation",
4988
- "name": "conversation",
4989
- "operations": [],
4990
- "schema": "Conversation"
4991
- },
4992
- {
4993
- "description": "",
4994
- "title": "Event",
4995
- "name": "event",
4996
- "operations": [],
4997
- "schema": "Event"
4998
- },
4999
- {
5000
- "description": "",
5001
- "title": "Message",
5002
- "name": "message",
5003
- "operations": [],
5004
- "schema": "Message"
5005
- },
5006
- {
5007
- "description": "",
5008
- "title": "State",
5009
- "name": "state",
5010
- "operations": [],
5011
- "schema": "State"
5012
- },
5013
- {
5014
- "title": "Hub",
5015
- "description": "",
5016
- "name": "hub",
5017
- "operations": []
5018
- },
5019
- {
5020
- "description": "",
5021
- "title": "Action",
5022
- "name": "action",
5023
- "operations": []
5024
- },
5025
- {
5026
- "description": "",
5027
- "title": "Task",
5028
- "name": "task",
5029
- "operations": [],
5030
- "schema": "Task"
5031
- },
5032
- {
5033
- "description": "",
5034
- "title": "Workflow",
5035
- "name": "workflow",
5036
- "operations": [],
5037
- "schema": "Workflow"
5038
- },
5039
- {
5040
- "description": "",
5041
- "title": "Tag",
5042
- "name": "tag",
5043
- "operations": []
5044
- },
5045
- {
5046
- "title": "Bot",
5047
- "description": "",
5048
- "name": "bot",
5049
- "operations": [],
5050
- "schema": "Bot"
5051
- },
5052
- {
5053
- "title": "Integration",
5054
- "description": "",
5055
- "name": "integration",
5056
- "operations": [],
5057
- "schema": "Integration"
5058
- },
5059
- {
5060
- "title": "Interface",
5061
- "description": "",
5062
- "name": "interface",
5063
- "operations": [],
5064
- "schema": "Interface"
5065
- },
5066
- {
5067
- "title": "Plugin",
5068
- "description": "",
5069
- "name": "plugin",
5070
- "operations": [],
5071
- "schema": "Plugin"
5072
- },
5073
- {
5074
- "title": "Workspace",
5075
- "description": "",
5076
- "name": "workspace",
5077
- "operations": [],
5078
- "schema": "Workspace"
5079
- },
5080
- {
5081
- "title": "Workspace Member",
5082
- "description": "",
5083
- "name": "workspaceMember",
5084
- "operations": [],
5085
- "schema": "WorkspaceMember"
5086
- },
5087
- {
5088
- "title": "Account",
5089
- "description": "",
5090
- "name": "account",
5091
- "operations": [],
5092
- "schema": "Account"
5093
- },
5094
- {
5095
- "title": "Usage",
5096
- "description": "",
5097
- "name": "usage",
5098
- "operations": [],
5099
- "schema": "Usage"
5100
- },
5101
- {
5102
- "title": "Quotas",
5103
- "description": "",
5104
- "name": "quotas",
5105
- "operations": []
5106
- },
5107
- {
5108
- "title": "Helper",
5109
- "description": "",
5110
- "name": "helper",
5111
- "operations": []
5112
- },
5113
- {
5114
- "title": "Activity",
5115
- "description": "",
5116
- "name": "activity",
5117
- "operations": [],
5118
- "schema": "Activity"
5119
- },
5120
1828
  {
5121
1829
  "title": "Tables",
5122
1830
  "description": "Manage and interact with table structures, including creation, updates, and querying of tables and their rows.",
@@ -5141,13 +1849,6 @@ export const state = {
5141
1849
  "upsertTableRows"
5142
1850
  ],
5143
1851
  "schema": "Table"
5144
- },
5145
- {
5146
- "title": "Files",
5147
- "description": "The Files API allows you to create, manage, and index files that can be used by your bots and integrations. Files can be in any text or binary format, and documents (such as PDF, Microsoft Word, HTML, Markdown, etc.) can be indexed to be used for semantic search in RAG (Retrieval Augmented Generation) implementations. Files are private by default but can be made publicly accessible through a permanent URL that's unique for each file.",
5148
- "name": "files",
5149
- "operations": [],
5150
- "schema": "File"
5151
1852
  }
5152
1853
  ],
5153
1854
  "options": {