@seamapi/http 2.31.0 → 2.33.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/lib/resources/access-code.d.ts +15 -15
- package/lib/resources/access-grant.d.ts +4 -4
- package/lib/resources/access-method.d.ts +9 -9
- package/lib/resources/acs-access-group.d.ts +3 -3
- package/lib/resources/acs-credential.d.ts +35 -35
- package/lib/resources/acs-encoder.d.ts +10 -10
- package/lib/resources/acs-entrance.d.ts +20 -20
- package/lib/resources/acs-system.d.ts +37 -37
- package/lib/resources/acs-user.d.ts +35 -35
- package/lib/resources/action-attempt.d.ts +101 -101
- package/lib/resources/client-session.d.ts +12 -12
- package/lib/resources/connect-webview.d.ts +6 -6
- package/lib/resources/connected-account.d.ts +8 -8
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +102 -85
- package/lib/resources/event.d.ts +10 -10
- package/lib/resources/noise-threshold.d.ts +2 -2
- package/lib/resources/phone.d.ts +1 -1
- package/lib/resources/thermostat-daily-program.d.ts +1 -1
- package/lib/resources/thermostat-schedule.d.ts +11 -11
- package/lib/resources/unmanaged-access-code.d.ts +12 -12
- package/lib/resources/unmanaged-access-grant.d.ts +4 -4
- package/lib/resources/unmanaged-access-method.d.ts +9 -9
- package/lib/resources/unmanaged-device.d.ts +11 -11
- package/lib/resources/user-identity.d.ts +1 -1
- package/lib/resources/webhook.d.ts +4 -4
- package/lib/resources/workspace.d.ts +12 -12
- package/lib/routes/access-codes/access-codes.d.ts +28 -28
- package/lib/routes/access-codes/access-codes.js +13 -13
- package/lib/routes/access-codes/simulate/simulate.d.ts +1 -1
- package/lib/routes/access-codes/simulate/simulate.js +1 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/access-codes/unmanaged/unmanaged.js +5 -5
- package/lib/routes/access-grants/access-grants.d.ts +3 -3
- package/lib/routes/access-grants/access-grants.js +1 -1
- package/lib/routes/access-methods/access-methods.d.ts +2 -2
- package/lib/routes/access-methods/access-methods.js +2 -2
- package/lib/routes/acs/access-groups/access-groups.d.ts +7 -7
- package/lib/routes/acs/access-groups/access-groups.js +7 -7
- package/lib/routes/acs/credentials/credentials.d.ts +12 -12
- package/lib/routes/acs/credentials/credentials.js +8 -8
- package/lib/routes/acs/encoders/encoders.d.ts +5 -5
- package/lib/routes/acs/encoders/encoders.js +5 -5
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +4 -4
- package/lib/routes/acs/encoders/simulate/simulate.js +4 -4
- package/lib/routes/acs/entrances/entrances.d.ts +5 -5
- package/lib/routes/acs/entrances/entrances.js +5 -5
- package/lib/routes/acs/systems/systems.d.ts +3 -3
- package/lib/routes/acs/systems/systems.js +3 -3
- package/lib/routes/acs/users/users.d.ts +16 -16
- package/lib/routes/acs/users/users.js +11 -11
- package/lib/routes/action-attempts/action-attempts.d.ts +2 -2
- package/lib/routes/action-attempts/action-attempts.js +2 -2
- package/lib/routes/client-sessions/client-sessions.d.ts +22 -22
- package/lib/routes/client-sessions/client-sessions.js +8 -8
- package/lib/routes/connect-webviews/connect-webviews.d.ts +12 -12
- package/lib/routes/connect-webviews/connect-webviews.js +5 -5
- package/lib/routes/connected-accounts/connected-accounts.d.ts +7 -7
- package/lib/routes/connected-accounts/connected-accounts.js +5 -5
- package/lib/routes/connected-accounts/simulate/simulate.d.ts +1 -1
- package/lib/routes/connected-accounts/simulate/simulate.js +1 -1
- package/lib/routes/devices/devices.d.ts +12 -12
- package/lib/routes/devices/devices.js +6 -6
- package/lib/routes/devices/simulate/simulate.d.ts +3 -3
- package/lib/routes/devices/simulate/simulate.js +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/devices/unmanaged/unmanaged.js +6 -6
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +2 -2
- package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
- package/lib/routes/instant-keys/instant-keys.js +3 -3
- package/lib/routes/locks/locks.d.ts +6 -6
- package/lib/routes/locks/locks.js +5 -5
- package/lib/routes/locks/simulate/simulate.d.ts +2 -2
- package/lib/routes/locks/simulate/simulate.js +2 -2
- package/lib/routes/noise-sensors/noise-sensors.d.ts +1 -1
- package/lib/routes/noise-sensors/noise-sensors.js +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +7 -7
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +5 -5
- package/lib/routes/noise-sensors/simulate/simulate.d.ts +1 -1
- package/lib/routes/noise-sensors/simulate/simulate.js +1 -1
- package/lib/routes/phones/phones.d.ts +4 -4
- package/lib/routes/phones/phones.js +3 -3
- package/lib/routes/phones/simulate/simulate.d.ts +1 -1
- package/lib/routes/phones/simulate/simulate.js +1 -1
- package/lib/routes/seam-http-endpoints-without-workspace.d.ts +2 -2
- package/lib/routes/seam-http-endpoints-without-workspace.js +2 -2
- package/lib/routes/seam-http-endpoints.d.ts +176 -176
- package/lib/routes/seam-http-endpoints.js +176 -176
- package/lib/routes/spaces/spaces.d.ts +4 -4
- package/lib/routes/spaces/spaces.js +4 -4
- package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
- package/lib/routes/thermostats/schedules/schedules.d.ts +11 -11
- package/lib/routes/thermostats/schedules/schedules.js +5 -5
- package/lib/routes/thermostats/simulate/simulate.d.ts +6 -6
- package/lib/routes/thermostats/simulate/simulate.js +2 -2
- package/lib/routes/thermostats/thermostats.d.ts +43 -43
- package/lib/routes/thermostats/thermostats.js +13 -13
- package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/user-identities/unmanaged/unmanaged.js +3 -3
- package/lib/routes/user-identities/user-identities.d.ts +15 -15
- package/lib/routes/user-identities/user-identities.js +15 -15
- package/lib/routes/webhooks/webhooks.d.ts +5 -5
- package/lib/routes/webhooks/webhooks.js +5 -5
- package/lib/routes/workspaces/workspaces.d.ts +16 -16
- package/lib/routes/workspaces/workspaces.js +5 -5
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-code.ts +15 -15
- package/src/lib/resources/access-grant.ts +4 -4
- package/src/lib/resources/access-method.ts +9 -9
- package/src/lib/resources/acs-access-group.ts +3 -3
- package/src/lib/resources/acs-credential.ts +35 -35
- package/src/lib/resources/acs-encoder.ts +10 -10
- package/src/lib/resources/acs-entrance.ts +20 -20
- package/src/lib/resources/acs-system.ts +37 -37
- package/src/lib/resources/acs-user.ts +35 -35
- package/src/lib/resources/action-attempt.ts +101 -101
- package/src/lib/resources/client-session.ts +12 -12
- package/src/lib/resources/connect-webview.ts +6 -6
- package/src/lib/resources/connected-account.ts +8 -8
- package/src/lib/resources/device-provider.ts +1 -0
- package/src/lib/resources/device.ts +104 -84
- package/src/lib/resources/event.ts +10 -10
- package/src/lib/resources/noise-threshold.ts +2 -2
- package/src/lib/resources/phone.ts +1 -1
- package/src/lib/resources/thermostat-daily-program.ts +1 -1
- package/src/lib/resources/thermostat-schedule.ts +11 -11
- package/src/lib/resources/unmanaged-access-code.ts +12 -12
- package/src/lib/resources/unmanaged-access-grant.ts +4 -4
- package/src/lib/resources/unmanaged-access-method.ts +9 -9
- package/src/lib/resources/unmanaged-device.ts +11 -10
- package/src/lib/resources/user-identity.ts +1 -1
- package/src/lib/resources/webhook.ts +4 -4
- package/src/lib/resources/workspace.ts +12 -12
- package/src/lib/routes/access-codes/access-codes.ts +28 -28
- package/src/lib/routes/access-codes/simulate/simulate.ts +1 -1
- package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +9 -9
- package/src/lib/routes/access-grants/access-grants.ts +3 -3
- package/src/lib/routes/access-methods/access-methods.ts +2 -2
- package/src/lib/routes/acs/access-groups/access-groups.ts +7 -7
- package/src/lib/routes/acs/credentials/credentials.ts +12 -12
- package/src/lib/routes/acs/encoders/encoders.ts +5 -5
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +4 -4
- package/src/lib/routes/acs/entrances/entrances.ts +5 -5
- package/src/lib/routes/acs/systems/systems.ts +3 -3
- package/src/lib/routes/acs/users/users.ts +16 -16
- package/src/lib/routes/action-attempts/action-attempts.ts +2 -2
- package/src/lib/routes/client-sessions/client-sessions.ts +22 -22
- package/src/lib/routes/connect-webviews/connect-webviews.ts +12 -11
- package/src/lib/routes/connected-accounts/connected-accounts.ts +7 -7
- package/src/lib/routes/connected-accounts/simulate/simulate.ts +1 -1
- package/src/lib/routes/devices/devices.ts +13 -9
- package/src/lib/routes/devices/simulate/simulate.ts +3 -3
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +10 -6
- package/src/lib/routes/events/events.ts +4 -4
- package/src/lib/routes/instant-keys/instant-keys.ts +3 -3
- package/src/lib/routes/locks/locks.ts +6 -5
- package/src/lib/routes/locks/simulate/simulate.ts +2 -2
- package/src/lib/routes/noise-sensors/noise-sensors.ts +1 -1
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +7 -7
- package/src/lib/routes/noise-sensors/simulate/simulate.ts +1 -1
- package/src/lib/routes/phones/phones.ts +4 -4
- package/src/lib/routes/phones/simulate/simulate.ts +1 -1
- package/src/lib/routes/seam-http-endpoints-without-workspace.ts +2 -2
- package/src/lib/routes/seam-http-endpoints.ts +176 -176
- package/src/lib/routes/spaces/spaces.ts +4 -4
- package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +2 -2
- package/src/lib/routes/thermostats/schedules/schedules.ts +11 -11
- package/src/lib/routes/thermostats/simulate/simulate.ts +6 -6
- package/src/lib/routes/thermostats/thermostats.ts +43 -43
- package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +3 -3
- package/src/lib/routes/user-identities/user-identities.ts +15 -15
- package/src/lib/routes/webhooks/webhooks.ts +5 -5
- package/src/lib/routes/workspaces/workspaces.ts +16 -16
- package/src/lib/version.ts +1 -1
|
@@ -18,11 +18,11 @@ export declare class SeamHttpSpaces {
|
|
|
18
18
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
19
19
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
20
20
|
/**
|
|
21
|
-
* Adds [entrances](https://
|
|
21
|
+
* Adds [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.
|
|
22
22
|
*/
|
|
23
23
|
addAcsEntrances(parameters: SpacesAddAcsEntrancesParameters, options?: SpacesAddAcsEntrancesOptions): SpacesAddAcsEntrancesRequest;
|
|
24
24
|
/**
|
|
25
|
-
* Adds a [connected account](https://
|
|
25
|
+
* Adds a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to a specific space.
|
|
26
26
|
*/
|
|
27
27
|
addConnectedAccount(parameters: SpacesAddConnectedAccountParameters, options?: SpacesAddConnectedAccountOptions): SpacesAddConnectedAccountRequest;
|
|
28
28
|
/**
|
|
@@ -50,11 +50,11 @@ export declare class SeamHttpSpaces {
|
|
|
50
50
|
*/
|
|
51
51
|
list(parameters?: SpacesListParameters, options?: SpacesListOptions): SpacesListRequest;
|
|
52
52
|
/**
|
|
53
|
-
* Removes [entrances](https://
|
|
53
|
+
* Removes [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.
|
|
54
54
|
*/
|
|
55
55
|
removeAcsEntrances(parameters: SpacesRemoveAcsEntrancesParameters, options?: SpacesRemoveAcsEntrancesOptions): SpacesRemoveAcsEntrancesRequest;
|
|
56
56
|
/**
|
|
57
|
-
* Removes a [connected account](https://
|
|
57
|
+
* Removes a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) from a specific space.
|
|
58
58
|
*/
|
|
59
59
|
removeConnectedAccount(parameters: SpacesRemoveConnectedAccountParameters, options?: SpacesRemoveConnectedAccountOptions): SpacesRemoveConnectedAccountRequest;
|
|
60
60
|
/**
|
|
@@ -83,7 +83,7 @@ export class SeamHttpSpaces {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Adds [entrances](https://
|
|
86
|
+
* Adds [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.
|
|
87
87
|
*/
|
|
88
88
|
addAcsEntrances(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -99,7 +99,7 @@ export class SeamHttpSpaces {
|
|
|
99
99
|
});
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* Adds a [connected account](https://
|
|
102
|
+
* Adds a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to a specific space.
|
|
103
103
|
*/
|
|
104
104
|
addConnectedAccount(parameters, options = {}) {
|
|
105
105
|
return new SeamHttpRequest(this, {
|
|
@@ -217,7 +217,7 @@ export class SeamHttpSpaces {
|
|
|
217
217
|
});
|
|
218
218
|
}
|
|
219
219
|
/**
|
|
220
|
-
* Removes [entrances](https://
|
|
220
|
+
* Removes [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.
|
|
221
221
|
*/
|
|
222
222
|
removeAcsEntrances(parameters, options = {}) {
|
|
223
223
|
return new SeamHttpRequest(this, {
|
|
@@ -233,7 +233,7 @@ export class SeamHttpSpaces {
|
|
|
233
233
|
});
|
|
234
234
|
}
|
|
235
235
|
/**
|
|
236
|
-
* Removes a [connected account](https://
|
|
236
|
+
* Removes a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) from a specific space.
|
|
237
237
|
*/
|
|
238
238
|
removeConnectedAccount(parameters, options = {}) {
|
|
239
239
|
return new SeamHttpRequest(this, {
|
|
@@ -43,7 +43,7 @@ export type ThermostatsDailyProgramsCreateParameters = {
|
|
|
43
43
|
*/
|
|
44
44
|
periods: Array<{
|
|
45
45
|
/**
|
|
46
|
-
* Key of the [climate preset](https://
|
|
46
|
+
* Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.
|
|
47
47
|
*/
|
|
48
48
|
climate_preset_key?: string | undefined;
|
|
49
49
|
/**
|
|
@@ -84,7 +84,7 @@ export type ThermostatsDailyProgramsUpdateParameters = {
|
|
|
84
84
|
*/
|
|
85
85
|
periods: Array<{
|
|
86
86
|
/**
|
|
87
|
-
* Key of the [climate preset](https://
|
|
87
|
+
* Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.
|
|
88
88
|
*/
|
|
89
89
|
climate_preset_key?: string | undefined;
|
|
90
90
|
/**
|
|
@@ -16,29 +16,29 @@ export declare class SeamHttpThermostatsSchedules {
|
|
|
16
16
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
17
17
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
18
18
|
/**
|
|
19
|
-
* Creates a new [thermostat schedule](https://
|
|
19
|
+
* Creates a new [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
20
20
|
*/
|
|
21
21
|
create(parameters: ThermostatsSchedulesCreateParameters, options?: ThermostatsSchedulesCreateOptions): ThermostatsSchedulesCreateRequest;
|
|
22
22
|
/**
|
|
23
|
-
* Deletes a [thermostat schedule](https://
|
|
23
|
+
* Deletes a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
24
24
|
*/
|
|
25
25
|
delete(parameters: ThermostatsSchedulesDeleteParameters, options?: ThermostatsSchedulesDeleteOptions): ThermostatsSchedulesDeleteRequest;
|
|
26
26
|
/**
|
|
27
|
-
* Returns a specified [thermostat schedule](https://
|
|
27
|
+
* Returns a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
28
28
|
*/
|
|
29
29
|
get(parameters: ThermostatsSchedulesGetParameters, options?: ThermostatsSchedulesGetOptions): ThermostatsSchedulesGetRequest;
|
|
30
30
|
/**
|
|
31
|
-
* Returns a list of all [thermostat schedules](https://
|
|
31
|
+
* Returns a list of all [thermostat schedules](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
32
32
|
*/
|
|
33
33
|
list(parameters: ThermostatsSchedulesListParameters, options?: ThermostatsSchedulesListOptions): ThermostatsSchedulesListRequest;
|
|
34
34
|
/**
|
|
35
|
-
* Updates a specified [thermostat schedule](https://
|
|
35
|
+
* Updates a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
36
36
|
*/
|
|
37
37
|
update(parameters: ThermostatsSchedulesUpdateParameters, options?: ThermostatsSchedulesUpdateOptions): ThermostatsSchedulesUpdateRequest;
|
|
38
38
|
}
|
|
39
39
|
export type ThermostatsSchedulesCreateParameters = {
|
|
40
40
|
/**
|
|
41
|
-
* Key of the [climate preset](https://
|
|
41
|
+
* Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule.
|
|
42
42
|
*/
|
|
43
43
|
climate_preset_key: string;
|
|
44
44
|
/**
|
|
@@ -50,11 +50,11 @@ export type ThermostatsSchedulesCreateParameters = {
|
|
|
50
50
|
*/
|
|
51
51
|
ends_at: string;
|
|
52
52
|
/**
|
|
53
|
-
* Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://
|
|
53
|
+
* Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
54
54
|
*/
|
|
55
55
|
is_override_allowed?: boolean | undefined;
|
|
56
56
|
/**
|
|
57
|
-
* Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://
|
|
57
|
+
* Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
58
58
|
*/
|
|
59
59
|
max_override_period_minutes?: number | null | undefined;
|
|
60
60
|
/**
|
|
@@ -124,7 +124,7 @@ export interface ThermostatsSchedulesListOptions {
|
|
|
124
124
|
}
|
|
125
125
|
export type ThermostatsSchedulesUpdateParameters = {
|
|
126
126
|
/**
|
|
127
|
-
* Key of the [climate preset](https://
|
|
127
|
+
* Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.
|
|
128
128
|
*/
|
|
129
129
|
climate_preset_key?: string | undefined;
|
|
130
130
|
/**
|
|
@@ -132,11 +132,11 @@ export type ThermostatsSchedulesUpdateParameters = {
|
|
|
132
132
|
*/
|
|
133
133
|
ends_at?: string | undefined;
|
|
134
134
|
/**
|
|
135
|
-
* Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://
|
|
135
|
+
* Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
136
136
|
*/
|
|
137
137
|
is_override_allowed?: boolean | undefined;
|
|
138
138
|
/**
|
|
139
|
-
* Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://
|
|
139
|
+
* Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
140
140
|
*/
|
|
141
141
|
max_override_period_minutes?: number | null | undefined;
|
|
142
142
|
/**
|
|
@@ -83,7 +83,7 @@ export class SeamHttpThermostatsSchedules {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Creates a new [thermostat schedule](https://
|
|
86
|
+
* Creates a new [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
87
87
|
*/
|
|
88
88
|
create(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -104,7 +104,7 @@ export class SeamHttpThermostatsSchedules {
|
|
|
104
104
|
});
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
|
-
* Deletes a [thermostat schedule](https://
|
|
107
|
+
* Deletes a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
108
108
|
*/
|
|
109
109
|
delete(parameters, options = {}) {
|
|
110
110
|
return new SeamHttpRequest(this, {
|
|
@@ -120,7 +120,7 @@ export class SeamHttpThermostatsSchedules {
|
|
|
120
120
|
});
|
|
121
121
|
}
|
|
122
122
|
/**
|
|
123
|
-
* Returns a specified [thermostat schedule](https://
|
|
123
|
+
* Returns a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
124
124
|
*/
|
|
125
125
|
get(parameters, options = {}) {
|
|
126
126
|
return new SeamHttpRequest(this, {
|
|
@@ -136,7 +136,7 @@ export class SeamHttpThermostatsSchedules {
|
|
|
136
136
|
});
|
|
137
137
|
}
|
|
138
138
|
/**
|
|
139
|
-
* Returns a list of all [thermostat schedules](https://
|
|
139
|
+
* Returns a list of all [thermostat schedules](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
140
140
|
*/
|
|
141
141
|
list(parameters, options = {}) {
|
|
142
142
|
return new SeamHttpRequest(this, {
|
|
@@ -152,7 +152,7 @@ export class SeamHttpThermostatsSchedules {
|
|
|
152
152
|
});
|
|
153
153
|
}
|
|
154
154
|
/**
|
|
155
|
-
* Updates a specified [thermostat schedule](https://
|
|
155
|
+
* Updates a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
156
156
|
*/
|
|
157
157
|
update(parameters, options = {}) {
|
|
158
158
|
return new SeamHttpRequest(this, {
|
|
@@ -15,21 +15,21 @@ export declare class SeamHttpThermostatsSimulate {
|
|
|
15
15
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
16
16
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
17
17
|
/**
|
|
18
|
-
* Simulates having adjusted the [HVAC mode](https://
|
|
18
|
+
* Simulates having adjusted the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://www.seam.co/docs/capability-guides/thermostats). Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
|
|
19
19
|
*/
|
|
20
20
|
hvacModeAdjusted(parameters: ThermostatsSimulateHvacModeAdjustedParameters, options?: ThermostatsSimulateHvacModeAdjustedOptions): ThermostatsSimulateHvacModeAdjustedRequest;
|
|
21
21
|
/**
|
|
22
|
-
* Simulates a [thermostat](https://
|
|
22
|
+
* Simulates a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
|
|
23
23
|
*/
|
|
24
24
|
temperatureReached(parameters: ThermostatsSimulateTemperatureReachedParameters, options?: ThermostatsSimulateTemperatureReachedOptions): ThermostatsSimulateTemperatureReachedRequest;
|
|
25
25
|
}
|
|
26
26
|
export type ThermostatsSimulateHvacModeAdjustedParameters = {
|
|
27
27
|
/**
|
|
28
|
-
* Cooling [set point](https://
|
|
28
|
+
* Cooling [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.
|
|
29
29
|
*/
|
|
30
30
|
cooling_set_point_celsius?: number | undefined;
|
|
31
31
|
/**
|
|
32
|
-
* Cooling [set point](https://
|
|
32
|
+
* Cooling [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.
|
|
33
33
|
*/
|
|
34
34
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
35
35
|
/**
|
|
@@ -37,11 +37,11 @@ export type ThermostatsSimulateHvacModeAdjustedParameters = {
|
|
|
37
37
|
*/
|
|
38
38
|
device_id: string;
|
|
39
39
|
/**
|
|
40
|
-
* Heating [set point](https://
|
|
40
|
+
* Heating [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.
|
|
41
41
|
*/
|
|
42
42
|
heating_set_point_celsius?: number | undefined;
|
|
43
43
|
/**
|
|
44
|
-
* Heating [set point](https://
|
|
44
|
+
* Heating [set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.
|
|
45
45
|
*/
|
|
46
46
|
heating_set_point_fahrenheit?: number | undefined;
|
|
47
47
|
/**
|
|
@@ -83,7 +83,7 @@ export class SeamHttpThermostatsSimulate {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Simulates having adjusted the [HVAC mode](https://
|
|
86
|
+
* Simulates having adjusted the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://www.seam.co/docs/capability-guides/thermostats). Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
|
|
87
87
|
*/
|
|
88
88
|
hvacModeAdjusted(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -99,7 +99,7 @@ export class SeamHttpThermostatsSimulate {
|
|
|
99
99
|
});
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* Simulates a [thermostat](https://
|
|
102
|
+
* Simulates a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
|
|
103
103
|
*/
|
|
104
104
|
temperatureReached(parameters, options = {}) {
|
|
105
105
|
return new SeamHttpRequest(this, {
|
|
@@ -23,55 +23,55 @@ export declare class SeamHttpThermostats {
|
|
|
23
23
|
get schedules(): SeamHttpThermostatsSchedules;
|
|
24
24
|
get simulate(): SeamHttpThermostatsSimulate;
|
|
25
25
|
/**
|
|
26
|
-
* Activates a specified [climate preset](https://
|
|
26
|
+
* Activates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
27
27
|
*/
|
|
28
28
|
activateClimatePreset(parameters: ThermostatsActivateClimatePresetParameters, options?: ThermostatsActivateClimatePresetOptions): ThermostatsActivateClimatePresetRequest;
|
|
29
29
|
/**
|
|
30
|
-
* Sets a specified [thermostat](https://
|
|
30
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [cool mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
31
31
|
*/
|
|
32
32
|
cool(parameters: ThermostatsCoolParameters, options?: ThermostatsCoolOptions): ThermostatsCoolRequest;
|
|
33
33
|
/**
|
|
34
|
-
* Creates a [climate preset](https://
|
|
34
|
+
* Creates a [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
35
35
|
*/
|
|
36
36
|
createClimatePreset(parameters: ThermostatsCreateClimatePresetParameters, options?: ThermostatsCreateClimatePresetOptions): ThermostatsCreateClimatePresetRequest;
|
|
37
37
|
/**
|
|
38
|
-
* Deletes a specified [climate preset](https://
|
|
38
|
+
* Deletes a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
39
39
|
*/
|
|
40
40
|
deleteClimatePreset(parameters: ThermostatsDeleteClimatePresetParameters, options?: ThermostatsDeleteClimatePresetOptions): ThermostatsDeleteClimatePresetRequest;
|
|
41
41
|
/**
|
|
42
|
-
* Sets a specified [thermostat](https://
|
|
42
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
43
43
|
*/
|
|
44
44
|
heat(parameters: ThermostatsHeatParameters, options?: ThermostatsHeatOptions): ThermostatsHeatRequest;
|
|
45
45
|
/**
|
|
46
|
-
* Sets a specified [thermostat](https://
|
|
46
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat-cool ("auto") mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
47
47
|
*/
|
|
48
48
|
heatCool(parameters: ThermostatsHeatCoolParameters, options?: ThermostatsHeatCoolOptions): ThermostatsHeatCoolRequest;
|
|
49
49
|
/**
|
|
50
|
-
* Returns a list of all [thermostats](https://
|
|
50
|
+
* Returns a list of all [thermostats](https://www.seam.co/docs/capability-guides/thermostats).
|
|
51
51
|
*/
|
|
52
52
|
list(parameters?: ThermostatsListParameters, options?: ThermostatsListOptions): ThermostatsListRequest;
|
|
53
53
|
/**
|
|
54
|
-
* Sets a specified [thermostat](https://
|
|
54
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to ["off" mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
55
55
|
*/
|
|
56
56
|
off(parameters: ThermostatsOffParameters, options?: ThermostatsOffOptions): ThermostatsOffRequest;
|
|
57
57
|
/**
|
|
58
|
-
* Sets a specified [climate preset](https://
|
|
58
|
+
* Sets a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
59
59
|
*/
|
|
60
60
|
setFallbackClimatePreset(parameters: ThermostatsSetFallbackClimatePresetParameters, options?: ThermostatsSetFallbackClimatePresetOptions): ThermostatsSetFallbackClimatePresetRequest;
|
|
61
61
|
/**
|
|
62
|
-
* Sets the [fan mode setting](https://
|
|
62
|
+
* Sets the [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
63
63
|
*/
|
|
64
64
|
setFanMode(parameters: ThermostatsSetFanModeParameters, options?: ThermostatsSetFanModeOptions): ThermostatsSetFanModeRequest;
|
|
65
65
|
/**
|
|
66
|
-
* Sets the [HVAC mode](https://
|
|
66
|
+
* Sets the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
67
67
|
*/
|
|
68
68
|
setHvacMode(parameters: ThermostatsSetHvacModeParameters, options?: ThermostatsSetHvacModeOptions): ThermostatsSetHvacModeRequest;
|
|
69
69
|
/**
|
|
70
|
-
* Sets a [temperature threshold](https://
|
|
70
|
+
* Sets a [temperature threshold](https://www.seam.co/docs/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.
|
|
71
71
|
*/
|
|
72
72
|
setTemperatureThreshold(parameters: ThermostatsSetTemperatureThresholdParameters, options?: ThermostatsSetTemperatureThresholdOptions): ThermostatsSetTemperatureThresholdRequest;
|
|
73
73
|
/**
|
|
74
|
-
* Updates a specified [climate preset](https://
|
|
74
|
+
* Updates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
75
75
|
*/
|
|
76
76
|
updateClimatePreset(parameters: ThermostatsUpdateClimatePresetParameters, options?: ThermostatsUpdateClimatePresetOptions): ThermostatsUpdateClimatePresetRequest;
|
|
77
77
|
/**
|
|
@@ -99,11 +99,11 @@ export type ThermostatsActivateClimatePresetRequest = SeamHttpRequest<Thermostat
|
|
|
99
99
|
export type ThermostatsActivateClimatePresetOptions = Pick<SeamHttpRequestOptions, 'waitForActionAttempt'>;
|
|
100
100
|
export type ThermostatsCoolParameters = {
|
|
101
101
|
/**
|
|
102
|
-
* [Cooling set point](https://
|
|
102
|
+
* [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
|
|
103
103
|
*/
|
|
104
104
|
cooling_set_point_celsius?: number | undefined;
|
|
105
105
|
/**
|
|
106
|
-
* [Cooling set point](https://
|
|
106
|
+
* [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
|
|
107
107
|
*/
|
|
108
108
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
109
109
|
/**
|
|
@@ -121,7 +121,7 @@ export type ThermostatsCoolRequest = SeamHttpRequest<ThermostatsCoolResponse, 'a
|
|
|
121
121
|
export type ThermostatsCoolOptions = Pick<SeamHttpRequestOptions, 'waitForActionAttempt'>;
|
|
122
122
|
export type ThermostatsCreateClimatePresetParameters = {
|
|
123
123
|
/**
|
|
124
|
-
* Unique key to identify the [climate preset](https://
|
|
124
|
+
* Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
125
125
|
*/
|
|
126
126
|
climate_preset_key: string;
|
|
127
127
|
/**
|
|
@@ -129,11 +129,11 @@ export type ThermostatsCreateClimatePresetParameters = {
|
|
|
129
129
|
*/
|
|
130
130
|
climate_preset_mode?: 'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied' | undefined;
|
|
131
131
|
/**
|
|
132
|
-
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
132
|
+
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
133
133
|
*/
|
|
134
134
|
cooling_set_point_celsius?: number | undefined;
|
|
135
135
|
/**
|
|
136
|
-
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
136
|
+
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
137
137
|
*/
|
|
138
138
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
139
139
|
/**
|
|
@@ -158,19 +158,19 @@ export type ThermostatsCreateClimatePresetParameters = {
|
|
|
158
158
|
owner?: 'user' | 'system' | undefined;
|
|
159
159
|
} | undefined;
|
|
160
160
|
/**
|
|
161
|
-
* Desired [fan mode setting](https://
|
|
161
|
+
* Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
|
|
162
162
|
*/
|
|
163
163
|
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined;
|
|
164
164
|
/**
|
|
165
|
-
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
165
|
+
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
166
166
|
*/
|
|
167
167
|
heating_set_point_celsius?: number | undefined;
|
|
168
168
|
/**
|
|
169
|
-
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
169
|
+
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
170
170
|
*/
|
|
171
171
|
heating_set_point_fahrenheit?: number | undefined;
|
|
172
172
|
/**
|
|
173
|
-
* Desired [HVAC mode](https://
|
|
173
|
+
* Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
|
|
174
174
|
*/
|
|
175
175
|
hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
|
|
176
176
|
/**
|
|
@@ -179,7 +179,7 @@ export type ThermostatsCreateClimatePresetParameters = {
|
|
|
179
179
|
*/
|
|
180
180
|
manual_override_allowed?: boolean | undefined;
|
|
181
181
|
/**
|
|
182
|
-
* User-friendly name to identify the [climate preset](https://
|
|
182
|
+
* User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
183
183
|
*/
|
|
184
184
|
name?: string | null | undefined;
|
|
185
185
|
};
|
|
@@ -213,11 +213,11 @@ export type ThermostatsHeatParameters = {
|
|
|
213
213
|
*/
|
|
214
214
|
device_id: string;
|
|
215
215
|
/**
|
|
216
|
-
* [Heating set point](https://
|
|
216
|
+
* [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
|
|
217
217
|
*/
|
|
218
218
|
heating_set_point_celsius?: number | undefined;
|
|
219
219
|
/**
|
|
220
|
-
* [Heating set point](https://
|
|
220
|
+
* [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
|
|
221
221
|
*/
|
|
222
222
|
heating_set_point_fahrenheit?: number | undefined;
|
|
223
223
|
};
|
|
@@ -231,11 +231,11 @@ export type ThermostatsHeatRequest = SeamHttpRequest<ThermostatsHeatResponse, 'a
|
|
|
231
231
|
export type ThermostatsHeatOptions = Pick<SeamHttpRequestOptions, 'waitForActionAttempt'>;
|
|
232
232
|
export type ThermostatsHeatCoolParameters = {
|
|
233
233
|
/**
|
|
234
|
-
* [Cooling set point](https://
|
|
234
|
+
* [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
|
|
235
235
|
*/
|
|
236
236
|
cooling_set_point_celsius?: number | undefined;
|
|
237
237
|
/**
|
|
238
|
-
* [Cooling set point](https://
|
|
238
|
+
* [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
|
|
239
239
|
*/
|
|
240
240
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
241
241
|
/**
|
|
@@ -243,11 +243,11 @@ export type ThermostatsHeatCoolParameters = {
|
|
|
243
243
|
*/
|
|
244
244
|
device_id: string;
|
|
245
245
|
/**
|
|
246
|
-
* [Heating set point](https://
|
|
246
|
+
* [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
|
|
247
247
|
*/
|
|
248
248
|
heating_set_point_celsius?: number | undefined;
|
|
249
249
|
/**
|
|
250
|
-
* [Heating set point](https://
|
|
250
|
+
* [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
|
|
251
251
|
*/
|
|
252
252
|
heating_set_point_fahrenheit?: number | undefined;
|
|
253
253
|
};
|
|
@@ -336,7 +336,7 @@ export type ThermostatsSetFanModeParameters = {
|
|
|
336
336
|
*/
|
|
337
337
|
fan_mode?: 'auto' | 'on' | 'circulate' | undefined;
|
|
338
338
|
/**
|
|
339
|
-
* [Fan mode setting](https://
|
|
339
|
+
* [Fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat.
|
|
340
340
|
*/
|
|
341
341
|
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined;
|
|
342
342
|
};
|
|
@@ -350,11 +350,11 @@ export type ThermostatsSetFanModeRequest = SeamHttpRequest<ThermostatsSetFanMode
|
|
|
350
350
|
export type ThermostatsSetFanModeOptions = Pick<SeamHttpRequestOptions, 'waitForActionAttempt'>;
|
|
351
351
|
export type ThermostatsSetHvacModeParameters = {
|
|
352
352
|
/**
|
|
353
|
-
* [Cooling set point](https://
|
|
353
|
+
* [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
|
|
354
354
|
*/
|
|
355
355
|
cooling_set_point_celsius?: number | undefined;
|
|
356
356
|
/**
|
|
357
|
-
* [Cooling set point](https://
|
|
357
|
+
* [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
|
|
358
358
|
*/
|
|
359
359
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
360
360
|
/**
|
|
@@ -362,11 +362,11 @@ export type ThermostatsSetHvacModeParameters = {
|
|
|
362
362
|
*/
|
|
363
363
|
device_id: string;
|
|
364
364
|
/**
|
|
365
|
-
* [Heating set point](https://
|
|
365
|
+
* [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
|
|
366
366
|
*/
|
|
367
367
|
heating_set_point_celsius?: number | undefined;
|
|
368
368
|
/**
|
|
369
|
-
* [Heating set point](https://
|
|
369
|
+
* [Heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
|
|
370
370
|
*/
|
|
371
371
|
heating_set_point_fahrenheit?: number | undefined;
|
|
372
372
|
hvac_mode_setting: 'off' | 'cool' | 'heat' | 'heat_cool' | 'eco';
|
|
@@ -410,7 +410,7 @@ export interface ThermostatsSetTemperatureThresholdOptions {
|
|
|
410
410
|
}
|
|
411
411
|
export type ThermostatsUpdateClimatePresetParameters = {
|
|
412
412
|
/**
|
|
413
|
-
* Unique key to identify the [climate preset](https://
|
|
413
|
+
* Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
414
414
|
*/
|
|
415
415
|
climate_preset_key: string;
|
|
416
416
|
/**
|
|
@@ -418,11 +418,11 @@ export type ThermostatsUpdateClimatePresetParameters = {
|
|
|
418
418
|
*/
|
|
419
419
|
climate_preset_mode?: 'home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied' | undefined;
|
|
420
420
|
/**
|
|
421
|
-
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
421
|
+
* Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
422
422
|
*/
|
|
423
423
|
cooling_set_point_celsius?: number | undefined;
|
|
424
424
|
/**
|
|
425
|
-
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
425
|
+
* Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
426
426
|
*/
|
|
427
427
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
428
428
|
/**
|
|
@@ -447,28 +447,28 @@ export type ThermostatsUpdateClimatePresetParameters = {
|
|
|
447
447
|
owner?: 'user' | 'system' | undefined;
|
|
448
448
|
} | undefined;
|
|
449
449
|
/**
|
|
450
|
-
* Desired [fan mode setting](https://
|
|
450
|
+
* Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
|
|
451
451
|
*/
|
|
452
452
|
fan_mode_setting?: 'auto' | 'on' | 'circulate' | undefined;
|
|
453
453
|
/**
|
|
454
|
-
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
454
|
+
* Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
455
455
|
*/
|
|
456
456
|
heating_set_point_celsius?: number | undefined;
|
|
457
457
|
/**
|
|
458
|
-
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
458
|
+
* Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
459
459
|
*/
|
|
460
460
|
heating_set_point_fahrenheit?: number | undefined;
|
|
461
461
|
/**
|
|
462
|
-
* Desired [HVAC mode](https://
|
|
462
|
+
* Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
|
|
463
463
|
*/
|
|
464
464
|
hvac_mode_setting?: 'off' | 'heat' | 'cool' | 'heat_cool' | 'eco' | undefined;
|
|
465
465
|
/**
|
|
466
|
-
* Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://
|
|
466
|
+
* Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
467
467
|
* @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
468
468
|
*/
|
|
469
469
|
manual_override_allowed?: boolean | undefined;
|
|
470
470
|
/**
|
|
471
|
-
* User-friendly name to identify the [climate preset](https://
|
|
471
|
+
* User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
472
472
|
*/
|
|
473
473
|
name?: string | null | undefined;
|
|
474
474
|
};
|