@botpress/api 0.16.0 → 0.16.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.
@@ -1,5 +1,5 @@
1
1
  import * as opapi from "@bpinternal/opapi";
2
- export type State = opapi.State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File" | "Table" | "Column" | "Row", never, "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "tables">;
2
+ export type State = opapi.State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "File" | "Table" | "Column" | "Row", never, "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "task" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "tables">;
3
3
  export declare const state: {
4
4
  operations: {
5
5
  createConversation: {
@@ -1404,6 +1404,279 @@ export declare const state: {
1404
1404
  };
1405
1405
  parameters: {};
1406
1406
  };
1407
+ getTask: {
1408
+ name: string;
1409
+ description: string;
1410
+ method: "get";
1411
+ path: string;
1412
+ parameters: {
1413
+ id: {
1414
+ in: "path";
1415
+ type: "string";
1416
+ description: string;
1417
+ };
1418
+ };
1419
+ section: "task";
1420
+ response: {
1421
+ description: string;
1422
+ schema: {
1423
+ type: "object";
1424
+ properties: {
1425
+ task: {
1426
+ $ref: string;
1427
+ };
1428
+ };
1429
+ required: string[];
1430
+ title: string;
1431
+ additionalProperties: false;
1432
+ };
1433
+ };
1434
+ };
1435
+ createTask: {
1436
+ name: string;
1437
+ description: string;
1438
+ method: "post";
1439
+ path: string;
1440
+ requestBody: {
1441
+ description: string;
1442
+ schema: {
1443
+ type: "object";
1444
+ properties: {
1445
+ title: {
1446
+ type: "string";
1447
+ description: string;
1448
+ };
1449
+ instruction: {
1450
+ type: "string";
1451
+ description: string;
1452
+ };
1453
+ type: {
1454
+ type: "string";
1455
+ description: string;
1456
+ };
1457
+ data: {
1458
+ type: "object";
1459
+ additionalProperties: true;
1460
+ description: string;
1461
+ };
1462
+ parentTaskId: {
1463
+ type: "string";
1464
+ description: string;
1465
+ };
1466
+ conversationId: {
1467
+ type: "string";
1468
+ description: string;
1469
+ };
1470
+ userId: {
1471
+ type: "string";
1472
+ description: string;
1473
+ };
1474
+ timeoutAt: {
1475
+ type: "string";
1476
+ format: string;
1477
+ description: string;
1478
+ };
1479
+ tags: {
1480
+ type: "object";
1481
+ additionalProperties: {
1482
+ type: "string";
1483
+ maxLength: number;
1484
+ };
1485
+ description: string;
1486
+ };
1487
+ };
1488
+ required: string[];
1489
+ title: string;
1490
+ additionalProperties: false;
1491
+ };
1492
+ };
1493
+ section: "task";
1494
+ response: {
1495
+ description: string;
1496
+ status: 201;
1497
+ schema: {
1498
+ type: "object";
1499
+ properties: {
1500
+ task: {
1501
+ $ref: string;
1502
+ };
1503
+ };
1504
+ required: string[];
1505
+ title: string;
1506
+ additionalProperties: false;
1507
+ };
1508
+ };
1509
+ parameters: {};
1510
+ };
1511
+ updateTask: {
1512
+ name: string;
1513
+ description: string;
1514
+ method: "put";
1515
+ path: string;
1516
+ parameters: {
1517
+ id: {
1518
+ in: "path";
1519
+ type: "string";
1520
+ description: string;
1521
+ };
1522
+ };
1523
+ requestBody: {
1524
+ description: string;
1525
+ schema: {
1526
+ type: "object";
1527
+ properties: {
1528
+ title: {
1529
+ type: "string";
1530
+ description: string;
1531
+ };
1532
+ instruction: {
1533
+ type: "string";
1534
+ description: string;
1535
+ };
1536
+ data: {
1537
+ type: "object";
1538
+ additionalProperties: true;
1539
+ description: string;
1540
+ };
1541
+ timeoutAt: {
1542
+ type: "string";
1543
+ format: string;
1544
+ description: string;
1545
+ };
1546
+ status: {
1547
+ type: "string";
1548
+ enum: string[];
1549
+ description: string;
1550
+ };
1551
+ tags: {
1552
+ type: "object";
1553
+ additionalProperties: {
1554
+ type: "string";
1555
+ maxLength: number;
1556
+ };
1557
+ description: string;
1558
+ };
1559
+ };
1560
+ title: string;
1561
+ additionalProperties: false;
1562
+ };
1563
+ };
1564
+ section: "task";
1565
+ response: {
1566
+ description: string;
1567
+ schema: {
1568
+ type: "object";
1569
+ properties: {
1570
+ task: {
1571
+ $ref: string;
1572
+ };
1573
+ };
1574
+ required: string[];
1575
+ title: string;
1576
+ additionalProperties: false;
1577
+ };
1578
+ };
1579
+ };
1580
+ deleteTask: {
1581
+ name: string;
1582
+ description: string;
1583
+ method: "delete";
1584
+ path: string;
1585
+ parameters: {
1586
+ id: {
1587
+ in: "path";
1588
+ type: "string";
1589
+ description: string;
1590
+ };
1591
+ };
1592
+ section: "task";
1593
+ response: {
1594
+ description: string;
1595
+ schema: {
1596
+ type: "object";
1597
+ title: string;
1598
+ additionalProperties: false;
1599
+ };
1600
+ };
1601
+ };
1602
+ listTasks: {
1603
+ name: string;
1604
+ description: string;
1605
+ method: "get";
1606
+ path: string;
1607
+ parameters: {
1608
+ nextToken: {
1609
+ in: "query";
1610
+ description: string;
1611
+ type: "string";
1612
+ };
1613
+ tags: {
1614
+ in: "query";
1615
+ type: "object";
1616
+ schema: {
1617
+ type: "object";
1618
+ additionalProperties: {
1619
+ type: "string";
1620
+ };
1621
+ };
1622
+ description: string;
1623
+ };
1624
+ conversationId: {
1625
+ in: "query";
1626
+ type: "string";
1627
+ description: string;
1628
+ };
1629
+ userId: {
1630
+ in: "query";
1631
+ type: "string";
1632
+ description: string;
1633
+ };
1634
+ parentTaskId: {
1635
+ in: "query";
1636
+ type: "string";
1637
+ description: string;
1638
+ };
1639
+ status: {
1640
+ in: "query";
1641
+ type: "string";
1642
+ description: string;
1643
+ enum: string[];
1644
+ };
1645
+ type: {
1646
+ in: "query";
1647
+ type: "string";
1648
+ description: string;
1649
+ };
1650
+ };
1651
+ section: "task";
1652
+ response: {
1653
+ description: string;
1654
+ schema: {
1655
+ type: "object";
1656
+ properties: {
1657
+ tasks: {
1658
+ type: "array";
1659
+ items: {
1660
+ $ref: string;
1661
+ };
1662
+ };
1663
+ meta: {
1664
+ type: "object";
1665
+ properties: {
1666
+ nextToken: {
1667
+ type: "string";
1668
+ description: string;
1669
+ };
1670
+ };
1671
+ additionalProperties: false;
1672
+ };
1673
+ };
1674
+ required: string[];
1675
+ title: string;
1676
+ additionalProperties: false;
1677
+ };
1678
+ };
1679
+ };
1407
1680
  runVrl: {
1408
1681
  name: string;
1409
1682
  description: string;
@@ -3343,6 +3616,10 @@ export declare const state: {
3343
3616
  isPublic: {
3344
3617
  type: "boolean";
3345
3618
  };
3619
+ handle: {
3620
+ default: string;
3621
+ type: "string";
3622
+ };
3346
3623
  };
3347
3624
  required: string[];
3348
3625
  title: string;
@@ -3434,6 +3711,10 @@ export declare const state: {
3434
3711
  isPublic: {
3435
3712
  type: "boolean";
3436
3713
  };
3714
+ handle: {
3715
+ default: string;
3716
+ type: "string";
3717
+ };
3437
3718
  };
3438
3719
  required: string[];
3439
3720
  title: string;
@@ -3746,6 +4027,12 @@ export declare const state: {
3746
4027
  isPublic: {
3747
4028
  type: "boolean";
3748
4029
  };
4030
+ handle: {
4031
+ type: "string";
4032
+ minLength: number;
4033
+ maxLength: number;
4034
+ pattern: string;
4035
+ };
3749
4036
  };
3750
4037
  additionalProperties: false;
3751
4038
  title: string;
@@ -3818,12 +4105,67 @@ export declare const state: {
3818
4105
  isPublic: {
3819
4106
  type: "boolean";
3820
4107
  };
4108
+ handle: {
4109
+ default: string;
4110
+ type: "string";
4111
+ };
4112
+ };
4113
+ required: string[];
4114
+ title: string;
4115
+ additionalProperties: false;
4116
+ };
4117
+ };
4118
+ };
4119
+ checkHandleAvailability: {
4120
+ name: string;
4121
+ description: string;
4122
+ section: "workspace";
4123
+ method: "put";
4124
+ disableDefaultParameters: {
4125
+ "x-workspace-id": boolean;
4126
+ };
4127
+ path: string;
4128
+ requestBody: {
4129
+ description: string;
4130
+ schema: {
4131
+ type: "object";
4132
+ properties: {
4133
+ handle: {
4134
+ type: "string";
4135
+ minLength: number;
4136
+ maxLength: number;
4137
+ pattern: string;
4138
+ };
4139
+ };
4140
+ required: string[];
4141
+ title: string;
4142
+ additionalProperties: false;
4143
+ };
4144
+ };
4145
+ response: {
4146
+ description: string;
4147
+ schema: {
4148
+ type: "object";
4149
+ properties: {
4150
+ available: {
4151
+ type: "boolean";
4152
+ };
4153
+ suggestions: {
4154
+ type: "array";
4155
+ items: {
4156
+ type: "string";
4157
+ };
4158
+ };
4159
+ usedBy: {
4160
+ type: "string";
4161
+ };
3821
4162
  };
3822
4163
  required: string[];
3823
4164
  title: string;
3824
4165
  additionalProperties: false;
3825
4166
  };
3826
4167
  };
4168
+ parameters: {};
3827
4169
  };
3828
4170
  listWorkspaces: {
3829
4171
  name: string;
@@ -3913,6 +4255,10 @@ export declare const state: {
3913
4255
  isPublic: {
3914
4256
  type: "boolean";
3915
4257
  };
4258
+ handle: {
4259
+ default: string;
4260
+ type: "string";
4261
+ };
3916
4262
  };
3917
4263
  required: string[];
3918
4264
  title: string;
@@ -4033,6 +4379,10 @@ export declare const state: {
4033
4379
  isPublic: {
4034
4380
  type: "boolean";
4035
4381
  };
4382
+ handle: {
4383
+ default: string;
4384
+ type: "string";
4385
+ };
4036
4386
  };
4037
4387
  required: string[];
4038
4388
  title: string;
@@ -5705,6 +6055,8 @@ export declare const state: {
5705
6055
  patchStateBody: true;
5706
6056
  callActionBody: true;
5707
6057
  configureIntegrationBody: true;
6058
+ createTaskBody: true;
6059
+ updateTaskBody: true;
5708
6060
  runVrlBody: true;
5709
6061
  createPersonalAccessTokenBody: true;
5710
6062
  setAccountPreferenceBody: true;
@@ -5715,6 +6067,7 @@ export declare const state: {
5715
6067
  chargeWorkspaceUnpaidInvoicesBody: true;
5716
6068
  createWorkspaceBody: true;
5717
6069
  updateWorkspaceBody: true;
6070
+ checkHandleAvailabilityBody: true;
5718
6071
  changeWorkspacePlanBody: true;
5719
6072
  createWorkspaceMemberBody: true;
5720
6073
  updateWorkspaceMemberBody: true;
@@ -5755,6 +6108,11 @@ export declare const state: {
5755
6108
  patchStateResponse: true;
5756
6109
  callActionResponse: true;
5757
6110
  configureIntegrationResponse: true;
6111
+ getTaskResponse: true;
6112
+ createTaskResponse: true;
6113
+ updateTaskResponse: true;
6114
+ deleteTaskResponse: true;
6115
+ listTasksResponse: true;
5758
6116
  runVrlResponse: true;
5759
6117
  getAccountResponse: true;
5760
6118
  listPersonalAccessTokensResponse: true;
@@ -5789,6 +6147,7 @@ export declare const state: {
5789
6147
  getWorkspaceQuotaResponse: true;
5790
6148
  listWorkspaceQuotasResponse: true;
5791
6149
  updateWorkspaceResponse: true;
6150
+ checkHandleAvailabilityResponse: true;
5792
6151
  listWorkspacesResponse: true;
5793
6152
  changeWorkspacePlanResponse: true;
5794
6153
  deleteWorkspaceResponse: true;
@@ -5828,6 +6187,7 @@ export declare const state: {
5828
6187
  Event: true;
5829
6188
  Message: true;
5830
6189
  State: true;
6190
+ Task: true;
5831
6191
  File: true;
5832
6192
  Table: true;
5833
6193
  Column: true;
@@ -6635,6 +6995,10 @@ export declare const state: {
6635
6995
  isPublic: {
6636
6996
  type: "boolean";
6637
6997
  };
6998
+ handle: {
6999
+ default: string;
7000
+ type: "string";
7001
+ };
6638
7002
  };
6639
7003
  required: string[];
6640
7004
  additionalProperties: false;
@@ -6864,6 +7228,12 @@ export declare const state: {
6864
7228
  maxLength: number;
6865
7229
  description: string;
6866
7230
  };
7231
+ currentTaskId: {
7232
+ type: "string";
7233
+ minLength: number;
7234
+ maxLength: number;
7235
+ description: string;
7236
+ };
6867
7237
  createdAt: {
6868
7238
  type: "string";
6869
7239
  format: string;
@@ -6941,7 +7311,13 @@ export declare const state: {
6941
7311
  };
6942
7312
  status: {
6943
7313
  type: "string";
7314
+ enum: string[];
7315
+ };
7316
+ failureReason: {
7317
+ type: "string";
7318
+ maxLength: number;
6944
7319
  description: string;
7320
+ nullable: true;
6945
7321
  };
6946
7322
  };
6947
7323
  required: string[];
@@ -7065,6 +7441,92 @@ export declare const state: {
7065
7441
  additionalProperties: false;
7066
7442
  };
7067
7443
  };
7444
+ Task: {
7445
+ section: "task";
7446
+ schema: {
7447
+ type: "object";
7448
+ properties: {
7449
+ id: {
7450
+ type: "string";
7451
+ minLength: number;
7452
+ maxLength: number;
7453
+ description: string;
7454
+ };
7455
+ title: {
7456
+ type: "string";
7457
+ maxLength: number;
7458
+ description: string;
7459
+ };
7460
+ instruction: {
7461
+ type: "string";
7462
+ maxLength: number;
7463
+ description: string;
7464
+ };
7465
+ type: {
7466
+ type: "string";
7467
+ description: string;
7468
+ };
7469
+ data: {
7470
+ type: "object";
7471
+ additionalProperties: true;
7472
+ description: string;
7473
+ };
7474
+ status: {
7475
+ type: "string";
7476
+ enum: string[];
7477
+ description: string;
7478
+ };
7479
+ parentTaskId: {
7480
+ type: "string";
7481
+ minLength: number;
7482
+ maxLength: number;
7483
+ description: string;
7484
+ };
7485
+ conversationId: {
7486
+ type: "string";
7487
+ minLength: number;
7488
+ maxLength: number;
7489
+ description: string;
7490
+ };
7491
+ userId: {
7492
+ type: "string";
7493
+ minLength: number;
7494
+ maxLength: number;
7495
+ description: string;
7496
+ };
7497
+ timeoutAt: {
7498
+ type: "string";
7499
+ format: string;
7500
+ description: string;
7501
+ };
7502
+ createdAt: {
7503
+ type: "string";
7504
+ format: string;
7505
+ description: string;
7506
+ };
7507
+ updatedAt: {
7508
+ type: "string";
7509
+ format: string;
7510
+ description: string;
7511
+ };
7512
+ failureReason: {
7513
+ type: "string";
7514
+ maxLength: number;
7515
+ description: string;
7516
+ };
7517
+ tags: {
7518
+ type: "object";
7519
+ additionalProperties: {
7520
+ type: "string";
7521
+ };
7522
+ description: string;
7523
+ };
7524
+ };
7525
+ required: string[];
7526
+ description: string;
7527
+ additionalProperties: false;
7528
+ };
7529
+ };
7068
7530
  File: {
7069
7531
  section: "file";
7070
7532
  schema: {
@@ -7125,53 +7587,74 @@ export declare const state: {
7125
7587
  maximum: number;
7126
7588
  description: string;
7127
7589
  };
7128
- columns: {
7129
- type: "array";
7130
- items: {
7131
- type: "object";
7590
+ schema: {
7591
+ type: "object";
7592
+ properties: {
7593
+ $schema: {
7594
+ type: "string";
7595
+ };
7132
7596
  properties: {
7133
- id: {
7134
- type: "string";
7135
- description: string;
7136
- };
7137
- name: {
7138
- type: "string";
7139
- minLength: number;
7140
- maxLength: number;
7141
- description: string;
7142
- };
7143
- description: {
7144
- type: "string";
7145
- description: string;
7146
- };
7147
- searchable: {
7148
- type: "boolean";
7149
- description: string;
7150
- };
7151
- type: {
7152
- type: "string";
7153
- enum: string[];
7154
- description: string;
7597
+ type: "object";
7598
+ additionalProperties: {
7599
+ type: "object";
7600
+ properties: {
7601
+ type: {
7602
+ type: "string";
7603
+ enum: string[];
7604
+ };
7605
+ format: {
7606
+ type: "string";
7607
+ enum: string[];
7608
+ };
7609
+ description: {
7610
+ type: "string";
7611
+ };
7612
+ nullable: {
7613
+ default: boolean;
7614
+ type: "boolean";
7615
+ };
7616
+ "x-zui": {
7617
+ type: "object";
7618
+ properties: {
7619
+ index: {
7620
+ type: "integer";
7621
+ };
7622
+ searchable: {
7623
+ type: "boolean";
7624
+ description: string;
7625
+ };
7626
+ typings: {
7627
+ type: "string";
7628
+ description: string;
7629
+ };
7630
+ };
7631
+ required: string[];
7632
+ additionalProperties: false;
7633
+ };
7634
+ };
7635
+ required: string[];
7636
+ additionalProperties: false;
7155
7637
  };
7156
- typings: {
7638
+ description: string;
7639
+ };
7640
+ additionalProperties: {
7641
+ type: "boolean";
7642
+ enum: boolean[];
7643
+ };
7644
+ required: {
7645
+ type: "array";
7646
+ items: {
7157
7647
  type: "string";
7158
- description: string;
7159
- };
7160
- schema: {
7161
- type: "object";
7162
- properties: {};
7163
- additionalProperties: true;
7164
7648
  };
7649
+ description: string;
7650
+ };
7651
+ type: {
7652
+ type: "string";
7653
+ enum: string[];
7165
7654
  };
7166
- required: string[];
7167
7655
  };
7168
- maxItems: number;
7169
- description: string;
7170
- };
7171
- schema: {
7172
- type: "object";
7173
- additionalProperties: true;
7174
- description: string;
7656
+ required: string[];
7657
+ additionalProperties: false;
7175
7658
  };
7176
7659
  tags: {
7177
7660
  type: "object";
@@ -7309,6 +7792,12 @@ export declare const state: {
7309
7792
  name: "action";
7310
7793
  operations: string[];
7311
7794
  schema?: undefined;
7795
+ } | {
7796
+ description: string;
7797
+ title: string;
7798
+ name: "task";
7799
+ operations: string[];
7800
+ schema: string;
7312
7801
  } | {
7313
7802
  title: string;
7314
7803
  description: string;