@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.
- package/dist/connect.cjs +65 -15
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +47 -1
- package/lib/seam/connect/openapi.d.ts +30 -0
- package/lib/seam/connect/openapi.js +58 -8
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +17 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +73 -8
- package/src/lib/seam/connect/route-types.ts +17 -1
|
@@ -14885,6 +14885,7 @@ export default {
|
|
|
14885
14885
|
},
|
|
14886
14886
|
'/thermostats/cool': {
|
|
14887
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).',
|
|
14888
14889
|
operationId: 'thermostatsCoolPost',
|
|
14889
14890
|
requestBody: {
|
|
14890
14891
|
content: {
|
|
@@ -14892,14 +14893,20 @@ export default {
|
|
|
14892
14893
|
schema: {
|
|
14893
14894
|
properties: {
|
|
14894
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.',
|
|
14895
14897
|
format: 'float',
|
|
14896
14898
|
type: 'number',
|
|
14897
14899
|
},
|
|
14898
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.',
|
|
14899
14902
|
format: 'float',
|
|
14900
14903
|
type: 'number',
|
|
14901
14904
|
},
|
|
14902
|
-
device_id: {
|
|
14905
|
+
device_id: {
|
|
14906
|
+
description: 'ID of the thermostat device.',
|
|
14907
|
+
format: 'uuid',
|
|
14908
|
+
type: 'string',
|
|
14909
|
+
},
|
|
14903
14910
|
sync: { default: false, type: 'boolean' },
|
|
14904
14911
|
},
|
|
14905
14912
|
required: ['device_id'],
|
|
@@ -14941,6 +14948,7 @@ export default {
|
|
|
14941
14948
|
'x-fern-sdk-method-name': 'cool',
|
|
14942
14949
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
14943
14950
|
'x-response-key': 'action_attempt',
|
|
14951
|
+
'x-title': 'Set to Cool Mode',
|
|
14944
14952
|
},
|
|
14945
14953
|
},
|
|
14946
14954
|
'/thermostats/create_climate_preset': {
|
|
@@ -15065,14 +15073,22 @@ export default {
|
|
|
15065
15073
|
},
|
|
15066
15074
|
'/thermostats/get': {
|
|
15067
15075
|
post: {
|
|
15076
|
+
description: 'Returns a specific thermostat.',
|
|
15068
15077
|
operationId: 'thermostatsGetPost',
|
|
15069
15078
|
requestBody: {
|
|
15070
15079
|
content: {
|
|
15071
15080
|
'application/json': {
|
|
15072
15081
|
schema: {
|
|
15073
15082
|
properties: {
|
|
15074
|
-
device_id: {
|
|
15075
|
-
|
|
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
|
+
},
|
|
15076
15092
|
},
|
|
15077
15093
|
type: 'object',
|
|
15078
15094
|
},
|
|
@@ -15111,22 +15127,30 @@ export default {
|
|
|
15111
15127
|
'x-fern-sdk-method-name': 'get',
|
|
15112
15128
|
'x-fern-sdk-return-value': 'thermostat',
|
|
15113
15129
|
'x-response-key': 'thermostat',
|
|
15130
|
+
'x-title': 'Get a Thermostat',
|
|
15114
15131
|
},
|
|
15115
15132
|
},
|
|
15116
15133
|
'/thermostats/heat': {
|
|
15117
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).',
|
|
15118
15136
|
operationId: 'thermostatsHeatPost',
|
|
15119
15137
|
requestBody: {
|
|
15120
15138
|
content: {
|
|
15121
15139
|
'application/json': {
|
|
15122
15140
|
schema: {
|
|
15123
15141
|
properties: {
|
|
15124
|
-
device_id: {
|
|
15142
|
+
device_id: {
|
|
15143
|
+
description: 'ID of the thermostat device.',
|
|
15144
|
+
format: 'uuid',
|
|
15145
|
+
type: 'string',
|
|
15146
|
+
},
|
|
15125
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.',
|
|
15126
15149
|
format: 'float',
|
|
15127
15150
|
type: 'number',
|
|
15128
15151
|
},
|
|
15129
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.',
|
|
15130
15154
|
format: 'float',
|
|
15131
15155
|
type: 'number',
|
|
15132
15156
|
},
|
|
@@ -15171,10 +15195,12 @@ export default {
|
|
|
15171
15195
|
'x-fern-sdk-method-name': 'heat',
|
|
15172
15196
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
15173
15197
|
'x-response-key': 'action_attempt',
|
|
15198
|
+
'x-title': 'Set to Heat Mode',
|
|
15174
15199
|
},
|
|
15175
15200
|
},
|
|
15176
15201
|
'/thermostats/heat_cool': {
|
|
15177
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).',
|
|
15178
15204
|
operationId: 'thermostatsHeatCoolPost',
|
|
15179
15205
|
requestBody: {
|
|
15180
15206
|
content: {
|
|
@@ -15182,19 +15208,27 @@ export default {
|
|
|
15182
15208
|
schema: {
|
|
15183
15209
|
properties: {
|
|
15184
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.',
|
|
15185
15212
|
format: 'float',
|
|
15186
15213
|
type: 'number',
|
|
15187
15214
|
},
|
|
15188
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.',
|
|
15189
15217
|
format: 'float',
|
|
15190
15218
|
type: 'number',
|
|
15191
15219
|
},
|
|
15192
|
-
device_id: {
|
|
15220
|
+
device_id: {
|
|
15221
|
+
description: 'ID of the thermostat device.',
|
|
15222
|
+
format: 'uuid',
|
|
15223
|
+
type: 'string',
|
|
15224
|
+
},
|
|
15193
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.',
|
|
15194
15227
|
format: 'float',
|
|
15195
15228
|
type: 'number',
|
|
15196
15229
|
},
|
|
15197
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.',
|
|
15198
15232
|
format: 'float',
|
|
15199
15233
|
type: 'number',
|
|
15200
15234
|
},
|
|
@@ -15239,10 +15273,12 @@ export default {
|
|
|
15239
15273
|
'x-fern-sdk-method-name': 'heat_cool',
|
|
15240
15274
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
15241
15275
|
'x-response-key': 'action_attempt',
|
|
15276
|
+
'x-title': 'Set to Heat-Cool (Auto) Mode',
|
|
15242
15277
|
},
|
|
15243
15278
|
},
|
|
15244
15279
|
'/thermostats/list': {
|
|
15245
15280
|
post: {
|
|
15281
|
+
description: 'Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.',
|
|
15246
15282
|
operationId: 'thermostatsListPost',
|
|
15247
15283
|
requestBody: {
|
|
15248
15284
|
content: {
|
|
@@ -15512,17 +15548,23 @@ export default {
|
|
|
15512
15548
|
'x-fern-sdk-method-name': 'list',
|
|
15513
15549
|
'x-fern-sdk-return-value': 'devices',
|
|
15514
15550
|
'x-response-key': 'devices',
|
|
15551
|
+
'x-title': 'List Thermostats',
|
|
15515
15552
|
},
|
|
15516
15553
|
},
|
|
15517
15554
|
'/thermostats/off': {
|
|
15518
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).',
|
|
15519
15557
|
operationId: 'thermostatsOffPost',
|
|
15520
15558
|
requestBody: {
|
|
15521
15559
|
content: {
|
|
15522
15560
|
'application/json': {
|
|
15523
15561
|
schema: {
|
|
15524
15562
|
properties: {
|
|
15525
|
-
device_id: {
|
|
15563
|
+
device_id: {
|
|
15564
|
+
description: 'ID of the thermostat device.',
|
|
15565
|
+
format: 'uuid',
|
|
15566
|
+
type: 'string',
|
|
15567
|
+
},
|
|
15526
15568
|
sync: { default: false, type: 'boolean' },
|
|
15527
15569
|
},
|
|
15528
15570
|
required: ['device_id'],
|
|
@@ -15564,6 +15606,7 @@ export default {
|
|
|
15564
15606
|
'x-fern-sdk-method-name': 'off',
|
|
15565
15607
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
15566
15608
|
'x-response-key': 'action_attempt',
|
|
15609
|
+
'x-title': 'Set to Off Mode',
|
|
15567
15610
|
},
|
|
15568
15611
|
},
|
|
15569
15612
|
'/thermostats/schedules/create': {
|
|
@@ -15926,20 +15969,26 @@ export default {
|
|
|
15926
15969
|
},
|
|
15927
15970
|
'/thermostats/set_fan_mode': {
|
|
15928
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).',
|
|
15929
15973
|
operationId: 'thermostatsSetFanModePost',
|
|
15930
15974
|
requestBody: {
|
|
15931
15975
|
content: {
|
|
15932
15976
|
'application/json': {
|
|
15933
15977
|
schema: {
|
|
15934
15978
|
properties: {
|
|
15935
|
-
device_id: {
|
|
15979
|
+
device_id: {
|
|
15980
|
+
description: 'ID of the thermostat device.',
|
|
15981
|
+
format: 'uuid',
|
|
15982
|
+
type: 'string',
|
|
15983
|
+
},
|
|
15936
15984
|
fan_mode: {
|
|
15937
15985
|
deprecated: true,
|
|
15938
15986
|
enum: ['auto', 'on', 'circulate'],
|
|
15939
15987
|
type: 'string',
|
|
15940
|
-
'x-deprecated': '
|
|
15988
|
+
'x-deprecated': 'Use `fan_mode_setting` instead.',
|
|
15941
15989
|
},
|
|
15942
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).',
|
|
15943
15992
|
enum: ['auto', 'on', 'circulate'],
|
|
15944
15993
|
type: 'string',
|
|
15945
15994
|
},
|
|
@@ -15984,6 +16033,7 @@ export default {
|
|
|
15984
16033
|
'x-fern-sdk-method-name': 'set_fan_mode',
|
|
15985
16034
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
15986
16035
|
'x-response-key': 'action_attempt',
|
|
16036
|
+
'x-title': 'Set Fan Mode Setting',
|
|
15987
16037
|
},
|
|
15988
16038
|
},
|
|
15989
16039
|
'/thermostats/set_temperature_threshold': {
|