@botpress/api 0.29.4 → 0.29.6
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 +366 -65
- package/dist/src/gen/state.d.ts +286 -0
- package/package.json +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +351 -7
package/src/gen/state.ts
CHANGED
|
@@ -2545,6 +2545,74 @@ export const state = {
|
|
|
2545
2545
|
"maxLength": 200,
|
|
2546
2546
|
"description": "Version of the [Integration](#schema_integration)"
|
|
2547
2547
|
},
|
|
2548
|
+
"interfaces": {
|
|
2549
|
+
"type": "object",
|
|
2550
|
+
"additionalProperties": {
|
|
2551
|
+
"type": "object",
|
|
2552
|
+
"properties": {
|
|
2553
|
+
"id": {
|
|
2554
|
+
"type": "string",
|
|
2555
|
+
"minLength": 28,
|
|
2556
|
+
"maxLength": 36
|
|
2557
|
+
},
|
|
2558
|
+
"entities": {
|
|
2559
|
+
"type": "object",
|
|
2560
|
+
"additionalProperties": {
|
|
2561
|
+
"type": "object",
|
|
2562
|
+
"properties": {
|
|
2563
|
+
"name": {
|
|
2564
|
+
"type": "string",
|
|
2565
|
+
"maxLength": 200
|
|
2566
|
+
}
|
|
2567
|
+
},
|
|
2568
|
+
"required": [
|
|
2569
|
+
"name"
|
|
2570
|
+
],
|
|
2571
|
+
"additionalProperties": false
|
|
2572
|
+
}
|
|
2573
|
+
},
|
|
2574
|
+
"actions": {
|
|
2575
|
+
"type": "object",
|
|
2576
|
+
"additionalProperties": {
|
|
2577
|
+
"type": "object",
|
|
2578
|
+
"properties": {
|
|
2579
|
+
"name": {
|
|
2580
|
+
"type": "string",
|
|
2581
|
+
"maxLength": 200
|
|
2582
|
+
}
|
|
2583
|
+
},
|
|
2584
|
+
"required": [
|
|
2585
|
+
"name"
|
|
2586
|
+
],
|
|
2587
|
+
"additionalProperties": false
|
|
2588
|
+
}
|
|
2589
|
+
},
|
|
2590
|
+
"events": {
|
|
2591
|
+
"type": "object",
|
|
2592
|
+
"additionalProperties": {
|
|
2593
|
+
"type": "object",
|
|
2594
|
+
"properties": {
|
|
2595
|
+
"name": {
|
|
2596
|
+
"type": "string",
|
|
2597
|
+
"maxLength": 200
|
|
2598
|
+
}
|
|
2599
|
+
},
|
|
2600
|
+
"required": [
|
|
2601
|
+
"name"
|
|
2602
|
+
],
|
|
2603
|
+
"additionalProperties": false
|
|
2604
|
+
}
|
|
2605
|
+
}
|
|
2606
|
+
},
|
|
2607
|
+
"required": [
|
|
2608
|
+
"id",
|
|
2609
|
+
"entities",
|
|
2610
|
+
"actions",
|
|
2611
|
+
"events"
|
|
2612
|
+
],
|
|
2613
|
+
"additionalProperties": false
|
|
2614
|
+
}
|
|
2615
|
+
},
|
|
2548
2616
|
"configuration": {
|
|
2549
2617
|
"type": "object",
|
|
2550
2618
|
"properties": {
|
|
@@ -2951,6 +3019,7 @@ export const state = {
|
|
|
2951
3019
|
"url",
|
|
2952
3020
|
"name",
|
|
2953
3021
|
"version",
|
|
3022
|
+
"interfaces",
|
|
2954
3023
|
"configuration",
|
|
2955
3024
|
"channels",
|
|
2956
3025
|
"states",
|
|
@@ -3055,6 +3124,74 @@ export const state = {
|
|
|
3055
3124
|
"maxLength": 200,
|
|
3056
3125
|
"description": "Version of the [Integration](#schema_integration)"
|
|
3057
3126
|
},
|
|
3127
|
+
"interfaces": {
|
|
3128
|
+
"type": "object",
|
|
3129
|
+
"additionalProperties": {
|
|
3130
|
+
"type": "object",
|
|
3131
|
+
"properties": {
|
|
3132
|
+
"id": {
|
|
3133
|
+
"type": "string",
|
|
3134
|
+
"minLength": 28,
|
|
3135
|
+
"maxLength": 36
|
|
3136
|
+
},
|
|
3137
|
+
"entities": {
|
|
3138
|
+
"type": "object",
|
|
3139
|
+
"additionalProperties": {
|
|
3140
|
+
"type": "object",
|
|
3141
|
+
"properties": {
|
|
3142
|
+
"name": {
|
|
3143
|
+
"type": "string",
|
|
3144
|
+
"maxLength": 200
|
|
3145
|
+
}
|
|
3146
|
+
},
|
|
3147
|
+
"required": [
|
|
3148
|
+
"name"
|
|
3149
|
+
],
|
|
3150
|
+
"additionalProperties": false
|
|
3151
|
+
}
|
|
3152
|
+
},
|
|
3153
|
+
"actions": {
|
|
3154
|
+
"type": "object",
|
|
3155
|
+
"additionalProperties": {
|
|
3156
|
+
"type": "object",
|
|
3157
|
+
"properties": {
|
|
3158
|
+
"name": {
|
|
3159
|
+
"type": "string",
|
|
3160
|
+
"maxLength": 200
|
|
3161
|
+
}
|
|
3162
|
+
},
|
|
3163
|
+
"required": [
|
|
3164
|
+
"name"
|
|
3165
|
+
],
|
|
3166
|
+
"additionalProperties": false
|
|
3167
|
+
}
|
|
3168
|
+
},
|
|
3169
|
+
"events": {
|
|
3170
|
+
"type": "object",
|
|
3171
|
+
"additionalProperties": {
|
|
3172
|
+
"type": "object",
|
|
3173
|
+
"properties": {
|
|
3174
|
+
"name": {
|
|
3175
|
+
"type": "string",
|
|
3176
|
+
"maxLength": 200
|
|
3177
|
+
}
|
|
3178
|
+
},
|
|
3179
|
+
"required": [
|
|
3180
|
+
"name"
|
|
3181
|
+
],
|
|
3182
|
+
"additionalProperties": false
|
|
3183
|
+
}
|
|
3184
|
+
}
|
|
3185
|
+
},
|
|
3186
|
+
"required": [
|
|
3187
|
+
"id",
|
|
3188
|
+
"entities",
|
|
3189
|
+
"actions",
|
|
3190
|
+
"events"
|
|
3191
|
+
],
|
|
3192
|
+
"additionalProperties": false
|
|
3193
|
+
}
|
|
3194
|
+
},
|
|
3058
3195
|
"configuration": {
|
|
3059
3196
|
"type": "object",
|
|
3060
3197
|
"properties": {
|
|
@@ -3461,6 +3598,7 @@ export const state = {
|
|
|
3461
3598
|
"url",
|
|
3462
3599
|
"name",
|
|
3463
3600
|
"version",
|
|
3601
|
+
"interfaces",
|
|
3464
3602
|
"configuration",
|
|
3465
3603
|
"channels",
|
|
3466
3604
|
"states",
|
|
@@ -6801,6 +6939,74 @@ export const state = {
|
|
|
6801
6939
|
"maxLength": 200,
|
|
6802
6940
|
"description": "Version of the [Integration](#schema_integration)"
|
|
6803
6941
|
},
|
|
6942
|
+
"interfaces": {
|
|
6943
|
+
"type": "object",
|
|
6944
|
+
"additionalProperties": {
|
|
6945
|
+
"type": "object",
|
|
6946
|
+
"properties": {
|
|
6947
|
+
"id": {
|
|
6948
|
+
"type": "string",
|
|
6949
|
+
"minLength": 28,
|
|
6950
|
+
"maxLength": 36
|
|
6951
|
+
},
|
|
6952
|
+
"entities": {
|
|
6953
|
+
"type": "object",
|
|
6954
|
+
"additionalProperties": {
|
|
6955
|
+
"type": "object",
|
|
6956
|
+
"properties": {
|
|
6957
|
+
"name": {
|
|
6958
|
+
"type": "string",
|
|
6959
|
+
"maxLength": 200
|
|
6960
|
+
}
|
|
6961
|
+
},
|
|
6962
|
+
"required": [
|
|
6963
|
+
"name"
|
|
6964
|
+
],
|
|
6965
|
+
"additionalProperties": false
|
|
6966
|
+
}
|
|
6967
|
+
},
|
|
6968
|
+
"actions": {
|
|
6969
|
+
"type": "object",
|
|
6970
|
+
"additionalProperties": {
|
|
6971
|
+
"type": "object",
|
|
6972
|
+
"properties": {
|
|
6973
|
+
"name": {
|
|
6974
|
+
"type": "string",
|
|
6975
|
+
"maxLength": 200
|
|
6976
|
+
}
|
|
6977
|
+
},
|
|
6978
|
+
"required": [
|
|
6979
|
+
"name"
|
|
6980
|
+
],
|
|
6981
|
+
"additionalProperties": false
|
|
6982
|
+
}
|
|
6983
|
+
},
|
|
6984
|
+
"events": {
|
|
6985
|
+
"type": "object",
|
|
6986
|
+
"additionalProperties": {
|
|
6987
|
+
"type": "object",
|
|
6988
|
+
"properties": {
|
|
6989
|
+
"name": {
|
|
6990
|
+
"type": "string",
|
|
6991
|
+
"maxLength": 200
|
|
6992
|
+
}
|
|
6993
|
+
},
|
|
6994
|
+
"required": [
|
|
6995
|
+
"name"
|
|
6996
|
+
],
|
|
6997
|
+
"additionalProperties": false
|
|
6998
|
+
}
|
|
6999
|
+
}
|
|
7000
|
+
},
|
|
7001
|
+
"required": [
|
|
7002
|
+
"id",
|
|
7003
|
+
"entities",
|
|
7004
|
+
"actions",
|
|
7005
|
+
"events"
|
|
7006
|
+
],
|
|
7007
|
+
"additionalProperties": false
|
|
7008
|
+
}
|
|
7009
|
+
},
|
|
6804
7010
|
"configuration": {
|
|
6805
7011
|
"type": "object",
|
|
6806
7012
|
"properties": {
|
|
@@ -7559,6 +7765,75 @@ export const state = {
|
|
|
7559
7765
|
"additionalProperties": false
|
|
7560
7766
|
}
|
|
7561
7767
|
},
|
|
7768
|
+
"interfaces": {
|
|
7769
|
+
"type": "object",
|
|
7770
|
+
"additionalProperties": {
|
|
7771
|
+
"type": "object",
|
|
7772
|
+
"properties": {
|
|
7773
|
+
"id": {
|
|
7774
|
+
"type": "string",
|
|
7775
|
+
"minLength": 28,
|
|
7776
|
+
"maxLength": 36
|
|
7777
|
+
},
|
|
7778
|
+
"entities": {
|
|
7779
|
+
"type": "object",
|
|
7780
|
+
"additionalProperties": {
|
|
7781
|
+
"type": "object",
|
|
7782
|
+
"properties": {
|
|
7783
|
+
"name": {
|
|
7784
|
+
"type": "string",
|
|
7785
|
+
"maxLength": 200
|
|
7786
|
+
}
|
|
7787
|
+
},
|
|
7788
|
+
"required": [
|
|
7789
|
+
"name"
|
|
7790
|
+
],
|
|
7791
|
+
"additionalProperties": false
|
|
7792
|
+
}
|
|
7793
|
+
},
|
|
7794
|
+
"actions": {
|
|
7795
|
+
"type": "object",
|
|
7796
|
+
"additionalProperties": {
|
|
7797
|
+
"type": "object",
|
|
7798
|
+
"properties": {
|
|
7799
|
+
"name": {
|
|
7800
|
+
"type": "string",
|
|
7801
|
+
"maxLength": 200
|
|
7802
|
+
}
|
|
7803
|
+
},
|
|
7804
|
+
"required": [
|
|
7805
|
+
"name"
|
|
7806
|
+
],
|
|
7807
|
+
"additionalProperties": false
|
|
7808
|
+
}
|
|
7809
|
+
},
|
|
7810
|
+
"events": {
|
|
7811
|
+
"type": "object",
|
|
7812
|
+
"additionalProperties": {
|
|
7813
|
+
"type": "object",
|
|
7814
|
+
"properties": {
|
|
7815
|
+
"name": {
|
|
7816
|
+
"type": "string",
|
|
7817
|
+
"maxLength": 200
|
|
7818
|
+
}
|
|
7819
|
+
},
|
|
7820
|
+
"required": [
|
|
7821
|
+
"name"
|
|
7822
|
+
],
|
|
7823
|
+
"additionalProperties": false
|
|
7824
|
+
}
|
|
7825
|
+
}
|
|
7826
|
+
},
|
|
7827
|
+
"required": [
|
|
7828
|
+
"id",
|
|
7829
|
+
"entities",
|
|
7830
|
+
"actions",
|
|
7831
|
+
"events"
|
|
7832
|
+
],
|
|
7833
|
+
"nullable": true,
|
|
7834
|
+
"additionalProperties": false
|
|
7835
|
+
}
|
|
7836
|
+
},
|
|
7562
7837
|
"secrets": {
|
|
7563
7838
|
"type": "object",
|
|
7564
7839
|
"additionalProperties": {
|
|
@@ -8167,7 +8442,7 @@ export const state = {
|
|
|
8167
8442
|
"type": "string",
|
|
8168
8443
|
"maxLength": 1000
|
|
8169
8444
|
},
|
|
8170
|
-
"description": "File tags as an object of key
|
|
8445
|
+
"description": "File tags as an object of key-value pairs. Tag values should be of `string` (text) type."
|
|
8171
8446
|
},
|
|
8172
8447
|
"size": {
|
|
8173
8448
|
"type": "number",
|
|
@@ -8347,7 +8622,7 @@ export const state = {
|
|
|
8347
8622
|
},
|
|
8348
8623
|
"tags": {
|
|
8349
8624
|
"in": "query",
|
|
8350
|
-
"description": "Filter by tags",
|
|
8625
|
+
"description": "Filter files by tags. Tags should be passed as a URL-encoded JSON object of key-value pairs that must be present in the tags of a file.",
|
|
8351
8626
|
"type": "object",
|
|
8352
8627
|
"schema": {
|
|
8353
8628
|
"type": "object",
|
|
@@ -8624,7 +8899,7 @@ export const state = {
|
|
|
8624
8899
|
"maxLength": 1000,
|
|
8625
8900
|
"nullable": true
|
|
8626
8901
|
},
|
|
8627
|
-
"description": "The file tags to update as an object of key
|
|
8902
|
+
"description": "The file tags to update as an object of key-value pairs with `string` (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`."
|
|
8628
8903
|
},
|
|
8629
8904
|
"accessPolicies": {
|
|
8630
8905
|
"type": "array",
|
|
@@ -8759,7 +9034,7 @@ export const state = {
|
|
|
8759
9034
|
"parameters": {
|
|
8760
9035
|
"tags": {
|
|
8761
9036
|
"in": "query",
|
|
8762
|
-
"description": "Filter by tags",
|
|
9037
|
+
"description": "Filter files by tags. Tags should be passed as a URL-encoded JSON object of key-value pairs that must be present in the tags of a file.",
|
|
8763
9038
|
"type": "object",
|
|
8764
9039
|
"schema": {
|
|
8765
9040
|
"type": "object",
|
|
@@ -8821,7 +9096,7 @@ export const state = {
|
|
|
8821
9096
|
"type": "string",
|
|
8822
9097
|
"maxLength": 1000
|
|
8823
9098
|
},
|
|
8824
|
-
"description": "The tags of the file as an object of key
|
|
9099
|
+
"description": "The tags of the file as an object of key-value pairs."
|
|
8825
9100
|
},
|
|
8826
9101
|
"createdAt": {
|
|
8827
9102
|
"type": "string",
|
|
@@ -9758,7 +10033,7 @@ export const state = {
|
|
|
9758
10033
|
"title": "Botpress API",
|
|
9759
10034
|
"description": "API for Botpress Cloud",
|
|
9760
10035
|
"server": "https://api.botpress.cloud",
|
|
9761
|
-
"version": "0.29.
|
|
10036
|
+
"version": "0.29.6",
|
|
9762
10037
|
"prefix": "v1"
|
|
9763
10038
|
},
|
|
9764
10039
|
"errors": [
|
|
@@ -10627,6 +10902,74 @@ export const state = {
|
|
|
10627
10902
|
"maxLength": 200,
|
|
10628
10903
|
"description": "Version of the [Integration](#schema_integration)"
|
|
10629
10904
|
},
|
|
10905
|
+
"interfaces": {
|
|
10906
|
+
"type": "object",
|
|
10907
|
+
"additionalProperties": {
|
|
10908
|
+
"type": "object",
|
|
10909
|
+
"properties": {
|
|
10910
|
+
"id": {
|
|
10911
|
+
"type": "string",
|
|
10912
|
+
"minLength": 28,
|
|
10913
|
+
"maxLength": 36
|
|
10914
|
+
},
|
|
10915
|
+
"entities": {
|
|
10916
|
+
"type": "object",
|
|
10917
|
+
"additionalProperties": {
|
|
10918
|
+
"type": "object",
|
|
10919
|
+
"properties": {
|
|
10920
|
+
"name": {
|
|
10921
|
+
"type": "string",
|
|
10922
|
+
"maxLength": 200
|
|
10923
|
+
}
|
|
10924
|
+
},
|
|
10925
|
+
"required": [
|
|
10926
|
+
"name"
|
|
10927
|
+
],
|
|
10928
|
+
"additionalProperties": false
|
|
10929
|
+
}
|
|
10930
|
+
},
|
|
10931
|
+
"actions": {
|
|
10932
|
+
"type": "object",
|
|
10933
|
+
"additionalProperties": {
|
|
10934
|
+
"type": "object",
|
|
10935
|
+
"properties": {
|
|
10936
|
+
"name": {
|
|
10937
|
+
"type": "string",
|
|
10938
|
+
"maxLength": 200
|
|
10939
|
+
}
|
|
10940
|
+
},
|
|
10941
|
+
"required": [
|
|
10942
|
+
"name"
|
|
10943
|
+
],
|
|
10944
|
+
"additionalProperties": false
|
|
10945
|
+
}
|
|
10946
|
+
},
|
|
10947
|
+
"events": {
|
|
10948
|
+
"type": "object",
|
|
10949
|
+
"additionalProperties": {
|
|
10950
|
+
"type": "object",
|
|
10951
|
+
"properties": {
|
|
10952
|
+
"name": {
|
|
10953
|
+
"type": "string",
|
|
10954
|
+
"maxLength": 200
|
|
10955
|
+
}
|
|
10956
|
+
},
|
|
10957
|
+
"required": [
|
|
10958
|
+
"name"
|
|
10959
|
+
],
|
|
10960
|
+
"additionalProperties": false
|
|
10961
|
+
}
|
|
10962
|
+
}
|
|
10963
|
+
},
|
|
10964
|
+
"required": [
|
|
10965
|
+
"id",
|
|
10966
|
+
"entities",
|
|
10967
|
+
"actions",
|
|
10968
|
+
"events"
|
|
10969
|
+
],
|
|
10970
|
+
"additionalProperties": false
|
|
10971
|
+
}
|
|
10972
|
+
},
|
|
10630
10973
|
"configuration": {
|
|
10631
10974
|
"type": "object",
|
|
10632
10975
|
"properties": {
|
|
@@ -11012,6 +11355,7 @@ export const state = {
|
|
|
11012
11355
|
"url",
|
|
11013
11356
|
"name",
|
|
11014
11357
|
"version",
|
|
11358
|
+
"interfaces",
|
|
11015
11359
|
"configuration",
|
|
11016
11360
|
"channels",
|
|
11017
11361
|
"states",
|
|
@@ -12564,7 +12908,7 @@ export const state = {
|
|
|
12564
12908
|
},
|
|
12565
12909
|
{
|
|
12566
12910
|
"title": "Files",
|
|
12567
|
-
"description": "
|
|
12911
|
+
"description": "The Files API allows you to create, manage, and index files that can be used by your bots and integrations. Files can be in any text or binary format, and documents (such as PDF, Microsoft Office, HTML, CSV, etc.) can be indexed to be used for semantic search in RAG (Retrieval Augmented Generation) implementations. Files are private by default but can be made publicly accessible through a permanent URL that's unique for each file.",
|
|
12568
12912
|
"name": "files",
|
|
12569
12913
|
"operations": [
|
|
12570
12914
|
"createFile",
|