@botpress/api 0.31.0 → 0.32.0

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/src/gen/state.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /* prettier-ignore */
4
4
  import * as opapi from '@bpinternal/opapi'
5
- export type State = opapi.State<'Bot' | 'Integration' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'file' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>
5
+ export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'file' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'interface' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>
6
6
  export const state = {
7
7
  "operations": {
8
8
  "createConversation": {
@@ -8315,6 +8315,474 @@ export const state = {
8315
8315
  }
8316
8316
  }
8317
8317
  },
8318
+ "createInterface": {
8319
+ "name": "createInterface",
8320
+ "description": "Create Interface",
8321
+ "method": "post",
8322
+ "path": "/v1/admin/interfaces",
8323
+ "parameters": {},
8324
+ "requestBody": {
8325
+ "description": "Interface to create",
8326
+ "schema": {
8327
+ "type": "object",
8328
+ "properties": {
8329
+ "name": {
8330
+ "type": "string",
8331
+ "maxLength": 200,
8332
+ "description": "Name of the [Interface](#schema_interface)"
8333
+ },
8334
+ "version": {
8335
+ "type": "string",
8336
+ "maxLength": 200,
8337
+ "description": "Version of the [Interface](#schema_interface)"
8338
+ },
8339
+ "events": {
8340
+ "type": "object",
8341
+ "additionalProperties": {
8342
+ "type": "object",
8343
+ "properties": {
8344
+ "title": {
8345
+ "type": "string",
8346
+ "maxLength": 64,
8347
+ "description": "Title of the event"
8348
+ },
8349
+ "description": {
8350
+ "type": "string",
8351
+ "maxLength": 256,
8352
+ "description": "Description of the event"
8353
+ },
8354
+ "schema": {
8355
+ "type": "object",
8356
+ "additionalProperties": true
8357
+ }
8358
+ },
8359
+ "required": [
8360
+ "schema"
8361
+ ],
8362
+ "description": "Event Definition",
8363
+ "additionalProperties": false
8364
+ }
8365
+ },
8366
+ "actions": {
8367
+ "type": "object",
8368
+ "additionalProperties": {
8369
+ "type": "object",
8370
+ "properties": {
8371
+ "title": {
8372
+ "type": "string",
8373
+ "maxLength": 64,
8374
+ "description": "Title of the action"
8375
+ },
8376
+ "description": {
8377
+ "type": "string",
8378
+ "maxLength": 256,
8379
+ "description": "Description of the action"
8380
+ },
8381
+ "input": {
8382
+ "type": "object",
8383
+ "properties": {
8384
+ "schema": {
8385
+ "type": "object",
8386
+ "additionalProperties": true
8387
+ }
8388
+ },
8389
+ "required": [
8390
+ "schema"
8391
+ ],
8392
+ "additionalProperties": false
8393
+ },
8394
+ "output": {
8395
+ "type": "object",
8396
+ "properties": {
8397
+ "schema": {
8398
+ "type": "object",
8399
+ "additionalProperties": true
8400
+ }
8401
+ },
8402
+ "required": [
8403
+ "schema"
8404
+ ],
8405
+ "additionalProperties": false
8406
+ }
8407
+ },
8408
+ "required": [
8409
+ "input",
8410
+ "output"
8411
+ ],
8412
+ "description": "Action definition",
8413
+ "additionalProperties": false
8414
+ }
8415
+ },
8416
+ "entities": {
8417
+ "type": "object",
8418
+ "additionalProperties": {
8419
+ "type": "object",
8420
+ "properties": {
8421
+ "title": {
8422
+ "type": "string",
8423
+ "maxLength": 64,
8424
+ "description": "Title of the entity"
8425
+ },
8426
+ "description": {
8427
+ "type": "string",
8428
+ "maxLength": 256,
8429
+ "description": "Description of the entity"
8430
+ },
8431
+ "schema": {
8432
+ "type": "object",
8433
+ "additionalProperties": true
8434
+ }
8435
+ },
8436
+ "required": [
8437
+ "schema"
8438
+ ],
8439
+ "description": "Entity definition",
8440
+ "additionalProperties": false
8441
+ }
8442
+ }
8443
+ },
8444
+ "required": [
8445
+ "name",
8446
+ "version",
8447
+ "events",
8448
+ "actions",
8449
+ "entities"
8450
+ ],
8451
+ "title": "createInterfaceBody",
8452
+ "additionalProperties": false
8453
+ }
8454
+ },
8455
+ "section": "interface",
8456
+ "response": {
8457
+ "description": "Get an interface",
8458
+ "schema": {
8459
+ "type": "object",
8460
+ "properties": {
8461
+ "interface": {
8462
+ "$ref": "#/components/schemas/Interface"
8463
+ }
8464
+ },
8465
+ "required": [
8466
+ "interface"
8467
+ ],
8468
+ "title": "createInterfaceResponse",
8469
+ "additionalProperties": false
8470
+ }
8471
+ }
8472
+ },
8473
+ "getInterface": {
8474
+ "name": "getInterface",
8475
+ "description": "Get Interface",
8476
+ "method": "get",
8477
+ "path": "/v1/admin/interfaces/{id}",
8478
+ "parameters": {
8479
+ "id": {
8480
+ "in": "path",
8481
+ "type": "string",
8482
+ "description": "Interface id"
8483
+ }
8484
+ },
8485
+ "section": "interface",
8486
+ "response": {
8487
+ "description": "Get an interface",
8488
+ "schema": {
8489
+ "type": "object",
8490
+ "properties": {
8491
+ "interface": {
8492
+ "$ref": "#/components/schemas/Interface"
8493
+ }
8494
+ },
8495
+ "required": [
8496
+ "interface"
8497
+ ],
8498
+ "title": "getInterfaceResponse",
8499
+ "additionalProperties": false
8500
+ }
8501
+ }
8502
+ },
8503
+ "getInterfaceByName": {
8504
+ "name": "getInterfaceByName",
8505
+ "description": "Get Interface by name and version",
8506
+ "method": "get",
8507
+ "path": "/v1/admin/interfaces/{name}/{version}",
8508
+ "parameters": {
8509
+ "name": {
8510
+ "in": "path",
8511
+ "type": "string",
8512
+ "description": "Interface name"
8513
+ },
8514
+ "version": {
8515
+ "in": "path",
8516
+ "type": "string",
8517
+ "description": "Interface version"
8518
+ }
8519
+ },
8520
+ "section": "interface",
8521
+ "response": {
8522
+ "description": "Get an interface",
8523
+ "schema": {
8524
+ "type": "object",
8525
+ "properties": {
8526
+ "interface": {
8527
+ "$ref": "#/components/schemas/Interface"
8528
+ }
8529
+ },
8530
+ "required": [
8531
+ "interface"
8532
+ ],
8533
+ "title": "getInterfaceByNameResponse",
8534
+ "additionalProperties": false
8535
+ }
8536
+ }
8537
+ },
8538
+ "updateInterface": {
8539
+ "name": "updateInterface",
8540
+ "description": "Update Interface",
8541
+ "method": "put",
8542
+ "path": "/v1/admin/interfaces/{id}",
8543
+ "parameters": {
8544
+ "id": {
8545
+ "in": "path",
8546
+ "type": "string",
8547
+ "description": "Interface id"
8548
+ }
8549
+ },
8550
+ "requestBody": {
8551
+ "description": "Interface to update",
8552
+ "schema": {
8553
+ "type": "object",
8554
+ "properties": {
8555
+ "events": {
8556
+ "type": "object",
8557
+ "additionalProperties": {
8558
+ "type": "object",
8559
+ "properties": {
8560
+ "title": {
8561
+ "type": "string",
8562
+ "maxLength": 64,
8563
+ "description": "Title of the event"
8564
+ },
8565
+ "description": {
8566
+ "type": "string",
8567
+ "maxLength": 256,
8568
+ "description": "Description of the event"
8569
+ },
8570
+ "schema": {
8571
+ "type": "object",
8572
+ "additionalProperties": true
8573
+ }
8574
+ },
8575
+ "required": [
8576
+ "schema"
8577
+ ],
8578
+ "description": "Event Definition",
8579
+ "nullable": true,
8580
+ "additionalProperties": false
8581
+ }
8582
+ },
8583
+ "actions": {
8584
+ "type": "object",
8585
+ "additionalProperties": {
8586
+ "type": "object",
8587
+ "properties": {
8588
+ "title": {
8589
+ "type": "string",
8590
+ "maxLength": 64,
8591
+ "description": "Title of the action"
8592
+ },
8593
+ "description": {
8594
+ "type": "string",
8595
+ "maxLength": 256,
8596
+ "description": "Description of the action"
8597
+ },
8598
+ "input": {
8599
+ "type": "object",
8600
+ "properties": {
8601
+ "schema": {
8602
+ "type": "object",
8603
+ "additionalProperties": true
8604
+ }
8605
+ },
8606
+ "required": [
8607
+ "schema"
8608
+ ],
8609
+ "additionalProperties": false
8610
+ },
8611
+ "output": {
8612
+ "type": "object",
8613
+ "properties": {
8614
+ "schema": {
8615
+ "type": "object",
8616
+ "additionalProperties": true
8617
+ }
8618
+ },
8619
+ "required": [
8620
+ "schema"
8621
+ ],
8622
+ "additionalProperties": false
8623
+ }
8624
+ },
8625
+ "required": [
8626
+ "input",
8627
+ "output"
8628
+ ],
8629
+ "description": "Action definition",
8630
+ "nullable": true,
8631
+ "additionalProperties": false
8632
+ }
8633
+ },
8634
+ "entities": {
8635
+ "type": "object",
8636
+ "additionalProperties": {
8637
+ "type": "object",
8638
+ "properties": {
8639
+ "title": {
8640
+ "type": "string",
8641
+ "maxLength": 64,
8642
+ "description": "Title of the entity"
8643
+ },
8644
+ "description": {
8645
+ "type": "string",
8646
+ "maxLength": 256,
8647
+ "description": "Description of the entity"
8648
+ },
8649
+ "schema": {
8650
+ "type": "object",
8651
+ "additionalProperties": true
8652
+ }
8653
+ },
8654
+ "required": [
8655
+ "schema"
8656
+ ],
8657
+ "description": "Entity definition",
8658
+ "nullable": true,
8659
+ "additionalProperties": false
8660
+ }
8661
+ }
8662
+ },
8663
+ "title": "updateInterfaceBody",
8664
+ "additionalProperties": false
8665
+ }
8666
+ },
8667
+ "section": "interface",
8668
+ "response": {
8669
+ "description": "Update an interface",
8670
+ "schema": {
8671
+ "type": "object",
8672
+ "properties": {
8673
+ "interface": {
8674
+ "$ref": "#/components/schemas/Interface"
8675
+ }
8676
+ },
8677
+ "required": [
8678
+ "interface"
8679
+ ],
8680
+ "title": "updateInterfaceResponse",
8681
+ "additionalProperties": false
8682
+ }
8683
+ }
8684
+ },
8685
+ "deleteInterface": {
8686
+ "name": "deleteInterface",
8687
+ "description": "Delete Interface",
8688
+ "method": "delete",
8689
+ "path": "/v1/admin/interfaces/{id}",
8690
+ "parameters": {
8691
+ "id": {
8692
+ "in": "path",
8693
+ "type": "string",
8694
+ "description": "Interface id"
8695
+ }
8696
+ },
8697
+ "section": "interface",
8698
+ "response": {
8699
+ "description": "Delete an interface",
8700
+ "schema": {
8701
+ "type": "object",
8702
+ "title": "deleteInterfaceResponse",
8703
+ "additionalProperties": false
8704
+ }
8705
+ }
8706
+ },
8707
+ "listInterfaces": {
8708
+ "name": "listInterfaces",
8709
+ "description": "List Interfaces",
8710
+ "method": "get",
8711
+ "path": "/v1/admin/interfaces",
8712
+ "section": "interface",
8713
+ "parameters": {
8714
+ "nextToken": {
8715
+ "in": "query",
8716
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
8717
+ "type": "string"
8718
+ }
8719
+ },
8720
+ "response": {
8721
+ "description": "List interfaces",
8722
+ "schema": {
8723
+ "type": "object",
8724
+ "properties": {
8725
+ "interfaces": {
8726
+ "type": "array",
8727
+ "items": {
8728
+ "type": "object",
8729
+ "properties": {
8730
+ "id": {
8731
+ "type": "string",
8732
+ "minLength": 28,
8733
+ "maxLength": 36,
8734
+ "description": "ID of the [Interface](#schema_interface)"
8735
+ },
8736
+ "createdAt": {
8737
+ "type": "string",
8738
+ "format": "date-time",
8739
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
8740
+ },
8741
+ "updatedAt": {
8742
+ "type": "string",
8743
+ "format": "date-time",
8744
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
8745
+ },
8746
+ "name": {
8747
+ "type": "string",
8748
+ "maxLength": 200,
8749
+ "description": "Name of the [Interface](#schema_interface)"
8750
+ },
8751
+ "version": {
8752
+ "type": "string",
8753
+ "maxLength": 200,
8754
+ "description": "Version of the [Interface](#schema_interface)"
8755
+ }
8756
+ },
8757
+ "required": [
8758
+ "id",
8759
+ "createdAt",
8760
+ "updatedAt",
8761
+ "name",
8762
+ "version"
8763
+ ]
8764
+ }
8765
+ },
8766
+ "meta": {
8767
+ "type": "object",
8768
+ "properties": {
8769
+ "nextToken": {
8770
+ "type": "string",
8771
+ "description": "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."
8772
+ }
8773
+ },
8774
+ "additionalProperties": false
8775
+ }
8776
+ },
8777
+ "required": [
8778
+ "interfaces",
8779
+ "meta"
8780
+ ],
8781
+ "title": "listInterfacesResponse",
8782
+ "additionalProperties": false
8783
+ }
8784
+ }
8785
+ },
8318
8786
  "getUsage": {
8319
8787
  "name": "getUsage",
8320
8788
  "path": "/v1/admin/usages/{id}",
@@ -10217,7 +10685,7 @@ export const state = {
10217
10685
  "title": "Botpress API",
10218
10686
  "description": "API for Botpress Cloud",
10219
10687
  "server": "https://api.botpress.cloud",
10220
- "version": "0.31.0",
10688
+ "version": "0.32.0",
10221
10689
  "prefix": "v1"
10222
10690
  },
10223
10691
  "errors": [
@@ -10381,6 +10849,8 @@ export const state = {
10381
10849
  "createIntegrationApiKeyBody": true,
10382
10850
  "createIntegrationBody": true,
10383
10851
  "updateIntegrationBody": true,
10852
+ "createInterfaceBody": true,
10853
+ "updateInterfaceBody": true,
10384
10854
  "changeAISpendQuotaBody": true,
10385
10855
  "introspectBody": true,
10386
10856
  "upsertFileBody": true,
@@ -10491,6 +10961,12 @@ export const state = {
10491
10961
  "getIntegrationLogsResponse": true,
10492
10962
  "getIntegrationByNameResponse": true,
10493
10963
  "deleteIntegrationResponse": true,
10964
+ "createInterfaceResponse": true,
10965
+ "getInterfaceResponse": true,
10966
+ "getInterfaceByNameResponse": true,
10967
+ "updateInterfaceResponse": true,
10968
+ "deleteInterfaceResponse": true,
10969
+ "listInterfacesResponse": true,
10494
10970
  "getUsageResponse": true,
10495
10971
  "getMultipleUsagesResponse": true,
10496
10972
  "listUsageHistoryResponse": true,
@@ -10521,6 +10997,7 @@ export const state = {
10521
10997
  "schemas": {
10522
10998
  "Bot": true,
10523
10999
  "Integration": true,
11000
+ "Interface": true,
10524
11001
  "Workspace": true,
10525
11002
  "WorkspaceMember": true,
10526
11003
  "Account": true,
@@ -11565,6 +12042,155 @@ export const state = {
11565
12042
  "additionalProperties": false
11566
12043
  }
11567
12044
  },
12045
+ "Interface": {
12046
+ "section": "interface",
12047
+ "schema": {
12048
+ "type": "object",
12049
+ "properties": {
12050
+ "id": {
12051
+ "type": "string",
12052
+ "minLength": 28,
12053
+ "maxLength": 36,
12054
+ "description": "ID of the [Interface](#schema_interface)"
12055
+ },
12056
+ "createdAt": {
12057
+ "type": "string",
12058
+ "format": "date-time",
12059
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
12060
+ },
12061
+ "updatedAt": {
12062
+ "type": "string",
12063
+ "format": "date-time",
12064
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
12065
+ },
12066
+ "name": {
12067
+ "type": "string",
12068
+ "maxLength": 200,
12069
+ "description": "Name of the [Interface](#schema_interface)"
12070
+ },
12071
+ "version": {
12072
+ "type": "string",
12073
+ "maxLength": 200,
12074
+ "description": "Version of the [Interface](#schema_interface)"
12075
+ },
12076
+ "events": {
12077
+ "type": "object",
12078
+ "additionalProperties": {
12079
+ "type": "object",
12080
+ "properties": {
12081
+ "title": {
12082
+ "type": "string",
12083
+ "maxLength": 64,
12084
+ "description": "Title of the event"
12085
+ },
12086
+ "description": {
12087
+ "type": "string",
12088
+ "maxLength": 256,
12089
+ "description": "Description of the event"
12090
+ },
12091
+ "schema": {
12092
+ "type": "object",
12093
+ "additionalProperties": true
12094
+ }
12095
+ },
12096
+ "required": [
12097
+ "schema"
12098
+ ],
12099
+ "description": "Event Definition",
12100
+ "additionalProperties": false
12101
+ }
12102
+ },
12103
+ "actions": {
12104
+ "type": "object",
12105
+ "additionalProperties": {
12106
+ "type": "object",
12107
+ "properties": {
12108
+ "title": {
12109
+ "type": "string",
12110
+ "maxLength": 64,
12111
+ "description": "Title of the action"
12112
+ },
12113
+ "description": {
12114
+ "type": "string",
12115
+ "maxLength": 256,
12116
+ "description": "Description of the action"
12117
+ },
12118
+ "input": {
12119
+ "type": "object",
12120
+ "properties": {
12121
+ "schema": {
12122
+ "type": "object",
12123
+ "additionalProperties": true
12124
+ }
12125
+ },
12126
+ "required": [
12127
+ "schema"
12128
+ ],
12129
+ "additionalProperties": false
12130
+ },
12131
+ "output": {
12132
+ "type": "object",
12133
+ "properties": {
12134
+ "schema": {
12135
+ "type": "object",
12136
+ "additionalProperties": true
12137
+ }
12138
+ },
12139
+ "required": [
12140
+ "schema"
12141
+ ],
12142
+ "additionalProperties": false
12143
+ }
12144
+ },
12145
+ "required": [
12146
+ "input",
12147
+ "output"
12148
+ ],
12149
+ "description": "Action definition",
12150
+ "additionalProperties": false
12151
+ }
12152
+ },
12153
+ "entities": {
12154
+ "type": "object",
12155
+ "additionalProperties": {
12156
+ "type": "object",
12157
+ "properties": {
12158
+ "title": {
12159
+ "type": "string",
12160
+ "maxLength": 64,
12161
+ "description": "Title of the entity"
12162
+ },
12163
+ "description": {
12164
+ "type": "string",
12165
+ "maxLength": 256,
12166
+ "description": "Description of the entity"
12167
+ },
12168
+ "schema": {
12169
+ "type": "object",
12170
+ "additionalProperties": true
12171
+ }
12172
+ },
12173
+ "required": [
12174
+ "schema"
12175
+ ],
12176
+ "description": "Entity definition",
12177
+ "additionalProperties": false
12178
+ }
12179
+ }
12180
+ },
12181
+ "required": [
12182
+ "id",
12183
+ "createdAt",
12184
+ "updatedAt",
12185
+ "name",
12186
+ "version",
12187
+ "events",
12188
+ "actions",
12189
+ "entities"
12190
+ ],
12191
+ "additionalProperties": false
12192
+ }
12193
+ },
11568
12194
  "Workspace": {
11569
12195
  "section": "workspace",
11570
12196
  "schema": {
@@ -12994,6 +13620,20 @@ export const state = {
12994
13620
  ],
12995
13621
  "schema": "Integration"
12996
13622
  },
13623
+ {
13624
+ "title": "Interface",
13625
+ "description": "",
13626
+ "name": "interface",
13627
+ "operations": [
13628
+ "createInterface",
13629
+ "getInterface",
13630
+ "getInterfaceByName",
13631
+ "updateInterface",
13632
+ "deleteInterface",
13633
+ "listInterfaces"
13634
+ ],
13635
+ "schema": "Interface"
13636
+ },
12997
13637
  {
12998
13638
  "title": "Workspace",
12999
13639
  "description": "",