@botpress/api 0.9.0 → 0.10.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
@@ -1530,7 +1530,7 @@ export const state = {
1530
1530
  parameters: {
1531
1531
  id: {
1532
1532
  type: "string",
1533
- description: "Integration Id",
1533
+ description: "Integration ID",
1534
1534
  in: "path",
1535
1535
  },
1536
1536
  },
@@ -2447,6 +2447,180 @@ export const state = {
2447
2447
  },
2448
2448
  },
2449
2449
  },
2450
+ listBotIssues: {
2451
+ name: "listBotIssues",
2452
+ description: "List Bot Issues",
2453
+ method: "get",
2454
+ path: "/v1/admin/bots/{id}/issues",
2455
+ section: "bot",
2456
+ parameters: {
2457
+ id: {
2458
+ type: "string",
2459
+ description: "Bot ID",
2460
+ in: "path",
2461
+ },
2462
+ nextToken: {
2463
+ in: "query",
2464
+ description:
2465
+ "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
2466
+ type: "string",
2467
+ },
2468
+ },
2469
+ response: {
2470
+ description: "Success",
2471
+ schema: {
2472
+ type: "object",
2473
+ properties: {
2474
+ issues: {
2475
+ type: "array",
2476
+ items: {
2477
+ type: "object",
2478
+ properties: {
2479
+ id: {
2480
+ type: "string",
2481
+ },
2482
+ code: {
2483
+ type: "string",
2484
+ },
2485
+ createdAt: {
2486
+ type: "string",
2487
+ format: "date-time",
2488
+ },
2489
+ lastSeenAt: {
2490
+ type: "string",
2491
+ format: "date-time",
2492
+ },
2493
+ title: {
2494
+ type: "string",
2495
+ },
2496
+ description: {
2497
+ type: "string",
2498
+ },
2499
+ groupedData: {
2500
+ type: "object",
2501
+ properties: {},
2502
+ },
2503
+ eventsCount: {
2504
+ type: "number",
2505
+ },
2506
+ category: {
2507
+ type: "string",
2508
+ enum: ["user_code", "limits", "configuration", "other"],
2509
+ },
2510
+ resolutionLink: {
2511
+ type: "string",
2512
+ nullable: true,
2513
+ },
2514
+ },
2515
+ required: [
2516
+ "id",
2517
+ "code",
2518
+ "createdAt",
2519
+ "lastSeenAt",
2520
+ "title",
2521
+ "description",
2522
+ "groupedData",
2523
+ "eventsCount",
2524
+ "category",
2525
+ "resolutionLink",
2526
+ ],
2527
+ },
2528
+ },
2529
+ meta: {
2530
+ type: "object",
2531
+ properties: {
2532
+ nextToken: {
2533
+ type: "string",
2534
+ description:
2535
+ "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.",
2536
+ },
2537
+ },
2538
+ additionalProperties: false,
2539
+ },
2540
+ },
2541
+ required: ["issues", "meta"],
2542
+ title: "listBotIssuesResponse",
2543
+ additionalProperties: false,
2544
+ },
2545
+ },
2546
+ },
2547
+ deleteBotIssue: {
2548
+ name: "deleteBotIssue",
2549
+ description: "Delete Bot Issue",
2550
+ method: "delete",
2551
+ path: "/v1/admin/bots/{id}/issues/{issueId}",
2552
+ section: "bot",
2553
+ parameters: {
2554
+ id: {
2555
+ type: "string",
2556
+ description: "Bot ID",
2557
+ in: "path",
2558
+ },
2559
+ issueId: {
2560
+ in: "path",
2561
+ description: "Issue ID",
2562
+ type: "string",
2563
+ },
2564
+ },
2565
+ response: {
2566
+ description: "Success",
2567
+ schema: {
2568
+ type: "object",
2569
+ title: "deleteBotIssueResponse",
2570
+ additionalProperties: false,
2571
+ },
2572
+ },
2573
+ },
2574
+ listBotIssueEvents: {
2575
+ name: "listBotIssueEvents",
2576
+ description: "List Events for a Bot Issue",
2577
+ method: "get",
2578
+ path: "/v1/admin/bots/{id}/issues/{issueId}/events",
2579
+ section: "bot",
2580
+ parameters: {
2581
+ id: {
2582
+ type: "string",
2583
+ description: "Bot ID",
2584
+ in: "path",
2585
+ },
2586
+ issueId: {
2587
+ in: "path",
2588
+ description: "Issue ID",
2589
+ type: "string",
2590
+ },
2591
+ },
2592
+ response: {
2593
+ description: "Success",
2594
+ schema: {
2595
+ type: "object",
2596
+ properties: {
2597
+ issueEvents: {
2598
+ type: "array",
2599
+ items: {
2600
+ type: "object",
2601
+ properties: {
2602
+ id: {
2603
+ type: "string",
2604
+ },
2605
+ createdAt: {
2606
+ type: "string",
2607
+ format: "date-time",
2608
+ },
2609
+ data: {
2610
+ type: "object",
2611
+ properties: {},
2612
+ },
2613
+ },
2614
+ required: ["id", "createdAt", "data"],
2615
+ },
2616
+ },
2617
+ },
2618
+ required: ["issueEvents"],
2619
+ title: "listBotIssueEventsResponse",
2620
+ additionalProperties: false,
2621
+ },
2622
+ },
2623
+ },
2450
2624
  createWorkspace: {
2451
2625
  name: "createWorkspace",
2452
2626
  description: "Create workspace",
@@ -3752,7 +3926,7 @@ export const state = {
3752
3926
  parameters: {
3753
3927
  id: {
3754
3928
  type: "string",
3755
- description: "Integration Id",
3929
+ description: "Integration ID",
3756
3930
  in: "path",
3757
3931
  },
3758
3932
  },
@@ -4202,7 +4376,7 @@ export const state = {
4202
4376
  parameters: {
4203
4377
  id: {
4204
4378
  type: "string",
4205
- description: "Integration Id",
4379
+ description: "Integration ID",
4206
4380
  in: "path",
4207
4381
  },
4208
4382
  },
@@ -4230,7 +4404,7 @@ export const state = {
4230
4404
  parameters: {
4231
4405
  id: {
4232
4406
  type: "string",
4233
- description: "Integration Id",
4407
+ description: "Integration ID",
4234
4408
  in: "path",
4235
4409
  },
4236
4410
  timeStart: {
@@ -4328,7 +4502,7 @@ export const state = {
4328
4502
  parameters: {
4329
4503
  id: {
4330
4504
  type: "string",
4331
- description: "Integration Id",
4505
+ description: "Integration ID",
4332
4506
  in: "path",
4333
4507
  },
4334
4508
  },
@@ -4660,7 +4834,7 @@ export const state = {
4660
4834
  title: "Botpress API",
4661
4835
  description: "API for Botpress Cloud",
4662
4836
  server: "https://api.botpress.cloud",
4663
- version: "0.9.0",
4837
+ version: "0.10.0",
4664
4838
  prefix: "v1",
4665
4839
  },
4666
4840
  errors: [
@@ -4853,6 +5027,9 @@ export const state = {
4853
5027
  getBotLogsResponse: true,
4854
5028
  getBotWebchatResponse: true,
4855
5029
  getBotAnalyticsResponse: true,
5030
+ listBotIssuesResponse: true,
5031
+ deleteBotIssueResponse: true,
5032
+ listBotIssueEventsResponse: true,
4856
5033
  createWorkspaceResponse: true,
4857
5034
  getWorkspaceResponse: true,
4858
5035
  listWorkspaceUsagesResponse: true,
@@ -4890,6 +5067,8 @@ export const state = {
4890
5067
  WorkspaceMember: true,
4891
5068
  Account: true,
4892
5069
  Usage: true,
5070
+ Issue: true,
5071
+ IssueEvent: true,
4893
5072
  User: true,
4894
5073
  Conversation: true,
4895
5074
  Event: true,
@@ -5757,6 +5936,83 @@ export const state = {
5757
5936
  additionalProperties: false,
5758
5937
  },
5759
5938
  },
5939
+ Issue: {
5940
+ section: "bot",
5941
+ schema: {
5942
+ type: "object",
5943
+ properties: {
5944
+ id: {
5945
+ type: "string",
5946
+ },
5947
+ code: {
5948
+ type: "string",
5949
+ },
5950
+ createdAt: {
5951
+ type: "string",
5952
+ format: "date-time",
5953
+ },
5954
+ lastSeenAt: {
5955
+ type: "string",
5956
+ format: "date-time",
5957
+ },
5958
+ title: {
5959
+ type: "string",
5960
+ },
5961
+ description: {
5962
+ type: "string",
5963
+ },
5964
+ groupedData: {
5965
+ type: "object",
5966
+ additionalProperties: false,
5967
+ },
5968
+ eventsCount: {
5969
+ type: "number",
5970
+ },
5971
+ category: {
5972
+ type: "string",
5973
+ enum: ["user_code", "limits", "configuration", "other"],
5974
+ },
5975
+ resolutionLink: {
5976
+ type: "string",
5977
+ nullable: true,
5978
+ },
5979
+ },
5980
+ required: [
5981
+ "id",
5982
+ "code",
5983
+ "createdAt",
5984
+ "lastSeenAt",
5985
+ "title",
5986
+ "description",
5987
+ "groupedData",
5988
+ "eventsCount",
5989
+ "category",
5990
+ "resolutionLink",
5991
+ ],
5992
+ additionalProperties: false,
5993
+ },
5994
+ },
5995
+ IssueEvent: {
5996
+ section: "bot",
5997
+ schema: {
5998
+ type: "object",
5999
+ properties: {
6000
+ id: {
6001
+ type: "string",
6002
+ },
6003
+ createdAt: {
6004
+ type: "string",
6005
+ format: "date-time",
6006
+ },
6007
+ data: {
6008
+ type: "object",
6009
+ additionalProperties: false,
6010
+ },
6011
+ },
6012
+ required: ["id", "createdAt", "data"],
6013
+ additionalProperties: false,
6014
+ },
6015
+ },
5760
6016
  User: {
5761
6017
  section: "user",
5762
6018
  schema: {
@@ -6149,6 +6405,9 @@ export const state = {
6149
6405
  "getBotLogs",
6150
6406
  "getBotWebchat",
6151
6407
  "getBotAnalytics",
6408
+ "listBotIssues",
6409
+ "deleteBotIssue",
6410
+ "listBotIssueEvents",
6152
6411
  ],
6153
6412
  schema: "Bot",
6154
6413
  },
@@ -6227,6 +6486,8 @@ export const state = {
6227
6486
  | "WorkspaceMember"
6228
6487
  | "Account"
6229
6488
  | "Usage"
6489
+ | "Issue"
6490
+ | "IssueEvent"
6230
6491
  | "User"
6231
6492
  | "Conversation"
6232
6493
  | "Event"