@seamapi/types 1.343.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.
- package/dist/connect.cjs +73 -15
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +58 -0
- package/lib/seam/connect/openapi.d.ts +39 -0
- package/lib/seam/connect/openapi.js +69 -11
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +19 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +85 -11
- package/src/lib/seam/connect/route-types.ts +19 -0
|
@@ -34702,24 +34702,40 @@ export interface Routes {
|
|
|
34702
34702
|
method: 'POST';
|
|
34703
34703
|
queryParams: {};
|
|
34704
34704
|
jsonBody: {
|
|
34705
|
+
/** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
|
|
34705
34706
|
hvac_mode: 'off';
|
|
34707
|
+
/** ID of the desired thermostat device. */
|
|
34706
34708
|
device_id: string;
|
|
34707
34709
|
} | {
|
|
34710
|
+
/** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
|
|
34708
34711
|
hvac_mode: 'cool';
|
|
34712
|
+
/** ID of the desired thermostat device. */
|
|
34709
34713
|
device_id: string;
|
|
34714
|
+
/** 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`. */
|
|
34710
34715
|
cooling_set_point_celsius?: number | undefined;
|
|
34716
|
+
/** 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`. */
|
|
34711
34717
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
34712
34718
|
} | {
|
|
34719
|
+
/** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
|
|
34713
34720
|
hvac_mode: 'heat';
|
|
34721
|
+
/** ID of the desired thermostat device. */
|
|
34714
34722
|
device_id: string;
|
|
34723
|
+
/** 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`. */
|
|
34715
34724
|
heating_set_point_celsius?: number | undefined;
|
|
34725
|
+
/** 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`. */
|
|
34716
34726
|
heating_set_point_fahrenheit?: number | undefined;
|
|
34717
34727
|
} | {
|
|
34728
|
+
/** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
|
|
34718
34729
|
hvac_mode: 'heat_cool';
|
|
34730
|
+
/** ID of the desired thermostat device. */
|
|
34719
34731
|
device_id: string;
|
|
34732
|
+
/** 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`. */
|
|
34720
34733
|
cooling_set_point_celsius?: number | undefined;
|
|
34734
|
+
/** 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`. */
|
|
34721
34735
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
34736
|
+
/** 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`. */
|
|
34722
34737
|
heating_set_point_celsius?: number | undefined;
|
|
34738
|
+
/** 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`. */
|
|
34723
34739
|
heating_set_point_fahrenheit?: number | undefined;
|
|
34724
34740
|
};
|
|
34725
34741
|
commonParams: {};
|
|
@@ -34731,8 +34747,11 @@ export interface Routes {
|
|
|
34731
34747
|
method: 'POST';
|
|
34732
34748
|
queryParams: {};
|
|
34733
34749
|
jsonBody: {
|
|
34750
|
+
/** ID of the desired thermostat device. */
|
|
34734
34751
|
device_id: string;
|
|
34752
|
+
/** Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. */
|
|
34735
34753
|
temperature_celsius?: number | undefined;
|
|
34754
|
+
/** Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. */
|
|
34736
34755
|
temperature_fahrenheit?: number | undefined;
|
|
34737
34756
|
};
|
|
34738
34757
|
commonParams: {};
|
package/package.json
CHANGED
|
@@ -22150,6 +22150,7 @@ export default {
|
|
|
22150
22150
|
{ api_key: [] },
|
|
22151
22151
|
{ pat_with_workspace: [] },
|
|
22152
22152
|
{ console_session_with_workspace: [] },
|
|
22153
|
+
{ client_session: [] },
|
|
22153
22154
|
],
|
|
22154
22155
|
summary: '/devices/update',
|
|
22155
22156
|
tags: ['/devices'],
|
|
@@ -22207,6 +22208,7 @@ export default {
|
|
|
22207
22208
|
{ api_key: [] },
|
|
22208
22209
|
{ pat_with_workspace: [] },
|
|
22209
22210
|
{ console_session_with_workspace: [] },
|
|
22211
|
+
{ client_session: [] },
|
|
22210
22212
|
],
|
|
22211
22213
|
summary: '/devices/update',
|
|
22212
22214
|
tags: ['/devices'],
|
|
@@ -25716,6 +25718,8 @@ export default {
|
|
|
25716
25718
|
},
|
|
25717
25719
|
'/thermostats/simulate/hvac_mode_adjusted': {
|
|
25718
25720
|
post: {
|
|
25721
|
+
description:
|
|
25722
|
+
'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).',
|
|
25719
25723
|
operationId: 'thermostatsSimulateHvacModeAdjustedPost',
|
|
25720
25724
|
requestBody: {
|
|
25721
25725
|
content: {
|
|
@@ -25725,8 +25729,17 @@ export default {
|
|
|
25725
25729
|
oneOf: [
|
|
25726
25730
|
{
|
|
25727
25731
|
properties: {
|
|
25728
|
-
device_id: {
|
|
25729
|
-
|
|
25732
|
+
device_id: {
|
|
25733
|
+
description: 'ID of the desired thermostat device.',
|
|
25734
|
+
format: 'uuid',
|
|
25735
|
+
type: 'string',
|
|
25736
|
+
},
|
|
25737
|
+
hvac_mode: {
|
|
25738
|
+
description:
|
|
25739
|
+
'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
|
|
25740
|
+
enum: ['off'],
|
|
25741
|
+
type: 'string',
|
|
25742
|
+
},
|
|
25730
25743
|
},
|
|
25731
25744
|
required: ['hvac_mode', 'device_id'],
|
|
25732
25745
|
type: 'object',
|
|
@@ -25734,31 +25747,57 @@ export default {
|
|
|
25734
25747
|
{
|
|
25735
25748
|
properties: {
|
|
25736
25749
|
cooling_set_point_celsius: {
|
|
25750
|
+
description:
|
|
25751
|
+
'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`.',
|
|
25737
25752
|
format: 'float',
|
|
25738
25753
|
type: 'number',
|
|
25739
25754
|
},
|
|
25740
25755
|
cooling_set_point_fahrenheit: {
|
|
25756
|
+
description:
|
|
25757
|
+
'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`.',
|
|
25741
25758
|
format: 'float',
|
|
25742
25759
|
type: 'number',
|
|
25743
25760
|
},
|
|
25744
|
-
device_id: {
|
|
25745
|
-
|
|
25761
|
+
device_id: {
|
|
25762
|
+
description: 'ID of the desired thermostat device.',
|
|
25763
|
+
format: 'uuid',
|
|
25764
|
+
type: 'string',
|
|
25765
|
+
},
|
|
25766
|
+
hvac_mode: {
|
|
25767
|
+
description:
|
|
25768
|
+
'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
|
|
25769
|
+
enum: ['cool'],
|
|
25770
|
+
type: 'string',
|
|
25771
|
+
},
|
|
25746
25772
|
},
|
|
25747
25773
|
required: ['hvac_mode', 'device_id'],
|
|
25748
25774
|
type: 'object',
|
|
25749
25775
|
},
|
|
25750
25776
|
{
|
|
25751
25777
|
properties: {
|
|
25752
|
-
device_id: {
|
|
25778
|
+
device_id: {
|
|
25779
|
+
description: 'ID of the desired thermostat device.',
|
|
25780
|
+
format: 'uuid',
|
|
25781
|
+
type: 'string',
|
|
25782
|
+
},
|
|
25753
25783
|
heating_set_point_celsius: {
|
|
25784
|
+
description:
|
|
25785
|
+
'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`.',
|
|
25754
25786
|
format: 'float',
|
|
25755
25787
|
type: 'number',
|
|
25756
25788
|
},
|
|
25757
25789
|
heating_set_point_fahrenheit: {
|
|
25790
|
+
description:
|
|
25791
|
+
'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`.',
|
|
25758
25792
|
format: 'float',
|
|
25759
25793
|
type: 'number',
|
|
25760
25794
|
},
|
|
25761
|
-
hvac_mode: {
|
|
25795
|
+
hvac_mode: {
|
|
25796
|
+
description:
|
|
25797
|
+
'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
|
|
25798
|
+
enum: ['heat'],
|
|
25799
|
+
type: 'string',
|
|
25800
|
+
},
|
|
25762
25801
|
},
|
|
25763
25802
|
required: ['hvac_mode', 'device_id'],
|
|
25764
25803
|
type: 'object',
|
|
@@ -25766,23 +25805,40 @@ export default {
|
|
|
25766
25805
|
{
|
|
25767
25806
|
properties: {
|
|
25768
25807
|
cooling_set_point_celsius: {
|
|
25808
|
+
description:
|
|
25809
|
+
'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`.',
|
|
25769
25810
|
format: 'float',
|
|
25770
25811
|
type: 'number',
|
|
25771
25812
|
},
|
|
25772
25813
|
cooling_set_point_fahrenheit: {
|
|
25814
|
+
description:
|
|
25815
|
+
'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`.',
|
|
25773
25816
|
format: 'float',
|
|
25774
25817
|
type: 'number',
|
|
25775
25818
|
},
|
|
25776
|
-
device_id: {
|
|
25819
|
+
device_id: {
|
|
25820
|
+
description: 'ID of the desired thermostat device.',
|
|
25821
|
+
format: 'uuid',
|
|
25822
|
+
type: 'string',
|
|
25823
|
+
},
|
|
25777
25824
|
heating_set_point_celsius: {
|
|
25825
|
+
description:
|
|
25826
|
+
'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`.',
|
|
25778
25827
|
format: 'float',
|
|
25779
25828
|
type: 'number',
|
|
25780
25829
|
},
|
|
25781
25830
|
heating_set_point_fahrenheit: {
|
|
25831
|
+
description:
|
|
25832
|
+
'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`.',
|
|
25782
25833
|
format: 'float',
|
|
25783
25834
|
type: 'number',
|
|
25784
25835
|
},
|
|
25785
|
-
hvac_mode: {
|
|
25836
|
+
hvac_mode: {
|
|
25837
|
+
description:
|
|
25838
|
+
'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
|
|
25839
|
+
enum: ['heat_cool'],
|
|
25840
|
+
type: 'string',
|
|
25841
|
+
},
|
|
25786
25842
|
},
|
|
25787
25843
|
required: ['hvac_mode', 'device_id'],
|
|
25788
25844
|
type: 'object',
|
|
@@ -25818,19 +25874,36 @@ export default {
|
|
|
25818
25874
|
'x-fern-sdk-group-name': ['thermostats', 'simulate'],
|
|
25819
25875
|
'x-fern-sdk-method-name': 'hvac_mode_adjusted',
|
|
25820
25876
|
'x-response-key': null,
|
|
25877
|
+
'x-title': 'HVAC Mode Adjusted',
|
|
25821
25878
|
},
|
|
25822
25879
|
},
|
|
25823
25880
|
'/thermostats/simulate/temperature_reached': {
|
|
25824
25881
|
post: {
|
|
25882
|
+
description:
|
|
25883
|
+
'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).',
|
|
25825
25884
|
operationId: 'thermostatsSimulateTemperatureReachedPost',
|
|
25826
25885
|
requestBody: {
|
|
25827
25886
|
content: {
|
|
25828
25887
|
'application/json': {
|
|
25829
25888
|
schema: {
|
|
25830
25889
|
properties: {
|
|
25831
|
-
device_id: {
|
|
25832
|
-
|
|
25833
|
-
|
|
25890
|
+
device_id: {
|
|
25891
|
+
description: 'ID of the desired thermostat device.',
|
|
25892
|
+
format: 'uuid',
|
|
25893
|
+
type: 'string',
|
|
25894
|
+
},
|
|
25895
|
+
temperature_celsius: {
|
|
25896
|
+
description:
|
|
25897
|
+
'Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`.',
|
|
25898
|
+
format: 'float',
|
|
25899
|
+
type: 'number',
|
|
25900
|
+
},
|
|
25901
|
+
temperature_fahrenheit: {
|
|
25902
|
+
description:
|
|
25903
|
+
'Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`.',
|
|
25904
|
+
format: 'float',
|
|
25905
|
+
type: 'number',
|
|
25906
|
+
},
|
|
25834
25907
|
},
|
|
25835
25908
|
required: ['device_id'],
|
|
25836
25909
|
type: 'object',
|
|
@@ -25864,6 +25937,7 @@ export default {
|
|
|
25864
25937
|
'x-fern-sdk-group-name': ['thermostats', 'simulate'],
|
|
25865
25938
|
'x-fern-sdk-method-name': 'temperature_reached',
|
|
25866
25939
|
'x-response-key': null,
|
|
25940
|
+
'x-title': 'Temperature Reached',
|
|
25867
25941
|
},
|
|
25868
25942
|
},
|
|
25869
25943
|
'/thermostats/update_climate_preset': {
|
|
@@ -43226,27 +43226,43 @@ export interface Routes {
|
|
|
43226
43226
|
queryParams: {}
|
|
43227
43227
|
jsonBody:
|
|
43228
43228
|
| {
|
|
43229
|
+
/** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
|
|
43229
43230
|
hvac_mode: 'off'
|
|
43231
|
+
/** ID of the desired thermostat device. */
|
|
43230
43232
|
device_id: string
|
|
43231
43233
|
}
|
|
43232
43234
|
| {
|
|
43235
|
+
/** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
|
|
43233
43236
|
hvac_mode: 'cool'
|
|
43237
|
+
/** ID of the desired thermostat device. */
|
|
43234
43238
|
device_id: string
|
|
43239
|
+
/** 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`. */
|
|
43235
43240
|
cooling_set_point_celsius?: number | undefined
|
|
43241
|
+
/** 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`. */
|
|
43236
43242
|
cooling_set_point_fahrenheit?: number | undefined
|
|
43237
43243
|
}
|
|
43238
43244
|
| {
|
|
43245
|
+
/** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
|
|
43239
43246
|
hvac_mode: 'heat'
|
|
43247
|
+
/** ID of the desired thermostat device. */
|
|
43240
43248
|
device_id: string
|
|
43249
|
+
/** 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`. */
|
|
43241
43250
|
heating_set_point_celsius?: number | undefined
|
|
43251
|
+
/** 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`. */
|
|
43242
43252
|
heating_set_point_fahrenheit?: number | undefined
|
|
43243
43253
|
}
|
|
43244
43254
|
| {
|
|
43255
|
+
/** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
|
|
43245
43256
|
hvac_mode: 'heat_cool'
|
|
43257
|
+
/** ID of the desired thermostat device. */
|
|
43246
43258
|
device_id: string
|
|
43259
|
+
/** 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`. */
|
|
43247
43260
|
cooling_set_point_celsius?: number | undefined
|
|
43261
|
+
/** 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`. */
|
|
43248
43262
|
cooling_set_point_fahrenheit?: number | undefined
|
|
43263
|
+
/** 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`. */
|
|
43249
43264
|
heating_set_point_celsius?: number | undefined
|
|
43265
|
+
/** 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`. */
|
|
43250
43266
|
heating_set_point_fahrenheit?: number | undefined
|
|
43251
43267
|
}
|
|
43252
43268
|
commonParams: {}
|
|
@@ -43258,8 +43274,11 @@ export interface Routes {
|
|
|
43258
43274
|
method: 'POST'
|
|
43259
43275
|
queryParams: {}
|
|
43260
43276
|
jsonBody: {
|
|
43277
|
+
/** ID of the desired thermostat device. */
|
|
43261
43278
|
device_id: string
|
|
43279
|
+
/** Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. */
|
|
43262
43280
|
temperature_celsius?: number | undefined
|
|
43281
|
+
/** Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. */
|
|
43263
43282
|
temperature_fahrenheit?: number | undefined
|
|
43264
43283
|
}
|
|
43265
43284
|
commonParams: {}
|