@seamapi/types 1.1017.0 → 1.1019.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. package/lib/seam/connect/models/custom-metadata.d.ts +4 -1
  2. package/lib/seam/connect/models/custom-metadata.js +7 -2
  3. package/lib/seam/connect/models/custom-metadata.js.map +1 -1
  4. package/lib/seam/connect/models/devices/device-metadata.d.ts +10 -0
  5. package/lib/seam/connect/models/devices/device-metadata.js +9 -1
  6. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  7. package/lib/seam/connect/models/devices/device.d.ts +14 -0
  8. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +10 -0
  9. package/lib/seam/connect/openapi.js +27 -7
  10. package/lib/seam/connect/openapi.js.map +1 -1
  11. package/lib/seam/connect/route-types.d.ts +91 -23
  12. package/package.json +1 -1
  13. package/src/lib/seam/connect/models/custom-metadata.ts +15 -2
  14. package/src/lib/seam/connect/models/devices/device-metadata.ts +13 -1
  15. package/src/lib/seam/connect/openapi.ts +29 -7
  16. package/src/lib/seam/connect/route-types.ts +125 -23
package/lib/seam/connect/route-types.d.ts CHANGED
@@ -12574,8 +12574,12 @@ export type Routes = {
12574
12574
  product_type?: (string | undefined) | undefined;
12575
12575
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
12576
12576
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
12577
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
12577
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
12578
12578
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
12579
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
12580
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
12581
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
12582
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
12579
12583
  } | undefined;
12580
12584
  /** Metadata for a KeyNest device. */
12581
12585
  keynest_metadata?: {
@@ -19636,8 +19640,12 @@ export type Routes = {
19636
19640
  product_type?: (string | undefined) | undefined;
19637
19641
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
19638
19642
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
19639
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
19643
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
19640
19644
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
19645
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
19646
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
19647
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
19648
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
19641
19649
  } | undefined;
19642
19650
  /** Metadata for a KeyNest device. */
19643
19651
  keynest_metadata?: {
@@ -41277,9 +41285,9 @@ export type Routes = {
41277
41285
  customer_key?: string | undefined;
41278
41286
  /** Your user ID for the user by which you want to filter Connect Webviews. */
41279
41287
  user_identifier_key?: string | undefined;
41280
- /** Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string. */
41288
+ /** Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. */
41281
41289
  custom_metadata_has?: {
41282
- [x: string]: string | boolean;
41290
+ [x: string]: string | boolean | null;
41283
41291
  } | undefined;
41284
41292
  /** String for which to search. Filters returned Connect Webviews to include all records that satisfy a partial match using `connect_webview_id`, `accepted_providers`, `custom_metadata`, or `customer_key`. */
41285
41293
  search?: string | undefined;
@@ -41571,9 +41579,9 @@ export type Routes = {
41571
41579
  commonParams: {
41572
41580
  /** Your user ID for the user by which you want to filter connected accounts. */
41573
41581
  user_identifier_key?: string | undefined;
41574
- /** Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string. */
41582
+ /** Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. */
41575
41583
  custom_metadata_has?: {
41576
- [x: string]: string | boolean;
41584
+ [x: string]: string | boolean | null;
41577
41585
  } | undefined;
41578
41586
  /** Customer key by which you want to filter connected accounts. */
41579
41587
  customer_key?: string | undefined;
@@ -43501,8 +43509,12 @@ export type Routes = {
43501
43509
  product_type?: (string | undefined) | undefined;
43502
43510
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
43503
43511
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
43504
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
43512
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
43505
43513
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
43514
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
43515
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
43516
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
43517
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
43506
43518
  } | undefined;
43507
43519
  /** Metadata for a KeyNest device. */
43508
43520
  keynest_metadata?: {
@@ -44446,9 +44458,9 @@ export type Routes = {
44446
44458
  created_before?: Date | undefined;
44447
44459
  /** Your own internal user ID for the user for which you want to list devices. */
44448
44460
  user_identifier_key?: string | undefined;
44449
- /** Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string. */
44461
+ /** Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter. */
44450
44462
  custom_metadata_has?: {
44451
- [x: string]: string | boolean;
44463
+ [x: string]: string | boolean | null;
44452
44464
  } | undefined;
44453
44465
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
44454
44466
  page_cursor?: (string | undefined) | null;
@@ -45042,8 +45054,12 @@ export type Routes = {
45042
45054
  product_type?: (string | undefined) | undefined;
45043
45055
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
45044
45056
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
45045
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
45057
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
45046
45058
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
45059
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
45060
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
45061
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
45062
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
45047
45063
  } | undefined;
45048
45064
  /** Metadata for a KeyNest device. */
45049
45065
  keynest_metadata?: {
@@ -56211,8 +56227,12 @@ export type Routes = {
56211
56227
  product_type?: (string | undefined) | undefined;
56212
56228
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
56213
56229
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
56214
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
56230
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
56215
56231
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
56232
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
56233
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
56234
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
56235
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
56216
56236
  } | undefined;
56217
56237
  /** Metadata for a KeyNest device. */
56218
56238
  keynest_metadata?: {
@@ -57702,8 +57722,12 @@ export type Routes = {
57702
57722
  product_type?: (string | undefined) | undefined;
57703
57723
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
57704
57724
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
57705
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
57725
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
57706
57726
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
57727
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
57728
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
57729
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
57730
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
57707
57731
  } | undefined;
57708
57732
  /** Metadata for a KeyNest device. */
57709
57733
  keynest_metadata?: {
@@ -59216,8 +59240,12 @@ export type Routes = {
59216
59240
  product_type?: (string | undefined) | undefined;
59217
59241
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
59218
59242
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
59219
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
59243
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
59220
59244
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
59245
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
59246
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
59247
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
59248
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
59221
59249
  } | undefined;
59222
59250
  /** Metadata for a KeyNest device. */
59223
59251
  keynest_metadata?: {
@@ -60706,8 +60734,12 @@ export type Routes = {
60706
60734
  product_type?: (string | undefined) | undefined;
60707
60735
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
60708
60736
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
60709
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
60737
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
60710
60738
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
60739
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
60740
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
60741
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
60742
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
60711
60743
  } | undefined;
60712
60744
  /** Metadata for a KeyNest device. */
60713
60745
  keynest_metadata?: {
@@ -69410,8 +69442,12 @@ export type Routes = {
69410
69442
  product_type?: (string | undefined) | undefined;
69411
69443
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
69412
69444
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
69413
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
69445
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
69414
69446
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
69447
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
69448
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
69449
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
69450
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
69415
69451
  } | undefined;
69416
69452
  /** Metadata for a KeyNest device. */
69417
69453
  keynest_metadata?: {
@@ -70900,8 +70936,12 @@ export type Routes = {
70900
70936
  product_type?: (string | undefined) | undefined;
70901
70937
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
70902
70938
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
70903
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
70939
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
70904
70940
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
70941
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
70942
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
70943
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
70944
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
70905
70945
  } | undefined;
70906
70946
  /** Metadata for a KeyNest device. */
70907
70947
  keynest_metadata?: {
@@ -87902,8 +87942,12 @@ export type Routes = {
87902
87942
  product_type?: (string | undefined) | undefined;
87903
87943
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
87904
87944
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
87905
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
87945
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
87906
87946
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
87947
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
87948
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
87949
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
87950
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
87907
87951
  } | undefined;
87908
87952
  /** Metadata for a KeyNest device. */
87909
87953
  keynest_metadata?: {
@@ -95805,8 +95849,12 @@ export type Routes = {
95805
95849
  product_type?: (string | undefined) | undefined;
95806
95850
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
95807
95851
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
95808
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
95852
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
95809
95853
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
95854
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
95855
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
95856
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
95857
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
95810
95858
  } | undefined;
95811
95859
  /** Metadata for a KeyNest device. */
95812
95860
  keynest_metadata?: {
@@ -100927,8 +100975,12 @@ export type Routes = {
100927
100975
  product_type?: (string | undefined) | undefined;
100928
100976
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
100929
100977
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
100930
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
100978
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
100931
100979
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
100980
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
100981
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
100982
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
100983
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
100932
100984
  } | undefined;
100933
100985
  /** Metadata for a KeyNest device. */
100934
100986
  keynest_metadata?: {
@@ -102417,8 +102469,12 @@ export type Routes = {
102417
102469
  product_type?: (string | undefined) | undefined;
102418
102470
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
102419
102471
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
102420
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
102472
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
102421
102473
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
102474
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
102475
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
102476
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
102477
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
102422
102478
  } | undefined;
102423
102479
  /** Metadata for a KeyNest device. */
102424
102480
  keynest_metadata?: {
@@ -112105,8 +112161,12 @@ export type Routes = {
112105
112161
  product_type?: (string | undefined) | undefined;
112106
112162
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
112107
112163
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
112108
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
112164
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
112109
112165
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
112166
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
112167
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
112168
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
112169
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
112110
112170
  } | undefined;
112111
112171
  /** Metadata for a KeyNest device. */
112112
112172
  keynest_metadata?: {
@@ -113597,8 +113657,12 @@ export type Routes = {
113597
113657
  product_type?: (string | undefined) | undefined;
113598
113658
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
113599
113659
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
113600
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
113660
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
113601
113661
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
113662
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
113663
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
113664
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
113665
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
113602
113666
  } | undefined;
113603
113667
  /** Metadata for a KeyNest device. */
113604
113668
  keynest_metadata?: {
@@ -116426,8 +116490,12 @@ export type Routes = {
116426
116490
  product_type?: (string | undefined) | undefined;
116427
116491
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
116428
116492
  dual_setpoints_not_supported?: (boolean | undefined) | undefined;
116429
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
116493
+ /** Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written. */
116430
116494
  enforced_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
116495
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
116496
+ enforced_heating_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
116497
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
116498
+ enforced_cooling_setpoint_range_celsius?: ([number, number] | undefined) | undefined;
116431
116499
  } | undefined;
116432
116500
  /** Metadata for a KeyNest device. */
116433
116501
  keynest_metadata?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1017.0",
3
+ "version": "1.1019.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
package/src/lib/seam/connect/models/custom-metadata.ts CHANGED
@@ -31,10 +31,21 @@ export const custom_metadata_input = z
31
31
  'Set of up to 50 key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Accepts string or Boolean values. Strings are limited to 500 characters. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Set a key to `null` or to an empty string to remove that key from the custom metadata.',
32
32
  )
33
33
 
34
+ // A query string can only carry `null` for an unset value — the serializer drops
35
+ // an empty string — so `""` is dropped here rather than given a meaning it could
36
+ // not keep on a GET. It has to be the schema and not a handler: lib/api/pagination.ts
37
+ // serializes req.commonParams for next_page_url and the cursor hash.
34
38
  export const custom_metadata_has = z
35
- .record(custom_metadata_has_key, z.union([z.string(), z.boolean()]))
39
+ .record(custom_metadata_has_key, z.union([z.string(), z.boolean(), z.null()]))
40
+ .transform((custom_metadata_has_filter) =>
41
+ Object.fromEntries(
42
+ Object.entries(custom_metadata_has_filter).filter(
43
+ ([, metadata_value]) => metadata_value !== '',
44
+ ),
45
+ ),
46
+ )
36
47
  .describe(
37
- 'Set of key:value pairs by which to filter. Key names cannot contain a period (.). Accepts string or Boolean values. Specify an empty string to match a key that is unset or set to an empty string.',
48
+ 'Set of key:value pairs by which to filter. Key names cannot contain a period (.). Accepts string or Boolean values, or `null` to match a key that is unset. A key given an empty string is omitted from the filter.',
38
49
  )
39
50
 
40
51
  export const custom_metadata = z
@@ -46,3 +57,5 @@ export const custom_metadata = z
46
57
  export type CustomMetadata = z.output<typeof custom_metadata>
47
58
 
48
59
  export type CustomMetadataInput = z.input<typeof custom_metadata_input>
60
+
61
+ export type CustomMetadataHas = z.output<typeof custom_metadata_has>
package/src/lib/seam/connect/models/devices/device-metadata.ts CHANGED
@@ -975,7 +975,19 @@ export const device_metadata = z
975
975
  .tuple([z.number(), z.number()])
976
976
  .optional()
977
977
  .describe(
978
- `Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.`,
978
+ `Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written.`,
979
+ ),
980
+ enforced_heating_setpoint_range_celsius: z
981
+ .tuple([z.number(), z.number()])
982
+ .optional()
983
+ .describe(
984
+ `Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.`,
985
+ ),
986
+ enforced_cooling_setpoint_range_celsius: z
987
+ .tuple([z.number(), z.number()])
988
+ .optional()
989
+ .describe(
990
+ `Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.`,
979
991
  ),
980
992
  })
981
993
  .partial()
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -15462,9 +15462,25 @@ const openapi: OpenAPISpec = {
15462
15462
  'Set to true when the device does not support the /dual-setpoints API endpoint.',
15463
15463
  type: 'boolean',
15464
15464
  },
15465
+ enforced_cooling_setpoint_range_celsius: {
15466
+ description:
15467
+ 'Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.',
15468
+ items: { format: 'float', type: 'number' },
15469
+ maxItems: 2,
15470
+ minItems: 2,
15471
+ type: 'array',
15472
+ },
15473
+ enforced_heating_setpoint_range_celsius: {
15474
+ description:
15475
+ 'Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.',
15476
+ items: { format: 'float', type: 'number' },
15477
+ maxItems: 2,
15478
+ minItems: 2,
15479
+ type: 'array',
15480
+ },
15465
15481
  enforced_setpoint_range_celsius: {
15466
15482
  description:
15467
- 'Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.',
15483
+ 'Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written.',
15468
15484
  items: { format: 'float', type: 'number' },
15469
15485
  maxItems: 2,
15470
15486
  minItems: 2,
@@ -51228,10 +51244,11 @@ const openapi: OpenAPISpec = {
51228
51244
  name: 'custom_metadata_has',
51229
51245
  schema: {
51230
51246
  additionalProperties: {
51247
+ nullable: true,
51231
51248
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
51232
51249
  },
51233
51250
  description:
51234
- 'Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.',
51251
+ 'Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.',
51235
51252
  type: 'object',
51236
51253
  },
51237
51254
  },
@@ -51317,10 +51334,11 @@ const openapi: OpenAPISpec = {
51317
51334
  properties: {
51318
51335
  custom_metadata_has: {
51319
51336
  additionalProperties: {
51337
+ nullable: true,
51320
51338
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
51321
51339
  },
51322
51340
  description:
51323
- 'Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.',
51341
+ 'Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.',
51324
51342
  type: 'object',
51325
51343
  },
51326
51344
  customer_key: {
@@ -51656,10 +51674,11 @@ const openapi: OpenAPISpec = {
51656
51674
  name: 'custom_metadata_has',
51657
51675
  schema: {
51658
51676
  additionalProperties: {
51677
+ nullable: true,
51659
51678
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
51660
51679
  },
51661
51680
  description:
51662
- 'Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.',
51681
+ 'Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.',
51663
51682
  type: 'object',
51664
51683
  },
51665
51684
  },
@@ -51765,10 +51784,11 @@ const openapi: OpenAPISpec = {
51765
51784
  properties: {
51766
51785
  custom_metadata_has: {
51767
51786
  additionalProperties: {
51787
+ nullable: true,
51768
51788
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
51769
51789
  },
51770
51790
  description:
51771
- 'Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.',
51791
+ 'Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.',
51772
51792
  type: 'object',
51773
51793
  },
51774
51794
  customer_key: {
@@ -55482,10 +55502,11 @@ const openapi: OpenAPISpec = {
55482
55502
  name: 'custom_metadata_has',
55483
55503
  schema: {
55484
55504
  additionalProperties: {
55505
+ nullable: true,
55485
55506
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
55486
55507
  },
55487
55508
  description:
55488
- 'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.',
55509
+ 'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.',
55489
55510
  type: 'object',
55490
55511
  },
55491
55512
  },
@@ -55672,10 +55693,11 @@ const openapi: OpenAPISpec = {
55672
55693
  },
55673
55694
  custom_metadata_has: {
55674
55695
  additionalProperties: {
55696
+ nullable: true,
55675
55697
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
55676
55698
  },
55677
55699
  description:
55678
- 'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.',
55700
+ 'Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.',
55679
55701
  type: 'object',
55680
55702
  },
55681
55703
  customer_key: {