@seamapi/types 1.344.0 → 1.344.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.
@@ -37700,6 +37700,7 @@ declare const _default: {
37700
37700
  };
37701
37701
  '/thermostats/simulate/hvac_mode_adjusted': {
37702
37702
  post: {
37703
+ description: string;
37703
37704
  operationId: string;
37704
37705
  requestBody: {
37705
37706
  content: {
@@ -37711,10 +37712,12 @@ declare const _default: {
37711
37712
  oneOf: ({
37712
37713
  properties: {
37713
37714
  device_id: {
37715
+ description: string;
37714
37716
  format: string;
37715
37717
  type: string;
37716
37718
  };
37717
37719
  hvac_mode: {
37720
+ description: string;
37718
37721
  enum: string[];
37719
37722
  type: string;
37720
37723
  };
@@ -37728,18 +37731,22 @@ declare const _default: {
37728
37731
  } | {
37729
37732
  properties: {
37730
37733
  cooling_set_point_celsius: {
37734
+ description: string;
37731
37735
  format: string;
37732
37736
  type: string;
37733
37737
  };
37734
37738
  cooling_set_point_fahrenheit: {
37739
+ description: string;
37735
37740
  format: string;
37736
37741
  type: string;
37737
37742
  };
37738
37743
  device_id: {
37744
+ description: string;
37739
37745
  format: string;
37740
37746
  type: string;
37741
37747
  };
37742
37748
  hvac_mode: {
37749
+ description: string;
37743
37750
  enum: string[];
37744
37751
  type: string;
37745
37752
  };
@@ -37751,18 +37758,22 @@ declare const _default: {
37751
37758
  } | {
37752
37759
  properties: {
37753
37760
  device_id: {
37761
+ description: string;
37754
37762
  format: string;
37755
37763
  type: string;
37756
37764
  };
37757
37765
  heating_set_point_celsius: {
37766
+ description: string;
37758
37767
  format: string;
37759
37768
  type: string;
37760
37769
  };
37761
37770
  heating_set_point_fahrenheit: {
37771
+ description: string;
37762
37772
  format: string;
37763
37773
  type: string;
37764
37774
  };
37765
37775
  hvac_mode: {
37776
+ description: string;
37766
37777
  enum: string[];
37767
37778
  type: string;
37768
37779
  };
@@ -37774,26 +37785,32 @@ declare const _default: {
37774
37785
  } | {
37775
37786
  properties: {
37776
37787
  cooling_set_point_celsius: {
37788
+ description: string;
37777
37789
  format: string;
37778
37790
  type: string;
37779
37791
  };
37780
37792
  cooling_set_point_fahrenheit: {
37793
+ description: string;
37781
37794
  format: string;
37782
37795
  type: string;
37783
37796
  };
37784
37797
  device_id: {
37798
+ description: string;
37785
37799
  format: string;
37786
37800
  type: string;
37787
37801
  };
37788
37802
  heating_set_point_celsius: {
37803
+ description: string;
37789
37804
  format: string;
37790
37805
  type: string;
37791
37806
  };
37792
37807
  heating_set_point_fahrenheit: {
37808
+ description: string;
37793
37809
  format: string;
37794
37810
  type: string;
37795
37811
  };
37796
37812
  hvac_mode: {
37813
+ description: string;
37797
37814
  enum: string[];
37798
37815
  type: string;
37799
37816
  };
@@ -37847,10 +37864,12 @@ declare const _default: {
37847
37864
  'x-fern-sdk-group-name': string[];
37848
37865
  'x-fern-sdk-method-name': string;
37849
37866
  'x-response-key': null;
37867
+ 'x-title': string;
37850
37868
  };
37851
37869
  };
37852
37870
  '/thermostats/simulate/temperature_reached': {
37853
37871
  post: {
37872
+ description: string;
37854
37873
  operationId: string;
37855
37874
  requestBody: {
37856
37875
  content: {
@@ -37858,14 +37877,17 @@ declare const _default: {
37858
37877
  schema: {
37859
37878
  properties: {
37860
37879
  device_id: {
37880
+ description: string;
37861
37881
  format: string;
37862
37882
  type: string;
37863
37883
  };
37864
37884
  temperature_celsius: {
37885
+ description: string;
37865
37886
  format: string;
37866
37887
  type: string;
37867
37888
  };
37868
37889
  temperature_fahrenheit: {
37890
+ description: string;
37869
37891
  format: string;
37870
37892
  type: string;
37871
37893
  };
@@ -37918,6 +37940,7 @@ declare const _default: {
37918
37940
  'x-fern-sdk-group-name': string[];
37919
37941
  'x-fern-sdk-method-name': string;
37920
37942
  'x-response-key': null;
37943
+ 'x-title': string;
37921
37944
  };
37922
37945
  };
37923
37946
  '/thermostats/update_climate_preset': {
@@ -75194,24 +75217,40 @@ interface Routes {
75194
75217
  method: 'POST';
75195
75218
  queryParams: {};
75196
75219
  jsonBody: {
75220
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
75197
75221
  hvac_mode: 'off';
75222
+ /** ID of the desired thermostat device. */
75198
75223
  device_id: string;
75199
75224
  } | {
75225
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
75200
75226
  hvac_mode: 'cool';
75227
+ /** ID of the desired thermostat device. */
75201
75228
  device_id: string;
75229
+ /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
75202
75230
  cooling_set_point_celsius?: number | undefined;
75231
+ /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
75203
75232
  cooling_set_point_fahrenheit?: number | undefined;
75204
75233
  } | {
75234
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
75205
75235
  hvac_mode: 'heat';
75236
+ /** ID of the desired thermostat device. */
75206
75237
  device_id: string;
75238
+ /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
75207
75239
  heating_set_point_celsius?: number | undefined;
75240
+ /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
75208
75241
  heating_set_point_fahrenheit?: number | undefined;
75209
75242
  } | {
75243
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
75210
75244
  hvac_mode: 'heat_cool';
75245
+ /** ID of the desired thermostat device. */
75211
75246
  device_id: string;
75247
+ /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
75212
75248
  cooling_set_point_celsius?: number | undefined;
75249
+ /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
75213
75250
  cooling_set_point_fahrenheit?: number | undefined;
75251
+ /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
75214
75252
  heating_set_point_celsius?: number | undefined;
75253
+ /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
75215
75254
  heating_set_point_fahrenheit?: number | undefined;
75216
75255
  };
75217
75256
  commonParams: {};
@@ -75223,8 +75262,11 @@ interface Routes {
75223
75262
  method: 'POST';
75224
75263
  queryParams: {};
75225
75264
  jsonBody: {
75265
+ /** ID of the desired thermostat device. */
75226
75266
  device_id: string;
75267
+ /** Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. */
75227
75268
  temperature_celsius?: number | undefined;
75269
+ /** Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. */
75228
75270
  temperature_fahrenheit?: number | undefined;
75229
75271
  };
75230
75272
  commonParams: {};
@@ -21060,6 +21060,7 @@ declare const _default: {
21060
21060
  };
21061
21061
  '/thermostats/simulate/hvac_mode_adjusted': {
21062
21062
  post: {
21063
+ description: string;
21063
21064
  operationId: string;
21064
21065
  requestBody: {
21065
21066
  content: {
@@ -21071,10 +21072,12 @@ declare const _default: {
21071
21072
  oneOf: ({
21072
21073
  properties: {
21073
21074
  device_id: {
21075
+ description: string;
21074
21076
  format: string;
21075
21077
  type: string;
21076
21078
  };
21077
21079
  hvac_mode: {
21080
+ description: string;
21078
21081
  enum: string[];
21079
21082
  type: string;
21080
21083
  };
@@ -21088,18 +21091,22 @@ declare const _default: {
21088
21091
  } | {
21089
21092
  properties: {
21090
21093
  cooling_set_point_celsius: {
21094
+ description: string;
21091
21095
  format: string;
21092
21096
  type: string;
21093
21097
  };
21094
21098
  cooling_set_point_fahrenheit: {
21099
+ description: string;
21095
21100
  format: string;
21096
21101
  type: string;
21097
21102
  };
21098
21103
  device_id: {
21104
+ description: string;
21099
21105
  format: string;
21100
21106
  type: string;
21101
21107
  };
21102
21108
  hvac_mode: {
21109
+ description: string;
21103
21110
  enum: string[];
21104
21111
  type: string;
21105
21112
  };
@@ -21111,18 +21118,22 @@ declare const _default: {
21111
21118
  } | {
21112
21119
  properties: {
21113
21120
  device_id: {
21121
+ description: string;
21114
21122
  format: string;
21115
21123
  type: string;
21116
21124
  };
21117
21125
  heating_set_point_celsius: {
21126
+ description: string;
21118
21127
  format: string;
21119
21128
  type: string;
21120
21129
  };
21121
21130
  heating_set_point_fahrenheit: {
21131
+ description: string;
21122
21132
  format: string;
21123
21133
  type: string;
21124
21134
  };
21125
21135
  hvac_mode: {
21136
+ description: string;
21126
21137
  enum: string[];
21127
21138
  type: string;
21128
21139
  };
@@ -21134,26 +21145,32 @@ declare const _default: {
21134
21145
  } | {
21135
21146
  properties: {
21136
21147
  cooling_set_point_celsius: {
21148
+ description: string;
21137
21149
  format: string;
21138
21150
  type: string;
21139
21151
  };
21140
21152
  cooling_set_point_fahrenheit: {
21153
+ description: string;
21141
21154
  format: string;
21142
21155
  type: string;
21143
21156
  };
21144
21157
  device_id: {
21158
+ description: string;
21145
21159
  format: string;
21146
21160
  type: string;
21147
21161
  };
21148
21162
  heating_set_point_celsius: {
21163
+ description: string;
21149
21164
  format: string;
21150
21165
  type: string;
21151
21166
  };
21152
21167
  heating_set_point_fahrenheit: {
21168
+ description: string;
21153
21169
  format: string;
21154
21170
  type: string;
21155
21171
  };
21156
21172
  hvac_mode: {
21173
+ description: string;
21157
21174
  enum: string[];
21158
21175
  type: string;
21159
21176
  };
@@ -21207,10 +21224,12 @@ declare const _default: {
21207
21224
  'x-fern-sdk-group-name': string[];
21208
21225
  'x-fern-sdk-method-name': string;
21209
21226
  'x-response-key': null;
21227
+ 'x-title': string;
21210
21228
  };
21211
21229
  };
21212
21230
  '/thermostats/simulate/temperature_reached': {
21213
21231
  post: {
21232
+ description: string;
21214
21233
  operationId: string;
21215
21234
  requestBody: {
21216
21235
  content: {
@@ -21218,14 +21237,17 @@ declare const _default: {
21218
21237
  schema: {
21219
21238
  properties: {
21220
21239
  device_id: {
21240
+ description: string;
21221
21241
  format: string;
21222
21242
  type: string;
21223
21243
  };
21224
21244
  temperature_celsius: {
21245
+ description: string;
21225
21246
  format: string;
21226
21247
  type: string;
21227
21248
  };
21228
21249
  temperature_fahrenheit: {
21250
+ description: string;
21229
21251
  format: string;
21230
21252
  type: string;
21231
21253
  };
@@ -21278,6 +21300,7 @@ declare const _default: {
21278
21300
  'x-fern-sdk-group-name': string[];
21279
21301
  'x-fern-sdk-method-name': string;
21280
21302
  'x-response-key': null;
21303
+ 'x-title': string;
21281
21304
  };
21282
21305
  };
21283
21306
  '/thermostats/update_climate_preset': {
@@ -24376,6 +24376,7 @@ export default {
24376
24376
  },
24377
24377
  '/thermostats/simulate/hvac_mode_adjusted': {
24378
24378
  post: {
24379
+ description: 'Simulates having adjusted the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/latest/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).',
24379
24380
  operationId: 'thermostatsSimulateHvacModeAdjustedPost',
24380
24381
  requestBody: {
24381
24382
  content: {
@@ -24385,8 +24386,16 @@ export default {
24385
24386
  oneOf: [
24386
24387
  {
24387
24388
  properties: {
24388
- device_id: { format: 'uuid', type: 'string' },
24389
- hvac_mode: { enum: ['off'], type: 'string' },
24389
+ device_id: {
24390
+ description: 'ID of the desired thermostat device.',
24391
+ format: 'uuid',
24392
+ type: 'string',
24393
+ },
24394
+ hvac_mode: {
24395
+ description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
24396
+ enum: ['off'],
24397
+ type: 'string',
24398
+ },
24390
24399
  },
24391
24400
  required: ['hvac_mode', 'device_id'],
24392
24401
  type: 'object',
@@ -24394,31 +24403,51 @@ export default {
24394
24403
  {
24395
24404
  properties: {
24396
24405
  cooling_set_point_celsius: {
24406
+ description: 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.',
24397
24407
  format: 'float',
24398
24408
  type: 'number',
24399
24409
  },
24400
24410
  cooling_set_point_fahrenheit: {
24411
+ description: 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.',
24401
24412
  format: 'float',
24402
24413
  type: 'number',
24403
24414
  },
24404
- device_id: { format: 'uuid', type: 'string' },
24405
- hvac_mode: { enum: ['cool'], type: 'string' },
24415
+ device_id: {
24416
+ description: 'ID of the desired thermostat device.',
24417
+ format: 'uuid',
24418
+ type: 'string',
24419
+ },
24420
+ hvac_mode: {
24421
+ description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
24422
+ enum: ['cool'],
24423
+ type: 'string',
24424
+ },
24406
24425
  },
24407
24426
  required: ['hvac_mode', 'device_id'],
24408
24427
  type: 'object',
24409
24428
  },
24410
24429
  {
24411
24430
  properties: {
24412
- device_id: { format: 'uuid', type: 'string' },
24431
+ device_id: {
24432
+ description: 'ID of the desired thermostat device.',
24433
+ format: 'uuid',
24434
+ type: 'string',
24435
+ },
24413
24436
  heating_set_point_celsius: {
24437
+ description: 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.',
24414
24438
  format: 'float',
24415
24439
  type: 'number',
24416
24440
  },
24417
24441
  heating_set_point_fahrenheit: {
24442
+ description: 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.',
24418
24443
  format: 'float',
24419
24444
  type: 'number',
24420
24445
  },
24421
- hvac_mode: { enum: ['heat'], type: 'string' },
24446
+ hvac_mode: {
24447
+ description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
24448
+ enum: ['heat'],
24449
+ type: 'string',
24450
+ },
24422
24451
  },
24423
24452
  required: ['hvac_mode', 'device_id'],
24424
24453
  type: 'object',
@@ -24426,23 +24455,35 @@ export default {
24426
24455
  {
24427
24456
  properties: {
24428
24457
  cooling_set_point_celsius: {
24458
+ description: 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.',
24429
24459
  format: 'float',
24430
24460
  type: 'number',
24431
24461
  },
24432
24462
  cooling_set_point_fahrenheit: {
24463
+ description: 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.',
24433
24464
  format: 'float',
24434
24465
  type: 'number',
24435
24466
  },
24436
- device_id: { format: 'uuid', type: 'string' },
24467
+ device_id: {
24468
+ description: 'ID of the desired thermostat device.',
24469
+ format: 'uuid',
24470
+ type: 'string',
24471
+ },
24437
24472
  heating_set_point_celsius: {
24473
+ description: 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.',
24438
24474
  format: 'float',
24439
24475
  type: 'number',
24440
24476
  },
24441
24477
  heating_set_point_fahrenheit: {
24478
+ description: 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.',
24442
24479
  format: 'float',
24443
24480
  type: 'number',
24444
24481
  },
24445
- hvac_mode: { enum: ['heat_cool'], type: 'string' },
24482
+ hvac_mode: {
24483
+ description: 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
24484
+ enum: ['heat_cool'],
24485
+ type: 'string',
24486
+ },
24446
24487
  },
24447
24488
  required: ['hvac_mode', 'device_id'],
24448
24489
  type: 'object',
@@ -24478,19 +24519,33 @@ export default {
24478
24519
  'x-fern-sdk-group-name': ['thermostats', 'simulate'],
24479
24520
  'x-fern-sdk-method-name': 'hvac_mode_adjusted',
24480
24521
  'x-response-key': null,
24522
+ 'x-title': 'HVAC Mode Adjusted',
24481
24523
  },
24482
24524
  },
24483
24525
  '/thermostats/simulate/temperature_reached': {
24484
24526
  post: {
24527
+ description: 'Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/latest/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).',
24485
24528
  operationId: 'thermostatsSimulateTemperatureReachedPost',
24486
24529
  requestBody: {
24487
24530
  content: {
24488
24531
  'application/json': {
24489
24532
  schema: {
24490
24533
  properties: {
24491
- device_id: { format: 'uuid', type: 'string' },
24492
- temperature_celsius: { format: 'float', type: 'number' },
24493
- temperature_fahrenheit: { format: 'float', type: 'number' },
24534
+ device_id: {
24535
+ description: 'ID of the desired thermostat device.',
24536
+ format: 'uuid',
24537
+ type: 'string',
24538
+ },
24539
+ temperature_celsius: {
24540
+ description: 'Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`.',
24541
+ format: 'float',
24542
+ type: 'number',
24543
+ },
24544
+ temperature_fahrenheit: {
24545
+ description: 'Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`.',
24546
+ format: 'float',
24547
+ type: 'number',
24548
+ },
24494
24549
  },
24495
24550
  required: ['device_id'],
24496
24551
  type: 'object',
@@ -24524,6 +24579,7 @@ export default {
24524
24579
  'x-fern-sdk-group-name': ['thermostats', 'simulate'],
24525
24580
  'x-fern-sdk-method-name': 'temperature_reached',
24526
24581
  'x-response-key': null,
24582
+ 'x-title': 'Temperature Reached',
24527
24583
  },
24528
24584
  },
24529
24585
  '/thermostats/update_climate_preset': {