@botpress/api 0.24.0 → 0.25.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.
Files changed (5) hide show
  1. package/dist/index.js +129 -52
  2. package/dist/src/gen/state.d.ts +88 -38
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +129 -52
package/dist/index.js CHANGED
@@ -274022,6 +274022,11 @@ var state = {
274022
274022
  "description": "Global identifier configuration of the [Integration](#schema_integration)",
274023
274023
  "additionalProperties": false
274024
274024
  },
274025
+ "url": {
274026
+ "type": "string",
274027
+ "maxLength": 2e3,
274028
+ "description": "Title describing the task"
274029
+ },
274025
274030
  "name": {
274026
274031
  "type": "string",
274027
274032
  "maxLength": 200,
@@ -274436,6 +274441,7 @@ var state = {
274436
274441
  "createdAt",
274437
274442
  "updatedAt",
274438
274443
  "identifier",
274444
+ "url",
274439
274445
  "name",
274440
274446
  "version",
274441
274447
  "configuration",
@@ -274527,6 +274533,11 @@ var state = {
274527
274533
  "description": "Global identifier configuration of the [Integration](#schema_integration)",
274528
274534
  "additionalProperties": false
274529
274535
  },
274536
+ "url": {
274537
+ "type": "string",
274538
+ "maxLength": 2e3,
274539
+ "description": "Title describing the task"
274540
+ },
274530
274541
  "name": {
274531
274542
  "type": "string",
274532
274543
  "maxLength": 200,
@@ -274941,6 +274952,7 @@ var state = {
274941
274952
  "createdAt",
274942
274953
  "updatedAt",
274943
274954
  "identifier",
274955
+ "url",
274944
274956
  "name",
274945
274957
  "version",
274946
274958
  "configuration",
@@ -278158,9 +278170,9 @@ var state = {
278158
278170
  "section": "integration",
278159
278171
  "path": "/v1/admin/integrations/iaks",
278160
278172
  "parameters": {
278161
- "integrationVersionId": {
278173
+ "integrationId": {
278162
278174
  "in": "query",
278163
- "description": "ID of the integration version",
278175
+ "description": "ID of the integration",
278164
278176
  "type": "string",
278165
278177
  "required": true
278166
278178
  }
@@ -278213,7 +278225,7 @@ var state = {
278213
278225
  "schema": {
278214
278226
  "type": "object",
278215
278227
  "properties": {
278216
- "integrationVersionId": {
278228
+ "integrationId": {
278217
278229
  "type": "string"
278218
278230
  },
278219
278231
  "note": {
@@ -278221,7 +278233,7 @@ var state = {
278221
278233
  }
278222
278234
  },
278223
278235
  "required": [
278224
- "integrationVersionId"
278236
+ "integrationId"
278225
278237
  ],
278226
278238
  "title": "createIntegrationApiKeyBody",
278227
278239
  "additionalProperties": false
@@ -278649,7 +278661,7 @@ var state = {
278649
278661
  },
278650
278662
  "url": {
278651
278663
  "type": "string",
278652
- "description": "URL of the integration; Only available for dev integrations"
278664
+ "description": "URL of the integration"
278653
278665
  },
278654
278666
  "dev": {
278655
278667
  "type": "boolean",
@@ -279099,7 +279111,8 @@ var state = {
279099
279111
  },
279100
279112
  "url": {
279101
279113
  "type": "string",
279102
- "description": "URL of the integration; Only available for dev integrations"
279114
+ "description": "URL of the integration",
279115
+ "nullable": true
279103
279116
  },
279104
279117
  "public": {
279105
279118
  "type": "boolean",
@@ -279663,48 +279676,44 @@ var state = {
279663
279676
  "schema": {
279664
279677
  "type": "object",
279665
279678
  "properties": {
279666
- "data": {
279667
- "nullable": true
279679
+ "name": {
279680
+ "type": "string",
279681
+ "description": "File name"
279682
+ },
279683
+ "tags": {
279684
+ "type": "object",
279685
+ "additionalProperties": {
279686
+ "type": "string",
279687
+ "maxLength": 1e3
279688
+ },
279689
+ "description": "File tags as an object of key/value pairs"
279690
+ },
279691
+ "index": {
279692
+ "default": false,
279693
+ "type": "boolean",
279694
+ "description": "Set to a value of 'true' to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota."
279695
+ },
279696
+ "accessPolicies": {
279697
+ "type": "array",
279698
+ "items": {
279699
+ "type": "string",
279700
+ "enum": [
279701
+ "public_content",
279702
+ "integrations"
279703
+ ]
279704
+ },
279705
+ "description": 'File access policies. Add "public_content" to allow public access to the file content. Add "integrations" to allow read, search and list operations for any integration installed in the bot.'
279706
+ },
279707
+ "contentType": {
279708
+ "type": "string",
279709
+ "description": 'File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is "application/octet-stream".'
279668
279710
  }
279669
279711
  },
279670
279712
  "title": "createFileBody",
279671
- "format": "binary",
279672
279713
  "additionalProperties": false
279673
279714
  }
279674
279715
  },
279675
- "parameters": {
279676
- "x-name": {
279677
- "type": "string",
279678
- "description": "File name",
279679
- "in": "header"
279680
- },
279681
- "x-tags": {
279682
- "type": "string",
279683
- "description": "File tags as URL-encoded JSON string representing an object of key-value pairs.",
279684
- "in": "header"
279685
- },
279686
- "x-access-policies": {
279687
- "type": "string",
279688
- "description": 'File access policies, comma-separated. Add "public_content" to allow public access to the file content. Add "integrations" to allo read, search and list operations for any integration installed in the bot.',
279689
- "in": "header"
279690
- },
279691
- "x-index": {
279692
- "type": "boolean",
279693
- "description": 'Set to a value of "true" to index the file in vector storage (default: false). Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.',
279694
- "in": "header"
279695
- },
279696
- "Content-Type": {
279697
- "type": "string",
279698
- "description": 'File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is "application/octet-stream".',
279699
- "in": "header"
279700
- },
279701
- "Content-Length": {
279702
- "type": "string",
279703
- "description": "File content length",
279704
- "in": "header"
279705
- }
279706
- },
279707
- "contentType": "*/*",
279716
+ "contentType": "application/json",
279708
279717
  "section": "files",
279709
279718
  "response": {
279710
279719
  "description": "The file metadata.",
@@ -279729,7 +279738,7 @@ var state = {
279729
279738
  },
279730
279739
  "size": {
279731
279740
  "type": "number",
279732
- "description": "File size in bytes",
279741
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
279733
279742
  "nullable": true
279734
279743
  },
279735
279744
  "contentType": {
@@ -279772,6 +279781,23 @@ var state = {
279772
279781
  "indexingFailureReason": {
279773
279782
  "type": "string",
279774
279783
  "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
279784
+ },
279785
+ "uploadStatus": {
279786
+ "type": "string",
279787
+ "enum": [
279788
+ "PENDING",
279789
+ "COMPLETE",
279790
+ "FAILED"
279791
+ ],
279792
+ "description": 'Status of the file upload process. If the status is "PENDING", the file content has not been uploaded yet. \nThe status will be set to "COMPLETE" once the file content has been uploaded successfully. \nIf the status is "FAILED", the file content could not be uploaded. See "uploadFailureReason" for more details.'
279793
+ },
279794
+ "uploadFailureReason": {
279795
+ "type": "string",
279796
+ "description": 'Failure reason of the file upload if the upload status is "FAILED".'
279797
+ },
279798
+ "uploadUrl": {
279799
+ "type": "string",
279800
+ "description": "URL to upload the file content. File content needs to be sent to this URL via a POST request."
279775
279801
  }
279776
279802
  },
279777
279803
  "required": [
@@ -279783,7 +279809,9 @@ var state = {
279783
279809
  "tags",
279784
279810
  "createdAt",
279785
279811
  "updatedAt",
279786
- "accessPolicies"
279812
+ "accessPolicies",
279813
+ "uploadStatus",
279814
+ "uploadUrl"
279787
279815
  ],
279788
279816
  "additionalProperties": false
279789
279817
  }
@@ -279794,7 +279822,8 @@ var state = {
279794
279822
  "title": "createFileResponse",
279795
279823
  "additionalProperties": false
279796
279824
  }
279797
- }
279825
+ },
279826
+ "parameters": {}
279798
279827
  },
279799
279828
  "deleteFile": {
279800
279829
  "name": "deleteFile",
@@ -279872,7 +279901,7 @@ var state = {
279872
279901
  },
279873
279902
  "size": {
279874
279903
  "type": "number",
279875
- "description": "File size in bytes",
279904
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
279876
279905
  "nullable": true
279877
279906
  },
279878
279907
  "contentType": {
@@ -279915,6 +279944,19 @@ var state = {
279915
279944
  "indexingFailureReason": {
279916
279945
  "type": "string",
279917
279946
  "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
279947
+ },
279948
+ "uploadStatus": {
279949
+ "type": "string",
279950
+ "enum": [
279951
+ "PENDING",
279952
+ "COMPLETE",
279953
+ "FAILED"
279954
+ ],
279955
+ "description": 'Status of the file upload process. If the status is "PENDING", the file content has not been uploaded yet. \nThe status will be set to "COMPLETE" once the file content has been uploaded successfully. \nIf the status is "FAILED", the file content could not be uploaded. See "uploadFailureReason" for more details.'
279956
+ },
279957
+ "uploadFailureReason": {
279958
+ "type": "string",
279959
+ "description": 'Failure reason of the file upload if the upload status is "FAILED".'
279918
279960
  }
279919
279961
  },
279920
279962
  "required": [
@@ -279926,7 +279968,8 @@ var state = {
279926
279968
  "tags",
279927
279969
  "createdAt",
279928
279970
  "updatedAt",
279929
- "accessPolicies"
279971
+ "accessPolicies",
279972
+ "uploadStatus"
279930
279973
  ]
279931
279974
  }
279932
279975
  },
@@ -279986,7 +280029,7 @@ var state = {
279986
280029
  },
279987
280030
  "size": {
279988
280031
  "type": "number",
279989
- "description": "File size in bytes",
280032
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
279990
280033
  "nullable": true
279991
280034
  },
279992
280035
  "contentType": {
@@ -280029,6 +280072,19 @@ var state = {
280029
280072
  "indexingFailureReason": {
280030
280073
  "type": "string",
280031
280074
  "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
280075
+ },
280076
+ "uploadStatus": {
280077
+ "type": "string",
280078
+ "enum": [
280079
+ "PENDING",
280080
+ "COMPLETE",
280081
+ "FAILED"
280082
+ ],
280083
+ "description": 'Status of the file upload process. If the status is "PENDING", the file content has not been uploaded yet. \nThe status will be set to "COMPLETE" once the file content has been uploaded successfully. \nIf the status is "FAILED", the file content could not be uploaded. See "uploadFailureReason" for more details.'
280084
+ },
280085
+ "uploadFailureReason": {
280086
+ "type": "string",
280087
+ "description": 'Failure reason of the file upload if the upload status is "FAILED".'
280032
280088
  }
280033
280089
  },
280034
280090
  "required": [
@@ -280040,7 +280096,8 @@ var state = {
280040
280096
  "tags",
280041
280097
  "createdAt",
280042
280098
  "updatedAt",
280043
- "accessPolicies"
280099
+ "accessPolicies",
280100
+ "uploadStatus"
280044
280101
  ],
280045
280102
  "additionalProperties": false
280046
280103
  }
@@ -281105,7 +281162,7 @@ var state = {
281105
281162
  "title": "Botpress API",
281106
281163
  "description": "API for Botpress Cloud",
281107
281164
  "server": "https://api.botpress.cloud",
281108
- "version": "0.24.0",
281165
+ "version": "0.25.1",
281109
281166
  "prefix": "v1"
281110
281167
  },
281111
281168
  "errors": [
@@ -281966,6 +282023,11 @@ var state = {
281966
282023
  "description": "Global identifier configuration of the [Integration](#schema_integration)",
281967
282024
  "additionalProperties": false
281968
282025
  },
282026
+ "url": {
282027
+ "type": "string",
282028
+ "maxLength": 2e3,
282029
+ "description": "Title describing the task"
282030
+ },
281969
282031
  "name": {
281970
282032
  "type": "string",
281971
282033
  "maxLength": 200,
@@ -282359,6 +282421,7 @@ var state = {
282359
282421
  "createdAt",
282360
282422
  "updatedAt",
282361
282423
  "identifier",
282424
+ "url",
282362
282425
  "name",
282363
282426
  "version",
282364
282427
  "configuration",
@@ -283433,7 +283496,7 @@ var state = {
283433
283496
  },
283434
283497
  "size": {
283435
283498
  "type": "number",
283436
- "description": "File size in bytes",
283499
+ "description": 'File size in bytes. Non-null if file upload status is "COMPLETE".',
283437
283500
  "nullable": true
283438
283501
  },
283439
283502
  "contentType": {
@@ -283476,6 +283539,19 @@ var state = {
283476
283539
  "indexingFailureReason": {
283477
283540
  "type": "string",
283478
283541
  "description": 'Last failure reason of the file indexing if the indexing status is "FAILED".'
283542
+ },
283543
+ "uploadStatus": {
283544
+ "type": "string",
283545
+ "enum": [
283546
+ "PENDING",
283547
+ "COMPLETE",
283548
+ "FAILED"
283549
+ ],
283550
+ "description": 'Status of the file upload process. If the status is "PENDING", the file content has not been uploaded yet. \nThe status will be set to "COMPLETE" once the file content has been uploaded successfully. \nIf the status is "FAILED", the file content could not be uploaded. See "uploadFailureReason" for more details.'
283551
+ },
283552
+ "uploadFailureReason": {
283553
+ "type": "string",
283554
+ "description": 'Failure reason of the file upload if the upload status is "FAILED".'
283479
283555
  }
283480
283556
  },
283481
283557
  "required": [
@@ -283487,7 +283563,8 @@ var state = {
283487
283563
  "tags",
283488
283564
  "createdAt",
283489
283565
  "updatedAt",
283490
- "accessPolicies"
283566
+ "accessPolicies",
283567
+ "uploadStatus"
283491
283568
  ],
283492
283569
  "additionalProperties": false
283493
283570
  }
package/dist/src/gen/state.d.ts CHANGED
@@ -2265,6 +2265,11 @@ export declare const state: {
2265
2265
  description: string;
2266
2266
  additionalProperties: false;
2267
2267
  };
2268
+ url: {
2269
+ type: "string";
2270
+ maxLength: number;
2271
+ description: string;
2272
+ };
2268
2273
  name: {
2269
2274
  type: "string";
2270
2275
  maxLength: number;
@@ -2700,6 +2705,11 @@ export declare const state: {
2700
2705
  description: string;
2701
2706
  additionalProperties: false;
2702
2707
  };
2708
+ url: {
2709
+ type: "string";
2710
+ maxLength: number;
2711
+ description: string;
2712
+ };
2703
2713
  name: {
2704
2714
  type: "string";
2705
2715
  maxLength: number;
@@ -5761,7 +5771,7 @@ export declare const state: {
5761
5771
  section: "integration";
5762
5772
  path: string;
5763
5773
  parameters: {
5764
- integrationVersionId: {
5774
+ integrationId: {
5765
5775
  in: "query";
5766
5776
  description: string;
5767
5777
  type: "string";
@@ -5810,7 +5820,7 @@ export declare const state: {
5810
5820
  schema: {
5811
5821
  type: "object";
5812
5822
  properties: {
5813
- integrationVersionId: {
5823
+ integrationId: {
5814
5824
  type: "string";
5815
5825
  };
5816
5826
  note: {
@@ -6631,6 +6641,7 @@ export declare const state: {
6631
6641
  url: {
6632
6642
  type: "string";
6633
6643
  description: string;
6644
+ nullable: true;
6634
6645
  };
6635
6646
  public: {
6636
6647
  type: "boolean";
@@ -7126,48 +7137,41 @@ export declare const state: {
7126
7137
  schema: {
7127
7138
  type: "object";
7128
7139
  properties: {
7129
- data: {
7130
- nullable: true;
7140
+ name: {
7141
+ type: "string";
7142
+ description: string;
7143
+ };
7144
+ tags: {
7145
+ type: "object";
7146
+ additionalProperties: {
7147
+ type: "string";
7148
+ maxLength: number;
7149
+ };
7150
+ description: string;
7151
+ };
7152
+ index: {
7153
+ default: boolean;
7154
+ type: "boolean";
7155
+ description: string;
7156
+ };
7157
+ accessPolicies: {
7158
+ type: "array";
7159
+ items: {
7160
+ type: "string";
7161
+ enum: string[];
7162
+ };
7163
+ description: string;
7164
+ };
7165
+ contentType: {
7166
+ type: "string";
7167
+ description: string;
7131
7168
  };
7132
7169
  };
7133
7170
  title: string;
7134
- format: string;
7135
7171
  additionalProperties: false;
7136
7172
  };
7137
7173
  };
7138
- parameters: {
7139
- "x-name": {
7140
- type: "string";
7141
- description: string;
7142
- in: "header";
7143
- };
7144
- "x-tags": {
7145
- type: "string";
7146
- description: string;
7147
- in: "header";
7148
- };
7149
- "x-access-policies": {
7150
- type: "string";
7151
- description: string;
7152
- in: "header";
7153
- };
7154
- "x-index": {
7155
- type: "boolean";
7156
- description: string;
7157
- in: "header";
7158
- };
7159
- "Content-Type": {
7160
- type: "string";
7161
- description: string;
7162
- in: "header";
7163
- };
7164
- "Content-Length": {
7165
- type: "string";
7166
- description: string;
7167
- in: "header";
7168
- };
7169
- };
7170
- contentType: "*/*";
7174
+ contentType: "application/json";
7171
7175
  section: "files";
7172
7176
  response: {
7173
7177
  description: string;
@@ -7231,6 +7235,19 @@ export declare const state: {
7231
7235
  type: "string";
7232
7236
  description: string;
7233
7237
  };
7238
+ uploadStatus: {
7239
+ type: "string";
7240
+ enum: string[];
7241
+ description: string;
7242
+ };
7243
+ uploadFailureReason: {
7244
+ type: "string";
7245
+ description: string;
7246
+ };
7247
+ uploadUrl: {
7248
+ type: "string";
7249
+ description: string;
7250
+ };
7234
7251
  };
7235
7252
  required: string[];
7236
7253
  additionalProperties: false;
@@ -7241,6 +7258,7 @@ export declare const state: {
7241
7258
  additionalProperties: false;
7242
7259
  };
7243
7260
  };
7261
+ parameters: {};
7244
7262
  };
7245
7263
  deleteFile: {
7246
7264
  name: string;
@@ -7357,6 +7375,15 @@ export declare const state: {
7357
7375
  type: "string";
7358
7376
  description: string;
7359
7377
  };
7378
+ uploadStatus: {
7379
+ type: "string";
7380
+ enum: string[];
7381
+ description: string;
7382
+ };
7383
+ uploadFailureReason: {
7384
+ type: "string";
7385
+ description: string;
7386
+ };
7360
7387
  };
7361
7388
  required: string[];
7362
7389
  };
@@ -7453,6 +7480,15 @@ export declare const state: {
7453
7480
  type: "string";
7454
7481
  description: string;
7455
7482
  };
7483
+ uploadStatus: {
7484
+ type: "string";
7485
+ enum: string[];
7486
+ description: string;
7487
+ };
7488
+ uploadFailureReason: {
7489
+ type: "string";
7490
+ description: string;
7491
+ };
7456
7492
  };
7457
7493
  required: string[];
7458
7494
  additionalProperties: false;
@@ -9147,6 +9183,11 @@ export declare const state: {
9147
9183
  description: string;
9148
9184
  additionalProperties: false;
9149
9185
  };
9186
+ url: {
9187
+ type: "string";
9188
+ maxLength: number;
9189
+ description: string;
9190
+ };
9150
9191
  name: {
9151
9192
  type: "string";
9152
9193
  maxLength: number;
@@ -10383,6 +10424,15 @@ export declare const state: {
10383
10424
  type: "string";
10384
10425
  description: string;
10385
10426
  };
10427
+ uploadStatus: {
10428
+ type: "string";
10429
+ enum: string[];
10430
+ description: string;
10431
+ };
10432
+ uploadFailureReason: {
10433
+ type: "string";
10434
+ description: string;
10435
+ };
10386
10436
  };
10387
10437
  required: string[];
10388
10438
  additionalProperties: false;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "0.24.0",
3
+ "version": "0.25.1",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {