losant_rest 1.22.4 → 1.23.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 (79) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +1623 -142
  3. data/docs/file.md +3 -3
  4. data/docs/files.md +2 -2
  5. data/docs/privateFile.md +222 -0
  6. data/docs/privateFiles.md +97 -0
  7. data/lib/platform_rest/client.rb +10 -2
  8. data/lib/platform_rest/file.rb +3 -3
  9. data/lib/platform_rest/files.rb +1 -1
  10. data/lib/platform_rest/private_file.rb +230 -0
  11. data/lib/platform_rest/private_files.rb +146 -0
  12. data/lib/platform_rest/version.rb +1 -1
  13. data/lib/platform_rest.rb +2 -0
  14. data/schemas/apiTokenPost.json +12 -2
  15. data/schemas/application.json +7 -0
  16. data/schemas/applicationClonePost.json +4 -0
  17. data/schemas/applicationCreationByTemplateResult.json +7 -0
  18. data/schemas/applicationDashboardPost.json +3 -1
  19. data/schemas/applicationExportPost.json +4 -0
  20. data/schemas/applicationImportExecutions.json +2 -0
  21. data/schemas/applicationPatch.json +4 -0
  22. data/schemas/applicationPost.json +4 -0
  23. data/schemas/applicationTemplate.json +3 -0
  24. data/schemas/applicationTemplates.json +3 -0
  25. data/schemas/applications.json +7 -0
  26. data/schemas/auditLog.json +1 -0
  27. data/schemas/auditLogFilter.json +1 -0
  28. data/schemas/auditLogs.json +1 -0
  29. data/schemas/credentialLinkedResources.json +18 -0
  30. data/schemas/dashboard.json +3 -1
  31. data/schemas/dashboardBlockSuggestCodePost.json +620 -0
  32. data/schemas/dashboardBlockSuggestCodeResponse.json +49 -0
  33. data/schemas/dashboardPatch.json +3 -1
  34. data/schemas/dashboardPost.json +3 -1
  35. data/schemas/dashboardUpdateEvents.json +25 -0
  36. data/schemas/dashboards.json +3 -1
  37. data/schemas/event.json +81 -0
  38. data/schemas/eventPatch.json +25 -0
  39. data/schemas/eventPlusNewCount.json +81 -0
  40. data/schemas/events.json +81 -0
  41. data/schemas/eventsExport.json +8 -0
  42. data/schemas/experienceLinkedResources.json +18 -0
  43. data/schemas/fileUploadPostResponse.json +103 -82
  44. data/schemas/files.json +1 -1
  45. data/schemas/flow.json +6 -0
  46. data/schemas/flowPatch.json +6 -0
  47. data/schemas/flowPost.json +6 -0
  48. data/schemas/flowVersion.json +12 -0
  49. data/schemas/flowVersionPost.json +6 -0
  50. data/schemas/flowVersions.json +12 -0
  51. data/schemas/flows.json +6 -0
  52. data/schemas/flowsImportPost.json +12 -0
  53. data/schemas/flowsImportResult.json +18 -0
  54. data/schemas/githubLogin.json +12 -2
  55. data/schemas/historicalSummaries.json +10 -0
  56. data/schemas/historicalSummary.json +10 -0
  57. data/schemas/importIntoApplicationOptions.json +1 -0
  58. data/schemas/importNewApplicationOptions.json +1 -0
  59. data/schemas/instance.json +7 -0
  60. data/schemas/instanceOrg.json +7 -0
  61. data/schemas/instanceOrgPatch.json +4 -0
  62. data/schemas/instanceOrgPost.json +4 -0
  63. data/schemas/instanceOrgs.json +7 -0
  64. data/schemas/instancePatch.json +4 -0
  65. data/schemas/instanceSandbox.json +6 -0
  66. data/schemas/instanceSandboxes.json +6 -0
  67. data/schemas/instances.json +7 -0
  68. data/schemas/me.json +6 -0
  69. data/schemas/notebook.json +17 -0
  70. data/schemas/notebookPatch.json +17 -0
  71. data/schemas/notebookPost.json +17 -0
  72. data/schemas/notebooks.json +17 -0
  73. data/schemas/org.json +7 -0
  74. data/schemas/orgs.json +7 -0
  75. data/schemas/samlResponse.json +12 -2
  76. data/schemas/suggestFunctionResponse.json +13 -1
  77. data/schemas/userCredentials.json +12 -2
  78. data/schemas/userPost.json +12 -2
  79. metadata +8 -2
data/docs/_schemas.md CHANGED
@@ -67,6 +67,8 @@
67
67
  * [Credential Post](#credential-post)
68
68
  * [Credentials](#credentials)
69
69
  * [Dashboard](#dashboard)
70
+ * [Dashboard Block Suggest Code Post](#dashboard-block-suggest-code-post)
71
+ * [Suggest Function Respone](#suggest-function-respone)
70
72
  * [Dashboard Context Instance](#dashboard-context-instance)
71
73
  * [Dashboard Patch](#dashboard-patch)
72
74
  * [Dashboard Post](#dashboard-post)
@@ -14106,10 +14108,12 @@ Schema for the body of an API Token creation request
14106
14108
  "flows.*",
14107
14109
  "flowVersion.*",
14108
14110
  "flowVersions.*",
14109
- "resourceJobs.*",
14110
- "resourceJob.*",
14111
14111
  "notebook.*",
14112
14112
  "notebooks.*",
14113
+ "privateFile.*",
14114
+ "privateFiles.*",
14115
+ "resourceJobs.*",
14116
+ "resourceJob.*",
14113
14117
  "webhook.*",
14114
14118
  "webhooks.*",
14115
14119
  "application.applyTemplate",
@@ -14346,6 +14350,13 @@ Schema for the body of an API Token creation request
14346
14350
  "notebook.upload",
14347
14351
  "notebooks.get",
14348
14352
  "notebooks.post",
14353
+ "privateFile.get",
14354
+ "privateFile.patch",
14355
+ "privateFile.move",
14356
+ "privateFile.delete",
14357
+ "privateFile.upload",
14358
+ "privateFiles.get",
14359
+ "privateFiles.post",
14349
14360
  "resourceJob.get",
14350
14361
  "resourceJob.logs",
14351
14362
  "resourceJob.patch",
@@ -14382,6 +14393,7 @@ Schema for the body of an API Token creation request
14382
14393
  "dashboard.patch",
14383
14394
  "dashboard.delete",
14384
14395
  "dashboard.sendReport",
14396
+ "dashboard.suggestCode",
14385
14397
  "dashboards.get",
14386
14398
  "dashboards.post",
14387
14399
  "org.get",
@@ -14926,6 +14938,9 @@ Schema for a single Application
14926
14938
  "notebookCount": {
14927
14939
  "type": "integer"
14928
14940
  },
14941
+ "privateFileCount": {
14942
+ "type": "integer"
14943
+ },
14929
14944
  "resourceJobCount": {
14930
14945
  "type": "integer"
14931
14946
  },
@@ -15228,6 +15243,10 @@ Schema for a single Application
15228
15243
  "type": "boolean",
15229
15244
  "default": false
15230
15245
  },
15246
+ "includePrivateFiles": {
15247
+ "type": "boolean",
15248
+ "default": false
15249
+ },
15231
15250
  "includeDataTableRows": {
15232
15251
  "type": "boolean",
15233
15252
  "default": false
@@ -16451,6 +16470,10 @@ Schema for the body of an application clone request
16451
16470
  "type": "boolean",
16452
16471
  "default": false
16453
16472
  },
16473
+ "includePrivateFiles": {
16474
+ "type": "boolean",
16475
+ "default": false
16476
+ },
16454
16477
  "includeDataTableRows": {
16455
16478
  "type": "boolean",
16456
16479
  "default": false
@@ -16692,6 +16715,9 @@ Schema for creating an application by template result
16692
16715
  "notebookCount": {
16693
16716
  "type": "integer"
16694
16717
  },
16718
+ "privateFileCount": {
16719
+ "type": "integer"
16720
+ },
16695
16721
  "resourceJobCount": {
16696
16722
  "type": "integer"
16697
16723
  },
@@ -16994,6 +17020,10 @@ Schema for creating an application by template result
16994
17020
  "type": "boolean",
16995
17021
  "default": false
16996
17022
  },
17023
+ "includePrivateFiles": {
17024
+ "type": "boolean",
17025
+ "default": false
17026
+ },
16997
17027
  "includeDataTableRows": {
16998
17028
  "type": "boolean",
16999
17029
  "default": false
@@ -18127,8 +18157,10 @@ Schema for the body of an Application scoped Dashboard creation request
18127
18157
  "vegaLite3",
18128
18158
  "vegaLite4",
18129
18159
  "vegaLite5",
18160
+ "vegaLite6",
18130
18161
  "vega4",
18131
- "vega5"
18162
+ "vega5",
18163
+ "vega6"
18132
18164
  ]
18133
18165
  },
18134
18166
  "tooltipEventSubscribe": {
@@ -23624,6 +23656,10 @@ Schema for the body of an application export request
23624
23656
  "type": "boolean",
23625
23657
  "default": false
23626
23658
  },
23659
+ "includePrivateFiles": {
23660
+ "type": "boolean",
23661
+ "default": false
23662
+ },
23627
23663
  "includeDataTableRows": {
23628
23664
  "type": "boolean",
23629
23665
  "default": false
@@ -23886,6 +23922,7 @@ Schema for a list Application import executions
23886
23922
  "Global",
23887
23923
  "Integration",
23888
23924
  "Notebook",
23925
+ "PrivateFile",
23889
23926
  "Webhook",
23890
23927
  "ResourceJob"
23891
23928
  ]
@@ -23947,6 +23984,7 @@ Schema for a list Application import executions
23947
23984
  "Global",
23948
23985
  "Integration",
23949
23986
  "Notebook",
23987
+ "PrivateFile",
23950
23988
  "Webhook",
23951
23989
  "ResourceJob"
23952
23990
  ]
@@ -25438,6 +25476,10 @@ Schema for the body of an Application modification request
25438
25476
  "type": "boolean",
25439
25477
  "default": false
25440
25478
  },
25479
+ "includePrivateFiles": {
25480
+ "type": "boolean",
25481
+ "default": false
25482
+ },
25441
25483
  "includeDataTableRows": {
25442
25484
  "type": "boolean",
25443
25485
  "default": false
@@ -25752,6 +25794,10 @@ Schema for the body of an Application creation request
25752
25794
  "type": "boolean",
25753
25795
  "default": false
25754
25796
  },
25797
+ "includePrivateFiles": {
25798
+ "type": "boolean",
25799
+ "default": false
25800
+ },
25755
25801
  "includeDataTableRows": {
25756
25802
  "type": "boolean",
25757
25803
  "default": false
@@ -26222,6 +26268,9 @@ Schema for a single Application Template
26222
26268
  "notebookCount": {
26223
26269
  "type": "integer"
26224
26270
  },
26271
+ "privateFileCount": {
26272
+ "type": "integer"
26273
+ },
26225
26274
  "resourceJobCount": {
26226
26275
  "type": "integer"
26227
26276
  },
@@ -26264,6 +26313,7 @@ Schema for a single Application Template
26264
26313
  "flowCount": 1,
26265
26314
  "integrationCount": 0,
26266
26315
  "notebookCount": 0,
26316
+ "privateFileCount": 0,
26267
26317
  "resourceJobCount": 0,
26268
26318
  "dataTableCsvSize": 4008,
26269
26319
  "webhookCount": 0
@@ -26540,6 +26590,9 @@ Schema for a collection of Application Templates
26540
26590
  "notebookCount": {
26541
26591
  "type": "integer"
26542
26592
  },
26593
+ "privateFileCount": {
26594
+ "type": "integer"
26595
+ },
26543
26596
  "resourceJobCount": {
26544
26597
  "type": "integer"
26545
26598
  },
@@ -26630,6 +26683,7 @@ Schema for a collection of Application Templates
26630
26683
  "flowCount": 1,
26631
26684
  "integrationCount": 0,
26632
26685
  "notebookCount": 0,
26686
+ "privateFileCount": 0,
26633
26687
  "resourceJobCount": 0,
26634
26688
  "dataTableCsvSize": 4008,
26635
26689
  "webhookCount": 0
@@ -26833,6 +26887,9 @@ Schema for a collection of Applications
26833
26887
  "notebookCount": {
26834
26888
  "type": "integer"
26835
26889
  },
26890
+ "privateFileCount": {
26891
+ "type": "integer"
26892
+ },
26836
26893
  "resourceJobCount": {
26837
26894
  "type": "integer"
26838
26895
  },
@@ -27135,6 +27192,10 @@ Schema for a collection of Applications
27135
27192
  "type": "boolean",
27136
27193
  "default": false
27137
27194
  },
27195
+ "includePrivateFiles": {
27196
+ "type": "boolean",
27197
+ "default": false
27198
+ },
27138
27199
  "includeDataTableRows": {
27139
27200
  "type": "boolean",
27140
27201
  "default": false
@@ -27455,6 +27516,7 @@ Schema for a single Audit Log entry
27455
27516
  "Flow",
27456
27517
  "Integration",
27457
27518
  "Notebook",
27519
+ "PrivateFile",
27458
27520
  "ResourceJob",
27459
27521
  "Webhook"
27460
27522
  ]
@@ -27608,6 +27670,7 @@ Schema for the filter of an audit log query
27608
27670
  "Flow",
27609
27671
  "Integration",
27610
27672
  "Notebook",
27673
+ "PrivateFile",
27611
27674
  "ResourceJob",
27612
27675
  "Webhook"
27613
27676
  ]
@@ -27778,6 +27841,7 @@ Schema for a collection of Audit Logs
27778
27841
  "Flow",
27779
27842
  "Integration",
27780
27843
  "Notebook",
27844
+ "PrivateFile",
27781
27845
  "ResourceJob",
27782
27846
  "Webhook"
27783
27847
  ]
@@ -29290,6 +29354,12 @@ The body of an credential linked resources response
29290
29354
  },
29291
29355
  "update": {
29292
29356
  "type": "boolean"
29357
+ },
29358
+ "public": {
29359
+ "type": "boolean"
29360
+ },
29361
+ "private": {
29362
+ "type": "boolean"
29293
29363
  }
29294
29364
  },
29295
29365
  "additionalProperties": false
@@ -32421,6 +32491,12 @@ The body of an credential linked resources response
32421
32491
  },
32422
32492
  "update": {
32423
32493
  "type": "boolean"
32494
+ },
32495
+ "public": {
32496
+ "type": "boolean"
32497
+ },
32498
+ "private": {
32499
+ "type": "boolean"
32424
32500
  }
32425
32501
  },
32426
32502
  "additionalProperties": false
@@ -35461,6 +35537,12 @@ The body of an credential linked resources response
35461
35537
  },
35462
35538
  "update": {
35463
35539
  "type": "boolean"
35540
+ },
35541
+ "public": {
35542
+ "type": "boolean"
35543
+ },
35544
+ "private": {
35545
+ "type": "boolean"
35464
35546
  }
35465
35547
  },
35466
35548
  "additionalProperties": false
@@ -40591,8 +40673,10 @@ Schema for a single Dashboard
40591
40673
  "vegaLite3",
40592
40674
  "vegaLite4",
40593
40675
  "vegaLite5",
40676
+ "vegaLite6",
40594
40677
  "vega4",
40595
- "vega5"
40678
+ "vega5",
40679
+ "vega6"
40596
40680
  ]
40597
40681
  },
40598
40682
  "tooltipEventSubscribe": {
@@ -46037,6 +46121,746 @@ Schema for a single Dashboard
46037
46121
 
46038
46122
  <br/>
46039
46123
 
46124
+ ## Dashboard Block Suggest Code Post
46125
+
46126
+ Schema for the body of a dashboard block code suggestion request
46127
+
46128
+ ### <a name="dashboard-block-suggest-code-post-schema"></a> Schema
46129
+
46130
+ ```json
46131
+ {
46132
+ "$schema": "http://json-schema.org/draft-07/schema#",
46133
+ "type": "object",
46134
+ "properties": {
46135
+ "text": {
46136
+ "type": "string",
46137
+ "minLength": 1,
46138
+ "maxLength": 8192
46139
+ },
46140
+ "blockConfig": {
46141
+ "type": "object",
46142
+ "properties": {
46143
+ "id": {
46144
+ "type": "string",
46145
+ "maxLength": 48
46146
+ },
46147
+ "title": {
46148
+ "type": "string",
46149
+ "maxLength": 255
46150
+ },
46151
+ "description": {
46152
+ "type": "string",
46153
+ "maxLength": 32767
46154
+ },
46155
+ "applicationId": {
46156
+ "type": "string",
46157
+ "pattern": "^[A-Fa-f\\d]{24}$"
46158
+ },
46159
+ "startX": {
46160
+ "type": "number"
46161
+ },
46162
+ "startY": {
46163
+ "type": "number"
46164
+ },
46165
+ "width": {
46166
+ "type": "number"
46167
+ },
46168
+ "height": {
46169
+ "type": "number"
46170
+ },
46171
+ "blockType": {
46172
+ "type": "string",
46173
+ "enum": [
46174
+ "custom-chart",
46175
+ "custom-html"
46176
+ ]
46177
+ },
46178
+ "config": {
46179
+ "type": "object",
46180
+ "properties": {
46181
+ "configuration": {
46182
+ "oneOf": [
46183
+ {
46184
+ "type": "object",
46185
+ "properties": {
46186
+ "headContent": {
46187
+ "type": "string",
46188
+ "maxLength": 32767
46189
+ },
46190
+ "bodyContent": {
46191
+ "type": "string",
46192
+ "maxLength": 32767
46193
+ }
46194
+ },
46195
+ "additionalProperties": false
46196
+ },
46197
+ {
46198
+ "type": "string",
46199
+ "maxLength": 32767
46200
+ }
46201
+ ]
46202
+ },
46203
+ "segments": {
46204
+ "type": "array",
46205
+ "maxItems": 100,
46206
+ "items": {
46207
+ "oneOf": [
46208
+ {
46209
+ "type": "object",
46210
+ "properties": {
46211
+ "queryType": {
46212
+ "type": "string",
46213
+ "enum": [
46214
+ "time-series"
46215
+ ]
46216
+ },
46217
+ "id": {
46218
+ "type": "string",
46219
+ "maxLength": 48
46220
+ },
46221
+ "attribute": {
46222
+ "type": "string",
46223
+ "maxLength": 255
46224
+ },
46225
+ "aggregation": {
46226
+ "oneOf": [
46227
+ {
46228
+ "oneOf": [
46229
+ {
46230
+ "type": "string",
46231
+ "enum": [
46232
+ "FIRST",
46233
+ "LAST",
46234
+ "COUNT",
46235
+ "MAX",
46236
+ "MIN",
46237
+ "MEDIAN",
46238
+ "MEAN",
46239
+ "SUM",
46240
+ "STD_DEV"
46241
+ ]
46242
+ },
46243
+ {
46244
+ "type": "string",
46245
+ "enum": [
46246
+ "NONE"
46247
+ ]
46248
+ }
46249
+ ]
46250
+ },
46251
+ {
46252
+ "type": "object",
46253
+ "properties": {
46254
+ "type": {
46255
+ "oneOf": [
46256
+ {
46257
+ "type": "string",
46258
+ "enum": [
46259
+ "FIRST",
46260
+ "LAST",
46261
+ "COUNT",
46262
+ "MAX",
46263
+ "MIN",
46264
+ "MEDIAN",
46265
+ "MEAN",
46266
+ "SUM",
46267
+ "STD_DEV"
46268
+ ]
46269
+ },
46270
+ {
46271
+ "type": "string",
46272
+ "enum": [
46273
+ "NONE"
46274
+ ]
46275
+ }
46276
+ ]
46277
+ },
46278
+ "options": {
46279
+ "type": "object",
46280
+ "additionalProperties": false
46281
+ }
46282
+ },
46283
+ "additionalProperties": false,
46284
+ "required": [
46285
+ "type"
46286
+ ]
46287
+ },
46288
+ {
46289
+ "type": "object",
46290
+ "properties": {
46291
+ "type": {
46292
+ "type": "string",
46293
+ "enum": [
46294
+ "TIMEATVALUE"
46295
+ ]
46296
+ },
46297
+ "options": {
46298
+ "type": "object",
46299
+ "properties": {
46300
+ "value": {
46301
+ "oneOf": [
46302
+ {
46303
+ "type": "string",
46304
+ "maxLength": 255
46305
+ },
46306
+ {
46307
+ "type": "number"
46308
+ },
46309
+ {
46310
+ "type": "boolean"
46311
+ }
46312
+ ]
46313
+ }
46314
+ },
46315
+ "additionalProperties": false,
46316
+ "required": [
46317
+ "value"
46318
+ ]
46319
+ }
46320
+ },
46321
+ "additionalProperties": false,
46322
+ "required": [
46323
+ "type",
46324
+ "options"
46325
+ ]
46326
+ }
46327
+ ]
46328
+ },
46329
+ "deviceIds": {
46330
+ "type": "array",
46331
+ "maxItems": 100,
46332
+ "items": {
46333
+ "type": "string",
46334
+ "maxLength": 255
46335
+ }
46336
+ },
46337
+ "deviceTags": {
46338
+ "type": "array",
46339
+ "maxItems": 100,
46340
+ "items": {
46341
+ "type": "object",
46342
+ "properties": {
46343
+ "key": {
46344
+ "type": "string",
46345
+ "maxLength": 255
46346
+ },
46347
+ "value": {
46348
+ "type": "string",
46349
+ "maxLength": 255
46350
+ },
46351
+ "fromCtx": {
46352
+ "type": "string",
46353
+ "maxLength": 255
46354
+ }
46355
+ },
46356
+ "additionalProperties": false
46357
+ }
46358
+ },
46359
+ "query": {
46360
+ "type": "string",
46361
+ "maxLength": 32767
46362
+ },
46363
+ "duration": {
46364
+ "oneOf": [
46365
+ {
46366
+ "type": "integer",
46367
+ "minimum": 0
46368
+ },
46369
+ {
46370
+ "type": "string",
46371
+ "enum": [
46372
+ "{{dashboard.duration}}"
46373
+ ]
46374
+ }
46375
+ ]
46376
+ },
46377
+ "resolution": {
46378
+ "oneOf": [
46379
+ {
46380
+ "type": "integer",
46381
+ "minimum": 0
46382
+ },
46383
+ {
46384
+ "type": "null"
46385
+ },
46386
+ {
46387
+ "type": "string",
46388
+ "maxLength": 255
46389
+ }
46390
+ ]
46391
+ }
46392
+ },
46393
+ "additionalProperties": false
46394
+ },
46395
+ {
46396
+ "type": "object",
46397
+ "properties": {
46398
+ "queryType": {
46399
+ "type": "string",
46400
+ "enum": [
46401
+ "gauge"
46402
+ ]
46403
+ },
46404
+ "id": {
46405
+ "type": "string",
46406
+ "maxLength": 48
46407
+ },
46408
+ "attribute": {
46409
+ "type": "string",
46410
+ "maxLength": 255
46411
+ },
46412
+ "aggregation": {
46413
+ "oneOf": [
46414
+ {
46415
+ "oneOf": [
46416
+ {
46417
+ "type": "string",
46418
+ "enum": [
46419
+ "FIRST",
46420
+ "LAST",
46421
+ "COUNT",
46422
+ "MAX",
46423
+ "MIN",
46424
+ "MEDIAN",
46425
+ "MEAN",
46426
+ "SUM",
46427
+ "STD_DEV"
46428
+ ]
46429
+ },
46430
+ {
46431
+ "type": "string",
46432
+ "enum": [
46433
+ "NONE"
46434
+ ]
46435
+ }
46436
+ ]
46437
+ },
46438
+ {
46439
+ "type": "object",
46440
+ "properties": {
46441
+ "type": {
46442
+ "oneOf": [
46443
+ {
46444
+ "type": "string",
46445
+ "enum": [
46446
+ "FIRST",
46447
+ "LAST",
46448
+ "COUNT",
46449
+ "MAX",
46450
+ "MIN",
46451
+ "MEDIAN",
46452
+ "MEAN",
46453
+ "SUM",
46454
+ "STD_DEV"
46455
+ ]
46456
+ },
46457
+ {
46458
+ "type": "string",
46459
+ "enum": [
46460
+ "NONE"
46461
+ ]
46462
+ }
46463
+ ]
46464
+ },
46465
+ "options": {
46466
+ "type": "object",
46467
+ "additionalProperties": false
46468
+ }
46469
+ },
46470
+ "additionalProperties": false,
46471
+ "required": [
46472
+ "type"
46473
+ ]
46474
+ },
46475
+ {
46476
+ "type": "object",
46477
+ "properties": {
46478
+ "type": {
46479
+ "type": "string",
46480
+ "enum": [
46481
+ "TIMEATVALUE"
46482
+ ]
46483
+ },
46484
+ "options": {
46485
+ "type": "object",
46486
+ "properties": {
46487
+ "value": {
46488
+ "oneOf": [
46489
+ {
46490
+ "type": "string",
46491
+ "maxLength": 255
46492
+ },
46493
+ {
46494
+ "type": "number"
46495
+ },
46496
+ {
46497
+ "type": "boolean"
46498
+ }
46499
+ ]
46500
+ }
46501
+ },
46502
+ "additionalProperties": false,
46503
+ "required": [
46504
+ "value"
46505
+ ]
46506
+ }
46507
+ },
46508
+ "additionalProperties": false,
46509
+ "required": [
46510
+ "type",
46511
+ "options"
46512
+ ]
46513
+ }
46514
+ ]
46515
+ },
46516
+ "deviceIds": {
46517
+ "type": "array",
46518
+ "maxItems": 100,
46519
+ "items": {
46520
+ "type": "string",
46521
+ "maxLength": 255
46522
+ }
46523
+ },
46524
+ "deviceTags": {
46525
+ "type": "array",
46526
+ "maxItems": 100,
46527
+ "items": {
46528
+ "type": "object",
46529
+ "properties": {
46530
+ "key": {
46531
+ "type": "string",
46532
+ "maxLength": 255
46533
+ },
46534
+ "value": {
46535
+ "type": "string",
46536
+ "maxLength": 255
46537
+ },
46538
+ "fromCtx": {
46539
+ "type": "string",
46540
+ "maxLength": 255
46541
+ }
46542
+ },
46543
+ "additionalProperties": false
46544
+ }
46545
+ },
46546
+ "query": {
46547
+ "type": "string",
46548
+ "maxLength": 32767
46549
+ },
46550
+ "duration": {
46551
+ "oneOf": [
46552
+ {
46553
+ "type": "integer",
46554
+ "minimum": 0
46555
+ },
46556
+ {
46557
+ "type": "string",
46558
+ "enum": [
46559
+ "{{dashboard.duration}}"
46560
+ ]
46561
+ }
46562
+ ]
46563
+ }
46564
+ },
46565
+ "additionalProperties": false
46566
+ },
46567
+ {
46568
+ "type": "object",
46569
+ "properties": {
46570
+ "queryType": {
46571
+ "type": "string",
46572
+ "enum": [
46573
+ "data-table"
46574
+ ]
46575
+ },
46576
+ "id": {
46577
+ "type": "string",
46578
+ "maxLength": 48
46579
+ },
46580
+ "dataTableId": {
46581
+ "type": "string",
46582
+ "pattern": "^[A-Fa-f\\d]{24}$"
46583
+ },
46584
+ "query": {
46585
+ "type": "string",
46586
+ "maxLength": 32767
46587
+ },
46588
+ "queryMode": {
46589
+ "type": "string",
46590
+ "enum": [
46591
+ "$or",
46592
+ "$and",
46593
+ "advanced"
46594
+ ]
46595
+ },
46596
+ "sortColumn": {
46597
+ "type": "string",
46598
+ "maxLength": 255
46599
+ },
46600
+ "sortDirection": {
46601
+ "type": "string",
46602
+ "maxLength": 255
46603
+ },
46604
+ "limit": {
46605
+ "type": "string",
46606
+ "maxLength": 255
46607
+ },
46608
+ "offset": {
46609
+ "type": "string",
46610
+ "maxLength": 255
46611
+ }
46612
+ },
46613
+ "additionalProperties": false
46614
+ },
46615
+ {
46616
+ "type": "object",
46617
+ "properties": {
46618
+ "queryType": {
46619
+ "type": "string",
46620
+ "enum": [
46621
+ "device-info"
46622
+ ]
46623
+ },
46624
+ "id": {
46625
+ "type": "string",
46626
+ "maxLength": 48
46627
+ },
46628
+ "attributes": {
46629
+ "oneOf": [
46630
+ {
46631
+ "type": "null"
46632
+ },
46633
+ {
46634
+ "type": "array",
46635
+ "maxItems": 100,
46636
+ "items": {
46637
+ "type": "string",
46638
+ "maxLength": 255
46639
+ }
46640
+ }
46641
+ ]
46642
+ },
46643
+ "excludeConnectionInfo": {
46644
+ "type": "boolean"
46645
+ },
46646
+ "sortField": {
46647
+ "type": "string",
46648
+ "maxLength": 255
46649
+ },
46650
+ "sortDirection": {
46651
+ "type": "string",
46652
+ "maxLength": 255
46653
+ },
46654
+ "page": {
46655
+ "type": "string",
46656
+ "maxLength": 255
46657
+ },
46658
+ "perPage": {
46659
+ "type": "string",
46660
+ "maxLength": 255
46661
+ },
46662
+ "query": {
46663
+ "type": "string",
46664
+ "maxLength": 32767
46665
+ },
46666
+ "compositeStateType": {
46667
+ "type": "string",
46668
+ "maxLength": 255
46669
+ }
46670
+ },
46671
+ "additionalProperties": false
46672
+ },
46673
+ {
46674
+ "type": "object",
46675
+ "properties": {
46676
+ "queryType": {
46677
+ "type": "string",
46678
+ "enum": [
46679
+ "events"
46680
+ ]
46681
+ },
46682
+ "id": {
46683
+ "type": "string",
46684
+ "maxLength": 48
46685
+ },
46686
+ "sortField": {
46687
+ "type": "string",
46688
+ "maxLength": 255
46689
+ },
46690
+ "sortDirection": {
46691
+ "type": "string",
46692
+ "maxLength": 255
46693
+ },
46694
+ "page": {
46695
+ "type": "string",
46696
+ "maxLength": 255
46697
+ },
46698
+ "perPage": {
46699
+ "type": "string",
46700
+ "maxLength": 255
46701
+ },
46702
+ "query": {
46703
+ "type": "string",
46704
+ "maxLength": 32767
46705
+ },
46706
+ "includeExtendedEventInfo": {
46707
+ "type": "boolean"
46708
+ }
46709
+ },
46710
+ "additionalProperties": false
46711
+ }
46712
+ ]
46713
+ }
46714
+ },
46715
+ "vegaVersion": {
46716
+ "type": "string",
46717
+ "enum": [
46718
+ "vegaLite2",
46719
+ "vegaLite3",
46720
+ "vegaLite4",
46721
+ "vegaLite5",
46722
+ "vegaLite6",
46723
+ "vega4",
46724
+ "vega5",
46725
+ "vega6"
46726
+ ]
46727
+ },
46728
+ "tooltipEventSubscribe": {
46729
+ "type": "boolean"
46730
+ }
46731
+ },
46732
+ "additionalProperties": false
46733
+ }
46734
+ },
46735
+ "required": [
46736
+ "blockType",
46737
+ "startX",
46738
+ "startY",
46739
+ "width",
46740
+ "height"
46741
+ ],
46742
+ "additionalProperties": false
46743
+ }
46744
+ },
46745
+ "required": [
46746
+ "text",
46747
+ "blockConfig"
46748
+ ],
46749
+ "additionalProperties": false
46750
+ }
46751
+ ```
46752
+ ### <a name="dashboard-block-suggest-code-post-example"></a> Example
46753
+
46754
+ ```json
46755
+ {
46756
+ "text": "Generate a Google Charts time series chart using the data from the time series segment",
46757
+ "blockConfig": {
46758
+ "applicationId": "64b8f0f1f1c2a30008e4b8c1",
46759
+ "id": "1",
46760
+ "startX": 0,
46761
+ "startY": 0,
46762
+ "width": 6,
46763
+ "height": 6,
46764
+ "blockType": "custom-html",
46765
+ "config": {
46766
+ "configuration": {
46767
+ "headContent": "",
46768
+ "bodyContent": ""
46769
+ },
46770
+ "segments": [
46771
+ {
46772
+ "queryType": "time-series",
46773
+ "id": "time-series-0",
46774
+ "deviceIds": [
46775
+ "{{ctx.deviceId}}"
46776
+ ],
46777
+ "deviceTags": [],
46778
+ "attribute": "{{ctx.attribute}}",
46779
+ "duration": "{{dashboard.duration}}",
46780
+ "resolution": "{{dashboard.resolution}}"
46781
+ }
46782
+ ],
46783
+ "tooltipEventSubscribe": false
46784
+ }
46785
+ }
46786
+ }
46787
+ ```
46788
+
46789
+ <br/>
46790
+
46791
+ ## Suggest Function Respone
46792
+
46793
+ Schema for the response to a suggest function request
46794
+
46795
+ ### <a name="suggest-function-respone-schema"></a> Schema
46796
+
46797
+ ```json
46798
+ {
46799
+ "$schema": "http://json-schema.org/draft-07/schema#",
46800
+ "type": "object",
46801
+ "properties": {
46802
+ "response": {
46803
+ "type": "object",
46804
+ "properties": {
46805
+ "headContent": {
46806
+ "type": "string",
46807
+ "maxLength": 32767
46808
+ },
46809
+ "bodyContent": {
46810
+ "type": "string",
46811
+ "maxLength": 32767
46812
+ },
46813
+ "comments": {
46814
+ "type": "string",
46815
+ "maxLength": 32767
46816
+ }
46817
+ }
46818
+ },
46819
+ "responseId": {
46820
+ "type": "string",
46821
+ "minLength": 1,
46822
+ "maxLength": 1024
46823
+ },
46824
+ "finishReason": {
46825
+ "type": "string",
46826
+ "enum": [
46827
+ "FINISH_REASON_UNSPECIFIED",
46828
+ "STOP",
46829
+ "MAX_TOKENS",
46830
+ "SAFETY",
46831
+ "RECITATION",
46832
+ "OTHER",
46833
+ "BLOCKLIST",
46834
+ "PROHIBITED_CONTENT",
46835
+ "SPII",
46836
+ "MALFORMED_FUNCTION_CALL"
46837
+ ]
46838
+ }
46839
+ },
46840
+ "required": [
46841
+ "response",
46842
+ "responseId",
46843
+ "finishReason"
46844
+ ],
46845
+ "additionalProperties": false
46846
+ }
46847
+ ```
46848
+ ### <a name="suggest-function-respone-example"></a> Example
46849
+
46850
+ ```json
46851
+ {
46852
+ "response": {
46853
+ "headContent": "<script>window.alert('Hello from the Custom HTML Block!');</script>",
46854
+ "bodyContent": "<div>Did you see an alert?</div>",
46855
+ "comments": "This code will fire a window alert when the block initially loads."
46856
+ },
46857
+ "responseId": "YCwSaIeyOfComecPutWYyAg",
46858
+ "finishReason": "STOP"
46859
+ }
46860
+ ```
46861
+
46862
+ <br/>
46863
+
46040
46864
  ## Dashboard Context Instance
46041
46865
 
46042
46866
  Schema for a dashboard context instance
@@ -47028,8 +47852,10 @@ Schema for the body of a Dashboard modification request
47028
47852
  "vegaLite3",
47029
47853
  "vegaLite4",
47030
47854
  "vegaLite5",
47855
+ "vegaLite6",
47031
47856
  "vega4",
47032
- "vega5"
47857
+ "vega5",
47858
+ "vega6"
47033
47859
  ]
47034
47860
  },
47035
47861
  "tooltipEventSubscribe": {
@@ -53463,8 +54289,10 @@ Schema for the body of a Dashboard creation request
53463
54289
  "vegaLite3",
53464
54290
  "vegaLite4",
53465
54291
  "vegaLite5",
54292
+ "vegaLite6",
53466
54293
  "vega4",
53467
- "vega5"
54294
+ "vega5",
54295
+ "vega6"
53468
54296
  ]
53469
54297
  },
53470
54298
  "tooltipEventSubscribe": {
@@ -59106,6 +59934,31 @@ Schema for the body of an update events request
59106
59934
  "resolved"
59107
59935
  ]
59108
59936
  },
59937
+ "level": {
59938
+ "type": "string",
59939
+ "enum": [
59940
+ "info",
59941
+ "warning",
59942
+ "error",
59943
+ "critical"
59944
+ ]
59945
+ },
59946
+ "subject": {
59947
+ "type": "string",
59948
+ "minLength": 1,
59949
+ "maxLength": 255
59950
+ },
59951
+ "deviceId": {
59952
+ "oneOf": [
59953
+ {
59954
+ "type": "string",
59955
+ "pattern": "^[A-Fa-f\\d]{24}$"
59956
+ },
59957
+ {
59958
+ "type": "null"
59959
+ }
59960
+ ]
59961
+ },
59109
59962
  "comment": {
59110
59963
  "type": "string",
59111
59964
  "maxLength": 32767
@@ -60297,8 +61150,10 @@ Schema for a collection of Dashboards
60297
61150
  "vegaLite3",
60298
61151
  "vegaLite4",
60299
61152
  "vegaLite5",
61153
+ "vegaLite6",
60300
61154
  "vega4",
60301
- "vega5"
61155
+ "vega5",
61156
+ "vega6"
60302
61157
  ]
60303
61158
  },
60304
61159
  "tooltipEventSubscribe": {
@@ -86332,6 +87187,87 @@ Schema for a single Event
86332
87187
  ]
86333
87188
  }
86334
87189
  }
87190
+ },
87191
+ "levelChange": {
87192
+ "type": "object",
87193
+ "properties": {
87194
+ "old": {
87195
+ "type": "string",
87196
+ "enum": [
87197
+ "info",
87198
+ "warning",
87199
+ "error",
87200
+ "critical"
87201
+ ]
87202
+ },
87203
+ "new": {
87204
+ "type": "string",
87205
+ "enum": [
87206
+ "info",
87207
+ "warning",
87208
+ "error",
87209
+ "critical"
87210
+ ]
87211
+ }
87212
+ }
87213
+ },
87214
+ "subjectChange": {
87215
+ "type": "object",
87216
+ "properties": {
87217
+ "old": {
87218
+ "type": "string",
87219
+ "minLength": 1,
87220
+ "maxLength": 255
87221
+ },
87222
+ "new": {
87223
+ "type": "string",
87224
+ "minLength": 1,
87225
+ "maxLength": 255
87226
+ }
87227
+ }
87228
+ },
87229
+ "deviceIdChange": {
87230
+ "type": "object",
87231
+ "properties": {
87232
+ "old": {
87233
+ "type": "string",
87234
+ "pattern": "^[A-Fa-f\\d]{24}$"
87235
+ },
87236
+ "oldDeviceName": {
87237
+ "type": "string",
87238
+ "minLength": 1,
87239
+ "maxLength": 255
87240
+ },
87241
+ "new": {
87242
+ "type": "string",
87243
+ "pattern": "^[A-Fa-f\\d]{24}$"
87244
+ },
87245
+ "newDeviceName": {
87246
+ "type": "string",
87247
+ "minLength": 1,
87248
+ "maxLength": 255
87249
+ }
87250
+ }
87251
+ },
87252
+ "tagsChange": {
87253
+ "type": "object",
87254
+ "patternProperties": {
87255
+ "^[0-9a-zA-Z_-]{1,255}$": {
87256
+ "type": "object",
87257
+ "properties": {
87258
+ "old": {
87259
+ "type": "string",
87260
+ "minLength": 1,
87261
+ "maxLength": 255
87262
+ },
87263
+ "new": {
87264
+ "type": "string",
87265
+ "minLength": 1,
87266
+ "maxLength": 255
87267
+ }
87268
+ }
87269
+ }
87270
+ }
86335
87271
  }
86336
87272
  }
86337
87273
  }
@@ -86385,6 +87321,31 @@ Schema for the body of an Event modification request
86385
87321
  "resolved"
86386
87322
  ]
86387
87323
  },
87324
+ "level": {
87325
+ "type": "string",
87326
+ "enum": [
87327
+ "info",
87328
+ "warning",
87329
+ "error",
87330
+ "critical"
87331
+ ]
87332
+ },
87333
+ "subject": {
87334
+ "type": "string",
87335
+ "minLength": 1,
87336
+ "maxLength": 255
87337
+ },
87338
+ "deviceId": {
87339
+ "oneOf": [
87340
+ {
87341
+ "type": "string",
87342
+ "pattern": "^[A-Fa-f\\d]{24}$"
87343
+ },
87344
+ {
87345
+ "type": "null"
87346
+ }
87347
+ ]
87348
+ },
86388
87349
  "comment": {
86389
87350
  "type": "string",
86390
87351
  "maxLength": 32767
@@ -86581,6 +87542,87 @@ Schema for an event plus a count of new events
86581
87542
  ]
86582
87543
  }
86583
87544
  }
87545
+ },
87546
+ "levelChange": {
87547
+ "type": "object",
87548
+ "properties": {
87549
+ "old": {
87550
+ "type": "string",
87551
+ "enum": [
87552
+ "info",
87553
+ "warning",
87554
+ "error",
87555
+ "critical"
87556
+ ]
87557
+ },
87558
+ "new": {
87559
+ "type": "string",
87560
+ "enum": [
87561
+ "info",
87562
+ "warning",
87563
+ "error",
87564
+ "critical"
87565
+ ]
87566
+ }
87567
+ }
87568
+ },
87569
+ "subjectChange": {
87570
+ "type": "object",
87571
+ "properties": {
87572
+ "old": {
87573
+ "type": "string",
87574
+ "minLength": 1,
87575
+ "maxLength": 255
87576
+ },
87577
+ "new": {
87578
+ "type": "string",
87579
+ "minLength": 1,
87580
+ "maxLength": 255
87581
+ }
87582
+ }
87583
+ },
87584
+ "deviceIdChange": {
87585
+ "type": "object",
87586
+ "properties": {
87587
+ "old": {
87588
+ "type": "string",
87589
+ "pattern": "^[A-Fa-f\\d]{24}$"
87590
+ },
87591
+ "oldDeviceName": {
87592
+ "type": "string",
87593
+ "minLength": 1,
87594
+ "maxLength": 255
87595
+ },
87596
+ "new": {
87597
+ "type": "string",
87598
+ "pattern": "^[A-Fa-f\\d]{24}$"
87599
+ },
87600
+ "newDeviceName": {
87601
+ "type": "string",
87602
+ "minLength": 1,
87603
+ "maxLength": 255
87604
+ }
87605
+ }
87606
+ },
87607
+ "tagsChange": {
87608
+ "type": "object",
87609
+ "patternProperties": {
87610
+ "^[0-9a-zA-Z_-]{1,255}$": {
87611
+ "type": "object",
87612
+ "properties": {
87613
+ "old": {
87614
+ "type": "string",
87615
+ "minLength": 1,
87616
+ "maxLength": 255
87617
+ },
87618
+ "new": {
87619
+ "type": "string",
87620
+ "minLength": 1,
87621
+ "maxLength": 255
87622
+ }
87623
+ }
87624
+ }
87625
+ }
86584
87626
  }
86585
87627
  }
86586
87628
  }
@@ -86942,6 +87984,87 @@ Schema for a collection of Events
86942
87984
  ]
86943
87985
  }
86944
87986
  }
87987
+ },
87988
+ "levelChange": {
87989
+ "type": "object",
87990
+ "properties": {
87991
+ "old": {
87992
+ "type": "string",
87993
+ "enum": [
87994
+ "info",
87995
+ "warning",
87996
+ "error",
87997
+ "critical"
87998
+ ]
87999
+ },
88000
+ "new": {
88001
+ "type": "string",
88002
+ "enum": [
88003
+ "info",
88004
+ "warning",
88005
+ "error",
88006
+ "critical"
88007
+ ]
88008
+ }
88009
+ }
88010
+ },
88011
+ "subjectChange": {
88012
+ "type": "object",
88013
+ "properties": {
88014
+ "old": {
88015
+ "type": "string",
88016
+ "minLength": 1,
88017
+ "maxLength": 255
88018
+ },
88019
+ "new": {
88020
+ "type": "string",
88021
+ "minLength": 1,
88022
+ "maxLength": 255
88023
+ }
88024
+ }
88025
+ },
88026
+ "deviceIdChange": {
88027
+ "type": "object",
88028
+ "properties": {
88029
+ "old": {
88030
+ "type": "string",
88031
+ "pattern": "^[A-Fa-f\\d]{24}$"
88032
+ },
88033
+ "oldDeviceName": {
88034
+ "type": "string",
88035
+ "minLength": 1,
88036
+ "maxLength": 255
88037
+ },
88038
+ "new": {
88039
+ "type": "string",
88040
+ "pattern": "^[A-Fa-f\\d]{24}$"
88041
+ },
88042
+ "newDeviceName": {
88043
+ "type": "string",
88044
+ "minLength": 1,
88045
+ "maxLength": 255
88046
+ }
88047
+ }
88048
+ },
88049
+ "tagsChange": {
88050
+ "type": "object",
88051
+ "patternProperties": {
88052
+ "^[0-9a-zA-Z_-]{1,255}$": {
88053
+ "type": "object",
88054
+ "properties": {
88055
+ "old": {
88056
+ "type": "string",
88057
+ "minLength": 1,
88058
+ "maxLength": 255
88059
+ },
88060
+ "new": {
88061
+ "type": "string",
88062
+ "minLength": 1,
88063
+ "maxLength": 255
88064
+ }
88065
+ }
88066
+ }
88067
+ }
86945
88068
  }
86946
88069
  }
86947
88070
  }
@@ -88701,6 +89824,14 @@ Export options for events
88701
89824
  }
88702
89825
  },
88703
89826
  "additionalProperties": false
89827
+ },
89828
+ "format": {
89829
+ "type": "string",
89830
+ "enum": [
89831
+ "csv",
89832
+ "json"
89833
+ ],
89834
+ "default": "csv"
88704
89835
  }
88705
89836
  },
88706
89837
  "additionalProperties": false
@@ -91093,6 +92224,12 @@ The body of an experience linked resources response
91093
92224
  },
91094
92225
  "update": {
91095
92226
  "type": "boolean"
92227
+ },
92228
+ "public": {
92229
+ "type": "boolean"
92230
+ },
92231
+ "private": {
92232
+ "type": "boolean"
91096
92233
  }
91097
92234
  },
91098
92235
  "additionalProperties": false
@@ -94224,6 +95361,12 @@ The body of an experience linked resources response
94224
95361
  },
94225
95362
  "update": {
94226
95363
  "type": "boolean"
95364
+ },
95365
+ "public": {
95366
+ "type": "boolean"
95367
+ },
95368
+ "private": {
95369
+ "type": "boolean"
94227
95370
  }
94228
95371
  },
94229
95372
  "additionalProperties": false
@@ -97264,6 +98407,12 @@ The body of an experience linked resources response
97264
98407
  },
97265
98408
  "update": {
97266
98409
  "type": "boolean"
98410
+ },
98411
+ "public": {
98412
+ "type": "boolean"
98413
+ },
98414
+ "private": {
98415
+ "type": "boolean"
97267
98416
  }
97268
98417
  },
97269
98418
  "additionalProperties": false
@@ -102092,7 +103241,7 @@ Schema for a collection of Experience Views
102092
103241
 
102093
103242
  ## File Schema
102094
103243
 
102095
- Schema for a single file
103244
+ Schema for a single public or private file
102096
103245
 
102097
103246
  ### <a name="file-schema-schema"></a> Schema
102098
103247
 
@@ -102210,7 +103359,7 @@ Schema for a single file
102210
103359
 
102211
103360
  ## File Patch
102212
103361
 
102213
- Schema to patch a file
103362
+ Schema to patch a public or private file
102214
103363
 
102215
103364
  ### <a name="file-patch-schema"></a> Schema
102216
103365
 
@@ -102257,7 +103406,7 @@ Schema to patch a file
102257
103406
 
102258
103407
  ## File Post
102259
103408
 
102260
- Schema to create a single file or directory
103409
+ Schema to create a single public or private file or directory
102261
103410
 
102262
103411
  ### <a name="file-post-schema"></a> Schema
102263
103412
 
@@ -102298,140 +103447,161 @@ Schema to create a single file or directory
102298
103447
  "height": {
102299
103448
  "type": "number"
102300
103449
  }
102301
- },
102302
- "additionalProperties": false
102303
- }
102304
- },
102305
- "additionalProperties": false,
102306
- "required": [
102307
- "name",
102308
- "type"
102309
- ]
102310
- }
102311
- ```
102312
- ### <a name="file-post-example"></a> Example
102313
-
102314
- ```json
102315
- {
102316
- "name": "file.csv",
102317
- "type": "file",
102318
- "parentDirectory": "/",
102319
- "fileSize": 500,
102320
- "contentType": "text/csv"
102321
- }
102322
- ```
102323
-
102324
- <br/>
102325
-
102326
- ## File Upload Post Response
102327
-
102328
- Schema to upload the file to s3
102329
-
102330
- ### <a name="file-upload-post-response-schema"></a> Schema
102331
-
102332
- ```json
102333
- {
102334
- "$schema": "http://json-schema.org/draft-07/schema#",
102335
- "type": "object",
102336
- "properties": {
102337
- "id": {
102338
- "type": "string",
102339
- "pattern": "^[A-Fa-f\\d]{24}$"
102340
- },
102341
- "applicationId": {
102342
- "type": "string",
102343
- "pattern": "^[A-Fa-f\\d]{24}$"
102344
- },
102345
- "creationDate": {
102346
- "type": "string",
102347
- "format": "date-time"
102348
- },
102349
- "lastUpdated": {
102350
- "type": "string",
102351
- "format": "date-time"
102352
- },
102353
- "authorId": {
102354
- "type": "string",
102355
- "pattern": "^[A-Fa-f\\d]{24}$"
102356
- },
102357
- "authorType": {
102358
- "type": "string",
102359
- "enum": [
102360
- "flow",
102361
- "user",
102362
- "device",
102363
- "apiToken",
102364
- "notebook"
102365
- ]
102366
- },
102367
- "status": {
102368
- "type": "string",
102369
- "enum": [
102370
- "pending",
102371
- "moving",
102372
- "deleting",
102373
- "completed"
102374
- ]
102375
- },
102376
- "name": {
102377
- "type": "string",
102378
- "minLength": 1,
102379
- "maxLength": 1024
102380
- },
102381
- "parentDirectory": {
102382
- "type": "string",
102383
- "maxLength": 1024
102384
- },
102385
- "type": {
102386
- "type": "string",
102387
- "enum": [
102388
- "file",
102389
- "directory"
102390
- ]
102391
- },
102392
- "fileSize": {
102393
- "type": "number"
102394
- },
102395
- "contentType": {
102396
- "type": "string",
102397
- "maxLength": 1024
102398
- },
102399
- "fileDimensions": {
102400
- "type": "object",
102401
- "properties": {
102402
- "width": {
102403
- "type": "number"
102404
- },
102405
- "height": {
102406
- "type": "number"
102407
- }
102408
- }
102409
- },
102410
- "upload": {
103450
+ },
103451
+ "additionalProperties": false
103452
+ }
103453
+ },
103454
+ "additionalProperties": false,
103455
+ "required": [
103456
+ "name",
103457
+ "type"
103458
+ ]
103459
+ }
103460
+ ```
103461
+ ### <a name="file-post-example"></a> Example
103462
+
103463
+ ```json
103464
+ {
103465
+ "name": "file.csv",
103466
+ "type": "file",
103467
+ "parentDirectory": "/",
103468
+ "fileSize": 500,
103469
+ "contentType": "text/csv"
103470
+ }
103471
+ ```
103472
+
103473
+ <br/>
103474
+
103475
+ ## File Upload Post Response
103476
+
103477
+ Schema with the information needed to upload public or private file contents
103478
+
103479
+ ### <a name="file-upload-post-response-schema"></a> Schema
103480
+
103481
+ ```json
103482
+ {
103483
+ "$schema": "http://json-schema.org/draft-07/schema#",
103484
+ "allOf": [
103485
+ {
103486
+ "title": "File Schema",
103487
+ "description": "Schema for a single public or private file",
102411
103488
  "type": "object",
102412
103489
  "properties": {
102413
- "url": {
103490
+ "id": {
103491
+ "type": "string",
103492
+ "pattern": "^[A-Fa-f\\d]{24}$"
103493
+ },
103494
+ "applicationId": {
103495
+ "type": "string",
103496
+ "pattern": "^[A-Fa-f\\d]{24}$"
103497
+ },
103498
+ "creationDate": {
103499
+ "type": "string",
103500
+ "format": "date-time"
103501
+ },
103502
+ "lastUpdated": {
103503
+ "type": "string",
103504
+ "format": "date-time"
103505
+ },
103506
+ "authorId": {
103507
+ "type": "string",
103508
+ "pattern": "^[A-Fa-f\\d]{24}$"
103509
+ },
103510
+ "authorType": {
103511
+ "type": "string",
103512
+ "enum": [
103513
+ "flow",
103514
+ "user",
103515
+ "device",
103516
+ "apiToken",
103517
+ "notebook"
103518
+ ]
103519
+ },
103520
+ "status": {
103521
+ "type": "string",
103522
+ "enum": [
103523
+ "pending",
103524
+ "moving",
103525
+ "deleting",
103526
+ "completed"
103527
+ ]
103528
+ },
103529
+ "name": {
103530
+ "type": "string",
103531
+ "minLength": 1,
103532
+ "maxLength": 1024
103533
+ },
103534
+ "parentDirectory": {
103535
+ "type": "string",
103536
+ "maxLength": 1024
103537
+ },
103538
+ "type": {
103539
+ "type": "string",
103540
+ "enum": [
103541
+ "file",
103542
+ "directory"
103543
+ ]
103544
+ },
103545
+ "fileSize": {
103546
+ "type": "number"
103547
+ },
103548
+ "s3etag": {
102414
103549
  "type": "string"
102415
103550
  },
102416
- "fields": {
103551
+ "contentType": {
103552
+ "type": "string",
103553
+ "maxLength": 1024
103554
+ },
103555
+ "fileDimensions": {
102417
103556
  "type": "object",
102418
- "patternProperties": {
102419
- "^.*$": {
102420
- "type": "string"
103557
+ "properties": {
103558
+ "width": {
103559
+ "type": "number"
103560
+ },
103561
+ "height": {
103562
+ "type": "number"
102421
103563
  }
102422
- },
103564
+ }
103565
+ },
103566
+ "moveIntoId": {
103567
+ "type": "string",
103568
+ "pattern": "^[A-Fa-f\\d]{24}$"
103569
+ },
103570
+ "url": {
103571
+ "type": "string"
103572
+ }
103573
+ }
103574
+ },
103575
+ {
103576
+ "type": "object",
103577
+ "properties": {
103578
+ "upload": {
103579
+ "type": "object",
102423
103580
  "properties": {
102424
- "key": {
103581
+ "url": {
102425
103582
  "type": "string"
102426
103583
  },
102427
- "bucket": {
102428
- "type": "string"
103584
+ "fields": {
103585
+ "type": "object",
103586
+ "patternProperties": {
103587
+ "^.*$": {
103588
+ "type": "string"
103589
+ }
103590
+ },
103591
+ "properties": {
103592
+ "key": {
103593
+ "type": "string"
103594
+ },
103595
+ "bucket": {
103596
+ "type": "string"
103597
+ }
103598
+ }
102429
103599
  }
102430
103600
  }
102431
103601
  }
102432
103602
  }
102433
103603
  }
102434
- }
103604
+ ]
102435
103605
  }
102436
103606
  ```
102437
103607
  ### <a name="file-upload-post-response-example"></a> Example
@@ -102469,7 +103639,7 @@ Schema to upload the file to s3
102469
103639
 
102470
103640
  ## Files Schema
102471
103641
 
102472
- Schema for a collection of files
103642
+ Schema for a collection of public or private files
102473
103643
 
102474
103644
  ### <a name="files-schema-schema"></a> Schema
102475
103645
 
@@ -102482,7 +103652,7 @@ Schema for a collection of files
102482
103652
  "type": "array",
102483
103653
  "items": {
102484
103654
  "title": "File Schema",
102485
- "description": "Schema for a single file",
103655
+ "description": "Schema for a single public or private file",
102486
103656
  "type": "object",
102487
103657
  "properties": {
102488
103658
  "id": {
@@ -102784,6 +103954,12 @@ Schema for a single Workflow
102784
103954
  },
102785
103955
  "update": {
102786
103956
  "type": "boolean"
103957
+ },
103958
+ "public": {
103959
+ "type": "boolean"
103960
+ },
103961
+ "private": {
103962
+ "type": "boolean"
102787
103963
  }
102788
103964
  },
102789
103965
  "additionalProperties": false
@@ -106058,6 +107234,12 @@ Schema for the body of a Workflow modification request
106058
107234
  },
106059
107235
  "update": {
106060
107236
  "type": "boolean"
107237
+ },
107238
+ "public": {
107239
+ "type": "boolean"
107240
+ },
107241
+ "private": {
107242
+ "type": "boolean"
106061
107243
  }
106062
107244
  },
106063
107245
  "additionalProperties": false
@@ -109085,6 +110267,12 @@ Schema for the body of a Workflow creation request
109085
110267
  },
109086
110268
  "update": {
109087
110269
  "type": "boolean"
110270
+ },
110271
+ "public": {
110272
+ "type": "boolean"
110273
+ },
110274
+ "private": {
110275
+ "type": "boolean"
109088
110276
  }
109089
110277
  },
109090
110278
  "additionalProperties": false
@@ -112384,6 +113572,12 @@ Schema for a single Workflow Version
112384
113572
  },
112385
113573
  "update": {
112386
113574
  "type": "boolean"
113575
+ },
113576
+ "public": {
113577
+ "type": "boolean"
113578
+ },
113579
+ "private": {
113580
+ "type": "boolean"
112387
113581
  }
112388
113582
  },
112389
113583
  "additionalProperties": false
@@ -115424,6 +116618,12 @@ Schema for a single Workflow Version
115424
116618
  },
115425
116619
  "update": {
115426
116620
  "type": "boolean"
116621
+ },
116622
+ "public": {
116623
+ "type": "boolean"
116624
+ },
116625
+ "private": {
116626
+ "type": "boolean"
115427
116627
  }
115428
116628
  },
115429
116629
  "additionalProperties": false
@@ -118175,6 +119375,12 @@ Schema for the body of a Workflow Version creation request
118175
119375
  },
118176
119376
  "update": {
118177
119377
  "type": "boolean"
119378
+ },
119379
+ "public": {
119380
+ "type": "boolean"
119381
+ },
119382
+ "private": {
119383
+ "type": "boolean"
118178
119384
  }
118179
119385
  },
118180
119386
  "additionalProperties": false
@@ -121241,6 +122447,12 @@ Schema for a collection of Workflow Versions
121241
122447
  },
121242
122448
  "update": {
121243
122449
  "type": "boolean"
122450
+ },
122451
+ "public": {
122452
+ "type": "boolean"
122453
+ },
122454
+ "private": {
122455
+ "type": "boolean"
121244
122456
  }
121245
122457
  },
121246
122458
  "additionalProperties": false
@@ -124281,6 +125493,12 @@ Schema for a collection of Workflow Versions
124281
125493
  },
124282
125494
  "update": {
124283
125495
  "type": "boolean"
125496
+ },
125497
+ "public": {
125498
+ "type": "boolean"
125499
+ },
125500
+ "private": {
125501
+ "type": "boolean"
124284
125502
  }
124285
125503
  },
124286
125504
  "additionalProperties": false
@@ -128261,6 +129479,12 @@ Schema for a collection of Workflows
128261
129479
  },
128262
129480
  "update": {
128263
129481
  "type": "boolean"
129482
+ },
129483
+ "public": {
129484
+ "type": "boolean"
129485
+ },
129486
+ "private": {
129487
+ "type": "boolean"
128264
129488
  }
128265
129489
  },
128266
129490
  "additionalProperties": false
@@ -131412,6 +132636,12 @@ Schema for the body of a workflow import request
131412
132636
  },
131413
132637
  "update": {
131414
132638
  "type": "boolean"
132639
+ },
132640
+ "public": {
132641
+ "type": "boolean"
132642
+ },
132643
+ "private": {
132644
+ "type": "boolean"
131415
132645
  }
131416
132646
  },
131417
132647
  "additionalProperties": false
@@ -134441,6 +135671,12 @@ Schema for the body of a workflow import request
134441
135671
  },
134442
135672
  "update": {
134443
135673
  "type": "boolean"
135674
+ },
135675
+ "public": {
135676
+ "type": "boolean"
135677
+ },
135678
+ "private": {
135679
+ "type": "boolean"
134444
135680
  }
134445
135681
  },
134446
135682
  "additionalProperties": false
@@ -137544,6 +138780,12 @@ Schema for the result of a workflow import request
137544
138780
  },
137545
138781
  "update": {
137546
138782
  "type": "boolean"
138783
+ },
138784
+ "public": {
138785
+ "type": "boolean"
138786
+ },
138787
+ "private": {
138788
+ "type": "boolean"
137547
138789
  }
137548
138790
  },
137549
138791
  "additionalProperties": false
@@ -140624,6 +141866,12 @@ Schema for the result of a workflow import request
140624
141866
  },
140625
141867
  "update": {
140626
141868
  "type": "boolean"
141869
+ },
141870
+ "public": {
141871
+ "type": "boolean"
141872
+ },
141873
+ "private": {
141874
+ "type": "boolean"
140627
141875
  }
140628
141876
  },
140629
141877
  "additionalProperties": false
@@ -143664,6 +144912,12 @@ Schema for the result of a workflow import request
143664
144912
  },
143665
144913
  "update": {
143666
144914
  "type": "boolean"
144915
+ },
144916
+ "public": {
144917
+ "type": "boolean"
144918
+ },
144919
+ "private": {
144920
+ "type": "boolean"
143667
144921
  }
143668
144922
  },
143669
144923
  "additionalProperties": false
@@ -146447,10 +147701,12 @@ Schema for the body of a Github login request
146447
147701
  "flows.*",
146448
147702
  "flowVersion.*",
146449
147703
  "flowVersions.*",
146450
- "resourceJobs.*",
146451
- "resourceJob.*",
146452
147704
  "notebook.*",
146453
147705
  "notebooks.*",
147706
+ "privateFile.*",
147707
+ "privateFiles.*",
147708
+ "resourceJobs.*",
147709
+ "resourceJob.*",
146454
147710
  "webhook.*",
146455
147711
  "webhooks.*",
146456
147712
  "application.applyTemplate",
@@ -146687,6 +147943,13 @@ Schema for the body of a Github login request
146687
147943
  "notebook.upload",
146688
147944
  "notebooks.get",
146689
147945
  "notebooks.post",
147946
+ "privateFile.get",
147947
+ "privateFile.patch",
147948
+ "privateFile.move",
147949
+ "privateFile.delete",
147950
+ "privateFile.upload",
147951
+ "privateFiles.get",
147952
+ "privateFiles.post",
146690
147953
  "resourceJob.get",
146691
147954
  "resourceJob.logs",
146692
147955
  "resourceJob.patch",
@@ -146723,6 +147986,7 @@ Schema for the body of a Github login request
146723
147986
  "dashboard.patch",
146724
147987
  "dashboard.delete",
146725
147988
  "dashboard.sendReport",
147989
+ "dashboard.suggestCode",
146726
147990
  "dashboards.get",
146727
147991
  "dashboards.post",
146728
147992
  "org.get",
@@ -147044,6 +148308,10 @@ Schema for a collection of Historical Summaries
147044
148308
  "type": "integer",
147045
148309
  "minimum": 0
147046
148310
  },
148311
+ "privatefile": {
148312
+ "type": "integer",
148313
+ "minimum": 0
148314
+ },
147047
148315
  "resourcejob": {
147048
148316
  "type": "integer",
147049
148317
  "minimum": 0
@@ -147200,6 +148468,12 @@ Schema for a collection of Historical Summaries
147200
148468
  "notebookMinutesCount": {
147201
148469
  "type": "number"
147202
148470
  },
148471
+ "privateFileCount": {
148472
+ "type": "number"
148473
+ },
148474
+ "privateFileTotalSizeMb": {
148475
+ "type": "number"
148476
+ },
147203
148477
  "webhookCount": {
147204
148478
  "type": "number"
147205
148479
  },
@@ -147615,6 +148889,8 @@ Schema for a collection of Historical Summaries
147615
148889
  "resourceJobCount": 0,
147616
148890
  "notebookRunCount": 0,
147617
148891
  "notebookMinutesCount": 0,
148892
+ "privateFileCount": 0,
148893
+ "privateFileTotalSizeMb": 0,
147618
148894
  "webhookCount": 2,
147619
148895
  "workflowCount": 3,
147620
148896
  "payloadBillableCount": 437,
@@ -147784,6 +149060,10 @@ Schema for a historical summary report
147784
149060
  "type": "integer",
147785
149061
  "minimum": 0
147786
149062
  },
149063
+ "privatefile": {
149064
+ "type": "integer",
149065
+ "minimum": 0
149066
+ },
147787
149067
  "resourcejob": {
147788
149068
  "type": "integer",
147789
149069
  "minimum": 0
@@ -147940,6 +149220,12 @@ Schema for a historical summary report
147940
149220
  "notebookMinutesCount": {
147941
149221
  "type": "number"
147942
149222
  },
149223
+ "privateFileCount": {
149224
+ "type": "number"
149225
+ },
149226
+ "privateFileTotalSizeMb": {
149227
+ "type": "number"
149228
+ },
147943
149229
  "webhookCount": {
147944
149230
  "type": "number"
147945
149231
  },
@@ -148319,6 +149605,8 @@ Schema for a historical summary report
148319
149605
  "resourceJobCount": 0,
148320
149606
  "notebookRunCount": 0,
148321
149607
  "notebookMinutesCount": 0,
149608
+ "privateFileCount": 0,
149609
+ "privateFileTotalSizeMb": 0,
148322
149610
  "webhookCount": 2,
148323
149611
  "workflowCount": 3,
148324
149612
  "payloadBillableCount": 437,
@@ -148412,6 +149700,7 @@ Schema for additional application import options
148412
149700
  "Global",
148413
149701
  "Integration",
148414
149702
  "Notebook",
149703
+ "PrivateFile",
148415
149704
  "Webhook",
148416
149705
  "ResourceJob"
148417
149706
  ]
@@ -148497,6 +149786,7 @@ Schema for additional application import options (new application)
148497
149786
  "Global",
148498
149787
  "Integration",
148499
149788
  "Notebook",
149789
+ "PrivateFile",
148500
149790
  "Webhook",
148501
149791
  "ResourceJob"
148502
149792
  ]
@@ -148699,6 +149989,9 @@ Schema for a single Instance
148699
149989
  "notebook": {
148700
149990
  "type": "integer"
148701
149991
  },
149992
+ "privatefile": {
149993
+ "type": "integer"
149994
+ },
148702
149995
  "resourcejob": {
148703
149996
  "type": "integer"
148704
149997
  },
@@ -148825,6 +150118,10 @@ Schema for a single Instance
148825
150118
  "type": "integer",
148826
150119
  "minimum": 0
148827
150120
  },
150121
+ "privatefile": {
150122
+ "type": "integer",
150123
+ "minimum": 0
150124
+ },
148828
150125
  "resourcejob": {
148829
150126
  "type": "integer",
148830
150127
  "minimum": 0
@@ -148935,6 +150232,7 @@ Schema for a single Instance
148935
150232
  "integration": 50,
148936
150233
  "notebook": 100,
148937
150234
  "resourcejob": 10,
150235
+ "privatefile": 1000,
148938
150236
  "webhook": 1000,
148939
150237
  "dataTTL": 15552000,
148940
150238
  "member": 100,
@@ -152471,6 +153769,10 @@ Schema for the body of an Organization owned by an instance
152471
153769
  "type": "integer",
152472
153770
  "minimum": 0
152473
153771
  },
153772
+ "privatefile": {
153773
+ "type": "integer",
153774
+ "minimum": 0
153775
+ },
152474
153776
  "resourcejob": {
152475
153777
  "type": "integer",
152476
153778
  "minimum": 0
@@ -152592,6 +153894,9 @@ Schema for the body of an Organization owned by an instance
152592
153894
  "notebookCount": {
152593
153895
  "type": "integer"
152594
153896
  },
153897
+ "privateFileCount": {
153898
+ "type": "integer"
153899
+ },
152595
153900
  "resourceJobCount": {
152596
153901
  "type": "integer"
152597
153902
  },
@@ -152948,6 +154253,7 @@ Schema for the body of an Organization owned by an instance
152948
154253
  "integration": 50,
152949
154254
  "notebook": 100,
152950
154255
  "resourcejob": 100,
154256
+ "privatefile": 1000,
152951
154257
  "webhook": 1000,
152952
154258
  "dataTTL": 15552000,
152953
154259
  "member": 100,
@@ -152981,6 +154287,7 @@ Schema for the body of an Organization owned by an instance
152981
154287
  "flowCount": 30,
152982
154288
  "integrationCount": 6,
152983
154289
  "notebookCount": 0,
154290
+ "privateFileCount": 0,
152984
154291
  "resourceJobCount": 5,
152985
154292
  "keyCount": 17,
152986
154293
  "memberCount": 1,
@@ -153547,6 +154854,10 @@ Schema for the body of an Organization modification request within an instance
153547
154854
  "type": "integer",
153548
154855
  "minimum": 0
153549
154856
  },
154857
+ "privatefile": {
154858
+ "type": "integer",
154859
+ "minimum": 0
154860
+ },
153550
154861
  "resourcejob": {
153551
154862
  "type": "integer",
153552
154863
  "minimum": 0
@@ -153806,6 +155117,10 @@ Schema for the body of an Organization creation request within an instance
153806
155117
  "type": "integer",
153807
155118
  "minimum": 0
153808
155119
  },
155120
+ "privatefile": {
155121
+ "type": "integer",
155122
+ "minimum": 0
155123
+ },
153809
155124
  "resourcejob": {
153810
155125
  "type": "integer",
153811
155126
  "minimum": 0
@@ -154261,6 +155576,10 @@ Schema for a collection of Organizations within an instance
154261
155576
  "type": "integer",
154262
155577
  "minimum": 0
154263
155578
  },
155579
+ "privatefile": {
155580
+ "type": "integer",
155581
+ "minimum": 0
155582
+ },
154264
155583
  "resourcejob": {
154265
155584
  "type": "integer",
154266
155585
  "minimum": 0
@@ -154382,6 +155701,9 @@ Schema for a collection of Organizations within an instance
154382
155701
  "notebookCount": {
154383
155702
  "type": "integer"
154384
155703
  },
155704
+ "privateFileCount": {
155705
+ "type": "integer"
155706
+ },
154385
155707
  "resourceJobCount": {
154386
155708
  "type": "integer"
154387
155709
  },
@@ -154778,6 +156100,7 @@ Schema for a collection of Organizations within an instance
154778
156100
  "integration": 50,
154779
156101
  "notebook": 100,
154780
156102
  "resourcejob": 100,
156103
+ "privatefile": 1000,
154781
156104
  "webhook": 1000,
154782
156105
  "dataTTL": 15552000,
154783
156106
  "member": 100,
@@ -154811,6 +156134,7 @@ Schema for a collection of Organizations within an instance
154811
156134
  "flowCount": 30,
154812
156135
  "integrationCount": 6,
154813
156136
  "notebookCount": 0,
156137
+ "privateFileCount": 0,
154814
156138
  "resourceJobCount": 5,
154815
156139
  "keyCount": 17,
154816
156140
  "memberCount": 1,
@@ -155019,6 +156343,10 @@ Schema for instance patch request
155019
156343
  "type": "integer",
155020
156344
  "minimum": 0
155021
156345
  },
156346
+ "privatefile": {
156347
+ "type": "integer",
156348
+ "minimum": 0
156349
+ },
155022
156350
  "resourcejob": {
155023
156351
  "type": "integer",
155024
156352
  "minimum": 0
@@ -155359,6 +156687,9 @@ Schema for information about a sandbox user within an instance domain
155359
156687
  "notebook": {
155360
156688
  "type": "integer"
155361
156689
  },
156690
+ "privatefile": {
156691
+ "type": "integer"
156692
+ },
155362
156693
  "resourcejob": {
155363
156694
  "type": "integer"
155364
156695
  },
@@ -155467,6 +156798,9 @@ Schema for information about a sandbox user within an instance domain
155467
156798
  "resourceJobCount": {
155468
156799
  "type": "integer"
155469
156800
  },
156801
+ "privateFileCount": {
156802
+ "type": "integer"
156803
+ },
155470
156804
  "webhookCount": {
155471
156805
  "type": "integer"
155472
156806
  },
@@ -155924,6 +157258,9 @@ Schema for a collection of instance associated sandboxes
155924
157258
  "notebook": {
155925
157259
  "type": "integer"
155926
157260
  },
157261
+ "privatefile": {
157262
+ "type": "integer"
157263
+ },
155927
157264
  "resourcejob": {
155928
157265
  "type": "integer"
155929
157266
  },
@@ -156032,6 +157369,9 @@ Schema for a collection of instance associated sandboxes
156032
157369
  "resourceJobCount": {
156033
157370
  "type": "integer"
156034
157371
  },
157372
+ "privateFileCount": {
157373
+ "type": "integer"
157374
+ },
156035
157375
  "webhookCount": {
156036
157376
  "type": "integer"
156037
157377
  },
@@ -156569,6 +157909,9 @@ Schema for a collection of Instances
156569
157909
  "notebook": {
156570
157910
  "type": "integer"
156571
157911
  },
157912
+ "privatefile": {
157913
+ "type": "integer"
157914
+ },
156572
157915
  "resourcejob": {
156573
157916
  "type": "integer"
156574
157917
  },
@@ -156695,6 +158038,10 @@ Schema for a collection of Instances
156695
158038
  "type": "integer",
156696
158039
  "minimum": 0
156697
158040
  },
158041
+ "privatefile": {
158042
+ "type": "integer",
158043
+ "minimum": 0
158044
+ },
156698
158045
  "resourcejob": {
156699
158046
  "type": "integer",
156700
158047
  "minimum": 0
@@ -156842,6 +158189,7 @@ Schema for a collection of Instances
156842
158189
  "integration": 50,
156843
158190
  "notebook": 100,
156844
158191
  "resourcejob": 10,
158192
+ "privatefile": 1000,
156845
158193
  "webhook": 1000,
156846
158194
  "dataTTL": 15552000,
156847
158195
  "member": 100,
@@ -160738,6 +162086,9 @@ Schema for information about the currently authenticated user
160738
162086
  "notebook": {
160739
162087
  "type": "integer"
160740
162088
  },
162089
+ "privatefile": {
162090
+ "type": "integer"
162091
+ },
160741
162092
  "resourcejob": {
160742
162093
  "type": "integer"
160743
162094
  },
@@ -160960,6 +162311,9 @@ Schema for information about the currently authenticated user
160960
162311
  "resourceJobCount": {
160961
162312
  "type": "integer"
160962
162313
  },
162314
+ "privateFileCount": {
162315
+ "type": "integer"
162316
+ },
160963
162317
  "webhookCount": {
160964
162318
  "type": "integer"
160965
162319
  },
@@ -163997,6 +165351,14 @@ Schema for a single Notebook
163997
165351
  "queryJson": {
163998
165352
  "type": "string",
163999
165353
  "maxLength": 8192
165354
+ },
165355
+ "format": {
165356
+ "type": "string",
165357
+ "enum": [
165358
+ "csv",
165359
+ "json"
165360
+ ],
165361
+ "default": "csv"
164000
165362
  }
164001
165363
  },
164002
165364
  "required": [
@@ -164132,6 +165494,9 @@ Schema for a single Notebook
164132
165494
  "type": "string",
164133
165495
  "minLength": 1,
164134
165496
  "maxLength": 1024
165497
+ },
165498
+ "destinationPrivate": {
165499
+ "type": "boolean"
164135
165500
  }
164136
165501
  },
164137
165502
  "required": [
@@ -164168,6 +165533,9 @@ Schema for a single Notebook
164168
165533
  "type": "string",
164169
165534
  "minLength": 1,
164170
165535
  "maxLength": 1024
165536
+ },
165537
+ "destinationPrivate": {
165538
+ "type": "boolean"
164171
165539
  }
164172
165540
  },
164173
165541
  "required": [
@@ -164205,6 +165573,9 @@ Schema for a single Notebook
164205
165573
  "type": "string",
164206
165574
  "minLength": 1,
164207
165575
  "maxLength": 1024
165576
+ },
165577
+ "destinationPrivate": {
165578
+ "type": "boolean"
164208
165579
  }
164209
165580
  },
164210
165581
  "required": [
@@ -165133,6 +166504,14 @@ Schema for the body of a Notebook modification request
165133
166504
  "queryJson": {
165134
166505
  "type": "string",
165135
166506
  "maxLength": 8192
166507
+ },
166508
+ "format": {
166509
+ "type": "string",
166510
+ "enum": [
166511
+ "csv",
166512
+ "json"
166513
+ ],
166514
+ "default": "csv"
165136
166515
  }
165137
166516
  },
165138
166517
  "required": [
@@ -165268,6 +166647,9 @@ Schema for the body of a Notebook modification request
165268
166647
  "type": "string",
165269
166648
  "minLength": 1,
165270
166649
  "maxLength": 1024
166650
+ },
166651
+ "destinationPrivate": {
166652
+ "type": "boolean"
165271
166653
  }
165272
166654
  },
165273
166655
  "required": [
@@ -165304,6 +166686,9 @@ Schema for the body of a Notebook modification request
165304
166686
  "type": "string",
165305
166687
  "minLength": 1,
165306
166688
  "maxLength": 1024
166689
+ },
166690
+ "destinationPrivate": {
166691
+ "type": "boolean"
165307
166692
  }
165308
166693
  },
165309
166694
  "required": [
@@ -165341,6 +166726,9 @@ Schema for the body of a Notebook modification request
165341
166726
  "type": "string",
165342
166727
  "minLength": 1,
165343
166728
  "maxLength": 1024
166729
+ },
166730
+ "destinationPrivate": {
166731
+ "type": "boolean"
165344
166732
  }
165345
166733
  },
165346
166734
  "required": [
@@ -165787,6 +167175,14 @@ Schema for the body of an Notebook creation request
165787
167175
  "queryJson": {
165788
167176
  "type": "string",
165789
167177
  "maxLength": 8192
167178
+ },
167179
+ "format": {
167180
+ "type": "string",
167181
+ "enum": [
167182
+ "csv",
167183
+ "json"
167184
+ ],
167185
+ "default": "csv"
165790
167186
  }
165791
167187
  },
165792
167188
  "required": [
@@ -165922,6 +167318,9 @@ Schema for the body of an Notebook creation request
165922
167318
  "type": "string",
165923
167319
  "minLength": 1,
165924
167320
  "maxLength": 1024
167321
+ },
167322
+ "destinationPrivate": {
167323
+ "type": "boolean"
165925
167324
  }
165926
167325
  },
165927
167326
  "required": [
@@ -165958,6 +167357,9 @@ Schema for the body of an Notebook creation request
165958
167357
  "type": "string",
165959
167358
  "minLength": 1,
165960
167359
  "maxLength": 1024
167360
+ },
167361
+ "destinationPrivate": {
167362
+ "type": "boolean"
165961
167363
  }
165962
167364
  },
165963
167365
  "required": [
@@ -165995,6 +167397,9 @@ Schema for the body of an Notebook creation request
165995
167397
  "type": "string",
165996
167398
  "minLength": 1,
165997
167399
  "maxLength": 1024
167400
+ },
167401
+ "destinationPrivate": {
167402
+ "type": "boolean"
165998
167403
  }
165999
167404
  },
166000
167405
  "required": [
@@ -166471,6 +167876,14 @@ Schema for a collection of Notebooks
166471
167876
  "queryJson": {
166472
167877
  "type": "string",
166473
167878
  "maxLength": 8192
167879
+ },
167880
+ "format": {
167881
+ "type": "string",
167882
+ "enum": [
167883
+ "csv",
167884
+ "json"
167885
+ ],
167886
+ "default": "csv"
166474
167887
  }
166475
167888
  },
166476
167889
  "required": [
@@ -166606,6 +168019,9 @@ Schema for a collection of Notebooks
166606
168019
  "type": "string",
166607
168020
  "minLength": 1,
166608
168021
  "maxLength": 1024
168022
+ },
168023
+ "destinationPrivate": {
168024
+ "type": "boolean"
166609
168025
  }
166610
168026
  },
166611
168027
  "required": [
@@ -166642,6 +168058,9 @@ Schema for a collection of Notebooks
166642
168058
  "type": "string",
166643
168059
  "minLength": 1,
166644
168060
  "maxLength": 1024
168061
+ },
168062
+ "destinationPrivate": {
168063
+ "type": "boolean"
166645
168064
  }
166646
168065
  },
166647
168066
  "required": [
@@ -166679,6 +168098,9 @@ Schema for a collection of Notebooks
166679
168098
  "type": "string",
166680
168099
  "minLength": 1,
166681
168100
  "maxLength": 1024
168101
+ },
168102
+ "destinationPrivate": {
168103
+ "type": "boolean"
166682
168104
  }
166683
168105
  },
166684
168106
  "required": [
@@ -168126,6 +169548,10 @@ Schema for a single Organization
168126
169548
  "type": "integer",
168127
169549
  "minimum": 0
168128
169550
  },
169551
+ "privatefile": {
169552
+ "type": "integer",
169553
+ "minimum": 0
169554
+ },
168129
169555
  "resourcejob": {
168130
169556
  "type": "integer",
168131
169557
  "minimum": 0
@@ -168247,6 +169673,9 @@ Schema for a single Organization
168247
169673
  "notebookCount": {
168248
169674
  "type": "integer"
168249
169675
  },
169676
+ "privateFileCount": {
169677
+ "type": "integer"
169678
+ },
168250
169679
  "resourceJobCount": {
168251
169680
  "type": "integer"
168252
169681
  },
@@ -170016,6 +171445,10 @@ Schema for a collection of Organizations
170016
171445
  "type": "integer",
170017
171446
  "minimum": 0
170018
171447
  },
171448
+ "privatefile": {
171449
+ "type": "integer",
171450
+ "minimum": 0
171451
+ },
170019
171452
  "resourcejob": {
170020
171453
  "type": "integer",
170021
171454
  "minimum": 0
@@ -170137,6 +171570,9 @@ Schema for a collection of Organizations
170137
171570
  "notebookCount": {
170138
171571
  "type": "integer"
170139
171572
  },
171573
+ "privateFileCount": {
171574
+ "type": "integer"
171575
+ },
170140
171576
  "resourceJobCount": {
170141
171577
  "type": "integer"
170142
171578
  },
@@ -172963,10 +174399,12 @@ SAML Response body for login
172963
174399
  "flows.*",
172964
174400
  "flowVersion.*",
172965
174401
  "flowVersions.*",
172966
- "resourceJobs.*",
172967
- "resourceJob.*",
172968
174402
  "notebook.*",
172969
174403
  "notebooks.*",
174404
+ "privateFile.*",
174405
+ "privateFiles.*",
174406
+ "resourceJobs.*",
174407
+ "resourceJob.*",
172970
174408
  "webhook.*",
172971
174409
  "webhooks.*",
172972
174410
  "application.applyTemplate",
@@ -173203,6 +174641,13 @@ SAML Response body for login
173203
174641
  "notebook.upload",
173204
174642
  "notebooks.get",
173205
174643
  "notebooks.post",
174644
+ "privateFile.get",
174645
+ "privateFile.patch",
174646
+ "privateFile.move",
174647
+ "privateFile.delete",
174648
+ "privateFile.upload",
174649
+ "privateFiles.get",
174650
+ "privateFiles.post",
173206
174651
  "resourceJob.get",
173207
174652
  "resourceJob.logs",
173208
174653
  "resourceJob.patch",
@@ -173239,6 +174684,7 @@ SAML Response body for login
173239
174684
  "dashboard.patch",
173240
174685
  "dashboard.delete",
173241
174686
  "dashboard.sendReport",
174687
+ "dashboard.suggestCode",
173242
174688
  "dashboards.get",
173243
174689
  "dashboards.post",
173244
174690
  "org.get",
@@ -173575,6 +175021,19 @@ Schema for the response to a suggest function request
173575
175021
  "maxLength": 32767,
173576
175022
  "minLength": 1
173577
175023
  },
175024
+ "response": {
175025
+ "type": "object",
175026
+ "properties": {
175027
+ "code": {
175028
+ "type": "string",
175029
+ "maxLength": 32767
175030
+ },
175031
+ "comments": {
175032
+ "type": "string",
175033
+ "maxLength": 32767
175034
+ }
175035
+ }
175036
+ },
173578
175037
  "responseId": {
173579
175038
  "type": "string",
173580
175039
  "minLength": 1,
@@ -173597,7 +175056,6 @@ Schema for the response to a suggest function request
173597
175056
  }
173598
175057
  },
173599
175058
  "required": [
173600
- "text",
173601
175059
  "responseId",
173602
175060
  "finishReason"
173603
175061
  ],
@@ -173608,7 +175066,10 @@ Schema for the response to a suggest function request
173608
175066
 
173609
175067
  ```json
173610
175068
  {
173611
- "text": "```javascript\n/**\n * A function to sort an array of objects, by their 'name' property,\n * from the nethermost 'Z' to the foremost 'A'.\n *\n * @param {Array<Object>} arr - The array of objects to be sorted,\n * each object possessing a 'name' property.\n * @returns {Array<Object>} - The sorted array of objects.\n */\nfunction sortObjectsByNameReverse(arr) {\n // Hark! A comparison function, to bend the wills of objects!\n // We shall compare the names, and judge which doth precede the other.\n return arr.sort((a, b) => {\n // Let 'nameA' be the name of the first object, brought low for scrutiny.\n const nameA = a.name.toUpperCase(); // Cast aloft to uppercase, lest lower case betray us!\n // And 'nameB', the name of the second, likewise brought before us.\n const nameB = b.name.toUpperCase(); // Uppercase again, that all be judged as equals!\n\n // Now, to the comparing! A most subtle dance of precedence!\n if (nameA < nameB) {\n // If 'nameA' be found wanting, and falls behind 'nameB'...\n return 1; // ...then 'nameB' shall take precedence, and rise above!\n }\n if (nameA > nameB) {\n // But if 'nameA' doth surpass 'nameB', and standeth taller...\n return -1; // ...then 'nameA' shall hold its place, and 'nameB' shall yield.\n }\n\n // Should they be equal, twins in name and form...\n return 0; // ...then let them remain as they were, neither before nor behind.\n });\n}\n\n// Example Usage: A scene of players, sorted by their given names!\nconst players = [\n { name: \"Hamlet\" },\n { name: \"Ophelia\" },\n { name: \"Lear\" },\n { name: \"Macbeth\" },\n { name: \"Juliet\" },\n];\n\nconst sortedPlayers = sortObjectsByNameReverse(players);\nconsole.log(sortedPlayers); // Behold! A tragedy, properly ordered!\n\n```\n\n**Explanation of the Shakespearean Comments:**\n\n* **Hark!**: An attention-grabbing start, like a herald announcing something important.\n* **Bend the wills of objects!**: A dramatic way of saying \"compare the objects.\"\n* **Brought low for scrutiny**: Figurative language for accessing the `name` property.\n* **Cast aloft to uppercase, lest lower case betray us!**: Converting to uppercase to ensure case-insensitive sorting (avoids confusion with lowercase vs. uppercase letters). The \"betray us\" adds a dramatic flair.\n* **A most subtle dance of precedence!**: Describing the comparison process in a poetic way.\n* **Found wanting, and falls behind**: Describing the comparison result in a theatrical manner.\n* **Take precedence, and rise above!**: Emphasizing the meaning of the return value `1`.\n* **Doth surpass... shall hold its place, and yield**: The inverse of the previous comment, for the `-1` return value.\n* **Twins in name and form**: Describes when the names are equal.\n* **Then let them remain as they were**: meaning return 0, and the original order remains intact.\n* **Behold! A tragedy, properly ordered!**: A dramatic conclusion to the example, linking the sorted array back to the Shakespearean theme.\n\nThe comments attempt to use language that is both descriptive of the code and stylistically reminiscent of Shakespeare's plays, adding a layer of humor and theatricality to the code explanation.\n",
175069
+ "response": {
175070
+ "code": "payload.tempF = (9/5 * payload.tempC) + 32;",
175071
+ "comments": "This function will convert a Fahrenheit temperature at `payload.tempF` to a Celsius temperature and place the result at `payload.tempC`."
175072
+ },
173612
175073
  "responseId": "YCwSaIeyOfComecPutWYyAg",
173613
175074
  "finishReason": "STOP"
173614
175075
  }
@@ -176338,10 +177799,12 @@ Schema for the body of a User authentication request
176338
177799
  "flows.*",
176339
177800
  "flowVersion.*",
176340
177801
  "flowVersions.*",
176341
- "resourceJobs.*",
176342
- "resourceJob.*",
176343
177802
  "notebook.*",
176344
177803
  "notebooks.*",
177804
+ "privateFile.*",
177805
+ "privateFiles.*",
177806
+ "resourceJobs.*",
177807
+ "resourceJob.*",
176345
177808
  "webhook.*",
176346
177809
  "webhooks.*",
176347
177810
  "application.applyTemplate",
@@ -176578,6 +178041,13 @@ Schema for the body of a User authentication request
176578
178041
  "notebook.upload",
176579
178042
  "notebooks.get",
176580
178043
  "notebooks.post",
178044
+ "privateFile.get",
178045
+ "privateFile.patch",
178046
+ "privateFile.move",
178047
+ "privateFile.delete",
178048
+ "privateFile.upload",
178049
+ "privateFiles.get",
178050
+ "privateFiles.post",
176581
178051
  "resourceJob.get",
176582
178052
  "resourceJob.logs",
176583
178053
  "resourceJob.patch",
@@ -176614,6 +178084,7 @@ Schema for the body of a User authentication request
176614
178084
  "dashboard.patch",
176615
178085
  "dashboard.delete",
176616
178086
  "dashboard.sendReport",
178087
+ "dashboard.suggestCode",
176617
178088
  "dashboards.get",
176618
178089
  "dashboards.post",
176619
178090
  "org.get",
@@ -176949,10 +178420,12 @@ Schema for the body of a User creation request
176949
178420
  "flows.*",
176950
178421
  "flowVersion.*",
176951
178422
  "flowVersions.*",
176952
- "resourceJobs.*",
176953
- "resourceJob.*",
176954
178423
  "notebook.*",
176955
178424
  "notebooks.*",
178425
+ "privateFile.*",
178426
+ "privateFiles.*",
178427
+ "resourceJobs.*",
178428
+ "resourceJob.*",
176956
178429
  "webhook.*",
176957
178430
  "webhooks.*",
176958
178431
  "application.applyTemplate",
@@ -177189,6 +178662,13 @@ Schema for the body of a User creation request
177189
178662
  "notebook.upload",
177190
178663
  "notebooks.get",
177191
178664
  "notebooks.post",
178665
+ "privateFile.get",
178666
+ "privateFile.patch",
178667
+ "privateFile.move",
178668
+ "privateFile.delete",
178669
+ "privateFile.upload",
178670
+ "privateFiles.get",
178671
+ "privateFiles.post",
177192
178672
  "resourceJob.get",
177193
178673
  "resourceJob.logs",
177194
178674
  "resourceJob.patch",
@@ -177225,6 +178705,7 @@ Schema for the body of a User creation request
177225
178705
  "dashboard.patch",
177226
178706
  "dashboard.delete",
177227
178707
  "dashboard.sendReport",
178708
+ "dashboard.suggestCode",
177228
178709
  "dashboards.get",
177229
178710
  "dashboards.post",
177230
178711
  "org.get",