@botpress/api 1.0.0 → 1.1.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.
@@ -408,6 +408,12 @@ export const state = {
408
408
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
409
409
  "type": "string"
410
410
  },
411
+ "limit": {
412
+ "in": "query",
413
+ "description": "Maximum number of results to return per page",
414
+ "type": "number",
415
+ "required": false
416
+ },
411
417
  "name": {
412
418
  "type": "string",
413
419
  "description": "Integration Name",
@@ -417,6 +423,59 @@ export const state = {
417
423
  "type": "string",
418
424
  "description": "Integration version. Either a semver version or tag \"latest\"",
419
425
  "in": "query"
426
+ },
427
+ "interfaceId": {
428
+ "type": "string",
429
+ "description": "Filter integrations by implemented interface ID",
430
+ "in": "query"
431
+ },
432
+ "interfaceName": {
433
+ "type": "string",
434
+ "description": "Filter integrations by implemented interface name (strict match)",
435
+ "in": "query"
436
+ },
437
+ "installedByBotId": {
438
+ "in": "query",
439
+ "description": "Bot ID. Required when filtering for installed integrations",
440
+ "type": "string",
441
+ "required": false
442
+ },
443
+ "verificationStatus": {
444
+ "type": "string",
445
+ "description": "Filter integrations by verification status",
446
+ "in": "query",
447
+ "enum": [
448
+ "unapproved",
449
+ "pending",
450
+ "approved",
451
+ "rejected"
452
+ ]
453
+ },
454
+ "search": {
455
+ "type": "string",
456
+ "description": "Search integrations by name, description, actions, and interfaces. Responses include a matchedOn field indicating which fields matched the search.",
457
+ "in": "query"
458
+ },
459
+ "sortBy": {
460
+ "type": "string",
461
+ "description": "Sort integrations by field",
462
+ "in": "query",
463
+ "enum": [
464
+ "popularity",
465
+ "name",
466
+ "createdAt",
467
+ "updatedAt",
468
+ "installCount"
469
+ ]
470
+ },
471
+ "direction": {
472
+ "type": "string",
473
+ "description": "Sort direction (asc or desc)",
474
+ "in": "query",
475
+ "enum": [
476
+ "asc",
477
+ "desc"
478
+ ]
420
479
  }
421
480
  },
422
481
  "response": {
@@ -518,6 +577,38 @@ export const state = {
518
577
  "installs",
519
578
  "views"
520
579
  ]
580
+ },
581
+ "matchedOn": {
582
+ "type": "object",
583
+ "properties": {
584
+ "name": {
585
+ "type": "boolean",
586
+ "description": "Whether the integration name matched the search term"
587
+ },
588
+ "title": {
589
+ "type": "boolean",
590
+ "description": "Whether the integration title matched the search term"
591
+ },
592
+ "description": {
593
+ "type": "boolean",
594
+ "description": "Whether the integration description matched the search term"
595
+ },
596
+ "actions": {
597
+ "type": "array",
598
+ "items": {
599
+ "type": "string"
600
+ },
601
+ "description": "Action names that matched the search term"
602
+ },
603
+ "interfaces": {
604
+ "type": "array",
605
+ "items": {
606
+ "type": "string"
607
+ },
608
+ "description": "Interface names that matched the search term"
609
+ }
610
+ },
611
+ "description": "Metadata about which fields matched the search criteria"
521
612
  }
522
613
  },
523
614
  "required": [
@@ -8226,15 +8317,6 @@ export const state = {
8226
8317
  "description": "Filter integrations by implemented interface name (strict match)",
8227
8318
  "in": "query"
8228
8319
  },
8229
- "visibility": {
8230
- "type": "string",
8231
- "description": "Filter integrations by visibility (public, private)",
8232
- "in": "query",
8233
- "enum": [
8234
- "public",
8235
- "private"
8236
- ]
8237
- },
8238
8320
  "installedByBotId": {
8239
8321
  "in": "query",
8240
8322
  "description": "Bot ID. Required when filtering for installed integrations",
@@ -8278,6 +8360,15 @@ export const state = {
8278
8360
  "desc"
8279
8361
  ]
8280
8362
  },
8363
+ "visibility": {
8364
+ "type": "string",
8365
+ "description": "Filter integrations by visibility (public, private)",
8366
+ "in": "query",
8367
+ "enum": [
8368
+ "public",
8369
+ "private"
8370
+ ]
8371
+ },
8281
8372
  "dev": {
8282
8373
  "in": "query",
8283
8374
  "description": "If true, only dev integrations are returned. Otherwise, only production integrations are returned.",
@@ -10620,7 +10711,7 @@ export const state = {
10620
10711
  "title": "Botpress API",
10621
10712
  "description": "API for Botpress Cloud",
10622
10713
  "server": "https://api.botpress.cloud",
10623
- "version": "1.0.0",
10714
+ "version": "1.1.0",
10624
10715
  "prefix": "v1"
10625
10716
  },
10626
10717
  "errors": [