@botpress/api 0.19.1 → 0.19.2
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 +1414 -308
- package/dist/src/gen/state.d.ts +1009 -80
- package/package.json +2 -2
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +1191 -95
package/src/gen/state.ts
CHANGED
|
@@ -2226,9 +2226,7 @@ export const state = {
|
|
|
2226
2226
|
"schema": {
|
|
2227
2227
|
"type": "object",
|
|
2228
2228
|
"properties": {
|
|
2229
|
-
"value": {
|
|
2230
|
-
"nullable": true
|
|
2231
|
-
}
|
|
2229
|
+
"value": {}
|
|
2232
2230
|
},
|
|
2233
2231
|
"title": "setAccountPreferenceBody",
|
|
2234
2232
|
"additionalProperties": false
|
|
@@ -2349,103 +2347,1048 @@ export const state = {
|
|
|
2349
2347
|
"iconUrl": {
|
|
2350
2348
|
"type": "string",
|
|
2351
2349
|
"description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
|
|
2350
|
+
},
|
|
2351
|
+
"ownerWorkspace": {
|
|
2352
|
+
"type": "object",
|
|
2353
|
+
"properties": {
|
|
2354
|
+
"id": {
|
|
2355
|
+
"type": "string"
|
|
2356
|
+
},
|
|
2357
|
+
"handle": {
|
|
2358
|
+
"type": "string",
|
|
2359
|
+
"nullable": true
|
|
2360
|
+
},
|
|
2361
|
+
"name": {
|
|
2362
|
+
"type": "string"
|
|
2363
|
+
}
|
|
2364
|
+
},
|
|
2365
|
+
"required": [
|
|
2366
|
+
"id",
|
|
2367
|
+
"handle",
|
|
2368
|
+
"name"
|
|
2369
|
+
]
|
|
2370
|
+
}
|
|
2371
|
+
},
|
|
2372
|
+
"required": [
|
|
2373
|
+
"id",
|
|
2374
|
+
"name",
|
|
2375
|
+
"version",
|
|
2376
|
+
"createdAt",
|
|
2377
|
+
"updatedAt",
|
|
2378
|
+
"title",
|
|
2379
|
+
"description",
|
|
2380
|
+
"iconUrl",
|
|
2381
|
+
"ownerWorkspace"
|
|
2382
|
+
]
|
|
2383
|
+
}
|
|
2384
|
+
},
|
|
2385
|
+
"meta": {
|
|
2386
|
+
"type": "object",
|
|
2387
|
+
"properties": {
|
|
2388
|
+
"nextToken": {
|
|
2389
|
+
"type": "string",
|
|
2390
|
+
"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."
|
|
2391
|
+
}
|
|
2392
|
+
},
|
|
2393
|
+
"additionalProperties": false
|
|
2394
|
+
}
|
|
2395
|
+
},
|
|
2396
|
+
"required": [
|
|
2397
|
+
"integrations",
|
|
2398
|
+
"meta"
|
|
2399
|
+
],
|
|
2400
|
+
"title": "listPublicIntegrationsResponse",
|
|
2401
|
+
"additionalProperties": false
|
|
2402
|
+
}
|
|
2403
|
+
}
|
|
2404
|
+
},
|
|
2405
|
+
"getPublicIntegrationById": {
|
|
2406
|
+
"name": "getPublicIntegrationById",
|
|
2407
|
+
"description": "Get public integration by Id",
|
|
2408
|
+
"method": "get",
|
|
2409
|
+
"section": "hub",
|
|
2410
|
+
"path": "/v1/admin/hub/integrations/{id}",
|
|
2411
|
+
"disableDefaultParameters": {
|
|
2412
|
+
"x-workspace-id": true
|
|
2413
|
+
},
|
|
2414
|
+
"parameters": {
|
|
2415
|
+
"id": {
|
|
2416
|
+
"type": "string",
|
|
2417
|
+
"description": "Integration ID",
|
|
2418
|
+
"in": "path"
|
|
2419
|
+
}
|
|
2420
|
+
},
|
|
2421
|
+
"response": {
|
|
2422
|
+
"description": "Success",
|
|
2423
|
+
"schema": {
|
|
2424
|
+
"type": "object",
|
|
2425
|
+
"properties": {
|
|
2426
|
+
"integration": {
|
|
2427
|
+
"type": "object",
|
|
2428
|
+
"properties": {
|
|
2429
|
+
"id": {
|
|
2430
|
+
"type": "string",
|
|
2431
|
+
"minLength": 28,
|
|
2432
|
+
"maxLength": 36,
|
|
2433
|
+
"description": "User id"
|
|
2434
|
+
},
|
|
2435
|
+
"createdAt": {
|
|
2436
|
+
"type": "string",
|
|
2437
|
+
"format": "date-time",
|
|
2438
|
+
"description": "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
2439
|
+
},
|
|
2440
|
+
"updatedAt": {
|
|
2441
|
+
"type": "string",
|
|
2442
|
+
"format": "date-time",
|
|
2443
|
+
"description": "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
2444
|
+
},
|
|
2445
|
+
"identifier": {
|
|
2446
|
+
"type": "object",
|
|
2447
|
+
"properties": {
|
|
2448
|
+
"fallbackHandlerScript": {
|
|
2449
|
+
"type": "string",
|
|
2450
|
+
"maxLength": 2000,
|
|
2451
|
+
"description": "VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier"
|
|
2452
|
+
},
|
|
2453
|
+
"extractScript": {
|
|
2454
|
+
"type": "string",
|
|
2455
|
+
"maxLength": 2000,
|
|
2456
|
+
"description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth"
|
|
2457
|
+
}
|
|
2458
|
+
},
|
|
2459
|
+
"description": "Global identifier configuration of the [Integration](#schema_integration)",
|
|
2460
|
+
"additionalProperties": false
|
|
2461
|
+
},
|
|
2462
|
+
"name": {
|
|
2463
|
+
"type": "string",
|
|
2464
|
+
"maxLength": 200,
|
|
2465
|
+
"description": "Unique identifier of the integration that was installed on the bot"
|
|
2466
|
+
},
|
|
2467
|
+
"version": {
|
|
2468
|
+
"type": "string",
|
|
2469
|
+
"maxLength": 200,
|
|
2470
|
+
"description": "Unique identifier of the integration that was installed on the bot"
|
|
2471
|
+
},
|
|
2472
|
+
"configuration": {
|
|
2473
|
+
"type": "object",
|
|
2474
|
+
"properties": {
|
|
2475
|
+
"identifier": {
|
|
2476
|
+
"type": "object",
|
|
2477
|
+
"properties": {
|
|
2478
|
+
"linkTemplateScript": {
|
|
2479
|
+
"type": "string",
|
|
2480
|
+
"maxLength": 2000,
|
|
2481
|
+
"description": "Title describing the task"
|
|
2482
|
+
},
|
|
2483
|
+
"required": {
|
|
2484
|
+
"type": "boolean"
|
|
2485
|
+
}
|
|
2486
|
+
},
|
|
2487
|
+
"required": [
|
|
2488
|
+
"required"
|
|
2489
|
+
],
|
|
2490
|
+
"description": "Identifier configuration of the [Integration](#schema_integration)",
|
|
2491
|
+
"additionalProperties": false
|
|
2492
|
+
},
|
|
2493
|
+
"schema": {
|
|
2494
|
+
"type": "object",
|
|
2495
|
+
"additionalProperties": true,
|
|
2496
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
2497
|
+
}
|
|
2498
|
+
},
|
|
2499
|
+
"required": [
|
|
2500
|
+
"identifier"
|
|
2501
|
+
],
|
|
2502
|
+
"description": "Configuration definition",
|
|
2503
|
+
"additionalProperties": false
|
|
2504
|
+
},
|
|
2505
|
+
"channels": {
|
|
2506
|
+
"type": "object",
|
|
2507
|
+
"additionalProperties": {
|
|
2508
|
+
"type": "object",
|
|
2509
|
+
"properties": {
|
|
2510
|
+
"title": {
|
|
2511
|
+
"type": "string",
|
|
2512
|
+
"maxLength": 64,
|
|
2513
|
+
"description": "Title of the channel"
|
|
2514
|
+
},
|
|
2515
|
+
"description": {
|
|
2516
|
+
"type": "string",
|
|
2517
|
+
"maxLength": 256,
|
|
2518
|
+
"description": "Description of the channel"
|
|
2519
|
+
},
|
|
2520
|
+
"messages": {
|
|
2521
|
+
"type": "object",
|
|
2522
|
+
"additionalProperties": {
|
|
2523
|
+
"type": "object",
|
|
2524
|
+
"properties": {
|
|
2525
|
+
"schema": {
|
|
2526
|
+
"type": "object",
|
|
2527
|
+
"additionalProperties": true
|
|
2528
|
+
}
|
|
2529
|
+
},
|
|
2530
|
+
"required": [
|
|
2531
|
+
"schema"
|
|
2532
|
+
],
|
|
2533
|
+
"description": "Message definition",
|
|
2534
|
+
"additionalProperties": false
|
|
2535
|
+
}
|
|
2536
|
+
},
|
|
2537
|
+
"conversation": {
|
|
2538
|
+
"type": "object",
|
|
2539
|
+
"properties": {
|
|
2540
|
+
"tags": {
|
|
2541
|
+
"type": "object",
|
|
2542
|
+
"additionalProperties": {
|
|
2543
|
+
"type": "object",
|
|
2544
|
+
"properties": {
|
|
2545
|
+
"title": {
|
|
2546
|
+
"type": "string",
|
|
2547
|
+
"maxLength": 64,
|
|
2548
|
+
"description": "Title of the tag"
|
|
2549
|
+
},
|
|
2550
|
+
"description": {
|
|
2551
|
+
"type": "string",
|
|
2552
|
+
"maxLength": 256,
|
|
2553
|
+
"description": "Description of the tag"
|
|
2554
|
+
}
|
|
2555
|
+
},
|
|
2556
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
2557
|
+
"additionalProperties": false
|
|
2558
|
+
}
|
|
2559
|
+
},
|
|
2560
|
+
"creation": {
|
|
2561
|
+
"type": "object",
|
|
2562
|
+
"properties": {
|
|
2563
|
+
"enabled": {
|
|
2564
|
+
"type": "boolean",
|
|
2565
|
+
"description": "Enable conversation creation"
|
|
2566
|
+
},
|
|
2567
|
+
"requiredTags": {
|
|
2568
|
+
"type": "array",
|
|
2569
|
+
"items": {
|
|
2570
|
+
"type": "string"
|
|
2571
|
+
},
|
|
2572
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
|
|
2573
|
+
}
|
|
2574
|
+
},
|
|
2575
|
+
"required": [
|
|
2576
|
+
"enabled",
|
|
2577
|
+
"requiredTags"
|
|
2578
|
+
],
|
|
2579
|
+
"description": "The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.",
|
|
2580
|
+
"additionalProperties": false
|
|
2581
|
+
}
|
|
2582
|
+
},
|
|
2583
|
+
"required": [
|
|
2584
|
+
"tags",
|
|
2585
|
+
"creation"
|
|
2586
|
+
],
|
|
2587
|
+
"description": "Conversation object configuration",
|
|
2588
|
+
"additionalProperties": false
|
|
2589
|
+
},
|
|
2590
|
+
"message": {
|
|
2591
|
+
"type": "object",
|
|
2592
|
+
"properties": {
|
|
2593
|
+
"tags": {
|
|
2594
|
+
"type": "object",
|
|
2595
|
+
"additionalProperties": {
|
|
2596
|
+
"type": "object",
|
|
2597
|
+
"properties": {
|
|
2598
|
+
"title": {
|
|
2599
|
+
"type": "string",
|
|
2600
|
+
"maxLength": 64,
|
|
2601
|
+
"description": "Title of the tag"
|
|
2602
|
+
},
|
|
2603
|
+
"description": {
|
|
2604
|
+
"type": "string",
|
|
2605
|
+
"maxLength": 256,
|
|
2606
|
+
"description": "Description of the tag"
|
|
2607
|
+
}
|
|
2608
|
+
},
|
|
2609
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
2610
|
+
"additionalProperties": false
|
|
2611
|
+
}
|
|
2612
|
+
}
|
|
2613
|
+
},
|
|
2614
|
+
"required": [
|
|
2615
|
+
"tags"
|
|
2616
|
+
],
|
|
2617
|
+
"description": "Message object configuration",
|
|
2618
|
+
"additionalProperties": false
|
|
2619
|
+
}
|
|
2620
|
+
},
|
|
2621
|
+
"required": [
|
|
2622
|
+
"messages",
|
|
2623
|
+
"conversation",
|
|
2624
|
+
"message"
|
|
2625
|
+
],
|
|
2626
|
+
"description": "Channel definition",
|
|
2627
|
+
"additionalProperties": false
|
|
2628
|
+
}
|
|
2629
|
+
},
|
|
2630
|
+
"states": {
|
|
2631
|
+
"type": "object",
|
|
2632
|
+
"additionalProperties": {
|
|
2633
|
+
"type": "object",
|
|
2634
|
+
"properties": {
|
|
2635
|
+
"type": {
|
|
2636
|
+
"type": "string",
|
|
2637
|
+
"enum": [
|
|
2638
|
+
"conversation",
|
|
2639
|
+
"user",
|
|
2640
|
+
"integration"
|
|
2641
|
+
],
|
|
2642
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
|
|
2643
|
+
},
|
|
2644
|
+
"schema": {
|
|
2645
|
+
"type": "object",
|
|
2646
|
+
"additionalProperties": true,
|
|
2647
|
+
"description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
|
|
2648
|
+
}
|
|
2649
|
+
},
|
|
2650
|
+
"required": [
|
|
2651
|
+
"type",
|
|
2652
|
+
"schema"
|
|
2653
|
+
],
|
|
2654
|
+
"description": "State definition",
|
|
2655
|
+
"additionalProperties": false
|
|
2656
|
+
}
|
|
2657
|
+
},
|
|
2658
|
+
"events": {
|
|
2659
|
+
"type": "object",
|
|
2660
|
+
"additionalProperties": {
|
|
2661
|
+
"type": "object",
|
|
2662
|
+
"properties": {
|
|
2663
|
+
"title": {
|
|
2664
|
+
"type": "string",
|
|
2665
|
+
"maxLength": 64,
|
|
2666
|
+
"description": "Title of the event"
|
|
2667
|
+
},
|
|
2668
|
+
"description": {
|
|
2669
|
+
"type": "string",
|
|
2670
|
+
"maxLength": 256,
|
|
2671
|
+
"description": "Description of the event"
|
|
2672
|
+
},
|
|
2673
|
+
"schema": {
|
|
2674
|
+
"type": "object",
|
|
2675
|
+
"additionalProperties": true
|
|
2676
|
+
}
|
|
2677
|
+
},
|
|
2678
|
+
"required": [
|
|
2679
|
+
"schema"
|
|
2680
|
+
],
|
|
2681
|
+
"description": "Event Definition",
|
|
2682
|
+
"additionalProperties": false
|
|
2683
|
+
}
|
|
2684
|
+
},
|
|
2685
|
+
"actions": {
|
|
2686
|
+
"type": "object",
|
|
2687
|
+
"additionalProperties": {
|
|
2688
|
+
"type": "object",
|
|
2689
|
+
"properties": {
|
|
2690
|
+
"title": {
|
|
2691
|
+
"type": "string",
|
|
2692
|
+
"maxLength": 64,
|
|
2693
|
+
"description": "Title of the action"
|
|
2694
|
+
},
|
|
2695
|
+
"description": {
|
|
2696
|
+
"type": "string",
|
|
2697
|
+
"maxLength": 256,
|
|
2698
|
+
"description": "Description of the action"
|
|
2699
|
+
},
|
|
2700
|
+
"input": {
|
|
2701
|
+
"type": "object",
|
|
2702
|
+
"properties": {
|
|
2703
|
+
"schema": {
|
|
2704
|
+
"type": "object",
|
|
2705
|
+
"additionalProperties": true
|
|
2706
|
+
}
|
|
2707
|
+
},
|
|
2708
|
+
"required": [
|
|
2709
|
+
"schema"
|
|
2710
|
+
],
|
|
2711
|
+
"additionalProperties": false
|
|
2712
|
+
},
|
|
2713
|
+
"output": {
|
|
2714
|
+
"type": "object",
|
|
2715
|
+
"properties": {
|
|
2716
|
+
"schema": {
|
|
2717
|
+
"type": "object",
|
|
2718
|
+
"additionalProperties": true
|
|
2719
|
+
}
|
|
2720
|
+
},
|
|
2721
|
+
"required": [
|
|
2722
|
+
"schema"
|
|
2723
|
+
],
|
|
2724
|
+
"additionalProperties": false
|
|
2725
|
+
}
|
|
2726
|
+
},
|
|
2727
|
+
"required": [
|
|
2728
|
+
"input",
|
|
2729
|
+
"output"
|
|
2730
|
+
],
|
|
2731
|
+
"description": "Action definition",
|
|
2732
|
+
"additionalProperties": false
|
|
2733
|
+
}
|
|
2734
|
+
},
|
|
2735
|
+
"user": {
|
|
2736
|
+
"type": "object",
|
|
2737
|
+
"properties": {
|
|
2738
|
+
"tags": {
|
|
2739
|
+
"type": "object",
|
|
2740
|
+
"additionalProperties": {
|
|
2741
|
+
"type": "object",
|
|
2742
|
+
"properties": {
|
|
2743
|
+
"title": {
|
|
2744
|
+
"type": "string",
|
|
2745
|
+
"maxLength": 64,
|
|
2746
|
+
"description": "Title of the tag"
|
|
2747
|
+
},
|
|
2748
|
+
"description": {
|
|
2749
|
+
"type": "string",
|
|
2750
|
+
"maxLength": 256,
|
|
2751
|
+
"description": "Description of the tag"
|
|
2752
|
+
}
|
|
2753
|
+
},
|
|
2754
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
2755
|
+
"additionalProperties": false
|
|
2756
|
+
}
|
|
2757
|
+
},
|
|
2758
|
+
"creation": {
|
|
2759
|
+
"type": "object",
|
|
2760
|
+
"properties": {
|
|
2761
|
+
"enabled": {
|
|
2762
|
+
"type": "boolean",
|
|
2763
|
+
"description": "Enable user creation"
|
|
2764
|
+
},
|
|
2765
|
+
"requiredTags": {
|
|
2766
|
+
"type": "array",
|
|
2767
|
+
"items": {
|
|
2768
|
+
"type": "string"
|
|
2769
|
+
},
|
|
2770
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
2771
|
+
}
|
|
2772
|
+
},
|
|
2773
|
+
"required": [
|
|
2774
|
+
"enabled",
|
|
2775
|
+
"requiredTags"
|
|
2776
|
+
],
|
|
2777
|
+
"description": "The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.",
|
|
2778
|
+
"additionalProperties": false
|
|
2779
|
+
}
|
|
2780
|
+
},
|
|
2781
|
+
"required": [
|
|
2782
|
+
"tags",
|
|
2783
|
+
"creation"
|
|
2784
|
+
],
|
|
2785
|
+
"description": "User object configuration",
|
|
2786
|
+
"additionalProperties": false
|
|
2787
|
+
},
|
|
2788
|
+
"entities": {
|
|
2789
|
+
"type": "object",
|
|
2790
|
+
"additionalProperties": {
|
|
2791
|
+
"type": "object",
|
|
2792
|
+
"properties": {
|
|
2793
|
+
"title": {
|
|
2794
|
+
"type": "string",
|
|
2795
|
+
"maxLength": 64,
|
|
2796
|
+
"description": "Title of the entity"
|
|
2797
|
+
},
|
|
2798
|
+
"description": {
|
|
2799
|
+
"type": "string",
|
|
2800
|
+
"maxLength": 256,
|
|
2801
|
+
"description": "Description of the entity"
|
|
2802
|
+
},
|
|
2803
|
+
"schema": {
|
|
2804
|
+
"type": "object",
|
|
2805
|
+
"additionalProperties": true
|
|
2806
|
+
}
|
|
2807
|
+
},
|
|
2808
|
+
"required": [
|
|
2809
|
+
"schema"
|
|
2810
|
+
],
|
|
2811
|
+
"description": "Entity definition",
|
|
2812
|
+
"additionalProperties": false
|
|
2813
|
+
}
|
|
2814
|
+
},
|
|
2815
|
+
"dev": {
|
|
2816
|
+
"type": "boolean",
|
|
2817
|
+
"description": "Indicates if the integration is a development integration; Dev integrations run locally"
|
|
2818
|
+
},
|
|
2819
|
+
"title": {
|
|
2820
|
+
"type": "string",
|
|
2821
|
+
"minLength": 1,
|
|
2822
|
+
"maxLength": 64,
|
|
2823
|
+
"description": "Title of the integration. This is the name that will be displayed in the UI"
|
|
2824
|
+
},
|
|
2825
|
+
"description": {
|
|
2826
|
+
"type": "string",
|
|
2827
|
+
"maxLength": 256,
|
|
2828
|
+
"description": "Description of the integration. This is the description that will be displayed in the UI"
|
|
2829
|
+
},
|
|
2830
|
+
"iconUrl": {
|
|
2831
|
+
"type": "string",
|
|
2832
|
+
"description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
|
|
2833
|
+
},
|
|
2834
|
+
"readmeUrl": {
|
|
2835
|
+
"type": "string",
|
|
2836
|
+
"description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
|
|
2837
|
+
},
|
|
2838
|
+
"secrets": {
|
|
2839
|
+
"type": "array",
|
|
2840
|
+
"items": {
|
|
2841
|
+
"type": "string"
|
|
2842
|
+
},
|
|
2843
|
+
"description": "Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing."
|
|
2844
|
+
},
|
|
2845
|
+
"ownerWorkspace": {
|
|
2846
|
+
"type": "object",
|
|
2847
|
+
"properties": {
|
|
2848
|
+
"id": {
|
|
2849
|
+
"type": "string"
|
|
2850
|
+
},
|
|
2851
|
+
"handle": {
|
|
2852
|
+
"type": "string",
|
|
2853
|
+
"nullable": true
|
|
2854
|
+
},
|
|
2855
|
+
"name": {
|
|
2856
|
+
"type": "string"
|
|
2857
|
+
}
|
|
2858
|
+
},
|
|
2859
|
+
"required": [
|
|
2860
|
+
"id",
|
|
2861
|
+
"handle",
|
|
2862
|
+
"name"
|
|
2863
|
+
],
|
|
2864
|
+
"additionalProperties": false
|
|
2865
|
+
}
|
|
2866
|
+
},
|
|
2867
|
+
"required": [
|
|
2868
|
+
"id",
|
|
2869
|
+
"createdAt",
|
|
2870
|
+
"updatedAt",
|
|
2871
|
+
"identifier",
|
|
2872
|
+
"name",
|
|
2873
|
+
"version",
|
|
2874
|
+
"configuration",
|
|
2875
|
+
"channels",
|
|
2876
|
+
"states",
|
|
2877
|
+
"events",
|
|
2878
|
+
"actions",
|
|
2879
|
+
"user",
|
|
2880
|
+
"entities",
|
|
2881
|
+
"dev",
|
|
2882
|
+
"title",
|
|
2883
|
+
"description",
|
|
2884
|
+
"iconUrl",
|
|
2885
|
+
"readmeUrl",
|
|
2886
|
+
"secrets",
|
|
2887
|
+
"ownerWorkspace"
|
|
2888
|
+
],
|
|
2889
|
+
"additionalProperties": false
|
|
2890
|
+
}
|
|
2891
|
+
},
|
|
2892
|
+
"required": [
|
|
2893
|
+
"integration"
|
|
2894
|
+
],
|
|
2895
|
+
"title": "getPublicIntegrationByIdResponse",
|
|
2896
|
+
"additionalProperties": false
|
|
2897
|
+
}
|
|
2898
|
+
}
|
|
2899
|
+
},
|
|
2900
|
+
"getPublicIntegration": {
|
|
2901
|
+
"name": "getPublicIntegration",
|
|
2902
|
+
"description": "Get public integration by name and version",
|
|
2903
|
+
"method": "get",
|
|
2904
|
+
"section": "hub",
|
|
2905
|
+
"path": "/v1/admin/hub/integrations/{name}/{version}",
|
|
2906
|
+
"disableDefaultParameters": {
|
|
2907
|
+
"x-workspace-id": true
|
|
2908
|
+
},
|
|
2909
|
+
"parameters": {
|
|
2910
|
+
"name": {
|
|
2911
|
+
"type": "string",
|
|
2912
|
+
"description": "Integration Name",
|
|
2913
|
+
"in": "path"
|
|
2914
|
+
},
|
|
2915
|
+
"version": {
|
|
2916
|
+
"type": "string",
|
|
2917
|
+
"description": "Integration version. Either a semver version or tag \"latest\"",
|
|
2918
|
+
"in": "path"
|
|
2919
|
+
}
|
|
2920
|
+
},
|
|
2921
|
+
"response": {
|
|
2922
|
+
"description": "Success",
|
|
2923
|
+
"schema": {
|
|
2924
|
+
"type": "object",
|
|
2925
|
+
"properties": {
|
|
2926
|
+
"integration": {
|
|
2927
|
+
"type": "object",
|
|
2928
|
+
"properties": {
|
|
2929
|
+
"id": {
|
|
2930
|
+
"type": "string",
|
|
2931
|
+
"minLength": 28,
|
|
2932
|
+
"maxLength": 36,
|
|
2933
|
+
"description": "User id"
|
|
2934
|
+
},
|
|
2935
|
+
"createdAt": {
|
|
2936
|
+
"type": "string",
|
|
2937
|
+
"format": "date-time",
|
|
2938
|
+
"description": "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
2939
|
+
},
|
|
2940
|
+
"updatedAt": {
|
|
2941
|
+
"type": "string",
|
|
2942
|
+
"format": "date-time",
|
|
2943
|
+
"description": "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
2944
|
+
},
|
|
2945
|
+
"identifier": {
|
|
2946
|
+
"type": "object",
|
|
2947
|
+
"properties": {
|
|
2948
|
+
"fallbackHandlerScript": {
|
|
2949
|
+
"type": "string",
|
|
2950
|
+
"maxLength": 2000,
|
|
2951
|
+
"description": "VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier"
|
|
2952
|
+
},
|
|
2953
|
+
"extractScript": {
|
|
2954
|
+
"type": "string",
|
|
2955
|
+
"maxLength": 2000,
|
|
2956
|
+
"description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth"
|
|
2957
|
+
}
|
|
2958
|
+
},
|
|
2959
|
+
"description": "Global identifier configuration of the [Integration](#schema_integration)",
|
|
2960
|
+
"additionalProperties": false
|
|
2961
|
+
},
|
|
2962
|
+
"name": {
|
|
2963
|
+
"type": "string",
|
|
2964
|
+
"maxLength": 200,
|
|
2965
|
+
"description": "Unique identifier of the integration that was installed on the bot"
|
|
2966
|
+
},
|
|
2967
|
+
"version": {
|
|
2968
|
+
"type": "string",
|
|
2969
|
+
"maxLength": 200,
|
|
2970
|
+
"description": "Unique identifier of the integration that was installed on the bot"
|
|
2971
|
+
},
|
|
2972
|
+
"configuration": {
|
|
2973
|
+
"type": "object",
|
|
2974
|
+
"properties": {
|
|
2975
|
+
"identifier": {
|
|
2976
|
+
"type": "object",
|
|
2977
|
+
"properties": {
|
|
2978
|
+
"linkTemplateScript": {
|
|
2979
|
+
"type": "string",
|
|
2980
|
+
"maxLength": 2000,
|
|
2981
|
+
"description": "Title describing the task"
|
|
2982
|
+
},
|
|
2983
|
+
"required": {
|
|
2984
|
+
"type": "boolean"
|
|
2985
|
+
}
|
|
2986
|
+
},
|
|
2987
|
+
"required": [
|
|
2988
|
+
"required"
|
|
2989
|
+
],
|
|
2990
|
+
"description": "Identifier configuration of the [Integration](#schema_integration)",
|
|
2991
|
+
"additionalProperties": false
|
|
2992
|
+
},
|
|
2993
|
+
"schema": {
|
|
2994
|
+
"type": "object",
|
|
2995
|
+
"additionalProperties": true,
|
|
2996
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
2997
|
+
}
|
|
2998
|
+
},
|
|
2999
|
+
"required": [
|
|
3000
|
+
"identifier"
|
|
3001
|
+
],
|
|
3002
|
+
"description": "Configuration definition",
|
|
3003
|
+
"additionalProperties": false
|
|
3004
|
+
},
|
|
3005
|
+
"channels": {
|
|
3006
|
+
"type": "object",
|
|
3007
|
+
"additionalProperties": {
|
|
3008
|
+
"type": "object",
|
|
3009
|
+
"properties": {
|
|
3010
|
+
"title": {
|
|
3011
|
+
"type": "string",
|
|
3012
|
+
"maxLength": 64,
|
|
3013
|
+
"description": "Title of the channel"
|
|
3014
|
+
},
|
|
3015
|
+
"description": {
|
|
3016
|
+
"type": "string",
|
|
3017
|
+
"maxLength": 256,
|
|
3018
|
+
"description": "Description of the channel"
|
|
3019
|
+
},
|
|
3020
|
+
"messages": {
|
|
3021
|
+
"type": "object",
|
|
3022
|
+
"additionalProperties": {
|
|
3023
|
+
"type": "object",
|
|
3024
|
+
"properties": {
|
|
3025
|
+
"schema": {
|
|
3026
|
+
"type": "object",
|
|
3027
|
+
"additionalProperties": true
|
|
3028
|
+
}
|
|
3029
|
+
},
|
|
3030
|
+
"required": [
|
|
3031
|
+
"schema"
|
|
3032
|
+
],
|
|
3033
|
+
"description": "Message definition",
|
|
3034
|
+
"additionalProperties": false
|
|
3035
|
+
}
|
|
3036
|
+
},
|
|
3037
|
+
"conversation": {
|
|
3038
|
+
"type": "object",
|
|
3039
|
+
"properties": {
|
|
3040
|
+
"tags": {
|
|
3041
|
+
"type": "object",
|
|
3042
|
+
"additionalProperties": {
|
|
3043
|
+
"type": "object",
|
|
3044
|
+
"properties": {
|
|
3045
|
+
"title": {
|
|
3046
|
+
"type": "string",
|
|
3047
|
+
"maxLength": 64,
|
|
3048
|
+
"description": "Title of the tag"
|
|
3049
|
+
},
|
|
3050
|
+
"description": {
|
|
3051
|
+
"type": "string",
|
|
3052
|
+
"maxLength": 256,
|
|
3053
|
+
"description": "Description of the tag"
|
|
3054
|
+
}
|
|
3055
|
+
},
|
|
3056
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
3057
|
+
"additionalProperties": false
|
|
3058
|
+
}
|
|
3059
|
+
},
|
|
3060
|
+
"creation": {
|
|
3061
|
+
"type": "object",
|
|
3062
|
+
"properties": {
|
|
3063
|
+
"enabled": {
|
|
3064
|
+
"type": "boolean",
|
|
3065
|
+
"description": "Enable conversation creation"
|
|
3066
|
+
},
|
|
3067
|
+
"requiredTags": {
|
|
3068
|
+
"type": "array",
|
|
3069
|
+
"items": {
|
|
3070
|
+
"type": "string"
|
|
3071
|
+
},
|
|
3072
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
|
|
3073
|
+
}
|
|
3074
|
+
},
|
|
3075
|
+
"required": [
|
|
3076
|
+
"enabled",
|
|
3077
|
+
"requiredTags"
|
|
3078
|
+
],
|
|
3079
|
+
"description": "The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.",
|
|
3080
|
+
"additionalProperties": false
|
|
3081
|
+
}
|
|
3082
|
+
},
|
|
3083
|
+
"required": [
|
|
3084
|
+
"tags",
|
|
3085
|
+
"creation"
|
|
3086
|
+
],
|
|
3087
|
+
"description": "Conversation object configuration",
|
|
3088
|
+
"additionalProperties": false
|
|
3089
|
+
},
|
|
3090
|
+
"message": {
|
|
3091
|
+
"type": "object",
|
|
3092
|
+
"properties": {
|
|
3093
|
+
"tags": {
|
|
3094
|
+
"type": "object",
|
|
3095
|
+
"additionalProperties": {
|
|
3096
|
+
"type": "object",
|
|
3097
|
+
"properties": {
|
|
3098
|
+
"title": {
|
|
3099
|
+
"type": "string",
|
|
3100
|
+
"maxLength": 64,
|
|
3101
|
+
"description": "Title of the tag"
|
|
3102
|
+
},
|
|
3103
|
+
"description": {
|
|
3104
|
+
"type": "string",
|
|
3105
|
+
"maxLength": 256,
|
|
3106
|
+
"description": "Description of the tag"
|
|
3107
|
+
}
|
|
3108
|
+
},
|
|
3109
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
3110
|
+
"additionalProperties": false
|
|
3111
|
+
}
|
|
3112
|
+
}
|
|
3113
|
+
},
|
|
3114
|
+
"required": [
|
|
3115
|
+
"tags"
|
|
3116
|
+
],
|
|
3117
|
+
"description": "Message object configuration",
|
|
3118
|
+
"additionalProperties": false
|
|
3119
|
+
}
|
|
3120
|
+
},
|
|
3121
|
+
"required": [
|
|
3122
|
+
"messages",
|
|
3123
|
+
"conversation",
|
|
3124
|
+
"message"
|
|
3125
|
+
],
|
|
3126
|
+
"description": "Channel definition",
|
|
3127
|
+
"additionalProperties": false
|
|
3128
|
+
}
|
|
3129
|
+
},
|
|
3130
|
+
"states": {
|
|
3131
|
+
"type": "object",
|
|
3132
|
+
"additionalProperties": {
|
|
3133
|
+
"type": "object",
|
|
3134
|
+
"properties": {
|
|
3135
|
+
"type": {
|
|
3136
|
+
"type": "string",
|
|
3137
|
+
"enum": [
|
|
3138
|
+
"conversation",
|
|
3139
|
+
"user",
|
|
3140
|
+
"integration"
|
|
3141
|
+
],
|
|
3142
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
|
|
3143
|
+
},
|
|
3144
|
+
"schema": {
|
|
3145
|
+
"type": "object",
|
|
3146
|
+
"additionalProperties": true,
|
|
3147
|
+
"description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
|
|
3148
|
+
}
|
|
3149
|
+
},
|
|
3150
|
+
"required": [
|
|
3151
|
+
"type",
|
|
3152
|
+
"schema"
|
|
3153
|
+
],
|
|
3154
|
+
"description": "State definition",
|
|
3155
|
+
"additionalProperties": false
|
|
3156
|
+
}
|
|
3157
|
+
},
|
|
3158
|
+
"events": {
|
|
3159
|
+
"type": "object",
|
|
3160
|
+
"additionalProperties": {
|
|
3161
|
+
"type": "object",
|
|
3162
|
+
"properties": {
|
|
3163
|
+
"title": {
|
|
3164
|
+
"type": "string",
|
|
3165
|
+
"maxLength": 64,
|
|
3166
|
+
"description": "Title of the event"
|
|
3167
|
+
},
|
|
3168
|
+
"description": {
|
|
3169
|
+
"type": "string",
|
|
3170
|
+
"maxLength": 256,
|
|
3171
|
+
"description": "Description of the event"
|
|
3172
|
+
},
|
|
3173
|
+
"schema": {
|
|
3174
|
+
"type": "object",
|
|
3175
|
+
"additionalProperties": true
|
|
3176
|
+
}
|
|
3177
|
+
},
|
|
3178
|
+
"required": [
|
|
3179
|
+
"schema"
|
|
3180
|
+
],
|
|
3181
|
+
"description": "Event Definition",
|
|
3182
|
+
"additionalProperties": false
|
|
3183
|
+
}
|
|
3184
|
+
},
|
|
3185
|
+
"actions": {
|
|
3186
|
+
"type": "object",
|
|
3187
|
+
"additionalProperties": {
|
|
3188
|
+
"type": "object",
|
|
3189
|
+
"properties": {
|
|
3190
|
+
"title": {
|
|
3191
|
+
"type": "string",
|
|
3192
|
+
"maxLength": 64,
|
|
3193
|
+
"description": "Title of the action"
|
|
3194
|
+
},
|
|
3195
|
+
"description": {
|
|
3196
|
+
"type": "string",
|
|
3197
|
+
"maxLength": 256,
|
|
3198
|
+
"description": "Description of the action"
|
|
3199
|
+
},
|
|
3200
|
+
"input": {
|
|
3201
|
+
"type": "object",
|
|
3202
|
+
"properties": {
|
|
3203
|
+
"schema": {
|
|
3204
|
+
"type": "object",
|
|
3205
|
+
"additionalProperties": true
|
|
3206
|
+
}
|
|
3207
|
+
},
|
|
3208
|
+
"required": [
|
|
3209
|
+
"schema"
|
|
3210
|
+
],
|
|
3211
|
+
"additionalProperties": false
|
|
3212
|
+
},
|
|
3213
|
+
"output": {
|
|
3214
|
+
"type": "object",
|
|
3215
|
+
"properties": {
|
|
3216
|
+
"schema": {
|
|
3217
|
+
"type": "object",
|
|
3218
|
+
"additionalProperties": true
|
|
3219
|
+
}
|
|
3220
|
+
},
|
|
3221
|
+
"required": [
|
|
3222
|
+
"schema"
|
|
3223
|
+
],
|
|
3224
|
+
"additionalProperties": false
|
|
3225
|
+
}
|
|
3226
|
+
},
|
|
3227
|
+
"required": [
|
|
3228
|
+
"input",
|
|
3229
|
+
"output"
|
|
3230
|
+
],
|
|
3231
|
+
"description": "Action definition",
|
|
3232
|
+
"additionalProperties": false
|
|
3233
|
+
}
|
|
3234
|
+
},
|
|
3235
|
+
"user": {
|
|
3236
|
+
"type": "object",
|
|
3237
|
+
"properties": {
|
|
3238
|
+
"tags": {
|
|
3239
|
+
"type": "object",
|
|
3240
|
+
"additionalProperties": {
|
|
3241
|
+
"type": "object",
|
|
3242
|
+
"properties": {
|
|
3243
|
+
"title": {
|
|
3244
|
+
"type": "string",
|
|
3245
|
+
"maxLength": 64,
|
|
3246
|
+
"description": "Title of the tag"
|
|
3247
|
+
},
|
|
3248
|
+
"description": {
|
|
3249
|
+
"type": "string",
|
|
3250
|
+
"maxLength": 256,
|
|
3251
|
+
"description": "Description of the tag"
|
|
3252
|
+
}
|
|
3253
|
+
},
|
|
3254
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
3255
|
+
"additionalProperties": false
|
|
3256
|
+
}
|
|
3257
|
+
},
|
|
3258
|
+
"creation": {
|
|
3259
|
+
"type": "object",
|
|
3260
|
+
"properties": {
|
|
3261
|
+
"enabled": {
|
|
3262
|
+
"type": "boolean",
|
|
3263
|
+
"description": "Enable user creation"
|
|
3264
|
+
},
|
|
3265
|
+
"requiredTags": {
|
|
3266
|
+
"type": "array",
|
|
3267
|
+
"items": {
|
|
3268
|
+
"type": "string"
|
|
3269
|
+
},
|
|
3270
|
+
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
3271
|
+
}
|
|
3272
|
+
},
|
|
3273
|
+
"required": [
|
|
3274
|
+
"enabled",
|
|
3275
|
+
"requiredTags"
|
|
3276
|
+
],
|
|
3277
|
+
"description": "The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.",
|
|
3278
|
+
"additionalProperties": false
|
|
3279
|
+
}
|
|
3280
|
+
},
|
|
3281
|
+
"required": [
|
|
3282
|
+
"tags",
|
|
3283
|
+
"creation"
|
|
3284
|
+
],
|
|
3285
|
+
"description": "User object configuration",
|
|
3286
|
+
"additionalProperties": false
|
|
3287
|
+
},
|
|
3288
|
+
"entities": {
|
|
3289
|
+
"type": "object",
|
|
3290
|
+
"additionalProperties": {
|
|
3291
|
+
"type": "object",
|
|
3292
|
+
"properties": {
|
|
3293
|
+
"title": {
|
|
3294
|
+
"type": "string",
|
|
3295
|
+
"maxLength": 64,
|
|
3296
|
+
"description": "Title of the entity"
|
|
3297
|
+
},
|
|
3298
|
+
"description": {
|
|
3299
|
+
"type": "string",
|
|
3300
|
+
"maxLength": 256,
|
|
3301
|
+
"description": "Description of the entity"
|
|
3302
|
+
},
|
|
3303
|
+
"schema": {
|
|
3304
|
+
"type": "object",
|
|
3305
|
+
"additionalProperties": true
|
|
3306
|
+
}
|
|
3307
|
+
},
|
|
3308
|
+
"required": [
|
|
3309
|
+
"schema"
|
|
3310
|
+
],
|
|
3311
|
+
"description": "Entity definition",
|
|
3312
|
+
"additionalProperties": false
|
|
2352
3313
|
}
|
|
2353
3314
|
},
|
|
2354
|
-
"
|
|
2355
|
-
"
|
|
2356
|
-
"
|
|
2357
|
-
|
|
2358
|
-
|
|
2359
|
-
"updatedAt",
|
|
2360
|
-
"title",
|
|
2361
|
-
"description",
|
|
2362
|
-
"iconUrl"
|
|
2363
|
-
]
|
|
2364
|
-
}
|
|
2365
|
-
},
|
|
2366
|
-
"meta": {
|
|
2367
|
-
"type": "object",
|
|
2368
|
-
"properties": {
|
|
2369
|
-
"nextToken": {
|
|
3315
|
+
"dev": {
|
|
3316
|
+
"type": "boolean",
|
|
3317
|
+
"description": "Indicates if the integration is a development integration; Dev integrations run locally"
|
|
3318
|
+
},
|
|
3319
|
+
"title": {
|
|
2370
3320
|
"type": "string",
|
|
2371
|
-
"
|
|
3321
|
+
"minLength": 1,
|
|
3322
|
+
"maxLength": 64,
|
|
3323
|
+
"description": "Title of the integration. This is the name that will be displayed in the UI"
|
|
3324
|
+
},
|
|
3325
|
+
"description": {
|
|
3326
|
+
"type": "string",
|
|
3327
|
+
"maxLength": 256,
|
|
3328
|
+
"description": "Description of the integration. This is the description that will be displayed in the UI"
|
|
3329
|
+
},
|
|
3330
|
+
"iconUrl": {
|
|
3331
|
+
"type": "string",
|
|
3332
|
+
"description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
|
|
3333
|
+
},
|
|
3334
|
+
"readmeUrl": {
|
|
3335
|
+
"type": "string",
|
|
3336
|
+
"description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
|
|
3337
|
+
},
|
|
3338
|
+
"secrets": {
|
|
3339
|
+
"type": "array",
|
|
3340
|
+
"items": {
|
|
3341
|
+
"type": "string"
|
|
3342
|
+
},
|
|
3343
|
+
"description": "Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing."
|
|
3344
|
+
},
|
|
3345
|
+
"ownerWorkspace": {
|
|
3346
|
+
"type": "object",
|
|
3347
|
+
"properties": {
|
|
3348
|
+
"id": {
|
|
3349
|
+
"type": "string"
|
|
3350
|
+
},
|
|
3351
|
+
"handle": {
|
|
3352
|
+
"type": "string",
|
|
3353
|
+
"nullable": true
|
|
3354
|
+
},
|
|
3355
|
+
"name": {
|
|
3356
|
+
"type": "string"
|
|
3357
|
+
}
|
|
3358
|
+
},
|
|
3359
|
+
"required": [
|
|
3360
|
+
"id",
|
|
3361
|
+
"handle",
|
|
3362
|
+
"name"
|
|
3363
|
+
],
|
|
3364
|
+
"additionalProperties": false
|
|
2372
3365
|
}
|
|
2373
3366
|
},
|
|
3367
|
+
"required": [
|
|
3368
|
+
"id",
|
|
3369
|
+
"createdAt",
|
|
3370
|
+
"updatedAt",
|
|
3371
|
+
"identifier",
|
|
3372
|
+
"name",
|
|
3373
|
+
"version",
|
|
3374
|
+
"configuration",
|
|
3375
|
+
"channels",
|
|
3376
|
+
"states",
|
|
3377
|
+
"events",
|
|
3378
|
+
"actions",
|
|
3379
|
+
"user",
|
|
3380
|
+
"entities",
|
|
3381
|
+
"dev",
|
|
3382
|
+
"title",
|
|
3383
|
+
"description",
|
|
3384
|
+
"iconUrl",
|
|
3385
|
+
"readmeUrl",
|
|
3386
|
+
"secrets",
|
|
3387
|
+
"ownerWorkspace"
|
|
3388
|
+
],
|
|
2374
3389
|
"additionalProperties": false
|
|
2375
3390
|
}
|
|
2376
3391
|
},
|
|
2377
|
-
"required": [
|
|
2378
|
-
"integrations",
|
|
2379
|
-
"meta"
|
|
2380
|
-
],
|
|
2381
|
-
"title": "listPublicIntegrationsResponse",
|
|
2382
|
-
"additionalProperties": false
|
|
2383
|
-
}
|
|
2384
|
-
}
|
|
2385
|
-
},
|
|
2386
|
-
"getPublicIntegrationById": {
|
|
2387
|
-
"name": "getPublicIntegrationById",
|
|
2388
|
-
"description": "Get public integration by Id",
|
|
2389
|
-
"method": "get",
|
|
2390
|
-
"section": "hub",
|
|
2391
|
-
"path": "/v1/admin/hub/integrations/{id}",
|
|
2392
|
-
"disableDefaultParameters": {
|
|
2393
|
-
"x-workspace-id": true
|
|
2394
|
-
},
|
|
2395
|
-
"parameters": {
|
|
2396
|
-
"id": {
|
|
2397
|
-
"type": "string",
|
|
2398
|
-
"description": "Integration ID",
|
|
2399
|
-
"in": "path"
|
|
2400
|
-
}
|
|
2401
|
-
},
|
|
2402
|
-
"response": {
|
|
2403
|
-
"description": "Success",
|
|
2404
|
-
"schema": {
|
|
2405
|
-
"type": "object",
|
|
2406
|
-
"properties": {
|
|
2407
|
-
"integration": {
|
|
2408
|
-
"$ref": "#/components/schemas/Integration"
|
|
2409
|
-
}
|
|
2410
|
-
},
|
|
2411
|
-
"required": [
|
|
2412
|
-
"integration"
|
|
2413
|
-
],
|
|
2414
|
-
"title": "getPublicIntegrationByIdResponse",
|
|
2415
|
-
"additionalProperties": false
|
|
2416
|
-
}
|
|
2417
|
-
}
|
|
2418
|
-
},
|
|
2419
|
-
"getPublicIntegration": {
|
|
2420
|
-
"name": "getPublicIntegration",
|
|
2421
|
-
"description": "Get public integration by name and version",
|
|
2422
|
-
"method": "get",
|
|
2423
|
-
"section": "hub",
|
|
2424
|
-
"path": "/v1/admin/hub/integrations/{name}/{version}",
|
|
2425
|
-
"disableDefaultParameters": {
|
|
2426
|
-
"x-workspace-id": true
|
|
2427
|
-
},
|
|
2428
|
-
"parameters": {
|
|
2429
|
-
"name": {
|
|
2430
|
-
"type": "string",
|
|
2431
|
-
"description": "Integration Name",
|
|
2432
|
-
"in": "path"
|
|
2433
|
-
},
|
|
2434
|
-
"version": {
|
|
2435
|
-
"type": "string",
|
|
2436
|
-
"description": "Integration version. Either a semver version or tag \"latest\"",
|
|
2437
|
-
"in": "path"
|
|
2438
|
-
}
|
|
2439
|
-
},
|
|
2440
|
-
"response": {
|
|
2441
|
-
"description": "Success",
|
|
2442
|
-
"schema": {
|
|
2443
|
-
"type": "object",
|
|
2444
|
-
"properties": {
|
|
2445
|
-
"integration": {
|
|
2446
|
-
"$ref": "#/components/schemas/Integration"
|
|
2447
|
-
}
|
|
2448
|
-
},
|
|
2449
3392
|
"required": [
|
|
2450
3393
|
"integration"
|
|
2451
3394
|
],
|
|
@@ -7137,6 +8080,11 @@ export const state = {
|
|
|
7137
8080
|
"description": "File access policies",
|
|
7138
8081
|
"in": "header"
|
|
7139
8082
|
},
|
|
8083
|
+
"x-index": {
|
|
8084
|
+
"type": "string",
|
|
8085
|
+
"description": "Set to a value of \"true\" to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.",
|
|
8086
|
+
"in": "header"
|
|
8087
|
+
},
|
|
7140
8088
|
"Content-Type": {
|
|
7141
8089
|
"type": "string",
|
|
7142
8090
|
"description": "File content type",
|
|
@@ -7214,6 +8162,18 @@ export const state = {
|
|
|
7214
8162
|
"items": {
|
|
7215
8163
|
"type": "string"
|
|
7216
8164
|
}
|
|
8165
|
+
},
|
|
8166
|
+
"indexingStatus": {
|
|
8167
|
+
"type": "string",
|
|
8168
|
+
"enum": [
|
|
8169
|
+
"PENDING",
|
|
8170
|
+
"IN_PROGRESS",
|
|
8171
|
+
"COMPLETE",
|
|
8172
|
+
"FAILED"
|
|
8173
|
+
]
|
|
8174
|
+
},
|
|
8175
|
+
"indexingFailureReason": {
|
|
8176
|
+
"type": "string"
|
|
7217
8177
|
}
|
|
7218
8178
|
},
|
|
7219
8179
|
"required": [
|
|
@@ -7325,8 +8285,8 @@ export const state = {
|
|
|
7325
8285
|
"in": "path"
|
|
7326
8286
|
},
|
|
7327
8287
|
"tags": {
|
|
7328
|
-
"in": "query",
|
|
7329
8288
|
"type": "string",
|
|
8289
|
+
"in": "query",
|
|
7330
8290
|
"description": "Tags to filter files by as a JSON string representing an object of key-value pairs to match files' tags against."
|
|
7331
8291
|
}
|
|
7332
8292
|
},
|
|
@@ -7364,6 +8324,18 @@ export const state = {
|
|
|
7364
8324
|
"items": {
|
|
7365
8325
|
"type": "string"
|
|
7366
8326
|
}
|
|
8327
|
+
},
|
|
8328
|
+
"indexingStatus": {
|
|
8329
|
+
"type": "string",
|
|
8330
|
+
"enum": [
|
|
8331
|
+
"PENDING",
|
|
8332
|
+
"IN_PROGRESS",
|
|
8333
|
+
"COMPLETE",
|
|
8334
|
+
"FAILED"
|
|
8335
|
+
]
|
|
8336
|
+
},
|
|
8337
|
+
"indexingFailureReason": {
|
|
8338
|
+
"type": "string"
|
|
7367
8339
|
}
|
|
7368
8340
|
},
|
|
7369
8341
|
"required": [
|
|
@@ -7474,6 +8446,18 @@ export const state = {
|
|
|
7474
8446
|
"items": {
|
|
7475
8447
|
"type": "string"
|
|
7476
8448
|
}
|
|
8449
|
+
},
|
|
8450
|
+
"indexingStatus": {
|
|
8451
|
+
"type": "string",
|
|
8452
|
+
"enum": [
|
|
8453
|
+
"PENDING",
|
|
8454
|
+
"IN_PROGRESS",
|
|
8455
|
+
"COMPLETE",
|
|
8456
|
+
"FAILED"
|
|
8457
|
+
]
|
|
8458
|
+
},
|
|
8459
|
+
"indexingFailureReason": {
|
|
8460
|
+
"type": "string"
|
|
7477
8461
|
}
|
|
7478
8462
|
},
|
|
7479
8463
|
"required": [
|
|
@@ -7632,6 +8616,104 @@ export const state = {
|
|
|
7632
8616
|
}
|
|
7633
8617
|
}
|
|
7634
8618
|
},
|
|
8619
|
+
"searchFiles": {
|
|
8620
|
+
"name": "searchFiles",
|
|
8621
|
+
"path": "/v1/files/bot/{botId}/search",
|
|
8622
|
+
"description": "Search files",
|
|
8623
|
+
"method": "get",
|
|
8624
|
+
"section": "files",
|
|
8625
|
+
"parameters": {
|
|
8626
|
+
"x-bot-id": {
|
|
8627
|
+
"in": "header",
|
|
8628
|
+
"description": "Bot id",
|
|
8629
|
+
"type": "string",
|
|
8630
|
+
"required": true
|
|
8631
|
+
},
|
|
8632
|
+
"x-integration-id": {
|
|
8633
|
+
"in": "header",
|
|
8634
|
+
"description": "Integration id",
|
|
8635
|
+
"type": "string",
|
|
8636
|
+
"required": false
|
|
8637
|
+
},
|
|
8638
|
+
"x-user-id": {
|
|
8639
|
+
"in": "header",
|
|
8640
|
+
"description": "User id",
|
|
8641
|
+
"type": "string",
|
|
8642
|
+
"required": false
|
|
8643
|
+
},
|
|
8644
|
+
"x-user-role": {
|
|
8645
|
+
"in": "header",
|
|
8646
|
+
"description": "User role",
|
|
8647
|
+
"type": "string",
|
|
8648
|
+
"required": false
|
|
8649
|
+
},
|
|
8650
|
+
"botId": {
|
|
8651
|
+
"type": "string",
|
|
8652
|
+
"description": "Bot ID",
|
|
8653
|
+
"in": "path"
|
|
8654
|
+
},
|
|
8655
|
+
"tags": {
|
|
8656
|
+
"type": "string",
|
|
8657
|
+
"in": "query",
|
|
8658
|
+
"description": "Tags to filter files by as a JSON string representing an object of key-value pairs to match files' tags against."
|
|
8659
|
+
},
|
|
8660
|
+
"query": {
|
|
8661
|
+
"in": "query",
|
|
8662
|
+
"type": "string",
|
|
8663
|
+
"description": "Query expressed in natural language to retrieve matching text passages within all files using semantical search.",
|
|
8664
|
+
"required": true
|
|
8665
|
+
},
|
|
8666
|
+
"limit": {
|
|
8667
|
+
"in": "query",
|
|
8668
|
+
"type": "string",
|
|
8669
|
+
"description": "The maximum number of passages to return."
|
|
8670
|
+
}
|
|
8671
|
+
},
|
|
8672
|
+
"response": {
|
|
8673
|
+
"description": "Returns the passages matching the query.",
|
|
8674
|
+
"schema": {
|
|
8675
|
+
"type": "object",
|
|
8676
|
+
"properties": {
|
|
8677
|
+
"passages": {
|
|
8678
|
+
"type": "array",
|
|
8679
|
+
"items": {
|
|
8680
|
+
"type": "object",
|
|
8681
|
+
"properties": {
|
|
8682
|
+
"fileId": {
|
|
8683
|
+
"type": "string"
|
|
8684
|
+
},
|
|
8685
|
+
"score": {
|
|
8686
|
+
"type": "number"
|
|
8687
|
+
},
|
|
8688
|
+
"content": {
|
|
8689
|
+
"type": "string"
|
|
8690
|
+
},
|
|
8691
|
+
"tags": {
|
|
8692
|
+
"type": "object",
|
|
8693
|
+
"additionalProperties": {
|
|
8694
|
+
"type": "string",
|
|
8695
|
+
"maxLength": 1000
|
|
8696
|
+
},
|
|
8697
|
+
"description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
|
|
8698
|
+
}
|
|
8699
|
+
},
|
|
8700
|
+
"required": [
|
|
8701
|
+
"fileId",
|
|
8702
|
+
"score",
|
|
8703
|
+
"content",
|
|
8704
|
+
"tags"
|
|
8705
|
+
]
|
|
8706
|
+
}
|
|
8707
|
+
}
|
|
8708
|
+
},
|
|
8709
|
+
"required": [
|
|
8710
|
+
"passages"
|
|
8711
|
+
],
|
|
8712
|
+
"title": "searchFilesResponse",
|
|
8713
|
+
"additionalProperties": false
|
|
8714
|
+
}
|
|
8715
|
+
}
|
|
8716
|
+
},
|
|
7635
8717
|
"listTables": {
|
|
7636
8718
|
"name": "listTables",
|
|
7637
8719
|
"path": "/v1/tables",
|
|
@@ -8340,7 +9422,7 @@ export const state = {
|
|
|
8340
9422
|
"title": "Botpress API",
|
|
8341
9423
|
"description": "API for Botpress Cloud",
|
|
8342
9424
|
"server": "https://api.botpress.cloud",
|
|
8343
|
-
"version": "0.19.
|
|
9425
|
+
"version": "0.19.2",
|
|
8344
9426
|
"prefix": "v1"
|
|
8345
9427
|
},
|
|
8346
9428
|
"errors": [
|
|
@@ -8607,6 +9689,7 @@ export const state = {
|
|
|
8607
9689
|
"getFileMetadataResponse": true,
|
|
8608
9690
|
"getFileContentResponse": true,
|
|
8609
9691
|
"updateFileMetadataResponse": true,
|
|
9692
|
+
"searchFilesResponse": true,
|
|
8610
9693
|
"listTablesResponse": true,
|
|
8611
9694
|
"getTableResponse": true,
|
|
8612
9695
|
"createTableResponse": true,
|
|
@@ -10658,6 +11741,18 @@ export const state = {
|
|
|
10658
11741
|
"items": {
|
|
10659
11742
|
"type": "string"
|
|
10660
11743
|
}
|
|
11744
|
+
},
|
|
11745
|
+
"indexingStatus": {
|
|
11746
|
+
"type": "string",
|
|
11747
|
+
"enum": [
|
|
11748
|
+
"PENDING",
|
|
11749
|
+
"IN_PROGRESS",
|
|
11750
|
+
"COMPLETE",
|
|
11751
|
+
"FAILED"
|
|
11752
|
+
]
|
|
11753
|
+
},
|
|
11754
|
+
"indexingFailureReason": {
|
|
11755
|
+
"type": "string"
|
|
10661
11756
|
}
|
|
10662
11757
|
},
|
|
10663
11758
|
"required": [
|
|
@@ -10934,7 +12029,8 @@ export const state = {
|
|
|
10934
12029
|
"listFiles",
|
|
10935
12030
|
"getFileMetadata",
|
|
10936
12031
|
"getFileContent",
|
|
10937
|
-
"updateFileMetadata"
|
|
12032
|
+
"updateFileMetadata",
|
|
12033
|
+
"searchFiles"
|
|
10938
12034
|
],
|
|
10939
12035
|
"schema": "File"
|
|
10940
12036
|
}
|