@botpress/api 0.18.4 → 0.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +734 -171
- package/dist/src/gen/state.d.ts +615 -112
- package/dist/src/index.d.ts +2 -2
- package/package.json +4 -4
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +709 -158
package/src/gen/state.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/* prettier-ignore */
|
|
4
4
|
import * as opapi from '@bpinternal/opapi'
|
|
5
|
-
export type State = opapi.State<'Bot' | 'Integration' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | '
|
|
5
|
+
export type State = opapi.State<'Bot' | 'Integration' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'file' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>
|
|
6
6
|
export const state = {
|
|
7
7
|
"operations": {
|
|
8
8
|
"createConversation": {
|
|
@@ -2585,6 +2585,57 @@ export const state = {
|
|
|
2585
2585
|
"description": "Subscriptions of the bot",
|
|
2586
2586
|
"additionalProperties": false
|
|
2587
2587
|
},
|
|
2588
|
+
"actions": {
|
|
2589
|
+
"type": "object",
|
|
2590
|
+
"additionalProperties": {
|
|
2591
|
+
"type": "object",
|
|
2592
|
+
"properties": {
|
|
2593
|
+
"title": {
|
|
2594
|
+
"type": "string",
|
|
2595
|
+
"maxLength": 64,
|
|
2596
|
+
"description": "Title of the action"
|
|
2597
|
+
},
|
|
2598
|
+
"description": {
|
|
2599
|
+
"type": "string",
|
|
2600
|
+
"maxLength": 256,
|
|
2601
|
+
"description": "Description of the action"
|
|
2602
|
+
},
|
|
2603
|
+
"input": {
|
|
2604
|
+
"type": "object",
|
|
2605
|
+
"properties": {
|
|
2606
|
+
"schema": {
|
|
2607
|
+
"type": "object",
|
|
2608
|
+
"additionalProperties": true
|
|
2609
|
+
}
|
|
2610
|
+
},
|
|
2611
|
+
"required": [
|
|
2612
|
+
"schema"
|
|
2613
|
+
],
|
|
2614
|
+
"additionalProperties": false
|
|
2615
|
+
},
|
|
2616
|
+
"output": {
|
|
2617
|
+
"type": "object",
|
|
2618
|
+
"properties": {
|
|
2619
|
+
"schema": {
|
|
2620
|
+
"type": "object",
|
|
2621
|
+
"additionalProperties": true
|
|
2622
|
+
}
|
|
2623
|
+
},
|
|
2624
|
+
"required": [
|
|
2625
|
+
"schema"
|
|
2626
|
+
],
|
|
2627
|
+
"additionalProperties": false
|
|
2628
|
+
}
|
|
2629
|
+
},
|
|
2630
|
+
"required": [
|
|
2631
|
+
"input",
|
|
2632
|
+
"output"
|
|
2633
|
+
],
|
|
2634
|
+
"description": "Action definition",
|
|
2635
|
+
"additionalProperties": false
|
|
2636
|
+
},
|
|
2637
|
+
"description": "Actions definition"
|
|
2638
|
+
},
|
|
2588
2639
|
"configuration": {
|
|
2589
2640
|
"type": "object",
|
|
2590
2641
|
"properties": {
|
|
@@ -2899,6 +2950,57 @@ export const state = {
|
|
|
2899
2950
|
"additionalProperties": false
|
|
2900
2951
|
}
|
|
2901
2952
|
},
|
|
2953
|
+
"actions": {
|
|
2954
|
+
"type": "object",
|
|
2955
|
+
"additionalProperties": {
|
|
2956
|
+
"type": "object",
|
|
2957
|
+
"properties": {
|
|
2958
|
+
"title": {
|
|
2959
|
+
"type": "string",
|
|
2960
|
+
"maxLength": 64,
|
|
2961
|
+
"description": "Title of the action"
|
|
2962
|
+
},
|
|
2963
|
+
"description": {
|
|
2964
|
+
"type": "string",
|
|
2965
|
+
"maxLength": 256,
|
|
2966
|
+
"description": "Description of the action"
|
|
2967
|
+
},
|
|
2968
|
+
"input": {
|
|
2969
|
+
"type": "object",
|
|
2970
|
+
"properties": {
|
|
2971
|
+
"schema": {
|
|
2972
|
+
"type": "object",
|
|
2973
|
+
"additionalProperties": true
|
|
2974
|
+
}
|
|
2975
|
+
},
|
|
2976
|
+
"required": [
|
|
2977
|
+
"schema"
|
|
2978
|
+
],
|
|
2979
|
+
"additionalProperties": false
|
|
2980
|
+
},
|
|
2981
|
+
"output": {
|
|
2982
|
+
"type": "object",
|
|
2983
|
+
"properties": {
|
|
2984
|
+
"schema": {
|
|
2985
|
+
"type": "object",
|
|
2986
|
+
"additionalProperties": true
|
|
2987
|
+
}
|
|
2988
|
+
},
|
|
2989
|
+
"required": [
|
|
2990
|
+
"schema"
|
|
2991
|
+
],
|
|
2992
|
+
"additionalProperties": false
|
|
2993
|
+
}
|
|
2994
|
+
},
|
|
2995
|
+
"required": [
|
|
2996
|
+
"input",
|
|
2997
|
+
"output"
|
|
2998
|
+
],
|
|
2999
|
+
"description": "Action definition",
|
|
3000
|
+
"nullable": true,
|
|
3001
|
+
"additionalProperties": false
|
|
3002
|
+
}
|
|
3003
|
+
},
|
|
2902
3004
|
"states": {
|
|
2903
3005
|
"type": "object",
|
|
2904
3006
|
"additionalProperties": {
|
|
@@ -3955,6 +4057,45 @@ export const state = {
|
|
|
3955
4057
|
}
|
|
3956
4058
|
}
|
|
3957
4059
|
},
|
|
4060
|
+
"getUpcomingInvoice": {
|
|
4061
|
+
"name": "getUpcomingInvoice",
|
|
4062
|
+
"description": "Get upcoming invoice for workspace",
|
|
4063
|
+
"method": "get",
|
|
4064
|
+
"path": "/v1/admin/workspaces/{id}/billing/upcoming-invoice",
|
|
4065
|
+
"disableDefaultParameters": {
|
|
4066
|
+
"x-workspace-id": true
|
|
4067
|
+
},
|
|
4068
|
+
"parameters": {
|
|
4069
|
+
"id": {
|
|
4070
|
+
"type": "string",
|
|
4071
|
+
"description": "Workspace ID",
|
|
4072
|
+
"in": "path"
|
|
4073
|
+
}
|
|
4074
|
+
},
|
|
4075
|
+
"section": "workspace",
|
|
4076
|
+
"response": {
|
|
4077
|
+
"description": "Success",
|
|
4078
|
+
"schema": {
|
|
4079
|
+
"type": "object",
|
|
4080
|
+
"properties": {
|
|
4081
|
+
"id": {
|
|
4082
|
+
"type": "string",
|
|
4083
|
+
"description": "ID of the invoice."
|
|
4084
|
+
},
|
|
4085
|
+
"total": {
|
|
4086
|
+
"type": "number",
|
|
4087
|
+
"description": "Total amount to pay of the invoice."
|
|
4088
|
+
}
|
|
4089
|
+
},
|
|
4090
|
+
"required": [
|
|
4091
|
+
"id",
|
|
4092
|
+
"total"
|
|
4093
|
+
],
|
|
4094
|
+
"title": "getUpcomingInvoiceResponse",
|
|
4095
|
+
"additionalProperties": false
|
|
4096
|
+
}
|
|
4097
|
+
}
|
|
4098
|
+
},
|
|
3958
4099
|
"chargeWorkspaceUnpaidInvoices": {
|
|
3959
4100
|
"name": "chargeWorkspaceUnpaidInvoices",
|
|
3960
4101
|
"description": "Charge unpaid invoices of a workspace.",
|
|
@@ -6962,131 +7103,179 @@ export const state = {
|
|
|
6962
7103
|
},
|
|
6963
7104
|
"createFile": {
|
|
6964
7105
|
"name": "createFile",
|
|
6965
|
-
"
|
|
7106
|
+
"path": "/v1/files",
|
|
7107
|
+
"description": "Creates a file.",
|
|
6966
7108
|
"method": "post",
|
|
6967
|
-
"path": "/v1/storage/files",
|
|
6968
|
-
"section": "file",
|
|
6969
7109
|
"requestBody": {
|
|
6970
|
-
"description": "
|
|
7110
|
+
"description": "The file to upload.",
|
|
6971
7111
|
"schema": {
|
|
6972
7112
|
"type": "object",
|
|
6973
7113
|
"properties": {
|
|
6974
|
-
"
|
|
6975
|
-
"
|
|
6976
|
-
"format": "uuid",
|
|
6977
|
-
"description": "ID of the bot the file will be used for"
|
|
6978
|
-
},
|
|
6979
|
-
"contents": {
|
|
6980
|
-
"type": "string",
|
|
6981
|
-
"description": "Base64-encoded file contents"
|
|
6982
|
-
},
|
|
6983
|
-
"name": {
|
|
6984
|
-
"type": "string",
|
|
6985
|
-
"description": "Optional arbitrary file name (e.g. my-image.jpg), will be used for display purposes only."
|
|
6986
|
-
},
|
|
6987
|
-
"accessType": {
|
|
6988
|
-
"type": "string",
|
|
6989
|
-
"enum": [
|
|
6990
|
-
"private",
|
|
6991
|
-
"public"
|
|
6992
|
-
],
|
|
6993
|
-
"description": "Accepted values: private, public"
|
|
7114
|
+
"data": {
|
|
7115
|
+
"nullable": true
|
|
6994
7116
|
}
|
|
6995
7117
|
},
|
|
6996
|
-
"required": [
|
|
6997
|
-
"botId",
|
|
6998
|
-
"contents",
|
|
6999
|
-
"name",
|
|
7000
|
-
"accessType"
|
|
7001
|
-
],
|
|
7002
7118
|
"title": "createFileBody",
|
|
7119
|
+
"format": "binary",
|
|
7003
7120
|
"additionalProperties": false
|
|
7004
7121
|
}
|
|
7005
7122
|
},
|
|
7006
|
-
"response": {
|
|
7007
|
-
"description": "Success",
|
|
7008
|
-
"schema": {
|
|
7009
|
-
"type": "object",
|
|
7010
|
-
"properties": {
|
|
7011
|
-
"file": {
|
|
7012
|
-
"$ref": "#/components/schemas/File"
|
|
7013
|
-
}
|
|
7014
|
-
},
|
|
7015
|
-
"required": [
|
|
7016
|
-
"file"
|
|
7017
|
-
],
|
|
7018
|
-
"title": "createFileResponse",
|
|
7019
|
-
"additionalProperties": false
|
|
7020
|
-
}
|
|
7021
|
-
},
|
|
7022
|
-
"parameters": {}
|
|
7023
|
-
},
|
|
7024
|
-
"getFile": {
|
|
7025
|
-
"name": "getFile",
|
|
7026
|
-
"description": "Get File",
|
|
7027
|
-
"method": "get",
|
|
7028
|
-
"path": "/v1/storage/files/{id}",
|
|
7029
|
-
"section": "file",
|
|
7030
7123
|
"parameters": {
|
|
7031
|
-
"
|
|
7124
|
+
"x-filename": {
|
|
7032
7125
|
"type": "string",
|
|
7033
|
-
"description": "File
|
|
7034
|
-
"in": "
|
|
7126
|
+
"description": "File name",
|
|
7127
|
+
"in": "header",
|
|
7128
|
+
"required": true
|
|
7129
|
+
},
|
|
7130
|
+
"x-tags": {
|
|
7131
|
+
"type": "string",
|
|
7132
|
+
"description": "File tags as URL-encoded JSON string representing an object of key-value pairs.",
|
|
7133
|
+
"in": "header"
|
|
7134
|
+
},
|
|
7135
|
+
"x-access-policies": {
|
|
7136
|
+
"type": "string",
|
|
7137
|
+
"description": "File access policies",
|
|
7138
|
+
"in": "header"
|
|
7139
|
+
},
|
|
7140
|
+
"Content-Type": {
|
|
7141
|
+
"type": "string",
|
|
7142
|
+
"description": "File content type",
|
|
7143
|
+
"in": "header"
|
|
7144
|
+
},
|
|
7145
|
+
"Content-Length": {
|
|
7146
|
+
"type": "string",
|
|
7147
|
+
"description": "File content length",
|
|
7148
|
+
"in": "header"
|
|
7149
|
+
},
|
|
7150
|
+
"x-bot-id": {
|
|
7151
|
+
"in": "header",
|
|
7152
|
+
"description": "Bot id",
|
|
7153
|
+
"type": "string",
|
|
7154
|
+
"required": true
|
|
7155
|
+
},
|
|
7156
|
+
"x-integration-id": {
|
|
7157
|
+
"in": "header",
|
|
7158
|
+
"description": "Integration id",
|
|
7159
|
+
"type": "string",
|
|
7160
|
+
"required": false
|
|
7161
|
+
},
|
|
7162
|
+
"x-user-id": {
|
|
7163
|
+
"in": "header",
|
|
7164
|
+
"description": "User id",
|
|
7165
|
+
"type": "string",
|
|
7166
|
+
"required": false
|
|
7167
|
+
},
|
|
7168
|
+
"x-user-role": {
|
|
7169
|
+
"in": "header",
|
|
7170
|
+
"description": "User role",
|
|
7171
|
+
"type": "string",
|
|
7172
|
+
"required": false
|
|
7035
7173
|
}
|
|
7036
7174
|
},
|
|
7175
|
+
"contentType": "*/*",
|
|
7176
|
+
"section": "files",
|
|
7037
7177
|
"response": {
|
|
7038
|
-
"description": "
|
|
7178
|
+
"description": "The file metadata.",
|
|
7039
7179
|
"schema": {
|
|
7040
7180
|
"type": "object",
|
|
7041
7181
|
"properties": {
|
|
7042
7182
|
"file": {
|
|
7043
|
-
"
|
|
7183
|
+
"type": "object",
|
|
7184
|
+
"properties": {
|
|
7185
|
+
"id": {
|
|
7186
|
+
"type": "string"
|
|
7187
|
+
},
|
|
7188
|
+
"botId": {
|
|
7189
|
+
"type": "string"
|
|
7190
|
+
},
|
|
7191
|
+
"filename": {
|
|
7192
|
+
"type": "string"
|
|
7193
|
+
},
|
|
7194
|
+
"bytes": {
|
|
7195
|
+
"type": "number",
|
|
7196
|
+
"nullable": true
|
|
7197
|
+
},
|
|
7198
|
+
"tags": {
|
|
7199
|
+
"type": "object",
|
|
7200
|
+
"additionalProperties": {
|
|
7201
|
+
"type": "string",
|
|
7202
|
+
"maxLength": 1000
|
|
7203
|
+
},
|
|
7204
|
+
"description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
|
|
7205
|
+
},
|
|
7206
|
+
"createdAt": {
|
|
7207
|
+
"type": "string"
|
|
7208
|
+
},
|
|
7209
|
+
"updatedAt": {
|
|
7210
|
+
"type": "string"
|
|
7211
|
+
},
|
|
7212
|
+
"accessPolicies": {
|
|
7213
|
+
"type": "array",
|
|
7214
|
+
"items": {
|
|
7215
|
+
"type": "string"
|
|
7216
|
+
}
|
|
7217
|
+
}
|
|
7218
|
+
},
|
|
7219
|
+
"required": [
|
|
7220
|
+
"id",
|
|
7221
|
+
"botId",
|
|
7222
|
+
"filename",
|
|
7223
|
+
"bytes",
|
|
7224
|
+
"tags",
|
|
7225
|
+
"createdAt",
|
|
7226
|
+
"updatedAt",
|
|
7227
|
+
"accessPolicies"
|
|
7228
|
+
],
|
|
7229
|
+
"additionalProperties": false
|
|
7044
7230
|
}
|
|
7045
7231
|
},
|
|
7046
7232
|
"required": [
|
|
7047
7233
|
"file"
|
|
7048
7234
|
],
|
|
7049
|
-
"title": "
|
|
7235
|
+
"title": "createFileResponse",
|
|
7050
7236
|
"additionalProperties": false
|
|
7051
7237
|
}
|
|
7052
7238
|
}
|
|
7053
7239
|
},
|
|
7054
|
-
"downloadFile": {
|
|
7055
|
-
"name": "downloadFile",
|
|
7056
|
-
"description": "Download File",
|
|
7057
|
-
"method": "get",
|
|
7058
|
-
"path": "/v1/storage/files/{id}/download",
|
|
7059
|
-
"section": "file",
|
|
7060
|
-
"parameters": {
|
|
7061
|
-
"id": {
|
|
7062
|
-
"type": "string",
|
|
7063
|
-
"description": "File ID",
|
|
7064
|
-
"in": "path"
|
|
7065
|
-
}
|
|
7066
|
-
},
|
|
7067
|
-
"response": {
|
|
7068
|
-
"description": "Raw file contents",
|
|
7069
|
-
"schema": {
|
|
7070
|
-
"nullable": true,
|
|
7071
|
-
"title": "downloadFileResponse"
|
|
7072
|
-
}
|
|
7073
|
-
}
|
|
7074
|
-
},
|
|
7075
7240
|
"deleteFile": {
|
|
7076
7241
|
"name": "deleteFile",
|
|
7077
|
-
"
|
|
7242
|
+
"path": "/v1/files/{id}",
|
|
7243
|
+
"description": "Deletes a file.",
|
|
7078
7244
|
"method": "delete",
|
|
7079
|
-
"
|
|
7080
|
-
"section": "file",
|
|
7245
|
+
"section": "files",
|
|
7081
7246
|
"parameters": {
|
|
7082
7247
|
"id": {
|
|
7083
7248
|
"type": "string",
|
|
7084
7249
|
"description": "File ID",
|
|
7085
7250
|
"in": "path"
|
|
7251
|
+
},
|
|
7252
|
+
"x-bot-id": {
|
|
7253
|
+
"in": "header",
|
|
7254
|
+
"description": "Bot id",
|
|
7255
|
+
"type": "string",
|
|
7256
|
+
"required": true
|
|
7257
|
+
},
|
|
7258
|
+
"x-integration-id": {
|
|
7259
|
+
"in": "header",
|
|
7260
|
+
"description": "Integration id",
|
|
7261
|
+
"type": "string",
|
|
7262
|
+
"required": false
|
|
7263
|
+
},
|
|
7264
|
+
"x-user-id": {
|
|
7265
|
+
"in": "header",
|
|
7266
|
+
"description": "User id",
|
|
7267
|
+
"type": "string",
|
|
7268
|
+
"required": false
|
|
7269
|
+
},
|
|
7270
|
+
"x-user-role": {
|
|
7271
|
+
"in": "header",
|
|
7272
|
+
"description": "User role",
|
|
7273
|
+
"type": "string",
|
|
7274
|
+
"required": false
|
|
7086
7275
|
}
|
|
7087
7276
|
},
|
|
7088
7277
|
"response": {
|
|
7089
|
-
"description": "
|
|
7278
|
+
"description": "Empty response.",
|
|
7090
7279
|
"schema": {
|
|
7091
7280
|
"type": "object",
|
|
7092
7281
|
"title": "deleteFileResponse",
|
|
@@ -7096,32 +7285,96 @@ export const state = {
|
|
|
7096
7285
|
},
|
|
7097
7286
|
"listFiles": {
|
|
7098
7287
|
"name": "listFiles",
|
|
7099
|
-
"
|
|
7288
|
+
"path": "/v1/files/bot/{botId}",
|
|
7289
|
+
"description": "List files for bot",
|
|
7100
7290
|
"method": "get",
|
|
7101
|
-
"
|
|
7102
|
-
"section": "file",
|
|
7291
|
+
"section": "files",
|
|
7103
7292
|
"parameters": {
|
|
7104
7293
|
"nextToken": {
|
|
7105
7294
|
"in": "query",
|
|
7106
7295
|
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
7107
7296
|
"type": "string"
|
|
7108
7297
|
},
|
|
7109
|
-
"
|
|
7110
|
-
"in": "
|
|
7298
|
+
"x-bot-id": {
|
|
7299
|
+
"in": "header",
|
|
7300
|
+
"description": "Bot id",
|
|
7111
7301
|
"type": "string",
|
|
7112
|
-
"description": "Bot ID",
|
|
7113
7302
|
"required": true
|
|
7114
|
-
}
|
|
7303
|
+
},
|
|
7304
|
+
"x-integration-id": {
|
|
7305
|
+
"in": "header",
|
|
7306
|
+
"description": "Integration id",
|
|
7307
|
+
"type": "string",
|
|
7308
|
+
"required": false
|
|
7309
|
+
},
|
|
7310
|
+
"x-user-id": {
|
|
7311
|
+
"in": "header",
|
|
7312
|
+
"description": "User id",
|
|
7313
|
+
"type": "string",
|
|
7314
|
+
"required": false
|
|
7315
|
+
},
|
|
7316
|
+
"x-user-role": {
|
|
7317
|
+
"in": "header",
|
|
7318
|
+
"description": "User role",
|
|
7319
|
+
"type": "string",
|
|
7320
|
+
"required": false
|
|
7321
|
+
},
|
|
7322
|
+
"botId": {
|
|
7323
|
+
"type": "string",
|
|
7324
|
+
"description": "Bot ID",
|
|
7325
|
+
"in": "path"
|
|
7326
|
+
},
|
|
7327
|
+
"tags": {
|
|
7328
|
+
"in": "query",
|
|
7329
|
+
"type": "string",
|
|
7330
|
+
"description": "Tags to filter files by as a JSON string representing an object of key-value pairs to match files' tags against."
|
|
7331
|
+
}
|
|
7115
7332
|
},
|
|
7116
7333
|
"response": {
|
|
7117
|
-
"description": "
|
|
7334
|
+
"description": "Returns the list of files related to the bot.",
|
|
7118
7335
|
"schema": {
|
|
7119
7336
|
"type": "object",
|
|
7120
7337
|
"properties": {
|
|
7121
7338
|
"files": {
|
|
7122
7339
|
"type": "array",
|
|
7123
7340
|
"items": {
|
|
7124
|
-
"
|
|
7341
|
+
"type": "object",
|
|
7342
|
+
"properties": {
|
|
7343
|
+
"id": {
|
|
7344
|
+
"type": "string"
|
|
7345
|
+
},
|
|
7346
|
+
"botId": {
|
|
7347
|
+
"type": "string"
|
|
7348
|
+
},
|
|
7349
|
+
"filename": {
|
|
7350
|
+
"type": "string"
|
|
7351
|
+
},
|
|
7352
|
+
"bytes": {
|
|
7353
|
+
"type": "number",
|
|
7354
|
+
"nullable": true
|
|
7355
|
+
},
|
|
7356
|
+
"createdAt": {
|
|
7357
|
+
"type": "string"
|
|
7358
|
+
},
|
|
7359
|
+
"updatedAt": {
|
|
7360
|
+
"type": "string"
|
|
7361
|
+
},
|
|
7362
|
+
"accessPolicies": {
|
|
7363
|
+
"type": "array",
|
|
7364
|
+
"items": {
|
|
7365
|
+
"type": "string"
|
|
7366
|
+
}
|
|
7367
|
+
}
|
|
7368
|
+
},
|
|
7369
|
+
"required": [
|
|
7370
|
+
"id",
|
|
7371
|
+
"botId",
|
|
7372
|
+
"filename",
|
|
7373
|
+
"bytes",
|
|
7374
|
+
"createdAt",
|
|
7375
|
+
"updatedAt",
|
|
7376
|
+
"accessPolicies"
|
|
7377
|
+
]
|
|
7125
7378
|
}
|
|
7126
7379
|
},
|
|
7127
7380
|
"meta": {
|
|
@@ -7144,6 +7397,239 @@ export const state = {
|
|
|
7144
7397
|
}
|
|
7145
7398
|
}
|
|
7146
7399
|
},
|
|
7400
|
+
"getFileMetadata": {
|
|
7401
|
+
"name": "getFileMetadata",
|
|
7402
|
+
"path": "/v1/files/{id}/metadata",
|
|
7403
|
+
"description": "Get file metadata",
|
|
7404
|
+
"method": "get",
|
|
7405
|
+
"section": "files",
|
|
7406
|
+
"parameters": {
|
|
7407
|
+
"id": {
|
|
7408
|
+
"type": "string",
|
|
7409
|
+
"description": "File ID",
|
|
7410
|
+
"in": "path"
|
|
7411
|
+
},
|
|
7412
|
+
"x-bot-id": {
|
|
7413
|
+
"in": "header",
|
|
7414
|
+
"description": "Bot id",
|
|
7415
|
+
"type": "string",
|
|
7416
|
+
"required": true
|
|
7417
|
+
},
|
|
7418
|
+
"x-integration-id": {
|
|
7419
|
+
"in": "header",
|
|
7420
|
+
"description": "Integration id",
|
|
7421
|
+
"type": "string",
|
|
7422
|
+
"required": false
|
|
7423
|
+
},
|
|
7424
|
+
"x-user-id": {
|
|
7425
|
+
"in": "header",
|
|
7426
|
+
"description": "User id",
|
|
7427
|
+
"type": "string",
|
|
7428
|
+
"required": false
|
|
7429
|
+
},
|
|
7430
|
+
"x-user-role": {
|
|
7431
|
+
"in": "header",
|
|
7432
|
+
"description": "User role",
|
|
7433
|
+
"type": "string",
|
|
7434
|
+
"required": false
|
|
7435
|
+
}
|
|
7436
|
+
},
|
|
7437
|
+
"response": {
|
|
7438
|
+
"description": "The metadata of the file.",
|
|
7439
|
+
"schema": {
|
|
7440
|
+
"type": "object",
|
|
7441
|
+
"properties": {
|
|
7442
|
+
"file": {
|
|
7443
|
+
"type": "object",
|
|
7444
|
+
"properties": {
|
|
7445
|
+
"id": {
|
|
7446
|
+
"type": "string"
|
|
7447
|
+
},
|
|
7448
|
+
"botId": {
|
|
7449
|
+
"type": "string"
|
|
7450
|
+
},
|
|
7451
|
+
"filename": {
|
|
7452
|
+
"type": "string"
|
|
7453
|
+
},
|
|
7454
|
+
"bytes": {
|
|
7455
|
+
"type": "number",
|
|
7456
|
+
"nullable": true
|
|
7457
|
+
},
|
|
7458
|
+
"tags": {
|
|
7459
|
+
"type": "object",
|
|
7460
|
+
"additionalProperties": {
|
|
7461
|
+
"type": "string",
|
|
7462
|
+
"maxLength": 1000
|
|
7463
|
+
},
|
|
7464
|
+
"description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
|
|
7465
|
+
},
|
|
7466
|
+
"createdAt": {
|
|
7467
|
+
"type": "string"
|
|
7468
|
+
},
|
|
7469
|
+
"updatedAt": {
|
|
7470
|
+
"type": "string"
|
|
7471
|
+
},
|
|
7472
|
+
"accessPolicies": {
|
|
7473
|
+
"type": "array",
|
|
7474
|
+
"items": {
|
|
7475
|
+
"type": "string"
|
|
7476
|
+
}
|
|
7477
|
+
}
|
|
7478
|
+
},
|
|
7479
|
+
"required": [
|
|
7480
|
+
"id",
|
|
7481
|
+
"botId",
|
|
7482
|
+
"filename",
|
|
7483
|
+
"bytes",
|
|
7484
|
+
"tags",
|
|
7485
|
+
"createdAt",
|
|
7486
|
+
"updatedAt",
|
|
7487
|
+
"accessPolicies"
|
|
7488
|
+
],
|
|
7489
|
+
"additionalProperties": false
|
|
7490
|
+
}
|
|
7491
|
+
},
|
|
7492
|
+
"required": [
|
|
7493
|
+
"file"
|
|
7494
|
+
],
|
|
7495
|
+
"title": "getFileMetadataResponse",
|
|
7496
|
+
"additionalProperties": false
|
|
7497
|
+
}
|
|
7498
|
+
}
|
|
7499
|
+
},
|
|
7500
|
+
"getFileContent": {
|
|
7501
|
+
"name": "getFileContent",
|
|
7502
|
+
"path": "/v1/files/{id}/content",
|
|
7503
|
+
"description": "Gets a file content",
|
|
7504
|
+
"method": "get",
|
|
7505
|
+
"section": "files",
|
|
7506
|
+
"parameters": {
|
|
7507
|
+
"id": {
|
|
7508
|
+
"type": "string",
|
|
7509
|
+
"description": "File ID",
|
|
7510
|
+
"in": "path"
|
|
7511
|
+
},
|
|
7512
|
+
"x-bot-id": {
|
|
7513
|
+
"in": "header",
|
|
7514
|
+
"description": "Bot id",
|
|
7515
|
+
"type": "string",
|
|
7516
|
+
"required": true
|
|
7517
|
+
},
|
|
7518
|
+
"x-integration-id": {
|
|
7519
|
+
"in": "header",
|
|
7520
|
+
"description": "Integration id",
|
|
7521
|
+
"type": "string",
|
|
7522
|
+
"required": false
|
|
7523
|
+
},
|
|
7524
|
+
"x-user-id": {
|
|
7525
|
+
"in": "header",
|
|
7526
|
+
"description": "User id",
|
|
7527
|
+
"type": "string",
|
|
7528
|
+
"required": false
|
|
7529
|
+
},
|
|
7530
|
+
"x-user-role": {
|
|
7531
|
+
"in": "header",
|
|
7532
|
+
"description": "User role",
|
|
7533
|
+
"type": "string",
|
|
7534
|
+
"required": false
|
|
7535
|
+
}
|
|
7536
|
+
},
|
|
7537
|
+
"response": {
|
|
7538
|
+
"description": "Redirects to a presigned URL to download the file content.",
|
|
7539
|
+
"status": 302,
|
|
7540
|
+
"schema": {
|
|
7541
|
+
"type": "object",
|
|
7542
|
+
"properties": {
|
|
7543
|
+
"data": {
|
|
7544
|
+
"nullable": true
|
|
7545
|
+
}
|
|
7546
|
+
},
|
|
7547
|
+
"title": "getFileContentResponse",
|
|
7548
|
+
"format": "binary",
|
|
7549
|
+
"additionalProperties": false
|
|
7550
|
+
}
|
|
7551
|
+
}
|
|
7552
|
+
},
|
|
7553
|
+
"updateFileMetadata": {
|
|
7554
|
+
"name": "updateFileMetadata",
|
|
7555
|
+
"path": "/v1/files/{id}/metadata",
|
|
7556
|
+
"description": "Update file metadata",
|
|
7557
|
+
"method": "put",
|
|
7558
|
+
"section": "files",
|
|
7559
|
+
"parameters": {
|
|
7560
|
+
"id": {
|
|
7561
|
+
"type": "string",
|
|
7562
|
+
"description": "File ID",
|
|
7563
|
+
"in": "path"
|
|
7564
|
+
},
|
|
7565
|
+
"x-bot-id": {
|
|
7566
|
+
"in": "header",
|
|
7567
|
+
"description": "Bot id",
|
|
7568
|
+
"type": "string",
|
|
7569
|
+
"required": true
|
|
7570
|
+
},
|
|
7571
|
+
"x-integration-id": {
|
|
7572
|
+
"in": "header",
|
|
7573
|
+
"description": "Integration id",
|
|
7574
|
+
"type": "string",
|
|
7575
|
+
"required": false
|
|
7576
|
+
},
|
|
7577
|
+
"x-user-id": {
|
|
7578
|
+
"in": "header",
|
|
7579
|
+
"description": "User id",
|
|
7580
|
+
"type": "string",
|
|
7581
|
+
"required": false
|
|
7582
|
+
},
|
|
7583
|
+
"x-user-role": {
|
|
7584
|
+
"in": "header",
|
|
7585
|
+
"description": "User role",
|
|
7586
|
+
"type": "string",
|
|
7587
|
+
"required": false
|
|
7588
|
+
}
|
|
7589
|
+
},
|
|
7590
|
+
"requestBody": {
|
|
7591
|
+
"description": "File metadata to update.",
|
|
7592
|
+
"schema": {
|
|
7593
|
+
"type": "object",
|
|
7594
|
+
"properties": {
|
|
7595
|
+
"tags": {
|
|
7596
|
+
"type": "object",
|
|
7597
|
+
"additionalProperties": {
|
|
7598
|
+
"type": "string",
|
|
7599
|
+
"maxLength": 1000
|
|
7600
|
+
},
|
|
7601
|
+
"description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
|
|
7602
|
+
}
|
|
7603
|
+
},
|
|
7604
|
+
"required": [
|
|
7605
|
+
"tags"
|
|
7606
|
+
],
|
|
7607
|
+
"title": "updateFileMetadataBody",
|
|
7608
|
+
"additionalProperties": false
|
|
7609
|
+
}
|
|
7610
|
+
},
|
|
7611
|
+
"response": {
|
|
7612
|
+
"description": "An object containing the updated metadata of the file.",
|
|
7613
|
+
"schema": {
|
|
7614
|
+
"type": "object",
|
|
7615
|
+
"properties": {
|
|
7616
|
+
"tags": {
|
|
7617
|
+
"type": "object",
|
|
7618
|
+
"additionalProperties": {
|
|
7619
|
+
"type": "string",
|
|
7620
|
+
"maxLength": 1000
|
|
7621
|
+
},
|
|
7622
|
+
"description": "The tags to update as an object of key/value pairs. A tag key can be set to a null value to delete it."
|
|
7623
|
+
}
|
|
7624
|
+
},
|
|
7625
|
+
"required": [
|
|
7626
|
+
"tags"
|
|
7627
|
+
],
|
|
7628
|
+
"title": "updateFileMetadataResponse",
|
|
7629
|
+
"additionalProperties": false
|
|
7630
|
+
}
|
|
7631
|
+
}
|
|
7632
|
+
},
|
|
7147
7633
|
"listTables": {
|
|
7148
7634
|
"name": "listTables",
|
|
7149
7635
|
"path": "/v1/tables",
|
|
@@ -7852,7 +8338,7 @@ export const state = {
|
|
|
7852
8338
|
"title": "Botpress API",
|
|
7853
8339
|
"description": "API for Botpress Cloud",
|
|
7854
8340
|
"server": "https://api.botpress.cloud",
|
|
7855
|
-
"version": "0.
|
|
8341
|
+
"version": "0.19.0",
|
|
7856
8342
|
"prefix": "v1"
|
|
7857
8343
|
},
|
|
7858
8344
|
"errors": [
|
|
@@ -8008,6 +8494,7 @@ export const state = {
|
|
|
8008
8494
|
"changeAISpendQuotaBody": true,
|
|
8009
8495
|
"introspectBody": true,
|
|
8010
8496
|
"createFileBody": true,
|
|
8497
|
+
"updateFileMetadataBody": true,
|
|
8011
8498
|
"createTableBody": true,
|
|
8012
8499
|
"updateTableBody": true,
|
|
8013
8500
|
"renameTableColumnBody": true,
|
|
@@ -8080,6 +8567,7 @@ export const state = {
|
|
|
8080
8567
|
"getWorkspaceBillingDetailsResponse": true,
|
|
8081
8568
|
"setWorkspacePaymentMethodResponse": true,
|
|
8082
8569
|
"listWorkspaceInvoicesResponse": true,
|
|
8570
|
+
"getUpcomingInvoiceResponse": true,
|
|
8083
8571
|
"chargeWorkspaceUnpaidInvoicesResponse": true,
|
|
8084
8572
|
"createWorkspaceResponse": true,
|
|
8085
8573
|
"getPublicWorkspaceResponse": true,
|
|
@@ -8112,10 +8600,11 @@ export const state = {
|
|
|
8112
8600
|
"listActivitiesResponse": true,
|
|
8113
8601
|
"introspectResponse": true,
|
|
8114
8602
|
"createFileResponse": true,
|
|
8115
|
-
"getFileResponse": true,
|
|
8116
|
-
"downloadFileResponse": true,
|
|
8117
8603
|
"deleteFileResponse": true,
|
|
8118
8604
|
"listFilesResponse": true,
|
|
8605
|
+
"getFileMetadataResponse": true,
|
|
8606
|
+
"getFileContentResponse": true,
|
|
8607
|
+
"updateFileMetadataResponse": true,
|
|
8119
8608
|
"listTablesResponse": true,
|
|
8120
8609
|
"getTableResponse": true,
|
|
8121
8610
|
"createTableResponse": true,
|
|
@@ -8145,10 +8634,10 @@ export const state = {
|
|
|
8145
8634
|
"Message": true,
|
|
8146
8635
|
"State": true,
|
|
8147
8636
|
"Task": true,
|
|
8148
|
-
"File": true,
|
|
8149
8637
|
"Table": true,
|
|
8150
8638
|
"Column": true,
|
|
8151
|
-
"Row": true
|
|
8639
|
+
"Row": true,
|
|
8640
|
+
"File": true
|
|
8152
8641
|
}
|
|
8153
8642
|
},
|
|
8154
8643
|
"schemas": {
|
|
@@ -8528,6 +9017,57 @@ export const state = {
|
|
|
8528
9017
|
"description": "Subscriptions of the bot",
|
|
8529
9018
|
"additionalProperties": false
|
|
8530
9019
|
},
|
|
9020
|
+
"actions": {
|
|
9021
|
+
"type": "object",
|
|
9022
|
+
"additionalProperties": {
|
|
9023
|
+
"type": "object",
|
|
9024
|
+
"properties": {
|
|
9025
|
+
"title": {
|
|
9026
|
+
"type": "string",
|
|
9027
|
+
"maxLength": 64,
|
|
9028
|
+
"description": "Title of the action"
|
|
9029
|
+
},
|
|
9030
|
+
"description": {
|
|
9031
|
+
"type": "string",
|
|
9032
|
+
"maxLength": 256,
|
|
9033
|
+
"description": "Description of the action"
|
|
9034
|
+
},
|
|
9035
|
+
"input": {
|
|
9036
|
+
"type": "object",
|
|
9037
|
+
"properties": {
|
|
9038
|
+
"schema": {
|
|
9039
|
+
"type": "object",
|
|
9040
|
+
"additionalProperties": true
|
|
9041
|
+
}
|
|
9042
|
+
},
|
|
9043
|
+
"required": [
|
|
9044
|
+
"schema"
|
|
9045
|
+
],
|
|
9046
|
+
"additionalProperties": false
|
|
9047
|
+
},
|
|
9048
|
+
"output": {
|
|
9049
|
+
"type": "object",
|
|
9050
|
+
"properties": {
|
|
9051
|
+
"schema": {
|
|
9052
|
+
"type": "object",
|
|
9053
|
+
"additionalProperties": true
|
|
9054
|
+
}
|
|
9055
|
+
},
|
|
9056
|
+
"required": [
|
|
9057
|
+
"schema"
|
|
9058
|
+
],
|
|
9059
|
+
"additionalProperties": false
|
|
9060
|
+
}
|
|
9061
|
+
},
|
|
9062
|
+
"required": [
|
|
9063
|
+
"input",
|
|
9064
|
+
"output"
|
|
9065
|
+
],
|
|
9066
|
+
"description": "Action definition",
|
|
9067
|
+
"additionalProperties": false
|
|
9068
|
+
},
|
|
9069
|
+
"description": "Actions definition"
|
|
9070
|
+
},
|
|
8531
9071
|
"name": {
|
|
8532
9072
|
"type": "string",
|
|
8533
9073
|
"description": "Name of the [Bot](#schema_bot)"
|
|
@@ -8593,6 +9133,7 @@ export const state = {
|
|
|
8593
9133
|
"events",
|
|
8594
9134
|
"recurringEvents",
|
|
8595
9135
|
"subscriptions",
|
|
9136
|
+
"actions",
|
|
8596
9137
|
"name",
|
|
8597
9138
|
"dev",
|
|
8598
9139
|
"alwaysAlive",
|
|
@@ -9855,56 +10396,6 @@ export const state = {
|
|
|
9855
10396
|
"additionalProperties": false
|
|
9856
10397
|
}
|
|
9857
10398
|
},
|
|
9858
|
-
"File": {
|
|
9859
|
-
"section": "file",
|
|
9860
|
-
"schema": {
|
|
9861
|
-
"type": "object",
|
|
9862
|
-
"properties": {
|
|
9863
|
-
"botId": {
|
|
9864
|
-
"type": "string",
|
|
9865
|
-
"format": "uuid",
|
|
9866
|
-
"description": "ID of the bot the file will be used for"
|
|
9867
|
-
},
|
|
9868
|
-
"name": {
|
|
9869
|
-
"type": "string",
|
|
9870
|
-
"description": "Optional arbitrary file name (e.g. my-image.jpg), will be used for display purposes only."
|
|
9871
|
-
},
|
|
9872
|
-
"accessType": {
|
|
9873
|
-
"type": "string",
|
|
9874
|
-
"enum": [
|
|
9875
|
-
"private",
|
|
9876
|
-
"public"
|
|
9877
|
-
],
|
|
9878
|
-
"description": "Accepted values: private, public"
|
|
9879
|
-
},
|
|
9880
|
-
"id": {
|
|
9881
|
-
"type": "string",
|
|
9882
|
-
"description": "ID of the [File](#schema_file)"
|
|
9883
|
-
},
|
|
9884
|
-
"createdAt": {
|
|
9885
|
-
"type": "string",
|
|
9886
|
-
"description": "Creation date of the [File](#schema_file) in ISO 8601 format"
|
|
9887
|
-
},
|
|
9888
|
-
"size": {
|
|
9889
|
-
"type": "number",
|
|
9890
|
-
"description": "Size of the file in bytes"
|
|
9891
|
-
},
|
|
9892
|
-
"publicUrl": {
|
|
9893
|
-
"type": "string",
|
|
9894
|
-
"description": "Public URL to the file contents, available only if the access type is public. If the file is private, use the Download endpoint to retrieve the file contents."
|
|
9895
|
-
}
|
|
9896
|
-
},
|
|
9897
|
-
"required": [
|
|
9898
|
-
"botId",
|
|
9899
|
-
"name",
|
|
9900
|
-
"accessType",
|
|
9901
|
-
"id",
|
|
9902
|
-
"createdAt",
|
|
9903
|
-
"size"
|
|
9904
|
-
],
|
|
9905
|
-
"additionalProperties": false
|
|
9906
|
-
}
|
|
9907
|
-
},
|
|
9908
10399
|
"Table": {
|
|
9909
10400
|
"section": "tables",
|
|
9910
10401
|
"schema": {
|
|
@@ -10127,6 +10618,58 @@ export const state = {
|
|
|
10127
10618
|
],
|
|
10128
10619
|
"additionalProperties": true
|
|
10129
10620
|
}
|
|
10621
|
+
},
|
|
10622
|
+
"File": {
|
|
10623
|
+
"section": "files",
|
|
10624
|
+
"schema": {
|
|
10625
|
+
"type": "object",
|
|
10626
|
+
"properties": {
|
|
10627
|
+
"id": {
|
|
10628
|
+
"type": "string"
|
|
10629
|
+
},
|
|
10630
|
+
"botId": {
|
|
10631
|
+
"type": "string"
|
|
10632
|
+
},
|
|
10633
|
+
"filename": {
|
|
10634
|
+
"type": "string"
|
|
10635
|
+
},
|
|
10636
|
+
"bytes": {
|
|
10637
|
+
"type": "number",
|
|
10638
|
+
"nullable": true
|
|
10639
|
+
},
|
|
10640
|
+
"tags": {
|
|
10641
|
+
"type": "object",
|
|
10642
|
+
"additionalProperties": {
|
|
10643
|
+
"type": "string",
|
|
10644
|
+
"maxLength": 1000
|
|
10645
|
+
},
|
|
10646
|
+
"description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
|
|
10647
|
+
},
|
|
10648
|
+
"createdAt": {
|
|
10649
|
+
"type": "string"
|
|
10650
|
+
},
|
|
10651
|
+
"updatedAt": {
|
|
10652
|
+
"type": "string"
|
|
10653
|
+
},
|
|
10654
|
+
"accessPolicies": {
|
|
10655
|
+
"type": "array",
|
|
10656
|
+
"items": {
|
|
10657
|
+
"type": "string"
|
|
10658
|
+
}
|
|
10659
|
+
}
|
|
10660
|
+
},
|
|
10661
|
+
"required": [
|
|
10662
|
+
"id",
|
|
10663
|
+
"botId",
|
|
10664
|
+
"filename",
|
|
10665
|
+
"bytes",
|
|
10666
|
+
"tags",
|
|
10667
|
+
"createdAt",
|
|
10668
|
+
"updatedAt",
|
|
10669
|
+
"accessPolicies"
|
|
10670
|
+
],
|
|
10671
|
+
"additionalProperties": false
|
|
10672
|
+
}
|
|
10130
10673
|
}
|
|
10131
10674
|
},
|
|
10132
10675
|
"sections": [
|
|
@@ -10191,14 +10734,7 @@ export const state = {
|
|
|
10191
10734
|
"description": "",
|
|
10192
10735
|
"title": "File",
|
|
10193
10736
|
"name": "file",
|
|
10194
|
-
"operations": [
|
|
10195
|
-
"createFile",
|
|
10196
|
-
"getFile",
|
|
10197
|
-
"downloadFile",
|
|
10198
|
-
"deleteFile",
|
|
10199
|
-
"listFiles"
|
|
10200
|
-
],
|
|
10201
|
-
"schema": "File"
|
|
10737
|
+
"operations": []
|
|
10202
10738
|
},
|
|
10203
10739
|
{
|
|
10204
10740
|
"description": "",
|
|
@@ -10286,6 +10822,7 @@ export const state = {
|
|
|
10286
10822
|
"getWorkspaceBillingDetails",
|
|
10287
10823
|
"setWorkspacePaymentMethod",
|
|
10288
10824
|
"listWorkspaceInvoices",
|
|
10825
|
+
"getUpcomingInvoice",
|
|
10289
10826
|
"chargeWorkspaceUnpaidInvoices",
|
|
10290
10827
|
"createWorkspace",
|
|
10291
10828
|
"getPublicWorkspace",
|
|
@@ -10384,6 +10921,20 @@ export const state = {
|
|
|
10384
10921
|
"upsertTableRows"
|
|
10385
10922
|
],
|
|
10386
10923
|
"schema": "Table"
|
|
10924
|
+
},
|
|
10925
|
+
{
|
|
10926
|
+
"title": "Files",
|
|
10927
|
+
"description": "Operations related to file management.",
|
|
10928
|
+
"name": "files",
|
|
10929
|
+
"operations": [
|
|
10930
|
+
"createFile",
|
|
10931
|
+
"deleteFile",
|
|
10932
|
+
"listFiles",
|
|
10933
|
+
"getFileMetadata",
|
|
10934
|
+
"getFileContent",
|
|
10935
|
+
"updateFileMetadata"
|
|
10936
|
+
],
|
|
10937
|
+
"schema": "File"
|
|
10387
10938
|
}
|
|
10388
10939
|
],
|
|
10389
10940
|
"options": {
|