@botpress/api 0.16.0 → 0.16.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +728 -67
- package/dist/src/gen/state.d.ts +661 -72
- package/dist/src/index.d.ts +2 -2
- package/package.json +2 -2
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +773 -98
package/src/gen/state.ts
CHANGED
|
@@ -11,11 +11,13 @@ export type State = opapi.State<
|
|
|
11
11
|
| "Usage"
|
|
12
12
|
| "Issue"
|
|
13
13
|
| "IssueEvent"
|
|
14
|
+
| "Activity"
|
|
14
15
|
| "User"
|
|
15
16
|
| "Conversation"
|
|
16
17
|
| "Event"
|
|
17
18
|
| "Message"
|
|
18
19
|
| "State"
|
|
20
|
+
| "Task"
|
|
19
21
|
| "File"
|
|
20
22
|
| "Table"
|
|
21
23
|
| "Column"
|
|
@@ -29,6 +31,7 @@ export type State = opapi.State<
|
|
|
29
31
|
| "state"
|
|
30
32
|
| "hub"
|
|
31
33
|
| "action"
|
|
34
|
+
| "task"
|
|
32
35
|
| "bot"
|
|
33
36
|
| "integration"
|
|
34
37
|
| "workspace"
|
|
@@ -37,6 +40,7 @@ export type State = opapi.State<
|
|
|
37
40
|
| "usage"
|
|
38
41
|
| "quotas"
|
|
39
42
|
| "helper"
|
|
43
|
+
| "activity"
|
|
40
44
|
| "tables"
|
|
41
45
|
>;
|
|
42
46
|
export const state = {
|
|
@@ -1533,6 +1537,316 @@ export const state = {
|
|
|
1533
1537
|
},
|
|
1534
1538
|
parameters: {},
|
|
1535
1539
|
},
|
|
1540
|
+
getTask: {
|
|
1541
|
+
name: "getTask",
|
|
1542
|
+
description:
|
|
1543
|
+
"Retrieves the [Task](#schema_task) object for a valid identifier.",
|
|
1544
|
+
method: "get",
|
|
1545
|
+
path: "/v1/chat/tasks/{id}",
|
|
1546
|
+
parameters: {
|
|
1547
|
+
id: {
|
|
1548
|
+
in: "path",
|
|
1549
|
+
type: "string",
|
|
1550
|
+
description: "Task id",
|
|
1551
|
+
},
|
|
1552
|
+
},
|
|
1553
|
+
section: "task",
|
|
1554
|
+
response: {
|
|
1555
|
+
description:
|
|
1556
|
+
"Returns a [Task](#schema_task) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
|
|
1557
|
+
schema: {
|
|
1558
|
+
type: "object",
|
|
1559
|
+
properties: {
|
|
1560
|
+
task: {
|
|
1561
|
+
$ref: "#/components/schemas/Task",
|
|
1562
|
+
},
|
|
1563
|
+
},
|
|
1564
|
+
required: ["task"],
|
|
1565
|
+
title: "getTaskResponse",
|
|
1566
|
+
additionalProperties: false,
|
|
1567
|
+
},
|
|
1568
|
+
},
|
|
1569
|
+
},
|
|
1570
|
+
createTask: {
|
|
1571
|
+
name: "createTask",
|
|
1572
|
+
description:
|
|
1573
|
+
"Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.",
|
|
1574
|
+
method: "post",
|
|
1575
|
+
path: "/v1/chat/tasks",
|
|
1576
|
+
requestBody: {
|
|
1577
|
+
description: "Task data",
|
|
1578
|
+
schema: {
|
|
1579
|
+
type: "object",
|
|
1580
|
+
properties: {
|
|
1581
|
+
title: {
|
|
1582
|
+
type: "string",
|
|
1583
|
+
maxLength: 2000,
|
|
1584
|
+
description: "Title describing the task",
|
|
1585
|
+
},
|
|
1586
|
+
description: {
|
|
1587
|
+
type: "string",
|
|
1588
|
+
maxLength: 20000,
|
|
1589
|
+
description:
|
|
1590
|
+
"All the notes related to the execution of the current task",
|
|
1591
|
+
},
|
|
1592
|
+
type: {
|
|
1593
|
+
type: "string",
|
|
1594
|
+
maxLength: 200,
|
|
1595
|
+
description:
|
|
1596
|
+
"Unique identifier of the integration that was installed on the bot",
|
|
1597
|
+
},
|
|
1598
|
+
data: {
|
|
1599
|
+
type: "object",
|
|
1600
|
+
additionalProperties: true,
|
|
1601
|
+
description: "Content related to the task",
|
|
1602
|
+
},
|
|
1603
|
+
parentTaskId: {
|
|
1604
|
+
type: "string",
|
|
1605
|
+
description:
|
|
1606
|
+
"Parent task id is the parent task that created this task",
|
|
1607
|
+
},
|
|
1608
|
+
conversationId: {
|
|
1609
|
+
type: "string",
|
|
1610
|
+
description: "Conversation id related to this task",
|
|
1611
|
+
},
|
|
1612
|
+
userId: {
|
|
1613
|
+
type: "string",
|
|
1614
|
+
description: "Specific user related to this task",
|
|
1615
|
+
},
|
|
1616
|
+
timeoutAt: {
|
|
1617
|
+
type: "string",
|
|
1618
|
+
format: "date-time",
|
|
1619
|
+
description:
|
|
1620
|
+
"The timeout date where the task should be failed in the ISO 8601 format",
|
|
1621
|
+
},
|
|
1622
|
+
tags: {
|
|
1623
|
+
type: "object",
|
|
1624
|
+
additionalProperties: {
|
|
1625
|
+
type: "string",
|
|
1626
|
+
maxLength: 500,
|
|
1627
|
+
},
|
|
1628
|
+
description: "Tags for the [Task](#schema_task)",
|
|
1629
|
+
},
|
|
1630
|
+
},
|
|
1631
|
+
required: ["type", "conversationId"],
|
|
1632
|
+
title: "createTaskBody",
|
|
1633
|
+
additionalProperties: false,
|
|
1634
|
+
},
|
|
1635
|
+
},
|
|
1636
|
+
section: "task",
|
|
1637
|
+
response: {
|
|
1638
|
+
description:
|
|
1639
|
+
"Returns a [Task](#schema_task) object if creation succeeds. Returns [an error](#errors) otherwise",
|
|
1640
|
+
status: 201,
|
|
1641
|
+
schema: {
|
|
1642
|
+
type: "object",
|
|
1643
|
+
properties: {
|
|
1644
|
+
task: {
|
|
1645
|
+
$ref: "#/components/schemas/Task",
|
|
1646
|
+
},
|
|
1647
|
+
},
|
|
1648
|
+
required: ["task"],
|
|
1649
|
+
title: "createTaskResponse",
|
|
1650
|
+
additionalProperties: false,
|
|
1651
|
+
},
|
|
1652
|
+
},
|
|
1653
|
+
parameters: {},
|
|
1654
|
+
},
|
|
1655
|
+
updateTask: {
|
|
1656
|
+
name: "updateTask",
|
|
1657
|
+
description:
|
|
1658
|
+
"Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.",
|
|
1659
|
+
method: "put",
|
|
1660
|
+
path: "/v1/chat/tasks/{id}",
|
|
1661
|
+
parameters: {
|
|
1662
|
+
id: {
|
|
1663
|
+
in: "path",
|
|
1664
|
+
type: "string",
|
|
1665
|
+
description: "Task id",
|
|
1666
|
+
},
|
|
1667
|
+
},
|
|
1668
|
+
requestBody: {
|
|
1669
|
+
description: "Task data",
|
|
1670
|
+
schema: {
|
|
1671
|
+
type: "object",
|
|
1672
|
+
properties: {
|
|
1673
|
+
title: {
|
|
1674
|
+
type: "string",
|
|
1675
|
+
description: "Title describing the task",
|
|
1676
|
+
},
|
|
1677
|
+
description: {
|
|
1678
|
+
type: "string",
|
|
1679
|
+
description:
|
|
1680
|
+
"All the notes related to the execution of the current task",
|
|
1681
|
+
},
|
|
1682
|
+
data: {
|
|
1683
|
+
type: "object",
|
|
1684
|
+
additionalProperties: true,
|
|
1685
|
+
description: "Content related to the task",
|
|
1686
|
+
},
|
|
1687
|
+
timeoutAt: {
|
|
1688
|
+
type: "string",
|
|
1689
|
+
format: "date-time",
|
|
1690
|
+
description:
|
|
1691
|
+
"The timeout date where the task should be failed in the ISO 8601 format",
|
|
1692
|
+
},
|
|
1693
|
+
status: {
|
|
1694
|
+
type: "string",
|
|
1695
|
+
enum: [
|
|
1696
|
+
"pending",
|
|
1697
|
+
"in_progress",
|
|
1698
|
+
"failed",
|
|
1699
|
+
"completed",
|
|
1700
|
+
"blocked",
|
|
1701
|
+
"paused",
|
|
1702
|
+
"timeout",
|
|
1703
|
+
"cancelled",
|
|
1704
|
+
],
|
|
1705
|
+
description: "Status of the task",
|
|
1706
|
+
},
|
|
1707
|
+
tags: {
|
|
1708
|
+
type: "object",
|
|
1709
|
+
additionalProperties: {
|
|
1710
|
+
type: "string",
|
|
1711
|
+
maxLength: 500,
|
|
1712
|
+
},
|
|
1713
|
+
description: "Tags for the [Task](#schema_task)",
|
|
1714
|
+
},
|
|
1715
|
+
},
|
|
1716
|
+
title: "updateTaskBody",
|
|
1717
|
+
additionalProperties: false,
|
|
1718
|
+
},
|
|
1719
|
+
},
|
|
1720
|
+
section: "task",
|
|
1721
|
+
response: {
|
|
1722
|
+
description:
|
|
1723
|
+
"Returns an updated [Task](#schema_task) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
|
|
1724
|
+
schema: {
|
|
1725
|
+
type: "object",
|
|
1726
|
+
properties: {
|
|
1727
|
+
task: {
|
|
1728
|
+
$ref: "#/components/schemas/Task",
|
|
1729
|
+
},
|
|
1730
|
+
},
|
|
1731
|
+
required: ["task"],
|
|
1732
|
+
title: "updateTaskResponse",
|
|
1733
|
+
additionalProperties: false,
|
|
1734
|
+
},
|
|
1735
|
+
},
|
|
1736
|
+
},
|
|
1737
|
+
deleteTask: {
|
|
1738
|
+
name: "deleteTask",
|
|
1739
|
+
description:
|
|
1740
|
+
"Permanently deletes a [Task](#schema_task). It cannot be undone.",
|
|
1741
|
+
method: "delete",
|
|
1742
|
+
path: "/v1/chat/tasks/{id}",
|
|
1743
|
+
parameters: {
|
|
1744
|
+
id: {
|
|
1745
|
+
in: "path",
|
|
1746
|
+
type: "string",
|
|
1747
|
+
description: "Task id",
|
|
1748
|
+
},
|
|
1749
|
+
},
|
|
1750
|
+
section: "task",
|
|
1751
|
+
response: {
|
|
1752
|
+
description: "Returns the [Task](#schema_task) object that was deleted",
|
|
1753
|
+
schema: {
|
|
1754
|
+
type: "object",
|
|
1755
|
+
title: "deleteTaskResponse",
|
|
1756
|
+
additionalProperties: false,
|
|
1757
|
+
},
|
|
1758
|
+
},
|
|
1759
|
+
},
|
|
1760
|
+
listTasks: {
|
|
1761
|
+
name: "listTasks",
|
|
1762
|
+
description:
|
|
1763
|
+
"Retrieves a list of [Task](#schema_task) you've previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).",
|
|
1764
|
+
method: "get",
|
|
1765
|
+
path: "/v1/chat/tasks",
|
|
1766
|
+
parameters: {
|
|
1767
|
+
nextToken: {
|
|
1768
|
+
in: "query",
|
|
1769
|
+
description:
|
|
1770
|
+
"Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
1771
|
+
type: "string",
|
|
1772
|
+
},
|
|
1773
|
+
tags: {
|
|
1774
|
+
in: "query",
|
|
1775
|
+
type: "object",
|
|
1776
|
+
schema: {
|
|
1777
|
+
type: "object",
|
|
1778
|
+
additionalProperties: {
|
|
1779
|
+
type: "string",
|
|
1780
|
+
},
|
|
1781
|
+
},
|
|
1782
|
+
description: "Filter by tags",
|
|
1783
|
+
},
|
|
1784
|
+
conversationId: {
|
|
1785
|
+
in: "query",
|
|
1786
|
+
type: "string",
|
|
1787
|
+
description: "Conversation id",
|
|
1788
|
+
},
|
|
1789
|
+
userId: {
|
|
1790
|
+
in: "query",
|
|
1791
|
+
type: "string",
|
|
1792
|
+
description: "User id",
|
|
1793
|
+
},
|
|
1794
|
+
parentTaskId: {
|
|
1795
|
+
in: "query",
|
|
1796
|
+
type: "string",
|
|
1797
|
+
description: "Parent task id",
|
|
1798
|
+
},
|
|
1799
|
+
status: {
|
|
1800
|
+
in: "query",
|
|
1801
|
+
type: "string[]",
|
|
1802
|
+
description: "Status",
|
|
1803
|
+
enum: [
|
|
1804
|
+
"pending",
|
|
1805
|
+
"in_progress",
|
|
1806
|
+
"failed",
|
|
1807
|
+
"completed",
|
|
1808
|
+
"blocked",
|
|
1809
|
+
"paused",
|
|
1810
|
+
"timeout",
|
|
1811
|
+
"cancelled",
|
|
1812
|
+
],
|
|
1813
|
+
},
|
|
1814
|
+
type: {
|
|
1815
|
+
in: "query",
|
|
1816
|
+
type: "string",
|
|
1817
|
+
description: "Type",
|
|
1818
|
+
},
|
|
1819
|
+
},
|
|
1820
|
+
section: "task",
|
|
1821
|
+
response: {
|
|
1822
|
+
description: "Returns a list of [Task](#schema_task) objects",
|
|
1823
|
+
schema: {
|
|
1824
|
+
type: "object",
|
|
1825
|
+
properties: {
|
|
1826
|
+
tasks: {
|
|
1827
|
+
type: "array",
|
|
1828
|
+
items: {
|
|
1829
|
+
$ref: "#/components/schemas/Task",
|
|
1830
|
+
},
|
|
1831
|
+
},
|
|
1832
|
+
meta: {
|
|
1833
|
+
type: "object",
|
|
1834
|
+
properties: {
|
|
1835
|
+
nextToken: {
|
|
1836
|
+
type: "string",
|
|
1837
|
+
description:
|
|
1838
|
+
"The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.",
|
|
1839
|
+
},
|
|
1840
|
+
},
|
|
1841
|
+
additionalProperties: false,
|
|
1842
|
+
},
|
|
1843
|
+
},
|
|
1844
|
+
required: ["tasks", "meta"],
|
|
1845
|
+
title: "listTasksResponse",
|
|
1846
|
+
additionalProperties: false,
|
|
1847
|
+
},
|
|
1848
|
+
},
|
|
1849
|
+
},
|
|
1536
1850
|
runVrl: {
|
|
1537
1851
|
name: "runVrl",
|
|
1538
1852
|
description: "Run a VRL script",
|
|
@@ -3584,6 +3898,10 @@ export const state = {
|
|
|
3584
3898
|
isPublic: {
|
|
3585
3899
|
type: "boolean",
|
|
3586
3900
|
},
|
|
3901
|
+
handle: {
|
|
3902
|
+
default: "",
|
|
3903
|
+
type: "string",
|
|
3904
|
+
},
|
|
3587
3905
|
},
|
|
3588
3906
|
required: [
|
|
3589
3907
|
"id",
|
|
@@ -3687,6 +4005,10 @@ export const state = {
|
|
|
3687
4005
|
isPublic: {
|
|
3688
4006
|
type: "boolean",
|
|
3689
4007
|
},
|
|
4008
|
+
handle: {
|
|
4009
|
+
default: "",
|
|
4010
|
+
type: "string",
|
|
4011
|
+
},
|
|
3690
4012
|
},
|
|
3691
4013
|
required: [
|
|
3692
4014
|
"id",
|
|
@@ -4096,6 +4418,12 @@ export const state = {
|
|
|
4096
4418
|
isPublic: {
|
|
4097
4419
|
type: "boolean",
|
|
4098
4420
|
},
|
|
4421
|
+
handle: {
|
|
4422
|
+
type: "string",
|
|
4423
|
+
minLength: 1,
|
|
4424
|
+
maxLength: 64,
|
|
4425
|
+
pattern: "^[0-9a-z][a-z0-9-]+[0-9a-z]$",
|
|
4426
|
+
},
|
|
4099
4427
|
},
|
|
4100
4428
|
additionalProperties: false,
|
|
4101
4429
|
title: "updateWorkspaceBody",
|
|
@@ -4168,6 +4496,10 @@ export const state = {
|
|
|
4168
4496
|
isPublic: {
|
|
4169
4497
|
type: "boolean",
|
|
4170
4498
|
},
|
|
4499
|
+
handle: {
|
|
4500
|
+
default: "",
|
|
4501
|
+
type: "string",
|
|
4502
|
+
},
|
|
4171
4503
|
},
|
|
4172
4504
|
required: [
|
|
4173
4505
|
"id",
|
|
@@ -4187,21 +4519,30 @@ export const state = {
|
|
|
4187
4519
|
},
|
|
4188
4520
|
},
|
|
4189
4521
|
},
|
|
4190
|
-
|
|
4191
|
-
name: "
|
|
4192
|
-
description: "
|
|
4522
|
+
checkHandleAvailability: {
|
|
4523
|
+
name: "checkHandleAvailability",
|
|
4524
|
+
description: "Check if a workspace handle is available",
|
|
4193
4525
|
section: "workspace",
|
|
4194
|
-
method: "
|
|
4195
|
-
path: "/v1/admin/workspaces",
|
|
4526
|
+
method: "put",
|
|
4196
4527
|
disableDefaultParameters: {
|
|
4197
4528
|
"x-workspace-id": true,
|
|
4198
4529
|
},
|
|
4199
|
-
|
|
4200
|
-
|
|
4201
|
-
|
|
4202
|
-
|
|
4203
|
-
|
|
4204
|
-
|
|
4530
|
+
path: "/v1/admin/workspaces/handle-availability",
|
|
4531
|
+
requestBody: {
|
|
4532
|
+
description: "Workspace handle availability",
|
|
4533
|
+
schema: {
|
|
4534
|
+
type: "object",
|
|
4535
|
+
properties: {
|
|
4536
|
+
handle: {
|
|
4537
|
+
type: "string",
|
|
4538
|
+
minLength: 1,
|
|
4539
|
+
maxLength: 50,
|
|
4540
|
+
pattern: "^[a-z0-9-_]+$",
|
|
4541
|
+
},
|
|
4542
|
+
},
|
|
4543
|
+
required: ["handle"],
|
|
4544
|
+
title: "checkHandleAvailabilityBody",
|
|
4545
|
+
additionalProperties: false,
|
|
4205
4546
|
},
|
|
4206
4547
|
},
|
|
4207
4548
|
response: {
|
|
@@ -4209,14 +4550,56 @@ export const state = {
|
|
|
4209
4550
|
schema: {
|
|
4210
4551
|
type: "object",
|
|
4211
4552
|
properties: {
|
|
4212
|
-
|
|
4553
|
+
available: {
|
|
4554
|
+
type: "boolean",
|
|
4555
|
+
},
|
|
4556
|
+
suggestions: {
|
|
4213
4557
|
type: "array",
|
|
4214
4558
|
items: {
|
|
4215
|
-
type: "
|
|
4216
|
-
|
|
4217
|
-
|
|
4218
|
-
|
|
4219
|
-
|
|
4559
|
+
type: "string",
|
|
4560
|
+
},
|
|
4561
|
+
},
|
|
4562
|
+
usedBy: {
|
|
4563
|
+
type: "string",
|
|
4564
|
+
},
|
|
4565
|
+
},
|
|
4566
|
+
required: ["available", "suggestions"],
|
|
4567
|
+
title: "checkHandleAvailabilityResponse",
|
|
4568
|
+
additionalProperties: false,
|
|
4569
|
+
},
|
|
4570
|
+
},
|
|
4571
|
+
parameters: {},
|
|
4572
|
+
},
|
|
4573
|
+
listWorkspaces: {
|
|
4574
|
+
name: "listWorkspaces",
|
|
4575
|
+
description: "List workspaces the user has access to",
|
|
4576
|
+
section: "workspace",
|
|
4577
|
+
method: "get",
|
|
4578
|
+
path: "/v1/admin/workspaces",
|
|
4579
|
+
disableDefaultParameters: {
|
|
4580
|
+
"x-workspace-id": true,
|
|
4581
|
+
},
|
|
4582
|
+
parameters: {
|
|
4583
|
+
nextToken: {
|
|
4584
|
+
in: "query",
|
|
4585
|
+
description:
|
|
4586
|
+
"Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
4587
|
+
type: "string",
|
|
4588
|
+
},
|
|
4589
|
+
},
|
|
4590
|
+
response: {
|
|
4591
|
+
description: "Success",
|
|
4592
|
+
schema: {
|
|
4593
|
+
type: "object",
|
|
4594
|
+
properties: {
|
|
4595
|
+
workspaces: {
|
|
4596
|
+
type: "array",
|
|
4597
|
+
items: {
|
|
4598
|
+
type: "object",
|
|
4599
|
+
properties: {
|
|
4600
|
+
id: {
|
|
4601
|
+
type: "string",
|
|
4602
|
+
},
|
|
4220
4603
|
name: {
|
|
4221
4604
|
type: "string",
|
|
4222
4605
|
},
|
|
@@ -4276,6 +4659,10 @@ export const state = {
|
|
|
4276
4659
|
isPublic: {
|
|
4277
4660
|
type: "boolean",
|
|
4278
4661
|
},
|
|
4662
|
+
handle: {
|
|
4663
|
+
default: "",
|
|
4664
|
+
type: "string",
|
|
4665
|
+
},
|
|
4279
4666
|
},
|
|
4280
4667
|
required: [
|
|
4281
4668
|
"id",
|
|
@@ -4409,6 +4796,10 @@ export const state = {
|
|
|
4409
4796
|
isPublic: {
|
|
4410
4797
|
type: "boolean",
|
|
4411
4798
|
},
|
|
4799
|
+
handle: {
|
|
4800
|
+
default: "",
|
|
4801
|
+
type: "string",
|
|
4802
|
+
},
|
|
4412
4803
|
},
|
|
4413
4804
|
required: [
|
|
4414
4805
|
"id",
|
|
@@ -4834,7 +5225,7 @@ export const state = {
|
|
|
4834
5225
|
linkTemplateScript: {
|
|
4835
5226
|
type: "string",
|
|
4836
5227
|
maxLength: 2000,
|
|
4837
|
-
description: "
|
|
5228
|
+
description: "Title describing the task",
|
|
4838
5229
|
},
|
|
4839
5230
|
},
|
|
4840
5231
|
additionalProperties: false,
|
|
@@ -4939,12 +5330,12 @@ export const state = {
|
|
|
4939
5330
|
fallbackHandlerScript: {
|
|
4940
5331
|
type: "string",
|
|
4941
5332
|
maxLength: 2000,
|
|
4942
|
-
description: "
|
|
5333
|
+
description: "Title describing the task",
|
|
4943
5334
|
},
|
|
4944
5335
|
extractScript: {
|
|
4945
5336
|
type: "string",
|
|
4946
5337
|
maxLength: 2000,
|
|
4947
|
-
description: "
|
|
5338
|
+
description: "Title describing the task",
|
|
4948
5339
|
},
|
|
4949
5340
|
},
|
|
4950
5341
|
additionalProperties: false,
|
|
@@ -5207,7 +5598,7 @@ export const state = {
|
|
|
5207
5598
|
linkTemplateScript: {
|
|
5208
5599
|
type: "string",
|
|
5209
5600
|
maxLength: 2000,
|
|
5210
|
-
description: "
|
|
5601
|
+
description: "Title describing the task",
|
|
5211
5602
|
nullable: true,
|
|
5212
5603
|
},
|
|
5213
5604
|
required: {
|
|
@@ -5338,13 +5729,13 @@ export const state = {
|
|
|
5338
5729
|
extractScript: {
|
|
5339
5730
|
type: "string",
|
|
5340
5731
|
maxLength: 2000,
|
|
5341
|
-
description: "
|
|
5732
|
+
description: "Title describing the task",
|
|
5342
5733
|
nullable: true,
|
|
5343
5734
|
},
|
|
5344
5735
|
fallbackHandlerScript: {
|
|
5345
5736
|
type: "string",
|
|
5346
5737
|
maxLength: 2000,
|
|
5347
|
-
description: "
|
|
5738
|
+
description: "Title describing the task",
|
|
5348
5739
|
nullable: true,
|
|
5349
5740
|
},
|
|
5350
5741
|
},
|
|
@@ -5961,6 +6352,64 @@ export const state = {
|
|
|
5961
6352
|
},
|
|
5962
6353
|
parameters: {},
|
|
5963
6354
|
},
|
|
6355
|
+
listActivities: {
|
|
6356
|
+
name: "listActivities",
|
|
6357
|
+
description: "List activities of a task",
|
|
6358
|
+
method: "get",
|
|
6359
|
+
section: "activity",
|
|
6360
|
+
path: "/v1/admin/activities",
|
|
6361
|
+
disableDefaultParameters: {
|
|
6362
|
+
"x-workspace-id": true,
|
|
6363
|
+
},
|
|
6364
|
+
parameters: {
|
|
6365
|
+
nextToken: {
|
|
6366
|
+
in: "query",
|
|
6367
|
+
description:
|
|
6368
|
+
"Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
6369
|
+
type: "string",
|
|
6370
|
+
},
|
|
6371
|
+
taskId: {
|
|
6372
|
+
in: "query",
|
|
6373
|
+
description: "ID of the task to list activities for",
|
|
6374
|
+
type: "string",
|
|
6375
|
+
required: true,
|
|
6376
|
+
},
|
|
6377
|
+
botId: {
|
|
6378
|
+
in: "query",
|
|
6379
|
+
description: "ID of the bot to list activities for",
|
|
6380
|
+
type: "string",
|
|
6381
|
+
required: true,
|
|
6382
|
+
},
|
|
6383
|
+
},
|
|
6384
|
+
response: {
|
|
6385
|
+
description: "Success",
|
|
6386
|
+
schema: {
|
|
6387
|
+
type: "object",
|
|
6388
|
+
properties: {
|
|
6389
|
+
activities: {
|
|
6390
|
+
type: "array",
|
|
6391
|
+
items: {
|
|
6392
|
+
$ref: "#/components/schemas/Activity",
|
|
6393
|
+
},
|
|
6394
|
+
},
|
|
6395
|
+
meta: {
|
|
6396
|
+
type: "object",
|
|
6397
|
+
properties: {
|
|
6398
|
+
nextToken: {
|
|
6399
|
+
type: "string",
|
|
6400
|
+
description:
|
|
6401
|
+
"The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.",
|
|
6402
|
+
},
|
|
6403
|
+
},
|
|
6404
|
+
additionalProperties: false,
|
|
6405
|
+
},
|
|
6406
|
+
},
|
|
6407
|
+
required: ["activities", "meta"],
|
|
6408
|
+
title: "listActivitiesResponse",
|
|
6409
|
+
additionalProperties: false,
|
|
6410
|
+
},
|
|
6411
|
+
},
|
|
6412
|
+
},
|
|
5964
6413
|
introspect: {
|
|
5965
6414
|
name: "introspect",
|
|
5966
6415
|
description: "Introspect the API",
|
|
@@ -6182,7 +6631,7 @@ export const state = {
|
|
|
6182
6631
|
title: "Botpress API",
|
|
6183
6632
|
description: "API for Botpress Cloud",
|
|
6184
6633
|
server: "https://api.botpress.cloud",
|
|
6185
|
-
version: "0.16.
|
|
6634
|
+
version: "0.16.3",
|
|
6186
6635
|
prefix: "v1",
|
|
6187
6636
|
},
|
|
6188
6637
|
errors: [
|
|
@@ -6319,6 +6768,8 @@ export const state = {
|
|
|
6319
6768
|
patchStateBody: true,
|
|
6320
6769
|
callActionBody: true,
|
|
6321
6770
|
configureIntegrationBody: true,
|
|
6771
|
+
createTaskBody: true,
|
|
6772
|
+
updateTaskBody: true,
|
|
6322
6773
|
runVrlBody: true,
|
|
6323
6774
|
createPersonalAccessTokenBody: true,
|
|
6324
6775
|
setAccountPreferenceBody: true,
|
|
@@ -6329,6 +6780,7 @@ export const state = {
|
|
|
6329
6780
|
chargeWorkspaceUnpaidInvoicesBody: true,
|
|
6330
6781
|
createWorkspaceBody: true,
|
|
6331
6782
|
updateWorkspaceBody: true,
|
|
6783
|
+
checkHandleAvailabilityBody: true,
|
|
6332
6784
|
changeWorkspacePlanBody: true,
|
|
6333
6785
|
createWorkspaceMemberBody: true,
|
|
6334
6786
|
updateWorkspaceMemberBody: true,
|
|
@@ -6369,6 +6821,11 @@ export const state = {
|
|
|
6369
6821
|
patchStateResponse: true,
|
|
6370
6822
|
callActionResponse: true,
|
|
6371
6823
|
configureIntegrationResponse: true,
|
|
6824
|
+
getTaskResponse: true,
|
|
6825
|
+
createTaskResponse: true,
|
|
6826
|
+
updateTaskResponse: true,
|
|
6827
|
+
deleteTaskResponse: true,
|
|
6828
|
+
listTasksResponse: true,
|
|
6372
6829
|
runVrlResponse: true,
|
|
6373
6830
|
getAccountResponse: true,
|
|
6374
6831
|
listPersonalAccessTokensResponse: true,
|
|
@@ -6403,6 +6860,7 @@ export const state = {
|
|
|
6403
6860
|
getWorkspaceQuotaResponse: true,
|
|
6404
6861
|
listWorkspaceQuotasResponse: true,
|
|
6405
6862
|
updateWorkspaceResponse: true,
|
|
6863
|
+
checkHandleAvailabilityResponse: true,
|
|
6406
6864
|
listWorkspacesResponse: true,
|
|
6407
6865
|
changeWorkspacePlanResponse: true,
|
|
6408
6866
|
deleteWorkspaceResponse: true,
|
|
@@ -6421,6 +6879,7 @@ export const state = {
|
|
|
6421
6879
|
getUsageResponse: true,
|
|
6422
6880
|
listUsageHistoryResponse: true,
|
|
6423
6881
|
changeAISpendQuotaResponse: true,
|
|
6882
|
+
listActivitiesResponse: true,
|
|
6424
6883
|
introspectResponse: true,
|
|
6425
6884
|
createFileResponse: true,
|
|
6426
6885
|
getFileResponse: true,
|
|
@@ -6437,11 +6896,13 @@ export const state = {
|
|
|
6437
6896
|
Usage: true,
|
|
6438
6897
|
Issue: true,
|
|
6439
6898
|
IssueEvent: true,
|
|
6899
|
+
Activity: true,
|
|
6440
6900
|
User: true,
|
|
6441
6901
|
Conversation: true,
|
|
6442
6902
|
Event: true,
|
|
6443
6903
|
Message: true,
|
|
6444
6904
|
State: true,
|
|
6905
|
+
Task: true,
|
|
6445
6906
|
File: true,
|
|
6446
6907
|
Table: true,
|
|
6447
6908
|
Column: true,
|
|
@@ -6475,7 +6936,7 @@ export const state = {
|
|
|
6475
6936
|
signingSecret: {
|
|
6476
6937
|
type: "string",
|
|
6477
6938
|
maxLength: 2000,
|
|
6478
|
-
description: "
|
|
6939
|
+
description: "Title describing the task",
|
|
6479
6940
|
},
|
|
6480
6941
|
integrations: {
|
|
6481
6942
|
type: "object",
|
|
@@ -6488,30 +6949,27 @@ export const state = {
|
|
|
6488
6949
|
name: {
|
|
6489
6950
|
type: "string",
|
|
6490
6951
|
maxLength: 200,
|
|
6491
|
-
description:
|
|
6492
|
-
"Type of the [Message](#schema_message) represents the resource type that the message is related to",
|
|
6952
|
+
description: "Type of the task",
|
|
6493
6953
|
},
|
|
6494
6954
|
version: {
|
|
6495
6955
|
type: "string",
|
|
6496
6956
|
maxLength: 200,
|
|
6497
|
-
description:
|
|
6498
|
-
"Type of the [Message](#schema_message) represents the resource type that the message is related to",
|
|
6957
|
+
description: "Type of the task",
|
|
6499
6958
|
},
|
|
6500
6959
|
webhookUrl: {
|
|
6501
6960
|
type: "string",
|
|
6502
6961
|
maxLength: 2000,
|
|
6503
|
-
description: "
|
|
6962
|
+
description: "Title describing the task",
|
|
6504
6963
|
},
|
|
6505
6964
|
webhookId: {
|
|
6506
6965
|
type: "string",
|
|
6507
6966
|
maxLength: 200,
|
|
6508
|
-
description:
|
|
6509
|
-
"Type of the [Message](#schema_message) represents the resource type that the message is related to",
|
|
6967
|
+
description: "Type of the task",
|
|
6510
6968
|
},
|
|
6511
6969
|
identifier: {
|
|
6512
6970
|
type: "string",
|
|
6513
6971
|
maxLength: 2000,
|
|
6514
|
-
description: "
|
|
6972
|
+
description: "Title describing the task",
|
|
6515
6973
|
},
|
|
6516
6974
|
configuration: {
|
|
6517
6975
|
type: "object",
|
|
@@ -6531,7 +6989,7 @@ export const state = {
|
|
|
6531
6989
|
statusReason: {
|
|
6532
6990
|
type: "string",
|
|
6533
6991
|
maxLength: 2000,
|
|
6534
|
-
description: "
|
|
6992
|
+
description: "Title describing the task",
|
|
6535
6993
|
nullable: true,
|
|
6536
6994
|
},
|
|
6537
6995
|
id: {
|
|
@@ -6763,8 +7221,7 @@ export const state = {
|
|
|
6763
7221
|
cron: {
|
|
6764
7222
|
type: "string",
|
|
6765
7223
|
maxLength: 200,
|
|
6766
|
-
description:
|
|
6767
|
-
"Type of the [Message](#schema_message) represents the resource type that the message is related to",
|
|
7224
|
+
description: "Type of the task",
|
|
6768
7225
|
},
|
|
6769
7226
|
},
|
|
6770
7227
|
required: ["cron"],
|
|
@@ -6773,8 +7230,7 @@ export const state = {
|
|
|
6773
7230
|
type: {
|
|
6774
7231
|
type: "string",
|
|
6775
7232
|
maxLength: 200,
|
|
6776
|
-
description:
|
|
6777
|
-
"Type of the [Message](#schema_message) represents the resource type that the message is related to",
|
|
7233
|
+
description: "Type of the task",
|
|
6778
7234
|
},
|
|
6779
7235
|
payload: {
|
|
6780
7236
|
type: "object",
|
|
@@ -6941,14 +7397,12 @@ export const state = {
|
|
|
6941
7397
|
name: {
|
|
6942
7398
|
type: "string",
|
|
6943
7399
|
maxLength: 200,
|
|
6944
|
-
description:
|
|
6945
|
-
"Type of the [Message](#schema_message) represents the resource type that the message is related to",
|
|
7400
|
+
description: "Type of the task",
|
|
6946
7401
|
},
|
|
6947
7402
|
version: {
|
|
6948
7403
|
type: "string",
|
|
6949
7404
|
maxLength: 200,
|
|
6950
|
-
description:
|
|
6951
|
-
"Type of the [Message](#schema_message) represents the resource type that the message is related to",
|
|
7405
|
+
description: "Type of the task",
|
|
6952
7406
|
},
|
|
6953
7407
|
configuration: {
|
|
6954
7408
|
type: "object",
|
|
@@ -6959,7 +7413,7 @@ export const state = {
|
|
|
6959
7413
|
linkTemplateScript: {
|
|
6960
7414
|
type: "string",
|
|
6961
7415
|
maxLength: 2000,
|
|
6962
|
-
description: "
|
|
7416
|
+
description: "Title describing the task",
|
|
6963
7417
|
},
|
|
6964
7418
|
required: {
|
|
6965
7419
|
type: "boolean",
|
|
@@ -7364,6 +7818,10 @@ export const state = {
|
|
|
7364
7818
|
isPublic: {
|
|
7365
7819
|
type: "boolean",
|
|
7366
7820
|
},
|
|
7821
|
+
handle: {
|
|
7822
|
+
default: "",
|
|
7823
|
+
type: "string",
|
|
7824
|
+
},
|
|
7367
7825
|
},
|
|
7368
7826
|
required: [
|
|
7369
7827
|
"id",
|
|
@@ -7584,6 +8042,56 @@ export const state = {
|
|
|
7584
8042
|
additionalProperties: false,
|
|
7585
8043
|
},
|
|
7586
8044
|
},
|
|
8045
|
+
Activity: {
|
|
8046
|
+
section: "activity",
|
|
8047
|
+
schema: {
|
|
8048
|
+
type: "object",
|
|
8049
|
+
properties: {
|
|
8050
|
+
id: {
|
|
8051
|
+
type: "string",
|
|
8052
|
+
},
|
|
8053
|
+
description: {
|
|
8054
|
+
type: "string",
|
|
8055
|
+
},
|
|
8056
|
+
taskId: {
|
|
8057
|
+
type: "string",
|
|
8058
|
+
},
|
|
8059
|
+
category: {
|
|
8060
|
+
type: "string",
|
|
8061
|
+
enum: [
|
|
8062
|
+
"unknown",
|
|
8063
|
+
"capture",
|
|
8064
|
+
"bot_message",
|
|
8065
|
+
"user_message",
|
|
8066
|
+
"agent_message",
|
|
8067
|
+
"event",
|
|
8068
|
+
"action",
|
|
8069
|
+
"task_status",
|
|
8070
|
+
"subtask_status",
|
|
8071
|
+
"exception",
|
|
8072
|
+
],
|
|
8073
|
+
},
|
|
8074
|
+
data: {
|
|
8075
|
+
type: "object",
|
|
8076
|
+
additionalProperties: true,
|
|
8077
|
+
},
|
|
8078
|
+
createdAt: {
|
|
8079
|
+
type: "string",
|
|
8080
|
+
format: "date-time",
|
|
8081
|
+
description: "Creation date of the activity in ISO 8601 format",
|
|
8082
|
+
},
|
|
8083
|
+
},
|
|
8084
|
+
required: [
|
|
8085
|
+
"id",
|
|
8086
|
+
"description",
|
|
8087
|
+
"taskId",
|
|
8088
|
+
"category",
|
|
8089
|
+
"data",
|
|
8090
|
+
"createdAt",
|
|
8091
|
+
],
|
|
8092
|
+
additionalProperties: false,
|
|
8093
|
+
},
|
|
8094
|
+
},
|
|
7587
8095
|
User: {
|
|
7588
8096
|
section: "user",
|
|
7589
8097
|
schema: {
|
|
@@ -7643,6 +8151,12 @@ export const state = {
|
|
|
7643
8151
|
maxLength: 36,
|
|
7644
8152
|
description: "ID of the [Conversation](#schema_conversation)",
|
|
7645
8153
|
},
|
|
8154
|
+
currentTaskId: {
|
|
8155
|
+
type: "string",
|
|
8156
|
+
minLength: 28,
|
|
8157
|
+
maxLength: 36,
|
|
8158
|
+
description: "Id of the current [Task](#schema_task)",
|
|
8159
|
+
},
|
|
7646
8160
|
createdAt: {
|
|
7647
8161
|
type: "string",
|
|
7648
8162
|
format: "date-time",
|
|
@@ -7707,8 +8221,7 @@ export const state = {
|
|
|
7707
8221
|
type: {
|
|
7708
8222
|
type: "string",
|
|
7709
8223
|
maxLength: 200,
|
|
7710
|
-
description:
|
|
7711
|
-
"Type of the [Message](#schema_message) represents the resource type that the message is related to",
|
|
8224
|
+
description: "Type of the task",
|
|
7712
8225
|
},
|
|
7713
8226
|
payload: {
|
|
7714
8227
|
type: "object",
|
|
@@ -7738,10 +8251,23 @@ export const state = {
|
|
|
7738
8251
|
},
|
|
7739
8252
|
status: {
|
|
7740
8253
|
type: "string",
|
|
7741
|
-
|
|
8254
|
+
enum: ["pending", "processed", "ignored", "failed"],
|
|
8255
|
+
},
|
|
8256
|
+
failureReason: {
|
|
8257
|
+
type: "string",
|
|
8258
|
+
maxLength: 2000,
|
|
8259
|
+
description: "Reason why the event failed to be processed",
|
|
8260
|
+
nullable: true,
|
|
7742
8261
|
},
|
|
7743
8262
|
},
|
|
7744
|
-
required: [
|
|
8263
|
+
required: [
|
|
8264
|
+
"id",
|
|
8265
|
+
"createdAt",
|
|
8266
|
+
"type",
|
|
8267
|
+
"payload",
|
|
8268
|
+
"status",
|
|
8269
|
+
"failureReason",
|
|
8270
|
+
],
|
|
7745
8271
|
description: "The event object represents an action or an occurrence.",
|
|
7746
8272
|
additionalProperties: false,
|
|
7747
8273
|
},
|
|
@@ -7766,8 +8292,7 @@ export const state = {
|
|
|
7766
8292
|
type: {
|
|
7767
8293
|
type: "string",
|
|
7768
8294
|
maxLength: 200,
|
|
7769
|
-
description:
|
|
7770
|
-
"Type of the [Message](#schema_message) represents the resource type that the message is related to",
|
|
8295
|
+
description: "Type of the task",
|
|
7771
8296
|
},
|
|
7772
8297
|
payload: {
|
|
7773
8298
|
type: "object",
|
|
@@ -7860,8 +8385,7 @@ export const state = {
|
|
|
7860
8385
|
name: {
|
|
7861
8386
|
type: "string",
|
|
7862
8387
|
maxLength: 200,
|
|
7863
|
-
description:
|
|
7864
|
-
"Type of the [Message](#schema_message) represents the resource type that the message is related to",
|
|
8388
|
+
description: "Type of the task",
|
|
7865
8389
|
},
|
|
7866
8390
|
type: {
|
|
7867
8391
|
type: "string",
|
|
@@ -7890,6 +8414,116 @@ export const state = {
|
|
|
7890
8414
|
additionalProperties: false,
|
|
7891
8415
|
},
|
|
7892
8416
|
},
|
|
8417
|
+
Task: {
|
|
8418
|
+
section: "task",
|
|
8419
|
+
schema: {
|
|
8420
|
+
type: "object",
|
|
8421
|
+
properties: {
|
|
8422
|
+
id: {
|
|
8423
|
+
type: "string",
|
|
8424
|
+
minLength: 28,
|
|
8425
|
+
maxLength: 36,
|
|
8426
|
+
description: "ID of the [Conversation](#schema_conversation)",
|
|
8427
|
+
},
|
|
8428
|
+
title: {
|
|
8429
|
+
type: "string",
|
|
8430
|
+
maxLength: 64,
|
|
8431
|
+
description: "Title describing the task",
|
|
8432
|
+
},
|
|
8433
|
+
description: {
|
|
8434
|
+
type: "string",
|
|
8435
|
+
maxLength: 256,
|
|
8436
|
+
description:
|
|
8437
|
+
"All the notes related to the execution of the current task",
|
|
8438
|
+
},
|
|
8439
|
+
type: {
|
|
8440
|
+
type: "string",
|
|
8441
|
+
description: "Type of the task",
|
|
8442
|
+
},
|
|
8443
|
+
data: {
|
|
8444
|
+
type: "object",
|
|
8445
|
+
additionalProperties: true,
|
|
8446
|
+
description: "Content related to the task",
|
|
8447
|
+
},
|
|
8448
|
+
status: {
|
|
8449
|
+
type: "string",
|
|
8450
|
+
enum: [
|
|
8451
|
+
"pending",
|
|
8452
|
+
"in_progress",
|
|
8453
|
+
"failed",
|
|
8454
|
+
"completed",
|
|
8455
|
+
"blocked",
|
|
8456
|
+
"paused",
|
|
8457
|
+
"timeout",
|
|
8458
|
+
"cancelled",
|
|
8459
|
+
],
|
|
8460
|
+
description: "Status of the task",
|
|
8461
|
+
},
|
|
8462
|
+
parentTaskId: {
|
|
8463
|
+
type: "string",
|
|
8464
|
+
minLength: 28,
|
|
8465
|
+
maxLength: 36,
|
|
8466
|
+
description:
|
|
8467
|
+
"Parent task id is the parent task that created this task",
|
|
8468
|
+
},
|
|
8469
|
+
conversationId: {
|
|
8470
|
+
type: "string",
|
|
8471
|
+
minLength: 28,
|
|
8472
|
+
maxLength: 36,
|
|
8473
|
+
description: "Conversation id related to this task",
|
|
8474
|
+
},
|
|
8475
|
+
userId: {
|
|
8476
|
+
type: "string",
|
|
8477
|
+
minLength: 28,
|
|
8478
|
+
maxLength: 36,
|
|
8479
|
+
description: "Specific user related to this task",
|
|
8480
|
+
},
|
|
8481
|
+
timeoutAt: {
|
|
8482
|
+
type: "string",
|
|
8483
|
+
format: "date-time",
|
|
8484
|
+
description:
|
|
8485
|
+
"The timeout date where the task should be failed in the ISO 8601 format",
|
|
8486
|
+
},
|
|
8487
|
+
createdAt: {
|
|
8488
|
+
type: "string",
|
|
8489
|
+
format: "date-time",
|
|
8490
|
+
description: "Creation date of the task in ISO 8601 format",
|
|
8491
|
+
},
|
|
8492
|
+
updatedAt: {
|
|
8493
|
+
type: "string",
|
|
8494
|
+
format: "date-time",
|
|
8495
|
+
description: "Updating date of the task in ISO 8601 format",
|
|
8496
|
+
},
|
|
8497
|
+
failureReason: {
|
|
8498
|
+
type: "string",
|
|
8499
|
+
maxLength: 2000,
|
|
8500
|
+
description: "If the task fails this is the reason behind it",
|
|
8501
|
+
},
|
|
8502
|
+
tags: {
|
|
8503
|
+
type: "object",
|
|
8504
|
+
additionalProperties: {
|
|
8505
|
+
type: "string",
|
|
8506
|
+
},
|
|
8507
|
+
description:
|
|
8508
|
+
"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.",
|
|
8509
|
+
},
|
|
8510
|
+
},
|
|
8511
|
+
required: [
|
|
8512
|
+
"id",
|
|
8513
|
+
"title",
|
|
8514
|
+
"description",
|
|
8515
|
+
"type",
|
|
8516
|
+
"data",
|
|
8517
|
+
"status",
|
|
8518
|
+
"timeoutAt",
|
|
8519
|
+
"createdAt",
|
|
8520
|
+
"updatedAt",
|
|
8521
|
+
"tags",
|
|
8522
|
+
],
|
|
8523
|
+
description: "Task definition",
|
|
8524
|
+
additionalProperties: false,
|
|
8525
|
+
},
|
|
8526
|
+
},
|
|
7893
8527
|
File: {
|
|
7894
8528
|
section: "file",
|
|
7895
8529
|
schema: {
|
|
@@ -7954,58 +8588,78 @@ export const state = {
|
|
|
7954
8588
|
description:
|
|
7955
8589
|
"The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.",
|
|
7956
8590
|
},
|
|
7957
|
-
|
|
7958
|
-
type: "
|
|
7959
|
-
|
|
7960
|
-
|
|
8591
|
+
schema: {
|
|
8592
|
+
type: "object",
|
|
8593
|
+
properties: {
|
|
8594
|
+
$schema: {
|
|
8595
|
+
type: "string",
|
|
8596
|
+
},
|
|
7961
8597
|
properties: {
|
|
7962
|
-
|
|
7963
|
-
|
|
7964
|
-
|
|
7965
|
-
|
|
7966
|
-
|
|
7967
|
-
|
|
7968
|
-
|
|
7969
|
-
|
|
7970
|
-
|
|
7971
|
-
|
|
7972
|
-
|
|
7973
|
-
|
|
7974
|
-
|
|
7975
|
-
|
|
7976
|
-
|
|
7977
|
-
|
|
7978
|
-
|
|
7979
|
-
|
|
7980
|
-
|
|
7981
|
-
|
|
7982
|
-
|
|
7983
|
-
|
|
7984
|
-
|
|
7985
|
-
|
|
7986
|
-
|
|
8598
|
+
type: "object",
|
|
8599
|
+
additionalProperties: {
|
|
8600
|
+
type: "object",
|
|
8601
|
+
properties: {
|
|
8602
|
+
type: {
|
|
8603
|
+
type: "string",
|
|
8604
|
+
enum: ["string", "number", "boolean", "object", "null"],
|
|
8605
|
+
},
|
|
8606
|
+
format: {
|
|
8607
|
+
type: "string",
|
|
8608
|
+
enum: ["date-time"],
|
|
8609
|
+
},
|
|
8610
|
+
description: {
|
|
8611
|
+
type: "string",
|
|
8612
|
+
},
|
|
8613
|
+
nullable: {
|
|
8614
|
+
default: true,
|
|
8615
|
+
type: "boolean",
|
|
8616
|
+
},
|
|
8617
|
+
"x-zui": {
|
|
8618
|
+
type: "object",
|
|
8619
|
+
properties: {
|
|
8620
|
+
index: {
|
|
8621
|
+
type: "integer",
|
|
8622
|
+
},
|
|
8623
|
+
searchable: {
|
|
8624
|
+
type: "boolean",
|
|
8625
|
+
description:
|
|
8626
|
+
"Indicates if the column is vectorized and searchable.",
|
|
8627
|
+
},
|
|
8628
|
+
typings: {
|
|
8629
|
+
type: "string",
|
|
8630
|
+
description:
|
|
8631
|
+
'TypeScript typings for the column. Recommended if the type is "object", ex: "\\{ foo: string; bar: number \\}"',
|
|
8632
|
+
},
|
|
8633
|
+
},
|
|
8634
|
+
required: ["index"],
|
|
8635
|
+
additionalProperties: false,
|
|
8636
|
+
},
|
|
8637
|
+
},
|
|
8638
|
+
required: ["type", "x-zui"],
|
|
8639
|
+
additionalProperties: false,
|
|
7987
8640
|
},
|
|
7988
|
-
|
|
8641
|
+
description: "List of keys/columns in the table.",
|
|
8642
|
+
},
|
|
8643
|
+
additionalProperties: {
|
|
8644
|
+
type: "boolean",
|
|
8645
|
+
enum: [true],
|
|
8646
|
+
description:
|
|
8647
|
+
"Additional properties can be provided, but they will be ignored if no column matches.",
|
|
8648
|
+
},
|
|
8649
|
+
required: {
|
|
8650
|
+
type: "array",
|
|
8651
|
+
items: {
|
|
7989
8652
|
type: "string",
|
|
7990
|
-
description:
|
|
7991
|
-
'TypeScript typings for the column. Recommended if the type is "object", ex: "\\{ foo: string; bar: number \\}"',
|
|
7992
|
-
},
|
|
7993
|
-
schema: {
|
|
7994
|
-
type: "object",
|
|
7995
|
-
properties: {},
|
|
7996
|
-
additionalProperties: true,
|
|
7997
8653
|
},
|
|
8654
|
+
description: "Array of required properties.",
|
|
8655
|
+
},
|
|
8656
|
+
type: {
|
|
8657
|
+
type: "string",
|
|
8658
|
+
enum: ["object"],
|
|
7998
8659
|
},
|
|
7999
|
-
required: ["name", "type"],
|
|
8000
8660
|
},
|
|
8001
|
-
|
|
8002
|
-
|
|
8003
|
-
},
|
|
8004
|
-
schema: {
|
|
8005
|
-
type: "object",
|
|
8006
|
-
additionalProperties: true,
|
|
8007
|
-
description:
|
|
8008
|
-
"Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.",
|
|
8661
|
+
required: ["$schema", "properties", "additionalProperties", "type"],
|
|
8662
|
+
additionalProperties: false,
|
|
8009
8663
|
},
|
|
8010
8664
|
tags: {
|
|
8011
8665
|
type: "object",
|
|
@@ -8024,7 +8678,7 @@ export const state = {
|
|
|
8024
8678
|
description: "Timestamp of the last table update.",
|
|
8025
8679
|
},
|
|
8026
8680
|
},
|
|
8027
|
-
required: ["id", "name", "
|
|
8681
|
+
required: ["id", "name", "schema"],
|
|
8028
8682
|
additionalProperties: false,
|
|
8029
8683
|
},
|
|
8030
8684
|
},
|
|
@@ -8190,6 +8844,19 @@ export const state = {
|
|
|
8190
8844
|
name: "action",
|
|
8191
8845
|
operations: ["callAction"],
|
|
8192
8846
|
},
|
|
8847
|
+
{
|
|
8848
|
+
description: "",
|
|
8849
|
+
title: "Task",
|
|
8850
|
+
name: "task",
|
|
8851
|
+
operations: [
|
|
8852
|
+
"getTask",
|
|
8853
|
+
"createTask",
|
|
8854
|
+
"updateTask",
|
|
8855
|
+
"deleteTask",
|
|
8856
|
+
"listTasks",
|
|
8857
|
+
],
|
|
8858
|
+
schema: "Task",
|
|
8859
|
+
},
|
|
8193
8860
|
{
|
|
8194
8861
|
title: "Bot",
|
|
8195
8862
|
description: "",
|
|
@@ -8242,6 +8909,7 @@ export const state = {
|
|
|
8242
8909
|
"getWorkspaceQuota",
|
|
8243
8910
|
"listWorkspaceQuotas",
|
|
8244
8911
|
"updateWorkspace",
|
|
8912
|
+
"checkHandleAvailability",
|
|
8245
8913
|
"listWorkspaces",
|
|
8246
8914
|
"changeWorkspacePlan",
|
|
8247
8915
|
"deleteWorkspace",
|
|
@@ -8294,6 +8962,13 @@ export const state = {
|
|
|
8294
8962
|
name: "helper",
|
|
8295
8963
|
operations: ["runVrl"],
|
|
8296
8964
|
},
|
|
8965
|
+
{
|
|
8966
|
+
title: "Activity",
|
|
8967
|
+
description: "",
|
|
8968
|
+
name: "activity",
|
|
8969
|
+
operations: ["listActivities"],
|
|
8970
|
+
schema: "Activity",
|
|
8971
|
+
},
|
|
8297
8972
|
{
|
|
8298
8973
|
title: "Tables",
|
|
8299
8974
|
description: "Operations related to table management.",
|