@seamapi/types 1.288.2 → 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.
Files changed (10) hide show
  1. package/dist/connect.cjs +65 -15
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +47 -1
  4. package/lib/seam/connect/openapi.d.ts +30 -0
  5. package/lib/seam/connect/openapi.js +58 -8
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +17 -1
  8. package/package.json +1 -1
  9. package/src/lib/seam/connect/openapi.ts +73 -8
  10. package/src/lib/seam/connect/route-types.ts +17 -1
package/dist/connect.d.cts CHANGED
@@ -27696,6 +27696,7 @@ declare const _default: {
27696
27696
  };
27697
27697
  '/thermostats/cool': {
27698
27698
  post: {
27699
+ description: string;
27699
27700
  operationId: string;
27700
27701
  requestBody: {
27701
27702
  content: {
@@ -27703,14 +27704,17 @@ declare const _default: {
27703
27704
  schema: {
27704
27705
  properties: {
27705
27706
  cooling_set_point_celsius: {
27707
+ description: string;
27706
27708
  format: string;
27707
27709
  type: string;
27708
27710
  };
27709
27711
  cooling_set_point_fahrenheit: {
27712
+ description: string;
27710
27713
  format: string;
27711
27714
  type: string;
27712
27715
  };
27713
27716
  device_id: {
27717
+ description: string;
27714
27718
  format: string;
27715
27719
  type: string;
27716
27720
  };
@@ -27779,6 +27783,7 @@ declare const _default: {
27779
27783
  'x-fern-sdk-method-name': string;
27780
27784
  'x-fern-sdk-return-value': string;
27781
27785
  'x-response-key': string;
27786
+ 'x-title': string;
27782
27787
  };
27783
27788
  };
27784
27789
  '/thermostats/create_climate_preset': {
@@ -27947,6 +27952,7 @@ declare const _default: {
27947
27952
  };
27948
27953
  '/thermostats/get': {
27949
27954
  post: {
27955
+ description: string;
27950
27956
  operationId: string;
27951
27957
  requestBody: {
27952
27958
  content: {
@@ -27954,10 +27960,12 @@ declare const _default: {
27954
27960
  schema: {
27955
27961
  properties: {
27956
27962
  device_id: {
27963
+ description: string;
27957
27964
  format: string;
27958
27965
  type: string;
27959
27966
  };
27960
27967
  name: {
27968
+ description: string;
27961
27969
  type: string;
27962
27970
  };
27963
27971
  };
@@ -28021,10 +28029,12 @@ declare const _default: {
28021
28029
  'x-fern-sdk-method-name': string;
28022
28030
  'x-fern-sdk-return-value': string;
28023
28031
  'x-response-key': string;
28032
+ 'x-title': string;
28024
28033
  };
28025
28034
  };
28026
28035
  '/thermostats/heat': {
28027
28036
  post: {
28037
+ description: string;
28028
28038
  operationId: string;
28029
28039
  requestBody: {
28030
28040
  content: {
@@ -28032,14 +28042,17 @@ declare const _default: {
28032
28042
  schema: {
28033
28043
  properties: {
28034
28044
  device_id: {
28045
+ description: string;
28035
28046
  format: string;
28036
28047
  type: string;
28037
28048
  };
28038
28049
  heating_set_point_celsius: {
28050
+ description: string;
28039
28051
  format: string;
28040
28052
  type: string;
28041
28053
  };
28042
28054
  heating_set_point_fahrenheit: {
28055
+ description: string;
28043
28056
  format: string;
28044
28057
  type: string;
28045
28058
  };
@@ -28108,10 +28121,12 @@ declare const _default: {
28108
28121
  'x-fern-sdk-method-name': string;
28109
28122
  'x-fern-sdk-return-value': string;
28110
28123
  'x-response-key': string;
28124
+ 'x-title': string;
28111
28125
  };
28112
28126
  };
28113
28127
  '/thermostats/heat_cool': {
28114
28128
  post: {
28129
+ description: string;
28115
28130
  operationId: string;
28116
28131
  requestBody: {
28117
28132
  content: {
@@ -28119,22 +28134,27 @@ declare const _default: {
28119
28134
  schema: {
28120
28135
  properties: {
28121
28136
  cooling_set_point_celsius: {
28137
+ description: string;
28122
28138
  format: string;
28123
28139
  type: string;
28124
28140
  };
28125
28141
  cooling_set_point_fahrenheit: {
28142
+ description: string;
28126
28143
  format: string;
28127
28144
  type: string;
28128
28145
  };
28129
28146
  device_id: {
28147
+ description: string;
28130
28148
  format: string;
28131
28149
  type: string;
28132
28150
  };
28133
28151
  heating_set_point_celsius: {
28152
+ description: string;
28134
28153
  format: string;
28135
28154
  type: string;
28136
28155
  };
28137
28156
  heating_set_point_fahrenheit: {
28157
+ description: string;
28138
28158
  format: string;
28139
28159
  type: string;
28140
28160
  };
@@ -28203,10 +28223,12 @@ declare const _default: {
28203
28223
  'x-fern-sdk-method-name': string;
28204
28224
  'x-fern-sdk-return-value': string;
28205
28225
  'x-response-key': string;
28226
+ 'x-title': string;
28206
28227
  };
28207
28228
  };
28208
28229
  '/thermostats/list': {
28209
28230
  post: {
28231
+ description: string;
28210
28232
  operationId: string;
28211
28233
  requestBody: {
28212
28234
  content: {
@@ -28358,10 +28380,12 @@ declare const _default: {
28358
28380
  'x-fern-sdk-method-name': string;
28359
28381
  'x-fern-sdk-return-value': string;
28360
28382
  'x-response-key': string;
28383
+ 'x-title': string;
28361
28384
  };
28362
28385
  };
28363
28386
  '/thermostats/off': {
28364
28387
  post: {
28388
+ description: string;
28365
28389
  operationId: string;
28366
28390
  requestBody: {
28367
28391
  content: {
@@ -28369,6 +28393,7 @@ declare const _default: {
28369
28393
  schema: {
28370
28394
  properties: {
28371
28395
  device_id: {
28396
+ description: string;
28372
28397
  format: string;
28373
28398
  type: string;
28374
28399
  };
@@ -28437,6 +28462,7 @@ declare const _default: {
28437
28462
  'x-fern-sdk-method-name': string;
28438
28463
  'x-fern-sdk-return-value': string;
28439
28464
  'x-response-key': string;
28465
+ 'x-title': string;
28440
28466
  };
28441
28467
  };
28442
28468
  '/thermostats/schedules/create': {
@@ -28996,6 +29022,7 @@ declare const _default: {
28996
29022
  };
28997
29023
  '/thermostats/set_fan_mode': {
28998
29024
  post: {
29025
+ description: string;
28999
29026
  operationId: string;
29000
29027
  requestBody: {
29001
29028
  content: {
@@ -29003,6 +29030,7 @@ declare const _default: {
29003
29030
  schema: {
29004
29031
  properties: {
29005
29032
  device_id: {
29033
+ description: string;
29006
29034
  format: string;
29007
29035
  type: string;
29008
29036
  };
@@ -29013,6 +29041,7 @@ declare const _default: {
29013
29041
  'x-deprecated': string;
29014
29042
  };
29015
29043
  fan_mode_setting: {
29044
+ description: string;
29016
29045
  enum: string[];
29017
29046
  type: string;
29018
29047
  };
@@ -29081,6 +29110,7 @@ declare const _default: {
29081
29110
  'x-fern-sdk-method-name': string;
29082
29111
  'x-fern-sdk-return-value': string;
29083
29112
  'x-response-key': string;
29113
+ 'x-title': string;
29084
29114
  };
29085
29115
  };
29086
29116
  '/thermostats/set_temperature_threshold': {
@@ -50350,8 +50380,11 @@ interface Routes {
50350
50380
  method: 'POST';
50351
50381
  queryParams: {};
50352
50382
  jsonBody: {
50383
+ /** ID of the thermostat device. */
50353
50384
  device_id: string;
50385
+ /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
50354
50386
  cooling_set_point_celsius?: number | undefined;
50387
+ /** Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters. */
50355
50388
  cooling_set_point_fahrenheit?: number | undefined;
50356
50389
  sync?: boolean;
50357
50390
  };
@@ -51118,7 +51151,9 @@ interface Routes {
51118
51151
  queryParams: {};
51119
51152
  jsonBody: {};
51120
51153
  commonParams: {
51154
+ /** ID of the thermostat device. */
51121
51155
  device_id?: string | undefined;
51156
+ /** Name of the thermostat. */
51122
51157
  name?: string | undefined;
51123
51158
  };
51124
51159
  formData: {};
@@ -51593,8 +51628,11 @@ interface Routes {
51593
51628
  method: 'POST';
51594
51629
  queryParams: {};
51595
51630
  jsonBody: {
51631
+ /** ID of the thermostat device. */
51596
51632
  device_id: string;
51633
+ /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
51597
51634
  heating_set_point_celsius?: number | undefined;
51635
+ /** Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters. */
51598
51636
  heating_set_point_fahrenheit?: number | undefined;
51599
51637
  sync?: boolean;
51600
51638
  };
@@ -52328,10 +52366,15 @@ interface Routes {
52328
52366
  method: 'POST';
52329
52367
  queryParams: {};
52330
52368
  jsonBody: {
52369
+ /** ID of the thermostat device. */
52331
52370
  device_id: string;
52371
+ /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
52332
52372
  heating_set_point_celsius?: number | undefined;
52373
+ /** Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters. */
52333
52374
  heating_set_point_fahrenheit?: number | undefined;
52375
+ /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
52334
52376
  cooling_set_point_celsius?: number | undefined;
52377
+ /** Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters. */
52335
52378
  cooling_set_point_fahrenheit?: number | undefined;
52336
52379
  sync?: boolean;
52337
52380
  };
@@ -54016,6 +54059,7 @@ interface Routes {
54016
54059
  method: 'POST';
54017
54060
  queryParams: {};
54018
54061
  jsonBody: {
54062
+ /** ID of the thermostat device. */
54019
54063
  device_id: string;
54020
54064
  sync?: boolean;
54021
54065
  };
@@ -54866,10 +54910,12 @@ interface Routes {
54866
54910
  method: 'POST';
54867
54911
  queryParams: {};
54868
54912
  jsonBody: {
54913
+ /** ID of the thermostat device. */
54869
54914
  device_id: string;
54870
54915
  /**
54871
- * @deprecated use fan_mode_setting instead. */
54916
+ * @deprecated Use `fan_mode_setting` instead. */
54872
54917
  fan_mode?: ('auto' | 'on' | 'circulate') | undefined;
54918
+ /** 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). */
54873
54919
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
54874
54920
  sync?: boolean;
54875
54921
  };
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -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': {