@seamapi/types 1.288.1 → 1.289.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.
@@ -15932,6 +15932,7 @@ declare const _default: {
15932
15932
  };
15933
15933
  '/thermostats/cool': {
15934
15934
  post: {
15935
+ description: string;
15935
15936
  operationId: string;
15936
15937
  requestBody: {
15937
15938
  content: {
@@ -15939,14 +15940,17 @@ declare const _default: {
15939
15940
  schema: {
15940
15941
  properties: {
15941
15942
  cooling_set_point_celsius: {
15943
+ description: string;
15942
15944
  format: string;
15943
15945
  type: string;
15944
15946
  };
15945
15947
  cooling_set_point_fahrenheit: {
15948
+ description: string;
15946
15949
  format: string;
15947
15950
  type: string;
15948
15951
  };
15949
15952
  device_id: {
15953
+ description: string;
15950
15954
  format: string;
15951
15955
  type: string;
15952
15956
  };
@@ -16015,6 +16019,7 @@ declare const _default: {
16015
16019
  'x-fern-sdk-method-name': string;
16016
16020
  'x-fern-sdk-return-value': string;
16017
16021
  'x-response-key': string;
16022
+ 'x-title': string;
16018
16023
  };
16019
16024
  };
16020
16025
  '/thermostats/create_climate_preset': {
@@ -16183,6 +16188,7 @@ declare const _default: {
16183
16188
  };
16184
16189
  '/thermostats/get': {
16185
16190
  post: {
16191
+ description: string;
16186
16192
  operationId: string;
16187
16193
  requestBody: {
16188
16194
  content: {
@@ -16190,10 +16196,12 @@ declare const _default: {
16190
16196
  schema: {
16191
16197
  properties: {
16192
16198
  device_id: {
16199
+ description: string;
16193
16200
  format: string;
16194
16201
  type: string;
16195
16202
  };
16196
16203
  name: {
16204
+ description: string;
16197
16205
  type: string;
16198
16206
  };
16199
16207
  };
@@ -16257,10 +16265,12 @@ declare const _default: {
16257
16265
  'x-fern-sdk-method-name': string;
16258
16266
  'x-fern-sdk-return-value': string;
16259
16267
  'x-response-key': string;
16268
+ 'x-title': string;
16260
16269
  };
16261
16270
  };
16262
16271
  '/thermostats/heat': {
16263
16272
  post: {
16273
+ description: string;
16264
16274
  operationId: string;
16265
16275
  requestBody: {
16266
16276
  content: {
@@ -16268,14 +16278,17 @@ declare const _default: {
16268
16278
  schema: {
16269
16279
  properties: {
16270
16280
  device_id: {
16281
+ description: string;
16271
16282
  format: string;
16272
16283
  type: string;
16273
16284
  };
16274
16285
  heating_set_point_celsius: {
16286
+ description: string;
16275
16287
  format: string;
16276
16288
  type: string;
16277
16289
  };
16278
16290
  heating_set_point_fahrenheit: {
16291
+ description: string;
16279
16292
  format: string;
16280
16293
  type: string;
16281
16294
  };
@@ -16344,10 +16357,12 @@ declare const _default: {
16344
16357
  'x-fern-sdk-method-name': string;
16345
16358
  'x-fern-sdk-return-value': string;
16346
16359
  'x-response-key': string;
16360
+ 'x-title': string;
16347
16361
  };
16348
16362
  };
16349
16363
  '/thermostats/heat_cool': {
16350
16364
  post: {
16365
+ description: string;
16351
16366
  operationId: string;
16352
16367
  requestBody: {
16353
16368
  content: {
@@ -16355,22 +16370,27 @@ declare const _default: {
16355
16370
  schema: {
16356
16371
  properties: {
16357
16372
  cooling_set_point_celsius: {
16373
+ description: string;
16358
16374
  format: string;
16359
16375
  type: string;
16360
16376
  };
16361
16377
  cooling_set_point_fahrenheit: {
16378
+ description: string;
16362
16379
  format: string;
16363
16380
  type: string;
16364
16381
  };
16365
16382
  device_id: {
16383
+ description: string;
16366
16384
  format: string;
16367
16385
  type: string;
16368
16386
  };
16369
16387
  heating_set_point_celsius: {
16388
+ description: string;
16370
16389
  format: string;
16371
16390
  type: string;
16372
16391
  };
16373
16392
  heating_set_point_fahrenheit: {
16393
+ description: string;
16374
16394
  format: string;
16375
16395
  type: string;
16376
16396
  };
@@ -16439,10 +16459,12 @@ declare const _default: {
16439
16459
  'x-fern-sdk-method-name': string;
16440
16460
  'x-fern-sdk-return-value': string;
16441
16461
  'x-response-key': string;
16462
+ 'x-title': string;
16442
16463
  };
16443
16464
  };
16444
16465
  '/thermostats/list': {
16445
16466
  post: {
16467
+ description: string;
16446
16468
  operationId: string;
16447
16469
  requestBody: {
16448
16470
  content: {
@@ -16594,10 +16616,12 @@ declare const _default: {
16594
16616
  'x-fern-sdk-method-name': string;
16595
16617
  'x-fern-sdk-return-value': string;
16596
16618
  'x-response-key': string;
16619
+ 'x-title': string;
16597
16620
  };
16598
16621
  };
16599
16622
  '/thermostats/off': {
16600
16623
  post: {
16624
+ description: string;
16601
16625
  operationId: string;
16602
16626
  requestBody: {
16603
16627
  content: {
@@ -16605,6 +16629,7 @@ declare const _default: {
16605
16629
  schema: {
16606
16630
  properties: {
16607
16631
  device_id: {
16632
+ description: string;
16608
16633
  format: string;
16609
16634
  type: string;
16610
16635
  };
@@ -16673,6 +16698,7 @@ declare const _default: {
16673
16698
  'x-fern-sdk-method-name': string;
16674
16699
  'x-fern-sdk-return-value': string;
16675
16700
  'x-response-key': string;
16701
+ 'x-title': string;
16676
16702
  };
16677
16703
  };
16678
16704
  '/thermostats/schedules/create': {
@@ -17232,6 +17258,7 @@ declare const _default: {
17232
17258
  };
17233
17259
  '/thermostats/set_fan_mode': {
17234
17260
  post: {
17261
+ description: string;
17235
17262
  operationId: string;
17236
17263
  requestBody: {
17237
17264
  content: {
@@ -17239,6 +17266,7 @@ declare const _default: {
17239
17266
  schema: {
17240
17267
  properties: {
17241
17268
  device_id: {
17269
+ description: string;
17242
17270
  format: string;
17243
17271
  type: string;
17244
17272
  };
@@ -17249,6 +17277,7 @@ declare const _default: {
17249
17277
  'x-deprecated': string;
17250
17278
  };
17251
17279
  fan_mode_setting: {
17280
+ description: string;
17252
17281
  enum: string[];
17253
17282
  type: string;
17254
17283
  };
@@ -17317,6 +17346,7 @@ declare const _default: {
17317
17346
  'x-fern-sdk-method-name': string;
17318
17347
  'x-fern-sdk-return-value': string;
17319
17348
  'x-response-key': string;
17349
+ 'x-title': string;
17320
17350
  };
17321
17351
  };
17322
17352
  '/thermostats/set_temperature_threshold': {
@@ -512,11 +512,7 @@ export default {
512
512
  'door_name',
513
513
  'locked_state',
514
514
  'lock_type',
515
- 'online',
516
515
  'battery_level',
517
- 'left_open_alarm',
518
- 'intrusion_alarm',
519
- 'privacy_mode',
520
516
  ],
521
517
  type: 'object',
522
518
  },
@@ -14889,6 +14885,7 @@ export default {
14889
14885
  },
14890
14886
  '/thermostats/cool': {
14891
14887
  post: {
14888
+ description: 'Sets a thermostat to cooling mode. You must include a cooling set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
14892
14889
  operationId: 'thermostatsCoolPost',
14893
14890
  requestBody: {
14894
14891
  content: {
@@ -14896,14 +14893,20 @@ export default {
14896
14893
  schema: {
14897
14894
  properties: {
14898
14895
  cooling_set_point_celsius: {
14896
+ description: 'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
14899
14897
  format: 'float',
14900
14898
  type: 'number',
14901
14899
  },
14902
14900
  cooling_set_point_fahrenheit: {
14901
+ description: 'Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters.',
14903
14902
  format: 'float',
14904
14903
  type: 'number',
14905
14904
  },
14906
- device_id: { format: 'uuid', type: 'string' },
14905
+ device_id: {
14906
+ description: 'ID of the thermostat device.',
14907
+ format: 'uuid',
14908
+ type: 'string',
14909
+ },
14907
14910
  sync: { default: false, type: 'boolean' },
14908
14911
  },
14909
14912
  required: ['device_id'],
@@ -14945,6 +14948,7 @@ export default {
14945
14948
  'x-fern-sdk-method-name': 'cool',
14946
14949
  'x-fern-sdk-return-value': 'action_attempt',
14947
14950
  'x-response-key': 'action_attempt',
14951
+ 'x-title': 'Set to Cool Mode',
14948
14952
  },
14949
14953
  },
14950
14954
  '/thermostats/create_climate_preset': {
@@ -15069,14 +15073,22 @@ export default {
15069
15073
  },
15070
15074
  '/thermostats/get': {
15071
15075
  post: {
15076
+ description: 'Returns a specific thermostat.',
15072
15077
  operationId: 'thermostatsGetPost',
15073
15078
  requestBody: {
15074
15079
  content: {
15075
15080
  'application/json': {
15076
15081
  schema: {
15077
15082
  properties: {
15078
- device_id: { format: 'uuid', type: 'string' },
15079
- name: { type: 'string' },
15083
+ device_id: {
15084
+ description: 'ID of the thermostat device.',
15085
+ format: 'uuid',
15086
+ type: 'string',
15087
+ },
15088
+ name: {
15089
+ description: 'Name of the thermostat.',
15090
+ type: 'string',
15091
+ },
15080
15092
  },
15081
15093
  type: 'object',
15082
15094
  },
@@ -15115,22 +15127,30 @@ export default {
15115
15127
  'x-fern-sdk-method-name': 'get',
15116
15128
  'x-fern-sdk-return-value': 'thermostat',
15117
15129
  'x-response-key': 'thermostat',
15130
+ 'x-title': 'Get a Thermostat',
15118
15131
  },
15119
15132
  },
15120
15133
  '/thermostats/heat': {
15121
15134
  post: {
15135
+ description: 'Sets a thermostat to heating mode. You must include a heating set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
15122
15136
  operationId: 'thermostatsHeatPost',
15123
15137
  requestBody: {
15124
15138
  content: {
15125
15139
  'application/json': {
15126
15140
  schema: {
15127
15141
  properties: {
15128
- device_id: { format: 'uuid', type: 'string' },
15142
+ device_id: {
15143
+ description: 'ID of the thermostat device.',
15144
+ format: 'uuid',
15145
+ type: 'string',
15146
+ },
15129
15147
  heating_set_point_celsius: {
15148
+ description: 'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
15130
15149
  format: 'float',
15131
15150
  type: 'number',
15132
15151
  },
15133
15152
  heating_set_point_fahrenheit: {
15153
+ description: 'Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters.',
15134
15154
  format: 'float',
15135
15155
  type: 'number',
15136
15156
  },
@@ -15175,10 +15195,12 @@ export default {
15175
15195
  'x-fern-sdk-method-name': 'heat',
15176
15196
  'x-fern-sdk-return-value': 'action_attempt',
15177
15197
  'x-response-key': 'action_attempt',
15198
+ 'x-title': 'Set to Heat Mode',
15178
15199
  },
15179
15200
  },
15180
15201
  '/thermostats/heat_cool': {
15181
15202
  post: {
15203
+ description: 'Set a thermostat to heat-cool mode, also known as "auto" mode. To do so, you must include both cooling and heating set points in the payload, either in Celsius or Fahrenheit. For information about verifying the heating and cooling availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](https://docs.seam.co/latest/capability-guides/thermostats/hvac-mode#hvac-mode-constraints) and [Set Point Constraints](https://docs.seam.co/latest/capability-guides/thermostats/set-points#set-point-constraints).',
15182
15204
  operationId: 'thermostatsHeatCoolPost',
15183
15205
  requestBody: {
15184
15206
  content: {
@@ -15186,19 +15208,27 @@ export default {
15186
15208
  schema: {
15187
15209
  properties: {
15188
15210
  cooling_set_point_celsius: {
15211
+ description: 'Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters.',
15189
15212
  format: 'float',
15190
15213
  type: 'number',
15191
15214
  },
15192
15215
  cooling_set_point_fahrenheit: {
15216
+ description: 'Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters.',
15193
15217
  format: 'float',
15194
15218
  type: 'number',
15195
15219
  },
15196
- device_id: { format: 'uuid', type: 'string' },
15220
+ device_id: {
15221
+ description: 'ID of the thermostat device.',
15222
+ format: 'uuid',
15223
+ type: 'string',
15224
+ },
15197
15225
  heating_set_point_celsius: {
15226
+ description: 'Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters.',
15198
15227
  format: 'float',
15199
15228
  type: 'number',
15200
15229
  },
15201
15230
  heating_set_point_fahrenheit: {
15231
+ description: 'Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters.',
15202
15232
  format: 'float',
15203
15233
  type: 'number',
15204
15234
  },
@@ -15243,10 +15273,12 @@ export default {
15243
15273
  'x-fern-sdk-method-name': 'heat_cool',
15244
15274
  'x-fern-sdk-return-value': 'action_attempt',
15245
15275
  'x-response-key': 'action_attempt',
15276
+ 'x-title': 'Set to Heat-Cool (Auto) Mode',
15246
15277
  },
15247
15278
  },
15248
15279
  '/thermostats/list': {
15249
15280
  post: {
15281
+ description: 'Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.',
15250
15282
  operationId: 'thermostatsListPost',
15251
15283
  requestBody: {
15252
15284
  content: {
@@ -15516,17 +15548,23 @@ export default {
15516
15548
  'x-fern-sdk-method-name': 'list',
15517
15549
  'x-fern-sdk-return-value': 'devices',
15518
15550
  'x-response-key': 'devices',
15551
+ 'x-title': 'List Thermostats',
15519
15552
  },
15520
15553
  },
15521
15554
  '/thermostats/off': {
15522
15555
  post: {
15556
+ description: 'Sets a thermostat to "off" mode. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
15523
15557
  operationId: 'thermostatsOffPost',
15524
15558
  requestBody: {
15525
15559
  content: {
15526
15560
  'application/json': {
15527
15561
  schema: {
15528
15562
  properties: {
15529
- device_id: { format: 'uuid', type: 'string' },
15563
+ device_id: {
15564
+ description: 'ID of the thermostat device.',
15565
+ format: 'uuid',
15566
+ type: 'string',
15567
+ },
15530
15568
  sync: { default: false, type: 'boolean' },
15531
15569
  },
15532
15570
  required: ['device_id'],
@@ -15568,6 +15606,7 @@ export default {
15568
15606
  'x-fern-sdk-method-name': 'off',
15569
15607
  'x-fern-sdk-return-value': 'action_attempt',
15570
15608
  'x-response-key': 'action_attempt',
15609
+ 'x-title': 'Set to Off Mode',
15571
15610
  },
15572
15611
  },
15573
15612
  '/thermostats/schedules/create': {
@@ -15930,20 +15969,26 @@ export default {
15930
15969
  },
15931
15970
  '/thermostats/set_fan_mode': {
15932
15971
  post: {
15972
+ description: 'Sets the fan mode setting for a thermostat. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) and [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).',
15933
15973
  operationId: 'thermostatsSetFanModePost',
15934
15974
  requestBody: {
15935
15975
  content: {
15936
15976
  'application/json': {
15937
15977
  schema: {
15938
15978
  properties: {
15939
- device_id: { format: 'uuid', type: 'string' },
15979
+ device_id: {
15980
+ description: 'ID of the thermostat device.',
15981
+ format: 'uuid',
15982
+ type: 'string',
15983
+ },
15940
15984
  fan_mode: {
15941
15985
  deprecated: true,
15942
15986
  enum: ['auto', 'on', 'circulate'],
15943
15987
  type: 'string',
15944
- 'x-deprecated': 'use fan_mode_setting instead.',
15988
+ 'x-deprecated': 'Use `fan_mode_setting` instead.',
15945
15989
  },
15946
15990
  fan_mode_setting: {
15991
+ description: 'Fan mode setting of the thermostat. See also [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).',
15947
15992
  enum: ['auto', 'on', 'circulate'],
15948
15993
  type: 'string',
15949
15994
  },
@@ -15988,6 +16033,7 @@ export default {
15988
16033
  'x-fern-sdk-method-name': 'set_fan_mode',
15989
16034
  'x-fern-sdk-return-value': 'action_attempt',
15990
16035
  'x-response-key': 'action_attempt',
16036
+ 'x-title': 'Set Fan Mode Setting',
15991
16037
  },
15992
16038
  },
15993
16039
  '/thermostats/set_temperature_threshold': {