@botpress/api 0.2.2 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/gen/state.d.ts +891 -383
  2. package/dist/index.js +990 -424
  3. package/package.json +10 -10
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +1004 -415
package/src/gen/state.ts CHANGED
@@ -1466,34 +1466,6 @@ export const state = {
1466
1466
  },
1467
1467
  description: "A mapping of states to their definition",
1468
1468
  },
1469
- tags: {
1470
- type: "object",
1471
- properties: {
1472
- messages: {
1473
- default: [],
1474
- type: "array",
1475
- items: {
1476
- type: "string",
1477
- },
1478
- },
1479
- conversations: {
1480
- default: [],
1481
- type: "array",
1482
- items: {
1483
- type: "string",
1484
- },
1485
- },
1486
- users: {
1487
- default: [],
1488
- type: "array",
1489
- items: {
1490
- type: "string",
1491
- },
1492
- },
1493
- },
1494
- description: "Tags of the bot",
1495
- additionalProperties: false,
1496
- },
1497
1469
  events: {
1498
1470
  type: "object",
1499
1471
  additionalProperties: {
@@ -1505,7 +1477,7 @@ export const state = {
1505
1477
  },
1506
1478
  },
1507
1479
  required: ["schema"],
1508
- description: "Event schema",
1480
+ description: "Event Definition",
1509
1481
  additionalProperties: false,
1510
1482
  },
1511
1483
  description: "Events definition",
@@ -1555,6 +1527,81 @@ export const state = {
1555
1527
  },
1556
1528
  additionalProperties: false,
1557
1529
  },
1530
+ user: {
1531
+ type: "object",
1532
+ properties: {
1533
+ tags: {
1534
+ type: "object",
1535
+ additionalProperties: {
1536
+ type: "object",
1537
+ properties: {
1538
+ title: {
1539
+ type: "string",
1540
+ description: "Title of the tag",
1541
+ },
1542
+ description: {
1543
+ type: "string",
1544
+ description: "Description of the tag",
1545
+ },
1546
+ },
1547
+ description:
1548
+ "Definition of a tag that can be provided on the object",
1549
+ additionalProperties: false,
1550
+ },
1551
+ },
1552
+ },
1553
+ additionalProperties: false,
1554
+ },
1555
+ conversation: {
1556
+ type: "object",
1557
+ properties: {
1558
+ tags: {
1559
+ type: "object",
1560
+ additionalProperties: {
1561
+ type: "object",
1562
+ properties: {
1563
+ title: {
1564
+ type: "string",
1565
+ description: "Title of the tag",
1566
+ },
1567
+ description: {
1568
+ type: "string",
1569
+ description: "Description of the tag",
1570
+ },
1571
+ },
1572
+ description:
1573
+ "Definition of a tag that can be provided on the object",
1574
+ additionalProperties: false,
1575
+ },
1576
+ },
1577
+ },
1578
+ additionalProperties: false,
1579
+ },
1580
+ message: {
1581
+ type: "object",
1582
+ properties: {
1583
+ tags: {
1584
+ type: "object",
1585
+ additionalProperties: {
1586
+ type: "object",
1587
+ properties: {
1588
+ title: {
1589
+ type: "string",
1590
+ description: "Title of the tag",
1591
+ },
1592
+ description: {
1593
+ type: "string",
1594
+ description: "Description of the tag",
1595
+ },
1596
+ },
1597
+ description:
1598
+ "Definition of a tag that can be provided on the object",
1599
+ additionalProperties: false,
1600
+ },
1601
+ },
1602
+ },
1603
+ additionalProperties: false,
1604
+ },
1558
1605
  code: {
1559
1606
  type: "string",
1560
1607
  description: "JavaScript code of the bot",
@@ -1641,61 +1688,102 @@ export const state = {
1641
1688
  description:
1642
1689
  "Type of the [Bot](#schema_bot) authentication (`iam`)",
1643
1690
  },
1644
- states: {
1691
+ configuration: {
1645
1692
  type: "object",
1646
- additionalProperties: {
1647
- type: "object",
1648
- properties: {
1649
- type: {
1650
- type: "string",
1651
- enum: ["conversation", "user", "bot"],
1652
- description:
1653
- "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)",
1654
- },
1655
- schema: {
1693
+ properties: {
1694
+ data: {
1695
+ type: "object",
1696
+ additionalProperties: true,
1697
+ description: "Configuration data",
1698
+ },
1699
+ schema: {
1700
+ type: "object",
1701
+ additionalProperties: true,
1702
+ description:
1703
+ "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.",
1704
+ },
1705
+ },
1706
+ additionalProperties: false,
1707
+ },
1708
+ blocked: {
1709
+ type: "boolean",
1710
+ },
1711
+ user: {
1712
+ type: "object",
1713
+ properties: {
1714
+ tags: {
1715
+ type: "object",
1716
+ additionalProperties: {
1656
1717
  type: "object",
1657
- additionalProperties: true,
1658
- description:
1659
- "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.",
1660
- },
1661
- expiry: {
1662
- type: "number",
1663
- minimum: 1,
1718
+ properties: {
1719
+ title: {
1720
+ type: "string",
1721
+ description: "Title of the tag",
1722
+ },
1723
+ description: {
1724
+ type: "string",
1725
+ description: "Description of the tag",
1726
+ },
1727
+ },
1664
1728
  description:
1665
- "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.",
1729
+ "Definition of a tag that can be provided on the object",
1730
+ nullable: true,
1731
+ additionalProperties: false,
1666
1732
  },
1667
1733
  },
1668
- required: ["type", "schema"],
1669
- additionalProperties: false,
1670
1734
  },
1671
- description: "A mapping of states to their definition",
1735
+ additionalProperties: false,
1672
1736
  },
1673
- tags: {
1737
+ message: {
1674
1738
  type: "object",
1675
1739
  properties: {
1676
- messages: {
1677
- default: [],
1678
- type: "array",
1679
- items: {
1680
- type: "string",
1681
- },
1682
- },
1683
- conversations: {
1684
- default: [],
1685
- type: "array",
1686
- items: {
1687
- type: "string",
1740
+ tags: {
1741
+ type: "object",
1742
+ additionalProperties: {
1743
+ type: "object",
1744
+ properties: {
1745
+ title: {
1746
+ type: "string",
1747
+ description: "Title of the tag",
1748
+ },
1749
+ description: {
1750
+ type: "string",
1751
+ description: "Description of the tag",
1752
+ },
1753
+ },
1754
+ description:
1755
+ "Definition of a tag that can be provided on the object",
1756
+ nullable: true,
1757
+ additionalProperties: false,
1688
1758
  },
1689
1759
  },
1690
- users: {
1691
- default: [],
1692
- type: "array",
1693
- items: {
1694
- type: "string",
1760
+ },
1761
+ additionalProperties: false,
1762
+ },
1763
+ conversation: {
1764
+ type: "object",
1765
+ properties: {
1766
+ tags: {
1767
+ type: "object",
1768
+ additionalProperties: {
1769
+ type: "object",
1770
+ properties: {
1771
+ title: {
1772
+ type: "string",
1773
+ description: "Title of the tag",
1774
+ },
1775
+ description: {
1776
+ type: "string",
1777
+ description: "Description of the tag",
1778
+ },
1779
+ },
1780
+ description:
1781
+ "Definition of a tag that can be provided on the object",
1782
+ nullable: true,
1783
+ additionalProperties: false,
1695
1784
  },
1696
1785
  },
1697
1786
  },
1698
- description: "Tags of the bot",
1699
1787
  additionalProperties: false,
1700
1788
  },
1701
1789
  events: {
@@ -1709,10 +1797,39 @@ export const state = {
1709
1797
  },
1710
1798
  },
1711
1799
  required: ["schema"],
1712
- description: "Event schema",
1800
+ description: "Event Definition",
1801
+ nullable: true,
1802
+ additionalProperties: false,
1803
+ },
1804
+ },
1805
+ states: {
1806
+ type: "object",
1807
+ additionalProperties: {
1808
+ type: "object",
1809
+ properties: {
1810
+ type: {
1811
+ type: "string",
1812
+ enum: ["conversation", "user", "bot"],
1813
+ description:
1814
+ "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)",
1815
+ },
1816
+ schema: {
1817
+ type: "object",
1818
+ additionalProperties: true,
1819
+ description:
1820
+ "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.",
1821
+ },
1822
+ expiry: {
1823
+ type: "number",
1824
+ minimum: 1,
1825
+ description:
1826
+ "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.",
1827
+ },
1828
+ },
1829
+ required: ["type", "schema"],
1830
+ nullable: true,
1713
1831
  additionalProperties: false,
1714
1832
  },
1715
- description: "Events definition",
1716
1833
  },
1717
1834
  recurringEvents: {
1718
1835
  type: "object",
@@ -1738,29 +1855,9 @@ export const state = {
1738
1855
  },
1739
1856
  },
1740
1857
  required: ["schedule", "type", "payload"],
1858
+ nullable: true,
1741
1859
  additionalProperties: false,
1742
1860
  },
1743
- description: "Recurring events",
1744
- },
1745
- configuration: {
1746
- type: "object",
1747
- properties: {
1748
- data: {
1749
- type: "object",
1750
- additionalProperties: true,
1751
- description: "Configuration data",
1752
- },
1753
- schema: {
1754
- type: "object",
1755
- additionalProperties: true,
1756
- description:
1757
- "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.",
1758
- },
1759
- },
1760
- additionalProperties: false,
1761
- },
1762
- blocked: {
1763
- type: "boolean",
1764
1861
  },
1765
1862
  integrations: {
1766
1863
  type: "object",
@@ -2174,8 +2271,12 @@ export const state = {
2174
2271
  updatedAt: {
2175
2272
  type: "string",
2176
2273
  },
2274
+ botCount: {
2275
+ type: "number",
2276
+ },
2177
2277
  accountType: {
2178
2278
  type: "string",
2279
+ enum: ["free", "premium"],
2179
2280
  },
2180
2281
  blocked: {
2181
2282
  type: "boolean",
@@ -2190,6 +2291,7 @@ export const state = {
2190
2291
  "ownerId",
2191
2292
  "createdAt",
2192
2293
  "updatedAt",
2294
+ "botCount",
2193
2295
  "accountType",
2194
2296
  "blocked",
2195
2297
  "spendingLimit",
@@ -2199,39 +2301,125 @@ export const state = {
2199
2301
  },
2200
2302
  },
2201
2303
  },
2202
- listWorkspaces: {
2203
- name: "listWorkspaces",
2204
- description: "List workspaces the user has access to",
2205
- method: "get",
2206
- path: "/v1/admin/workspaces",
2207
- disableDefaultParameters: {
2208
- "x-workspace-id": true,
2209
- },
2304
+ updateWorkspace: {
2305
+ name: "updateWorkspace",
2306
+ description: "Update workspace",
2307
+ method: "put",
2308
+ path: "/v1/admin/workspaces/{id}",
2210
2309
  parameters: {
2211
- nextToken: {
2212
- in: "query",
2213
- description:
2214
- "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
2310
+ id: {
2215
2311
  type: "string",
2312
+ description: "Workspace ID",
2313
+ in: "path",
2216
2314
  },
2217
2315
  },
2218
- response: {
2219
- description: "Success",
2316
+ requestBody: {
2317
+ description: "Workspace metadata",
2220
2318
  schema: {
2221
2319
  type: "object",
2222
2320
  properties: {
2223
- workspaces: {
2224
- type: "array",
2225
- items: {
2226
- type: "object",
2227
- properties: {
2228
- id: {
2229
- type: "string",
2230
- },
2231
- name: {
2232
- type: "string",
2233
- },
2234
- ownerId: {
2321
+ name: {
2322
+ type: "string",
2323
+ minLength: 1,
2324
+ maxLength: 64,
2325
+ },
2326
+ accountType: {
2327
+ type: "string",
2328
+ enum: ["free", "premium"],
2329
+ },
2330
+ spendingLimit: {
2331
+ type: "number",
2332
+ minimum: 5,
2333
+ maximum: 1000,
2334
+ },
2335
+ },
2336
+ title: "updateWorkspaceBody",
2337
+ additionalProperties: false,
2338
+ },
2339
+ },
2340
+ response: {
2341
+ description: "Success",
2342
+ schema: {
2343
+ type: "object",
2344
+ properties: {
2345
+ id: {
2346
+ type: "string",
2347
+ },
2348
+ name: {
2349
+ type: "string",
2350
+ },
2351
+ ownerId: {
2352
+ type: "string",
2353
+ },
2354
+ createdAt: {
2355
+ type: "string",
2356
+ },
2357
+ updatedAt: {
2358
+ type: "string",
2359
+ },
2360
+ botCount: {
2361
+ type: "number",
2362
+ },
2363
+ accountType: {
2364
+ type: "string",
2365
+ enum: ["free", "premium"],
2366
+ },
2367
+ blocked: {
2368
+ type: "boolean",
2369
+ },
2370
+ spendingLimit: {
2371
+ type: "number",
2372
+ },
2373
+ },
2374
+ required: [
2375
+ "id",
2376
+ "name",
2377
+ "ownerId",
2378
+ "createdAt",
2379
+ "updatedAt",
2380
+ "botCount",
2381
+ "accountType",
2382
+ "blocked",
2383
+ "spendingLimit",
2384
+ ],
2385
+ title: "updateWorkspaceResponse",
2386
+ additionalProperties: false,
2387
+ },
2388
+ },
2389
+ },
2390
+ listWorkspaces: {
2391
+ name: "listWorkspaces",
2392
+ description: "List workspaces the user has access to",
2393
+ method: "get",
2394
+ path: "/v1/admin/workspaces",
2395
+ disableDefaultParameters: {
2396
+ "x-workspace-id": true,
2397
+ },
2398
+ parameters: {
2399
+ nextToken: {
2400
+ in: "query",
2401
+ description:
2402
+ "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
2403
+ type: "string",
2404
+ },
2405
+ },
2406
+ response: {
2407
+ description: "Success",
2408
+ schema: {
2409
+ type: "object",
2410
+ properties: {
2411
+ workspaces: {
2412
+ type: "array",
2413
+ items: {
2414
+ type: "object",
2415
+ properties: {
2416
+ id: {
2417
+ type: "string",
2418
+ },
2419
+ name: {
2420
+ type: "string",
2421
+ },
2422
+ ownerId: {
2235
2423
  type: "string",
2236
2424
  },
2237
2425
  createdAt: {
@@ -2240,8 +2428,23 @@ export const state = {
2240
2428
  updatedAt: {
2241
2429
  type: "string",
2242
2430
  },
2431
+ botCount: {
2432
+ type: "number",
2433
+ },
2434
+ accountType: {
2435
+ type: "string",
2436
+ enum: ["free", "premium"],
2437
+ },
2243
2438
  },
2244
- required: ["id", "name", "ownerId", "createdAt", "updatedAt"],
2439
+ required: [
2440
+ "id",
2441
+ "name",
2442
+ "ownerId",
2443
+ "createdAt",
2444
+ "updatedAt",
2445
+ "botCount",
2446
+ "accountType",
2447
+ ],
2245
2448
  },
2246
2449
  },
2247
2450
  meta: {
@@ -2281,93 +2484,20 @@ export const state = {
2281
2484
  type: "string",
2282
2485
  description: "Version of the [Integration](#schema_integration)",
2283
2486
  },
2284
- tags: {
2487
+ configuration: {
2285
2488
  type: "object",
2286
2489
  properties: {
2287
- users: {
2288
- default: [],
2289
- type: "array",
2290
- items: {
2291
- type: "string",
2292
- },
2490
+ schema: {
2491
+ type: "object",
2492
+ additionalProperties: true,
2493
+ description:
2494
+ "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.",
2293
2495
  },
2294
2496
  },
2295
- description: "Tags of the [Integration](#schema_integration)",
2497
+ required: ["schema"],
2498
+ description: "Configuration definition",
2296
2499
  additionalProperties: false,
2297
2500
  },
2298
- channels: {
2299
- type: "object",
2300
- additionalProperties: {
2301
- type: "object",
2302
- properties: {
2303
- tags: {
2304
- type: "object",
2305
- properties: {
2306
- messages: {
2307
- default: [],
2308
- type: "array",
2309
- items: {
2310
- type: "string",
2311
- },
2312
- },
2313
- conversations: {
2314
- default: [],
2315
- type: "array",
2316
- items: {
2317
- type: "string",
2318
- },
2319
- },
2320
- },
2321
- additionalProperties: false,
2322
- },
2323
- messages: {
2324
- type: "object",
2325
- additionalProperties: {
2326
- type: "object",
2327
- properties: {
2328
- schema: {
2329
- type: "object",
2330
- additionalProperties: true,
2331
- },
2332
- },
2333
- required: ["schema"],
2334
- additionalProperties: false,
2335
- },
2336
- },
2337
- conversation: {
2338
- type: "object",
2339
- properties: {
2340
- creation: {
2341
- type: "object",
2342
- properties: {
2343
- enabled: {
2344
- type: "boolean",
2345
- description: "Enable conversation creation",
2346
- },
2347
- requiredTags: {
2348
- type: "array",
2349
- items: {
2350
- type: "string",
2351
- },
2352
- description:
2353
- "The list of tags that are required to be specified when calling the API directly to create a conversation.",
2354
- },
2355
- },
2356
- required: ["enabled", "requiredTags"],
2357
- description:
2358
- "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.",
2359
- additionalProperties: false,
2360
- },
2361
- },
2362
- required: ["creation"],
2363
- additionalProperties: false,
2364
- },
2365
- },
2366
- required: ["messages"],
2367
- additionalProperties: false,
2368
- },
2369
- description: "Channels definition",
2370
- },
2371
2501
  states: {
2372
2502
  type: "object",
2373
2503
  additionalProperties: {
@@ -2387,22 +2517,9 @@ export const state = {
2387
2517
  },
2388
2518
  },
2389
2519
  required: ["type", "schema"],
2520
+ description: "State definition",
2390
2521
  additionalProperties: false,
2391
2522
  },
2392
- description: "States definition",
2393
- },
2394
- configuration: {
2395
- type: "object",
2396
- properties: {
2397
- schema: {
2398
- type: "object",
2399
- additionalProperties: true,
2400
- description: "Schema for the configuration",
2401
- },
2402
- },
2403
- required: ["schema"],
2404
- description: "Configuration definition",
2405
- additionalProperties: false,
2406
2523
  },
2407
2524
  events: {
2408
2525
  type: "object",
@@ -2415,10 +2532,9 @@ export const state = {
2415
2532
  },
2416
2533
  },
2417
2534
  required: ["schema"],
2418
- description: "Event schema",
2535
+ description: "Event Definition",
2419
2536
  additionalProperties: false,
2420
2537
  },
2421
- description: "Events definition",
2422
2538
  },
2423
2539
  actions: {
2424
2540
  type: "object",
@@ -2449,9 +2565,105 @@ export const state = {
2449
2565
  },
2450
2566
  },
2451
2567
  required: ["input", "output"],
2568
+ description: "Action definition",
2569
+ additionalProperties: false,
2570
+ },
2571
+ },
2572
+ channels: {
2573
+ type: "object",
2574
+ additionalProperties: {
2575
+ type: "object",
2576
+ properties: {
2577
+ messages: {
2578
+ type: "object",
2579
+ additionalProperties: {
2580
+ type: "object",
2581
+ properties: {
2582
+ schema: {
2583
+ type: "object",
2584
+ additionalProperties: true,
2585
+ },
2586
+ },
2587
+ required: ["schema"],
2588
+ description: "Message definition",
2589
+ additionalProperties: false,
2590
+ },
2591
+ },
2592
+ conversation: {
2593
+ type: "object",
2594
+ properties: {
2595
+ creation: {
2596
+ type: "object",
2597
+ properties: {
2598
+ enabled: {
2599
+ type: "boolean",
2600
+ description: "Enable conversation creation",
2601
+ },
2602
+ requiredTags: {
2603
+ type: "array",
2604
+ items: {
2605
+ type: "string",
2606
+ },
2607
+ description:
2608
+ "The list of tags that are required to be specified when calling the API directly to create a conversation.",
2609
+ },
2610
+ },
2611
+ required: ["enabled", "requiredTags"],
2612
+ description:
2613
+ "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.",
2614
+ additionalProperties: false,
2615
+ },
2616
+ tags: {
2617
+ type: "object",
2618
+ additionalProperties: {
2619
+ type: "object",
2620
+ properties: {
2621
+ title: {
2622
+ type: "string",
2623
+ description: "Title of the tag",
2624
+ },
2625
+ description: {
2626
+ type: "string",
2627
+ description: "Description of the tag",
2628
+ },
2629
+ },
2630
+ description:
2631
+ "Definition of a tag that can be provided on the object",
2632
+ additionalProperties: false,
2633
+ },
2634
+ },
2635
+ },
2636
+ additionalProperties: false,
2637
+ },
2638
+ message: {
2639
+ type: "object",
2640
+ properties: {
2641
+ tags: {
2642
+ type: "object",
2643
+ additionalProperties: {
2644
+ type: "object",
2645
+ properties: {
2646
+ title: {
2647
+ type: "string",
2648
+ description: "Title of the tag",
2649
+ },
2650
+ description: {
2651
+ type: "string",
2652
+ description: "Description of the tag",
2653
+ },
2654
+ },
2655
+ description:
2656
+ "Definition of a tag that can be provided on the object",
2657
+ additionalProperties: false,
2658
+ },
2659
+ },
2660
+ },
2661
+ additionalProperties: false,
2662
+ },
2663
+ },
2664
+ required: ["messages"],
2452
2665
  additionalProperties: false,
2453
2666
  },
2454
- description: "Action definition",
2455
2667
  },
2456
2668
  user: {
2457
2669
  type: "object",
@@ -2477,18 +2689,32 @@ export const state = {
2477
2689
  "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.",
2478
2690
  additionalProperties: false,
2479
2691
  },
2692
+ tags: {
2693
+ type: "object",
2694
+ additionalProperties: {
2695
+ type: "object",
2696
+ properties: {
2697
+ title: {
2698
+ type: "string",
2699
+ description: "Title of the tag",
2700
+ },
2701
+ description: {
2702
+ type: "string",
2703
+ description: "Description of the tag",
2704
+ },
2705
+ },
2706
+ description:
2707
+ "Definition of a tag that can be provided on the object",
2708
+ additionalProperties: false,
2709
+ },
2710
+ },
2480
2711
  },
2481
- required: ["creation"],
2482
2712
  additionalProperties: false,
2483
2713
  },
2484
2714
  code: {
2485
2715
  type: "string",
2486
2716
  description: "JavaScript code of the integration",
2487
2717
  },
2488
- public: {
2489
- type: "boolean",
2490
- description: "Whether the integration is public",
2491
- },
2492
2718
  url: {
2493
2719
  type: "string",
2494
2720
  description:
@@ -2562,18 +2788,18 @@ export const state = {
2562
2788
  schema: {
2563
2789
  type: "object",
2564
2790
  properties: {
2565
- tags: {
2791
+ configuration: {
2566
2792
  type: "object",
2567
2793
  properties: {
2568
- users: {
2569
- default: [],
2570
- type: "array",
2571
- items: {
2572
- type: "string",
2573
- },
2794
+ schema: {
2795
+ type: "object",
2796
+ additionalProperties: true,
2797
+ description:
2798
+ "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.",
2574
2799
  },
2575
2800
  },
2576
- description: "Tags of the [Integration](#schema_integration)",
2801
+ required: ["schema"],
2802
+ description: "Configuration definition",
2577
2803
  additionalProperties: false,
2578
2804
  },
2579
2805
  channels: {
@@ -2581,26 +2807,6 @@ export const state = {
2581
2807
  additionalProperties: {
2582
2808
  type: "object",
2583
2809
  properties: {
2584
- tags: {
2585
- type: "object",
2586
- properties: {
2587
- messages: {
2588
- default: [],
2589
- type: "array",
2590
- items: {
2591
- type: "string",
2592
- },
2593
- },
2594
- conversations: {
2595
- default: [],
2596
- type: "array",
2597
- items: {
2598
- type: "string",
2599
- },
2600
- },
2601
- },
2602
- additionalProperties: false,
2603
- },
2604
2810
  messages: {
2605
2811
  type: "object",
2606
2812
  additionalProperties: {
@@ -2612,6 +2818,8 @@ export const state = {
2612
2818
  },
2613
2819
  },
2614
2820
  required: ["schema"],
2821
+ description: "Message definition",
2822
+ nullable: true,
2615
2823
  additionalProperties: false,
2616
2824
  },
2617
2825
  },
@@ -2639,51 +2847,92 @@ export const state = {
2639
2847
  "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.",
2640
2848
  additionalProperties: false,
2641
2849
  },
2850
+ tags: {
2851
+ type: "object",
2852
+ additionalProperties: {
2853
+ type: "object",
2854
+ properties: {
2855
+ title: {
2856
+ type: "string",
2857
+ description: "Title of the tag",
2858
+ },
2859
+ description: {
2860
+ type: "string",
2861
+ description: "Description of the tag",
2862
+ },
2863
+ },
2864
+ description:
2865
+ "Definition of a tag that can be provided on the object",
2866
+ nullable: true,
2867
+ additionalProperties: false,
2868
+ },
2869
+ },
2870
+ },
2871
+ additionalProperties: false,
2872
+ },
2873
+ message: {
2874
+ type: "object",
2875
+ properties: {
2876
+ tags: {
2877
+ type: "object",
2878
+ additionalProperties: {
2879
+ type: "object",
2880
+ properties: {
2881
+ title: {
2882
+ type: "string",
2883
+ description: "Title of the tag",
2884
+ },
2885
+ description: {
2886
+ type: "string",
2887
+ description: "Description of the tag",
2888
+ },
2889
+ },
2890
+ description:
2891
+ "Definition of a tag that can be provided on the object",
2892
+ nullable: true,
2893
+ additionalProperties: false,
2894
+ },
2895
+ },
2642
2896
  },
2643
- required: ["creation"],
2644
2897
  additionalProperties: false,
2645
2898
  },
2646
2899
  },
2647
- required: ["messages"],
2648
2900
  additionalProperties: false,
2649
2901
  },
2650
- description: "Channels definition",
2651
2902
  },
2652
- states: {
2903
+ actions: {
2653
2904
  type: "object",
2654
2905
  additionalProperties: {
2655
2906
  type: "object",
2656
2907
  properties: {
2657
- type: {
2658
- type: "string",
2659
- enum: ["conversation", "user", "integration"],
2660
- description:
2661
- "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)",
2908
+ input: {
2909
+ type: "object",
2910
+ properties: {
2911
+ schema: {
2912
+ type: "object",
2913
+ additionalProperties: true,
2914
+ },
2915
+ },
2916
+ required: ["schema"],
2917
+ additionalProperties: false,
2662
2918
  },
2663
- schema: {
2919
+ output: {
2664
2920
  type: "object",
2665
- additionalProperties: true,
2666
- description:
2667
- "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.",
2921
+ properties: {
2922
+ schema: {
2923
+ type: "object",
2924
+ additionalProperties: true,
2925
+ },
2926
+ },
2927
+ required: ["schema"],
2928
+ additionalProperties: false,
2668
2929
  },
2669
2930
  },
2670
- required: ["type", "schema"],
2931
+ required: ["input", "output"],
2932
+ description: "Action definition",
2933
+ nullable: true,
2671
2934
  additionalProperties: false,
2672
2935
  },
2673
- description: "States definition",
2674
- },
2675
- configuration: {
2676
- type: "object",
2677
- properties: {
2678
- schema: {
2679
- type: "object",
2680
- additionalProperties: true,
2681
- description: "Schema for the configuration",
2682
- },
2683
- },
2684
- required: ["schema"],
2685
- description: "Configuration definition",
2686
- additionalProperties: false,
2687
2936
  },
2688
2937
  events: {
2689
2938
  type: "object",
@@ -2696,43 +2945,34 @@ export const state = {
2696
2945
  },
2697
2946
  },
2698
2947
  required: ["schema"],
2699
- description: "Event schema",
2948
+ description: "Event Definition",
2949
+ nullable: true,
2700
2950
  additionalProperties: false,
2701
2951
  },
2702
- description: "Events definition",
2703
2952
  },
2704
- actions: {
2953
+ states: {
2705
2954
  type: "object",
2706
2955
  additionalProperties: {
2707
2956
  type: "object",
2708
2957
  properties: {
2709
- input: {
2710
- type: "object",
2711
- properties: {
2712
- schema: {
2713
- type: "object",
2714
- additionalProperties: true,
2715
- },
2716
- },
2717
- required: ["schema"],
2718
- additionalProperties: false,
2958
+ type: {
2959
+ type: "string",
2960
+ enum: ["conversation", "user", "integration"],
2961
+ description:
2962
+ "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)",
2719
2963
  },
2720
- output: {
2964
+ schema: {
2721
2965
  type: "object",
2722
- properties: {
2723
- schema: {
2724
- type: "object",
2725
- additionalProperties: true,
2726
- },
2727
- },
2728
- required: ["schema"],
2729
- additionalProperties: false,
2966
+ additionalProperties: true,
2967
+ description:
2968
+ "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.",
2730
2969
  },
2731
2970
  },
2732
- required: ["input", "output"],
2971
+ required: ["type", "schema"],
2972
+ description: "State definition",
2973
+ nullable: true,
2733
2974
  additionalProperties: false,
2734
2975
  },
2735
- description: "Action definition",
2736
2976
  },
2737
2977
  user: {
2738
2978
  type: "object",
@@ -2758,23 +2998,33 @@ export const state = {
2758
2998
  "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.",
2759
2999
  additionalProperties: false,
2760
3000
  },
3001
+ tags: {
3002
+ type: "object",
3003
+ additionalProperties: {
3004
+ type: "object",
3005
+ properties: {
3006
+ title: {
3007
+ type: "string",
3008
+ description: "Title of the tag",
3009
+ },
3010
+ description: {
3011
+ type: "string",
3012
+ description: "Description of the tag",
3013
+ },
3014
+ },
3015
+ description:
3016
+ "Definition of a tag that can be provided on the object",
3017
+ nullable: true,
3018
+ additionalProperties: false,
3019
+ },
3020
+ },
2761
3021
  },
2762
- required: ["creation"],
2763
3022
  additionalProperties: false,
2764
3023
  },
2765
3024
  code: {
2766
3025
  type: "string",
2767
3026
  description: "JavaScript code of the integration",
2768
3027
  },
2769
- public: {
2770
- type: "boolean",
2771
- description: "Whether the integration is public",
2772
- },
2773
- url: {
2774
- type: "string",
2775
- description:
2776
- "URL of the integration; Only available for dev integrations",
2777
- },
2778
3028
  icon: {
2779
3029
  type: "string",
2780
3030
  description:
@@ -2798,6 +3048,11 @@ export const state = {
2798
3048
  description:
2799
3049
  "Description of the integration. This is the description that will be displayed in the UI",
2800
3050
  },
3051
+ url: {
3052
+ type: "string",
3053
+ description:
3054
+ "URL of the integration; Only available for dev integrations",
3055
+ },
2801
3056
  },
2802
3057
  title: "updateIntegrationBody",
2803
3058
  additionalProperties: false,
@@ -2989,33 +3244,188 @@ export const state = {
2989
3244
  type: "string",
2990
3245
  },
2991
3246
  },
2992
- required: ["timestamp", "level", "message"],
3247
+ required: ["timestamp", "level", "message"],
3248
+ },
3249
+ },
3250
+ },
3251
+ required: ["logs"],
3252
+ title: "getIntegrationLogsResponse",
3253
+ additionalProperties: false,
3254
+ },
3255
+ },
3256
+ },
3257
+ getIntegrationByName: {
3258
+ name: "getIntegrationByName",
3259
+ description: "Get integration",
3260
+ method: "get",
3261
+ section: "integration",
3262
+ path: "/v1/admin/integrations/{name}/{version}",
3263
+ parameters: {
3264
+ name: {
3265
+ type: "string",
3266
+ description: "Integration Name",
3267
+ in: "path",
3268
+ },
3269
+ version: {
3270
+ type: "string",
3271
+ description:
3272
+ 'Integration version. Either a semver version or tag "latest"',
3273
+ in: "path",
3274
+ },
3275
+ },
3276
+ response: {
3277
+ description: "Success",
3278
+ schema: {
3279
+ type: "object",
3280
+ properties: {
3281
+ integration: {
3282
+ $ref: "#/components/schemas/Integration",
3283
+ },
3284
+ },
3285
+ required: ["integration"],
3286
+ title: "getIntegrationByNameResponse",
3287
+ additionalProperties: false,
3288
+ },
3289
+ },
3290
+ },
3291
+ deleteIntegration: {
3292
+ name: "deleteIntegration",
3293
+ description: "Delete integration",
3294
+ method: "delete",
3295
+ section: "integration",
3296
+ path: "/v1/admin/integrations/{id}",
3297
+ parameters: {
3298
+ id: {
3299
+ type: "string",
3300
+ description: "Integration Id",
3301
+ in: "path",
3302
+ },
3303
+ },
3304
+ response: {
3305
+ description: "Success",
3306
+ schema: {
3307
+ type: "object",
3308
+ title: "deleteIntegrationResponse",
3309
+ additionalProperties: false,
3310
+ },
3311
+ },
3312
+ },
3313
+ listWorkspaceMembers: {
3314
+ name: "listWorkspaceMembers",
3315
+ description: "Lists all the members in a workspace",
3316
+ method: "get",
3317
+ path: "/v1/admin/workspace-members",
3318
+ parameters: {
3319
+ nextToken: {
3320
+ in: "query",
3321
+ description:
3322
+ "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
3323
+ type: "string",
3324
+ },
3325
+ },
3326
+ response: {
3327
+ description: "Success",
3328
+ schema: {
3329
+ type: "object",
3330
+ properties: {
3331
+ members: {
3332
+ type: "array",
3333
+ items: {
3334
+ type: "object",
3335
+ properties: {
3336
+ id: {
3337
+ type: "string",
3338
+ },
3339
+ userId: {
3340
+ type: "string",
3341
+ format: "uuid",
3342
+ },
3343
+ email: {
3344
+ type: "string",
3345
+ },
3346
+ role: {
3347
+ type: "string",
3348
+ enum: [
3349
+ "viewer",
3350
+ "billing",
3351
+ "developer",
3352
+ "manager",
3353
+ "administrator",
3354
+ "owner",
3355
+ ],
3356
+ },
3357
+ },
3358
+ required: ["id", "email", "role"],
3359
+ },
3360
+ },
3361
+ meta: {
3362
+ type: "object",
3363
+ properties: {
3364
+ nextToken: {
3365
+ type: "string",
3366
+ description:
3367
+ "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.",
3368
+ },
2993
3369
  },
3370
+ additionalProperties: false,
2994
3371
  },
2995
3372
  },
2996
- required: ["logs"],
2997
- title: "getIntegrationLogsResponse",
3373
+ required: ["members", "meta"],
3374
+ title: "listWorkspaceMembersResponse",
2998
3375
  additionalProperties: false,
2999
3376
  },
3000
3377
  },
3001
3378
  },
3002
- getIntegrationByName: {
3003
- name: "getIntegrationByName",
3004
- description: "Get integration",
3005
- method: "get",
3006
- section: "integration",
3007
- path: "/v1/admin/integrations/{name}/{version}",
3379
+ deleteWorkspaceMember: {
3380
+ name: "deleteWorkspaceMember",
3381
+ description: "Remove a member of a workspace",
3382
+ method: "delete",
3383
+ path: "/v1/admin/workspace-members/{id}",
3008
3384
  parameters: {
3009
- name: {
3385
+ id: {
3010
3386
  type: "string",
3011
- description: "Integration Name",
3387
+ description: "Workspace member ID",
3012
3388
  in: "path",
3013
3389
  },
3014
- version: {
3015
- type: "string",
3016
- description:
3017
- 'Integration version. Either a semver version or tag "latest"',
3018
- in: "path",
3390
+ },
3391
+ response: {
3392
+ description: "Success",
3393
+ schema: {
3394
+ type: "object",
3395
+ title: "deleteWorkspaceMemberResponse",
3396
+ additionalProperties: false,
3397
+ },
3398
+ },
3399
+ },
3400
+ createWorkspaceMember: {
3401
+ name: "createWorkspaceMember",
3402
+ description: "Add a member to the workspace",
3403
+ method: "post",
3404
+ path: "/v1/admin/workspace-members",
3405
+ requestBody: {
3406
+ description: "Workspace member metadata",
3407
+ schema: {
3408
+ type: "object",
3409
+ properties: {
3410
+ email: {
3411
+ type: "string",
3412
+ format: "email",
3413
+ },
3414
+ role: {
3415
+ type: "string",
3416
+ enum: [
3417
+ "viewer",
3418
+ "billing",
3419
+ "developer",
3420
+ "manager",
3421
+ "administrator",
3422
+ "owner",
3423
+ ],
3424
+ },
3425
+ },
3426
+ required: ["email", "role"],
3427
+ title: "createWorkspaceMemberBody",
3428
+ additionalProperties: false,
3019
3429
  },
3020
3430
  },
3021
3431
  response: {
@@ -3023,34 +3433,97 @@ export const state = {
3023
3433
  schema: {
3024
3434
  type: "object",
3025
3435
  properties: {
3026
- integration: {
3027
- $ref: "#/components/schemas/Integration",
3436
+ id: {
3437
+ type: "string",
3438
+ },
3439
+ userId: {
3440
+ type: "string",
3441
+ format: "uuid",
3442
+ },
3443
+ email: {
3444
+ type: "string",
3445
+ },
3446
+ role: {
3447
+ type: "string",
3448
+ enum: [
3449
+ "viewer",
3450
+ "billing",
3451
+ "developer",
3452
+ "manager",
3453
+ "administrator",
3454
+ "owner",
3455
+ ],
3028
3456
  },
3029
3457
  },
3030
- required: ["integration"],
3031
- title: "getIntegrationByNameResponse",
3458
+ required: ["id", "email", "role"],
3459
+ title: "createWorkspaceMemberResponse",
3032
3460
  additionalProperties: false,
3033
3461
  },
3034
3462
  },
3463
+ parameters: {},
3035
3464
  },
3036
- deleteIntegration: {
3037
- name: "deleteIntegration",
3038
- description: "Delete integration",
3039
- method: "delete",
3040
- section: "integration",
3041
- path: "/v1/admin/integrations/{id}",
3465
+ updateWorkspaceMember: {
3466
+ name: "updateWorkspaceMember",
3467
+ description: "Update the member of a workspace",
3468
+ method: "put",
3469
+ path: "/v1/admin/workspace-members/{id}",
3042
3470
  parameters: {
3043
3471
  id: {
3044
3472
  type: "string",
3045
- description: "Integration Id",
3473
+ description: "Workspace member ID",
3046
3474
  in: "path",
3047
3475
  },
3048
3476
  },
3477
+ requestBody: {
3478
+ description: "Workspace member metadata",
3479
+ schema: {
3480
+ type: "object",
3481
+ properties: {
3482
+ role: {
3483
+ type: "string",
3484
+ enum: [
3485
+ "viewer",
3486
+ "billing",
3487
+ "developer",
3488
+ "manager",
3489
+ "administrator",
3490
+ "owner",
3491
+ ],
3492
+ },
3493
+ },
3494
+ title: "updateWorkspaceMemberBody",
3495
+ additionalProperties: false,
3496
+ },
3497
+ },
3049
3498
  response: {
3050
3499
  description: "Success",
3051
3500
  schema: {
3052
3501
  type: "object",
3053
- title: "deleteIntegrationResponse",
3502
+ properties: {
3503
+ id: {
3504
+ type: "string",
3505
+ },
3506
+ userId: {
3507
+ type: "string",
3508
+ format: "uuid",
3509
+ },
3510
+ email: {
3511
+ type: "string",
3512
+ },
3513
+ role: {
3514
+ type: "string",
3515
+ enum: [
3516
+ "viewer",
3517
+ "billing",
3518
+ "developer",
3519
+ "manager",
3520
+ "administrator",
3521
+ "owner",
3522
+ ],
3523
+ },
3524
+ },
3525
+ required: ["id", "email", "role"],
3526
+ title: "updateWorkspaceMemberResponse",
3054
3527
  additionalProperties: false,
3055
3528
  },
3056
3529
  },
@@ -3276,7 +3749,7 @@ export const state = {
3276
3749
  title: "Botpress API",
3277
3750
  description: "API for Botpress Cloud",
3278
3751
  server: "https://api.botpress.cloud",
3279
- version: "0.2.0",
3752
+ version: "0.3.1",
3280
3753
  prefix: "v1",
3281
3754
  },
3282
3755
  errors: [
@@ -3388,8 +3861,11 @@ export const state = {
3388
3861
  createBotBody: true,
3389
3862
  updateBotBody: true,
3390
3863
  transferBotBody: true,
3864
+ updateWorkspaceBody: true,
3391
3865
  createIntegrationBody: true,
3392
3866
  updateIntegrationBody: true,
3867
+ createWorkspaceMemberBody: true,
3868
+ updateWorkspaceMemberBody: true,
3393
3869
  introspectBody: true,
3394
3870
  createFileBody: true,
3395
3871
  },
@@ -3433,6 +3909,7 @@ export const state = {
3433
3909
  getBotWebchatResponse: true,
3434
3910
  getBotAnalyticsResponse: true,
3435
3911
  getWorkspaceResponse: true,
3912
+ updateWorkspaceResponse: true,
3436
3913
  listWorkspacesResponse: true,
3437
3914
  createIntegrationResponse: true,
3438
3915
  updateIntegrationResponse: true,
@@ -3441,6 +3918,10 @@ export const state = {
3441
3918
  getIntegrationLogsResponse: true,
3442
3919
  getIntegrationByNameResponse: true,
3443
3920
  deleteIntegrationResponse: true,
3921
+ listWorkspaceMembersResponse: true,
3922
+ deleteWorkspaceMemberResponse: true,
3923
+ createWorkspaceMemberResponse: true,
3924
+ updateWorkspaceMemberResponse: true,
3444
3925
  introspectResponse: true,
3445
3926
  createFileResponse: true,
3446
3927
  getFileResponse: true,
@@ -3532,6 +4013,87 @@ export const state = {
3532
4013
  },
3533
4014
  description: "A mapping of integrations to their configuration",
3534
4015
  },
4016
+ user: {
4017
+ type: "object",
4018
+ properties: {
4019
+ tags: {
4020
+ type: "object",
4021
+ additionalProperties: {
4022
+ type: "object",
4023
+ properties: {
4024
+ title: {
4025
+ type: "string",
4026
+ description: "Title of the tag",
4027
+ },
4028
+ description: {
4029
+ type: "string",
4030
+ description: "Description of the tag",
4031
+ },
4032
+ },
4033
+ description:
4034
+ "Definition of a tag that can be provided on the object",
4035
+ additionalProperties: false,
4036
+ },
4037
+ },
4038
+ },
4039
+ required: ["tags"],
4040
+ description: "User object configuration",
4041
+ additionalProperties: false,
4042
+ },
4043
+ conversation: {
4044
+ type: "object",
4045
+ properties: {
4046
+ tags: {
4047
+ type: "object",
4048
+ additionalProperties: {
4049
+ type: "object",
4050
+ properties: {
4051
+ title: {
4052
+ type: "string",
4053
+ description: "Title of the tag",
4054
+ },
4055
+ description: {
4056
+ type: "string",
4057
+ description: "Description of the tag",
4058
+ },
4059
+ },
4060
+ description:
4061
+ "Definition of a tag that can be provided on the object",
4062
+ additionalProperties: false,
4063
+ },
4064
+ },
4065
+ },
4066
+ required: ["tags"],
4067
+ description: "Conversation object configuration",
4068
+ additionalProperties: false,
4069
+ },
4070
+ message: {
4071
+ type: "object",
4072
+ properties: {
4073
+ tags: {
4074
+ type: "object",
4075
+ additionalProperties: {
4076
+ type: "object",
4077
+ properties: {
4078
+ title: {
4079
+ type: "string",
4080
+ description: "Title of the tag",
4081
+ },
4082
+ description: {
4083
+ type: "string",
4084
+ description: "Description of the tag",
4085
+ },
4086
+ },
4087
+ description:
4088
+ "Definition of a tag that can be provided on the object",
4089
+ additionalProperties: false,
4090
+ },
4091
+ },
4092
+ },
4093
+ required: ["tags"],
4094
+ description: "Message object configuration",
4095
+ additionalProperties: false,
4096
+ },
3535
4097
  states: {
3536
4098
  type: "object",
3537
4099
  additionalProperties: {
@@ -3561,34 +4123,6 @@ export const state = {
3561
4123
  },
3562
4124
  description: "A mapping of states to their definition",
3563
4125
  },
3564
- tags: {
3565
- type: "object",
3566
- properties: {
3567
- messages: {
3568
- default: [],
3569
- type: "array",
3570
- items: {
3571
- type: "string",
3572
- },
3573
- },
3574
- conversations: {
3575
- default: [],
3576
- type: "array",
3577
- items: {
3578
- type: "string",
3579
- },
3580
- },
3581
- users: {
3582
- default: [],
3583
- type: "array",
3584
- items: {
3585
- type: "string",
3586
- },
3587
- },
3588
- },
3589
- description: "Tags of the bot",
3590
- additionalProperties: false,
3591
- },
3592
4126
  configuration: {
3593
4127
  type: "object",
3594
4128
  properties: {
@@ -3619,7 +4153,7 @@ export const state = {
3619
4153
  },
3620
4154
  },
3621
4155
  required: ["schema"],
3622
- description: "Event schema",
4156
+ description: "Event Definition",
3623
4157
  additionalProperties: false,
3624
4158
  },
3625
4159
  description: "Events definition",
@@ -3696,8 +4230,10 @@ export const state = {
3696
4230
  "updatedAt",
3697
4231
  "signingSecret",
3698
4232
  "integrations",
4233
+ "user",
4234
+ "conversation",
4235
+ "message",
3699
4236
  "states",
3700
- "tags",
3701
4237
  "configuration",
3702
4238
  "events",
3703
4239
  "recurringEvents",
@@ -3737,31 +4273,25 @@ export const state = {
3737
4273
  type: "string",
3738
4274
  description: "Version of the [Integration](#schema_integration)",
3739
4275
  },
4276
+ configuration: {
4277
+ type: "object",
4278
+ properties: {
4279
+ schema: {
4280
+ type: "object",
4281
+ additionalProperties: true,
4282
+ description:
4283
+ "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.",
4284
+ },
4285
+ },
4286
+ required: ["schema"],
4287
+ description: "Configuration definition",
4288
+ additionalProperties: false,
4289
+ },
3740
4290
  channels: {
3741
4291
  type: "object",
3742
4292
  additionalProperties: {
3743
4293
  type: "object",
3744
4294
  properties: {
3745
- tags: {
3746
- type: "object",
3747
- properties: {
3748
- messages: {
3749
- default: [],
3750
- type: "array",
3751
- items: {
3752
- type: "string",
3753
- },
3754
- },
3755
- conversations: {
3756
- default: [],
3757
- type: "array",
3758
- items: {
3759
- type: "string",
3760
- },
3761
- },
3762
- },
3763
- additionalProperties: false,
3764
- },
3765
4295
  messages: {
3766
4296
  type: "object",
3767
4297
  additionalProperties: {
@@ -3773,12 +4303,32 @@ export const state = {
3773
4303
  },
3774
4304
  },
3775
4305
  required: ["schema"],
4306
+ description: "Message definition",
3776
4307
  additionalProperties: false,
3777
4308
  },
3778
4309
  },
3779
4310
  conversation: {
3780
4311
  type: "object",
3781
4312
  properties: {
4313
+ tags: {
4314
+ type: "object",
4315
+ additionalProperties: {
4316
+ type: "object",
4317
+ properties: {
4318
+ title: {
4319
+ type: "string",
4320
+ description: "Title of the tag",
4321
+ },
4322
+ description: {
4323
+ type: "string",
4324
+ description: "Description of the tag",
4325
+ },
4326
+ },
4327
+ description:
4328
+ "Definition of a tag that can be provided on the object",
4329
+ additionalProperties: false,
4330
+ },
4331
+ },
3782
4332
  creation: {
3783
4333
  type: "object",
3784
4334
  properties: {
@@ -3801,17 +4351,44 @@ export const state = {
3801
4351
  additionalProperties: false,
3802
4352
  },
3803
4353
  },
3804
- required: ["creation"],
4354
+ required: ["tags", "creation"],
4355
+ description: "Conversation object configuration",
4356
+ additionalProperties: false,
4357
+ },
4358
+ message: {
4359
+ type: "object",
4360
+ properties: {
4361
+ tags: {
4362
+ type: "object",
4363
+ additionalProperties: {
4364
+ type: "object",
4365
+ properties: {
4366
+ title: {
4367
+ type: "string",
4368
+ description: "Title of the tag",
4369
+ },
4370
+ description: {
4371
+ type: "string",
4372
+ description: "Description of the tag",
4373
+ },
4374
+ },
4375
+ description:
4376
+ "Definition of a tag that can be provided on the object",
4377
+ additionalProperties: false,
4378
+ },
4379
+ },
4380
+ },
4381
+ required: ["tags"],
4382
+ description: "Message object configuration",
3805
4383
  additionalProperties: false,
3806
4384
  },
3807
4385
  },
3808
- required: ["tags", "messages", "conversation"],
4386
+ required: ["messages", "conversation", "message"],
4387
+ description: "Channel definition",
3809
4388
  additionalProperties: false,
3810
4389
  },
3811
- description: "Channels definition",
3812
4390
  },
3813
4391
  states: {
3814
- default: {},
3815
4392
  type: "object",
3816
4393
  additionalProperties: {
3817
4394
  type: "object",
@@ -3830,22 +4407,9 @@ export const state = {
3830
4407
  },
3831
4408
  },
3832
4409
  required: ["type", "schema"],
4410
+ description: "State definition",
3833
4411
  additionalProperties: false,
3834
4412
  },
3835
- description: "States definition",
3836
- },
3837
- configuration: {
3838
- type: "object",
3839
- properties: {
3840
- schema: {
3841
- type: "object",
3842
- additionalProperties: true,
3843
- description: "Schema for the configuration",
3844
- },
3845
- },
3846
- required: ["schema"],
3847
- description: "Configuration definition",
3848
- additionalProperties: false,
3849
4413
  },
3850
4414
  events: {
3851
4415
  type: "object",
@@ -3858,10 +4422,9 @@ export const state = {
3858
4422
  },
3859
4423
  },
3860
4424
  required: ["schema"],
3861
- description: "Event schema",
4425
+ description: "Event Definition",
3862
4426
  additionalProperties: false,
3863
4427
  },
3864
- description: "Events definition",
3865
4428
  },
3866
4429
  actions: {
3867
4430
  type: "object",
@@ -3892,13 +4455,32 @@ export const state = {
3892
4455
  },
3893
4456
  },
3894
4457
  required: ["input", "output"],
4458
+ description: "Action definition",
3895
4459
  additionalProperties: false,
3896
4460
  },
3897
- description: "Action definition",
3898
4461
  },
3899
4462
  user: {
3900
4463
  type: "object",
3901
4464
  properties: {
4465
+ tags: {
4466
+ type: "object",
4467
+ additionalProperties: {
4468
+ type: "object",
4469
+ properties: {
4470
+ title: {
4471
+ type: "string",
4472
+ description: "Title of the tag",
4473
+ },
4474
+ description: {
4475
+ type: "string",
4476
+ description: "Description of the tag",
4477
+ },
4478
+ },
4479
+ description:
4480
+ "Definition of a tag that can be provided on the object",
4481
+ additionalProperties: false,
4482
+ },
4483
+ },
3902
4484
  creation: {
3903
4485
  type: "object",
3904
4486
  properties: {
@@ -3921,7 +4503,8 @@ export const state = {
3921
4503
  additionalProperties: false,
3922
4504
  },
3923
4505
  },
3924
- required: ["creation"],
4506
+ required: ["tags", "creation"],
4507
+ description: "User object configuration",
3925
4508
  additionalProperties: false,
3926
4509
  },
3927
4510
  dev: {
@@ -3959,8 +4542,9 @@ export const state = {
3959
4542
  "updatedAt",
3960
4543
  "name",
3961
4544
  "version",
3962
- "channels",
3963
4545
  "configuration",
4546
+ "channels",
4547
+ "states",
3964
4548
  "events",
3965
4549
  "actions",
3966
4550
  "user",
@@ -3993,8 +4577,12 @@ export const state = {
3993
4577
  updatedAt: {
3994
4578
  type: "string",
3995
4579
  },
4580
+ botCount: {
4581
+ type: "number",
4582
+ },
3996
4583
  accountType: {
3997
4584
  type: "string",
4585
+ enum: ["free", "premium"],
3998
4586
  },
3999
4587
  blocked: {
4000
4588
  type: "boolean",
@@ -4009,6 +4597,7 @@ export const state = {
4009
4597
  "ownerId",
4010
4598
  "createdAt",
4011
4599
  "updatedAt",
4600
+ "botCount",
4012
4601
  "accountType",
4013
4602
  "blocked",
4014
4603
  "spendingLimit",