@seamapi/types 1.298.0 → 1.299.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.
@@ -17713,6 +17713,183 @@ declare const _default: {
17713
17713
  'x-title': string;
17714
17714
  };
17715
17715
  };
17716
+ '/thermostats/set_hvac_mode': {
17717
+ post: {
17718
+ description: string;
17719
+ operationId: string;
17720
+ requestBody: {
17721
+ content: {
17722
+ 'application/json': {
17723
+ schema: {
17724
+ discriminator: {
17725
+ propertyName: string;
17726
+ };
17727
+ oneOf: ({
17728
+ properties: {
17729
+ device_id: {
17730
+ description: string;
17731
+ format: string;
17732
+ type: string;
17733
+ };
17734
+ hvac_mode_setting: {
17735
+ enum: string[];
17736
+ type: string;
17737
+ };
17738
+ cooling_set_point_celsius?: never;
17739
+ cooling_set_point_fahrenheit?: never;
17740
+ heating_set_point_celsius?: never;
17741
+ heating_set_point_fahrenheit?: never;
17742
+ };
17743
+ required: string[];
17744
+ type: string;
17745
+ } | {
17746
+ properties: {
17747
+ cooling_set_point_celsius: {
17748
+ description: string;
17749
+ format: string;
17750
+ type: string;
17751
+ };
17752
+ cooling_set_point_fahrenheit: {
17753
+ description: string;
17754
+ format: string;
17755
+ type: string;
17756
+ };
17757
+ device_id: {
17758
+ description: string;
17759
+ format: string;
17760
+ type: string;
17761
+ };
17762
+ hvac_mode_setting: {
17763
+ enum: string[];
17764
+ type: string;
17765
+ };
17766
+ heating_set_point_celsius?: never;
17767
+ heating_set_point_fahrenheit?: never;
17768
+ };
17769
+ required: string[];
17770
+ type: string;
17771
+ } | {
17772
+ properties: {
17773
+ device_id: {
17774
+ description: string;
17775
+ format: string;
17776
+ type: string;
17777
+ };
17778
+ heating_set_point_celsius: {
17779
+ description: string;
17780
+ format: string;
17781
+ type: string;
17782
+ };
17783
+ heating_set_point_fahrenheit: {
17784
+ description: string;
17785
+ format: string;
17786
+ type: string;
17787
+ };
17788
+ hvac_mode_setting: {
17789
+ enum: string[];
17790
+ type: string;
17791
+ };
17792
+ cooling_set_point_celsius?: never;
17793
+ cooling_set_point_fahrenheit?: never;
17794
+ };
17795
+ required: string[];
17796
+ type: string;
17797
+ } | {
17798
+ properties: {
17799
+ cooling_set_point_celsius: {
17800
+ description: string;
17801
+ format: string;
17802
+ type: string;
17803
+ };
17804
+ cooling_set_point_fahrenheit: {
17805
+ description: string;
17806
+ format: string;
17807
+ type: string;
17808
+ };
17809
+ device_id: {
17810
+ description: string;
17811
+ format: string;
17812
+ type: string;
17813
+ };
17814
+ heating_set_point_celsius: {
17815
+ description: string;
17816
+ format: string;
17817
+ type: string;
17818
+ };
17819
+ heating_set_point_fahrenheit: {
17820
+ description: string;
17821
+ format: string;
17822
+ type: string;
17823
+ };
17824
+ hvac_mode_setting: {
17825
+ enum: string[];
17826
+ type: string;
17827
+ };
17828
+ };
17829
+ required: string[];
17830
+ type: string;
17831
+ })[];
17832
+ };
17833
+ };
17834
+ };
17835
+ };
17836
+ responses: {
17837
+ 200: {
17838
+ content: {
17839
+ 'application/json': {
17840
+ schema: {
17841
+ properties: {
17842
+ action_attempt: {
17843
+ $ref: string;
17844
+ };
17845
+ ok: {
17846
+ type: string;
17847
+ };
17848
+ };
17849
+ required: string[];
17850
+ type: string;
17851
+ };
17852
+ };
17853
+ };
17854
+ description: string;
17855
+ };
17856
+ 400: {
17857
+ description: string;
17858
+ };
17859
+ 401: {
17860
+ description: string;
17861
+ };
17862
+ };
17863
+ security: ({
17864
+ client_session: never[];
17865
+ pat_with_workspace?: never;
17866
+ console_session?: never;
17867
+ api_key?: never;
17868
+ } | {
17869
+ pat_with_workspace: never[];
17870
+ client_session?: never;
17871
+ console_session?: never;
17872
+ api_key?: never;
17873
+ } | {
17874
+ console_session: never[];
17875
+ client_session?: never;
17876
+ pat_with_workspace?: never;
17877
+ api_key?: never;
17878
+ } | {
17879
+ api_key: never[];
17880
+ client_session?: never;
17881
+ pat_with_workspace?: never;
17882
+ console_session?: never;
17883
+ })[];
17884
+ summary: string;
17885
+ tags: string[];
17886
+ 'x-fern-sdk-group-name': string[];
17887
+ 'x-fern-sdk-method-name': string;
17888
+ 'x-fern-sdk-return-value': string;
17889
+ 'x-response-key': string;
17890
+ 'x-title': string;
17891
+ };
17892
+ };
17716
17893
  '/thermostats/set_temperature_threshold': {
17717
17894
  patch: {
17718
17895
  description: string;
@@ -17299,6 +17299,148 @@ export default {
17299
17299
  'x-title': 'Set the Fan Mode Setting',
17300
17300
  },
17301
17301
  },
17302
+ '/thermostats/set_hvac_mode': {
17303
+ post: {
17304
+ description: 'Sets the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
17305
+ operationId: 'thermostatsSetHvacModePost',
17306
+ requestBody: {
17307
+ content: {
17308
+ 'application/json': {
17309
+ schema: {
17310
+ discriminator: { propertyName: 'hvac_mode_setting' },
17311
+ oneOf: [
17312
+ {
17313
+ properties: {
17314
+ device_id: {
17315
+ description: 'ID of the desired thermostat device.',
17316
+ format: 'uuid',
17317
+ type: 'string',
17318
+ },
17319
+ hvac_mode_setting: { enum: ['off'], type: 'string' },
17320
+ },
17321
+ required: ['hvac_mode_setting', 'device_id'],
17322
+ type: 'object',
17323
+ },
17324
+ {
17325
+ properties: {
17326
+ cooling_set_point_celsius: {
17327
+ description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters.',
17328
+ format: 'float',
17329
+ type: 'number',
17330
+ },
17331
+ cooling_set_point_fahrenheit: {
17332
+ description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters.',
17333
+ format: 'float',
17334
+ type: 'number',
17335
+ },
17336
+ device_id: {
17337
+ description: 'ID of the desired thermostat device.',
17338
+ format: 'uuid',
17339
+ type: 'string',
17340
+ },
17341
+ hvac_mode_setting: { enum: ['cool'], type: 'string' },
17342
+ },
17343
+ required: ['hvac_mode_setting', 'device_id'],
17344
+ type: 'object',
17345
+ },
17346
+ {
17347
+ properties: {
17348
+ device_id: {
17349
+ description: 'ID of the desired thermostat device.',
17350
+ format: 'uuid',
17351
+ type: 'string',
17352
+ },
17353
+ heating_set_point_celsius: {
17354
+ description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters.',
17355
+ format: 'float',
17356
+ type: 'number',
17357
+ },
17358
+ heating_set_point_fahrenheit: {
17359
+ description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters.',
17360
+ format: 'float',
17361
+ type: 'number',
17362
+ },
17363
+ hvac_mode_setting: { enum: ['heat'], type: 'string' },
17364
+ },
17365
+ required: ['hvac_mode_setting', 'device_id'],
17366
+ type: 'object',
17367
+ },
17368
+ {
17369
+ properties: {
17370
+ cooling_set_point_celsius: {
17371
+ description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters.',
17372
+ format: 'float',
17373
+ type: 'number',
17374
+ },
17375
+ cooling_set_point_fahrenheit: {
17376
+ description: 'Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters.',
17377
+ format: 'float',
17378
+ type: 'number',
17379
+ },
17380
+ device_id: {
17381
+ description: 'ID of the desired thermostat device.',
17382
+ format: 'uuid',
17383
+ type: 'string',
17384
+ },
17385
+ heating_set_point_celsius: {
17386
+ description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters.',
17387
+ format: 'float',
17388
+ type: 'number',
17389
+ },
17390
+ heating_set_point_fahrenheit: {
17391
+ description: 'Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters.',
17392
+ format: 'float',
17393
+ type: 'number',
17394
+ },
17395
+ hvac_mode_setting: {
17396
+ enum: ['heat_cool'],
17397
+ type: 'string',
17398
+ },
17399
+ },
17400
+ required: ['hvac_mode_setting', 'device_id'],
17401
+ type: 'object',
17402
+ },
17403
+ ],
17404
+ },
17405
+ },
17406
+ },
17407
+ },
17408
+ responses: {
17409
+ 200: {
17410
+ content: {
17411
+ 'application/json': {
17412
+ schema: {
17413
+ properties: {
17414
+ action_attempt: {
17415
+ $ref: '#/components/schemas/action_attempt',
17416
+ },
17417
+ ok: { type: 'boolean' },
17418
+ },
17419
+ required: ['action_attempt', 'ok'],
17420
+ type: 'object',
17421
+ },
17422
+ },
17423
+ },
17424
+ description: 'OK',
17425
+ },
17426
+ 400: { description: 'Bad Request' },
17427
+ 401: { description: 'Unauthorized' },
17428
+ },
17429
+ security: [
17430
+ { client_session: [] },
17431
+ { pat_with_workspace: [] },
17432
+ { console_session: [] },
17433
+ { api_key: [] },
17434
+ ],
17435
+ summary: '/thermostats/set_hvac_mode',
17436
+ tags: ['/thermostats'],
17437
+ 'x-fern-sdk-group-name': ['thermostats'],
17438
+ 'x-fern-sdk-method-name': 'set_hvac_mode',
17439
+ 'x-fern-sdk-return-value': 'action_attempt',
17440
+ 'x-response-key': 'action_attempt',
17441
+ 'x-title': 'Set the HVAC Mode',
17442
+ },
17443
+ },
17302
17444
  '/thermostats/set_temperature_threshold': {
17303
17445
  patch: {
17304
17446
  description: 'Sets a [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.',