losant_rest 1.22.0 → 1.22.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.
data/docs/_schemas.md CHANGED
@@ -292,6 +292,8 @@
292
292
  * [SSO Request](#sso-request)
293
293
  * [Success](#success)
294
294
  * [Success With Execution ID](#success-with-execution-id)
295
+ * [Suggest Function Post](#suggest-function-post)
296
+ * [Suggest Function Respone](#suggest-function-respone)
295
297
  * [Tag Keys Response](#tag-keys-response)
296
298
  * [Tag Values Response](#tag-values-response)
297
299
  * [Template Keywords](#template-keywords)
@@ -13425,6 +13427,7 @@ Schema for the body of an API Token creation request
13425
13427
  "flow.setStorageEntry",
13426
13428
  "flow.getStorageEntriesMetadata",
13427
13429
  "flow.stats",
13430
+ "flow.suggestFunction",
13428
13431
  "flows.get",
13429
13432
  "flows.getByVersion",
13430
13433
  "flows.import",
@@ -17070,6 +17073,45 @@ Schema for the body of an Application scoped Dashboard creation request
17070
17073
  }
17071
17074
  },
17072
17075
  "additionalProperties": false
17076
+ },
17077
+ {
17078
+ "type": "object",
17079
+ "properties": {
17080
+ "queryType": {
17081
+ "type": "string",
17082
+ "enum": [
17083
+ "events"
17084
+ ]
17085
+ },
17086
+ "id": {
17087
+ "type": "string",
17088
+ "maxLength": 48
17089
+ },
17090
+ "sortField": {
17091
+ "type": "string",
17092
+ "maxLength": 255
17093
+ },
17094
+ "sortDirection": {
17095
+ "type": "string",
17096
+ "maxLength": 255
17097
+ },
17098
+ "page": {
17099
+ "type": "string",
17100
+ "maxLength": 255
17101
+ },
17102
+ "perPage": {
17103
+ "type": "string",
17104
+ "maxLength": 255
17105
+ },
17106
+ "query": {
17107
+ "type": "string",
17108
+ "maxLength": 32767
17109
+ },
17110
+ "includeExtendedEventInfo": {
17111
+ "type": "boolean"
17112
+ }
17113
+ },
17114
+ "additionalProperties": false
17073
17115
  }
17074
17116
  ]
17075
17117
  }
@@ -18743,6 +18785,18 @@ Schema for the body of an Application scoped Dashboard creation request
18743
18785
  "format": {
18744
18786
  "type": "string",
18745
18787
  "maxLength": 255
18788
+ },
18789
+ "scale": {
18790
+ "type": "string",
18791
+ "enum": [
18792
+ "linear",
18793
+ "log",
18794
+ "sqrt"
18795
+ ],
18796
+ "default": "linear"
18797
+ },
18798
+ "stacked": {
18799
+ "type": "boolean"
18746
18800
  }
18747
18801
  },
18748
18802
  "additionalProperties": false,
@@ -18750,6 +18804,75 @@ Schema for the body of an Application scoped Dashboard creation request
18750
18804
  "id"
18751
18805
  ]
18752
18806
  }
18807
+ },
18808
+ "decorators": {
18809
+ "type": "array",
18810
+ "maxItems": 10,
18811
+ "items": {
18812
+ "type": "object",
18813
+ "properties": {
18814
+ "type": {
18815
+ "type": "string",
18816
+ "enum": [
18817
+ "line",
18818
+ "area"
18819
+ ]
18820
+ },
18821
+ "yAxisId": {
18822
+ "type": "string",
18823
+ "maxLength": 48
18824
+ },
18825
+ "label": {
18826
+ "type": "string",
18827
+ "maxLength": 255
18828
+ },
18829
+ "color": {
18830
+ "type": "string",
18831
+ "maxLength": 64
18832
+ },
18833
+ "lineStyle": {
18834
+ "type": "string",
18835
+ "enum": [
18836
+ "solid",
18837
+ "dotted",
18838
+ "dashed"
18839
+ ]
18840
+ },
18841
+ "lineWeight": {
18842
+ "type": "integer",
18843
+ "minimum": 0,
18844
+ "maximum": 5
18845
+ },
18846
+ "y1": {
18847
+ "oneOf": [
18848
+ {
18849
+ "type": "number"
18850
+ },
18851
+ {
18852
+ "type": "string",
18853
+ "maxLength": 128
18854
+ }
18855
+ ]
18856
+ },
18857
+ "y2": {
18858
+ "oneOf": [
18859
+ {
18860
+ "type": "number"
18861
+ },
18862
+ {
18863
+ "type": "string",
18864
+ "maxLength": 128
18865
+ }
18866
+ ]
18867
+ }
18868
+ },
18869
+ "required": [
18870
+ "type",
18871
+ "yAxisId",
18872
+ "y1"
18873
+ ],
18874
+ "additionalProperties": false
18875
+ }
18753
18876
  }
18754
18877
  },
18755
18878
  "additionalProperties": false
@@ -38623,6 +38746,45 @@ Schema for a single Dashboard
38623
38746
  }
38624
38747
  },
38625
38748
  "additionalProperties": false
38749
+ },
38750
+ {
38751
+ "type": "object",
38752
+ "properties": {
38753
+ "queryType": {
38754
+ "type": "string",
38755
+ "enum": [
38756
+ "events"
38757
+ ]
38758
+ },
38759
+ "id": {
38760
+ "type": "string",
38761
+ "maxLength": 48
38762
+ },
38763
+ "sortField": {
38764
+ "type": "string",
38765
+ "maxLength": 255
38766
+ },
38767
+ "sortDirection": {
38768
+ "type": "string",
38769
+ "maxLength": 255
38770
+ },
38771
+ "page": {
38772
+ "type": "string",
38773
+ "maxLength": 255
38774
+ },
38775
+ "perPage": {
38776
+ "type": "string",
38777
+ "maxLength": 255
38778
+ },
38779
+ "query": {
38780
+ "type": "string",
38781
+ "maxLength": 32767
38782
+ },
38783
+ "includeExtendedEventInfo": {
38784
+ "type": "boolean"
38785
+ }
38786
+ },
38787
+ "additionalProperties": false
38626
38788
  }
38627
38789
  ]
38628
38790
  }
@@ -40296,6 +40458,18 @@ Schema for a single Dashboard
40296
40458
  "format": {
40297
40459
  "type": "string",
40298
40460
  "maxLength": 255
40461
+ },
40462
+ "scale": {
40463
+ "type": "string",
40464
+ "enum": [
40465
+ "linear",
40466
+ "log",
40467
+ "sqrt"
40468
+ ],
40469
+ "default": "linear"
40470
+ },
40471
+ "stacked": {
40472
+ "type": "boolean"
40299
40473
  }
40300
40474
  },
40301
40475
  "additionalProperties": false,
@@ -40303,6 +40477,75 @@ Schema for a single Dashboard
40303
40477
  "id"
40304
40478
  ]
40305
40479
  }
40480
+ },
40481
+ "decorators": {
40482
+ "type": "array",
40483
+ "maxItems": 10,
40484
+ "items": {
40485
+ "type": "object",
40486
+ "properties": {
40487
+ "type": {
40488
+ "type": "string",
40489
+ "enum": [
40490
+ "line",
40491
+ "area"
40492
+ ]
40493
+ },
40494
+ "yAxisId": {
40495
+ "type": "string",
40496
+ "maxLength": 48
40497
+ },
40498
+ "label": {
40499
+ "type": "string",
40500
+ "maxLength": 255
40501
+ },
40502
+ "color": {
40503
+ "type": "string",
40504
+ "maxLength": 64
40505
+ },
40506
+ "lineStyle": {
40507
+ "type": "string",
40508
+ "enum": [
40509
+ "solid",
40510
+ "dotted",
40511
+ "dashed"
40512
+ ]
40513
+ },
40514
+ "lineWeight": {
40515
+ "type": "integer",
40516
+ "minimum": 0,
40517
+ "maximum": 5
40518
+ },
40519
+ "y1": {
40520
+ "oneOf": [
40521
+ {
40522
+ "type": "number"
40523
+ },
40524
+ {
40525
+ "type": "string",
40526
+ "maxLength": 128
40527
+ }
40528
+ ]
40529
+ },
40530
+ "y2": {
40531
+ "oneOf": [
40532
+ {
40533
+ "type": "number"
40534
+ },
40535
+ {
40536
+ "type": "string",
40537
+ "maxLength": 128
40538
+ }
40539
+ ]
40540
+ }
40541
+ },
40542
+ "required": [
40543
+ "type",
40544
+ "yAxisId",
40545
+ "y1"
40546
+ ],
40547
+ "additionalProperties": false
40548
+ }
40306
40549
  }
40307
40550
  },
40308
40551
  "additionalProperties": false
@@ -44940,6 +45183,45 @@ Schema for the body of a Dashboard modification request
44940
45183
  }
44941
45184
  },
44942
45185
  "additionalProperties": false
45186
+ },
45187
+ {
45188
+ "type": "object",
45189
+ "properties": {
45190
+ "queryType": {
45191
+ "type": "string",
45192
+ "enum": [
45193
+ "events"
45194
+ ]
45195
+ },
45196
+ "id": {
45197
+ "type": "string",
45198
+ "maxLength": 48
45199
+ },
45200
+ "sortField": {
45201
+ "type": "string",
45202
+ "maxLength": 255
45203
+ },
45204
+ "sortDirection": {
45205
+ "type": "string",
45206
+ "maxLength": 255
45207
+ },
45208
+ "page": {
45209
+ "type": "string",
45210
+ "maxLength": 255
45211
+ },
45212
+ "perPage": {
45213
+ "type": "string",
45214
+ "maxLength": 255
45215
+ },
45216
+ "query": {
45217
+ "type": "string",
45218
+ "maxLength": 32767
45219
+ },
45220
+ "includeExtendedEventInfo": {
45221
+ "type": "boolean"
45222
+ }
45223
+ },
45224
+ "additionalProperties": false
44943
45225
  }
44944
45226
  ]
44945
45227
  }
@@ -46613,6 +46895,18 @@ Schema for the body of a Dashboard modification request
46613
46895
  "format": {
46614
46896
  "type": "string",
46615
46897
  "maxLength": 255
46898
+ },
46899
+ "scale": {
46900
+ "type": "string",
46901
+ "enum": [
46902
+ "linear",
46903
+ "log",
46904
+ "sqrt"
46905
+ ],
46906
+ "default": "linear"
46907
+ },
46908
+ "stacked": {
46909
+ "type": "boolean"
46616
46910
  }
46617
46911
  },
46618
46912
  "additionalProperties": false,
@@ -46620,6 +46914,75 @@ Schema for the body of a Dashboard modification request
46620
46914
  "id"
46621
46915
  ]
46622
46916
  }
46917
+ },
46918
+ "decorators": {
46919
+ "type": "array",
46920
+ "maxItems": 10,
46921
+ "items": {
46922
+ "type": "object",
46923
+ "properties": {
46924
+ "type": {
46925
+ "type": "string",
46926
+ "enum": [
46927
+ "line",
46928
+ "area"
46929
+ ]
46930
+ },
46931
+ "yAxisId": {
46932
+ "type": "string",
46933
+ "maxLength": 48
46934
+ },
46935
+ "label": {
46936
+ "type": "string",
46937
+ "maxLength": 255
46938
+ },
46939
+ "color": {
46940
+ "type": "string",
46941
+ "maxLength": 64
46942
+ },
46943
+ "lineStyle": {
46944
+ "type": "string",
46945
+ "enum": [
46946
+ "solid",
46947
+ "dotted",
46948
+ "dashed"
46949
+ ]
46950
+ },
46951
+ "lineWeight": {
46952
+ "type": "integer",
46953
+ "minimum": 0,
46954
+ "maximum": 5
46955
+ },
46956
+ "y1": {
46957
+ "oneOf": [
46958
+ {
46959
+ "type": "number"
46960
+ },
46961
+ {
46962
+ "type": "string",
46963
+ "maxLength": 128
46964
+ }
46965
+ ]
46966
+ },
46967
+ "y2": {
46968
+ "oneOf": [
46969
+ {
46970
+ "type": "number"
46971
+ },
46972
+ {
46973
+ "type": "string",
46974
+ "maxLength": 128
46975
+ }
46976
+ ]
46977
+ }
46978
+ },
46979
+ "required": [
46980
+ "type",
46981
+ "yAxisId",
46982
+ "y1"
46983
+ ],
46984
+ "additionalProperties": false
46985
+ }
46623
46986
  }
46624
46987
  },
46625
46988
  "additionalProperties": false
@@ -51255,6 +51618,45 @@ Schema for the body of a Dashboard creation request
51255
51618
  }
51256
51619
  },
51257
51620
  "additionalProperties": false
51621
+ },
51622
+ {
51623
+ "type": "object",
51624
+ "properties": {
51625
+ "queryType": {
51626
+ "type": "string",
51627
+ "enum": [
51628
+ "events"
51629
+ ]
51630
+ },
51631
+ "id": {
51632
+ "type": "string",
51633
+ "maxLength": 48
51634
+ },
51635
+ "sortField": {
51636
+ "type": "string",
51637
+ "maxLength": 255
51638
+ },
51639
+ "sortDirection": {
51640
+ "type": "string",
51641
+ "maxLength": 255
51642
+ },
51643
+ "page": {
51644
+ "type": "string",
51645
+ "maxLength": 255
51646
+ },
51647
+ "perPage": {
51648
+ "type": "string",
51649
+ "maxLength": 255
51650
+ },
51651
+ "query": {
51652
+ "type": "string",
51653
+ "maxLength": 32767
51654
+ },
51655
+ "includeExtendedEventInfo": {
51656
+ "type": "boolean"
51657
+ }
51658
+ },
51659
+ "additionalProperties": false
51258
51660
  }
51259
51661
  ]
51260
51662
  }
@@ -52928,6 +53330,18 @@ Schema for the body of a Dashboard creation request
52928
53330
  "format": {
52929
53331
  "type": "string",
52930
53332
  "maxLength": 255
53333
+ },
53334
+ "scale": {
53335
+ "type": "string",
53336
+ "enum": [
53337
+ "linear",
53338
+ "log",
53339
+ "sqrt"
53340
+ ],
53341
+ "default": "linear"
53342
+ },
53343
+ "stacked": {
53344
+ "type": "boolean"
52931
53345
  }
52932
53346
  },
52933
53347
  "additionalProperties": false,
@@ -52935,6 +53349,75 @@ Schema for the body of a Dashboard creation request
52935
53349
  "id"
52936
53350
  ]
52937
53351
  }
53352
+ },
53353
+ "decorators": {
53354
+ "type": "array",
53355
+ "maxItems": 10,
53356
+ "items": {
53357
+ "type": "object",
53358
+ "properties": {
53359
+ "type": {
53360
+ "type": "string",
53361
+ "enum": [
53362
+ "line",
53363
+ "area"
53364
+ ]
53365
+ },
53366
+ "yAxisId": {
53367
+ "type": "string",
53368
+ "maxLength": 48
53369
+ },
53370
+ "label": {
53371
+ "type": "string",
53372
+ "maxLength": 255
53373
+ },
53374
+ "color": {
53375
+ "type": "string",
53376
+ "maxLength": 64
53377
+ },
53378
+ "lineStyle": {
53379
+ "type": "string",
53380
+ "enum": [
53381
+ "solid",
53382
+ "dotted",
53383
+ "dashed"
53384
+ ]
53385
+ },
53386
+ "lineWeight": {
53387
+ "type": "integer",
53388
+ "minimum": 0,
53389
+ "maximum": 5
53390
+ },
53391
+ "y1": {
53392
+ "oneOf": [
53393
+ {
53394
+ "type": "number"
53395
+ },
53396
+ {
53397
+ "type": "string",
53398
+ "maxLength": 128
53399
+ }
53400
+ ]
53401
+ },
53402
+ "y2": {
53403
+ "oneOf": [
53404
+ {
53405
+ "type": "number"
53406
+ },
53407
+ {
53408
+ "type": "string",
53409
+ "maxLength": 128
53410
+ }
53411
+ ]
53412
+ }
53413
+ },
53414
+ "required": [
53415
+ "type",
53416
+ "yAxisId",
53417
+ "y1"
53418
+ ],
53419
+ "additionalProperties": false
53420
+ }
52938
53421
  }
52939
53422
  },
52940
53423
  "additionalProperties": false
@@ -57969,6 +58452,45 @@ Schema for a collection of Dashboards
57969
58452
  }
57970
58453
  },
57971
58454
  "additionalProperties": false
58455
+ },
58456
+ {
58457
+ "type": "object",
58458
+ "properties": {
58459
+ "queryType": {
58460
+ "type": "string",
58461
+ "enum": [
58462
+ "events"
58463
+ ]
58464
+ },
58465
+ "id": {
58466
+ "type": "string",
58467
+ "maxLength": 48
58468
+ },
58469
+ "sortField": {
58470
+ "type": "string",
58471
+ "maxLength": 255
58472
+ },
58473
+ "sortDirection": {
58474
+ "type": "string",
58475
+ "maxLength": 255
58476
+ },
58477
+ "page": {
58478
+ "type": "string",
58479
+ "maxLength": 255
58480
+ },
58481
+ "perPage": {
58482
+ "type": "string",
58483
+ "maxLength": 255
58484
+ },
58485
+ "query": {
58486
+ "type": "string",
58487
+ "maxLength": 32767
58488
+ },
58489
+ "includeExtendedEventInfo": {
58490
+ "type": "boolean"
58491
+ }
58492
+ },
58493
+ "additionalProperties": false
57972
58494
  }
57973
58495
  ]
57974
58496
  }
@@ -59642,6 +60164,18 @@ Schema for a collection of Dashboards
59642
60164
  "format": {
59643
60165
  "type": "string",
59644
60166
  "maxLength": 255
60167
+ },
60168
+ "scale": {
60169
+ "type": "string",
60170
+ "enum": [
60171
+ "linear",
60172
+ "log",
60173
+ "sqrt"
60174
+ ],
60175
+ "default": "linear"
60176
+ },
60177
+ "stacked": {
60178
+ "type": "boolean"
59645
60179
  }
59646
60180
  },
59647
60181
  "additionalProperties": false,
@@ -59649,6 +60183,75 @@ Schema for a collection of Dashboards
59649
60183
  "id"
59650
60184
  ]
59651
60185
  }
60186
+ },
60187
+ "decorators": {
60188
+ "type": "array",
60189
+ "maxItems": 10,
60190
+ "items": {
60191
+ "type": "object",
60192
+ "properties": {
60193
+ "type": {
60194
+ "type": "string",
60195
+ "enum": [
60196
+ "line",
60197
+ "area"
60198
+ ]
60199
+ },
60200
+ "yAxisId": {
60201
+ "type": "string",
60202
+ "maxLength": 48
60203
+ },
60204
+ "label": {
60205
+ "type": "string",
60206
+ "maxLength": 255
60207
+ },
60208
+ "color": {
60209
+ "type": "string",
60210
+ "maxLength": 64
60211
+ },
60212
+ "lineStyle": {
60213
+ "type": "string",
60214
+ "enum": [
60215
+ "solid",
60216
+ "dotted",
60217
+ "dashed"
60218
+ ]
60219
+ },
60220
+ "lineWeight": {
60221
+ "type": "integer",
60222
+ "minimum": 0,
60223
+ "maximum": 5
60224
+ },
60225
+ "y1": {
60226
+ "oneOf": [
60227
+ {
60228
+ "type": "number"
60229
+ },
60230
+ {
60231
+ "type": "string",
60232
+ "maxLength": 128
60233
+ }
60234
+ ]
60235
+ },
60236
+ "y2": {
60237
+ "oneOf": [
60238
+ {
60239
+ "type": "number"
60240
+ },
60241
+ {
60242
+ "type": "string",
60243
+ "maxLength": 128
60244
+ }
60245
+ ]
60246
+ }
60247
+ },
60248
+ "required": [
60249
+ "type",
60250
+ "yAxisId",
60251
+ "y1"
60252
+ ],
60253
+ "additionalProperties": false
60254
+ }
59652
60255
  }
59653
60256
  },
59654
60257
  "additionalProperties": false
@@ -65510,6 +66113,10 @@ Schema for exporting data devices query
65510
66113
  "includeBlobData": {
65511
66114
  "type": "boolean",
65512
66115
  "default": false
66116
+ },
66117
+ "filePerDevice": {
66118
+ "type": "boolean",
66119
+ "default": false
65513
66120
  }
65514
66121
  }
65515
66122
  }
@@ -79573,6 +80180,71 @@ Schema for the body of a Devices modification request
79573
80180
  ],
79574
80181
  "additionalProperties": false
79575
80182
  },
80183
+ {
80184
+ "type": "object",
80185
+ "properties": {
80186
+ "operation": {
80187
+ "type": "string",
80188
+ "enum": [
80189
+ "set"
80190
+ ]
80191
+ },
80192
+ "target": {
80193
+ "type": "string",
80194
+ "enum": [
80195
+ "attributeContentType"
80196
+ ]
80197
+ },
80198
+ "attributeName": {
80199
+ "type": "string",
80200
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
80201
+ },
80202
+ "value": {
80203
+ "type": "string",
80204
+ "maxLength": 64,
80205
+ "minLength": 1
80206
+ }
80207
+ },
80208
+ "required": [
80209
+ "operation",
80210
+ "target",
80211
+ "attributeName",
80212
+ "value"
80213
+ ],
80214
+ "additionalProperties": false
80215
+ },
80216
+ {
80217
+ "type": "object",
80218
+ "properties": {
80219
+ "operation": {
80220
+ "type": "string",
80221
+ "enum": [
80222
+ "set"
80223
+ ]
80224
+ },
80225
+ "target": {
80226
+ "type": "string",
80227
+ "enum": [
80228
+ "attributeName"
80229
+ ]
80230
+ },
80231
+ "attributeName": {
80232
+ "type": "string",
80233
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
80234
+ },
80235
+ "value": {
80236
+ "type": "string",
80237
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
80238
+ }
80239
+ },
80240
+ "required": [
80241
+ "operation",
80242
+ "target",
80243
+ "attributeName",
80244
+ "value"
80245
+ ],
80246
+ "additionalProperties": false
80247
+ },
79576
80248
  {
79577
80249
  "type": "object",
79578
80250
  "properties": {
@@ -144061,6 +144733,7 @@ Schema for the body of a Github login request
144061
144733
  "flow.setStorageEntry",
144062
144734
  "flow.getStorageEntriesMetadata",
144063
144735
  "flow.stats",
144736
+ "flow.suggestFunction",
144064
144737
  "flows.get",
144065
144738
  "flows.getByVersion",
144066
144739
  "flows.import",
@@ -170567,6 +171240,7 @@ SAML Response body for login
170567
171240
  "flow.setStorageEntry",
170568
171241
  "flow.getStorageEntriesMetadata",
170569
171242
  "flow.stats",
171243
+ "flow.suggestFunction",
170570
171244
  "flows.get",
170571
171245
  "flows.getByVersion",
170572
171246
  "flows.import",
@@ -170919,6 +171593,96 @@ Schema for reporting a successful operation with a corresponding execution ID
170919
171593
 
170920
171594
  <br/>
170921
171595
 
171596
+ ## Suggest Function Post
171597
+
171598
+ Schema for the body of a workflow suggestion function request
171599
+
171600
+ ### <a name="suggest-function-post-schema"></a> Schema
171601
+
171602
+ ```json
171603
+ {
171604
+ "$schema": "http://json-schema.org/draft-07/schema#",
171605
+ "type": "object",
171606
+ "properties": {
171607
+ "text": {
171608
+ "type": "string",
171609
+ "minLength": 1,
171610
+ "maxLength": 8192
171611
+ }
171612
+ },
171613
+ "required": [
171614
+ "text"
171615
+ ],
171616
+ "additionalProperties": false
171617
+ }
171618
+ ```
171619
+ ### <a name="suggest-function-post-example"></a> Example
171620
+
171621
+ ```json
171622
+ {
171623
+ "text": "A function that sorts an array of objects by the name property from z to a"
171624
+ }
171625
+ ```
171626
+
171627
+ <br/>
171628
+
171629
+ ## Suggest Function Respone
171630
+
171631
+ Schema for the response to a suggest function request
171632
+
171633
+ ### <a name="suggest-function-respone-schema"></a> Schema
171634
+
171635
+ ```json
171636
+ {
171637
+ "$schema": "http://json-schema.org/draft-07/schema#",
171638
+ "type": "object",
171639
+ "properties": {
171640
+ "text": {
171641
+ "type": "string",
171642
+ "maxLength": 32767,
171643
+ "minLength": 1
171644
+ },
171645
+ "responseId": {
171646
+ "type": "string",
171647
+ "minLength": 1,
171648
+ "maxLength": 1024
171649
+ },
171650
+ "finishReason": {
171651
+ "type": "string",
171652
+ "enum": [
171653
+ "FINISH_REASON_UNSPECIFIED",
171654
+ "STOP",
171655
+ "MAX_TOKENS",
171656
+ "SAFETY",
171657
+ "RECITATION",
171658
+ "OTHER",
171659
+ "BLOCKLIST",
171660
+ "PROHIBITED_CONTENT",
171661
+ "SPII",
171662
+ "MALFORMED_FUNCTION_CALL"
171663
+ ]
171664
+ }
171665
+ },
171666
+ "required": [
171667
+ "text",
171668
+ "responseId",
171669
+ "finishReason"
171670
+ ],
171671
+ "additionalProperties": false
171672
+ }
171673
+ ```
171674
+ ### <a name="suggest-function-respone-example"></a> Example
171675
+
171676
+ ```json
171677
+ {
171678
+ "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",
171679
+ "responseId": "YCwSaIeyOfComecPutWYyAg",
171680
+ "finishReason": "STOP"
171681
+ }
171682
+ ```
171683
+
171684
+ <br/>
171685
+
170922
171686
  ## Tag Keys Response
170923
171687
 
170924
171688
  Schema for a list of tag keys
@@ -173846,6 +174610,7 @@ Schema for the body of a User authentication request
173846
174610
  "flow.setStorageEntry",
173847
174611
  "flow.getStorageEntriesMetadata",
173848
174612
  "flow.stats",
174613
+ "flow.suggestFunction",
173849
174614
  "flows.get",
173850
174615
  "flows.getByVersion",
173851
174616
  "flows.import",
@@ -174452,6 +175217,7 @@ Schema for the body of a User creation request
174452
175217
  "flow.setStorageEntry",
174453
175218
  "flow.getStorageEntriesMetadata",
174454
175219
  "flow.stats",
175220
+ "flow.suggestFunction",
174455
175221
  "flows.get",
174456
175222
  "flows.getByVersion",
174457
175223
  "flows.import",