@botpress/api 0.60.0 → 0.62.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
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /* prettier-ignore */
4
4
  import * as opapi from '@bpinternal/opapi'
5
- export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'bot' | 'integration' | 'interface' | 'plugin' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>
5
+ export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'tag' | 'bot' | 'integration' | 'interface' | 'plugin' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>
6
6
  export const state = {
7
7
  "operations": {
8
8
  "createConversation": {
@@ -1725,11 +1725,22 @@ export const state = {
1725
1725
  "type": "string",
1726
1726
  "maxLength": 200,
1727
1727
  "description": "Unique identifier of the integration that was installed on the bot"
1728
+ },
1729
+ "scheduleRegisterCall": {
1730
+ "type": "string",
1731
+ "enum": [
1732
+ "hourly",
1733
+ "daily",
1734
+ "weekly",
1735
+ "bi-weekly",
1736
+ "monthly",
1737
+ "bi-monthly",
1738
+ "quarterly",
1739
+ "yearly"
1740
+ ],
1741
+ "description": "Recurring schedule on which `register()` will be called on the integration"
1728
1742
  }
1729
1743
  },
1730
- "required": [
1731
- "identifier"
1732
- ],
1733
1744
  "title": "configureIntegrationBody",
1734
1745
  "additionalProperties": false
1735
1746
  }
@@ -2442,6 +2453,74 @@ export const state = {
2442
2453
  },
2443
2454
  "parameters": {}
2444
2455
  },
2456
+ "listTagValues": {
2457
+ "name": "listTagValues",
2458
+ "description": "Get a bot tag values",
2459
+ "method": "get",
2460
+ "path": "/v1/chat/tags/{key}/values",
2461
+ "section": "tag",
2462
+ "parameters": {
2463
+ "nextToken": {
2464
+ "in": "query",
2465
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
2466
+ "type": "string"
2467
+ },
2468
+ "key": {
2469
+ "in": "path",
2470
+ "type": "string",
2471
+ "description": "Tag key"
2472
+ },
2473
+ "type": {
2474
+ "in": "query",
2475
+ "type": "string",
2476
+ "description": "Tag type",
2477
+ "required": true,
2478
+ "enum": [
2479
+ "user",
2480
+ "conversation",
2481
+ "message"
2482
+ ]
2483
+ }
2484
+ },
2485
+ "response": {
2486
+ "description": "Empty response",
2487
+ "schema": {
2488
+ "type": "object",
2489
+ "properties": {
2490
+ "tags": {
2491
+ "type": "array",
2492
+ "items": {
2493
+ "type": "object",
2494
+ "properties": {
2495
+ "value": {
2496
+ "type": "string"
2497
+ }
2498
+ },
2499
+ "required": [
2500
+ "value"
2501
+ ]
2502
+ }
2503
+ },
2504
+ "meta": {
2505
+ "type": "object",
2506
+ "properties": {
2507
+ "nextToken": {
2508
+ "type": "string",
2509
+ "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."
2510
+ }
2511
+ },
2512
+ "additionalProperties": false
2513
+ }
2514
+ },
2515
+ "required": [
2516
+ "tags",
2517
+ "meta"
2518
+ ],
2519
+ "title": "listTagValuesResponse",
2520
+ "additionalProperties": false
2521
+ }
2522
+ }
2523
+ },
2445
2524
  "trackAnalytics": {
2446
2525
  "name": "trackAnalytics",
2447
2526
  "description": "Add an event to the analytics",
@@ -13555,7 +13634,7 @@ export const state = {
13555
13634
  "title": "Botpress API",
13556
13635
  "description": "API for Botpress Cloud",
13557
13636
  "server": "https://api.botpress.cloud",
13558
- "version": "0.60.0",
13637
+ "version": "0.62.0",
13559
13638
  "prefix": "v1"
13560
13639
  },
13561
13640
  "errors": [
@@ -13789,6 +13868,7 @@ export const state = {
13789
13868
  "deleteWorkflowResponse": true,
13790
13869
  "listWorkflowsResponse": true,
13791
13870
  "getOrCreateWorkflowResponse": true,
13871
+ "listTagValuesResponse": true,
13792
13872
  "trackAnalyticsResponse": true,
13793
13873
  "runVrlResponse": true,
13794
13874
  "getAccountResponse": true,
@@ -17183,6 +17263,14 @@ export const state = {
17183
17263
  ],
17184
17264
  "schema": "Workflow"
17185
17265
  },
17266
+ {
17267
+ "description": "",
17268
+ "title": "Tag",
17269
+ "name": "tag",
17270
+ "operations": [
17271
+ "listTagValues"
17272
+ ]
17273
+ },
17186
17274
  {
17187
17275
  "title": "Bot",
17188
17276
  "description": "",