@seamapi/types 1.395.3 → 1.396.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 +244 -254
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2057 -3172
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +0 -53
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +0 -23
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
- package/lib/seam/connect/models/devices/device-provider.js +2 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-program.js +16 -6
- package/lib/seam/connect/models/thermostats/thermostat-program.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +193 -206
- package/lib/seam/connect/openapi.js +219 -222
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1863 -2966
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +0 -35
- package/src/lib/seam/connect/models/devices/device-provider.ts +2 -0
- package/src/lib/seam/connect/models/thermostats/thermostat-program.ts +29 -15
- package/src/lib/seam/connect/openapi.ts +268 -231
- package/src/lib/seam/connect/route-types.ts +4677 -5965
|
@@ -8465,6 +8465,7 @@ export default {
|
|
|
8465
8465
|
},
|
|
8466
8466
|
thermostat_daily_programs: {
|
|
8467
8467
|
items: {
|
|
8468
|
+
description: 'Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.',
|
|
8468
8469
|
properties: {
|
|
8469
8470
|
created_at: {
|
|
8470
8471
|
description: 'Date and time at which the thermostat daily program was created.',
|
|
@@ -8472,7 +8473,7 @@ export default {
|
|
|
8472
8473
|
type: 'string',
|
|
8473
8474
|
},
|
|
8474
8475
|
device_id: {
|
|
8475
|
-
description: 'ID of the
|
|
8476
|
+
description: 'ID of the thermostat device on which the thermostat daily program is configured.',
|
|
8476
8477
|
format: 'uuid',
|
|
8477
8478
|
type: 'string',
|
|
8478
8479
|
},
|
|
@@ -8484,13 +8485,14 @@ export default {
|
|
|
8484
8485
|
periods: {
|
|
8485
8486
|
description: 'Array of thermostat daily program periods.',
|
|
8486
8487
|
items: {
|
|
8488
|
+
description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
|
|
8487
8489
|
properties: {
|
|
8488
8490
|
climate_preset_key: {
|
|
8489
|
-
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time
|
|
8491
|
+
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
|
|
8490
8492
|
type: 'string',
|
|
8491
8493
|
},
|
|
8492
8494
|
starts_at_time: {
|
|
8493
|
-
description: 'Time at which the thermostat daily program
|
|
8495
|
+
description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
8494
8496
|
pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
|
|
8495
8497
|
type: 'string',
|
|
8496
8498
|
},
|
|
@@ -8523,6 +8525,7 @@ export default {
|
|
|
8523
8525
|
'created_at',
|
|
8524
8526
|
],
|
|
8525
8527
|
type: 'object',
|
|
8528
|
+
'x-route-path': '/thermostats/thermostat_daily_programs',
|
|
8526
8529
|
},
|
|
8527
8530
|
type: 'array',
|
|
8528
8531
|
},
|
|
@@ -8929,6 +8932,7 @@ export default {
|
|
|
8929
8932
|
'tado',
|
|
8930
8933
|
'salto_space',
|
|
8931
8934
|
'sensi',
|
|
8935
|
+
'kwikset2',
|
|
8932
8936
|
],
|
|
8933
8937
|
type: 'string',
|
|
8934
8938
|
},
|
|
@@ -19186,6 +19190,11 @@ export default {
|
|
|
19186
19190
|
format: 'uuid',
|
|
19187
19191
|
type: 'string',
|
|
19188
19192
|
},
|
|
19193
|
+
user_identity_id: {
|
|
19194
|
+
description: 'ID of the user identity for which you want to retrieve all access groups.',
|
|
19195
|
+
format: 'uuid',
|
|
19196
|
+
type: 'string',
|
|
19197
|
+
},
|
|
19189
19198
|
},
|
|
19190
19199
|
type: 'object',
|
|
19191
19200
|
},
|
|
@@ -23403,6 +23412,7 @@ export default {
|
|
|
23403
23412
|
'tado',
|
|
23404
23413
|
'salto_space',
|
|
23405
23414
|
'sensi',
|
|
23415
|
+
'kwikset2',
|
|
23406
23416
|
'yale_access',
|
|
23407
23417
|
'hid_cm',
|
|
23408
23418
|
'google_nest',
|
|
@@ -23763,6 +23773,10 @@ export default {
|
|
|
23763
23773
|
description: 'Returns accounts whose custom_metadata contains all of the provided key/value pairs.',
|
|
23764
23774
|
type: 'object',
|
|
23765
23775
|
},
|
|
23776
|
+
customer_ids: {
|
|
23777
|
+
items: { format: 'uuid', type: 'string' },
|
|
23778
|
+
type: 'array',
|
|
23779
|
+
},
|
|
23766
23780
|
limit: {
|
|
23767
23781
|
default: 11000,
|
|
23768
23782
|
description: 'Maximum number of records to return per page.',
|
|
@@ -24012,6 +24026,10 @@ export default {
|
|
|
24012
24026
|
description: 'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.',
|
|
24013
24027
|
type: 'object',
|
|
24014
24028
|
},
|
|
24029
|
+
customer_ids: {
|
|
24030
|
+
items: { format: 'uuid', type: 'string' },
|
|
24031
|
+
type: 'array',
|
|
24032
|
+
},
|
|
24015
24033
|
device_ids: {
|
|
24016
24034
|
description: 'Array of device IDs by which to filter devices.',
|
|
24017
24035
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -24203,19 +24221,20 @@ export default {
|
|
|
24203
24221
|
'unknown',
|
|
24204
24222
|
'wyze',
|
|
24205
24223
|
'yale',
|
|
24206
|
-
'minut',
|
|
24207
24224
|
'two_n',
|
|
24208
24225
|
'ttlock',
|
|
24209
|
-
'nest',
|
|
24210
24226
|
'igloohome',
|
|
24211
|
-
'ecobee',
|
|
24212
24227
|
'hubitat',
|
|
24213
24228
|
'controlbyweb',
|
|
24214
24229
|
'smartthings',
|
|
24215
24230
|
'dormakaba_oracode',
|
|
24216
24231
|
'tedee',
|
|
24217
|
-
'honeywell_resideo',
|
|
24218
24232
|
'akiles',
|
|
24233
|
+
'ecobee',
|
|
24234
|
+
'honeywell_resideo',
|
|
24235
|
+
'minut',
|
|
24236
|
+
'nest',
|
|
24237
|
+
'noiseaware',
|
|
24219
24238
|
'tado',
|
|
24220
24239
|
'sensi',
|
|
24221
24240
|
],
|
|
@@ -24550,6 +24569,10 @@ export default {
|
|
|
24550
24569
|
description: 'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.',
|
|
24551
24570
|
type: 'object',
|
|
24552
24571
|
},
|
|
24572
|
+
customer_ids: {
|
|
24573
|
+
items: { format: 'uuid', type: 'string' },
|
|
24574
|
+
type: 'array',
|
|
24575
|
+
},
|
|
24553
24576
|
device_ids: {
|
|
24554
24577
|
description: 'Array of device IDs by which to filter devices.',
|
|
24555
24578
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -24741,19 +24764,20 @@ export default {
|
|
|
24741
24764
|
'unknown',
|
|
24742
24765
|
'wyze',
|
|
24743
24766
|
'yale',
|
|
24744
|
-
'minut',
|
|
24745
24767
|
'two_n',
|
|
24746
24768
|
'ttlock',
|
|
24747
|
-
'nest',
|
|
24748
24769
|
'igloohome',
|
|
24749
|
-
'ecobee',
|
|
24750
24770
|
'hubitat',
|
|
24751
24771
|
'controlbyweb',
|
|
24752
24772
|
'smartthings',
|
|
24753
24773
|
'dormakaba_oracode',
|
|
24754
24774
|
'tedee',
|
|
24755
|
-
'honeywell_resideo',
|
|
24756
24775
|
'akiles',
|
|
24776
|
+
'ecobee',
|
|
24777
|
+
'honeywell_resideo',
|
|
24778
|
+
'minut',
|
|
24779
|
+
'nest',
|
|
24780
|
+
'noiseaware',
|
|
24757
24781
|
'tado',
|
|
24758
24782
|
'sensi',
|
|
24759
24783
|
],
|
|
@@ -25103,6 +25127,10 @@ export default {
|
|
|
25103
25127
|
},
|
|
25104
25128
|
connect_webview_id: { format: 'uuid', type: 'string' },
|
|
25105
25129
|
connected_account_id: { format: 'uuid', type: 'string' },
|
|
25130
|
+
customer_ids: {
|
|
25131
|
+
items: { format: 'uuid', type: 'string' },
|
|
25132
|
+
type: 'array',
|
|
25133
|
+
},
|
|
25106
25134
|
device_id: { format: 'uuid', type: 'string' },
|
|
25107
25135
|
device_ids: {
|
|
25108
25136
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -25432,6 +25460,10 @@ export default {
|
|
|
25432
25460
|
description: 'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.',
|
|
25433
25461
|
type: 'object',
|
|
25434
25462
|
},
|
|
25463
|
+
customer_ids: {
|
|
25464
|
+
items: { format: 'uuid', type: 'string' },
|
|
25465
|
+
type: 'array',
|
|
25466
|
+
},
|
|
25435
25467
|
device_ids: {
|
|
25436
25468
|
description: 'Array of device IDs by which to filter devices.',
|
|
25437
25469
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -25979,6 +26011,10 @@ export default {
|
|
|
25979
26011
|
description: 'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.',
|
|
25980
26012
|
type: 'object',
|
|
25981
26013
|
},
|
|
26014
|
+
customer_ids: {
|
|
26015
|
+
items: { format: 'uuid', type: 'string' },
|
|
26016
|
+
type: 'array',
|
|
26017
|
+
},
|
|
25982
26018
|
device_ids: {
|
|
25983
26019
|
description: 'Array of device IDs by which to filter devices.',
|
|
25984
26020
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -26045,7 +26081,7 @@ export default {
|
|
|
26045
26081
|
},
|
|
26046
26082
|
manufacturer: {
|
|
26047
26083
|
description: 'Manufacturer by which to filter devices.',
|
|
26048
|
-
enum: ['
|
|
26084
|
+
enum: ['minut', 'noiseaware'],
|
|
26049
26085
|
type: 'string',
|
|
26050
26086
|
},
|
|
26051
26087
|
page_cursor: {
|
|
@@ -27990,11 +28026,11 @@ export default {
|
|
|
27990
28026
|
schema: {
|
|
27991
28027
|
properties: {
|
|
27992
28028
|
climate_preset_key: {
|
|
27993
|
-
description: 'Climate preset key of the
|
|
28029
|
+
description: 'Climate preset key of the climate preset that you want to activate.',
|
|
27994
28030
|
type: 'string',
|
|
27995
28031
|
},
|
|
27996
28032
|
device_id: {
|
|
27997
|
-
description: 'ID of the
|
|
28033
|
+
description: 'ID of the thermostat device for which you want to activate a climate preset.',
|
|
27998
28034
|
format: 'uuid',
|
|
27999
28035
|
type: 'string',
|
|
28000
28036
|
},
|
|
@@ -28041,166 +28077,6 @@ export default {
|
|
|
28041
28077
|
'x-title': 'Activate a Climate Preset',
|
|
28042
28078
|
},
|
|
28043
28079
|
},
|
|
28044
|
-
'/thermostats/activate_weekly_program': {
|
|
28045
|
-
post: {
|
|
28046
|
-
description: 'Activates a thermostat weekly program.',
|
|
28047
|
-
operationId: 'thermostatsActivateWeeklyProgramPost',
|
|
28048
|
-
requestBody: {
|
|
28049
|
-
content: {
|
|
28050
|
-
'application/json': {
|
|
28051
|
-
schema: {
|
|
28052
|
-
properties: {
|
|
28053
|
-
device_id: {
|
|
28054
|
-
description: 'ID of the thermostat device that the weekly program is for.',
|
|
28055
|
-
format: 'uuid',
|
|
28056
|
-
type: 'string',
|
|
28057
|
-
},
|
|
28058
|
-
friday_program_id: {
|
|
28059
|
-
description: 'ID of the thermostat daily program to run on Fridays.',
|
|
28060
|
-
format: 'uuid',
|
|
28061
|
-
nullable: true,
|
|
28062
|
-
type: 'string',
|
|
28063
|
-
},
|
|
28064
|
-
monday_program_id: {
|
|
28065
|
-
description: 'ID of the thermostat daily program to run on Mondays.',
|
|
28066
|
-
format: 'uuid',
|
|
28067
|
-
nullable: true,
|
|
28068
|
-
type: 'string',
|
|
28069
|
-
},
|
|
28070
|
-
saturday_program_id: {
|
|
28071
|
-
description: 'ID of the thermostat daily program to run on Saturdays.',
|
|
28072
|
-
format: 'uuid',
|
|
28073
|
-
nullable: true,
|
|
28074
|
-
type: 'string',
|
|
28075
|
-
},
|
|
28076
|
-
sunday_program_id: {
|
|
28077
|
-
description: 'ID of the thermostat daily program to run on Sundays.',
|
|
28078
|
-
format: 'uuid',
|
|
28079
|
-
nullable: true,
|
|
28080
|
-
type: 'string',
|
|
28081
|
-
},
|
|
28082
|
-
thursday_program_id: {
|
|
28083
|
-
description: 'ID of the thermostat daily program to run on Thursdays.',
|
|
28084
|
-
format: 'uuid',
|
|
28085
|
-
nullable: true,
|
|
28086
|
-
type: 'string',
|
|
28087
|
-
},
|
|
28088
|
-
tuesday_program_id: {
|
|
28089
|
-
description: 'ID of the thermostat daily program to run on Tuesdays.',
|
|
28090
|
-
format: 'uuid',
|
|
28091
|
-
nullable: true,
|
|
28092
|
-
type: 'string',
|
|
28093
|
-
},
|
|
28094
|
-
wednesday_program_id: {
|
|
28095
|
-
description: 'ID of the thermostat daily program to run on Wednesdays.',
|
|
28096
|
-
format: 'uuid',
|
|
28097
|
-
nullable: true,
|
|
28098
|
-
type: 'string',
|
|
28099
|
-
},
|
|
28100
|
-
},
|
|
28101
|
-
required: ['device_id'],
|
|
28102
|
-
type: 'object',
|
|
28103
|
-
},
|
|
28104
|
-
},
|
|
28105
|
-
},
|
|
28106
|
-
},
|
|
28107
|
-
responses: {
|
|
28108
|
-
200: {
|
|
28109
|
-
content: {
|
|
28110
|
-
'application/json': {
|
|
28111
|
-
schema: {
|
|
28112
|
-
properties: {
|
|
28113
|
-
action_attempt: {
|
|
28114
|
-
$ref: '#/components/schemas/action_attempt',
|
|
28115
|
-
},
|
|
28116
|
-
ok: { type: 'boolean' },
|
|
28117
|
-
},
|
|
28118
|
-
required: ['action_attempt', 'ok'],
|
|
28119
|
-
type: 'object',
|
|
28120
|
-
},
|
|
28121
|
-
},
|
|
28122
|
-
},
|
|
28123
|
-
description: 'OK',
|
|
28124
|
-
},
|
|
28125
|
-
400: { description: 'Bad Request' },
|
|
28126
|
-
401: { description: 'Unauthorized' },
|
|
28127
|
-
},
|
|
28128
|
-
security: [
|
|
28129
|
-
{ client_session: [] },
|
|
28130
|
-
{ pat_with_workspace: [] },
|
|
28131
|
-
{ console_session_with_workspace: [] },
|
|
28132
|
-
{ api_key: [] },
|
|
28133
|
-
],
|
|
28134
|
-
summary: '/thermostats/activate_weekly_program',
|
|
28135
|
-
tags: ['/thermostats'],
|
|
28136
|
-
'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
|
|
28137
|
-
'x-fern-sdk-group-name': ['thermostats'],
|
|
28138
|
-
'x-fern-sdk-method-name': 'activate_weekly_program',
|
|
28139
|
-
'x-fern-sdk-return-value': 'action_attempt',
|
|
28140
|
-
'x-response-key': 'action_attempt',
|
|
28141
|
-
'x-title': 'Activate a Thermostat Weekly Program',
|
|
28142
|
-
'x-undocumented': 'Unreleased.',
|
|
28143
|
-
},
|
|
28144
|
-
},
|
|
28145
|
-
'/thermostats/clear_weekly_program': {
|
|
28146
|
-
post: {
|
|
28147
|
-
description: 'Clears a thermostat weekly program.',
|
|
28148
|
-
operationId: 'thermostatsClearWeeklyProgramPost',
|
|
28149
|
-
requestBody: {
|
|
28150
|
-
content: {
|
|
28151
|
-
'application/json': {
|
|
28152
|
-
schema: {
|
|
28153
|
-
properties: {
|
|
28154
|
-
device_id: {
|
|
28155
|
-
description: 'ID of the thermostat device to clear the weekly program for.',
|
|
28156
|
-
format: 'uuid',
|
|
28157
|
-
type: 'string',
|
|
28158
|
-
},
|
|
28159
|
-
},
|
|
28160
|
-
required: ['device_id'],
|
|
28161
|
-
type: 'object',
|
|
28162
|
-
},
|
|
28163
|
-
},
|
|
28164
|
-
},
|
|
28165
|
-
},
|
|
28166
|
-
responses: {
|
|
28167
|
-
200: {
|
|
28168
|
-
content: {
|
|
28169
|
-
'application/json': {
|
|
28170
|
-
schema: {
|
|
28171
|
-
properties: {
|
|
28172
|
-
action_attempt: {
|
|
28173
|
-
$ref: '#/components/schemas/action_attempt',
|
|
28174
|
-
},
|
|
28175
|
-
ok: { type: 'boolean' },
|
|
28176
|
-
},
|
|
28177
|
-
required: ['action_attempt', 'ok'],
|
|
28178
|
-
type: 'object',
|
|
28179
|
-
},
|
|
28180
|
-
},
|
|
28181
|
-
},
|
|
28182
|
-
description: 'OK',
|
|
28183
|
-
},
|
|
28184
|
-
400: { description: 'Bad Request' },
|
|
28185
|
-
401: { description: 'Unauthorized' },
|
|
28186
|
-
},
|
|
28187
|
-
security: [
|
|
28188
|
-
{ client_session: [] },
|
|
28189
|
-
{ pat_with_workspace: [] },
|
|
28190
|
-
{ console_session_with_workspace: [] },
|
|
28191
|
-
{ api_key: [] },
|
|
28192
|
-
],
|
|
28193
|
-
summary: '/thermostats/clear_weekly_program',
|
|
28194
|
-
tags: ['/thermostats'],
|
|
28195
|
-
'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
|
|
28196
|
-
'x-fern-sdk-group-name': ['thermostats'],
|
|
28197
|
-
'x-fern-sdk-method-name': 'clear_weekly_program',
|
|
28198
|
-
'x-fern-sdk-return-value': 'action_attempt',
|
|
28199
|
-
'x-response-key': 'action_attempt',
|
|
28200
|
-
'x-title': 'Clear a Thermostat Weekly Program',
|
|
28201
|
-
'x-undocumented': 'Unreleased.',
|
|
28202
|
-
},
|
|
28203
|
-
},
|
|
28204
28080
|
'/thermostats/cool': {
|
|
28205
28081
|
post: {
|
|
28206
28082
|
description: 'Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
|
|
@@ -28221,7 +28097,7 @@ export default {
|
|
|
28221
28097
|
type: 'number',
|
|
28222
28098
|
},
|
|
28223
28099
|
device_id: {
|
|
28224
|
-
description: 'ID of the
|
|
28100
|
+
description: 'ID of the thermostat device that you want to set to cool mode.',
|
|
28225
28101
|
format: 'uuid',
|
|
28226
28102
|
type: 'string',
|
|
28227
28103
|
},
|
|
@@ -28298,7 +28174,7 @@ export default {
|
|
|
28298
28174
|
type: 'number',
|
|
28299
28175
|
},
|
|
28300
28176
|
device_id: {
|
|
28301
|
-
description: 'ID of the
|
|
28177
|
+
description: 'ID of the thermostat device for which you want create a climate preset.',
|
|
28302
28178
|
format: 'uuid',
|
|
28303
28179
|
type: 'string',
|
|
28304
28180
|
},
|
|
@@ -28374,7 +28250,7 @@ export default {
|
|
|
28374
28250
|
},
|
|
28375
28251
|
'/thermostats/daily_programs/create': {
|
|
28376
28252
|
post: {
|
|
28377
|
-
description: 'Creates a thermostat daily program.',
|
|
28253
|
+
description: 'Creates a thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.',
|
|
28378
28254
|
operationId: 'thermostatsDailyProgramsCreatePost',
|
|
28379
28255
|
requestBody: {
|
|
28380
28256
|
content: {
|
|
@@ -28382,7 +28258,7 @@ export default {
|
|
|
28382
28258
|
schema: {
|
|
28383
28259
|
properties: {
|
|
28384
28260
|
device_id: {
|
|
28385
|
-
description: 'ID of the
|
|
28261
|
+
description: 'ID of the thermostat device for which you want to create a daily program.',
|
|
28386
28262
|
format: 'uuid',
|
|
28387
28263
|
type: 'string',
|
|
28388
28264
|
},
|
|
@@ -28393,13 +28269,14 @@ export default {
|
|
|
28393
28269
|
periods: {
|
|
28394
28270
|
description: 'Array of thermostat daily program periods.',
|
|
28395
28271
|
items: {
|
|
28272
|
+
description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
|
|
28396
28273
|
properties: {
|
|
28397
28274
|
climate_preset_key: {
|
|
28398
|
-
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time
|
|
28275
|
+
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
|
|
28399
28276
|
type: 'string',
|
|
28400
28277
|
},
|
|
28401
28278
|
starts_at_time: {
|
|
28402
|
-
description: 'Time at which the thermostat daily program
|
|
28279
|
+
description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
28403
28280
|
pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
|
|
28404
28281
|
type: 'string',
|
|
28405
28282
|
},
|
|
@@ -28424,6 +28301,7 @@ export default {
|
|
|
28424
28301
|
properties: {
|
|
28425
28302
|
ok: { type: 'boolean' },
|
|
28426
28303
|
thermostat_daily_program: {
|
|
28304
|
+
description: 'Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.',
|
|
28427
28305
|
properties: {
|
|
28428
28306
|
created_at: {
|
|
28429
28307
|
description: 'Date and time at which the thermostat daily program was created.',
|
|
@@ -28431,7 +28309,7 @@ export default {
|
|
|
28431
28309
|
type: 'string',
|
|
28432
28310
|
},
|
|
28433
28311
|
device_id: {
|
|
28434
|
-
description: 'ID of the
|
|
28312
|
+
description: 'ID of the thermostat device on which the thermostat daily program is configured.',
|
|
28435
28313
|
format: 'uuid',
|
|
28436
28314
|
type: 'string',
|
|
28437
28315
|
},
|
|
@@ -28443,13 +28321,14 @@ export default {
|
|
|
28443
28321
|
periods: {
|
|
28444
28322
|
description: 'Array of thermostat daily program periods.',
|
|
28445
28323
|
items: {
|
|
28324
|
+
description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
|
|
28446
28325
|
properties: {
|
|
28447
28326
|
climate_preset_key: {
|
|
28448
|
-
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time
|
|
28327
|
+
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
|
|
28449
28328
|
type: 'string',
|
|
28450
28329
|
},
|
|
28451
28330
|
starts_at_time: {
|
|
28452
|
-
description: 'Time at which the thermostat daily program
|
|
28331
|
+
description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
28453
28332
|
pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
|
|
28454
28333
|
type: 'string',
|
|
28455
28334
|
},
|
|
@@ -28479,6 +28358,7 @@ export default {
|
|
|
28479
28358
|
'created_at',
|
|
28480
28359
|
],
|
|
28481
28360
|
type: 'object',
|
|
28361
|
+
'x-route-path': '/thermostats/thermostat_daily_programs',
|
|
28482
28362
|
},
|
|
28483
28363
|
},
|
|
28484
28364
|
required: ['thermostat_daily_program', 'ok'],
|
|
@@ -28504,7 +28384,6 @@ export default {
|
|
|
28504
28384
|
'x-fern-sdk-return-value': 'thermostat_daily_program',
|
|
28505
28385
|
'x-response-key': 'thermostat_daily_program',
|
|
28506
28386
|
'x-title': 'Create a Thermostat Daily Program',
|
|
28507
|
-
'x-undocumented': 'Unreleased.',
|
|
28508
28387
|
},
|
|
28509
28388
|
},
|
|
28510
28389
|
'/thermostats/daily_programs/delete': {
|
|
@@ -28517,7 +28396,7 @@ export default {
|
|
|
28517
28396
|
schema: {
|
|
28518
28397
|
properties: {
|
|
28519
28398
|
thermostat_daily_program_id: {
|
|
28520
|
-
description: 'ID of the
|
|
28399
|
+
description: 'ID of the thermostat daily program that you want to delete.',
|
|
28521
28400
|
format: 'uuid',
|
|
28522
28401
|
type: 'string',
|
|
28523
28402
|
},
|
|
@@ -28556,12 +28435,11 @@ export default {
|
|
|
28556
28435
|
'x-fern-sdk-method-name': 'delete',
|
|
28557
28436
|
'x-response-key': null,
|
|
28558
28437
|
'x-title': 'Delete a Thermostat Daily Program',
|
|
28559
|
-
'x-undocumented': 'Unreleased.',
|
|
28560
28438
|
},
|
|
28561
28439
|
},
|
|
28562
28440
|
'/thermostats/daily_programs/update': {
|
|
28563
28441
|
patch: {
|
|
28564
|
-
description: 'Updates a specified thermostat daily program.',
|
|
28442
|
+
description: 'Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.',
|
|
28565
28443
|
operationId: 'thermostatsDailyProgramsUpdatePatch',
|
|
28566
28444
|
requestBody: {
|
|
28567
28445
|
content: {
|
|
@@ -28569,19 +28447,20 @@ export default {
|
|
|
28569
28447
|
schema: {
|
|
28570
28448
|
properties: {
|
|
28571
28449
|
name: {
|
|
28572
|
-
description: 'User-friendly name to identify the thermostat daily program.',
|
|
28450
|
+
description: 'User-friendly name to identify the thermostat daily program that you want to update.',
|
|
28573
28451
|
type: 'string',
|
|
28574
28452
|
},
|
|
28575
28453
|
periods: {
|
|
28576
|
-
description: 'Array of thermostat daily program periods.',
|
|
28454
|
+
description: 'Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.',
|
|
28577
28455
|
items: {
|
|
28456
|
+
description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
|
|
28578
28457
|
properties: {
|
|
28579
28458
|
climate_preset_key: {
|
|
28580
|
-
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time
|
|
28459
|
+
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
|
|
28581
28460
|
type: 'string',
|
|
28582
28461
|
},
|
|
28583
28462
|
starts_at_time: {
|
|
28584
|
-
description: 'Time at which the thermostat daily program
|
|
28463
|
+
description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
28585
28464
|
pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
|
|
28586
28465
|
type: 'string',
|
|
28587
28466
|
},
|
|
@@ -28592,7 +28471,7 @@ export default {
|
|
|
28592
28471
|
type: 'array',
|
|
28593
28472
|
},
|
|
28594
28473
|
thermostat_daily_program_id: {
|
|
28595
|
-
description: 'ID of the
|
|
28474
|
+
description: 'ID of the thermostat daily program that you want to update.',
|
|
28596
28475
|
format: 'uuid',
|
|
28597
28476
|
type: 'string',
|
|
28598
28477
|
},
|
|
@@ -28636,10 +28515,9 @@ export default {
|
|
|
28636
28515
|
'x-fern-ignore': true,
|
|
28637
28516
|
'x-response-key': 'action_attempt',
|
|
28638
28517
|
'x-title': 'Update a Thermostat Daily Program',
|
|
28639
|
-
'x-undocumented': 'Unreleased.',
|
|
28640
28518
|
},
|
|
28641
28519
|
post: {
|
|
28642
|
-
description: 'Updates a specified thermostat daily program.',
|
|
28520
|
+
description: 'Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.',
|
|
28643
28521
|
operationId: 'thermostatsDailyProgramsUpdatePost',
|
|
28644
28522
|
requestBody: {
|
|
28645
28523
|
content: {
|
|
@@ -28647,19 +28525,20 @@ export default {
|
|
|
28647
28525
|
schema: {
|
|
28648
28526
|
properties: {
|
|
28649
28527
|
name: {
|
|
28650
|
-
description: 'User-friendly name to identify the thermostat daily program.',
|
|
28528
|
+
description: 'User-friendly name to identify the thermostat daily program that you want to update.',
|
|
28651
28529
|
type: 'string',
|
|
28652
28530
|
},
|
|
28653
28531
|
periods: {
|
|
28654
|
-
description: 'Array of thermostat daily program periods.',
|
|
28532
|
+
description: 'Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.',
|
|
28655
28533
|
items: {
|
|
28534
|
+
description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
|
|
28656
28535
|
properties: {
|
|
28657
28536
|
climate_preset_key: {
|
|
28658
|
-
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time
|
|
28537
|
+
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
|
|
28659
28538
|
type: 'string',
|
|
28660
28539
|
},
|
|
28661
28540
|
starts_at_time: {
|
|
28662
|
-
description: 'Time at which the thermostat daily program
|
|
28541
|
+
description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
28663
28542
|
pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
|
|
28664
28543
|
type: 'string',
|
|
28665
28544
|
},
|
|
@@ -28670,7 +28549,7 @@ export default {
|
|
|
28670
28549
|
type: 'array',
|
|
28671
28550
|
},
|
|
28672
28551
|
thermostat_daily_program_id: {
|
|
28673
|
-
description: 'ID of the
|
|
28552
|
+
description: 'ID of the thermostat daily program that you want to update.',
|
|
28674
28553
|
format: 'uuid',
|
|
28675
28554
|
type: 'string',
|
|
28676
28555
|
},
|
|
@@ -28716,7 +28595,6 @@ export default {
|
|
|
28716
28595
|
'x-fern-sdk-return-value': 'action_attempt',
|
|
28717
28596
|
'x-response-key': 'action_attempt',
|
|
28718
28597
|
'x-title': 'Update a Thermostat Daily Program',
|
|
28719
|
-
'x-undocumented': 'Unreleased.',
|
|
28720
28598
|
},
|
|
28721
28599
|
},
|
|
28722
28600
|
'/thermostats/delete_climate_preset': {
|
|
@@ -28729,11 +28607,11 @@ export default {
|
|
|
28729
28607
|
schema: {
|
|
28730
28608
|
properties: {
|
|
28731
28609
|
climate_preset_key: {
|
|
28732
|
-
description: 'Climate preset key of the
|
|
28610
|
+
description: 'Climate preset key of the climate preset that you want to delete.',
|
|
28733
28611
|
type: 'string',
|
|
28734
28612
|
},
|
|
28735
28613
|
device_id: {
|
|
28736
|
-
description: 'ID of the
|
|
28614
|
+
description: 'ID of the thermostat device for which you want to delete a climate preset.',
|
|
28737
28615
|
format: 'uuid',
|
|
28738
28616
|
type: 'string',
|
|
28739
28617
|
},
|
|
@@ -28784,12 +28662,12 @@ export default {
|
|
|
28784
28662
|
schema: {
|
|
28785
28663
|
properties: {
|
|
28786
28664
|
device_id: {
|
|
28787
|
-
description: 'ID of the
|
|
28665
|
+
description: 'ID of the thermostat device that you want to retrieve.',
|
|
28788
28666
|
format: 'uuid',
|
|
28789
28667
|
type: 'string',
|
|
28790
28668
|
},
|
|
28791
28669
|
name: {
|
|
28792
|
-
description: 'User-friendly name of the
|
|
28670
|
+
description: 'User-friendly name of the thermostat device that you want to retrieve.',
|
|
28793
28671
|
type: 'string',
|
|
28794
28672
|
},
|
|
28795
28673
|
},
|
|
@@ -28844,7 +28722,7 @@ export default {
|
|
|
28844
28722
|
schema: {
|
|
28845
28723
|
properties: {
|
|
28846
28724
|
device_id: {
|
|
28847
|
-
description: 'ID of the
|
|
28725
|
+
description: 'ID of the thermostat device that you want to set to heat mode.',
|
|
28848
28726
|
format: 'uuid',
|
|
28849
28727
|
type: 'string',
|
|
28850
28728
|
},
|
|
@@ -28927,7 +28805,7 @@ export default {
|
|
|
28927
28805
|
type: 'number',
|
|
28928
28806
|
},
|
|
28929
28807
|
device_id: {
|
|
28930
|
-
description: 'ID of the
|
|
28808
|
+
description: 'ID of the thermostat device that you want to set to heat-cool mode.',
|
|
28931
28809
|
format: 'uuid',
|
|
28932
28810
|
type: 'string',
|
|
28933
28811
|
},
|
|
@@ -29026,13 +28904,17 @@ export default {
|
|
|
29026
28904
|
description: 'Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices.',
|
|
29027
28905
|
type: 'object',
|
|
29028
28906
|
},
|
|
28907
|
+
customer_ids: {
|
|
28908
|
+
items: { format: 'uuid', type: 'string' },
|
|
28909
|
+
type: 'array',
|
|
28910
|
+
},
|
|
29029
28911
|
device_ids: {
|
|
29030
28912
|
description: 'Array of device IDs by which to filter devices.',
|
|
29031
28913
|
items: { format: 'uuid', type: 'string' },
|
|
29032
28914
|
type: 'array',
|
|
29033
28915
|
},
|
|
29034
28916
|
device_type: {
|
|
29035
|
-
description: 'Device type by which to filter devices.',
|
|
28917
|
+
description: 'Device type by which to filter thermostat devices.',
|
|
29036
28918
|
enum: [
|
|
29037
28919
|
'ecobee_thermostat',
|
|
29038
28920
|
'nest_thermostat',
|
|
@@ -29043,7 +28925,7 @@ export default {
|
|
|
29043
28925
|
type: 'string',
|
|
29044
28926
|
},
|
|
29045
28927
|
device_types: {
|
|
29046
|
-
description: 'Array of device types by which to filter devices.',
|
|
28928
|
+
description: 'Array of device types by which to filter thermostat devices.',
|
|
29047
28929
|
items: {
|
|
29048
28930
|
enum: [
|
|
29049
28931
|
'ecobee_thermostat',
|
|
@@ -29103,8 +28985,14 @@ export default {
|
|
|
29103
28985
|
type: 'number',
|
|
29104
28986
|
},
|
|
29105
28987
|
manufacturer: {
|
|
29106
|
-
description: 'Manufacturer by which to filter devices.',
|
|
29107
|
-
enum: [
|
|
28988
|
+
description: 'Manufacturer by which to filter thermostat devices.',
|
|
28989
|
+
enum: [
|
|
28990
|
+
'ecobee',
|
|
28991
|
+
'honeywell_resideo',
|
|
28992
|
+
'nest',
|
|
28993
|
+
'tado',
|
|
28994
|
+
'sensi',
|
|
28995
|
+
],
|
|
29108
28996
|
type: 'string',
|
|
29109
28997
|
},
|
|
29110
28998
|
page_cursor: {
|
|
@@ -29179,7 +29067,7 @@ export default {
|
|
|
29179
29067
|
schema: {
|
|
29180
29068
|
properties: {
|
|
29181
29069
|
device_id: {
|
|
29182
|
-
description: 'ID of the
|
|
29070
|
+
description: 'ID of the thermostat device that you want to set to off mode.',
|
|
29183
29071
|
format: 'uuid',
|
|
29184
29072
|
type: 'string',
|
|
29185
29073
|
},
|
|
@@ -29655,11 +29543,11 @@ export default {
|
|
|
29655
29543
|
schema: {
|
|
29656
29544
|
properties: {
|
|
29657
29545
|
climate_preset_key: {
|
|
29658
|
-
description: 'Climate preset key of the
|
|
29546
|
+
description: 'Climate preset key of the climate preset that you want to set as the fallback climate preset.',
|
|
29659
29547
|
type: 'string',
|
|
29660
29548
|
},
|
|
29661
29549
|
device_id: {
|
|
29662
|
-
description: 'ID of the
|
|
29550
|
+
description: 'ID of the thermostat device for which you want to set the fallback climate preset.',
|
|
29663
29551
|
format: 'uuid',
|
|
29664
29552
|
type: 'string',
|
|
29665
29553
|
},
|
|
@@ -29708,7 +29596,11 @@ export default {
|
|
|
29708
29596
|
'application/json': {
|
|
29709
29597
|
schema: {
|
|
29710
29598
|
properties: {
|
|
29711
|
-
device_id: {
|
|
29599
|
+
device_id: {
|
|
29600
|
+
description: 'ID of the thermostat device for which you want to set the fan mode.',
|
|
29601
|
+
format: 'uuid',
|
|
29602
|
+
type: 'string',
|
|
29603
|
+
},
|
|
29712
29604
|
fan_mode: {
|
|
29713
29605
|
deprecated: true,
|
|
29714
29606
|
enum: ['auto', 'on', 'circulate'],
|
|
@@ -29782,7 +29674,7 @@ export default {
|
|
|
29782
29674
|
{
|
|
29783
29675
|
properties: {
|
|
29784
29676
|
device_id: {
|
|
29785
|
-
description: 'ID of the
|
|
29677
|
+
description: 'ID of the thermostat device for which you want to set the HVAC mode.',
|
|
29786
29678
|
format: 'uuid',
|
|
29787
29679
|
type: 'string',
|
|
29788
29680
|
},
|
|
@@ -29804,7 +29696,7 @@ export default {
|
|
|
29804
29696
|
type: 'number',
|
|
29805
29697
|
},
|
|
29806
29698
|
device_id: {
|
|
29807
|
-
description: 'ID of the
|
|
29699
|
+
description: 'ID of the thermostat device for which you want to set the HVAC mode.',
|
|
29808
29700
|
format: 'uuid',
|
|
29809
29701
|
type: 'string',
|
|
29810
29702
|
},
|
|
@@ -29816,7 +29708,7 @@ export default {
|
|
|
29816
29708
|
{
|
|
29817
29709
|
properties: {
|
|
29818
29710
|
device_id: {
|
|
29819
|
-
description: 'ID of the
|
|
29711
|
+
description: 'ID of the thermostat device for which you want to set the HVAC mode.',
|
|
29820
29712
|
format: 'uuid',
|
|
29821
29713
|
type: 'string',
|
|
29822
29714
|
},
|
|
@@ -29848,7 +29740,7 @@ export default {
|
|
|
29848
29740
|
type: 'number',
|
|
29849
29741
|
},
|
|
29850
29742
|
device_id: {
|
|
29851
|
-
description: 'ID of the
|
|
29743
|
+
description: 'ID of the thermostat device for which you want to set the HVAC mode.',
|
|
29852
29744
|
format: 'uuid',
|
|
29853
29745
|
type: 'string',
|
|
29854
29746
|
},
|
|
@@ -29922,7 +29814,7 @@ export default {
|
|
|
29922
29814
|
schema: {
|
|
29923
29815
|
properties: {
|
|
29924
29816
|
device_id: {
|
|
29925
|
-
description: 'ID of the
|
|
29817
|
+
description: 'ID of the thermostat device for which you want to set a temperature threshold.',
|
|
29926
29818
|
format: 'uuid',
|
|
29927
29819
|
type: 'string',
|
|
29928
29820
|
},
|
|
@@ -29997,7 +29889,7 @@ export default {
|
|
|
29997
29889
|
schema: {
|
|
29998
29890
|
properties: {
|
|
29999
29891
|
device_id: {
|
|
30000
|
-
description: 'ID of the
|
|
29892
|
+
description: 'ID of the thermostat device for which you want to set a temperature threshold.',
|
|
30001
29893
|
format: 'uuid',
|
|
30002
29894
|
type: 'string',
|
|
30003
29895
|
},
|
|
@@ -30297,7 +30189,7 @@ export default {
|
|
|
30297
30189
|
type: 'number',
|
|
30298
30190
|
},
|
|
30299
30191
|
device_id: {
|
|
30300
|
-
description: 'ID of the
|
|
30192
|
+
description: 'ID of the thermostat device for which you want to update a climate preset.',
|
|
30301
30193
|
format: 'uuid',
|
|
30302
30194
|
type: 'string',
|
|
30303
30195
|
},
|
|
@@ -30395,7 +30287,7 @@ export default {
|
|
|
30395
30287
|
type: 'number',
|
|
30396
30288
|
},
|
|
30397
30289
|
device_id: {
|
|
30398
|
-
description: 'ID of the
|
|
30290
|
+
description: 'ID of the thermostat device for which you want to update a climate preset.',
|
|
30399
30291
|
format: 'uuid',
|
|
30400
30292
|
type: 'string',
|
|
30401
30293
|
},
|
|
@@ -30472,6 +30364,106 @@ export default {
|
|
|
30472
30364
|
'x-title': 'Update a Climate Preset',
|
|
30473
30365
|
},
|
|
30474
30366
|
},
|
|
30367
|
+
'/thermostats/update_weekly_program': {
|
|
30368
|
+
post: {
|
|
30369
|
+
description: 'Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.',
|
|
30370
|
+
operationId: 'thermostatsUpdateWeeklyProgramPost',
|
|
30371
|
+
requestBody: {
|
|
30372
|
+
content: {
|
|
30373
|
+
'application/json': {
|
|
30374
|
+
schema: {
|
|
30375
|
+
properties: {
|
|
30376
|
+
device_id: {
|
|
30377
|
+
description: 'ID of the thermostat device for which you want to update the weekly program.',
|
|
30378
|
+
format: 'uuid',
|
|
30379
|
+
type: 'string',
|
|
30380
|
+
},
|
|
30381
|
+
friday_program_id: {
|
|
30382
|
+
description: 'ID of the thermostat daily program to run on Fridays.',
|
|
30383
|
+
format: 'uuid',
|
|
30384
|
+
nullable: true,
|
|
30385
|
+
type: 'string',
|
|
30386
|
+
},
|
|
30387
|
+
monday_program_id: {
|
|
30388
|
+
description: 'ID of the thermostat daily program to run on Mondays.',
|
|
30389
|
+
format: 'uuid',
|
|
30390
|
+
nullable: true,
|
|
30391
|
+
type: 'string',
|
|
30392
|
+
},
|
|
30393
|
+
saturday_program_id: {
|
|
30394
|
+
description: 'ID of the thermostat daily program to run on Saturdays.',
|
|
30395
|
+
format: 'uuid',
|
|
30396
|
+
nullable: true,
|
|
30397
|
+
type: 'string',
|
|
30398
|
+
},
|
|
30399
|
+
sunday_program_id: {
|
|
30400
|
+
description: 'ID of the thermostat daily program to run on Sundays.',
|
|
30401
|
+
format: 'uuid',
|
|
30402
|
+
nullable: true,
|
|
30403
|
+
type: 'string',
|
|
30404
|
+
},
|
|
30405
|
+
thursday_program_id: {
|
|
30406
|
+
description: 'ID of the thermostat daily program to run on Thursdays.',
|
|
30407
|
+
format: 'uuid',
|
|
30408
|
+
nullable: true,
|
|
30409
|
+
type: 'string',
|
|
30410
|
+
},
|
|
30411
|
+
tuesday_program_id: {
|
|
30412
|
+
description: 'ID of the thermostat daily program to run on Tuesdays.',
|
|
30413
|
+
format: 'uuid',
|
|
30414
|
+
nullable: true,
|
|
30415
|
+
type: 'string',
|
|
30416
|
+
},
|
|
30417
|
+
wednesday_program_id: {
|
|
30418
|
+
description: 'ID of the thermostat daily program to run on Wednesdays.',
|
|
30419
|
+
format: 'uuid',
|
|
30420
|
+
nullable: true,
|
|
30421
|
+
type: 'string',
|
|
30422
|
+
},
|
|
30423
|
+
},
|
|
30424
|
+
required: ['device_id'],
|
|
30425
|
+
type: 'object',
|
|
30426
|
+
},
|
|
30427
|
+
},
|
|
30428
|
+
},
|
|
30429
|
+
},
|
|
30430
|
+
responses: {
|
|
30431
|
+
200: {
|
|
30432
|
+
content: {
|
|
30433
|
+
'application/json': {
|
|
30434
|
+
schema: {
|
|
30435
|
+
properties: {
|
|
30436
|
+
action_attempt: {
|
|
30437
|
+
$ref: '#/components/schemas/action_attempt',
|
|
30438
|
+
},
|
|
30439
|
+
ok: { type: 'boolean' },
|
|
30440
|
+
},
|
|
30441
|
+
required: ['action_attempt', 'ok'],
|
|
30442
|
+
type: 'object',
|
|
30443
|
+
},
|
|
30444
|
+
},
|
|
30445
|
+
},
|
|
30446
|
+
description: 'OK',
|
|
30447
|
+
},
|
|
30448
|
+
400: { description: 'Bad Request' },
|
|
30449
|
+
401: { description: 'Unauthorized' },
|
|
30450
|
+
},
|
|
30451
|
+
security: [
|
|
30452
|
+
{ client_session: [] },
|
|
30453
|
+
{ pat_with_workspace: [] },
|
|
30454
|
+
{ console_session_with_workspace: [] },
|
|
30455
|
+
{ api_key: [] },
|
|
30456
|
+
],
|
|
30457
|
+
summary: '/thermostats/update_weekly_program',
|
|
30458
|
+
tags: ['/thermostats'],
|
|
30459
|
+
'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
|
|
30460
|
+
'x-fern-sdk-group-name': ['thermostats'],
|
|
30461
|
+
'x-fern-sdk-method-name': 'update_weekly_program',
|
|
30462
|
+
'x-fern-sdk-return-value': 'action_attempt',
|
|
30463
|
+
'x-response-key': 'action_attempt',
|
|
30464
|
+
'x-title': 'Update the Thermostat Weekly Program',
|
|
30465
|
+
},
|
|
30466
|
+
},
|
|
30475
30467
|
'/unstable_access_grants/create': {
|
|
30476
30468
|
post: {
|
|
30477
30469
|
description: 'Creates a new access grant.',
|
|
@@ -32270,6 +32262,11 @@ export default {
|
|
|
32270
32262
|
'application/json': {
|
|
32271
32263
|
schema: {
|
|
32272
32264
|
properties: {
|
|
32265
|
+
acs_system_ids: {
|
|
32266
|
+
description: "List of ACS system IDs to associate with the user identity through ACS users. If there's no user with the same email address or phone number in the specified ACS systems, a new ACS user is created. If there is an existing user with the same email or phone number in the specified ACS systems, the user is linked to the user identity.",
|
|
32267
|
+
items: { format: 'uuid', type: 'string' },
|
|
32268
|
+
type: 'array',
|
|
32269
|
+
},
|
|
32273
32270
|
email_address: {
|
|
32274
32271
|
description: 'Unique email address for the user identity.',
|
|
32275
32272
|
format: 'email',
|