@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.
@@ -14505,9 +14505,15 @@ export type Routes = {
14505
14505
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
14506
14506
  dual_setpoints_not_supported?:
14507
14507
  (boolean | undefined) | undefined
14508
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
14508
+ /** 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. */
14509
14509
  enforced_setpoint_range_celsius?:
14510
14510
  ([number, number] | undefined) | undefined
14511
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
14512
+ enforced_heating_setpoint_range_celsius?:
14513
+ ([number, number] | undefined) | undefined
14514
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
14515
+ enforced_cooling_setpoint_range_celsius?:
14516
+ ([number, number] | undefined) | undefined
14511
14517
  }
14512
14518
  | undefined
14513
14519
  /** Metadata for a KeyNest device. */
@@ -22917,9 +22923,15 @@ export type Routes = {
22917
22923
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
22918
22924
  dual_setpoints_not_supported?:
22919
22925
  (boolean | undefined) | undefined
22920
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
22926
+ /** 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. */
22921
22927
  enforced_setpoint_range_celsius?:
22922
22928
  ([number, number] | undefined) | undefined
22929
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
22930
+ enforced_heating_setpoint_range_celsius?:
22931
+ ([number, number] | undefined) | undefined
22932
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
22933
+ enforced_cooling_setpoint_range_celsius?:
22934
+ ([number, number] | undefined) | undefined
22923
22935
  }
22924
22936
  | undefined
22925
22937
  /** Metadata for a KeyNest device. */
@@ -48403,10 +48415,10 @@ export type Routes = {
48403
48415
  customer_key?: string | undefined
48404
48416
  /** Your user ID for the user by which you want to filter Connect Webviews. */
48405
48417
  user_identifier_key?: string | undefined
48406
- /** 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. */
48418
+ /** 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. */
48407
48419
  custom_metadata_has?:
48408
48420
  | {
48409
- [x: string]: string | boolean
48421
+ [x: string]: string | boolean | null
48410
48422
  }
48411
48423
  | undefined
48412
48424
  /** 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`. */
@@ -48735,10 +48747,10 @@ export type Routes = {
48735
48747
  commonParams: {
48736
48748
  /** Your user ID for the user by which you want to filter connected accounts. */
48737
48749
  user_identifier_key?: string | undefined
48738
- /** 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. */
48750
+ /** 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. */
48739
48751
  custom_metadata_has?:
48740
48752
  | {
48741
- [x: string]: string | boolean
48753
+ [x: string]: string | boolean | null
48742
48754
  }
48743
48755
  | undefined
48744
48756
  /** Customer key by which you want to filter connected accounts. */
@@ -51045,9 +51057,15 @@ export type Routes = {
51045
51057
  product_type?: (string | undefined) | undefined
51046
51058
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
51047
51059
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
51048
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
51060
+ /** 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. */
51049
51061
  enforced_setpoint_range_celsius?:
51050
51062
  ([number, number] | undefined) | undefined
51063
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
51064
+ enforced_heating_setpoint_range_celsius?:
51065
+ ([number, number] | undefined) | undefined
51066
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
51067
+ enforced_cooling_setpoint_range_celsius?:
51068
+ ([number, number] | undefined) | undefined
51051
51069
  }
51052
51070
  | undefined
51053
51071
  /** Metadata for a KeyNest device. */
@@ -52345,10 +52363,10 @@ export type Routes = {
52345
52363
  created_before?: Date | undefined
52346
52364
  /** Your own internal user ID for the user for which you want to list devices. */
52347
52365
  user_identifier_key?: string | undefined
52348
- /** 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. */
52366
+ /** 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. */
52349
52367
  custom_metadata_has?:
52350
52368
  | {
52351
- [x: string]: string | boolean
52369
+ [x: string]: string | boolean | null
52352
52370
  }
52353
52371
  | undefined
52354
52372
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
@@ -53156,9 +53174,15 @@ export type Routes = {
53156
53174
  product_type?: (string | undefined) | undefined
53157
53175
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
53158
53176
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
53159
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
53177
+ /** 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. */
53160
53178
  enforced_setpoint_range_celsius?:
53161
53179
  ([number, number] | undefined) | undefined
53180
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
53181
+ enforced_heating_setpoint_range_celsius?:
53182
+ ([number, number] | undefined) | undefined
53183
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
53184
+ enforced_cooling_setpoint_range_celsius?:
53185
+ ([number, number] | undefined) | undefined
53162
53186
  }
53163
53187
  | undefined
53164
53188
  /** Metadata for a KeyNest device. */
@@ -67812,9 +67836,15 @@ export type Routes = {
67812
67836
  product_type?: (string | undefined) | undefined
67813
67837
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
67814
67838
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
67815
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
67839
+ /** 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. */
67816
67840
  enforced_setpoint_range_celsius?:
67817
67841
  ([number, number] | undefined) | undefined
67842
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
67843
+ enforced_heating_setpoint_range_celsius?:
67844
+ ([number, number] | undefined) | undefined
67845
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
67846
+ enforced_cooling_setpoint_range_celsius?:
67847
+ ([number, number] | undefined) | undefined
67818
67848
  }
67819
67849
  | undefined
67820
67850
  /** Metadata for a KeyNest device. */
@@ -69674,9 +69704,15 @@ export type Routes = {
69674
69704
  product_type?: (string | undefined) | undefined
69675
69705
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
69676
69706
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
69677
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
69707
+ /** 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. */
69678
69708
  enforced_setpoint_range_celsius?:
69679
69709
  ([number, number] | undefined) | undefined
69710
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
69711
+ enforced_heating_setpoint_range_celsius?:
69712
+ ([number, number] | undefined) | undefined
69713
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
69714
+ enforced_cooling_setpoint_range_celsius?:
69715
+ ([number, number] | undefined) | undefined
69680
69716
  }
69681
69717
  | undefined
69682
69718
  /** Metadata for a KeyNest device. */
@@ -71663,9 +71699,15 @@ export type Routes = {
71663
71699
  product_type?: (string | undefined) | undefined
71664
71700
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
71665
71701
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
71666
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
71702
+ /** 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. */
71667
71703
  enforced_setpoint_range_celsius?:
71668
71704
  ([number, number] | undefined) | undefined
71705
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
71706
+ enforced_heating_setpoint_range_celsius?:
71707
+ ([number, number] | undefined) | undefined
71708
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
71709
+ enforced_cooling_setpoint_range_celsius?:
71710
+ ([number, number] | undefined) | undefined
71669
71711
  }
71670
71712
  | undefined
71671
71713
  /** Metadata for a KeyNest device. */
@@ -73524,9 +73566,15 @@ export type Routes = {
73524
73566
  product_type?: (string | undefined) | undefined
73525
73567
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
73526
73568
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
73527
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
73569
+ /** 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. */
73528
73570
  enforced_setpoint_range_celsius?:
73529
73571
  ([number, number] | undefined) | undefined
73572
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
73573
+ enforced_heating_setpoint_range_celsius?:
73574
+ ([number, number] | undefined) | undefined
73575
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
73576
+ enforced_cooling_setpoint_range_celsius?:
73577
+ ([number, number] | undefined) | undefined
73530
73578
  }
73531
73579
  | undefined
73532
73580
  /** Metadata for a KeyNest device. */
@@ -83815,9 +83863,15 @@ export type Routes = {
83815
83863
  product_type?: (string | undefined) | undefined
83816
83864
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
83817
83865
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
83818
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
83866
+ /** 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. */
83819
83867
  enforced_setpoint_range_celsius?:
83820
83868
  ([number, number] | undefined) | undefined
83869
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
83870
+ enforced_heating_setpoint_range_celsius?:
83871
+ ([number, number] | undefined) | undefined
83872
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
83873
+ enforced_cooling_setpoint_range_celsius?:
83874
+ ([number, number] | undefined) | undefined
83821
83875
  }
83822
83876
  | undefined
83823
83877
  /** Metadata for a KeyNest device. */
@@ -85676,9 +85730,15 @@ export type Routes = {
85676
85730
  product_type?: (string | undefined) | undefined
85677
85731
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
85678
85732
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
85679
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
85733
+ /** 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. */
85680
85734
  enforced_setpoint_range_celsius?:
85681
85735
  ([number, number] | undefined) | undefined
85736
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
85737
+ enforced_heating_setpoint_range_celsius?:
85738
+ ([number, number] | undefined) | undefined
85739
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
85740
+ enforced_cooling_setpoint_range_celsius?:
85741
+ ([number, number] | undefined) | undefined
85682
85742
  }
85683
85743
  | undefined
85684
85744
  /** Metadata for a KeyNest device. */
@@ -105565,9 +105625,15 @@ export type Routes = {
105565
105625
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
105566
105626
  dual_setpoints_not_supported?:
105567
105627
  (boolean | undefined) | undefined
105568
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
105628
+ /** 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. */
105569
105629
  enforced_setpoint_range_celsius?:
105570
105630
  ([number, number] | undefined) | undefined
105631
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
105632
+ enforced_heating_setpoint_range_celsius?:
105633
+ ([number, number] | undefined) | undefined
105634
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
105635
+ enforced_cooling_setpoint_range_celsius?:
105636
+ ([number, number] | undefined) | undefined
105571
105637
  }
105572
105638
  | undefined
105573
105639
  /** Metadata for a KeyNest device. */
@@ -114975,9 +115041,15 @@ export type Routes = {
114975
115041
  product_type?: (string | undefined) | undefined
114976
115042
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
114977
115043
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
114978
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
115044
+ /** 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. */
114979
115045
  enforced_setpoint_range_celsius?:
114980
115046
  ([number, number] | undefined) | undefined
115047
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
115048
+ enforced_heating_setpoint_range_celsius?:
115049
+ ([number, number] | undefined) | undefined
115050
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
115051
+ enforced_cooling_setpoint_range_celsius?:
115052
+ ([number, number] | undefined) | undefined
114981
115053
  }
114982
115054
  | undefined
114983
115055
  /** Metadata for a KeyNest device. */
@@ -121103,9 +121175,15 @@ export type Routes = {
121103
121175
  product_type?: (string | undefined) | undefined
121104
121176
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
121105
121177
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
121106
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
121178
+ /** 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. */
121107
121179
  enforced_setpoint_range_celsius?:
121108
121180
  ([number, number] | undefined) | undefined
121181
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
121182
+ enforced_heating_setpoint_range_celsius?:
121183
+ ([number, number] | undefined) | undefined
121184
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
121185
+ enforced_cooling_setpoint_range_celsius?:
121186
+ ([number, number] | undefined) | undefined
121109
121187
  }
121110
121188
  | undefined
121111
121189
  /** Metadata for a KeyNest device. */
@@ -122964,9 +123042,15 @@ export type Routes = {
122964
123042
  product_type?: (string | undefined) | undefined
122965
123043
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
122966
123044
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
122967
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
123045
+ /** 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. */
122968
123046
  enforced_setpoint_range_celsius?:
122969
123047
  ([number, number] | undefined) | undefined
123048
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
123049
+ enforced_heating_setpoint_range_celsius?:
123050
+ ([number, number] | undefined) | undefined
123051
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
123052
+ enforced_cooling_setpoint_range_celsius?:
123053
+ ([number, number] | undefined) | undefined
122970
123054
  }
122971
123055
  | undefined
122972
123056
  /** Metadata for a KeyNest device. */
@@ -134279,9 +134363,15 @@ export type Routes = {
134279
134363
  product_type?: (string | undefined) | undefined
134280
134364
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
134281
134365
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
134282
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
134366
+ /** 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. */
134283
134367
  enforced_setpoint_range_celsius?:
134284
134368
  ([number, number] | undefined) | undefined
134369
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
134370
+ enforced_heating_setpoint_range_celsius?:
134371
+ ([number, number] | undefined) | undefined
134372
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
134373
+ enforced_cooling_setpoint_range_celsius?:
134374
+ ([number, number] | undefined) | undefined
134285
134375
  }
134286
134376
  | undefined
134287
134377
  /** Metadata for a KeyNest device. */
@@ -136142,9 +136232,15 @@ export type Routes = {
136142
136232
  product_type?: (string | undefined) | undefined
136143
136233
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
136144
136234
  dual_setpoints_not_supported?: (boolean | undefined) | undefined
136145
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
136235
+ /** 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. */
136146
136236
  enforced_setpoint_range_celsius?:
136147
136237
  ([number, number] | undefined) | undefined
136238
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
136239
+ enforced_heating_setpoint_range_celsius?:
136240
+ ([number, number] | undefined) | undefined
136241
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
136242
+ enforced_cooling_setpoint_range_celsius?:
136243
+ ([number, number] | undefined) | undefined
136148
136244
  }
136149
136245
  | undefined
136150
136246
  /** Metadata for a KeyNest device. */
@@ -139559,9 +139655,15 @@ export type Routes = {
139559
139655
  /** Set to true when the device does not support the /dual-setpoints API endpoint. */
139560
139656
  dual_setpoints_not_supported?:
139561
139657
  (boolean | undefined) | undefined
139562
- /** Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
139658
+ /** 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. */
139563
139659
  enforced_setpoint_range_celsius?:
139564
139660
  ([number, number] | undefined) | undefined
139661
+ /** Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
139662
+ enforced_heating_setpoint_range_celsius?:
139663
+ ([number, number] | undefined) | undefined
139664
+ /** Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. */
139665
+ enforced_cooling_setpoint_range_celsius?:
139666
+ ([number, number] | undefined) | undefined
139565
139667
  }
139566
139668
  | undefined
139567
139669
  /** Metadata for a KeyNest device. */