@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.
- package/.eslintrc.js +6 -0
- package/.turbo/turbo-openapi.log +6 -6
- package/dist/index.js +19056 -30211
- package/dist/src/gen/admin/state.d.ts +11 -1004
- package/dist/src/gen/files/state.d.ts +44 -3041
- package/dist/src/gen/runtime/state.d.ts +115 -2700
- package/dist/src/gen/state.d.ts +7 -0
- package/dist/src/gen/tables/state.d.ts +19 -2762
- package/dist/src/index.d.ts +10 -10
- package/package.json +5 -3
- package/src/gen/admin/metadata.json +1 -1
- package/src/gen/admin/openapi.json +1 -1
- package/src/gen/admin/state.ts +97 -1296
- package/src/gen/files/metadata.json +1 -1
- package/src/gen/files/openapi.json +1 -1
- package/src/gen/files/state.ts +83 -3667
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/runtime/metadata.json +1 -1
- package/src/gen/runtime/openapi.json +1 -1
- package/src/gen/runtime/state.ts +16 -3122
- package/src/gen/state.ts +12 -4
- package/src/gen/tables/metadata.json +1 -1
- package/src/gen/tables/openapi.json +1 -1
- package/src/gen/tables/state.ts +98 -3392
package/src/gen/files/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<'
|
|
5
|
+
export type State = opapi.State<'File', never, 'files'>
|
|
6
6
|
export const state = {
|
|
7
7
|
"operations": {
|
|
8
8
|
"upsertFile": {
|
|
@@ -1865,10 +1865,10 @@ export const state = {
|
|
|
1865
1865
|
}
|
|
1866
1866
|
},
|
|
1867
1867
|
"metadata": {
|
|
1868
|
-
"title": "Botpress API",
|
|
1869
|
-
"description": "API for Botpress
|
|
1868
|
+
"title": "Botpress Files API",
|
|
1869
|
+
"description": "API for Botpress Files",
|
|
1870
1870
|
"server": "https://api.botpress.cloud",
|
|
1871
|
-
"version": "1.
|
|
1871
|
+
"version": "1.48.1",
|
|
1872
1872
|
"prefix": "v1"
|
|
1873
1873
|
},
|
|
1874
1874
|
"errors": [
|
|
@@ -1948,3523 +1948,88 @@ export const state = {
|
|
|
1948
1948
|
"description": "The resource is current locked and cannot be operated on until the lock is released."
|
|
1949
1949
|
},
|
|
1950
1950
|
{
|
|
1951
|
-
"status":
|
|
1952
|
-
"type": "
|
|
1953
|
-
"description": "The
|
|
1954
|
-
},
|
|
1955
|
-
{
|
|
1956
|
-
"status": 400,
|
|
1957
|
-
"type": "InvalidQuery",
|
|
1958
|
-
"description": "The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."
|
|
1959
|
-
},
|
|
1960
|
-
{
|
|
1961
|
-
"status": 400,
|
|
1962
|
-
"type": "Runtime",
|
|
1963
|
-
"description": "An error happened during the execution of a runtime (bot or integration)."
|
|
1964
|
-
},
|
|
1965
|
-
{
|
|
1966
|
-
"status": 409,
|
|
1967
|
-
"type": "AlreadyExists",
|
|
1968
|
-
"description": "The record attempted to be created already exists."
|
|
1969
|
-
},
|
|
1970
|
-
{
|
|
1971
|
-
"status": 429,
|
|
1972
|
-
"type": "RateLimited",
|
|
1973
|
-
"description": "The request has been rate limited."
|
|
1974
|
-
},
|
|
1975
|
-
{
|
|
1976
|
-
"status": 402,
|
|
1977
|
-
"type": "PaymentRequired",
|
|
1978
|
-
"description": "A payment is required to perform this request."
|
|
1979
|
-
},
|
|
1980
|
-
{
|
|
1981
|
-
"status": 403,
|
|
1982
|
-
"type": "QuotaExceeded",
|
|
1983
|
-
"description": "The request exceeds the allowed quota. Quotas are a soft limit that can be increased."
|
|
1984
|
-
},
|
|
1985
|
-
{
|
|
1986
|
-
"status": 413,
|
|
1987
|
-
"type": "LimitExceeded",
|
|
1988
|
-
"description": "The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."
|
|
1989
|
-
},
|
|
1990
|
-
{
|
|
1991
|
-
"status": 400,
|
|
1992
|
-
"type": "BreakingChanges",
|
|
1993
|
-
"description": "Request payload contains breaking changes which is not allowed for this resource without a version increment."
|
|
1994
|
-
}
|
|
1995
|
-
],
|
|
1996
|
-
"refs": {
|
|
1997
|
-
"parameters": {},
|
|
1998
|
-
"requestBodies": {
|
|
1999
|
-
"upsertFileBody": true,
|
|
2000
|
-
"updateFileMetadataBody": true,
|
|
2001
|
-
"copyFileBody": true,
|
|
2002
|
-
"setFilePassagesBody": true,
|
|
2003
|
-
"createKnowledgeBaseBody": true,
|
|
2004
|
-
"updateKnowledgeBaseBody": true
|
|
2005
|
-
},
|
|
2006
|
-
"responses": {
|
|
2007
|
-
"upsertFileResponse": true,
|
|
2008
|
-
"deleteFileResponse": true,
|
|
2009
|
-
"listFilesResponse": true,
|
|
2010
|
-
"getFileResponse": true,
|
|
2011
|
-
"updateFileMetadataResponse": true,
|
|
2012
|
-
"copyFileResponse": true,
|
|
2013
|
-
"searchFilesResponse": true,
|
|
2014
|
-
"listFilePassagesResponse": true,
|
|
2015
|
-
"setFilePassagesResponse": true,
|
|
2016
|
-
"listFileTagsResponse": true,
|
|
2017
|
-
"listFileTagValuesResponse": true,
|
|
2018
|
-
"createKnowledgeBaseResponse": true,
|
|
2019
|
-
"deleteKnowledgeBaseResponse": true,
|
|
2020
|
-
"updateKnowledgeBaseResponse": true,
|
|
2021
|
-
"listKnowledgeBasesResponse": true
|
|
2022
|
-
},
|
|
2023
|
-
"schemas": {
|
|
2024
|
-
"Bot": true,
|
|
2025
|
-
"Integration": true,
|
|
2026
|
-
"Interface": true,
|
|
2027
|
-
"Plugin": true,
|
|
2028
|
-
"Workspace": true,
|
|
2029
|
-
"WorkspaceMember": true,
|
|
2030
|
-
"Account": true,
|
|
2031
|
-
"Usage": true,
|
|
2032
|
-
"Issue": true,
|
|
2033
|
-
"IssueEvent": true,
|
|
2034
|
-
"Activity": true,
|
|
2035
|
-
"Version": true,
|
|
2036
|
-
"User": true,
|
|
2037
|
-
"Conversation": true,
|
|
2038
|
-
"Event": true,
|
|
2039
|
-
"Message": true,
|
|
2040
|
-
"State": true,
|
|
2041
|
-
"Task": true,
|
|
2042
|
-
"Workflow": true,
|
|
2043
|
-
"Table": true,
|
|
2044
|
-
"Column": true,
|
|
2045
|
-
"Row": true,
|
|
2046
|
-
"File": true
|
|
2047
|
-
}
|
|
2048
|
-
},
|
|
2049
|
-
"schemas": {
|
|
2050
|
-
"Bot": {
|
|
2051
|
-
"section": "bot",
|
|
2052
|
-
"schema": {
|
|
2053
|
-
"type": "object",
|
|
2054
|
-
"properties": {
|
|
2055
|
-
"id": {
|
|
2056
|
-
"type": "string",
|
|
2057
|
-
"minLength": 28,
|
|
2058
|
-
"maxLength": 36,
|
|
2059
|
-
"description": "Id of the [Bot](#schema_bot)"
|
|
2060
|
-
},
|
|
2061
|
-
"createdAt": {
|
|
2062
|
-
"type": "string",
|
|
2063
|
-
"format": "date-time",
|
|
2064
|
-
"description": "Creation date of the [Bot](#schema_bot) in ISO 8601 format"
|
|
2065
|
-
},
|
|
2066
|
-
"updatedAt": {
|
|
2067
|
-
"type": "string",
|
|
2068
|
-
"format": "date-time",
|
|
2069
|
-
"description": "Updating date of the [Bot](#schema_bot) in ISO 8601 format"
|
|
2070
|
-
},
|
|
2071
|
-
"signingSecret": {
|
|
2072
|
-
"type": "string",
|
|
2073
|
-
"maxLength": 2000,
|
|
2074
|
-
"description": "Signing secret of the [Bot](#schema_bot)"
|
|
2075
|
-
},
|
|
2076
|
-
"integrations": {
|
|
2077
|
-
"type": "object",
|
|
2078
|
-
"additionalProperties": {
|
|
2079
|
-
"type": "object",
|
|
2080
|
-
"properties": {
|
|
2081
|
-
"enabled": {
|
|
2082
|
-
"type": "boolean"
|
|
2083
|
-
},
|
|
2084
|
-
"name": {
|
|
2085
|
-
"type": "string",
|
|
2086
|
-
"maxLength": 200,
|
|
2087
|
-
"description": "Name of the [Integration](#schema_integration)"
|
|
2088
|
-
},
|
|
2089
|
-
"version": {
|
|
2090
|
-
"type": "string",
|
|
2091
|
-
"maxLength": 200,
|
|
2092
|
-
"description": "Version of the [Integration](#schema_integration)"
|
|
2093
|
-
},
|
|
2094
|
-
"webhookUrl": {
|
|
2095
|
-
"type": "string",
|
|
2096
|
-
"maxLength": 2000
|
|
2097
|
-
},
|
|
2098
|
-
"webhookId": {
|
|
2099
|
-
"type": "string",
|
|
2100
|
-
"maxLength": 200
|
|
2101
|
-
},
|
|
2102
|
-
"identifier": {
|
|
2103
|
-
"type": "string",
|
|
2104
|
-
"maxLength": 2000
|
|
2105
|
-
},
|
|
2106
|
-
"configurationType": {
|
|
2107
|
-
"type": "string",
|
|
2108
|
-
"maxLength": 200,
|
|
2109
|
-
"nullable": true
|
|
2110
|
-
},
|
|
2111
|
-
"configuration": {
|
|
2112
|
-
"type": "object",
|
|
2113
|
-
"additionalProperties": true
|
|
2114
|
-
},
|
|
2115
|
-
"status": {
|
|
2116
|
-
"type": "string",
|
|
2117
|
-
"enum": [
|
|
2118
|
-
"registration_pending",
|
|
2119
|
-
"registered",
|
|
2120
|
-
"registration_failed",
|
|
2121
|
-
"unregistration_pending",
|
|
2122
|
-
"unregistered",
|
|
2123
|
-
"unregistration_failed"
|
|
2124
|
-
]
|
|
2125
|
-
},
|
|
2126
|
-
"statusReason": {
|
|
2127
|
-
"type": "string",
|
|
2128
|
-
"maxLength": 2000,
|
|
2129
|
-
"nullable": true
|
|
2130
|
-
},
|
|
2131
|
-
"disabledChannels": {
|
|
2132
|
-
"type": "array",
|
|
2133
|
-
"items": {
|
|
2134
|
-
"type": "string",
|
|
2135
|
-
"description": "Channel name"
|
|
2136
|
-
},
|
|
2137
|
-
"description": "Disabled channels for this integration"
|
|
2138
|
-
},
|
|
2139
|
-
"id": {
|
|
2140
|
-
"type": "string",
|
|
2141
|
-
"minLength": 28,
|
|
2142
|
-
"maxLength": 36,
|
|
2143
|
-
"description": "ID of the [Integration](#schema_integration)"
|
|
2144
|
-
},
|
|
2145
|
-
"createdAt": {
|
|
2146
|
-
"type": "string",
|
|
2147
|
-
"format": "date-time",
|
|
2148
|
-
"description": "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
2149
|
-
},
|
|
2150
|
-
"updatedAt": {
|
|
2151
|
-
"type": "string",
|
|
2152
|
-
"format": "date-time",
|
|
2153
|
-
"description": "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
2154
|
-
},
|
|
2155
|
-
"title": {
|
|
2156
|
-
"type": "string",
|
|
2157
|
-
"minLength": 1,
|
|
2158
|
-
"maxLength": 64,
|
|
2159
|
-
"description": "Title of the integration. This is the name that will be displayed in the UI"
|
|
2160
|
-
},
|
|
2161
|
-
"description": {
|
|
2162
|
-
"type": "string",
|
|
2163
|
-
"maxLength": 256,
|
|
2164
|
-
"description": "Description of the integration. This is the description that will be displayed in the UI"
|
|
2165
|
-
},
|
|
2166
|
-
"iconUrl": {
|
|
2167
|
-
"type": "string",
|
|
2168
|
-
"description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
|
|
2169
|
-
},
|
|
2170
|
-
"public": {
|
|
2171
|
-
"type": "boolean",
|
|
2172
|
-
"description": "[DEPRECATED] Indicates whether the integration is public. Please use the \"visibility\" parameter instead.",
|
|
2173
|
-
"deprecated": true
|
|
2174
|
-
},
|
|
2175
|
-
"visibility": {
|
|
2176
|
-
"type": "string",
|
|
2177
|
-
"enum": [
|
|
2178
|
-
"public",
|
|
2179
|
-
"private",
|
|
2180
|
-
"unlisted"
|
|
2181
|
-
],
|
|
2182
|
-
"description": "The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them."
|
|
2183
|
-
},
|
|
2184
|
-
"verificationStatus": {
|
|
2185
|
-
"type": "string",
|
|
2186
|
-
"enum": [
|
|
2187
|
-
"unapproved",
|
|
2188
|
-
"pending",
|
|
2189
|
-
"approved",
|
|
2190
|
-
"rejected"
|
|
2191
|
-
],
|
|
2192
|
-
"description": "Status of the integration version verification"
|
|
2193
|
-
}
|
|
2194
|
-
},
|
|
2195
|
-
"required": [
|
|
2196
|
-
"enabled",
|
|
2197
|
-
"name",
|
|
2198
|
-
"version",
|
|
2199
|
-
"webhookUrl",
|
|
2200
|
-
"webhookId",
|
|
2201
|
-
"configurationType",
|
|
2202
|
-
"configuration",
|
|
2203
|
-
"status",
|
|
2204
|
-
"statusReason",
|
|
2205
|
-
"disabledChannels",
|
|
2206
|
-
"id",
|
|
2207
|
-
"createdAt",
|
|
2208
|
-
"updatedAt",
|
|
2209
|
-
"title",
|
|
2210
|
-
"description",
|
|
2211
|
-
"iconUrl",
|
|
2212
|
-
"public",
|
|
2213
|
-
"visibility",
|
|
2214
|
-
"verificationStatus"
|
|
2215
|
-
],
|
|
2216
|
-
"additionalProperties": false
|
|
2217
|
-
},
|
|
2218
|
-
"description": "A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids."
|
|
2219
|
-
},
|
|
2220
|
-
"plugins": {
|
|
2221
|
-
"type": "object",
|
|
2222
|
-
"additionalProperties": {
|
|
2223
|
-
"type": "object",
|
|
2224
|
-
"properties": {
|
|
2225
|
-
"enabled": {
|
|
2226
|
-
"type": "boolean"
|
|
2227
|
-
},
|
|
2228
|
-
"name": {
|
|
2229
|
-
"type": "string",
|
|
2230
|
-
"maxLength": 200,
|
|
2231
|
-
"description": "Name of the [Plugin](#schema_plugin)"
|
|
2232
|
-
},
|
|
2233
|
-
"version": {
|
|
2234
|
-
"type": "string",
|
|
2235
|
-
"maxLength": 200,
|
|
2236
|
-
"description": "Version of the [Plugin](#schema_plugin)"
|
|
2237
|
-
},
|
|
2238
|
-
"configuration": {
|
|
2239
|
-
"type": "object",
|
|
2240
|
-
"additionalProperties": true
|
|
2241
|
-
},
|
|
2242
|
-
"interfaces": {
|
|
2243
|
-
"type": "object",
|
|
2244
|
-
"additionalProperties": {
|
|
2245
|
-
"type": "object",
|
|
2246
|
-
"properties": {
|
|
2247
|
-
"integrationId": {
|
|
2248
|
-
"type": "string",
|
|
2249
|
-
"minLength": 28,
|
|
2250
|
-
"maxLength": 36
|
|
2251
|
-
},
|
|
2252
|
-
"integrationAlias": {
|
|
2253
|
-
"type": "string",
|
|
2254
|
-
"maxLength": 200
|
|
2255
|
-
},
|
|
2256
|
-
"integrationInterfaceAlias": {
|
|
2257
|
-
"type": "string",
|
|
2258
|
-
"maxLength": 200
|
|
2259
|
-
},
|
|
2260
|
-
"interfaceId": {
|
|
2261
|
-
"type": "string",
|
|
2262
|
-
"minLength": 28,
|
|
2263
|
-
"maxLength": 36
|
|
2264
|
-
}
|
|
2265
|
-
},
|
|
2266
|
-
"required": [
|
|
2267
|
-
"integrationId",
|
|
2268
|
-
"integrationAlias",
|
|
2269
|
-
"interfaceId"
|
|
2270
|
-
],
|
|
2271
|
-
"additionalProperties": false
|
|
2272
|
-
},
|
|
2273
|
-
"description": "A mapping of plugin interface aliases to their backing integrations"
|
|
2274
|
-
},
|
|
2275
|
-
"integrations": {
|
|
2276
|
-
"type": "object",
|
|
2277
|
-
"additionalProperties": {
|
|
2278
|
-
"type": "object",
|
|
2279
|
-
"properties": {
|
|
2280
|
-
"integrationId": {
|
|
2281
|
-
"type": "string",
|
|
2282
|
-
"minLength": 28,
|
|
2283
|
-
"maxLength": 36
|
|
2284
|
-
},
|
|
2285
|
-
"integrationAlias": {
|
|
2286
|
-
"type": "string",
|
|
2287
|
-
"maxLength": 200
|
|
2288
|
-
}
|
|
2289
|
-
},
|
|
2290
|
-
"required": [
|
|
2291
|
-
"integrationId",
|
|
2292
|
-
"integrationAlias"
|
|
2293
|
-
],
|
|
2294
|
-
"additionalProperties": false
|
|
2295
|
-
},
|
|
2296
|
-
"description": "A mapping of plugin integration aliases to their backing integrations"
|
|
2297
|
-
},
|
|
2298
|
-
"id": {
|
|
2299
|
-
"type": "string",
|
|
2300
|
-
"minLength": 28,
|
|
2301
|
-
"maxLength": 36,
|
|
2302
|
-
"description": "ID of the [Plugin](#schema_plugin)"
|
|
2303
|
-
},
|
|
2304
|
-
"createdAt": {
|
|
2305
|
-
"type": "string",
|
|
2306
|
-
"format": "date-time",
|
|
2307
|
-
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
2308
|
-
},
|
|
2309
|
-
"updatedAt": {
|
|
2310
|
-
"type": "string",
|
|
2311
|
-
"format": "date-time",
|
|
2312
|
-
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
2313
|
-
},
|
|
2314
|
-
"title": {
|
|
2315
|
-
"type": "string",
|
|
2316
|
-
"minLength": 1,
|
|
2317
|
-
"maxLength": 64,
|
|
2318
|
-
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
2319
|
-
},
|
|
2320
|
-
"description": {
|
|
2321
|
-
"type": "string",
|
|
2322
|
-
"maxLength": 256,
|
|
2323
|
-
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
2324
|
-
},
|
|
2325
|
-
"iconUrl": {
|
|
2326
|
-
"type": "string",
|
|
2327
|
-
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
2328
|
-
},
|
|
2329
|
-
"readmeUrl": {
|
|
2330
|
-
"type": "string",
|
|
2331
|
-
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
2332
|
-
},
|
|
2333
|
-
"public": {
|
|
2334
|
-
"type": "boolean",
|
|
2335
|
-
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
2336
|
-
}
|
|
2337
|
-
},
|
|
2338
|
-
"required": [
|
|
2339
|
-
"enabled",
|
|
2340
|
-
"name",
|
|
2341
|
-
"version",
|
|
2342
|
-
"configuration",
|
|
2343
|
-
"id",
|
|
2344
|
-
"createdAt",
|
|
2345
|
-
"updatedAt",
|
|
2346
|
-
"title",
|
|
2347
|
-
"description",
|
|
2348
|
-
"iconUrl",
|
|
2349
|
-
"readmeUrl",
|
|
2350
|
-
"public"
|
|
2351
|
-
],
|
|
2352
|
-
"additionalProperties": false
|
|
2353
|
-
},
|
|
2354
|
-
"description": "A mapping of plugin aliases to their configuration"
|
|
2355
|
-
},
|
|
2356
|
-
"maxExecutionTime": {
|
|
2357
|
-
"type": "number",
|
|
2358
|
-
"description": "Maximum execution time of the bot (in seconds)."
|
|
2359
|
-
},
|
|
2360
|
-
"user": {
|
|
2361
|
-
"type": "object",
|
|
2362
|
-
"properties": {
|
|
2363
|
-
"tags": {
|
|
2364
|
-
"type": "object",
|
|
2365
|
-
"additionalProperties": {
|
|
2366
|
-
"type": "object",
|
|
2367
|
-
"properties": {
|
|
2368
|
-
"title": {
|
|
2369
|
-
"type": "string",
|
|
2370
|
-
"maxLength": 64,
|
|
2371
|
-
"description": "Title of the tag"
|
|
2372
|
-
},
|
|
2373
|
-
"description": {
|
|
2374
|
-
"type": "string",
|
|
2375
|
-
"maxLength": 256,
|
|
2376
|
-
"description": "Description of the tag"
|
|
2377
|
-
}
|
|
2378
|
-
},
|
|
2379
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
2380
|
-
"additionalProperties": false
|
|
2381
|
-
}
|
|
2382
|
-
}
|
|
2383
|
-
},
|
|
2384
|
-
"required": [
|
|
2385
|
-
"tags"
|
|
2386
|
-
],
|
|
2387
|
-
"description": "User object configuration",
|
|
2388
|
-
"additionalProperties": false
|
|
2389
|
-
},
|
|
2390
|
-
"conversation": {
|
|
2391
|
-
"type": "object",
|
|
2392
|
-
"properties": {
|
|
2393
|
-
"tags": {
|
|
2394
|
-
"type": "object",
|
|
2395
|
-
"additionalProperties": {
|
|
2396
|
-
"type": "object",
|
|
2397
|
-
"properties": {
|
|
2398
|
-
"title": {
|
|
2399
|
-
"type": "string",
|
|
2400
|
-
"maxLength": 64,
|
|
2401
|
-
"description": "Title of the tag"
|
|
2402
|
-
},
|
|
2403
|
-
"description": {
|
|
2404
|
-
"type": "string",
|
|
2405
|
-
"maxLength": 256,
|
|
2406
|
-
"description": "Description of the tag"
|
|
2407
|
-
}
|
|
2408
|
-
},
|
|
2409
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
2410
|
-
"additionalProperties": false
|
|
2411
|
-
}
|
|
2412
|
-
}
|
|
2413
|
-
},
|
|
2414
|
-
"required": [
|
|
2415
|
-
"tags"
|
|
2416
|
-
],
|
|
2417
|
-
"description": "Conversation object configuration",
|
|
2418
|
-
"additionalProperties": false
|
|
2419
|
-
},
|
|
2420
|
-
"message": {
|
|
2421
|
-
"type": "object",
|
|
2422
|
-
"properties": {
|
|
2423
|
-
"tags": {
|
|
2424
|
-
"type": "object",
|
|
2425
|
-
"additionalProperties": {
|
|
2426
|
-
"type": "object",
|
|
2427
|
-
"properties": {
|
|
2428
|
-
"title": {
|
|
2429
|
-
"type": "string",
|
|
2430
|
-
"maxLength": 64,
|
|
2431
|
-
"description": "Title of the tag"
|
|
2432
|
-
},
|
|
2433
|
-
"description": {
|
|
2434
|
-
"type": "string",
|
|
2435
|
-
"maxLength": 256,
|
|
2436
|
-
"description": "Description of the tag"
|
|
2437
|
-
}
|
|
2438
|
-
},
|
|
2439
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
2440
|
-
"additionalProperties": false
|
|
2441
|
-
}
|
|
2442
|
-
}
|
|
2443
|
-
},
|
|
2444
|
-
"required": [
|
|
2445
|
-
"tags"
|
|
2446
|
-
],
|
|
2447
|
-
"description": "Message object configuration",
|
|
2448
|
-
"additionalProperties": false
|
|
2449
|
-
},
|
|
2450
|
-
"states": {
|
|
2451
|
-
"type": "object",
|
|
2452
|
-
"additionalProperties": {
|
|
2453
|
-
"type": "object",
|
|
2454
|
-
"properties": {
|
|
2455
|
-
"type": {
|
|
2456
|
-
"type": "string",
|
|
2457
|
-
"enum": [
|
|
2458
|
-
"conversation",
|
|
2459
|
-
"user",
|
|
2460
|
-
"bot",
|
|
2461
|
-
"task"
|
|
2462
|
-
],
|
|
2463
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
2464
|
-
},
|
|
2465
|
-
"schema": {
|
|
2466
|
-
"type": "object",
|
|
2467
|
-
"additionalProperties": true,
|
|
2468
|
-
"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."
|
|
2469
|
-
},
|
|
2470
|
-
"expiry": {
|
|
2471
|
-
"type": "number",
|
|
2472
|
-
"minimum": 1,
|
|
2473
|
-
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
2474
|
-
}
|
|
2475
|
-
},
|
|
2476
|
-
"required": [
|
|
2477
|
-
"type",
|
|
2478
|
-
"schema"
|
|
2479
|
-
],
|
|
2480
|
-
"additionalProperties": false
|
|
2481
|
-
},
|
|
2482
|
-
"description": "A mapping of states to their definition"
|
|
2483
|
-
},
|
|
2484
|
-
"configuration": {
|
|
2485
|
-
"type": "object",
|
|
2486
|
-
"properties": {
|
|
2487
|
-
"data": {
|
|
2488
|
-
"type": "object",
|
|
2489
|
-
"additionalProperties": true,
|
|
2490
|
-
"description": "Configuration data"
|
|
2491
|
-
},
|
|
2492
|
-
"schema": {
|
|
2493
|
-
"type": "object",
|
|
2494
|
-
"additionalProperties": true,
|
|
2495
|
-
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
2496
|
-
}
|
|
2497
|
-
},
|
|
2498
|
-
"required": [
|
|
2499
|
-
"data",
|
|
2500
|
-
"schema"
|
|
2501
|
-
],
|
|
2502
|
-
"description": "Configuration of the bot",
|
|
2503
|
-
"additionalProperties": false
|
|
2504
|
-
},
|
|
2505
|
-
"events": {
|
|
2506
|
-
"type": "object",
|
|
2507
|
-
"additionalProperties": {
|
|
2508
|
-
"type": "object",
|
|
2509
|
-
"properties": {
|
|
2510
|
-
"title": {
|
|
2511
|
-
"type": "string",
|
|
2512
|
-
"maxLength": 64,
|
|
2513
|
-
"description": "Title of the event"
|
|
2514
|
-
},
|
|
2515
|
-
"description": {
|
|
2516
|
-
"type": "string",
|
|
2517
|
-
"maxLength": 256,
|
|
2518
|
-
"description": "Description of the event"
|
|
2519
|
-
},
|
|
2520
|
-
"schema": {
|
|
2521
|
-
"type": "object",
|
|
2522
|
-
"additionalProperties": true
|
|
2523
|
-
},
|
|
2524
|
-
"attributes": {
|
|
2525
|
-
"type": "object",
|
|
2526
|
-
"additionalProperties": {
|
|
2527
|
-
"type": "string",
|
|
2528
|
-
"maxLength": 200
|
|
2529
|
-
},
|
|
2530
|
-
"description": "Optional attributes"
|
|
2531
|
-
}
|
|
2532
|
-
},
|
|
2533
|
-
"required": [
|
|
2534
|
-
"schema"
|
|
2535
|
-
],
|
|
2536
|
-
"description": "Event Definition",
|
|
2537
|
-
"additionalProperties": false
|
|
2538
|
-
},
|
|
2539
|
-
"description": "Events definition"
|
|
2540
|
-
},
|
|
2541
|
-
"recurringEvents": {
|
|
2542
|
-
"type": "object",
|
|
2543
|
-
"additionalProperties": {
|
|
2544
|
-
"type": "object",
|
|
2545
|
-
"properties": {
|
|
2546
|
-
"schedule": {
|
|
2547
|
-
"type": "object",
|
|
2548
|
-
"properties": {
|
|
2549
|
-
"cron": {
|
|
2550
|
-
"type": "string",
|
|
2551
|
-
"maxLength": 200
|
|
2552
|
-
}
|
|
2553
|
-
},
|
|
2554
|
-
"required": [
|
|
2555
|
-
"cron"
|
|
2556
|
-
],
|
|
2557
|
-
"additionalProperties": false
|
|
2558
|
-
},
|
|
2559
|
-
"type": {
|
|
2560
|
-
"type": "string",
|
|
2561
|
-
"maxLength": 200
|
|
2562
|
-
},
|
|
2563
|
-
"payload": {
|
|
2564
|
-
"type": "object",
|
|
2565
|
-
"additionalProperties": true
|
|
2566
|
-
},
|
|
2567
|
-
"failedAttempts": {
|
|
2568
|
-
"type": "number",
|
|
2569
|
-
"description": "The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully."
|
|
2570
|
-
},
|
|
2571
|
-
"lastFailureReason": {
|
|
2572
|
-
"type": "string",
|
|
2573
|
-
"maxLength": 2000,
|
|
2574
|
-
"description": "The reason why the recurring event failed to run in the last attempt.",
|
|
2575
|
-
"nullable": true
|
|
2576
|
-
}
|
|
2577
|
-
},
|
|
2578
|
-
"required": [
|
|
2579
|
-
"schedule",
|
|
2580
|
-
"type",
|
|
2581
|
-
"payload",
|
|
2582
|
-
"failedAttempts",
|
|
2583
|
-
"lastFailureReason"
|
|
2584
|
-
],
|
|
2585
|
-
"additionalProperties": false
|
|
2586
|
-
},
|
|
2587
|
-
"description": "Recurring events"
|
|
2588
|
-
},
|
|
2589
|
-
"subscriptions": {
|
|
2590
|
-
"type": "object",
|
|
2591
|
-
"properties": {
|
|
2592
|
-
"events": {
|
|
2593
|
-
"type": "object",
|
|
2594
|
-
"additionalProperties": {
|
|
2595
|
-
"type": "object",
|
|
2596
|
-
"additionalProperties": false
|
|
2597
|
-
},
|
|
2598
|
-
"nullable": true,
|
|
2599
|
-
"description": "Events that the bot is currently subscribed on (ex: \"slack:reactionAdded\"). If null, the bot is subscribed to all events."
|
|
2600
|
-
}
|
|
2601
|
-
},
|
|
2602
|
-
"required": [
|
|
2603
|
-
"events"
|
|
2604
|
-
],
|
|
2605
|
-
"description": "Subscriptions of the bot",
|
|
2606
|
-
"additionalProperties": false
|
|
2607
|
-
},
|
|
2608
|
-
"actions": {
|
|
2609
|
-
"type": "object",
|
|
2610
|
-
"additionalProperties": {
|
|
2611
|
-
"type": "object",
|
|
2612
|
-
"properties": {
|
|
2613
|
-
"title": {
|
|
2614
|
-
"type": "string",
|
|
2615
|
-
"maxLength": 64,
|
|
2616
|
-
"description": "Title of the action"
|
|
2617
|
-
},
|
|
2618
|
-
"description": {
|
|
2619
|
-
"type": "string",
|
|
2620
|
-
"maxLength": 256,
|
|
2621
|
-
"description": "Description of the action"
|
|
2622
|
-
},
|
|
2623
|
-
"billable": {
|
|
2624
|
-
"type": "boolean"
|
|
2625
|
-
},
|
|
2626
|
-
"cacheable": {
|
|
2627
|
-
"type": "boolean"
|
|
2628
|
-
},
|
|
2629
|
-
"input": {
|
|
2630
|
-
"type": "object",
|
|
2631
|
-
"properties": {
|
|
2632
|
-
"schema": {
|
|
2633
|
-
"type": "object",
|
|
2634
|
-
"additionalProperties": true
|
|
2635
|
-
}
|
|
2636
|
-
},
|
|
2637
|
-
"required": [
|
|
2638
|
-
"schema"
|
|
2639
|
-
],
|
|
2640
|
-
"additionalProperties": false
|
|
2641
|
-
},
|
|
2642
|
-
"output": {
|
|
2643
|
-
"type": "object",
|
|
2644
|
-
"properties": {
|
|
2645
|
-
"schema": {
|
|
2646
|
-
"type": "object",
|
|
2647
|
-
"additionalProperties": true
|
|
2648
|
-
}
|
|
2649
|
-
},
|
|
2650
|
-
"required": [
|
|
2651
|
-
"schema"
|
|
2652
|
-
],
|
|
2653
|
-
"additionalProperties": false
|
|
2654
|
-
},
|
|
2655
|
-
"attributes": {
|
|
2656
|
-
"type": "object",
|
|
2657
|
-
"additionalProperties": {
|
|
2658
|
-
"type": "string",
|
|
2659
|
-
"maxLength": 200
|
|
2660
|
-
},
|
|
2661
|
-
"description": "Optional attributes"
|
|
2662
|
-
}
|
|
2663
|
-
},
|
|
2664
|
-
"required": [
|
|
2665
|
-
"input",
|
|
2666
|
-
"output"
|
|
2667
|
-
],
|
|
2668
|
-
"description": "Action definition",
|
|
2669
|
-
"additionalProperties": false
|
|
2670
|
-
},
|
|
2671
|
-
"description": "Actions definition"
|
|
2672
|
-
},
|
|
2673
|
-
"tags": {
|
|
2674
|
-
"type": "object",
|
|
2675
|
-
"additionalProperties": {
|
|
2676
|
-
"type": "string"
|
|
2677
|
-
},
|
|
2678
|
-
"description": "Tags of [Bot](#schema_bot)"
|
|
2679
|
-
},
|
|
2680
|
-
"name": {
|
|
2681
|
-
"type": "string",
|
|
2682
|
-
"description": "Name of the [Bot](#schema_bot)"
|
|
2683
|
-
},
|
|
2684
|
-
"deployedAt": {
|
|
2685
|
-
"type": "string",
|
|
2686
|
-
"format": "date-time",
|
|
2687
|
-
"description": "Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format"
|
|
2688
|
-
},
|
|
2689
|
-
"dev": {
|
|
2690
|
-
"type": "boolean",
|
|
2691
|
-
"description": "Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations"
|
|
2692
|
-
},
|
|
2693
|
-
"createdBy": {
|
|
2694
|
-
"type": "string",
|
|
2695
|
-
"description": "Id of the user that created the bot"
|
|
2696
|
-
},
|
|
2697
|
-
"alwaysAlive": {
|
|
2698
|
-
"type": "boolean",
|
|
2699
|
-
"description": "Indicates if the [Bot](#schema_bot) should be in always alive mode"
|
|
2700
|
-
},
|
|
2701
|
-
"status": {
|
|
2702
|
-
"type": "string",
|
|
2703
|
-
"enum": [
|
|
2704
|
-
"active",
|
|
2705
|
-
"deploying"
|
|
2706
|
-
],
|
|
2707
|
-
"description": "Status of the bot"
|
|
2708
|
-
},
|
|
2709
|
-
"medias": {
|
|
2710
|
-
"type": "array",
|
|
2711
|
-
"items": {
|
|
2712
|
-
"type": "object",
|
|
2713
|
-
"properties": {
|
|
2714
|
-
"url": {
|
|
2715
|
-
"type": "string",
|
|
2716
|
-
"description": "URL of the media file"
|
|
2717
|
-
},
|
|
2718
|
-
"name": {
|
|
2719
|
-
"type": "string",
|
|
2720
|
-
"description": "Name of the media file"
|
|
2721
|
-
}
|
|
2722
|
-
},
|
|
2723
|
-
"required": [
|
|
2724
|
-
"url",
|
|
2725
|
-
"name"
|
|
2726
|
-
]
|
|
2727
|
-
},
|
|
2728
|
-
"description": "Media files associated with the [Bot](#schema_bot)"
|
|
2729
|
-
}
|
|
2730
|
-
},
|
|
2731
|
-
"required": [
|
|
2732
|
-
"id",
|
|
2733
|
-
"createdAt",
|
|
2734
|
-
"updatedAt",
|
|
2735
|
-
"signingSecret",
|
|
2736
|
-
"integrations",
|
|
2737
|
-
"plugins",
|
|
2738
|
-
"user",
|
|
2739
|
-
"conversation",
|
|
2740
|
-
"message",
|
|
2741
|
-
"states",
|
|
2742
|
-
"configuration",
|
|
2743
|
-
"events",
|
|
2744
|
-
"recurringEvents",
|
|
2745
|
-
"subscriptions",
|
|
2746
|
-
"actions",
|
|
2747
|
-
"tags",
|
|
2748
|
-
"name",
|
|
2749
|
-
"dev",
|
|
2750
|
-
"alwaysAlive",
|
|
2751
|
-
"status",
|
|
2752
|
-
"medias"
|
|
2753
|
-
],
|
|
2754
|
-
"additionalProperties": false
|
|
2755
|
-
}
|
|
2756
|
-
},
|
|
2757
|
-
"Integration": {
|
|
2758
|
-
"section": "integration",
|
|
2759
|
-
"schema": {
|
|
2760
|
-
"type": "object",
|
|
2761
|
-
"properties": {
|
|
2762
|
-
"id": {
|
|
2763
|
-
"type": "string",
|
|
2764
|
-
"minLength": 28,
|
|
2765
|
-
"maxLength": 36,
|
|
2766
|
-
"description": "ID of the [Integration](#schema_integration)"
|
|
2767
|
-
},
|
|
2768
|
-
"createdAt": {
|
|
2769
|
-
"type": "string",
|
|
2770
|
-
"format": "date-time",
|
|
2771
|
-
"description": "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
2772
|
-
},
|
|
2773
|
-
"updatedAt": {
|
|
2774
|
-
"type": "string",
|
|
2775
|
-
"format": "date-time",
|
|
2776
|
-
"description": "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
|
|
2777
|
-
},
|
|
2778
|
-
"identifier": {
|
|
2779
|
-
"type": "object",
|
|
2780
|
-
"properties": {
|
|
2781
|
-
"fallbackHandlerScript": {
|
|
2782
|
-
"type": "string",
|
|
2783
|
-
"maxLength": 2000,
|
|
2784
|
-
"description": "VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier"
|
|
2785
|
-
},
|
|
2786
|
-
"extractScript": {
|
|
2787
|
-
"type": "string",
|
|
2788
|
-
"maxLength": 2000,
|
|
2789
|
-
"description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth"
|
|
2790
|
-
}
|
|
2791
|
-
},
|
|
2792
|
-
"description": "Global identifier configuration of the [Integration](#schema_integration)",
|
|
2793
|
-
"additionalProperties": false
|
|
2794
|
-
},
|
|
2795
|
-
"sandbox": {
|
|
2796
|
-
"type": "object",
|
|
2797
|
-
"properties": {
|
|
2798
|
-
"identifierExtractScript": {
|
|
2799
|
-
"type": "string",
|
|
2800
|
-
"maxLength": 2000,
|
|
2801
|
-
"description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox"
|
|
2802
|
-
},
|
|
2803
|
-
"messageExtractScript": {
|
|
2804
|
-
"type": "string",
|
|
2805
|
-
"maxLength": 2000,
|
|
2806
|
-
"description": "VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox"
|
|
2807
|
-
}
|
|
2808
|
-
},
|
|
2809
|
-
"additionalProperties": false
|
|
2810
|
-
},
|
|
2811
|
-
"maxExecutionTime": {
|
|
2812
|
-
"type": "number",
|
|
2813
|
-
"description": "Maximum execution time of the integration (in seconds)."
|
|
2814
|
-
},
|
|
2815
|
-
"url": {
|
|
2816
|
-
"type": "string",
|
|
2817
|
-
"maxLength": 2000,
|
|
2818
|
-
"description": "URL of the [Integration](#schema_integration)"
|
|
2819
|
-
},
|
|
2820
|
-
"name": {
|
|
2821
|
-
"type": "string",
|
|
2822
|
-
"maxLength": 200,
|
|
2823
|
-
"description": "Name of the [Integration](#schema_integration)"
|
|
2824
|
-
},
|
|
2825
|
-
"version": {
|
|
2826
|
-
"type": "string",
|
|
2827
|
-
"maxLength": 200,
|
|
2828
|
-
"description": "Version of the [Integration](#schema_integration)"
|
|
2829
|
-
},
|
|
2830
|
-
"interfaces": {
|
|
2831
|
-
"type": "object",
|
|
2832
|
-
"additionalProperties": {
|
|
2833
|
-
"type": "object",
|
|
2834
|
-
"properties": {
|
|
2835
|
-
"id": {
|
|
2836
|
-
"type": "string",
|
|
2837
|
-
"minLength": 28,
|
|
2838
|
-
"maxLength": 36,
|
|
2839
|
-
"description": "ID of the interface"
|
|
2840
|
-
},
|
|
2841
|
-
"name": {
|
|
2842
|
-
"type": "string",
|
|
2843
|
-
"maxLength": 200,
|
|
2844
|
-
"description": "Name of the interface"
|
|
2845
|
-
},
|
|
2846
|
-
"version": {
|
|
2847
|
-
"type": "string",
|
|
2848
|
-
"maxLength": 200,
|
|
2849
|
-
"description": "Version of the interface"
|
|
2850
|
-
},
|
|
2851
|
-
"entities": {
|
|
2852
|
-
"type": "object",
|
|
2853
|
-
"additionalProperties": {
|
|
2854
|
-
"type": "object",
|
|
2855
|
-
"properties": {
|
|
2856
|
-
"name": {
|
|
2857
|
-
"type": "string",
|
|
2858
|
-
"maxLength": 200
|
|
2859
|
-
}
|
|
2860
|
-
},
|
|
2861
|
-
"required": [
|
|
2862
|
-
"name"
|
|
2863
|
-
],
|
|
2864
|
-
"additionalProperties": false
|
|
2865
|
-
}
|
|
2866
|
-
},
|
|
2867
|
-
"actions": {
|
|
2868
|
-
"type": "object",
|
|
2869
|
-
"additionalProperties": {
|
|
2870
|
-
"type": "object",
|
|
2871
|
-
"properties": {
|
|
2872
|
-
"name": {
|
|
2873
|
-
"type": "string",
|
|
2874
|
-
"maxLength": 200
|
|
2875
|
-
}
|
|
2876
|
-
},
|
|
2877
|
-
"required": [
|
|
2878
|
-
"name"
|
|
2879
|
-
],
|
|
2880
|
-
"additionalProperties": false
|
|
2881
|
-
}
|
|
2882
|
-
},
|
|
2883
|
-
"events": {
|
|
2884
|
-
"type": "object",
|
|
2885
|
-
"additionalProperties": {
|
|
2886
|
-
"type": "object",
|
|
2887
|
-
"properties": {
|
|
2888
|
-
"name": {
|
|
2889
|
-
"type": "string",
|
|
2890
|
-
"maxLength": 200
|
|
2891
|
-
}
|
|
2892
|
-
},
|
|
2893
|
-
"required": [
|
|
2894
|
-
"name"
|
|
2895
|
-
],
|
|
2896
|
-
"additionalProperties": false
|
|
2897
|
-
}
|
|
2898
|
-
},
|
|
2899
|
-
"channels": {
|
|
2900
|
-
"type": "object",
|
|
2901
|
-
"additionalProperties": {
|
|
2902
|
-
"type": "object",
|
|
2903
|
-
"properties": {
|
|
2904
|
-
"name": {
|
|
2905
|
-
"type": "string",
|
|
2906
|
-
"maxLength": 200
|
|
2907
|
-
}
|
|
2908
|
-
},
|
|
2909
|
-
"required": [
|
|
2910
|
-
"name"
|
|
2911
|
-
],
|
|
2912
|
-
"additionalProperties": false
|
|
2913
|
-
}
|
|
2914
|
-
}
|
|
2915
|
-
},
|
|
2916
|
-
"required": [
|
|
2917
|
-
"id",
|
|
2918
|
-
"name",
|
|
2919
|
-
"version",
|
|
2920
|
-
"entities",
|
|
2921
|
-
"actions",
|
|
2922
|
-
"events",
|
|
2923
|
-
"channels"
|
|
2924
|
-
],
|
|
2925
|
-
"additionalProperties": false
|
|
2926
|
-
}
|
|
2927
|
-
},
|
|
2928
|
-
"configuration": {
|
|
2929
|
-
"type": "object",
|
|
2930
|
-
"properties": {
|
|
2931
|
-
"title": {
|
|
2932
|
-
"type": "string",
|
|
2933
|
-
"maxLength": 64,
|
|
2934
|
-
"description": "Title of the configuration"
|
|
2935
|
-
},
|
|
2936
|
-
"description": {
|
|
2937
|
-
"type": "string",
|
|
2938
|
-
"maxLength": 256,
|
|
2939
|
-
"description": "Description of the configuration"
|
|
2940
|
-
},
|
|
2941
|
-
"identifier": {
|
|
2942
|
-
"type": "object",
|
|
2943
|
-
"properties": {
|
|
2944
|
-
"linkTemplateScript": {
|
|
2945
|
-
"type": "string",
|
|
2946
|
-
"maxLength": 2000
|
|
2947
|
-
},
|
|
2948
|
-
"required": {
|
|
2949
|
-
"type": "boolean"
|
|
2950
|
-
}
|
|
2951
|
-
},
|
|
2952
|
-
"required": [
|
|
2953
|
-
"required"
|
|
2954
|
-
],
|
|
2955
|
-
"description": "Identifier configuration of the [Integration](#schema_integration)",
|
|
2956
|
-
"additionalProperties": false
|
|
2957
|
-
},
|
|
2958
|
-
"schema": {
|
|
2959
|
-
"type": "object",
|
|
2960
|
-
"additionalProperties": true,
|
|
2961
|
-
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
2962
|
-
}
|
|
2963
|
-
},
|
|
2964
|
-
"required": [
|
|
2965
|
-
"identifier",
|
|
2966
|
-
"schema"
|
|
2967
|
-
],
|
|
2968
|
-
"description": "Configuration definition",
|
|
2969
|
-
"additionalProperties": false
|
|
2970
|
-
},
|
|
2971
|
-
"configurations": {
|
|
2972
|
-
"type": "object",
|
|
2973
|
-
"additionalProperties": {
|
|
2974
|
-
"type": "object",
|
|
2975
|
-
"properties": {
|
|
2976
|
-
"title": {
|
|
2977
|
-
"type": "string",
|
|
2978
|
-
"maxLength": 64,
|
|
2979
|
-
"description": "Title of the configuration"
|
|
2980
|
-
},
|
|
2981
|
-
"description": {
|
|
2982
|
-
"type": "string",
|
|
2983
|
-
"maxLength": 256,
|
|
2984
|
-
"description": "Description of the configuration"
|
|
2985
|
-
},
|
|
2986
|
-
"identifier": {
|
|
2987
|
-
"type": "object",
|
|
2988
|
-
"properties": {
|
|
2989
|
-
"linkTemplateScript": {
|
|
2990
|
-
"type": "string",
|
|
2991
|
-
"maxLength": 2000
|
|
2992
|
-
},
|
|
2993
|
-
"required": {
|
|
2994
|
-
"type": "boolean"
|
|
2995
|
-
}
|
|
2996
|
-
},
|
|
2997
|
-
"required": [
|
|
2998
|
-
"required"
|
|
2999
|
-
],
|
|
3000
|
-
"description": "Identifier configuration of the [Integration](#schema_integration)",
|
|
3001
|
-
"additionalProperties": false
|
|
3002
|
-
},
|
|
3003
|
-
"schema": {
|
|
3004
|
-
"type": "object",
|
|
3005
|
-
"additionalProperties": true,
|
|
3006
|
-
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
3007
|
-
}
|
|
3008
|
-
},
|
|
3009
|
-
"required": [
|
|
3010
|
-
"identifier",
|
|
3011
|
-
"schema"
|
|
3012
|
-
],
|
|
3013
|
-
"description": "Configuration definition",
|
|
3014
|
-
"additionalProperties": false
|
|
3015
|
-
}
|
|
3016
|
-
},
|
|
3017
|
-
"channels": {
|
|
3018
|
-
"type": "object",
|
|
3019
|
-
"additionalProperties": {
|
|
3020
|
-
"type": "object",
|
|
3021
|
-
"properties": {
|
|
3022
|
-
"title": {
|
|
3023
|
-
"type": "string",
|
|
3024
|
-
"maxLength": 64,
|
|
3025
|
-
"description": "Title of the channel"
|
|
3026
|
-
},
|
|
3027
|
-
"description": {
|
|
3028
|
-
"type": "string",
|
|
3029
|
-
"maxLength": 256,
|
|
3030
|
-
"description": "Description of the channel"
|
|
3031
|
-
},
|
|
3032
|
-
"messages": {
|
|
3033
|
-
"type": "object",
|
|
3034
|
-
"additionalProperties": {
|
|
3035
|
-
"type": "object",
|
|
3036
|
-
"properties": {
|
|
3037
|
-
"schema": {
|
|
3038
|
-
"type": "object",
|
|
3039
|
-
"additionalProperties": true
|
|
3040
|
-
}
|
|
3041
|
-
},
|
|
3042
|
-
"required": [
|
|
3043
|
-
"schema"
|
|
3044
|
-
],
|
|
3045
|
-
"description": "Message definition",
|
|
3046
|
-
"additionalProperties": false
|
|
3047
|
-
}
|
|
3048
|
-
},
|
|
3049
|
-
"conversation": {
|
|
3050
|
-
"type": "object",
|
|
3051
|
-
"properties": {
|
|
3052
|
-
"tags": {
|
|
3053
|
-
"type": "object",
|
|
3054
|
-
"additionalProperties": {
|
|
3055
|
-
"type": "object",
|
|
3056
|
-
"properties": {
|
|
3057
|
-
"title": {
|
|
3058
|
-
"type": "string",
|
|
3059
|
-
"maxLength": 64,
|
|
3060
|
-
"description": "Title of the tag"
|
|
3061
|
-
},
|
|
3062
|
-
"description": {
|
|
3063
|
-
"type": "string",
|
|
3064
|
-
"maxLength": 256,
|
|
3065
|
-
"description": "Description of the tag"
|
|
3066
|
-
}
|
|
3067
|
-
},
|
|
3068
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
3069
|
-
"additionalProperties": false
|
|
3070
|
-
}
|
|
3071
|
-
},
|
|
3072
|
-
"creation": {
|
|
3073
|
-
"type": "object",
|
|
3074
|
-
"properties": {
|
|
3075
|
-
"enabled": {
|
|
3076
|
-
"type": "boolean",
|
|
3077
|
-
"description": "Enable conversation creation"
|
|
3078
|
-
},
|
|
3079
|
-
"requiredTags": {
|
|
3080
|
-
"type": "array",
|
|
3081
|
-
"items": {
|
|
3082
|
-
"type": "string"
|
|
3083
|
-
},
|
|
3084
|
-
"description": "The list of tags that are required to be specified when calling the API directly to create a conversation."
|
|
3085
|
-
}
|
|
3086
|
-
},
|
|
3087
|
-
"required": [
|
|
3088
|
-
"enabled",
|
|
3089
|
-
"requiredTags"
|
|
3090
|
-
],
|
|
3091
|
-
"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.",
|
|
3092
|
-
"additionalProperties": false
|
|
3093
|
-
}
|
|
3094
|
-
},
|
|
3095
|
-
"required": [
|
|
3096
|
-
"tags",
|
|
3097
|
-
"creation"
|
|
3098
|
-
],
|
|
3099
|
-
"description": "Conversation object configuration",
|
|
3100
|
-
"additionalProperties": false
|
|
3101
|
-
},
|
|
3102
|
-
"message": {
|
|
3103
|
-
"type": "object",
|
|
3104
|
-
"properties": {
|
|
3105
|
-
"tags": {
|
|
3106
|
-
"type": "object",
|
|
3107
|
-
"additionalProperties": {
|
|
3108
|
-
"type": "object",
|
|
3109
|
-
"properties": {
|
|
3110
|
-
"title": {
|
|
3111
|
-
"type": "string",
|
|
3112
|
-
"maxLength": 64,
|
|
3113
|
-
"description": "Title of the tag"
|
|
3114
|
-
},
|
|
3115
|
-
"description": {
|
|
3116
|
-
"type": "string",
|
|
3117
|
-
"maxLength": 256,
|
|
3118
|
-
"description": "Description of the tag"
|
|
3119
|
-
}
|
|
3120
|
-
},
|
|
3121
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
3122
|
-
"additionalProperties": false
|
|
3123
|
-
}
|
|
3124
|
-
}
|
|
3125
|
-
},
|
|
3126
|
-
"required": [
|
|
3127
|
-
"tags"
|
|
3128
|
-
],
|
|
3129
|
-
"description": "Message object configuration",
|
|
3130
|
-
"additionalProperties": false
|
|
3131
|
-
}
|
|
3132
|
-
},
|
|
3133
|
-
"required": [
|
|
3134
|
-
"messages",
|
|
3135
|
-
"conversation",
|
|
3136
|
-
"message"
|
|
3137
|
-
],
|
|
3138
|
-
"description": "Channel definition",
|
|
3139
|
-
"additionalProperties": false
|
|
3140
|
-
}
|
|
3141
|
-
},
|
|
3142
|
-
"states": {
|
|
3143
|
-
"type": "object",
|
|
3144
|
-
"additionalProperties": {
|
|
3145
|
-
"type": "object",
|
|
3146
|
-
"properties": {
|
|
3147
|
-
"type": {
|
|
3148
|
-
"type": "string",
|
|
3149
|
-
"enum": [
|
|
3150
|
-
"conversation",
|
|
3151
|
-
"user",
|
|
3152
|
-
"integration"
|
|
3153
|
-
],
|
|
3154
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user` or `integration`)"
|
|
3155
|
-
},
|
|
3156
|
-
"schema": {
|
|
3157
|
-
"type": "object",
|
|
3158
|
-
"additionalProperties": true,
|
|
3159
|
-
"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."
|
|
3160
|
-
}
|
|
3161
|
-
},
|
|
3162
|
-
"required": [
|
|
3163
|
-
"type",
|
|
3164
|
-
"schema"
|
|
3165
|
-
],
|
|
3166
|
-
"description": "State definition",
|
|
3167
|
-
"additionalProperties": false
|
|
3168
|
-
}
|
|
3169
|
-
},
|
|
3170
|
-
"events": {
|
|
3171
|
-
"type": "object",
|
|
3172
|
-
"additionalProperties": {
|
|
3173
|
-
"type": "object",
|
|
3174
|
-
"properties": {
|
|
3175
|
-
"title": {
|
|
3176
|
-
"type": "string",
|
|
3177
|
-
"maxLength": 64,
|
|
3178
|
-
"description": "Title of the event"
|
|
3179
|
-
},
|
|
3180
|
-
"description": {
|
|
3181
|
-
"type": "string",
|
|
3182
|
-
"maxLength": 256,
|
|
3183
|
-
"description": "Description of the event"
|
|
3184
|
-
},
|
|
3185
|
-
"schema": {
|
|
3186
|
-
"type": "object",
|
|
3187
|
-
"additionalProperties": true
|
|
3188
|
-
},
|
|
3189
|
-
"attributes": {
|
|
3190
|
-
"type": "object",
|
|
3191
|
-
"additionalProperties": {
|
|
3192
|
-
"type": "string",
|
|
3193
|
-
"maxLength": 200
|
|
3194
|
-
},
|
|
3195
|
-
"description": "Optional attributes"
|
|
3196
|
-
}
|
|
3197
|
-
},
|
|
3198
|
-
"required": [
|
|
3199
|
-
"schema"
|
|
3200
|
-
],
|
|
3201
|
-
"description": "Event Definition",
|
|
3202
|
-
"additionalProperties": false
|
|
3203
|
-
}
|
|
3204
|
-
},
|
|
3205
|
-
"actions": {
|
|
3206
|
-
"type": "object",
|
|
3207
|
-
"additionalProperties": {
|
|
3208
|
-
"type": "object",
|
|
3209
|
-
"properties": {
|
|
3210
|
-
"title": {
|
|
3211
|
-
"type": "string",
|
|
3212
|
-
"maxLength": 64,
|
|
3213
|
-
"description": "Title of the action"
|
|
3214
|
-
},
|
|
3215
|
-
"description": {
|
|
3216
|
-
"type": "string",
|
|
3217
|
-
"maxLength": 256,
|
|
3218
|
-
"description": "Description of the action"
|
|
3219
|
-
},
|
|
3220
|
-
"billable": {
|
|
3221
|
-
"type": "boolean"
|
|
3222
|
-
},
|
|
3223
|
-
"cacheable": {
|
|
3224
|
-
"type": "boolean"
|
|
3225
|
-
},
|
|
3226
|
-
"input": {
|
|
3227
|
-
"type": "object",
|
|
3228
|
-
"properties": {
|
|
3229
|
-
"schema": {
|
|
3230
|
-
"type": "object",
|
|
3231
|
-
"additionalProperties": true
|
|
3232
|
-
}
|
|
3233
|
-
},
|
|
3234
|
-
"required": [
|
|
3235
|
-
"schema"
|
|
3236
|
-
],
|
|
3237
|
-
"additionalProperties": false
|
|
3238
|
-
},
|
|
3239
|
-
"output": {
|
|
3240
|
-
"type": "object",
|
|
3241
|
-
"properties": {
|
|
3242
|
-
"schema": {
|
|
3243
|
-
"type": "object",
|
|
3244
|
-
"additionalProperties": true
|
|
3245
|
-
}
|
|
3246
|
-
},
|
|
3247
|
-
"required": [
|
|
3248
|
-
"schema"
|
|
3249
|
-
],
|
|
3250
|
-
"additionalProperties": false
|
|
3251
|
-
},
|
|
3252
|
-
"attributes": {
|
|
3253
|
-
"type": "object",
|
|
3254
|
-
"additionalProperties": {
|
|
3255
|
-
"type": "string",
|
|
3256
|
-
"maxLength": 200
|
|
3257
|
-
},
|
|
3258
|
-
"description": "Optional attributes"
|
|
3259
|
-
}
|
|
3260
|
-
},
|
|
3261
|
-
"required": [
|
|
3262
|
-
"input",
|
|
3263
|
-
"output"
|
|
3264
|
-
],
|
|
3265
|
-
"description": "Action definition",
|
|
3266
|
-
"additionalProperties": false
|
|
3267
|
-
}
|
|
3268
|
-
},
|
|
3269
|
-
"user": {
|
|
3270
|
-
"type": "object",
|
|
3271
|
-
"properties": {
|
|
3272
|
-
"tags": {
|
|
3273
|
-
"type": "object",
|
|
3274
|
-
"additionalProperties": {
|
|
3275
|
-
"type": "object",
|
|
3276
|
-
"properties": {
|
|
3277
|
-
"title": {
|
|
3278
|
-
"type": "string",
|
|
3279
|
-
"maxLength": 64,
|
|
3280
|
-
"description": "Title of the tag"
|
|
3281
|
-
},
|
|
3282
|
-
"description": {
|
|
3283
|
-
"type": "string",
|
|
3284
|
-
"maxLength": 256,
|
|
3285
|
-
"description": "Description of the tag"
|
|
3286
|
-
}
|
|
3287
|
-
},
|
|
3288
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
3289
|
-
"additionalProperties": false
|
|
3290
|
-
}
|
|
3291
|
-
},
|
|
3292
|
-
"creation": {
|
|
3293
|
-
"type": "object",
|
|
3294
|
-
"properties": {
|
|
3295
|
-
"enabled": {
|
|
3296
|
-
"type": "boolean",
|
|
3297
|
-
"description": "Enable user creation"
|
|
3298
|
-
},
|
|
3299
|
-
"requiredTags": {
|
|
3300
|
-
"type": "array",
|
|
3301
|
-
"items": {
|
|
3302
|
-
"type": "string"
|
|
3303
|
-
},
|
|
3304
|
-
"description": "The list of tags that are required to be specified when calling the API directly to create a user."
|
|
3305
|
-
}
|
|
3306
|
-
},
|
|
3307
|
-
"required": [
|
|
3308
|
-
"enabled",
|
|
3309
|
-
"requiredTags"
|
|
3310
|
-
],
|
|
3311
|
-
"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.",
|
|
3312
|
-
"additionalProperties": false
|
|
3313
|
-
}
|
|
3314
|
-
},
|
|
3315
|
-
"required": [
|
|
3316
|
-
"tags",
|
|
3317
|
-
"creation"
|
|
3318
|
-
],
|
|
3319
|
-
"description": "User object configuration",
|
|
3320
|
-
"additionalProperties": false
|
|
3321
|
-
},
|
|
3322
|
-
"entities": {
|
|
3323
|
-
"type": "object",
|
|
3324
|
-
"additionalProperties": {
|
|
3325
|
-
"type": "object",
|
|
3326
|
-
"properties": {
|
|
3327
|
-
"title": {
|
|
3328
|
-
"type": "string",
|
|
3329
|
-
"maxLength": 64,
|
|
3330
|
-
"description": "Title of the entity"
|
|
3331
|
-
},
|
|
3332
|
-
"description": {
|
|
3333
|
-
"type": "string",
|
|
3334
|
-
"maxLength": 256,
|
|
3335
|
-
"description": "Description of the entity"
|
|
3336
|
-
},
|
|
3337
|
-
"schema": {
|
|
3338
|
-
"type": "object",
|
|
3339
|
-
"additionalProperties": true
|
|
3340
|
-
}
|
|
3341
|
-
},
|
|
3342
|
-
"required": [
|
|
3343
|
-
"schema"
|
|
3344
|
-
],
|
|
3345
|
-
"description": "Entity definition",
|
|
3346
|
-
"additionalProperties": false
|
|
3347
|
-
}
|
|
3348
|
-
},
|
|
3349
|
-
"attributes": {
|
|
3350
|
-
"type": "object",
|
|
3351
|
-
"additionalProperties": {
|
|
3352
|
-
"type": "string",
|
|
3353
|
-
"maxLength": 200
|
|
3354
|
-
},
|
|
3355
|
-
"description": "Optional attributes"
|
|
3356
|
-
},
|
|
3357
|
-
"dev": {
|
|
3358
|
-
"type": "boolean",
|
|
3359
|
-
"description": "Indicates if the integration is a development integration; Dev integrations run locally"
|
|
3360
|
-
},
|
|
3361
|
-
"title": {
|
|
3362
|
-
"type": "string",
|
|
3363
|
-
"minLength": 1,
|
|
3364
|
-
"maxLength": 64,
|
|
3365
|
-
"description": "Title of the integration. This is the name that will be displayed in the UI"
|
|
3366
|
-
},
|
|
3367
|
-
"description": {
|
|
3368
|
-
"type": "string",
|
|
3369
|
-
"maxLength": 256,
|
|
3370
|
-
"description": "Description of the integration. This is the description that will be displayed in the UI"
|
|
3371
|
-
},
|
|
3372
|
-
"iconUrl": {
|
|
3373
|
-
"type": "string",
|
|
3374
|
-
"description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
|
|
3375
|
-
},
|
|
3376
|
-
"readmeUrl": {
|
|
3377
|
-
"type": "string",
|
|
3378
|
-
"description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
|
|
3379
|
-
},
|
|
3380
|
-
"public": {
|
|
3381
|
-
"type": "boolean",
|
|
3382
|
-
"description": "[DEPRECATED] Indicates whether the integration is public. Please use the \"visibility\" parameter instead.",
|
|
3383
|
-
"deprecated": true
|
|
3384
|
-
},
|
|
3385
|
-
"visibility": {
|
|
3386
|
-
"type": "string",
|
|
3387
|
-
"enum": [
|
|
3388
|
-
"public",
|
|
3389
|
-
"private",
|
|
3390
|
-
"unlisted"
|
|
3391
|
-
],
|
|
3392
|
-
"description": "The integration's visibility. Public integrations are available to all and cannot be updated without creating a new version. Unlisted integrations behave identically to public integrations, but they are not listed in the integration hub. By default, integrations are private and only accessible to the workspace that created them."
|
|
3393
|
-
},
|
|
3394
|
-
"verificationStatus": {
|
|
3395
|
-
"type": "string",
|
|
3396
|
-
"enum": [
|
|
3397
|
-
"unapproved",
|
|
3398
|
-
"pending",
|
|
3399
|
-
"approved",
|
|
3400
|
-
"rejected"
|
|
3401
|
-
],
|
|
3402
|
-
"description": "Status of the integration version verification"
|
|
3403
|
-
},
|
|
3404
|
-
"secrets": {
|
|
3405
|
-
"type": "array",
|
|
3406
|
-
"items": {
|
|
3407
|
-
"type": "string"
|
|
3408
|
-
},
|
|
3409
|
-
"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."
|
|
3410
|
-
}
|
|
3411
|
-
},
|
|
3412
|
-
"required": [
|
|
3413
|
-
"id",
|
|
3414
|
-
"createdAt",
|
|
3415
|
-
"updatedAt",
|
|
3416
|
-
"identifier",
|
|
3417
|
-
"url",
|
|
3418
|
-
"name",
|
|
3419
|
-
"version",
|
|
3420
|
-
"interfaces",
|
|
3421
|
-
"configuration",
|
|
3422
|
-
"configurations",
|
|
3423
|
-
"channels",
|
|
3424
|
-
"states",
|
|
3425
|
-
"events",
|
|
3426
|
-
"actions",
|
|
3427
|
-
"user",
|
|
3428
|
-
"entities",
|
|
3429
|
-
"dev",
|
|
3430
|
-
"title",
|
|
3431
|
-
"description",
|
|
3432
|
-
"iconUrl",
|
|
3433
|
-
"readmeUrl",
|
|
3434
|
-
"public",
|
|
3435
|
-
"visibility",
|
|
3436
|
-
"verificationStatus",
|
|
3437
|
-
"secrets"
|
|
3438
|
-
],
|
|
3439
|
-
"additionalProperties": false
|
|
3440
|
-
}
|
|
3441
|
-
},
|
|
3442
|
-
"Interface": {
|
|
3443
|
-
"section": "interface",
|
|
3444
|
-
"schema": {
|
|
3445
|
-
"type": "object",
|
|
3446
|
-
"properties": {
|
|
3447
|
-
"id": {
|
|
3448
|
-
"type": "string",
|
|
3449
|
-
"minLength": 28,
|
|
3450
|
-
"maxLength": 36,
|
|
3451
|
-
"description": "ID of the [Interface](#schema_interface)"
|
|
3452
|
-
},
|
|
3453
|
-
"createdAt": {
|
|
3454
|
-
"type": "string",
|
|
3455
|
-
"format": "date-time",
|
|
3456
|
-
"description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
3457
|
-
},
|
|
3458
|
-
"updatedAt": {
|
|
3459
|
-
"type": "string",
|
|
3460
|
-
"format": "date-time",
|
|
3461
|
-
"description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
|
|
3462
|
-
},
|
|
3463
|
-
"name": {
|
|
3464
|
-
"type": "string",
|
|
3465
|
-
"maxLength": 200,
|
|
3466
|
-
"description": "Name of the [Interface](#schema_interface)"
|
|
3467
|
-
},
|
|
3468
|
-
"version": {
|
|
3469
|
-
"type": "string",
|
|
3470
|
-
"maxLength": 200,
|
|
3471
|
-
"description": "Version of the [Interface](#schema_interface)"
|
|
3472
|
-
},
|
|
3473
|
-
"entities": {
|
|
3474
|
-
"type": "object",
|
|
3475
|
-
"additionalProperties": {
|
|
3476
|
-
"type": "object",
|
|
3477
|
-
"properties": {
|
|
3478
|
-
"title": {
|
|
3479
|
-
"type": "string",
|
|
3480
|
-
"maxLength": 64,
|
|
3481
|
-
"description": "Title of the entity"
|
|
3482
|
-
},
|
|
3483
|
-
"description": {
|
|
3484
|
-
"type": "string",
|
|
3485
|
-
"maxLength": 256,
|
|
3486
|
-
"description": "Description of the entity"
|
|
3487
|
-
},
|
|
3488
|
-
"schema": {
|
|
3489
|
-
"type": "object",
|
|
3490
|
-
"additionalProperties": true
|
|
3491
|
-
}
|
|
3492
|
-
},
|
|
3493
|
-
"required": [
|
|
3494
|
-
"schema"
|
|
3495
|
-
],
|
|
3496
|
-
"description": "Entity definition",
|
|
3497
|
-
"additionalProperties": false
|
|
3498
|
-
}
|
|
3499
|
-
},
|
|
3500
|
-
"events": {
|
|
3501
|
-
"type": "object",
|
|
3502
|
-
"additionalProperties": {
|
|
3503
|
-
"type": "object",
|
|
3504
|
-
"properties": {
|
|
3505
|
-
"title": {
|
|
3506
|
-
"type": "string",
|
|
3507
|
-
"maxLength": 64,
|
|
3508
|
-
"description": "Title of the event"
|
|
3509
|
-
},
|
|
3510
|
-
"description": {
|
|
3511
|
-
"type": "string",
|
|
3512
|
-
"maxLength": 256,
|
|
3513
|
-
"description": "Description of the event"
|
|
3514
|
-
},
|
|
3515
|
-
"schema": {
|
|
3516
|
-
"type": "object",
|
|
3517
|
-
"additionalProperties": true
|
|
3518
|
-
},
|
|
3519
|
-
"attributes": {
|
|
3520
|
-
"type": "object",
|
|
3521
|
-
"additionalProperties": {
|
|
3522
|
-
"type": "string",
|
|
3523
|
-
"maxLength": 200
|
|
3524
|
-
},
|
|
3525
|
-
"description": "Optional attributes"
|
|
3526
|
-
}
|
|
3527
|
-
},
|
|
3528
|
-
"required": [
|
|
3529
|
-
"schema"
|
|
3530
|
-
],
|
|
3531
|
-
"description": "Event Definition",
|
|
3532
|
-
"additionalProperties": false
|
|
3533
|
-
}
|
|
3534
|
-
},
|
|
3535
|
-
"actions": {
|
|
3536
|
-
"type": "object",
|
|
3537
|
-
"additionalProperties": {
|
|
3538
|
-
"type": "object",
|
|
3539
|
-
"properties": {
|
|
3540
|
-
"title": {
|
|
3541
|
-
"type": "string",
|
|
3542
|
-
"maxLength": 64,
|
|
3543
|
-
"description": "Title of the action"
|
|
3544
|
-
},
|
|
3545
|
-
"description": {
|
|
3546
|
-
"type": "string",
|
|
3547
|
-
"maxLength": 256,
|
|
3548
|
-
"description": "Description of the action"
|
|
3549
|
-
},
|
|
3550
|
-
"billable": {
|
|
3551
|
-
"type": "boolean"
|
|
3552
|
-
},
|
|
3553
|
-
"cacheable": {
|
|
3554
|
-
"type": "boolean"
|
|
3555
|
-
},
|
|
3556
|
-
"input": {
|
|
3557
|
-
"type": "object",
|
|
3558
|
-
"properties": {
|
|
3559
|
-
"schema": {
|
|
3560
|
-
"type": "object",
|
|
3561
|
-
"additionalProperties": true
|
|
3562
|
-
}
|
|
3563
|
-
},
|
|
3564
|
-
"required": [
|
|
3565
|
-
"schema"
|
|
3566
|
-
],
|
|
3567
|
-
"additionalProperties": false
|
|
3568
|
-
},
|
|
3569
|
-
"output": {
|
|
3570
|
-
"type": "object",
|
|
3571
|
-
"properties": {
|
|
3572
|
-
"schema": {
|
|
3573
|
-
"type": "object",
|
|
3574
|
-
"additionalProperties": true
|
|
3575
|
-
}
|
|
3576
|
-
},
|
|
3577
|
-
"required": [
|
|
3578
|
-
"schema"
|
|
3579
|
-
],
|
|
3580
|
-
"additionalProperties": false
|
|
3581
|
-
},
|
|
3582
|
-
"attributes": {
|
|
3583
|
-
"type": "object",
|
|
3584
|
-
"additionalProperties": {
|
|
3585
|
-
"type": "string",
|
|
3586
|
-
"maxLength": 200
|
|
3587
|
-
},
|
|
3588
|
-
"description": "Optional attributes"
|
|
3589
|
-
}
|
|
3590
|
-
},
|
|
3591
|
-
"required": [
|
|
3592
|
-
"input",
|
|
3593
|
-
"output"
|
|
3594
|
-
],
|
|
3595
|
-
"description": "Action definition",
|
|
3596
|
-
"additionalProperties": false
|
|
3597
|
-
}
|
|
3598
|
-
},
|
|
3599
|
-
"channels": {
|
|
3600
|
-
"type": "object",
|
|
3601
|
-
"additionalProperties": {
|
|
3602
|
-
"type": "object",
|
|
3603
|
-
"properties": {
|
|
3604
|
-
"title": {
|
|
3605
|
-
"type": "string",
|
|
3606
|
-
"maxLength": 64,
|
|
3607
|
-
"description": "Title of the channel"
|
|
3608
|
-
},
|
|
3609
|
-
"description": {
|
|
3610
|
-
"type": "string",
|
|
3611
|
-
"maxLength": 256,
|
|
3612
|
-
"description": "Description of the channel"
|
|
3613
|
-
},
|
|
3614
|
-
"messages": {
|
|
3615
|
-
"type": "object",
|
|
3616
|
-
"additionalProperties": {
|
|
3617
|
-
"type": "object",
|
|
3618
|
-
"properties": {
|
|
3619
|
-
"schema": {
|
|
3620
|
-
"type": "object",
|
|
3621
|
-
"additionalProperties": true
|
|
3622
|
-
}
|
|
3623
|
-
},
|
|
3624
|
-
"required": [
|
|
3625
|
-
"schema"
|
|
3626
|
-
],
|
|
3627
|
-
"description": "Message definition",
|
|
3628
|
-
"additionalProperties": false
|
|
3629
|
-
}
|
|
3630
|
-
}
|
|
3631
|
-
},
|
|
3632
|
-
"required": [
|
|
3633
|
-
"messages"
|
|
3634
|
-
],
|
|
3635
|
-
"additionalProperties": false
|
|
3636
|
-
}
|
|
3637
|
-
},
|
|
3638
|
-
"nameTemplate": {
|
|
3639
|
-
"type": "object",
|
|
3640
|
-
"properties": {
|
|
3641
|
-
"script": {
|
|
3642
|
-
"type": "string",
|
|
3643
|
-
"maxLength": 2000
|
|
3644
|
-
},
|
|
3645
|
-
"language": {
|
|
3646
|
-
"type": "string",
|
|
3647
|
-
"maxLength": 200
|
|
3648
|
-
}
|
|
3649
|
-
},
|
|
3650
|
-
"required": [
|
|
3651
|
-
"script",
|
|
3652
|
-
"language"
|
|
3653
|
-
],
|
|
3654
|
-
"description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
|
|
3655
|
-
"additionalProperties": false
|
|
3656
|
-
},
|
|
3657
|
-
"attributes": {
|
|
3658
|
-
"type": "object",
|
|
3659
|
-
"additionalProperties": {
|
|
3660
|
-
"type": "string",
|
|
3661
|
-
"maxLength": 200
|
|
3662
|
-
},
|
|
3663
|
-
"description": "Optional attributes"
|
|
3664
|
-
},
|
|
3665
|
-
"title": {
|
|
3666
|
-
"type": "string",
|
|
3667
|
-
"minLength": 1,
|
|
3668
|
-
"maxLength": 64,
|
|
3669
|
-
"description": "Title of the interface. This is the name that will be displayed in the UI"
|
|
3670
|
-
},
|
|
3671
|
-
"description": {
|
|
3672
|
-
"type": "string",
|
|
3673
|
-
"maxLength": 256,
|
|
3674
|
-
"description": "Description of the interface. This is the description that will be displayed in the UI"
|
|
3675
|
-
},
|
|
3676
|
-
"iconUrl": {
|
|
3677
|
-
"type": "string",
|
|
3678
|
-
"description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
|
|
3679
|
-
},
|
|
3680
|
-
"readmeUrl": {
|
|
3681
|
-
"type": "string",
|
|
3682
|
-
"description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
|
|
3683
|
-
},
|
|
3684
|
-
"public": {
|
|
3685
|
-
"type": "boolean",
|
|
3686
|
-
"description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
|
|
3687
|
-
}
|
|
3688
|
-
},
|
|
3689
|
-
"required": [
|
|
3690
|
-
"id",
|
|
3691
|
-
"createdAt",
|
|
3692
|
-
"updatedAt",
|
|
3693
|
-
"name",
|
|
3694
|
-
"version",
|
|
3695
|
-
"entities",
|
|
3696
|
-
"events",
|
|
3697
|
-
"actions",
|
|
3698
|
-
"channels",
|
|
3699
|
-
"title",
|
|
3700
|
-
"description",
|
|
3701
|
-
"iconUrl",
|
|
3702
|
-
"readmeUrl",
|
|
3703
|
-
"public"
|
|
3704
|
-
],
|
|
3705
|
-
"additionalProperties": false
|
|
3706
|
-
}
|
|
3707
|
-
},
|
|
3708
|
-
"Plugin": {
|
|
3709
|
-
"section": "plugin",
|
|
3710
|
-
"schema": {
|
|
3711
|
-
"type": "object",
|
|
3712
|
-
"properties": {
|
|
3713
|
-
"id": {
|
|
3714
|
-
"type": "string",
|
|
3715
|
-
"minLength": 28,
|
|
3716
|
-
"maxLength": 36,
|
|
3717
|
-
"description": "ID of the [Plugin](#schema_plugin)"
|
|
3718
|
-
},
|
|
3719
|
-
"name": {
|
|
3720
|
-
"type": "string",
|
|
3721
|
-
"maxLength": 200,
|
|
3722
|
-
"description": "Name of the [Plugin](#schema_plugin)"
|
|
3723
|
-
},
|
|
3724
|
-
"version": {
|
|
3725
|
-
"type": "string",
|
|
3726
|
-
"maxLength": 200,
|
|
3727
|
-
"description": "Version of the [Plugin](#schema_plugin)"
|
|
3728
|
-
},
|
|
3729
|
-
"createdAt": {
|
|
3730
|
-
"type": "string",
|
|
3731
|
-
"format": "date-time",
|
|
3732
|
-
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
3733
|
-
},
|
|
3734
|
-
"updatedAt": {
|
|
3735
|
-
"type": "string",
|
|
3736
|
-
"format": "date-time",
|
|
3737
|
-
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
3738
|
-
},
|
|
3739
|
-
"configuration": {
|
|
3740
|
-
"type": "object",
|
|
3741
|
-
"properties": {
|
|
3742
|
-
"title": {
|
|
3743
|
-
"type": "string",
|
|
3744
|
-
"maxLength": 64,
|
|
3745
|
-
"description": "Title of the configuration"
|
|
3746
|
-
},
|
|
3747
|
-
"description": {
|
|
3748
|
-
"type": "string",
|
|
3749
|
-
"maxLength": 256,
|
|
3750
|
-
"description": "Description of the configuration"
|
|
3751
|
-
},
|
|
3752
|
-
"schema": {
|
|
3753
|
-
"type": "object",
|
|
3754
|
-
"additionalProperties": true,
|
|
3755
|
-
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
3756
|
-
}
|
|
3757
|
-
},
|
|
3758
|
-
"required": [
|
|
3759
|
-
"schema"
|
|
3760
|
-
],
|
|
3761
|
-
"description": "Configuration definition",
|
|
3762
|
-
"additionalProperties": false
|
|
3763
|
-
},
|
|
3764
|
-
"states": {
|
|
3765
|
-
"type": "object",
|
|
3766
|
-
"additionalProperties": {
|
|
3767
|
-
"type": "object",
|
|
3768
|
-
"properties": {
|
|
3769
|
-
"type": {
|
|
3770
|
-
"type": "string",
|
|
3771
|
-
"enum": [
|
|
3772
|
-
"conversation",
|
|
3773
|
-
"user",
|
|
3774
|
-
"bot",
|
|
3775
|
-
"task"
|
|
3776
|
-
],
|
|
3777
|
-
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
3778
|
-
},
|
|
3779
|
-
"schema": {
|
|
3780
|
-
"type": "object",
|
|
3781
|
-
"additionalProperties": true,
|
|
3782
|
-
"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."
|
|
3783
|
-
},
|
|
3784
|
-
"expiry": {
|
|
3785
|
-
"type": "number",
|
|
3786
|
-
"minimum": 1,
|
|
3787
|
-
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
3788
|
-
}
|
|
3789
|
-
},
|
|
3790
|
-
"required": [
|
|
3791
|
-
"type",
|
|
3792
|
-
"schema"
|
|
3793
|
-
],
|
|
3794
|
-
"additionalProperties": false
|
|
3795
|
-
}
|
|
3796
|
-
},
|
|
3797
|
-
"events": {
|
|
3798
|
-
"type": "object",
|
|
3799
|
-
"additionalProperties": {
|
|
3800
|
-
"type": "object",
|
|
3801
|
-
"properties": {
|
|
3802
|
-
"title": {
|
|
3803
|
-
"type": "string",
|
|
3804
|
-
"maxLength": 64,
|
|
3805
|
-
"description": "Title of the event"
|
|
3806
|
-
},
|
|
3807
|
-
"description": {
|
|
3808
|
-
"type": "string",
|
|
3809
|
-
"maxLength": 256,
|
|
3810
|
-
"description": "Description of the event"
|
|
3811
|
-
},
|
|
3812
|
-
"schema": {
|
|
3813
|
-
"type": "object",
|
|
3814
|
-
"additionalProperties": true
|
|
3815
|
-
},
|
|
3816
|
-
"attributes": {
|
|
3817
|
-
"type": "object",
|
|
3818
|
-
"additionalProperties": {
|
|
3819
|
-
"type": "string",
|
|
3820
|
-
"maxLength": 200
|
|
3821
|
-
},
|
|
3822
|
-
"description": "Optional attributes"
|
|
3823
|
-
}
|
|
3824
|
-
},
|
|
3825
|
-
"required": [
|
|
3826
|
-
"schema"
|
|
3827
|
-
],
|
|
3828
|
-
"description": "Event Definition",
|
|
3829
|
-
"additionalProperties": false
|
|
3830
|
-
}
|
|
3831
|
-
},
|
|
3832
|
-
"actions": {
|
|
3833
|
-
"type": "object",
|
|
3834
|
-
"additionalProperties": {
|
|
3835
|
-
"type": "object",
|
|
3836
|
-
"properties": {
|
|
3837
|
-
"title": {
|
|
3838
|
-
"type": "string",
|
|
3839
|
-
"maxLength": 64,
|
|
3840
|
-
"description": "Title of the action"
|
|
3841
|
-
},
|
|
3842
|
-
"description": {
|
|
3843
|
-
"type": "string",
|
|
3844
|
-
"maxLength": 256,
|
|
3845
|
-
"description": "Description of the action"
|
|
3846
|
-
},
|
|
3847
|
-
"billable": {
|
|
3848
|
-
"type": "boolean"
|
|
3849
|
-
},
|
|
3850
|
-
"cacheable": {
|
|
3851
|
-
"type": "boolean"
|
|
3852
|
-
},
|
|
3853
|
-
"input": {
|
|
3854
|
-
"type": "object",
|
|
3855
|
-
"properties": {
|
|
3856
|
-
"schema": {
|
|
3857
|
-
"type": "object",
|
|
3858
|
-
"additionalProperties": true
|
|
3859
|
-
}
|
|
3860
|
-
},
|
|
3861
|
-
"required": [
|
|
3862
|
-
"schema"
|
|
3863
|
-
],
|
|
3864
|
-
"additionalProperties": false
|
|
3865
|
-
},
|
|
3866
|
-
"output": {
|
|
3867
|
-
"type": "object",
|
|
3868
|
-
"properties": {
|
|
3869
|
-
"schema": {
|
|
3870
|
-
"type": "object",
|
|
3871
|
-
"additionalProperties": true
|
|
3872
|
-
}
|
|
3873
|
-
},
|
|
3874
|
-
"required": [
|
|
3875
|
-
"schema"
|
|
3876
|
-
],
|
|
3877
|
-
"additionalProperties": false
|
|
3878
|
-
},
|
|
3879
|
-
"attributes": {
|
|
3880
|
-
"type": "object",
|
|
3881
|
-
"additionalProperties": {
|
|
3882
|
-
"type": "string",
|
|
3883
|
-
"maxLength": 200
|
|
3884
|
-
},
|
|
3885
|
-
"description": "Optional attributes"
|
|
3886
|
-
}
|
|
3887
|
-
},
|
|
3888
|
-
"required": [
|
|
3889
|
-
"input",
|
|
3890
|
-
"output"
|
|
3891
|
-
],
|
|
3892
|
-
"description": "Action definition",
|
|
3893
|
-
"additionalProperties": false
|
|
3894
|
-
}
|
|
3895
|
-
},
|
|
3896
|
-
"dependencies": {
|
|
3897
|
-
"type": "object",
|
|
3898
|
-
"properties": {
|
|
3899
|
-
"interfaces": {
|
|
3900
|
-
"type": "object",
|
|
3901
|
-
"additionalProperties": {
|
|
3902
|
-
"type": "object",
|
|
3903
|
-
"properties": {
|
|
3904
|
-
"id": {
|
|
3905
|
-
"type": "string",
|
|
3906
|
-
"minLength": 28,
|
|
3907
|
-
"maxLength": 36
|
|
3908
|
-
},
|
|
3909
|
-
"name": {
|
|
3910
|
-
"type": "string",
|
|
3911
|
-
"maxLength": 200
|
|
3912
|
-
},
|
|
3913
|
-
"version": {
|
|
3914
|
-
"type": "string",
|
|
3915
|
-
"maxLength": 200
|
|
3916
|
-
}
|
|
3917
|
-
},
|
|
3918
|
-
"required": [
|
|
3919
|
-
"id",
|
|
3920
|
-
"name",
|
|
3921
|
-
"version"
|
|
3922
|
-
],
|
|
3923
|
-
"additionalProperties": false
|
|
3924
|
-
}
|
|
3925
|
-
},
|
|
3926
|
-
"integrations": {
|
|
3927
|
-
"type": "object",
|
|
3928
|
-
"additionalProperties": {
|
|
3929
|
-
"type": "object",
|
|
3930
|
-
"properties": {
|
|
3931
|
-
"id": {
|
|
3932
|
-
"type": "string",
|
|
3933
|
-
"minLength": 28,
|
|
3934
|
-
"maxLength": 36
|
|
3935
|
-
},
|
|
3936
|
-
"name": {
|
|
3937
|
-
"type": "string",
|
|
3938
|
-
"maxLength": 200
|
|
3939
|
-
},
|
|
3940
|
-
"version": {
|
|
3941
|
-
"type": "string",
|
|
3942
|
-
"maxLength": 200
|
|
3943
|
-
}
|
|
3944
|
-
},
|
|
3945
|
-
"required": [
|
|
3946
|
-
"id",
|
|
3947
|
-
"name",
|
|
3948
|
-
"version"
|
|
3949
|
-
],
|
|
3950
|
-
"additionalProperties": false
|
|
3951
|
-
}
|
|
3952
|
-
}
|
|
3953
|
-
},
|
|
3954
|
-
"required": [
|
|
3955
|
-
"interfaces",
|
|
3956
|
-
"integrations"
|
|
3957
|
-
],
|
|
3958
|
-
"additionalProperties": false
|
|
3959
|
-
},
|
|
3960
|
-
"user": {
|
|
3961
|
-
"type": "object",
|
|
3962
|
-
"properties": {
|
|
3963
|
-
"tags": {
|
|
3964
|
-
"type": "object",
|
|
3965
|
-
"additionalProperties": {
|
|
3966
|
-
"type": "object",
|
|
3967
|
-
"properties": {
|
|
3968
|
-
"title": {
|
|
3969
|
-
"type": "string",
|
|
3970
|
-
"maxLength": 64,
|
|
3971
|
-
"description": "Title of the tag"
|
|
3972
|
-
},
|
|
3973
|
-
"description": {
|
|
3974
|
-
"type": "string",
|
|
3975
|
-
"maxLength": 256,
|
|
3976
|
-
"description": "Description of the tag"
|
|
3977
|
-
}
|
|
3978
|
-
},
|
|
3979
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
3980
|
-
"additionalProperties": false
|
|
3981
|
-
}
|
|
3982
|
-
}
|
|
3983
|
-
},
|
|
3984
|
-
"required": [
|
|
3985
|
-
"tags"
|
|
3986
|
-
],
|
|
3987
|
-
"description": "User object configuration",
|
|
3988
|
-
"additionalProperties": false
|
|
3989
|
-
},
|
|
3990
|
-
"conversation": {
|
|
3991
|
-
"type": "object",
|
|
3992
|
-
"properties": {
|
|
3993
|
-
"tags": {
|
|
3994
|
-
"type": "object",
|
|
3995
|
-
"additionalProperties": {
|
|
3996
|
-
"type": "object",
|
|
3997
|
-
"properties": {
|
|
3998
|
-
"title": {
|
|
3999
|
-
"type": "string",
|
|
4000
|
-
"maxLength": 64,
|
|
4001
|
-
"description": "Title of the tag"
|
|
4002
|
-
},
|
|
4003
|
-
"description": {
|
|
4004
|
-
"type": "string",
|
|
4005
|
-
"maxLength": 256,
|
|
4006
|
-
"description": "Description of the tag"
|
|
4007
|
-
}
|
|
4008
|
-
},
|
|
4009
|
-
"description": "Definition of a tag that can be provided on the object",
|
|
4010
|
-
"additionalProperties": false
|
|
4011
|
-
}
|
|
4012
|
-
}
|
|
4013
|
-
},
|
|
4014
|
-
"required": [
|
|
4015
|
-
"tags"
|
|
4016
|
-
],
|
|
4017
|
-
"description": "Conversation object configuration",
|
|
4018
|
-
"additionalProperties": false
|
|
4019
|
-
},
|
|
4020
|
-
"attributes": {
|
|
4021
|
-
"type": "object",
|
|
4022
|
-
"additionalProperties": {
|
|
4023
|
-
"type": "string",
|
|
4024
|
-
"maxLength": 200
|
|
4025
|
-
},
|
|
4026
|
-
"description": "Optional attributes"
|
|
4027
|
-
},
|
|
4028
|
-
"title": {
|
|
4029
|
-
"type": "string",
|
|
4030
|
-
"minLength": 1,
|
|
4031
|
-
"maxLength": 64,
|
|
4032
|
-
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
4033
|
-
},
|
|
4034
|
-
"description": {
|
|
4035
|
-
"type": "string",
|
|
4036
|
-
"maxLength": 256,
|
|
4037
|
-
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
4038
|
-
},
|
|
4039
|
-
"iconUrl": {
|
|
4040
|
-
"type": "string",
|
|
4041
|
-
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
4042
|
-
},
|
|
4043
|
-
"readmeUrl": {
|
|
4044
|
-
"type": "string",
|
|
4045
|
-
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
4046
|
-
},
|
|
4047
|
-
"public": {
|
|
4048
|
-
"type": "boolean",
|
|
4049
|
-
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
4050
|
-
}
|
|
4051
|
-
},
|
|
4052
|
-
"required": [
|
|
4053
|
-
"id",
|
|
4054
|
-
"name",
|
|
4055
|
-
"version",
|
|
4056
|
-
"createdAt",
|
|
4057
|
-
"updatedAt",
|
|
4058
|
-
"configuration",
|
|
4059
|
-
"states",
|
|
4060
|
-
"events",
|
|
4061
|
-
"actions",
|
|
4062
|
-
"dependencies",
|
|
4063
|
-
"user",
|
|
4064
|
-
"conversation",
|
|
4065
|
-
"title",
|
|
4066
|
-
"description",
|
|
4067
|
-
"iconUrl",
|
|
4068
|
-
"readmeUrl",
|
|
4069
|
-
"public"
|
|
4070
|
-
],
|
|
4071
|
-
"additionalProperties": false
|
|
4072
|
-
}
|
|
4073
|
-
},
|
|
4074
|
-
"Workspace": {
|
|
4075
|
-
"section": "workspace",
|
|
4076
|
-
"schema": {
|
|
4077
|
-
"type": "object",
|
|
4078
|
-
"properties": {
|
|
4079
|
-
"id": {
|
|
4080
|
-
"type": "string"
|
|
4081
|
-
},
|
|
4082
|
-
"name": {
|
|
4083
|
-
"type": "string"
|
|
4084
|
-
},
|
|
4085
|
-
"ownerId": {
|
|
4086
|
-
"type": "string"
|
|
4087
|
-
},
|
|
4088
|
-
"createdAt": {
|
|
4089
|
-
"type": "string"
|
|
4090
|
-
},
|
|
4091
|
-
"updatedAt": {
|
|
4092
|
-
"type": "string"
|
|
4093
|
-
},
|
|
4094
|
-
"botCount": {
|
|
4095
|
-
"type": "number"
|
|
4096
|
-
},
|
|
4097
|
-
"billingVersion": {
|
|
4098
|
-
"type": "string",
|
|
4099
|
-
"enum": [
|
|
4100
|
-
"v1",
|
|
4101
|
-
"v2",
|
|
4102
|
-
"v3"
|
|
4103
|
-
]
|
|
4104
|
-
},
|
|
4105
|
-
"plan": {
|
|
4106
|
-
"type": "string",
|
|
4107
|
-
"enum": [
|
|
4108
|
-
"community",
|
|
4109
|
-
"team",
|
|
4110
|
-
"enterprise",
|
|
4111
|
-
"plus"
|
|
4112
|
-
]
|
|
4113
|
-
},
|
|
4114
|
-
"blocked": {
|
|
4115
|
-
"type": "boolean"
|
|
4116
|
-
},
|
|
4117
|
-
"spendingLimit": {
|
|
4118
|
-
"type": "number"
|
|
4119
|
-
},
|
|
4120
|
-
"about": {
|
|
4121
|
-
"default": "",
|
|
4122
|
-
"type": "string"
|
|
4123
|
-
},
|
|
4124
|
-
"profilePicture": {
|
|
4125
|
-
"default": "",
|
|
4126
|
-
"type": "string"
|
|
4127
|
-
},
|
|
4128
|
-
"contactEmail": {
|
|
4129
|
-
"default": "",
|
|
4130
|
-
"type": "string"
|
|
4131
|
-
},
|
|
4132
|
-
"website": {
|
|
4133
|
-
"default": "",
|
|
4134
|
-
"type": "string"
|
|
4135
|
-
},
|
|
4136
|
-
"socialAccounts": {
|
|
4137
|
-
"default": [],
|
|
4138
|
-
"type": "array",
|
|
4139
|
-
"items": {
|
|
4140
|
-
"type": "string"
|
|
4141
|
-
}
|
|
4142
|
-
},
|
|
4143
|
-
"isPublic": {
|
|
4144
|
-
"type": "boolean"
|
|
4145
|
-
},
|
|
4146
|
-
"handle": {
|
|
4147
|
-
"type": "string"
|
|
4148
|
-
},
|
|
4149
|
-
"activeTrialId": {
|
|
4150
|
-
"type": "string",
|
|
4151
|
-
"nullable": true
|
|
4152
|
-
}
|
|
4153
|
-
},
|
|
4154
|
-
"required": [
|
|
4155
|
-
"id",
|
|
4156
|
-
"name",
|
|
4157
|
-
"ownerId",
|
|
4158
|
-
"createdAt",
|
|
4159
|
-
"updatedAt",
|
|
4160
|
-
"botCount",
|
|
4161
|
-
"billingVersion",
|
|
4162
|
-
"plan",
|
|
4163
|
-
"blocked",
|
|
4164
|
-
"spendingLimit",
|
|
4165
|
-
"activeTrialId"
|
|
4166
|
-
],
|
|
4167
|
-
"title": "updateWorkspaceResponse",
|
|
4168
|
-
"additionalProperties": false
|
|
4169
|
-
}
|
|
4170
|
-
},
|
|
4171
|
-
"WorkspaceMember": {
|
|
4172
|
-
"section": "workspaceMember",
|
|
4173
|
-
"schema": {
|
|
4174
|
-
"type": "object",
|
|
4175
|
-
"properties": {
|
|
4176
|
-
"id": {
|
|
4177
|
-
"type": "string"
|
|
4178
|
-
},
|
|
4179
|
-
"userId": {
|
|
4180
|
-
"type": "string",
|
|
4181
|
-
"format": "uuid"
|
|
4182
|
-
},
|
|
4183
|
-
"email": {
|
|
4184
|
-
"type": "string"
|
|
4185
|
-
},
|
|
4186
|
-
"createdAt": {
|
|
4187
|
-
"type": "string"
|
|
4188
|
-
},
|
|
4189
|
-
"role": {
|
|
4190
|
-
"type": "string",
|
|
4191
|
-
"enum": [
|
|
4192
|
-
"viewer",
|
|
4193
|
-
"billing",
|
|
4194
|
-
"developer",
|
|
4195
|
-
"manager",
|
|
4196
|
-
"administrator",
|
|
4197
|
-
"owner"
|
|
4198
|
-
]
|
|
4199
|
-
},
|
|
4200
|
-
"profilePicture": {
|
|
4201
|
-
"type": "string"
|
|
4202
|
-
},
|
|
4203
|
-
"displayName": {
|
|
4204
|
-
"type": "string",
|
|
4205
|
-
"maxLength": 100
|
|
4206
|
-
}
|
|
4207
|
-
},
|
|
4208
|
-
"required": [
|
|
4209
|
-
"id",
|
|
4210
|
-
"email",
|
|
4211
|
-
"createdAt",
|
|
4212
|
-
"role"
|
|
4213
|
-
],
|
|
4214
|
-
"title": "updateWorkspaceMemberResponse",
|
|
4215
|
-
"additionalProperties": false
|
|
4216
|
-
}
|
|
4217
|
-
},
|
|
4218
|
-
"Account": {
|
|
4219
|
-
"section": "account",
|
|
4220
|
-
"schema": {
|
|
4221
|
-
"type": "object",
|
|
4222
|
-
"properties": {
|
|
4223
|
-
"id": {
|
|
4224
|
-
"type": "string"
|
|
4225
|
-
},
|
|
4226
|
-
"email": {
|
|
4227
|
-
"type": "string"
|
|
4228
|
-
},
|
|
4229
|
-
"displayName": {
|
|
4230
|
-
"type": "string",
|
|
4231
|
-
"maxLength": 100
|
|
4232
|
-
},
|
|
4233
|
-
"emailVerified": {
|
|
4234
|
-
"type": "boolean"
|
|
4235
|
-
},
|
|
4236
|
-
"profilePicture": {
|
|
4237
|
-
"type": "string"
|
|
4238
|
-
},
|
|
4239
|
-
"createdAt": {
|
|
4240
|
-
"type": "string",
|
|
4241
|
-
"format": "date-time",
|
|
4242
|
-
"description": "Creation date of the [Account](#schema_account) in ISO 8601 format"
|
|
4243
|
-
}
|
|
4244
|
-
},
|
|
4245
|
-
"required": [
|
|
4246
|
-
"id",
|
|
4247
|
-
"email",
|
|
4248
|
-
"emailVerified",
|
|
4249
|
-
"createdAt"
|
|
4250
|
-
],
|
|
4251
|
-
"additionalProperties": false
|
|
4252
|
-
}
|
|
4253
|
-
},
|
|
4254
|
-
"Usage": {
|
|
4255
|
-
"section": "usage",
|
|
4256
|
-
"schema": {
|
|
4257
|
-
"type": "object",
|
|
4258
|
-
"properties": {
|
|
4259
|
-
"id": {
|
|
4260
|
-
"type": "string",
|
|
4261
|
-
"description": "Id of the usage that it is linked to. It can either be a workspace id or a bot id"
|
|
4262
|
-
},
|
|
4263
|
-
"period": {
|
|
4264
|
-
"type": "string",
|
|
4265
|
-
"description": "Period of the quota that it is applied to"
|
|
4266
|
-
},
|
|
4267
|
-
"value": {
|
|
4268
|
-
"type": "number",
|
|
4269
|
-
"description": "Value of the current usage"
|
|
4270
|
-
},
|
|
4271
|
-
"quota": {
|
|
4272
|
-
"type": "number",
|
|
4273
|
-
"description": "Quota of the current usage"
|
|
4274
|
-
},
|
|
4275
|
-
"type": {
|
|
4276
|
-
"type": "string",
|
|
4277
|
-
"enum": [
|
|
4278
|
-
"invocation_timeout",
|
|
4279
|
-
"invocation_calls",
|
|
4280
|
-
"storage_count",
|
|
4281
|
-
"bot_count",
|
|
4282
|
-
"knowledgebase_vector_storage",
|
|
4283
|
-
"workspace_ratelimit",
|
|
4284
|
-
"table_row_count",
|
|
4285
|
-
"workspace_member_count",
|
|
4286
|
-
"integrations_owned_count",
|
|
4287
|
-
"ai_spend",
|
|
4288
|
-
"openai_spend",
|
|
4289
|
-
"bing_search_spend",
|
|
4290
|
-
"always_alive"
|
|
4291
|
-
],
|
|
4292
|
-
"description": "Usage type that can be used"
|
|
4293
|
-
}
|
|
4294
|
-
},
|
|
4295
|
-
"required": [
|
|
4296
|
-
"id",
|
|
4297
|
-
"period",
|
|
4298
|
-
"value",
|
|
4299
|
-
"quota",
|
|
4300
|
-
"type"
|
|
4301
|
-
],
|
|
4302
|
-
"additionalProperties": false
|
|
4303
|
-
}
|
|
4304
|
-
},
|
|
4305
|
-
"Issue": {
|
|
4306
|
-
"section": "bot",
|
|
4307
|
-
"schema": {
|
|
4308
|
-
"type": "object",
|
|
4309
|
-
"properties": {
|
|
4310
|
-
"id": {
|
|
4311
|
-
"type": "string"
|
|
4312
|
-
},
|
|
4313
|
-
"code": {
|
|
4314
|
-
"type": "string"
|
|
4315
|
-
},
|
|
4316
|
-
"createdAt": {
|
|
4317
|
-
"type": "string",
|
|
4318
|
-
"format": "date-time"
|
|
4319
|
-
},
|
|
4320
|
-
"lastSeenAt": {
|
|
4321
|
-
"type": "string",
|
|
4322
|
-
"format": "date-time"
|
|
4323
|
-
},
|
|
4324
|
-
"title": {
|
|
4325
|
-
"type": "string"
|
|
4326
|
-
},
|
|
4327
|
-
"description": {
|
|
4328
|
-
"type": "string"
|
|
4329
|
-
},
|
|
4330
|
-
"groupedData": {
|
|
4331
|
-
"type": "object",
|
|
4332
|
-
"additionalProperties": {
|
|
4333
|
-
"type": "object",
|
|
4334
|
-
"properties": {
|
|
4335
|
-
"raw": {
|
|
4336
|
-
"type": "string"
|
|
4337
|
-
},
|
|
4338
|
-
"pretty": {
|
|
4339
|
-
"type": "string"
|
|
4340
|
-
}
|
|
4341
|
-
},
|
|
4342
|
-
"required": [
|
|
4343
|
-
"raw"
|
|
4344
|
-
],
|
|
4345
|
-
"additionalProperties": false
|
|
4346
|
-
}
|
|
4347
|
-
},
|
|
4348
|
-
"eventsCount": {
|
|
4349
|
-
"type": "number"
|
|
4350
|
-
},
|
|
4351
|
-
"category": {
|
|
4352
|
-
"type": "string",
|
|
4353
|
-
"enum": [
|
|
4354
|
-
"user_code",
|
|
4355
|
-
"limits",
|
|
4356
|
-
"configuration",
|
|
4357
|
-
"other"
|
|
4358
|
-
]
|
|
4359
|
-
},
|
|
4360
|
-
"resolutionLink": {
|
|
4361
|
-
"type": "string",
|
|
4362
|
-
"nullable": true
|
|
4363
|
-
}
|
|
4364
|
-
},
|
|
4365
|
-
"required": [
|
|
4366
|
-
"id",
|
|
4367
|
-
"code",
|
|
4368
|
-
"createdAt",
|
|
4369
|
-
"lastSeenAt",
|
|
4370
|
-
"title",
|
|
4371
|
-
"description",
|
|
4372
|
-
"groupedData",
|
|
4373
|
-
"eventsCount",
|
|
4374
|
-
"category",
|
|
4375
|
-
"resolutionLink"
|
|
4376
|
-
],
|
|
4377
|
-
"additionalProperties": false
|
|
4378
|
-
}
|
|
4379
|
-
},
|
|
4380
|
-
"IssueEvent": {
|
|
4381
|
-
"section": "bot",
|
|
4382
|
-
"schema": {
|
|
4383
|
-
"type": "object",
|
|
4384
|
-
"properties": {
|
|
4385
|
-
"id": {
|
|
4386
|
-
"type": "string"
|
|
4387
|
-
},
|
|
4388
|
-
"createdAt": {
|
|
4389
|
-
"type": "string",
|
|
4390
|
-
"format": "date-time"
|
|
4391
|
-
},
|
|
4392
|
-
"data": {
|
|
4393
|
-
"type": "object",
|
|
4394
|
-
"additionalProperties": {
|
|
4395
|
-
"type": "object",
|
|
4396
|
-
"properties": {
|
|
4397
|
-
"raw": {
|
|
4398
|
-
"type": "string"
|
|
4399
|
-
},
|
|
4400
|
-
"pretty": {
|
|
4401
|
-
"type": "string"
|
|
4402
|
-
}
|
|
4403
|
-
},
|
|
4404
|
-
"required": [
|
|
4405
|
-
"raw"
|
|
4406
|
-
],
|
|
4407
|
-
"additionalProperties": false
|
|
4408
|
-
}
|
|
4409
|
-
}
|
|
4410
|
-
},
|
|
4411
|
-
"required": [
|
|
4412
|
-
"id",
|
|
4413
|
-
"createdAt",
|
|
4414
|
-
"data"
|
|
4415
|
-
],
|
|
4416
|
-
"additionalProperties": false
|
|
4417
|
-
}
|
|
4418
|
-
},
|
|
4419
|
-
"Activity": {
|
|
4420
|
-
"section": "activity",
|
|
4421
|
-
"schema": {
|
|
4422
|
-
"type": "object",
|
|
4423
|
-
"properties": {
|
|
4424
|
-
"id": {
|
|
4425
|
-
"type": "string"
|
|
4426
|
-
},
|
|
4427
|
-
"description": {
|
|
4428
|
-
"type": "string"
|
|
4429
|
-
},
|
|
4430
|
-
"taskId": {
|
|
4431
|
-
"type": "string"
|
|
4432
|
-
},
|
|
4433
|
-
"category": {
|
|
4434
|
-
"type": "string",
|
|
4435
|
-
"enum": [
|
|
4436
|
-
"unknown",
|
|
4437
|
-
"capture",
|
|
4438
|
-
"bot_message",
|
|
4439
|
-
"user_message",
|
|
4440
|
-
"agent_message",
|
|
4441
|
-
"event",
|
|
4442
|
-
"action",
|
|
4443
|
-
"task_status",
|
|
4444
|
-
"subtask_status",
|
|
4445
|
-
"exception"
|
|
4446
|
-
]
|
|
4447
|
-
},
|
|
4448
|
-
"data": {
|
|
4449
|
-
"type": "object",
|
|
4450
|
-
"additionalProperties": true
|
|
4451
|
-
},
|
|
4452
|
-
"createdAt": {
|
|
4453
|
-
"type": "string",
|
|
4454
|
-
"format": "date-time",
|
|
4455
|
-
"description": "Creation date of the activity in ISO 8601 format"
|
|
4456
|
-
}
|
|
4457
|
-
},
|
|
4458
|
-
"required": [
|
|
4459
|
-
"id",
|
|
4460
|
-
"description",
|
|
4461
|
-
"taskId",
|
|
4462
|
-
"category",
|
|
4463
|
-
"data",
|
|
4464
|
-
"createdAt"
|
|
4465
|
-
],
|
|
4466
|
-
"additionalProperties": false
|
|
4467
|
-
}
|
|
4468
|
-
},
|
|
4469
|
-
"Version": {
|
|
4470
|
-
"section": "bot",
|
|
4471
|
-
"schema": {
|
|
4472
|
-
"type": "object",
|
|
4473
|
-
"properties": {
|
|
4474
|
-
"id": {
|
|
4475
|
-
"type": "string"
|
|
4476
|
-
},
|
|
4477
|
-
"name": {
|
|
4478
|
-
"type": "string"
|
|
4479
|
-
},
|
|
4480
|
-
"description": {
|
|
4481
|
-
"type": "string"
|
|
4482
|
-
}
|
|
4483
|
-
},
|
|
4484
|
-
"required": [
|
|
4485
|
-
"id",
|
|
4486
|
-
"name"
|
|
4487
|
-
],
|
|
4488
|
-
"additionalProperties": false
|
|
4489
|
-
}
|
|
4490
|
-
},
|
|
4491
|
-
"User": {
|
|
4492
|
-
"section": "user",
|
|
4493
|
-
"schema": {
|
|
4494
|
-
"type": "object",
|
|
4495
|
-
"properties": {
|
|
4496
|
-
"id": {
|
|
4497
|
-
"type": "string",
|
|
4498
|
-
"minLength": 28,
|
|
4499
|
-
"maxLength": 36,
|
|
4500
|
-
"description": "Id of the [User](#schema_user)"
|
|
4501
|
-
},
|
|
4502
|
-
"createdAt": {
|
|
4503
|
-
"type": "string",
|
|
4504
|
-
"format": "date-time",
|
|
4505
|
-
"description": "Creation date of the [User](#schema_user) in ISO 8601 format"
|
|
4506
|
-
},
|
|
4507
|
-
"updatedAt": {
|
|
4508
|
-
"type": "string",
|
|
4509
|
-
"format": "date-time",
|
|
4510
|
-
"description": "Updating date of the [User](#schema_user) in ISO 8601 format"
|
|
4511
|
-
},
|
|
4512
|
-
"tags": {
|
|
4513
|
-
"type": "object",
|
|
4514
|
-
"additionalProperties": {
|
|
4515
|
-
"type": "string"
|
|
4516
|
-
},
|
|
4517
|
-
"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."
|
|
4518
|
-
},
|
|
4519
|
-
"name": {
|
|
4520
|
-
"type": "string",
|
|
4521
|
-
"maxLength": 200,
|
|
4522
|
-
"description": "Name of the [User](#schema_user)"
|
|
4523
|
-
},
|
|
4524
|
-
"pictureUrl": {
|
|
4525
|
-
"type": "string",
|
|
4526
|
-
"maxLength": 40000,
|
|
4527
|
-
"description": "Picture URL of the [User](#schema_user)"
|
|
4528
|
-
}
|
|
4529
|
-
},
|
|
4530
|
-
"required": [
|
|
4531
|
-
"id",
|
|
4532
|
-
"createdAt",
|
|
4533
|
-
"updatedAt",
|
|
4534
|
-
"tags"
|
|
4535
|
-
],
|
|
4536
|
-
"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.",
|
|
4537
|
-
"additionalProperties": false
|
|
4538
|
-
}
|
|
4539
|
-
},
|
|
4540
|
-
"Conversation": {
|
|
4541
|
-
"section": "conversation",
|
|
4542
|
-
"schema": {
|
|
4543
|
-
"type": "object",
|
|
4544
|
-
"properties": {
|
|
4545
|
-
"id": {
|
|
4546
|
-
"type": "string",
|
|
4547
|
-
"minLength": 28,
|
|
4548
|
-
"maxLength": 36,
|
|
4549
|
-
"description": "Id of the [Conversation](#schema_conversation)"
|
|
4550
|
-
},
|
|
4551
|
-
"currentTaskId": {
|
|
4552
|
-
"type": "string",
|
|
4553
|
-
"minLength": 28,
|
|
4554
|
-
"maxLength": 36,
|
|
4555
|
-
"description": "Id of the current [Task](#schema_task)"
|
|
4556
|
-
},
|
|
4557
|
-
"currentWorkflowId": {
|
|
4558
|
-
"type": "string",
|
|
4559
|
-
"minLength": 28,
|
|
4560
|
-
"maxLength": 36,
|
|
4561
|
-
"description": "Id of the current [Workflow](#schema_workflow)"
|
|
4562
|
-
},
|
|
4563
|
-
"createdAt": {
|
|
4564
|
-
"type": "string",
|
|
4565
|
-
"format": "date-time",
|
|
4566
|
-
"description": "Creation date of the [Conversation](#schema_conversation) in ISO 8601 format"
|
|
4567
|
-
},
|
|
4568
|
-
"updatedAt": {
|
|
4569
|
-
"type": "string",
|
|
4570
|
-
"format": "date-time",
|
|
4571
|
-
"description": "Updating date of the [Conversation](#schema_conversation) in ISO 8601 format"
|
|
4572
|
-
},
|
|
4573
|
-
"channel": {
|
|
4574
|
-
"type": "string",
|
|
4575
|
-
"description": "Name of the channel where the [Conversation](#schema_conversation) is happening"
|
|
4576
|
-
},
|
|
4577
|
-
"integration": {
|
|
4578
|
-
"type": "string",
|
|
4579
|
-
"description": "Name of the integration that created the [Conversation](#schema_conversation)"
|
|
4580
|
-
},
|
|
4581
|
-
"tags": {
|
|
4582
|
-
"type": "object",
|
|
4583
|
-
"additionalProperties": {
|
|
4584
|
-
"type": "string"
|
|
4585
|
-
},
|
|
4586
|
-
"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."
|
|
4587
|
-
}
|
|
4588
|
-
},
|
|
4589
|
-
"required": [
|
|
4590
|
-
"id",
|
|
4591
|
-
"createdAt",
|
|
4592
|
-
"updatedAt",
|
|
4593
|
-
"channel",
|
|
4594
|
-
"integration",
|
|
4595
|
-
"tags"
|
|
4596
|
-
],
|
|
4597
|
-
"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.",
|
|
4598
|
-
"additionalProperties": false
|
|
4599
|
-
}
|
|
4600
|
-
},
|
|
4601
|
-
"Event": {
|
|
4602
|
-
"section": "event",
|
|
4603
|
-
"schema": {
|
|
4604
|
-
"type": "object",
|
|
4605
|
-
"properties": {
|
|
4606
|
-
"id": {
|
|
4607
|
-
"type": "string",
|
|
4608
|
-
"minLength": 28,
|
|
4609
|
-
"maxLength": 36,
|
|
4610
|
-
"description": "Id of the [Event](#schema_event)"
|
|
4611
|
-
},
|
|
4612
|
-
"createdAt": {
|
|
4613
|
-
"type": "string",
|
|
4614
|
-
"format": "date-time",
|
|
4615
|
-
"description": "Creation date of the [Event](#schema_event) in ISO 8601 format"
|
|
4616
|
-
},
|
|
4617
|
-
"type": {
|
|
4618
|
-
"type": "string",
|
|
4619
|
-
"maxLength": 200,
|
|
4620
|
-
"description": "Type of the [Event](#schema_event)."
|
|
4621
|
-
},
|
|
4622
|
-
"payload": {
|
|
4623
|
-
"type": "object",
|
|
4624
|
-
"additionalProperties": true,
|
|
4625
|
-
"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."
|
|
4626
|
-
},
|
|
4627
|
-
"conversationId": {
|
|
4628
|
-
"type": "string",
|
|
4629
|
-
"minLength": 28,
|
|
4630
|
-
"maxLength": 36,
|
|
4631
|
-
"description": "ID of the [Conversation](#schema_conversation) to link the event to."
|
|
4632
|
-
},
|
|
4633
|
-
"userId": {
|
|
4634
|
-
"type": "string",
|
|
4635
|
-
"minLength": 28,
|
|
4636
|
-
"maxLength": 36,
|
|
4637
|
-
"description": "ID of the [User](#schema_user) to link the event to."
|
|
4638
|
-
},
|
|
4639
|
-
"messageId": {
|
|
4640
|
-
"type": "string",
|
|
4641
|
-
"minLength": 28,
|
|
4642
|
-
"maxLength": 36,
|
|
4643
|
-
"description": "ID of the [Message](#schema_message) to link the event to."
|
|
4644
|
-
},
|
|
4645
|
-
"status": {
|
|
4646
|
-
"type": "string",
|
|
4647
|
-
"enum": [
|
|
4648
|
-
"pending",
|
|
4649
|
-
"processed",
|
|
4650
|
-
"ignored",
|
|
4651
|
-
"failed",
|
|
4652
|
-
"scheduled"
|
|
4653
|
-
]
|
|
4654
|
-
},
|
|
4655
|
-
"failureReason": {
|
|
4656
|
-
"type": "string",
|
|
4657
|
-
"maxLength": 2000,
|
|
4658
|
-
"nullable": true,
|
|
4659
|
-
"description": "Reason why the event failed to be processed"
|
|
4660
|
-
}
|
|
4661
|
-
},
|
|
4662
|
-
"required": [
|
|
4663
|
-
"id",
|
|
4664
|
-
"createdAt",
|
|
4665
|
-
"type",
|
|
4666
|
-
"payload",
|
|
4667
|
-
"status",
|
|
4668
|
-
"failureReason"
|
|
4669
|
-
],
|
|
4670
|
-
"description": "The event object represents an action or an occurrence.",
|
|
4671
|
-
"additionalProperties": false
|
|
4672
|
-
}
|
|
4673
|
-
},
|
|
4674
|
-
"Message": {
|
|
4675
|
-
"section": "message",
|
|
4676
|
-
"schema": {
|
|
4677
|
-
"type": "object",
|
|
4678
|
-
"properties": {
|
|
4679
|
-
"id": {
|
|
4680
|
-
"type": "string",
|
|
4681
|
-
"minLength": 28,
|
|
4682
|
-
"maxLength": 36,
|
|
4683
|
-
"description": "Id of the [Message](#schema_message)"
|
|
4684
|
-
},
|
|
4685
|
-
"createdAt": {
|
|
4686
|
-
"type": "string",
|
|
4687
|
-
"format": "date-time",
|
|
4688
|
-
"description": "Creation date of the [Message](#schema_message) in ISO 8601 format"
|
|
4689
|
-
},
|
|
4690
|
-
"updatedAt": {
|
|
4691
|
-
"type": "string",
|
|
4692
|
-
"format": "date-time",
|
|
4693
|
-
"description": "Update date of the [Message](#schema_message) in ISO 8601 format"
|
|
4694
|
-
},
|
|
4695
|
-
"type": {
|
|
4696
|
-
"type": "string",
|
|
4697
|
-
"maxLength": 200,
|
|
4698
|
-
"description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
|
|
4699
|
-
},
|
|
4700
|
-
"payload": {
|
|
4701
|
-
"type": "object",
|
|
4702
|
-
"additionalProperties": true,
|
|
4703
|
-
"description": "Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location"
|
|
4704
|
-
},
|
|
4705
|
-
"direction": {
|
|
4706
|
-
"type": "string",
|
|
4707
|
-
"enum": [
|
|
4708
|
-
"incoming",
|
|
4709
|
-
"outgoing"
|
|
4710
|
-
],
|
|
4711
|
-
"description": "Direction of the message (`incoming` or `outgoing`)."
|
|
4712
|
-
},
|
|
4713
|
-
"userId": {
|
|
4714
|
-
"type": "string",
|
|
4715
|
-
"minLength": 28,
|
|
4716
|
-
"maxLength": 36,
|
|
4717
|
-
"description": "ID of the [User](#schema_user)"
|
|
4718
|
-
},
|
|
4719
|
-
"conversationId": {
|
|
4720
|
-
"type": "string",
|
|
4721
|
-
"minLength": 28,
|
|
4722
|
-
"maxLength": 36,
|
|
4723
|
-
"description": "ID of the [Conversation](#schema_conversation)"
|
|
4724
|
-
},
|
|
4725
|
-
"tags": {
|
|
4726
|
-
"type": "object",
|
|
4727
|
-
"additionalProperties": {
|
|
4728
|
-
"type": "string"
|
|
4729
|
-
},
|
|
4730
|
-
"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."
|
|
4731
|
-
},
|
|
4732
|
-
"origin": {
|
|
4733
|
-
"type": "string",
|
|
4734
|
-
"enum": [
|
|
4735
|
-
"synthetic"
|
|
4736
|
-
],
|
|
4737
|
-
"description": "Origin of the message (`synthetic`)."
|
|
4738
|
-
}
|
|
4739
|
-
},
|
|
4740
|
-
"required": [
|
|
4741
|
-
"id",
|
|
4742
|
-
"createdAt",
|
|
4743
|
-
"updatedAt",
|
|
4744
|
-
"type",
|
|
4745
|
-
"payload",
|
|
4746
|
-
"direction",
|
|
4747
|
-
"userId",
|
|
4748
|
-
"conversationId",
|
|
4749
|
-
"tags"
|
|
4750
|
-
],
|
|
4751
|
-
"description": "The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).",
|
|
4752
|
-
"additionalProperties": false
|
|
4753
|
-
}
|
|
4754
|
-
},
|
|
4755
|
-
"State": {
|
|
4756
|
-
"section": "state",
|
|
4757
|
-
"schema": {
|
|
4758
|
-
"type": "object",
|
|
4759
|
-
"properties": {
|
|
4760
|
-
"id": {
|
|
4761
|
-
"type": "string",
|
|
4762
|
-
"minLength": 28,
|
|
4763
|
-
"maxLength": 36,
|
|
4764
|
-
"description": "Id of the [State](#schema_state)"
|
|
4765
|
-
},
|
|
4766
|
-
"createdAt": {
|
|
4767
|
-
"type": "string",
|
|
4768
|
-
"format": "date-time",
|
|
4769
|
-
"description": "Creation date of the [State](#schema_state) in ISO 8601 format"
|
|
4770
|
-
},
|
|
4771
|
-
"updatedAt": {
|
|
4772
|
-
"type": "string",
|
|
4773
|
-
"format": "date-time",
|
|
4774
|
-
"description": "Updating date of the [State](#schema_state) in ISO 8601 format"
|
|
4775
|
-
},
|
|
4776
|
-
"botId": {
|
|
4777
|
-
"type": "string",
|
|
4778
|
-
"minLength": 28,
|
|
4779
|
-
"maxLength": 36,
|
|
4780
|
-
"description": "Id of the [Bot](#schema_bot)"
|
|
4781
|
-
},
|
|
4782
|
-
"conversationId": {
|
|
4783
|
-
"type": "string",
|
|
4784
|
-
"minLength": 28,
|
|
4785
|
-
"maxLength": 36,
|
|
4786
|
-
"description": "Id of the [Conversation](#schema_conversation)"
|
|
4787
|
-
},
|
|
4788
|
-
"userId": {
|
|
4789
|
-
"type": "string",
|
|
4790
|
-
"minLength": 28,
|
|
4791
|
-
"maxLength": 36,
|
|
4792
|
-
"description": "Id of the [User](#schema_user)"
|
|
4793
|
-
},
|
|
4794
|
-
"name": {
|
|
4795
|
-
"type": "string",
|
|
4796
|
-
"maxLength": 200,
|
|
4797
|
-
"description": "Name of the [State](#schema_state) which is declared inside the bot definition"
|
|
4798
|
-
},
|
|
4799
|
-
"type": {
|
|
4800
|
-
"type": "string",
|
|
4801
|
-
"enum": [
|
|
4802
|
-
"conversation",
|
|
4803
|
-
"user",
|
|
4804
|
-
"bot",
|
|
4805
|
-
"task",
|
|
4806
|
-
"integration",
|
|
4807
|
-
"workflow"
|
|
4808
|
-
],
|
|
4809
|
-
"description": "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to"
|
|
4810
|
-
},
|
|
4811
|
-
"payload": {
|
|
4812
|
-
"type": "object",
|
|
4813
|
-
"additionalProperties": true,
|
|
4814
|
-
"description": "Payload is the content of the state defined by your bot."
|
|
4815
|
-
}
|
|
4816
|
-
},
|
|
4817
|
-
"required": [
|
|
4818
|
-
"id",
|
|
4819
|
-
"createdAt",
|
|
4820
|
-
"updatedAt",
|
|
4821
|
-
"botId",
|
|
4822
|
-
"name",
|
|
4823
|
-
"type",
|
|
4824
|
-
"payload"
|
|
4825
|
-
],
|
|
4826
|
-
"description": "The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.",
|
|
4827
|
-
"additionalProperties": false
|
|
4828
|
-
}
|
|
4829
|
-
},
|
|
4830
|
-
"Task": {
|
|
4831
|
-
"section": "task",
|
|
4832
|
-
"schema": {
|
|
4833
|
-
"type": "object",
|
|
4834
|
-
"properties": {
|
|
4835
|
-
"id": {
|
|
4836
|
-
"type": "string",
|
|
4837
|
-
"minLength": 28,
|
|
4838
|
-
"maxLength": 36,
|
|
4839
|
-
"description": "Id of the [Task](#schema_task)"
|
|
4840
|
-
},
|
|
4841
|
-
"title": {
|
|
4842
|
-
"type": "string",
|
|
4843
|
-
"maxLength": 64,
|
|
4844
|
-
"description": "Title describing the task"
|
|
4845
|
-
},
|
|
4846
|
-
"description": {
|
|
4847
|
-
"type": "string",
|
|
4848
|
-
"maxLength": 256,
|
|
4849
|
-
"description": "All the notes related to the execution of the current task"
|
|
4850
|
-
},
|
|
4851
|
-
"type": {
|
|
4852
|
-
"type": "string",
|
|
4853
|
-
"description": "Type of the task"
|
|
4854
|
-
},
|
|
4855
|
-
"data": {
|
|
4856
|
-
"type": "object",
|
|
4857
|
-
"additionalProperties": true,
|
|
4858
|
-
"description": "Content related to the task"
|
|
4859
|
-
},
|
|
4860
|
-
"status": {
|
|
4861
|
-
"type": "string",
|
|
4862
|
-
"enum": [
|
|
4863
|
-
"pending",
|
|
4864
|
-
"in_progress",
|
|
4865
|
-
"failed",
|
|
4866
|
-
"completed",
|
|
4867
|
-
"blocked",
|
|
4868
|
-
"paused",
|
|
4869
|
-
"timeout",
|
|
4870
|
-
"cancelled"
|
|
4871
|
-
],
|
|
4872
|
-
"description": "Status of the task"
|
|
4873
|
-
},
|
|
4874
|
-
"parentTaskId": {
|
|
4875
|
-
"type": "string",
|
|
4876
|
-
"minLength": 28,
|
|
4877
|
-
"maxLength": 36,
|
|
4878
|
-
"description": "Parent task id is the parent task that created this task"
|
|
4879
|
-
},
|
|
4880
|
-
"conversationId": {
|
|
4881
|
-
"type": "string",
|
|
4882
|
-
"minLength": 28,
|
|
4883
|
-
"maxLength": 36,
|
|
4884
|
-
"description": "Conversation id related to this task"
|
|
4885
|
-
},
|
|
4886
|
-
"userId": {
|
|
4887
|
-
"type": "string",
|
|
4888
|
-
"minLength": 28,
|
|
4889
|
-
"maxLength": 36,
|
|
4890
|
-
"description": "Specific user related to this task"
|
|
4891
|
-
},
|
|
4892
|
-
"timeoutAt": {
|
|
4893
|
-
"type": "string",
|
|
4894
|
-
"format": "date-time",
|
|
4895
|
-
"description": "The timeout date where the task should be failed in the ISO 8601 format"
|
|
4896
|
-
},
|
|
4897
|
-
"createdAt": {
|
|
4898
|
-
"type": "string",
|
|
4899
|
-
"format": "date-time",
|
|
4900
|
-
"description": "Creation date of the task in ISO 8601 format"
|
|
4901
|
-
},
|
|
4902
|
-
"updatedAt": {
|
|
4903
|
-
"type": "string",
|
|
4904
|
-
"format": "date-time",
|
|
4905
|
-
"description": "Updating date of the task in ISO 8601 format"
|
|
4906
|
-
},
|
|
4907
|
-
"failureReason": {
|
|
4908
|
-
"type": "string",
|
|
4909
|
-
"maxLength": 2000,
|
|
4910
|
-
"description": "If the task fails this is the reason behind it"
|
|
4911
|
-
},
|
|
4912
|
-
"tags": {
|
|
4913
|
-
"type": "object",
|
|
4914
|
-
"additionalProperties": {
|
|
4915
|
-
"type": "string"
|
|
4916
|
-
},
|
|
4917
|
-
"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."
|
|
4918
|
-
}
|
|
4919
|
-
},
|
|
4920
|
-
"required": [
|
|
4921
|
-
"id",
|
|
4922
|
-
"title",
|
|
4923
|
-
"description",
|
|
4924
|
-
"type",
|
|
4925
|
-
"data",
|
|
4926
|
-
"status",
|
|
4927
|
-
"timeoutAt",
|
|
4928
|
-
"createdAt",
|
|
4929
|
-
"updatedAt",
|
|
4930
|
-
"tags"
|
|
4931
|
-
],
|
|
4932
|
-
"description": "Task definition",
|
|
4933
|
-
"additionalProperties": false
|
|
4934
|
-
}
|
|
4935
|
-
},
|
|
4936
|
-
"Workflow": {
|
|
4937
|
-
"section": "workflow",
|
|
4938
|
-
"schema": {
|
|
4939
|
-
"type": "object",
|
|
4940
|
-
"properties": {
|
|
4941
|
-
"id": {
|
|
4942
|
-
"type": "string",
|
|
4943
|
-
"minLength": 28,
|
|
4944
|
-
"maxLength": 36,
|
|
4945
|
-
"description": "Id of the [Workflow](#schema_workflow)"
|
|
4946
|
-
},
|
|
4947
|
-
"name": {
|
|
4948
|
-
"type": "string",
|
|
4949
|
-
"maxLength": 200,
|
|
4950
|
-
"description": "Name of the workflow"
|
|
4951
|
-
},
|
|
4952
|
-
"status": {
|
|
4953
|
-
"type": "string",
|
|
4954
|
-
"enum": [
|
|
4955
|
-
"pending",
|
|
4956
|
-
"in_progress",
|
|
4957
|
-
"failed",
|
|
4958
|
-
"completed",
|
|
4959
|
-
"listening",
|
|
4960
|
-
"paused",
|
|
4961
|
-
"timedout",
|
|
4962
|
-
"cancelled"
|
|
4963
|
-
],
|
|
4964
|
-
"description": "Status of the [Workflow](#schema_workflow)"
|
|
4965
|
-
},
|
|
4966
|
-
"input": {
|
|
4967
|
-
"type": "object",
|
|
4968
|
-
"additionalProperties": true,
|
|
4969
|
-
"description": "Input provided to the [Workflow](#schema_workflow)"
|
|
4970
|
-
},
|
|
4971
|
-
"output": {
|
|
4972
|
-
"type": "object",
|
|
4973
|
-
"additionalProperties": true,
|
|
4974
|
-
"description": "Data returned by the [Workflow](#schema_workflow) output"
|
|
4975
|
-
},
|
|
4976
|
-
"parentWorkflowId": {
|
|
4977
|
-
"type": "string",
|
|
4978
|
-
"minLength": 28,
|
|
4979
|
-
"maxLength": 36,
|
|
4980
|
-
"description": "Parent [Workflow](#schema_workflow) id is the parent [Workflow](#schema_workflow) that created this [Workflow](#schema_workflow)"
|
|
4981
|
-
},
|
|
4982
|
-
"conversationId": {
|
|
4983
|
-
"type": "string",
|
|
4984
|
-
"minLength": 28,
|
|
4985
|
-
"maxLength": 36,
|
|
4986
|
-
"description": "Conversation id related to this [Workflow](#schema_workflow)"
|
|
4987
|
-
},
|
|
4988
|
-
"userId": {
|
|
4989
|
-
"type": "string",
|
|
4990
|
-
"minLength": 28,
|
|
4991
|
-
"maxLength": 36,
|
|
4992
|
-
"description": "User id related to this [Workflow](#schema_workflow)"
|
|
4993
|
-
},
|
|
4994
|
-
"createdAt": {
|
|
4995
|
-
"type": "string",
|
|
4996
|
-
"format": "date-time",
|
|
4997
|
-
"description": "Creation date of the [Workflow](#schema_workflow) in ISO 8601 format"
|
|
4998
|
-
},
|
|
4999
|
-
"updatedAt": {
|
|
5000
|
-
"type": "string",
|
|
5001
|
-
"format": "date-time",
|
|
5002
|
-
"description": "Updating date of the [Workflow](#schema_workflow) in ISO 8601 format"
|
|
5003
|
-
},
|
|
5004
|
-
"completedAt": {
|
|
5005
|
-
"type": "string",
|
|
5006
|
-
"format": "date-time",
|
|
5007
|
-
"description": "The date when the [Workflow](#schema_workflow) completed in ISO 8601 format"
|
|
5008
|
-
},
|
|
5009
|
-
"failureReason": {
|
|
5010
|
-
"type": "string",
|
|
5011
|
-
"maxLength": 2000,
|
|
5012
|
-
"description": "If the [Workflow](#schema_workflow) fails this is the reason behind it"
|
|
5013
|
-
},
|
|
5014
|
-
"timeoutAt": {
|
|
5015
|
-
"type": "string",
|
|
5016
|
-
"format": "date-time",
|
|
5017
|
-
"description": "The timeout date when the [Workflow](#schema_workflow) will fail in the ISO 8601 format"
|
|
5018
|
-
},
|
|
5019
|
-
"tags": {
|
|
5020
|
-
"type": "object",
|
|
5021
|
-
"additionalProperties": {
|
|
5022
|
-
"type": "string"
|
|
5023
|
-
},
|
|
5024
|
-
"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."
|
|
5025
|
-
}
|
|
5026
|
-
},
|
|
5027
|
-
"required": [
|
|
5028
|
-
"id",
|
|
5029
|
-
"name",
|
|
5030
|
-
"status",
|
|
5031
|
-
"input",
|
|
5032
|
-
"output",
|
|
5033
|
-
"createdAt",
|
|
5034
|
-
"updatedAt",
|
|
5035
|
-
"timeoutAt",
|
|
5036
|
-
"tags"
|
|
5037
|
-
],
|
|
5038
|
-
"description": "Workflow definition",
|
|
5039
|
-
"additionalProperties": false
|
|
5040
|
-
}
|
|
5041
|
-
},
|
|
5042
|
-
"Table": {
|
|
5043
|
-
"section": "tables",
|
|
5044
|
-
"schema": {
|
|
5045
|
-
"type": "object",
|
|
5046
|
-
"properties": {
|
|
5047
|
-
"id": {
|
|
5048
|
-
"type": "string",
|
|
5049
|
-
"description": "Unique identifier for the table"
|
|
5050
|
-
},
|
|
5051
|
-
"name": {
|
|
5052
|
-
"description": "Required. This name is used to identify your table.",
|
|
5053
|
-
"type": "string",
|
|
5054
|
-
"minLength": 1
|
|
5055
|
-
},
|
|
5056
|
-
"factor": {
|
|
5057
|
-
"default": 1,
|
|
5058
|
-
"type": "number",
|
|
5059
|
-
"minimum": 1,
|
|
5060
|
-
"maximum": 30,
|
|
5061
|
-
"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."
|
|
5062
|
-
},
|
|
5063
|
-
"frozen": {
|
|
5064
|
-
"type": "boolean",
|
|
5065
|
-
"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."
|
|
5066
|
-
},
|
|
5067
|
-
"schema": {
|
|
5068
|
-
"type": "object",
|
|
5069
|
-
"properties": {
|
|
5070
|
-
"$schema": {
|
|
5071
|
-
"type": "string"
|
|
5072
|
-
},
|
|
5073
|
-
"properties": {
|
|
5074
|
-
"type": "object",
|
|
5075
|
-
"additionalProperties": {
|
|
5076
|
-
"type": "object",
|
|
5077
|
-
"properties": {
|
|
5078
|
-
"type": {
|
|
5079
|
-
"type": "string",
|
|
5080
|
-
"enum": [
|
|
5081
|
-
"string",
|
|
5082
|
-
"number",
|
|
5083
|
-
"boolean",
|
|
5084
|
-
"object",
|
|
5085
|
-
"array",
|
|
5086
|
-
"null"
|
|
5087
|
-
]
|
|
5088
|
-
},
|
|
5089
|
-
"format": {
|
|
5090
|
-
"type": "string",
|
|
5091
|
-
"enum": [
|
|
5092
|
-
"date-time"
|
|
5093
|
-
]
|
|
5094
|
-
},
|
|
5095
|
-
"description": {
|
|
5096
|
-
"type": "string"
|
|
5097
|
-
},
|
|
5098
|
-
"pattern": {
|
|
5099
|
-
"type": "string",
|
|
5100
|
-
"description": "String properties must match this pattern"
|
|
5101
|
-
},
|
|
5102
|
-
"enum": {
|
|
5103
|
-
"type": "array",
|
|
5104
|
-
"items": {
|
|
5105
|
-
"type": "string"
|
|
5106
|
-
},
|
|
5107
|
-
"description": "String properties must be one of these values"
|
|
5108
|
-
},
|
|
5109
|
-
"items": {
|
|
5110
|
-
"type": "object",
|
|
5111
|
-
"properties": {
|
|
5112
|
-
"type": {
|
|
5113
|
-
"type": "string",
|
|
5114
|
-
"enum": [
|
|
5115
|
-
"string",
|
|
5116
|
-
"number",
|
|
5117
|
-
"boolean",
|
|
5118
|
-
"object",
|
|
5119
|
-
"array",
|
|
5120
|
-
"null"
|
|
5121
|
-
]
|
|
5122
|
-
}
|
|
5123
|
-
},
|
|
5124
|
-
"required": [
|
|
5125
|
-
"type"
|
|
5126
|
-
],
|
|
5127
|
-
"additionalProperties": true,
|
|
5128
|
-
"description": "Defines the shape of items in an array"
|
|
5129
|
-
},
|
|
5130
|
-
"nullable": {
|
|
5131
|
-
"default": true,
|
|
5132
|
-
"type": "boolean"
|
|
5133
|
-
},
|
|
5134
|
-
"properties": {
|
|
5135
|
-
"type": "object",
|
|
5136
|
-
"additionalProperties": {
|
|
5137
|
-
"type": "object",
|
|
5138
|
-
"properties": {
|
|
5139
|
-
"type": {
|
|
5140
|
-
"type": "string",
|
|
5141
|
-
"enum": [
|
|
5142
|
-
"string",
|
|
5143
|
-
"number",
|
|
5144
|
-
"boolean",
|
|
5145
|
-
"object",
|
|
5146
|
-
"array",
|
|
5147
|
-
"null"
|
|
5148
|
-
]
|
|
5149
|
-
}
|
|
5150
|
-
},
|
|
5151
|
-
"required": [
|
|
5152
|
-
"type"
|
|
5153
|
-
],
|
|
5154
|
-
"additionalProperties": true
|
|
5155
|
-
}
|
|
5156
|
-
},
|
|
5157
|
-
"x-zui": {
|
|
5158
|
-
"type": "object",
|
|
5159
|
-
"properties": {
|
|
5160
|
-
"index": {
|
|
5161
|
-
"type": "integer"
|
|
5162
|
-
},
|
|
5163
|
-
"id": {
|
|
5164
|
-
"type": "string",
|
|
5165
|
-
"description": "[deprecated] ID of the column."
|
|
5166
|
-
},
|
|
5167
|
-
"searchable": {
|
|
5168
|
-
"type": "boolean",
|
|
5169
|
-
"description": "Indicates if the column is vectorized and searchable."
|
|
5170
|
-
},
|
|
5171
|
-
"hidden": {
|
|
5172
|
-
"type": "boolean",
|
|
5173
|
-
"description": "Indicates if the field is hidden in the UI"
|
|
5174
|
-
},
|
|
5175
|
-
"order": {
|
|
5176
|
-
"type": "number",
|
|
5177
|
-
"description": "Order of the column in the UI"
|
|
5178
|
-
},
|
|
5179
|
-
"width": {
|
|
5180
|
-
"type": "number",
|
|
5181
|
-
"description": "Width of the column in the UI"
|
|
5182
|
-
},
|
|
5183
|
-
"schemaId": {
|
|
5184
|
-
"type": "string",
|
|
5185
|
-
"description": "ID of the schema"
|
|
5186
|
-
},
|
|
5187
|
-
"computed": {
|
|
5188
|
-
"type": "object",
|
|
5189
|
-
"properties": {
|
|
5190
|
-
"action": {
|
|
5191
|
-
"type": "string",
|
|
5192
|
-
"enum": [
|
|
5193
|
-
"ai",
|
|
5194
|
-
"code",
|
|
5195
|
-
"workflow"
|
|
5196
|
-
]
|
|
5197
|
-
},
|
|
5198
|
-
"dependencies": {
|
|
5199
|
-
"default": [],
|
|
5200
|
-
"type": "array",
|
|
5201
|
-
"items": {
|
|
5202
|
-
"type": "string"
|
|
5203
|
-
}
|
|
5204
|
-
},
|
|
5205
|
-
"prompt": {
|
|
5206
|
-
"type": "string",
|
|
5207
|
-
"description": "Prompt when action is \"ai\""
|
|
5208
|
-
},
|
|
5209
|
-
"code": {
|
|
5210
|
-
"type": "string",
|
|
5211
|
-
"description": "Code to execute when action is \"code\""
|
|
5212
|
-
},
|
|
5213
|
-
"model": {
|
|
5214
|
-
"default": "gpt-4o",
|
|
5215
|
-
"type": "string",
|
|
5216
|
-
"maxLength": 80,
|
|
5217
|
-
"description": "Model to use when action is \"ai\""
|
|
5218
|
-
},
|
|
5219
|
-
"workflowId": {
|
|
5220
|
-
"type": "string",
|
|
5221
|
-
"maxLength": 20,
|
|
5222
|
-
"description": "ID of Workflow to execute when action is \"workflow\""
|
|
5223
|
-
},
|
|
5224
|
-
"enabled": {
|
|
5225
|
-
"type": "boolean"
|
|
5226
|
-
}
|
|
5227
|
-
},
|
|
5228
|
-
"required": [
|
|
5229
|
-
"action"
|
|
5230
|
-
],
|
|
5231
|
-
"additionalProperties": false
|
|
5232
|
-
},
|
|
5233
|
-
"typings": {
|
|
5234
|
-
"type": "string",
|
|
5235
|
-
"description": "TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\""
|
|
5236
|
-
}
|
|
5237
|
-
},
|
|
5238
|
-
"required": [
|
|
5239
|
-
"index"
|
|
5240
|
-
],
|
|
5241
|
-
"additionalProperties": false
|
|
5242
|
-
}
|
|
5243
|
-
},
|
|
5244
|
-
"required": [
|
|
5245
|
-
"type",
|
|
5246
|
-
"x-zui"
|
|
5247
|
-
],
|
|
5248
|
-
"additionalProperties": false
|
|
5249
|
-
},
|
|
5250
|
-
"description": "List of keys/columns in the table."
|
|
5251
|
-
},
|
|
5252
|
-
"additionalProperties": {
|
|
5253
|
-
"type": "boolean",
|
|
5254
|
-
"enum": [
|
|
5255
|
-
true
|
|
5256
|
-
],
|
|
5257
|
-
"description": "Additional properties can be provided, but they will be ignored if no column matches."
|
|
5258
|
-
},
|
|
5259
|
-
"required": {
|
|
5260
|
-
"type": "array",
|
|
5261
|
-
"items": {
|
|
5262
|
-
"type": "string"
|
|
5263
|
-
},
|
|
5264
|
-
"description": "Array of required properties."
|
|
5265
|
-
},
|
|
5266
|
-
"type": {
|
|
5267
|
-
"type": "string",
|
|
5268
|
-
"enum": [
|
|
5269
|
-
"object"
|
|
5270
|
-
]
|
|
5271
|
-
}
|
|
5272
|
-
},
|
|
5273
|
-
"required": [
|
|
5274
|
-
"properties",
|
|
5275
|
-
"additionalProperties",
|
|
5276
|
-
"type"
|
|
5277
|
-
],
|
|
5278
|
-
"additionalProperties": false
|
|
5279
|
-
},
|
|
5280
|
-
"tags": {
|
|
5281
|
-
"type": "object",
|
|
5282
|
-
"additionalProperties": {
|
|
5283
|
-
"type": "string"
|
|
5284
|
-
},
|
|
5285
|
-
"description": "Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs."
|
|
5286
|
-
},
|
|
5287
|
-
"isComputeEnabled": {
|
|
5288
|
-
"type": "boolean",
|
|
5289
|
-
"description": "Indicates if the table is enabled for computation."
|
|
5290
|
-
},
|
|
5291
|
-
"createdAt": {
|
|
5292
|
-
"type": "string",
|
|
5293
|
-
"format": "date-time",
|
|
5294
|
-
"description": "Timestamp of table creation."
|
|
5295
|
-
},
|
|
5296
|
-
"updatedAt": {
|
|
5297
|
-
"type": "string",
|
|
5298
|
-
"format": "date-time",
|
|
5299
|
-
"description": "Timestamp of the last table update."
|
|
5300
|
-
}
|
|
5301
|
-
},
|
|
5302
|
-
"required": [
|
|
5303
|
-
"id",
|
|
5304
|
-
"name",
|
|
5305
|
-
"schema"
|
|
5306
|
-
],
|
|
5307
|
-
"additionalProperties": false
|
|
5308
|
-
}
|
|
1951
|
+
"status": 410,
|
|
1952
|
+
"type": "ResourceGone",
|
|
1953
|
+
"description": "The requested resource is no longer available."
|
|
5309
1954
|
},
|
|
5310
|
-
|
|
5311
|
-
"
|
|
5312
|
-
"
|
|
5313
|
-
|
|
5314
|
-
"properties": {
|
|
5315
|
-
"id": {
|
|
5316
|
-
"type": "string",
|
|
5317
|
-
"description": "Unique identifier for the column."
|
|
5318
|
-
},
|
|
5319
|
-
"name": {
|
|
5320
|
-
"type": "string",
|
|
5321
|
-
"minLength": 1,
|
|
5322
|
-
"maxLength": 30,
|
|
5323
|
-
"description": "Name of the column, must be within length limits."
|
|
5324
|
-
},
|
|
5325
|
-
"description": {
|
|
5326
|
-
"type": "string",
|
|
5327
|
-
"description": "Optional descriptive text about the column."
|
|
5328
|
-
},
|
|
5329
|
-
"searchable": {
|
|
5330
|
-
"type": "boolean",
|
|
5331
|
-
"description": "Indicates if the column is vectorized and searchable."
|
|
5332
|
-
},
|
|
5333
|
-
"type": {
|
|
5334
|
-
"type": "string",
|
|
5335
|
-
"enum": [
|
|
5336
|
-
"string",
|
|
5337
|
-
"number",
|
|
5338
|
-
"boolean",
|
|
5339
|
-
"date",
|
|
5340
|
-
"object"
|
|
5341
|
-
],
|
|
5342
|
-
"description": "Specifies the data type of the column. Use \"object\" for complex data structures."
|
|
5343
|
-
},
|
|
5344
|
-
"typings": {
|
|
5345
|
-
"type": "string",
|
|
5346
|
-
"description": "TypeScript typings for the column. Recommended if the type is \"object\", ex: \"\\{ foo: string; bar: number \\}\""
|
|
5347
|
-
},
|
|
5348
|
-
"computed": {
|
|
5349
|
-
"type": "object",
|
|
5350
|
-
"properties": {
|
|
5351
|
-
"action": {
|
|
5352
|
-
"type": "string",
|
|
5353
|
-
"enum": [
|
|
5354
|
-
"ai",
|
|
5355
|
-
"code",
|
|
5356
|
-
"workflow"
|
|
5357
|
-
]
|
|
5358
|
-
},
|
|
5359
|
-
"dependencies": {
|
|
5360
|
-
"default": [],
|
|
5361
|
-
"type": "array",
|
|
5362
|
-
"items": {
|
|
5363
|
-
"type": "string"
|
|
5364
|
-
}
|
|
5365
|
-
},
|
|
5366
|
-
"prompt": {
|
|
5367
|
-
"type": "string",
|
|
5368
|
-
"description": "Prompt when action is \"ai\""
|
|
5369
|
-
},
|
|
5370
|
-
"code": {
|
|
5371
|
-
"type": "string",
|
|
5372
|
-
"description": "Code to execute when action is \"code\""
|
|
5373
|
-
},
|
|
5374
|
-
"model": {
|
|
5375
|
-
"default": "gpt-4o",
|
|
5376
|
-
"type": "string",
|
|
5377
|
-
"maxLength": 80,
|
|
5378
|
-
"description": "Model to use when action is \"ai\""
|
|
5379
|
-
},
|
|
5380
|
-
"workflowId": {
|
|
5381
|
-
"type": "string",
|
|
5382
|
-
"maxLength": 20,
|
|
5383
|
-
"description": "ID of Workflow to execute when action is \"workflow\""
|
|
5384
|
-
},
|
|
5385
|
-
"enabled": {
|
|
5386
|
-
"type": "boolean"
|
|
5387
|
-
}
|
|
5388
|
-
},
|
|
5389
|
-
"required": [
|
|
5390
|
-
"action"
|
|
5391
|
-
],
|
|
5392
|
-
"additionalProperties": false
|
|
5393
|
-
},
|
|
5394
|
-
"schema": {
|
|
5395
|
-
"type": "object",
|
|
5396
|
-
"additionalProperties": true
|
|
5397
|
-
}
|
|
5398
|
-
},
|
|
5399
|
-
"required": [
|
|
5400
|
-
"name",
|
|
5401
|
-
"type"
|
|
5402
|
-
],
|
|
5403
|
-
"additionalProperties": false
|
|
5404
|
-
}
|
|
1955
|
+
{
|
|
1956
|
+
"status": 400,
|
|
1957
|
+
"type": "ReferenceNotFound",
|
|
1958
|
+
"description": "The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."
|
|
5405
1959
|
},
|
|
5406
|
-
|
|
5407
|
-
"
|
|
5408
|
-
"
|
|
5409
|
-
|
|
5410
|
-
|
|
5411
|
-
|
|
5412
|
-
|
|
5413
|
-
|
|
5414
|
-
|
|
5415
|
-
|
|
5416
|
-
|
|
5417
|
-
|
|
5418
|
-
|
|
5419
|
-
|
|
5420
|
-
|
|
5421
|
-
|
|
5422
|
-
|
|
5423
|
-
|
|
5424
|
-
|
|
5425
|
-
|
|
5426
|
-
|
|
5427
|
-
|
|
5428
|
-
|
|
5429
|
-
|
|
5430
|
-
|
|
5431
|
-
|
|
5432
|
-
|
|
5433
|
-
|
|
5434
|
-
|
|
5435
|
-
|
|
5436
|
-
|
|
5437
|
-
|
|
5438
|
-
|
|
5439
|
-
|
|
5440
|
-
|
|
5441
|
-
|
|
5442
|
-
|
|
5443
|
-
|
|
5444
|
-
|
|
5445
|
-
|
|
5446
|
-
|
|
5447
|
-
|
|
5448
|
-
|
|
5449
|
-
|
|
5450
|
-
|
|
5451
|
-
|
|
5452
|
-
|
|
5453
|
-
|
|
5454
|
-
|
|
5455
|
-
|
|
5456
|
-
|
|
5457
|
-
|
|
5458
|
-
|
|
5459
|
-
|
|
5460
|
-
|
|
5461
|
-
|
|
5462
|
-
|
|
5463
|
-
|
|
5464
|
-
|
|
5465
|
-
|
|
5466
|
-
|
|
1960
|
+
{
|
|
1961
|
+
"status": 400,
|
|
1962
|
+
"type": "InvalidQuery",
|
|
1963
|
+
"description": "The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."
|
|
1964
|
+
},
|
|
1965
|
+
{
|
|
1966
|
+
"status": 400,
|
|
1967
|
+
"type": "Runtime",
|
|
1968
|
+
"description": "An error happened during the execution of a runtime (bot or integration)."
|
|
1969
|
+
},
|
|
1970
|
+
{
|
|
1971
|
+
"status": 409,
|
|
1972
|
+
"type": "AlreadyExists",
|
|
1973
|
+
"description": "The record attempted to be created already exists."
|
|
1974
|
+
},
|
|
1975
|
+
{
|
|
1976
|
+
"status": 429,
|
|
1977
|
+
"type": "RateLimited",
|
|
1978
|
+
"description": "The request has been rate limited."
|
|
1979
|
+
},
|
|
1980
|
+
{
|
|
1981
|
+
"status": 402,
|
|
1982
|
+
"type": "PaymentRequired",
|
|
1983
|
+
"description": "A payment is required to perform this request."
|
|
1984
|
+
},
|
|
1985
|
+
{
|
|
1986
|
+
"status": 403,
|
|
1987
|
+
"type": "QuotaExceeded",
|
|
1988
|
+
"description": "The request exceeds the allowed quota. Quotas are a soft limit that can be increased."
|
|
1989
|
+
},
|
|
1990
|
+
{
|
|
1991
|
+
"status": 413,
|
|
1992
|
+
"type": "LimitExceeded",
|
|
1993
|
+
"description": "The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."
|
|
1994
|
+
},
|
|
1995
|
+
{
|
|
1996
|
+
"status": 400,
|
|
1997
|
+
"type": "BreakingChanges",
|
|
1998
|
+
"description": "Request payload contains breaking changes which is not allowed for this resource without a version increment."
|
|
1999
|
+
}
|
|
2000
|
+
],
|
|
2001
|
+
"refs": {
|
|
2002
|
+
"parameters": {},
|
|
2003
|
+
"requestBodies": {
|
|
2004
|
+
"upsertFileBody": true,
|
|
2005
|
+
"updateFileMetadataBody": true,
|
|
2006
|
+
"copyFileBody": true,
|
|
2007
|
+
"setFilePassagesBody": true,
|
|
2008
|
+
"createKnowledgeBaseBody": true,
|
|
2009
|
+
"updateKnowledgeBaseBody": true
|
|
2010
|
+
},
|
|
2011
|
+
"responses": {
|
|
2012
|
+
"upsertFileResponse": true,
|
|
2013
|
+
"deleteFileResponse": true,
|
|
2014
|
+
"listFilesResponse": true,
|
|
2015
|
+
"getFileResponse": true,
|
|
2016
|
+
"updateFileMetadataResponse": true,
|
|
2017
|
+
"copyFileResponse": true,
|
|
2018
|
+
"searchFilesResponse": true,
|
|
2019
|
+
"listFilePassagesResponse": true,
|
|
2020
|
+
"setFilePassagesResponse": true,
|
|
2021
|
+
"listFileTagsResponse": true,
|
|
2022
|
+
"listFileTagValuesResponse": true,
|
|
2023
|
+
"createKnowledgeBaseResponse": true,
|
|
2024
|
+
"deleteKnowledgeBaseResponse": true,
|
|
2025
|
+
"updateKnowledgeBaseResponse": true,
|
|
2026
|
+
"listKnowledgeBasesResponse": true
|
|
5467
2027
|
},
|
|
2028
|
+
"schemas": {
|
|
2029
|
+
"File": true
|
|
2030
|
+
}
|
|
2031
|
+
},
|
|
2032
|
+
"schemas": {
|
|
5468
2033
|
"File": {
|
|
5469
2034
|
"section": "files",
|
|
5470
2035
|
"schema": {
|
|
@@ -5608,155 +2173,6 @@ export const state = {
|
|
|
5608
2173
|
}
|
|
5609
2174
|
},
|
|
5610
2175
|
"sections": [
|
|
5611
|
-
{
|
|
5612
|
-
"description": "",
|
|
5613
|
-
"title": "User",
|
|
5614
|
-
"name": "user",
|
|
5615
|
-
"operations": [],
|
|
5616
|
-
"schema": "User"
|
|
5617
|
-
},
|
|
5618
|
-
{
|
|
5619
|
-
"description": "",
|
|
5620
|
-
"title": "Conversation",
|
|
5621
|
-
"name": "conversation",
|
|
5622
|
-
"operations": [],
|
|
5623
|
-
"schema": "Conversation"
|
|
5624
|
-
},
|
|
5625
|
-
{
|
|
5626
|
-
"description": "",
|
|
5627
|
-
"title": "Event",
|
|
5628
|
-
"name": "event",
|
|
5629
|
-
"operations": [],
|
|
5630
|
-
"schema": "Event"
|
|
5631
|
-
},
|
|
5632
|
-
{
|
|
5633
|
-
"description": "",
|
|
5634
|
-
"title": "Message",
|
|
5635
|
-
"name": "message",
|
|
5636
|
-
"operations": [],
|
|
5637
|
-
"schema": "Message"
|
|
5638
|
-
},
|
|
5639
|
-
{
|
|
5640
|
-
"description": "",
|
|
5641
|
-
"title": "State",
|
|
5642
|
-
"name": "state",
|
|
5643
|
-
"operations": [],
|
|
5644
|
-
"schema": "State"
|
|
5645
|
-
},
|
|
5646
|
-
{
|
|
5647
|
-
"title": "Hub",
|
|
5648
|
-
"description": "",
|
|
5649
|
-
"name": "hub",
|
|
5650
|
-
"operations": []
|
|
5651
|
-
},
|
|
5652
|
-
{
|
|
5653
|
-
"description": "",
|
|
5654
|
-
"title": "Action",
|
|
5655
|
-
"name": "action",
|
|
5656
|
-
"operations": []
|
|
5657
|
-
},
|
|
5658
|
-
{
|
|
5659
|
-
"description": "",
|
|
5660
|
-
"title": "Task",
|
|
5661
|
-
"name": "task",
|
|
5662
|
-
"operations": [],
|
|
5663
|
-
"schema": "Task"
|
|
5664
|
-
},
|
|
5665
|
-
{
|
|
5666
|
-
"description": "",
|
|
5667
|
-
"title": "Workflow",
|
|
5668
|
-
"name": "workflow",
|
|
5669
|
-
"operations": [],
|
|
5670
|
-
"schema": "Workflow"
|
|
5671
|
-
},
|
|
5672
|
-
{
|
|
5673
|
-
"description": "",
|
|
5674
|
-
"title": "Tag",
|
|
5675
|
-
"name": "tag",
|
|
5676
|
-
"operations": []
|
|
5677
|
-
},
|
|
5678
|
-
{
|
|
5679
|
-
"title": "Bot",
|
|
5680
|
-
"description": "",
|
|
5681
|
-
"name": "bot",
|
|
5682
|
-
"operations": [],
|
|
5683
|
-
"schema": "Bot"
|
|
5684
|
-
},
|
|
5685
|
-
{
|
|
5686
|
-
"title": "Integration",
|
|
5687
|
-
"description": "",
|
|
5688
|
-
"name": "integration",
|
|
5689
|
-
"operations": [],
|
|
5690
|
-
"schema": "Integration"
|
|
5691
|
-
},
|
|
5692
|
-
{
|
|
5693
|
-
"title": "Interface",
|
|
5694
|
-
"description": "",
|
|
5695
|
-
"name": "interface",
|
|
5696
|
-
"operations": [],
|
|
5697
|
-
"schema": "Interface"
|
|
5698
|
-
},
|
|
5699
|
-
{
|
|
5700
|
-
"title": "Plugin",
|
|
5701
|
-
"description": "",
|
|
5702
|
-
"name": "plugin",
|
|
5703
|
-
"operations": [],
|
|
5704
|
-
"schema": "Plugin"
|
|
5705
|
-
},
|
|
5706
|
-
{
|
|
5707
|
-
"title": "Workspace",
|
|
5708
|
-
"description": "",
|
|
5709
|
-
"name": "workspace",
|
|
5710
|
-
"operations": [],
|
|
5711
|
-
"schema": "Workspace"
|
|
5712
|
-
},
|
|
5713
|
-
{
|
|
5714
|
-
"title": "Workspace Member",
|
|
5715
|
-
"description": "",
|
|
5716
|
-
"name": "workspaceMember",
|
|
5717
|
-
"operations": [],
|
|
5718
|
-
"schema": "WorkspaceMember"
|
|
5719
|
-
},
|
|
5720
|
-
{
|
|
5721
|
-
"title": "Account",
|
|
5722
|
-
"description": "",
|
|
5723
|
-
"name": "account",
|
|
5724
|
-
"operations": [],
|
|
5725
|
-
"schema": "Account"
|
|
5726
|
-
},
|
|
5727
|
-
{
|
|
5728
|
-
"title": "Usage",
|
|
5729
|
-
"description": "",
|
|
5730
|
-
"name": "usage",
|
|
5731
|
-
"operations": [],
|
|
5732
|
-
"schema": "Usage"
|
|
5733
|
-
},
|
|
5734
|
-
{
|
|
5735
|
-
"title": "Quotas",
|
|
5736
|
-
"description": "",
|
|
5737
|
-
"name": "quotas",
|
|
5738
|
-
"operations": []
|
|
5739
|
-
},
|
|
5740
|
-
{
|
|
5741
|
-
"title": "Helper",
|
|
5742
|
-
"description": "",
|
|
5743
|
-
"name": "helper",
|
|
5744
|
-
"operations": []
|
|
5745
|
-
},
|
|
5746
|
-
{
|
|
5747
|
-
"title": "Activity",
|
|
5748
|
-
"description": "",
|
|
5749
|
-
"name": "activity",
|
|
5750
|
-
"operations": [],
|
|
5751
|
-
"schema": "Activity"
|
|
5752
|
-
},
|
|
5753
|
-
{
|
|
5754
|
-
"title": "Tables",
|
|
5755
|
-
"description": "Manage and interact with table structures, including creation, updates, and querying of tables and their rows.",
|
|
5756
|
-
"name": "tables",
|
|
5757
|
-
"operations": [],
|
|
5758
|
-
"schema": "Table"
|
|
5759
|
-
},
|
|
5760
2176
|
{
|
|
5761
2177
|
"title": "Files",
|
|
5762
2178
|
"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.",
|