@botpress/api 1.0.0 → 1.2.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/dist/index.js CHANGED
@@ -284643,7 +284643,7 @@ var state = {
284643
284643
  "title": "Botpress API",
284644
284644
  "description": "API for Botpress Cloud",
284645
284645
  "server": "https://api.botpress.cloud",
284646
- "version": "1.0.0",
284646
+ "version": "1.2.0",
284647
284647
  "prefix": "v1"
284648
284648
  },
284649
284649
  "errors": [
@@ -288710,6 +288710,12 @@ var state2 = {
288710
288710
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
288711
288711
  "type": "string"
288712
288712
  },
288713
+ "limit": {
288714
+ "in": "query",
288715
+ "description": "Maximum number of results to return per page",
288716
+ "type": "number",
288717
+ "required": false
288718
+ },
288713
288719
  "name": {
288714
288720
  "type": "string",
288715
288721
  "description": "Integration Name",
@@ -288719,6 +288725,59 @@ var state2 = {
288719
288725
  "type": "string",
288720
288726
  "description": 'Integration version. Either a semver version or tag "latest"',
288721
288727
  "in": "query"
288728
+ },
288729
+ "interfaceId": {
288730
+ "type": "string",
288731
+ "description": "Filter integrations by implemented interface ID",
288732
+ "in": "query"
288733
+ },
288734
+ "interfaceName": {
288735
+ "type": "string",
288736
+ "description": "Filter integrations by implemented interface name (strict match)",
288737
+ "in": "query"
288738
+ },
288739
+ "installedByBotId": {
288740
+ "in": "query",
288741
+ "description": "Bot ID. Required when filtering for installed integrations",
288742
+ "type": "string",
288743
+ "required": false
288744
+ },
288745
+ "verificationStatus": {
288746
+ "type": "string",
288747
+ "description": "Filter integrations by verification status",
288748
+ "in": "query",
288749
+ "enum": [
288750
+ "unapproved",
288751
+ "pending",
288752
+ "approved",
288753
+ "rejected"
288754
+ ]
288755
+ },
288756
+ "search": {
288757
+ "type": "string",
288758
+ "description": "Search integrations by name, description, actions, and interfaces. Responses include a matchedOn field indicating which fields matched the search.",
288759
+ "in": "query"
288760
+ },
288761
+ "sortBy": {
288762
+ "type": "string",
288763
+ "description": "Sort integrations by field",
288764
+ "in": "query",
288765
+ "enum": [
288766
+ "popularity",
288767
+ "name",
288768
+ "createdAt",
288769
+ "updatedAt",
288770
+ "installCount"
288771
+ ]
288772
+ },
288773
+ "direction": {
288774
+ "type": "string",
288775
+ "description": "Sort direction (asc or desc)",
288776
+ "in": "query",
288777
+ "enum": [
288778
+ "asc",
288779
+ "desc"
288780
+ ]
288722
288781
  }
288723
288782
  },
288724
288783
  "response": {
@@ -288820,6 +288879,38 @@ var state2 = {
288820
288879
  "installs",
288821
288880
  "views"
288822
288881
  ]
288882
+ },
288883
+ "matchedOn": {
288884
+ "type": "object",
288885
+ "properties": {
288886
+ "name": {
288887
+ "type": "boolean",
288888
+ "description": "Whether the integration name matched the search term"
288889
+ },
288890
+ "title": {
288891
+ "type": "boolean",
288892
+ "description": "Whether the integration title matched the search term"
288893
+ },
288894
+ "description": {
288895
+ "type": "boolean",
288896
+ "description": "Whether the integration description matched the search term"
288897
+ },
288898
+ "actions": {
288899
+ "type": "array",
288900
+ "items": {
288901
+ "type": "string"
288902
+ },
288903
+ "description": "Action names that matched the search term"
288904
+ },
288905
+ "interfaces": {
288906
+ "type": "array",
288907
+ "items": {
288908
+ "type": "string"
288909
+ },
288910
+ "description": "Interface names that matched the search term"
288911
+ }
288912
+ },
288913
+ "description": "Metadata about which fields matched the search criteria"
288823
288914
  }
288824
288915
  },
288825
288916
  "required": [
@@ -296528,15 +296619,6 @@ var state2 = {
296528
296619
  "description": "Filter integrations by implemented interface name (strict match)",
296529
296620
  "in": "query"
296530
296621
  },
296531
- "visibility": {
296532
- "type": "string",
296533
- "description": "Filter integrations by visibility (public, private)",
296534
- "in": "query",
296535
- "enum": [
296536
- "public",
296537
- "private"
296538
- ]
296539
- },
296540
296622
  "installedByBotId": {
296541
296623
  "in": "query",
296542
296624
  "description": "Bot ID. Required when filtering for installed integrations",
@@ -296580,6 +296662,15 @@ var state2 = {
296580
296662
  "desc"
296581
296663
  ]
296582
296664
  },
296665
+ "visibility": {
296666
+ "type": "string",
296667
+ "description": "Filter integrations by visibility (public, private)",
296668
+ "in": "query",
296669
+ "enum": [
296670
+ "public",
296671
+ "private"
296672
+ ]
296673
+ },
296583
296674
  "dev": {
296584
296675
  "in": "query",
296585
296676
  "description": "If true, only dev integrations are returned. Otherwise, only production integrations are returned.",
@@ -298922,7 +299013,7 @@ var state2 = {
298922
299013
  "title": "Botpress API",
298923
299014
  "description": "API for Botpress Cloud",
298924
299015
  "server": "https://api.botpress.cloud",
298925
- "version": "1.0.0",
299016
+ "version": "1.2.0",
298926
299017
  "prefix": "v1"
298927
299018
  },
298928
299019
  "errors": [
@@ -302789,6 +302880,13 @@ var state3 = {
302789
302880
  },
302790
302881
  "additionalProperties": false
302791
302882
  },
302883
+ "stack": {
302884
+ "type": "string",
302885
+ "enum": [
302886
+ "realtime-v1"
302887
+ ],
302888
+ "description": "Internal setting, cannot be set manually."
302889
+ },
302792
302890
  "vision": {
302793
302891
  "type": "object",
302794
302892
  "properties": {
@@ -304211,7 +304309,7 @@ var state3 = {
304211
304309
  "title": "Botpress API",
304212
304310
  "description": "API for Botpress Cloud",
304213
304311
  "server": "https://api.botpress.cloud",
304214
- "version": "1.0.0",
304312
+ "version": "1.2.0",
304215
304313
  "prefix": "v1"
304216
304314
  },
304217
304315
  "errors": [
@@ -309002,7 +309100,7 @@ var state4 = {
309002
309100
  "title": "Botpress API",
309003
309101
  "description": "API for Botpress Cloud",
309004
309102
  "server": "https://api.botpress.cloud",
309005
- "version": "1.0.0",
309103
+ "version": "1.2.0",
309006
309104
  "prefix": "v1"
309007
309105
  },
309008
309106
  "errors": [
@@ -315590,6 +315688,12 @@ var state5 = {
315590
315688
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
315591
315689
  "type": "string"
315592
315690
  },
315691
+ "limit": {
315692
+ "in": "query",
315693
+ "description": "Maximum number of results to return per page",
315694
+ "type": "number",
315695
+ "required": false
315696
+ },
315593
315697
  "name": {
315594
315698
  "type": "string",
315595
315699
  "description": "Integration Name",
@@ -315599,6 +315703,59 @@ var state5 = {
315599
315703
  "type": "string",
315600
315704
  "description": 'Integration version. Either a semver version or tag "latest"',
315601
315705
  "in": "query"
315706
+ },
315707
+ "interfaceId": {
315708
+ "type": "string",
315709
+ "description": "Filter integrations by implemented interface ID",
315710
+ "in": "query"
315711
+ },
315712
+ "interfaceName": {
315713
+ "type": "string",
315714
+ "description": "Filter integrations by implemented interface name (strict match)",
315715
+ "in": "query"
315716
+ },
315717
+ "installedByBotId": {
315718
+ "in": "query",
315719
+ "description": "Bot ID. Required when filtering for installed integrations",
315720
+ "type": "string",
315721
+ "required": false
315722
+ },
315723
+ "verificationStatus": {
315724
+ "type": "string",
315725
+ "description": "Filter integrations by verification status",
315726
+ "in": "query",
315727
+ "enum": [
315728
+ "unapproved",
315729
+ "pending",
315730
+ "approved",
315731
+ "rejected"
315732
+ ]
315733
+ },
315734
+ "search": {
315735
+ "type": "string",
315736
+ "description": "Search integrations by name, description, actions, and interfaces. Responses include a matchedOn field indicating which fields matched the search.",
315737
+ "in": "query"
315738
+ },
315739
+ "sortBy": {
315740
+ "type": "string",
315741
+ "description": "Sort integrations by field",
315742
+ "in": "query",
315743
+ "enum": [
315744
+ "popularity",
315745
+ "name",
315746
+ "createdAt",
315747
+ "updatedAt",
315748
+ "installCount"
315749
+ ]
315750
+ },
315751
+ "direction": {
315752
+ "type": "string",
315753
+ "description": "Sort direction (asc or desc)",
315754
+ "in": "query",
315755
+ "enum": [
315756
+ "asc",
315757
+ "desc"
315758
+ ]
315602
315759
  }
315603
315760
  },
315604
315761
  "response": {
@@ -315700,6 +315857,38 @@ var state5 = {
315700
315857
  "installs",
315701
315858
  "views"
315702
315859
  ]
315860
+ },
315861
+ "matchedOn": {
315862
+ "type": "object",
315863
+ "properties": {
315864
+ "name": {
315865
+ "type": "boolean",
315866
+ "description": "Whether the integration name matched the search term"
315867
+ },
315868
+ "title": {
315869
+ "type": "boolean",
315870
+ "description": "Whether the integration title matched the search term"
315871
+ },
315872
+ "description": {
315873
+ "type": "boolean",
315874
+ "description": "Whether the integration description matched the search term"
315875
+ },
315876
+ "actions": {
315877
+ "type": "array",
315878
+ "items": {
315879
+ "type": "string"
315880
+ },
315881
+ "description": "Action names that matched the search term"
315882
+ },
315883
+ "interfaces": {
315884
+ "type": "array",
315885
+ "items": {
315886
+ "type": "string"
315887
+ },
315888
+ "description": "Interface names that matched the search term"
315889
+ }
315890
+ },
315891
+ "description": "Metadata about which fields matched the search criteria"
315703
315892
  }
315704
315893
  },
315705
315894
  "required": [
@@ -323409,15 +323598,6 @@ var state5 = {
323409
323598
  "description": "Filter integrations by implemented interface name (strict match)",
323410
323599
  "in": "query"
323411
323600
  },
323412
- "visibility": {
323413
- "type": "string",
323414
- "description": "Filter integrations by visibility (public, private)",
323415
- "in": "query",
323416
- "enum": [
323417
- "public",
323418
- "private"
323419
- ]
323420
- },
323421
323601
  "installedByBotId": {
323422
323602
  "in": "query",
323423
323603
  "description": "Bot ID. Required when filtering for installed integrations",
@@ -323461,6 +323641,15 @@ var state5 = {
323461
323641
  "desc"
323462
323642
  ]
323463
323643
  },
323644
+ "visibility": {
323645
+ "type": "string",
323646
+ "description": "Filter integrations by visibility (public, private)",
323647
+ "in": "query",
323648
+ "enum": [
323649
+ "public",
323650
+ "private"
323651
+ ]
323652
+ },
323464
323653
  "dev": {
323465
323654
  "in": "query",
323466
323655
  "description": "If true, only dev integrations are returned. Otherwise, only production integrations are returned.",
@@ -325910,6 +326099,13 @@ var state5 = {
325910
326099
  },
325911
326100
  "additionalProperties": false
325912
326101
  },
326102
+ "stack": {
326103
+ "type": "string",
326104
+ "enum": [
326105
+ "realtime-v1"
326106
+ ],
326107
+ "description": "Internal setting, cannot be set manually."
326108
+ },
325913
326109
  "vision": {
325914
326110
  "type": "object",
325915
326111
  "properties": {
@@ -328538,7 +328734,7 @@ var state5 = {
328538
328734
  "title": "Botpress API",
328539
328735
  "description": "API for Botpress Cloud",
328540
328736
  "server": "https://api.botpress.cloud",
328541
- "version": "1.0.0",
328737
+ "version": "1.2.0",
328542
328738
  "prefix": "v1"
328543
328739
  },
328544
328740
  "errors": [
@@ -371,6 +371,12 @@ export declare const state: {
371
371
  description: string;
372
372
  type: "string";
373
373
  };
374
+ limit: {
375
+ in: "query";
376
+ description: string;
377
+ type: "number";
378
+ required: false;
379
+ };
374
380
  name: {
375
381
  type: "string";
376
382
  description: string;
@@ -381,6 +387,45 @@ export declare const state: {
381
387
  description: string;
382
388
  in: "query";
383
389
  };
390
+ interfaceId: {
391
+ type: "string";
392
+ description: string;
393
+ in: "query";
394
+ };
395
+ interfaceName: {
396
+ type: "string";
397
+ description: string;
398
+ in: "query";
399
+ };
400
+ installedByBotId: {
401
+ in: "query";
402
+ description: string;
403
+ type: "string";
404
+ required: false;
405
+ };
406
+ verificationStatus: {
407
+ type: "string";
408
+ description: string;
409
+ in: "query";
410
+ enum: string[];
411
+ };
412
+ search: {
413
+ type: "string";
414
+ description: string;
415
+ in: "query";
416
+ };
417
+ sortBy: {
418
+ type: "string";
419
+ description: string;
420
+ in: "query";
421
+ enum: string[];
422
+ };
423
+ direction: {
424
+ type: "string";
425
+ description: string;
426
+ in: "query";
427
+ enum: string[];
428
+ };
384
429
  };
385
430
  response: {
386
431
  description: string;
@@ -470,6 +515,38 @@ export declare const state: {
470
515
  };
471
516
  required: string[];
472
517
  };
518
+ matchedOn: {
519
+ type: "object";
520
+ properties: {
521
+ name: {
522
+ type: "boolean";
523
+ description: string;
524
+ };
525
+ title: {
526
+ type: "boolean";
527
+ description: string;
528
+ };
529
+ description: {
530
+ type: "boolean";
531
+ description: string;
532
+ };
533
+ actions: {
534
+ type: "array";
535
+ items: {
536
+ type: "string";
537
+ };
538
+ description: string;
539
+ };
540
+ interfaces: {
541
+ type: "array";
542
+ items: {
543
+ type: "string";
544
+ };
545
+ description: string;
546
+ };
547
+ };
548
+ description: string;
549
+ };
473
550
  };
474
551
  required: string[];
475
552
  };
@@ -7223,12 +7300,6 @@ export declare const state: {
7223
7300
  description: string;
7224
7301
  in: "query";
7225
7302
  };
7226
- visibility: {
7227
- type: "string";
7228
- description: string;
7229
- in: "query";
7230
- enum: string[];
7231
- };
7232
7303
  installedByBotId: {
7233
7304
  in: "query";
7234
7305
  description: string;
@@ -7258,6 +7329,12 @@ export declare const state: {
7258
7329
  in: "query";
7259
7330
  enum: string[];
7260
7331
  };
7332
+ visibility: {
7333
+ type: "string";
7334
+ description: string;
7335
+ in: "query";
7336
+ enum: string[];
7337
+ };
7261
7338
  dev: {
7262
7339
  in: "query";
7263
7340
  description: string;
@@ -110,6 +110,11 @@ export declare const state: {
110
110
  };
111
111
  additionalProperties: false;
112
112
  };
113
+ stack: {
114
+ type: "string";
115
+ enum: string[];
116
+ description: string;
117
+ };
113
118
  vision: {
114
119
  type: "object";
115
120
  properties: {
@@ -2723,6 +2723,12 @@ export declare const state: {
2723
2723
  description: string;
2724
2724
  type: "string";
2725
2725
  };
2726
+ limit: {
2727
+ in: "query";
2728
+ description: string;
2729
+ type: "number";
2730
+ required: false;
2731
+ };
2726
2732
  name: {
2727
2733
  type: "string";
2728
2734
  description: string;
@@ -2733,6 +2739,45 @@ export declare const state: {
2733
2739
  description: string;
2734
2740
  in: "query";
2735
2741
  };
2742
+ interfaceId: {
2743
+ type: "string";
2744
+ description: string;
2745
+ in: "query";
2746
+ };
2747
+ interfaceName: {
2748
+ type: "string";
2749
+ description: string;
2750
+ in: "query";
2751
+ };
2752
+ installedByBotId: {
2753
+ in: "query";
2754
+ description: string;
2755
+ type: "string";
2756
+ required: false;
2757
+ };
2758
+ verificationStatus: {
2759
+ type: "string";
2760
+ description: string;
2761
+ in: "query";
2762
+ enum: string[];
2763
+ };
2764
+ search: {
2765
+ type: "string";
2766
+ description: string;
2767
+ in: "query";
2768
+ };
2769
+ sortBy: {
2770
+ type: "string";
2771
+ description: string;
2772
+ in: "query";
2773
+ enum: string[];
2774
+ };
2775
+ direction: {
2776
+ type: "string";
2777
+ description: string;
2778
+ in: "query";
2779
+ enum: string[];
2780
+ };
2736
2781
  };
2737
2782
  response: {
2738
2783
  description: string;
@@ -2822,6 +2867,38 @@ export declare const state: {
2822
2867
  };
2823
2868
  required: string[];
2824
2869
  };
2870
+ matchedOn: {
2871
+ type: "object";
2872
+ properties: {
2873
+ name: {
2874
+ type: "boolean";
2875
+ description: string;
2876
+ };
2877
+ title: {
2878
+ type: "boolean";
2879
+ description: string;
2880
+ };
2881
+ description: {
2882
+ type: "boolean";
2883
+ description: string;
2884
+ };
2885
+ actions: {
2886
+ type: "array";
2887
+ items: {
2888
+ type: "string";
2889
+ };
2890
+ description: string;
2891
+ };
2892
+ interfaces: {
2893
+ type: "array";
2894
+ items: {
2895
+ type: "string";
2896
+ };
2897
+ description: string;
2898
+ };
2899
+ };
2900
+ description: string;
2901
+ };
2825
2902
  };
2826
2903
  required: string[];
2827
2904
  };
@@ -9576,12 +9653,6 @@ export declare const state: {
9576
9653
  description: string;
9577
9654
  in: "query";
9578
9655
  };
9579
- visibility: {
9580
- type: "string";
9581
- description: string;
9582
- in: "query";
9583
- enum: string[];
9584
- };
9585
9656
  installedByBotId: {
9586
9657
  in: "query";
9587
9658
  description: string;
@@ -9611,6 +9682,12 @@ export declare const state: {
9611
9682
  in: "query";
9612
9683
  enum: string[];
9613
9684
  };
9685
+ visibility: {
9686
+ type: "string";
9687
+ description: string;
9688
+ in: "query";
9689
+ enum: string[];
9690
+ };
9614
9691
  dev: {
9615
9692
  in: "query";
9616
9693
  description: string;
@@ -11793,6 +11870,11 @@ export declare const state: {
11793
11870
  };
11794
11871
  additionalProperties: false;
11795
11872
  };
11873
+ stack: {
11874
+ type: "string";
11875
+ enum: string[];
11876
+ description: string;
11877
+ };
11796
11878
  vision: {
11797
11879
  type: "object";
11798
11880
  properties: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "1.0.0",
3
+ "version": "1.2.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {