@botpress/api 1.47.0 → 1.48.1

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.
@@ -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' | 'tag' | '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', never, 'bot' | 'integration' | 'interface' | 'plugin' | 'hub' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity'>
6
6
  export const state = {
7
7
  "operations": {
8
8
  "runVrl": {
@@ -14060,10 +14060,10 @@ export const state = {
14060
14060
  }
14061
14061
  },
14062
14062
  "metadata": {
14063
- "title": "Botpress API",
14064
- "description": "API for Botpress Cloud",
14063
+ "title": "Botpress Admin API",
14064
+ "description": "API for Botpress Cloud Manager",
14065
14065
  "server": "https://api.botpress.cloud",
14066
- "version": "1.47.0",
14066
+ "version": "1.48.1",
14067
14067
  "prefix": "v1"
14068
14068
  },
14069
14069
  "errors": [
@@ -14142,6 +14142,11 @@ export const state = {
14142
14142
  "type": "ResourceLockedConflict",
14143
14143
  "description": "The resource is current locked and cannot be operated on until the lock is released."
14144
14144
  },
14145
+ {
14146
+ "status": 410,
14147
+ "type": "ResourceGone",
14148
+ "description": "The requested resource is no longer available."
14149
+ },
14145
14150
  {
14146
14151
  "status": 400,
14147
14152
  "type": "ReferenceNotFound",
@@ -14347,18 +14352,7 @@ export const state = {
14347
14352
  "Issue": true,
14348
14353
  "IssueEvent": true,
14349
14354
  "Activity": true,
14350
- "Version": true,
14351
- "User": true,
14352
- "Conversation": true,
14353
- "Event": true,
14354
- "Message": true,
14355
- "State": true,
14356
- "Task": true,
14357
- "Workflow": true,
14358
- "Table": true,
14359
- "Column": true,
14360
- "Row": true,
14361
- "File": true
14355
+ "Version": true
14362
14356
  }
14363
14357
  },
14364
14358
  "schemas": {
@@ -16800,1161 +16794,96 @@ export const state = {
16800
16794
  ],
16801
16795
  "additionalProperties": false
16802
16796
  }
16797
+ }
16798
+ },
16799
+ "sections": [
16800
+ {
16801
+ "title": "Bot",
16802
+ "description": "",
16803
+ "name": "bot",
16804
+ "operations": [
16805
+ "createBot",
16806
+ "updateBot",
16807
+ "transferBot",
16808
+ "listBots",
16809
+ "getBot",
16810
+ "deleteBot",
16811
+ "getBotLogs",
16812
+ "getBotWebchat",
16813
+ "getBotAnalytics",
16814
+ "listActionRuns",
16815
+ "getBotIssue",
16816
+ "listBotIssues",
16817
+ "deleteBotIssue",
16818
+ "listBotIssueEvents",
16819
+ "listBotVersions",
16820
+ "getBotVersion",
16821
+ "getBotJson",
16822
+ "publishFromBotJson",
16823
+ "createBotVersion",
16824
+ "deployBotVersion",
16825
+ "createIntegrationShareableId",
16826
+ "deleteIntegrationShareableId",
16827
+ "getIntegrationShareableId",
16828
+ "unlinkSandboxedConversations",
16829
+ "listBotApiKeys",
16830
+ "createBotApiKey",
16831
+ "deleteBotApiKey",
16832
+ "getBotAllowlist",
16833
+ "updateBotAllowlist"
16834
+ ],
16835
+ "schema": "Bot"
16803
16836
  },
16804
- "User": {
16805
- "section": "user",
16806
- "schema": {
16807
- "type": "object",
16808
- "properties": {
16809
- "id": {
16810
- "type": "string",
16811
- "minLength": 28,
16812
- "maxLength": 36,
16813
- "description": "Id of the [User](#schema_user)"
16814
- },
16815
- "createdAt": {
16816
- "type": "string",
16817
- "format": "date-time",
16818
- "description": "Creation date of the [User](#schema_user) in ISO 8601 format"
16819
- },
16820
- "updatedAt": {
16821
- "type": "string",
16822
- "format": "date-time",
16823
- "description": "Updating date of the [User](#schema_user) in ISO 8601 format"
16824
- },
16825
- "tags": {
16826
- "type": "object",
16827
- "additionalProperties": {
16828
- "type": "string"
16829
- },
16830
- "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [User](#schema_user). The set of [Tags](/docs/developers/concepts/tags) available on a [User](#schema_user) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them."
16831
- },
16832
- "name": {
16833
- "type": "string",
16834
- "maxLength": 200,
16835
- "description": "Name of the [User](#schema_user)"
16836
- },
16837
- "pictureUrl": {
16838
- "type": "string",
16839
- "maxLength": 40000,
16840
- "description": "Picture URL of the [User](#schema_user)"
16841
- }
16842
- },
16843
- "required": [
16844
- "id",
16845
- "createdAt",
16846
- "updatedAt",
16847
- "tags"
16848
- ],
16849
- "description": "The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.",
16850
- "additionalProperties": false
16851
- }
16837
+ {
16838
+ "title": "Integration",
16839
+ "description": "",
16840
+ "name": "integration",
16841
+ "operations": [
16842
+ "listIntegrationApiKeys",
16843
+ "createIntegrationApiKey",
16844
+ "deleteIntegrationApiKey",
16845
+ "createIntegration",
16846
+ "validateIntegrationCreation",
16847
+ "updateIntegration",
16848
+ "validateIntegrationUpdate",
16849
+ "listIntegrations",
16850
+ "getIntegration",
16851
+ "getIntegrationLogs",
16852
+ "getIntegrationByName",
16853
+ "deleteIntegration",
16854
+ "requestIntegrationVerification"
16855
+ ],
16856
+ "schema": "Integration"
16852
16857
  },
16853
- "Conversation": {
16854
- "section": "conversation",
16855
- "schema": {
16856
- "type": "object",
16857
- "properties": {
16858
- "id": {
16859
- "type": "string",
16860
- "minLength": 28,
16861
- "maxLength": 36,
16862
- "description": "Id of the [Conversation](#schema_conversation)"
16863
- },
16864
- "currentTaskId": {
16865
- "type": "string",
16866
- "minLength": 28,
16867
- "maxLength": 36,
16868
- "description": "Id of the current [Task](#schema_task)"
16869
- },
16870
- "currentWorkflowId": {
16871
- "type": "string",
16872
- "minLength": 28,
16873
- "maxLength": 36,
16874
- "description": "Id of the current [Workflow](#schema_workflow)"
16875
- },
16876
- "createdAt": {
16877
- "type": "string",
16878
- "format": "date-time",
16879
- "description": "Creation date of the [Conversation](#schema_conversation) in ISO 8601 format"
16880
- },
16881
- "updatedAt": {
16882
- "type": "string",
16883
- "format": "date-time",
16884
- "description": "Updating date of the [Conversation](#schema_conversation) in ISO 8601 format"
16885
- },
16886
- "channel": {
16887
- "type": "string",
16888
- "description": "Name of the channel where the [Conversation](#schema_conversation) is happening"
16889
- },
16890
- "integration": {
16891
- "type": "string",
16892
- "description": "Name of the integration that created the [Conversation](#schema_conversation)"
16893
- },
16894
- "tags": {
16895
- "type": "object",
16896
- "additionalProperties": {
16897
- "type": "string"
16898
- },
16899
- "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them."
16900
- }
16901
- },
16902
- "required": [
16903
- "id",
16904
- "createdAt",
16905
- "updatedAt",
16906
- "channel",
16907
- "integration",
16908
- "tags"
16909
- ],
16910
- "description": "The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.",
16911
- "additionalProperties": false
16912
- }
16858
+ {
16859
+ "title": "Interface",
16860
+ "description": "",
16861
+ "name": "interface",
16862
+ "operations": [
16863
+ "createInterface",
16864
+ "getInterface",
16865
+ "getInterfaceByName",
16866
+ "updateInterface",
16867
+ "deleteInterface",
16868
+ "listInterfaces"
16869
+ ],
16870
+ "schema": "Interface"
16913
16871
  },
16914
- "Event": {
16915
- "section": "event",
16916
- "schema": {
16917
- "type": "object",
16918
- "properties": {
16919
- "id": {
16920
- "type": "string",
16921
- "minLength": 28,
16922
- "maxLength": 36,
16923
- "description": "Id of the [Event](#schema_event)"
16924
- },
16925
- "createdAt": {
16926
- "type": "string",
16927
- "format": "date-time",
16928
- "description": "Creation date of the [Event](#schema_event) in ISO 8601 format"
16929
- },
16930
- "type": {
16931
- "type": "string",
16932
- "maxLength": 200,
16933
- "description": "Type of the [Event](#schema_event)."
16934
- },
16935
- "payload": {
16936
- "type": "object",
16937
- "additionalProperties": true,
16938
- "description": "Payload is the content of the event defined by the integration installed on your bot or one of the default events created by our api."
16939
- },
16940
- "conversationId": {
16941
- "type": "string",
16942
- "minLength": 28,
16943
- "maxLength": 36,
16944
- "description": "ID of the [Conversation](#schema_conversation) to link the event to."
16945
- },
16946
- "userId": {
16947
- "type": "string",
16948
- "minLength": 28,
16949
- "maxLength": 36,
16950
- "description": "ID of the [User](#schema_user) to link the event to."
16951
- },
16952
- "messageId": {
16953
- "type": "string",
16954
- "minLength": 28,
16955
- "maxLength": 36,
16956
- "description": "ID of the [Message](#schema_message) to link the event to."
16957
- },
16958
- "status": {
16959
- "type": "string",
16960
- "enum": [
16961
- "pending",
16962
- "processed",
16963
- "ignored",
16964
- "failed",
16965
- "scheduled"
16966
- ]
16967
- },
16968
- "failureReason": {
16969
- "type": "string",
16970
- "maxLength": 2000,
16971
- "nullable": true,
16972
- "description": "Reason why the event failed to be processed"
16973
- }
16974
- },
16975
- "required": [
16976
- "id",
16977
- "createdAt",
16978
- "type",
16979
- "payload",
16980
- "status",
16981
- "failureReason"
16982
- ],
16983
- "description": "The event object represents an action or an occurrence.",
16984
- "additionalProperties": false
16985
- }
16986
- },
16987
- "Message": {
16988
- "section": "message",
16989
- "schema": {
16990
- "type": "object",
16991
- "properties": {
16992
- "id": {
16993
- "type": "string",
16994
- "minLength": 28,
16995
- "maxLength": 36,
16996
- "description": "Id of the [Message](#schema_message)"
16997
- },
16998
- "createdAt": {
16999
- "type": "string",
17000
- "format": "date-time",
17001
- "description": "Creation date of the [Message](#schema_message) in ISO 8601 format"
17002
- },
17003
- "updatedAt": {
17004
- "type": "string",
17005
- "format": "date-time",
17006
- "description": "Update date of the [Message](#schema_message) in ISO 8601 format"
17007
- },
17008
- "type": {
17009
- "type": "string",
17010
- "maxLength": 200,
17011
- "description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
17012
- },
17013
- "payload": {
17014
- "type": "object",
17015
- "additionalProperties": true,
17016
- "description": "Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location"
17017
- },
17018
- "direction": {
17019
- "type": "string",
17020
- "enum": [
17021
- "incoming",
17022
- "outgoing"
17023
- ],
17024
- "description": "Direction of the message (`incoming` or `outgoing`)."
17025
- },
17026
- "userId": {
17027
- "type": "string",
17028
- "minLength": 28,
17029
- "maxLength": 36,
17030
- "description": "ID of the [User](#schema_user)"
17031
- },
17032
- "conversationId": {
17033
- "type": "string",
17034
- "minLength": 28,
17035
- "maxLength": 36,
17036
- "description": "ID of the [Conversation](#schema_conversation)"
17037
- },
17038
- "tags": {
17039
- "type": "object",
17040
- "additionalProperties": {
17041
- "type": "string"
17042
- },
17043
- "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them."
17044
- },
17045
- "origin": {
17046
- "type": "string",
17047
- "enum": [
17048
- "synthetic"
17049
- ],
17050
- "description": "Origin of the message (`synthetic`)."
17051
- }
17052
- },
17053
- "required": [
17054
- "id",
17055
- "createdAt",
17056
- "updatedAt",
17057
- "type",
17058
- "payload",
17059
- "direction",
17060
- "userId",
17061
- "conversationId",
17062
- "tags"
17063
- ],
17064
- "description": "The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).",
17065
- "additionalProperties": false
17066
- }
17067
- },
17068
- "State": {
17069
- "section": "state",
17070
- "schema": {
17071
- "type": "object",
17072
- "properties": {
17073
- "id": {
17074
- "type": "string",
17075
- "minLength": 28,
17076
- "maxLength": 36,
17077
- "description": "Id of the [State](#schema_state)"
17078
- },
17079
- "createdAt": {
17080
- "type": "string",
17081
- "format": "date-time",
17082
- "description": "Creation date of the [State](#schema_state) in ISO 8601 format"
17083
- },
17084
- "updatedAt": {
17085
- "type": "string",
17086
- "format": "date-time",
17087
- "description": "Updating date of the [State](#schema_state) in ISO 8601 format"
17088
- },
17089
- "botId": {
17090
- "type": "string",
17091
- "minLength": 28,
17092
- "maxLength": 36,
17093
- "description": "Id of the [Bot](#schema_bot)"
17094
- },
17095
- "conversationId": {
17096
- "type": "string",
17097
- "minLength": 28,
17098
- "maxLength": 36,
17099
- "description": "Id of the [Conversation](#schema_conversation)"
17100
- },
17101
- "userId": {
17102
- "type": "string",
17103
- "minLength": 28,
17104
- "maxLength": 36,
17105
- "description": "Id of the [User](#schema_user)"
17106
- },
17107
- "name": {
17108
- "type": "string",
17109
- "maxLength": 200,
17110
- "description": "Name of the [State](#schema_state) which is declared inside the bot definition"
17111
- },
17112
- "type": {
17113
- "type": "string",
17114
- "enum": [
17115
- "conversation",
17116
- "user",
17117
- "bot",
17118
- "task",
17119
- "integration",
17120
- "workflow"
17121
- ],
17122
- "description": "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to"
17123
- },
17124
- "payload": {
17125
- "type": "object",
17126
- "additionalProperties": true,
17127
- "description": "Payload is the content of the state defined by your bot."
17128
- }
17129
- },
17130
- "required": [
17131
- "id",
17132
- "createdAt",
17133
- "updatedAt",
17134
- "botId",
17135
- "name",
17136
- "type",
17137
- "payload"
17138
- ],
17139
- "description": "The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.",
17140
- "additionalProperties": false
17141
- }
17142
- },
17143
- "Task": {
17144
- "section": "task",
17145
- "schema": {
17146
- "type": "object",
17147
- "properties": {
17148
- "id": {
17149
- "type": "string",
17150
- "minLength": 28,
17151
- "maxLength": 36,
17152
- "description": "Id of the [Task](#schema_task)"
17153
- },
17154
- "title": {
17155
- "type": "string",
17156
- "maxLength": 64,
17157
- "description": "Title describing the task"
17158
- },
17159
- "description": {
17160
- "type": "string",
17161
- "maxLength": 256,
17162
- "description": "All the notes related to the execution of the current task"
17163
- },
17164
- "type": {
17165
- "type": "string",
17166
- "description": "Type of the task"
17167
- },
17168
- "data": {
17169
- "type": "object",
17170
- "additionalProperties": true,
17171
- "description": "Content related to the task"
17172
- },
17173
- "status": {
17174
- "type": "string",
17175
- "enum": [
17176
- "pending",
17177
- "in_progress",
17178
- "failed",
17179
- "completed",
17180
- "blocked",
17181
- "paused",
17182
- "timeout",
17183
- "cancelled"
17184
- ],
17185
- "description": "Status of the task"
17186
- },
17187
- "parentTaskId": {
17188
- "type": "string",
17189
- "minLength": 28,
17190
- "maxLength": 36,
17191
- "description": "Parent task id is the parent task that created this task"
17192
- },
17193
- "conversationId": {
17194
- "type": "string",
17195
- "minLength": 28,
17196
- "maxLength": 36,
17197
- "description": "Conversation id related to this task"
17198
- },
17199
- "userId": {
17200
- "type": "string",
17201
- "minLength": 28,
17202
- "maxLength": 36,
17203
- "description": "Specific user related to this task"
17204
- },
17205
- "timeoutAt": {
17206
- "type": "string",
17207
- "format": "date-time",
17208
- "description": "The timeout date where the task should be failed in the ISO 8601 format"
17209
- },
17210
- "createdAt": {
17211
- "type": "string",
17212
- "format": "date-time",
17213
- "description": "Creation date of the task in ISO 8601 format"
17214
- },
17215
- "updatedAt": {
17216
- "type": "string",
17217
- "format": "date-time",
17218
- "description": "Updating date of the task in ISO 8601 format"
17219
- },
17220
- "failureReason": {
17221
- "type": "string",
17222
- "maxLength": 2000,
17223
- "description": "If the task fails this is the reason behind it"
17224
- },
17225
- "tags": {
17226
- "type": "object",
17227
- "additionalProperties": {
17228
- "type": "string"
17229
- },
17230
- "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them."
17231
- }
17232
- },
17233
- "required": [
17234
- "id",
17235
- "title",
17236
- "description",
17237
- "type",
17238
- "data",
17239
- "status",
17240
- "timeoutAt",
17241
- "createdAt",
17242
- "updatedAt",
17243
- "tags"
17244
- ],
17245
- "description": "Task definition",
17246
- "additionalProperties": false
17247
- }
17248
- },
17249
- "Workflow": {
17250
- "section": "workflow",
17251
- "schema": {
17252
- "type": "object",
17253
- "properties": {
17254
- "id": {
17255
- "type": "string",
17256
- "minLength": 28,
17257
- "maxLength": 36,
17258
- "description": "Id of the [Workflow](#schema_workflow)"
17259
- },
17260
- "name": {
17261
- "type": "string",
17262
- "maxLength": 200,
17263
- "description": "Name of the workflow"
17264
- },
17265
- "status": {
17266
- "type": "string",
17267
- "enum": [
17268
- "pending",
17269
- "in_progress",
17270
- "failed",
17271
- "completed",
17272
- "listening",
17273
- "paused",
17274
- "timedout",
17275
- "cancelled"
17276
- ],
17277
- "description": "Status of the [Workflow](#schema_workflow)"
17278
- },
17279
- "input": {
17280
- "type": "object",
17281
- "additionalProperties": true,
17282
- "description": "Input provided to the [Workflow](#schema_workflow)"
17283
- },
17284
- "output": {
17285
- "type": "object",
17286
- "additionalProperties": true,
17287
- "description": "Data returned by the [Workflow](#schema_workflow) output"
17288
- },
17289
- "parentWorkflowId": {
17290
- "type": "string",
17291
- "minLength": 28,
17292
- "maxLength": 36,
17293
- "description": "Parent [Workflow](#schema_workflow) id is the parent [Workflow](#schema_workflow) that created this [Workflow](#schema_workflow)"
17294
- },
17295
- "conversationId": {
17296
- "type": "string",
17297
- "minLength": 28,
17298
- "maxLength": 36,
17299
- "description": "Conversation id related to this [Workflow](#schema_workflow)"
17300
- },
17301
- "userId": {
17302
- "type": "string",
17303
- "minLength": 28,
17304
- "maxLength": 36,
17305
- "description": "User id related to this [Workflow](#schema_workflow)"
17306
- },
17307
- "createdAt": {
17308
- "type": "string",
17309
- "format": "date-time",
17310
- "description": "Creation date of the [Workflow](#schema_workflow) in ISO 8601 format"
17311
- },
17312
- "updatedAt": {
17313
- "type": "string",
17314
- "format": "date-time",
17315
- "description": "Updating date of the [Workflow](#schema_workflow) in ISO 8601 format"
17316
- },
17317
- "completedAt": {
17318
- "type": "string",
17319
- "format": "date-time",
17320
- "description": "The date when the [Workflow](#schema_workflow) completed in ISO 8601 format"
17321
- },
17322
- "failureReason": {
17323
- "type": "string",
17324
- "maxLength": 2000,
17325
- "description": "If the [Workflow](#schema_workflow) fails this is the reason behind it"
17326
- },
17327
- "timeoutAt": {
17328
- "type": "string",
17329
- "format": "date-time",
17330
- "description": "The timeout date when the [Workflow](#schema_workflow) will fail in the ISO 8601 format"
17331
- },
17332
- "tags": {
17333
- "type": "object",
17334
- "additionalProperties": {
17335
- "type": "string"
17336
- },
17337
- "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Workflow](#schema_workflow). Individual keys can be unset by posting an empty value to them."
17338
- }
17339
- },
17340
- "required": [
17341
- "id",
17342
- "name",
17343
- "status",
17344
- "input",
17345
- "output",
17346
- "createdAt",
17347
- "updatedAt",
17348
- "timeoutAt",
17349
- "tags"
17350
- ],
17351
- "description": "Workflow definition",
17352
- "additionalProperties": false
17353
- }
17354
- },
17355
- "Table": {
17356
- "section": "tables",
17357
- "schema": {
17358
- "type": "object",
17359
- "properties": {
17360
- "id": {
17361
- "type": "string",
17362
- "description": "Unique identifier for the table"
17363
- },
17364
- "name": {
17365
- "description": "Required. This name is used to identify your table.",
17366
- "type": "string",
17367
- "minLength": 1
17368
- },
17369
- "factor": {
17370
- "default": 1,
17371
- "type": "number",
17372
- "minimum": 1,
17373
- "maximum": 30,
17374
- "description": "The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1."
17375
- },
17376
- "frozen": {
17377
- "type": "boolean",
17378
- "description": "A table designated as \"frozen\" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations."
17379
- },
17380
- "schema": {
17381
- "type": "object",
17382
- "properties": {
17383
- "$schema": {
17384
- "type": "string"
17385
- },
17386
- "properties": {
17387
- "type": "object",
17388
- "additionalProperties": {
17389
- "type": "object",
17390
- "properties": {
17391
- "type": {
17392
- "type": "string",
17393
- "enum": [
17394
- "string",
17395
- "number",
17396
- "boolean",
17397
- "object",
17398
- "array",
17399
- "null"
17400
- ]
17401
- },
17402
- "format": {
17403
- "type": "string",
17404
- "enum": [
17405
- "date-time"
17406
- ]
17407
- },
17408
- "description": {
17409
- "type": "string"
17410
- },
17411
- "pattern": {
17412
- "type": "string",
17413
- "description": "String properties must match this pattern"
17414
- },
17415
- "enum": {
17416
- "type": "array",
17417
- "items": {
17418
- "type": "string"
17419
- },
17420
- "description": "String properties must be one of these values"
17421
- },
17422
- "items": {
17423
- "type": "object",
17424
- "properties": {
17425
- "type": {
17426
- "type": "string",
17427
- "enum": [
17428
- "string",
17429
- "number",
17430
- "boolean",
17431
- "object",
17432
- "array",
17433
- "null"
17434
- ]
17435
- }
17436
- },
17437
- "required": [
17438
- "type"
17439
- ],
17440
- "additionalProperties": true,
17441
- "description": "Defines the shape of items in an array"
17442
- },
17443
- "nullable": {
17444
- "default": true,
17445
- "type": "boolean"
17446
- },
17447
- "properties": {
17448
- "type": "object",
17449
- "additionalProperties": {
17450
- "type": "object",
17451
- "properties": {
17452
- "type": {
17453
- "type": "string",
17454
- "enum": [
17455
- "string",
17456
- "number",
17457
- "boolean",
17458
- "object",
17459
- "array",
17460
- "null"
17461
- ]
17462
- }
17463
- },
17464
- "required": [
17465
- "type"
17466
- ],
17467
- "additionalProperties": true
17468
- }
17469
- },
17470
- "x-zui": {
17471
- "type": "object",
17472
- "properties": {
17473
- "index": {
17474
- "type": "integer"
17475
- },
17476
- "id": {
17477
- "type": "string",
17478
- "description": "[deprecated] ID of the column."
17479
- },
17480
- "searchable": {
17481
- "type": "boolean",
17482
- "description": "Indicates if the column is vectorized and searchable."
17483
- },
17484
- "hidden": {
17485
- "type": "boolean",
17486
- "description": "Indicates if the field is hidden in the UI"
17487
- },
17488
- "order": {
17489
- "type": "number",
17490
- "description": "Order of the column in the UI"
17491
- },
17492
- "width": {
17493
- "type": "number",
17494
- "description": "Width of the column in the UI"
17495
- },
17496
- "schemaId": {
17497
- "type": "string",
17498
- "description": "ID of the schema"
17499
- },
17500
- "computed": {
17501
- "type": "object",
17502
- "properties": {
17503
- "action": {
17504
- "type": "string",
17505
- "enum": [
17506
- "ai",
17507
- "code",
17508
- "workflow"
17509
- ]
17510
- },
17511
- "dependencies": {
17512
- "default": [],
17513
- "type": "array",
17514
- "items": {
17515
- "type": "string"
17516
- }
17517
- },
17518
- "prompt": {
17519
- "type": "string",
17520
- "description": "Prompt when action is \"ai\""
17521
- },
17522
- "code": {
17523
- "type": "string",
17524
- "description": "Code to execute when action is \"code\""
17525
- },
17526
- "model": {
17527
- "default": "gpt-4o",
17528
- "type": "string",
17529
- "maxLength": 80,
17530
- "description": "Model to use when action is \"ai\""
17531
- },
17532
- "workflowId": {
17533
- "type": "string",
17534
- "maxLength": 20,
17535
- "description": "ID of Workflow to execute when action is \"workflow\""
17536
- },
17537
- "enabled": {
17538
- "type": "boolean"
17539
- }
17540
- },
17541
- "required": [
17542
- "action"
17543
- ],
17544
- "additionalProperties": false
17545
- },
17546
- "typings": {
17547
- "type": "string",
17548
- "description": "TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\""
17549
- }
17550
- },
17551
- "required": [
17552
- "index"
17553
- ],
17554
- "additionalProperties": false
17555
- }
17556
- },
17557
- "required": [
17558
- "type",
17559
- "x-zui"
17560
- ],
17561
- "additionalProperties": false
17562
- },
17563
- "description": "List of keys/columns in the table."
17564
- },
17565
- "additionalProperties": {
17566
- "type": "boolean",
17567
- "enum": [
17568
- true
17569
- ],
17570
- "description": "Additional properties can be provided, but they will be ignored if no column matches."
17571
- },
17572
- "required": {
17573
- "type": "array",
17574
- "items": {
17575
- "type": "string"
17576
- },
17577
- "description": "Array of required properties."
17578
- },
17579
- "type": {
17580
- "type": "string",
17581
- "enum": [
17582
- "object"
17583
- ]
17584
- }
17585
- },
17586
- "required": [
17587
- "properties",
17588
- "additionalProperties",
17589
- "type"
17590
- ],
17591
- "additionalProperties": false
17592
- },
17593
- "tags": {
17594
- "type": "object",
17595
- "additionalProperties": {
17596
- "type": "string"
17597
- },
17598
- "description": "Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs."
17599
- },
17600
- "isComputeEnabled": {
17601
- "type": "boolean",
17602
- "description": "Indicates if the table is enabled for computation."
17603
- },
17604
- "createdAt": {
17605
- "type": "string",
17606
- "format": "date-time",
17607
- "description": "Timestamp of table creation."
17608
- },
17609
- "updatedAt": {
17610
- "type": "string",
17611
- "format": "date-time",
17612
- "description": "Timestamp of the last table update."
17613
- }
17614
- },
17615
- "required": [
17616
- "id",
17617
- "name",
17618
- "schema"
17619
- ],
17620
- "additionalProperties": false
17621
- }
17622
- },
17623
- "Column": {
17624
- "section": "tables",
17625
- "schema": {
17626
- "type": "object",
17627
- "properties": {
17628
- "id": {
17629
- "type": "string",
17630
- "description": "Unique identifier for the column."
17631
- },
17632
- "name": {
17633
- "type": "string",
17634
- "minLength": 1,
17635
- "maxLength": 30,
17636
- "description": "Name of the column, must be within length limits."
17637
- },
17638
- "description": {
17639
- "type": "string",
17640
- "description": "Optional descriptive text about the column."
17641
- },
17642
- "searchable": {
17643
- "type": "boolean",
17644
- "description": "Indicates if the column is vectorized and searchable."
17645
- },
17646
- "type": {
17647
- "type": "string",
17648
- "enum": [
17649
- "string",
17650
- "number",
17651
- "boolean",
17652
- "date",
17653
- "object"
17654
- ],
17655
- "description": "Specifies the data type of the column. Use \"object\" for complex data structures."
17656
- },
17657
- "typings": {
17658
- "type": "string",
17659
- "description": "TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\""
17660
- },
17661
- "computed": {
17662
- "type": "object",
17663
- "properties": {
17664
- "action": {
17665
- "type": "string",
17666
- "enum": [
17667
- "ai",
17668
- "code",
17669
- "workflow"
17670
- ]
17671
- },
17672
- "dependencies": {
17673
- "default": [],
17674
- "type": "array",
17675
- "items": {
17676
- "type": "string"
17677
- }
17678
- },
17679
- "prompt": {
17680
- "type": "string",
17681
- "description": "Prompt when action is \"ai\""
17682
- },
17683
- "code": {
17684
- "type": "string",
17685
- "description": "Code to execute when action is \"code\""
17686
- },
17687
- "model": {
17688
- "default": "gpt-4o",
17689
- "type": "string",
17690
- "maxLength": 80,
17691
- "description": "Model to use when action is \"ai\""
17692
- },
17693
- "workflowId": {
17694
- "type": "string",
17695
- "maxLength": 20,
17696
- "description": "ID of Workflow to execute when action is \"workflow\""
17697
- },
17698
- "enabled": {
17699
- "type": "boolean"
17700
- }
17701
- },
17702
- "required": [
17703
- "action"
17704
- ],
17705
- "additionalProperties": false
17706
- },
17707
- "schema": {
17708
- "type": "object",
17709
- "additionalProperties": true
17710
- }
17711
- },
17712
- "required": [
17713
- "name",
17714
- "type"
17715
- ],
17716
- "additionalProperties": false
17717
- }
17718
- },
17719
- "Row": {
17720
- "section": "tables",
17721
- "schema": {
17722
- "type": "object",
17723
- "properties": {
17724
- "id": {
17725
- "type": "number",
17726
- "description": "Unique identifier for the row."
17727
- },
17728
- "createdAt": {
17729
- "type": "string",
17730
- "format": "date-time",
17731
- "description": "Timestamp of row creation."
17732
- },
17733
- "updatedAt": {
17734
- "type": "string",
17735
- "format": "date-time",
17736
- "description": "Timestamp of the last row update."
17737
- },
17738
- "computed": {
17739
- "type": "object",
17740
- "additionalProperties": {
17741
- "type": "object",
17742
- "properties": {
17743
- "status": {
17744
- "type": "string"
17745
- },
17746
- "error": {
17747
- "type": "string"
17748
- },
17749
- "updatedBy": {
17750
- "type": "string"
17751
- },
17752
- "updatedAt": {
17753
- "type": "string"
17754
- }
17755
- },
17756
- "required": [
17757
- "status"
17758
- ],
17759
- "additionalProperties": false
17760
- }
17761
- },
17762
- "stale": {
17763
- "type": "array",
17764
- "items": {
17765
- "type": "string"
17766
- },
17767
- "description": "[Read-only] List of stale values that are waiting to be recomputed."
17768
- },
17769
- "similarity": {
17770
- "type": "number",
17771
- "description": "Optional numeric value indicating similarity, when using findTableRows."
17772
- }
17773
- },
17774
- "required": [
17775
- "id",
17776
- "computed"
17777
- ],
17778
- "additionalProperties": true
17779
- }
17780
- },
17781
- "File": {
17782
- "section": "files",
17783
- "schema": {
17784
- "type": "object",
17785
- "properties": {
17786
- "id": {
17787
- "type": "string",
17788
- "description": "File ID"
17789
- },
17790
- "botId": {
17791
- "type": "string",
17792
- "description": "The ID of the bot the file belongs to"
17793
- },
17794
- "key": {
17795
- "type": "string",
17796
- "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
17797
- },
17798
- "url": {
17799
- "type": "string",
17800
- "description": "URL to retrieve the file content. This URL will be ready to use once the file is uploaded.\n\nIf the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe."
17801
- },
17802
- "size": {
17803
- "type": "number",
17804
- "description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
17805
- "nullable": true
17806
- },
17807
- "contentType": {
17808
- "type": "string",
17809
- "description": "MIME type of the file's content"
17810
- },
17811
- "tags": {
17812
- "type": "object",
17813
- "additionalProperties": {
17814
- "type": "string",
17815
- "maxLength": 1000
17816
- },
17817
- "description": "The tags of the file as an object of key/value pairs"
17818
- },
17819
- "metadata": {
17820
- "type": "object",
17821
- "additionalProperties": {
17822
- "nullable": true
17823
- },
17824
- "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
17825
- },
17826
- "createdAt": {
17827
- "type": "string",
17828
- "description": "File creation timestamp in ISO 8601 format"
17829
- },
17830
- "updatedAt": {
17831
- "type": "string",
17832
- "description": "File last update timestamp in ISO 8601 format"
17833
- },
17834
- "accessPolicies": {
17835
- "type": "array",
17836
- "items": {
17837
- "type": "string",
17838
- "enum": [
17839
- "integrations",
17840
- "public_content"
17841
- ]
17842
- },
17843
- "description": "Access policies configured for the file."
17844
- },
17845
- "index": {
17846
- "type": "boolean",
17847
- "description": "Whether the file was requested to be indexed for search or not."
17848
- },
17849
- "status": {
17850
- "type": "string",
17851
- "enum": [
17852
- "upload_pending",
17853
- "upload_failed",
17854
- "upload_completed",
17855
- "indexing_pending",
17856
- "indexing_failed",
17857
- "indexing_completed"
17858
- ],
17859
- "description": "Status of the file. If the status is `upload_pending`, the file content has not been uploaded yet. The status will be set to `upload_completed` once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to `upload_failed` and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the `indexing_pending` status (the `upload_completed` status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to `indexing_completed`. If the indexing failed the status will be set to `indexing_failed` and the reason for the failure will be available in the `failedStatusReason` field."
17860
- },
17861
- "failedStatusReason": {
17862
- "type": "string",
17863
- "description": "If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure."
17864
- },
17865
- "expiresAt": {
17866
- "type": "string",
17867
- "description": "File expiry timestamp in ISO 8601 format"
17868
- },
17869
- "owner": {
17870
- "type": "object",
17871
- "properties": {
17872
- "type": {
17873
- "type": "string",
17874
- "enum": [
17875
- "bot",
17876
- "integration",
17877
- "user"
17878
- ]
17879
- },
17880
- "id": {
17881
- "type": "string",
17882
- "description": "This field is present if `type` is \"user\" or \"bot\". If `type` is \"user\", this is the user ID. If `type` is \"bot\", this is the bot ID."
17883
- },
17884
- "name": {
17885
- "type": "string",
17886
- "description": "This field is present if the `type` is \"integration\". If `type` is \"integration\", this is the integration name."
17887
- }
17888
- },
17889
- "required": [
17890
- "type"
17891
- ],
17892
- "additionalProperties": false
17893
- },
17894
- "indexingStack": {
17895
- "type": "string",
17896
- "enum": [
17897
- "v1",
17898
- "v2"
17899
- ],
17900
- "description": "Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of \"v2\" denotes the latest stack, \"v1\" denotes the legacy stack."
17901
- }
17902
- },
17903
- "required": [
17904
- "id",
17905
- "botId",
17906
- "key",
17907
- "url",
17908
- "size",
17909
- "contentType",
17910
- "tags",
17911
- "metadata",
17912
- "createdAt",
17913
- "updatedAt",
17914
- "accessPolicies",
17915
- "index",
17916
- "status",
17917
- "owner"
17918
- ],
17919
- "additionalProperties": false
17920
- }
17921
- }
17922
- },
17923
- "sections": [
17924
- {
17925
- "description": "",
17926
- "title": "User",
17927
- "name": "user",
17928
- "operations": [],
17929
- "schema": "User"
17930
- },
17931
- {
17932
- "description": "",
17933
- "title": "Conversation",
17934
- "name": "conversation",
17935
- "operations": [],
17936
- "schema": "Conversation"
17937
- },
17938
- {
17939
- "description": "",
17940
- "title": "Event",
17941
- "name": "event",
17942
- "operations": [],
17943
- "schema": "Event"
17944
- },
17945
- {
17946
- "description": "",
17947
- "title": "Message",
17948
- "name": "message",
17949
- "operations": [],
17950
- "schema": "Message"
17951
- },
17952
- {
17953
- "description": "",
17954
- "title": "State",
17955
- "name": "state",
17956
- "operations": [],
17957
- "schema": "State"
16872
+ {
16873
+ "title": "Plugin",
16874
+ "description": "",
16875
+ "name": "plugin",
16876
+ "operations": [
16877
+ "createPlugin",
16878
+ "getPlugin",
16879
+ "getDereferencedPlugin",
16880
+ "getPluginByName",
16881
+ "updatePlugin",
16882
+ "deletePlugin",
16883
+ "listPlugins",
16884
+ "getPluginCode"
16885
+ ],
16886
+ "schema": "Plugin"
17958
16887
  },
17959
16888
  {
17960
16889
  "title": "Hub",
@@ -17974,120 +16903,6 @@ export const state = {
17974
16903
  "getPublicInterface"
17975
16904
  ]
17976
16905
  },
17977
- {
17978
- "description": "",
17979
- "title": "Action",
17980
- "name": "action",
17981
- "operations": []
17982
- },
17983
- {
17984
- "description": "",
17985
- "title": "Task",
17986
- "name": "task",
17987
- "operations": [],
17988
- "schema": "Task"
17989
- },
17990
- {
17991
- "description": "",
17992
- "title": "Workflow",
17993
- "name": "workflow",
17994
- "operations": [],
17995
- "schema": "Workflow"
17996
- },
17997
- {
17998
- "description": "",
17999
- "title": "Tag",
18000
- "name": "tag",
18001
- "operations": []
18002
- },
18003
- {
18004
- "title": "Bot",
18005
- "description": "",
18006
- "name": "bot",
18007
- "operations": [
18008
- "createBot",
18009
- "updateBot",
18010
- "transferBot",
18011
- "listBots",
18012
- "getBot",
18013
- "deleteBot",
18014
- "getBotLogs",
18015
- "getBotWebchat",
18016
- "getBotAnalytics",
18017
- "listActionRuns",
18018
- "getBotIssue",
18019
- "listBotIssues",
18020
- "deleteBotIssue",
18021
- "listBotIssueEvents",
18022
- "listBotVersions",
18023
- "getBotVersion",
18024
- "getBotJson",
18025
- "publishFromBotJson",
18026
- "createBotVersion",
18027
- "deployBotVersion",
18028
- "createIntegrationShareableId",
18029
- "deleteIntegrationShareableId",
18030
- "getIntegrationShareableId",
18031
- "unlinkSandboxedConversations",
18032
- "listBotApiKeys",
18033
- "createBotApiKey",
18034
- "deleteBotApiKey",
18035
- "getBotAllowlist",
18036
- "updateBotAllowlist"
18037
- ],
18038
- "schema": "Bot"
18039
- },
18040
- {
18041
- "title": "Integration",
18042
- "description": "",
18043
- "name": "integration",
18044
- "operations": [
18045
- "listIntegrationApiKeys",
18046
- "createIntegrationApiKey",
18047
- "deleteIntegrationApiKey",
18048
- "createIntegration",
18049
- "validateIntegrationCreation",
18050
- "updateIntegration",
18051
- "validateIntegrationUpdate",
18052
- "listIntegrations",
18053
- "getIntegration",
18054
- "getIntegrationLogs",
18055
- "getIntegrationByName",
18056
- "deleteIntegration",
18057
- "requestIntegrationVerification"
18058
- ],
18059
- "schema": "Integration"
18060
- },
18061
- {
18062
- "title": "Interface",
18063
- "description": "",
18064
- "name": "interface",
18065
- "operations": [
18066
- "createInterface",
18067
- "getInterface",
18068
- "getInterfaceByName",
18069
- "updateInterface",
18070
- "deleteInterface",
18071
- "listInterfaces"
18072
- ],
18073
- "schema": "Interface"
18074
- },
18075
- {
18076
- "title": "Plugin",
18077
- "description": "",
18078
- "name": "plugin",
18079
- "operations": [
18080
- "createPlugin",
18081
- "getPlugin",
18082
- "getDereferencedPlugin",
18083
- "getPluginByName",
18084
- "updatePlugin",
18085
- "deletePlugin",
18086
- "listPlugins",
18087
- "getPluginCode"
18088
- ],
18089
- "schema": "Plugin"
18090
- },
18091
16906
  {
18092
16907
  "title": "Workspace",
18093
16908
  "description": "",
@@ -18179,20 +16994,6 @@ export const state = {
18179
16994
  "listActivities"
18180
16995
  ],
18181
16996
  "schema": "Activity"
18182
- },
18183
- {
18184
- "title": "Tables",
18185
- "description": "Manage and interact with table structures, including creation, updates, and querying of tables and their rows.",
18186
- "name": "tables",
18187
- "operations": [],
18188
- "schema": "Table"
18189
- },
18190
- {
18191
- "title": "Files",
18192
- "description": "The Files API allows you to create, manage, and index files that can be used by your bots and integrations. Files can be in any text or binary format, and documents (such as PDF, Microsoft Word, HTML, Markdown, etc.) can be indexed to be used for semantic search in RAG (Retrieval Augmented Generation) implementations. Files are private by default but can be made publicly accessible through a permanent URL that's unique for each file.",
18193
- "name": "files",
18194
- "operations": [],
18195
- "schema": "File"
18196
16997
  }
18197
16998
  ],
18198
16999
  "options": {