@botpress/api 0.29.5 → 0.30.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
@@ -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",
@@ -5531,7 +5669,7 @@ export const state = {
5531
5669
  },
5532
5670
  "type": {
5533
5671
  "in": "query",
5534
- "description": "Type of usage",
5672
+ "description": "Usage type",
5535
5673
  "type": "string",
5536
5674
  "enum": [
5537
5675
  "invocation_timeout",
@@ -5594,7 +5732,7 @@ export const state = {
5594
5732
  },
5595
5733
  "type": {
5596
5734
  "in": "query",
5597
- "description": "Type of usage",
5735
+ "description": "Usage type",
5598
5736
  "type": "string",
5599
5737
  "enum": [
5600
5738
  "invocation_timeout",
@@ -5718,7 +5856,7 @@ export const state = {
5718
5856
  },
5719
5857
  "type": {
5720
5858
  "in": "query",
5721
- "description": "Type of usage",
5859
+ "description": "Usage type",
5722
5860
  "type": "string",
5723
5861
  "enum": [
5724
5862
  "invocation_timeout",
@@ -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": {
@@ -7905,7 +8180,7 @@ export const state = {
7905
8180
  "parameters": {
7906
8181
  "type": {
7907
8182
  "in": "query",
7908
- "description": "Type of usage",
8183
+ "description": "Usage type",
7909
8184
  "type": "string",
7910
8185
  "enum": [
7911
8186
  "invocation_timeout",
@@ -7953,6 +8228,55 @@ export const state = {
7953
8228
  }
7954
8229
  }
7955
8230
  },
8231
+ "getMultipleUsages": {
8232
+ "name": "getMultipleUsages",
8233
+ "path": "/v1/admin/usages/multiple",
8234
+ "description": "Get multiple usages",
8235
+ "method": "get",
8236
+ "section": "usage",
8237
+ "disableDefaultParameters": {
8238
+ "x-workspace-id": true
8239
+ },
8240
+ "parameters": {
8241
+ "types": {
8242
+ "in": "query",
8243
+ "description": "Usage types to retrieve. All types have to belong to the same type of entity (e.g. workspace or bot).",
8244
+ "type": "string[]",
8245
+ "required": true
8246
+ },
8247
+ "ids": {
8248
+ "in": "query",
8249
+ "type": "string[]",
8250
+ "description": "IDs of either workspaces or bots to retrieve usages for.",
8251
+ "required": true
8252
+ },
8253
+ "period": {
8254
+ "in": "query",
8255
+ "description": "Period to get",
8256
+ "type": "string",
8257
+ "required": false
8258
+ }
8259
+ },
8260
+ "response": {
8261
+ "description": "Success",
8262
+ "schema": {
8263
+ "type": "object",
8264
+ "properties": {
8265
+ "usages": {
8266
+ "type": "array",
8267
+ "items": {
8268
+ "$ref": "#/components/schemas/Usage"
8269
+ }
8270
+ }
8271
+ },
8272
+ "required": [
8273
+ "usages"
8274
+ ],
8275
+ "title": "getMultipleUsagesResponse",
8276
+ "additionalProperties": false
8277
+ }
8278
+ }
8279
+ },
7956
8280
  "listUsageHistory": {
7957
8281
  "name": "listUsageHistory",
7958
8282
  "path": "/v1/admin/usages/{id}/history",
@@ -7961,7 +8285,7 @@ export const state = {
7961
8285
  "parameters": {
7962
8286
  "type": {
7963
8287
  "in": "query",
7964
- "description": "Type of usage",
8288
+ "description": "Usage type",
7965
8289
  "type": "string",
7966
8290
  "enum": [
7967
8291
  "invocation_timeout",
@@ -9758,7 +10082,7 @@ export const state = {
9758
10082
  "title": "Botpress API",
9759
10083
  "description": "API for Botpress Cloud",
9760
10084
  "server": "https://api.botpress.cloud",
9761
- "version": "0.29.5",
10085
+ "version": "0.30.0",
9762
10086
  "prefix": "v1"
9763
10087
  },
9764
10088
  "errors": [
@@ -10027,6 +10351,7 @@ export const state = {
10027
10351
  "getIntegrationByNameResponse": true,
10028
10352
  "deleteIntegrationResponse": true,
10029
10353
  "getUsageResponse": true,
10354
+ "getMultipleUsagesResponse": true,
10030
10355
  "listUsageHistoryResponse": true,
10031
10356
  "changeAISpendQuotaResponse": true,
10032
10357
  "listActivitiesResponse": true,
@@ -10627,6 +10952,74 @@ export const state = {
10627
10952
  "maxLength": 200,
10628
10953
  "description": "Version of the [Integration](#schema_integration)"
10629
10954
  },
10955
+ "interfaces": {
10956
+ "type": "object",
10957
+ "additionalProperties": {
10958
+ "type": "object",
10959
+ "properties": {
10960
+ "id": {
10961
+ "type": "string",
10962
+ "minLength": 28,
10963
+ "maxLength": 36
10964
+ },
10965
+ "entities": {
10966
+ "type": "object",
10967
+ "additionalProperties": {
10968
+ "type": "object",
10969
+ "properties": {
10970
+ "name": {
10971
+ "type": "string",
10972
+ "maxLength": 200
10973
+ }
10974
+ },
10975
+ "required": [
10976
+ "name"
10977
+ ],
10978
+ "additionalProperties": false
10979
+ }
10980
+ },
10981
+ "actions": {
10982
+ "type": "object",
10983
+ "additionalProperties": {
10984
+ "type": "object",
10985
+ "properties": {
10986
+ "name": {
10987
+ "type": "string",
10988
+ "maxLength": 200
10989
+ }
10990
+ },
10991
+ "required": [
10992
+ "name"
10993
+ ],
10994
+ "additionalProperties": false
10995
+ }
10996
+ },
10997
+ "events": {
10998
+ "type": "object",
10999
+ "additionalProperties": {
11000
+ "type": "object",
11001
+ "properties": {
11002
+ "name": {
11003
+ "type": "string",
11004
+ "maxLength": 200
11005
+ }
11006
+ },
11007
+ "required": [
11008
+ "name"
11009
+ ],
11010
+ "additionalProperties": false
11011
+ }
11012
+ }
11013
+ },
11014
+ "required": [
11015
+ "id",
11016
+ "entities",
11017
+ "actions",
11018
+ "events"
11019
+ ],
11020
+ "additionalProperties": false
11021
+ }
11022
+ },
10630
11023
  "configuration": {
10631
11024
  "type": "object",
10632
11025
  "properties": {
@@ -11012,6 +11405,7 @@ export const state = {
11012
11405
  "url",
11013
11406
  "name",
11014
11407
  "version",
11408
+ "interfaces",
11015
11409
  "configuration",
11016
11410
  "channels",
11017
11411
  "states",
@@ -12511,7 +12905,8 @@ export const state = {
12511
12905
  "description": "",
12512
12906
  "name": "usage",
12513
12907
  "operations": [
12514
- "getUsage"
12908
+ "getUsage",
12909
+ "getMultipleUsages"
12515
12910
  ],
12516
12911
  "schema": "Usage"
12517
12912
  },