@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.
@@ -9314,6 +9314,8 @@ export default {
9314
9314
  },
9315
9315
  thermostat_daily_programs: {
9316
9316
  items: {
9317
+ description:
9318
+ '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.',
9317
9319
  properties: {
9318
9320
  created_at: {
9319
9321
  description:
@@ -9323,7 +9325,7 @@ export default {
9323
9325
  },
9324
9326
  device_id: {
9325
9327
  description:
9326
- 'ID of the desired thermostat device.',
9328
+ 'ID of the thermostat device on which the thermostat daily program is configured.',
9327
9329
  format: 'uuid',
9328
9330
  type: 'string',
9329
9331
  },
@@ -9337,15 +9339,17 @@ export default {
9337
9339
  description:
9338
9340
  'Array of thermostat daily program periods.',
9339
9341
  items: {
9342
+ description:
9343
+ '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.',
9340
9344
  properties: {
9341
9345
  climate_preset_key: {
9342
9346
  description:
9343
- '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.',
9347
+ '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`.',
9344
9348
  type: 'string',
9345
9349
  },
9346
9350
  starts_at_time: {
9347
9351
  description:
9348
- 'Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
9352
+ 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
9349
9353
  pattern:
9350
9354
  '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
9351
9355
  type: 'string',
@@ -9381,6 +9385,8 @@ export default {
9381
9385
  'created_at',
9382
9386
  ],
9383
9387
  type: 'object',
9388
+ 'x-route-path':
9389
+ '/thermostats/thermostat_daily_programs',
9384
9390
  },
9385
9391
  type: 'array',
9386
9392
  },
@@ -9820,6 +9826,7 @@ export default {
9820
9826
  'tado',
9821
9827
  'salto_space',
9822
9828
  'sensi',
9829
+ 'kwikset2',
9823
9830
  ],
9824
9831
  type: 'string',
9825
9832
  },
@@ -20970,6 +20977,12 @@ export default {
20970
20977
  format: 'uuid',
20971
20978
  type: 'string',
20972
20979
  },
20980
+ user_identity_id: {
20981
+ description:
20982
+ 'ID of the user identity for which you want to retrieve all access groups.',
20983
+ format: 'uuid',
20984
+ type: 'string',
20985
+ },
20973
20986
  },
20974
20987
  type: 'object',
20975
20988
  },
@@ -25320,6 +25333,7 @@ export default {
25320
25333
  'tado',
25321
25334
  'salto_space',
25322
25335
  'sensi',
25336
+ 'kwikset2',
25323
25337
  'yale_access',
25324
25338
  'hid_cm',
25325
25339
  'google_nest',
@@ -25683,6 +25697,10 @@ export default {
25683
25697
  'Returns accounts whose custom_metadata contains all of the provided key/value pairs.',
25684
25698
  type: 'object',
25685
25699
  },
25700
+ customer_ids: {
25701
+ items: { format: 'uuid', type: 'string' },
25702
+ type: 'array',
25703
+ },
25686
25704
  limit: {
25687
25705
  default: 11_000,
25688
25706
  description:
@@ -25943,6 +25961,10 @@ export default {
25943
25961
  '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.',
25944
25962
  type: 'object',
25945
25963
  },
25964
+ customer_ids: {
25965
+ items: { format: 'uuid', type: 'string' },
25966
+ type: 'array',
25967
+ },
25946
25968
  device_ids: {
25947
25969
  description:
25948
25970
  'Array of device IDs by which to filter devices.',
@@ -26137,19 +26159,20 @@ export default {
26137
26159
  'unknown',
26138
26160
  'wyze',
26139
26161
  'yale',
26140
- 'minut',
26141
26162
  'two_n',
26142
26163
  'ttlock',
26143
- 'nest',
26144
26164
  'igloohome',
26145
- 'ecobee',
26146
26165
  'hubitat',
26147
26166
  'controlbyweb',
26148
26167
  'smartthings',
26149
26168
  'dormakaba_oracode',
26150
26169
  'tedee',
26151
- 'honeywell_resideo',
26152
26170
  'akiles',
26171
+ 'ecobee',
26172
+ 'honeywell_resideo',
26173
+ 'minut',
26174
+ 'nest',
26175
+ 'noiseaware',
26153
26176
  'tado',
26154
26177
  'sensi',
26155
26178
  ],
@@ -26491,6 +26514,10 @@ export default {
26491
26514
  '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.',
26492
26515
  type: 'object',
26493
26516
  },
26517
+ customer_ids: {
26518
+ items: { format: 'uuid', type: 'string' },
26519
+ type: 'array',
26520
+ },
26494
26521
  device_ids: {
26495
26522
  description:
26496
26523
  'Array of device IDs by which to filter devices.',
@@ -26685,19 +26712,20 @@ export default {
26685
26712
  'unknown',
26686
26713
  'wyze',
26687
26714
  'yale',
26688
- 'minut',
26689
26715
  'two_n',
26690
26716
  'ttlock',
26691
- 'nest',
26692
26717
  'igloohome',
26693
- 'ecobee',
26694
26718
  'hubitat',
26695
26719
  'controlbyweb',
26696
26720
  'smartthings',
26697
26721
  'dormakaba_oracode',
26698
26722
  'tedee',
26699
- 'honeywell_resideo',
26700
26723
  'akiles',
26724
+ 'ecobee',
26725
+ 'honeywell_resideo',
26726
+ 'minut',
26727
+ 'nest',
26728
+ 'noiseaware',
26701
26729
  'tado',
26702
26730
  'sensi',
26703
26731
  ],
@@ -27049,6 +27077,10 @@ export default {
27049
27077
  },
27050
27078
  connect_webview_id: { format: 'uuid', type: 'string' },
27051
27079
  connected_account_id: { format: 'uuid', type: 'string' },
27080
+ customer_ids: {
27081
+ items: { format: 'uuid', type: 'string' },
27082
+ type: 'array',
27083
+ },
27052
27084
  device_id: { format: 'uuid', type: 'string' },
27053
27085
  device_ids: {
27054
27086
  items: { format: 'uuid', type: 'string' },
@@ -27383,6 +27415,10 @@ export default {
27383
27415
  '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.',
27384
27416
  type: 'object',
27385
27417
  },
27418
+ customer_ids: {
27419
+ items: { format: 'uuid', type: 'string' },
27420
+ type: 'array',
27421
+ },
27386
27422
  device_ids: {
27387
27423
  description:
27388
27424
  'Array of device IDs by which to filter devices.',
@@ -27940,6 +27976,10 @@ export default {
27940
27976
  '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.',
27941
27977
  type: 'object',
27942
27978
  },
27979
+ customer_ids: {
27980
+ items: { format: 'uuid', type: 'string' },
27981
+ type: 'array',
27982
+ },
27943
27983
  device_ids: {
27944
27984
  description:
27945
27985
  'Array of device IDs by which to filter devices.',
@@ -28009,7 +28049,7 @@ export default {
28009
28049
  },
28010
28050
  manufacturer: {
28011
28051
  description: 'Manufacturer by which to filter devices.',
28012
- enum: ['noiseaware', 'minut'],
28052
+ enum: ['minut', 'noiseaware'],
28013
28053
  type: 'string',
28014
28054
  },
28015
28055
  page_cursor: {
@@ -30042,11 +30082,12 @@ export default {
30042
30082
  properties: {
30043
30083
  climate_preset_key: {
30044
30084
  description:
30045
- 'Climate preset key of the desired climate preset.',
30085
+ 'Climate preset key of the climate preset that you want to activate.',
30046
30086
  type: 'string',
30047
30087
  },
30048
30088
  device_id: {
30049
- description: 'ID of the desired thermostat device.',
30089
+ description:
30090
+ 'ID of the thermostat device for which you want to activate a climate preset.',
30050
30091
  format: 'uuid',
30051
30092
  type: 'string',
30052
30093
  },
@@ -30093,175 +30134,6 @@ export default {
30093
30134
  'x-title': 'Activate a Climate Preset',
30094
30135
  },
30095
30136
  },
30096
- '/thermostats/activate_weekly_program': {
30097
- post: {
30098
- description: 'Activates a thermostat weekly program.',
30099
- operationId: 'thermostatsActivateWeeklyProgramPost',
30100
- requestBody: {
30101
- content: {
30102
- 'application/json': {
30103
- schema: {
30104
- properties: {
30105
- device_id: {
30106
- description:
30107
- 'ID of the thermostat device that the weekly program is for.',
30108
- format: 'uuid',
30109
- type: 'string',
30110
- },
30111
- friday_program_id: {
30112
- description:
30113
- 'ID of the thermostat daily program to run on Fridays.',
30114
- format: 'uuid',
30115
- nullable: true,
30116
- type: 'string',
30117
- },
30118
- monday_program_id: {
30119
- description:
30120
- 'ID of the thermostat daily program to run on Mondays.',
30121
- format: 'uuid',
30122
- nullable: true,
30123
- type: 'string',
30124
- },
30125
- saturday_program_id: {
30126
- description:
30127
- 'ID of the thermostat daily program to run on Saturdays.',
30128
- format: 'uuid',
30129
- nullable: true,
30130
- type: 'string',
30131
- },
30132
- sunday_program_id: {
30133
- description:
30134
- 'ID of the thermostat daily program to run on Sundays.',
30135
- format: 'uuid',
30136
- nullable: true,
30137
- type: 'string',
30138
- },
30139
- thursday_program_id: {
30140
- description:
30141
- 'ID of the thermostat daily program to run on Thursdays.',
30142
- format: 'uuid',
30143
- nullable: true,
30144
- type: 'string',
30145
- },
30146
- tuesday_program_id: {
30147
- description:
30148
- 'ID of the thermostat daily program to run on Tuesdays.',
30149
- format: 'uuid',
30150
- nullable: true,
30151
- type: 'string',
30152
- },
30153
- wednesday_program_id: {
30154
- description:
30155
- 'ID of the thermostat daily program to run on Wednesdays.',
30156
- format: 'uuid',
30157
- nullable: true,
30158
- type: 'string',
30159
- },
30160
- },
30161
- required: ['device_id'],
30162
- type: 'object',
30163
- },
30164
- },
30165
- },
30166
- },
30167
- responses: {
30168
- 200: {
30169
- content: {
30170
- 'application/json': {
30171
- schema: {
30172
- properties: {
30173
- action_attempt: {
30174
- $ref: '#/components/schemas/action_attempt',
30175
- },
30176
- ok: { type: 'boolean' },
30177
- },
30178
- required: ['action_attempt', 'ok'],
30179
- type: 'object',
30180
- },
30181
- },
30182
- },
30183
- description: 'OK',
30184
- },
30185
- 400: { description: 'Bad Request' },
30186
- 401: { description: 'Unauthorized' },
30187
- },
30188
- security: [
30189
- { client_session: [] },
30190
- { pat_with_workspace: [] },
30191
- { console_session_with_workspace: [] },
30192
- { api_key: [] },
30193
- ],
30194
- summary: '/thermostats/activate_weekly_program',
30195
- tags: ['/thermostats'],
30196
- 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
30197
- 'x-fern-sdk-group-name': ['thermostats'],
30198
- 'x-fern-sdk-method-name': 'activate_weekly_program',
30199
- 'x-fern-sdk-return-value': 'action_attempt',
30200
- 'x-response-key': 'action_attempt',
30201
- 'x-title': 'Activate a Thermostat Weekly Program',
30202
- 'x-undocumented': 'Unreleased.',
30203
- },
30204
- },
30205
- '/thermostats/clear_weekly_program': {
30206
- post: {
30207
- description: 'Clears a thermostat weekly program.',
30208
- operationId: 'thermostatsClearWeeklyProgramPost',
30209
- requestBody: {
30210
- content: {
30211
- 'application/json': {
30212
- schema: {
30213
- properties: {
30214
- device_id: {
30215
- description:
30216
- 'ID of the thermostat device to clear the weekly program for.',
30217
- format: 'uuid',
30218
- type: 'string',
30219
- },
30220
- },
30221
- required: ['device_id'],
30222
- type: 'object',
30223
- },
30224
- },
30225
- },
30226
- },
30227
- responses: {
30228
- 200: {
30229
- content: {
30230
- 'application/json': {
30231
- schema: {
30232
- properties: {
30233
- action_attempt: {
30234
- $ref: '#/components/schemas/action_attempt',
30235
- },
30236
- ok: { type: 'boolean' },
30237
- },
30238
- required: ['action_attempt', 'ok'],
30239
- type: 'object',
30240
- },
30241
- },
30242
- },
30243
- description: 'OK',
30244
- },
30245
- 400: { description: 'Bad Request' },
30246
- 401: { description: 'Unauthorized' },
30247
- },
30248
- security: [
30249
- { client_session: [] },
30250
- { pat_with_workspace: [] },
30251
- { console_session_with_workspace: [] },
30252
- { api_key: [] },
30253
- ],
30254
- summary: '/thermostats/clear_weekly_program',
30255
- tags: ['/thermostats'],
30256
- 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
30257
- 'x-fern-sdk-group-name': ['thermostats'],
30258
- 'x-fern-sdk-method-name': 'clear_weekly_program',
30259
- 'x-fern-sdk-return-value': 'action_attempt',
30260
- 'x-response-key': 'action_attempt',
30261
- 'x-title': 'Clear a Thermostat Weekly Program',
30262
- 'x-undocumented': 'Unreleased.',
30263
- },
30264
- },
30265
30137
  '/thermostats/cool': {
30266
30138
  post: {
30267
30139
  description:
@@ -30285,7 +30157,8 @@ export default {
30285
30157
  type: 'number',
30286
30158
  },
30287
30159
  device_id: {
30288
- description: 'ID of the desired thermostat device.',
30160
+ description:
30161
+ 'ID of the thermostat device that you want to set to cool mode.',
30289
30162
  format: 'uuid',
30290
30163
  type: 'string',
30291
30164
  },
@@ -30366,7 +30239,8 @@ export default {
30366
30239
  type: 'number',
30367
30240
  },
30368
30241
  device_id: {
30369
- description: 'ID of the desired thermostat device.',
30242
+ description:
30243
+ 'ID of the thermostat device for which you want create a climate preset.',
30370
30244
  format: 'uuid',
30371
30245
  type: 'string',
30372
30246
  },
@@ -30449,7 +30323,8 @@ export default {
30449
30323
  },
30450
30324
  '/thermostats/daily_programs/create': {
30451
30325
  post: {
30452
- description: 'Creates a thermostat daily program.',
30326
+ description:
30327
+ '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.',
30453
30328
  operationId: 'thermostatsDailyProgramsCreatePost',
30454
30329
  requestBody: {
30455
30330
  content: {
@@ -30457,7 +30332,8 @@ export default {
30457
30332
  schema: {
30458
30333
  properties: {
30459
30334
  device_id: {
30460
- description: 'ID of the desired thermostat device.',
30335
+ description:
30336
+ 'ID of the thermostat device for which you want to create a daily program.',
30461
30337
  format: 'uuid',
30462
30338
  type: 'string',
30463
30339
  },
@@ -30469,15 +30345,17 @@ export default {
30469
30345
  periods: {
30470
30346
  description: 'Array of thermostat daily program periods.',
30471
30347
  items: {
30348
+ description:
30349
+ '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.',
30472
30350
  properties: {
30473
30351
  climate_preset_key: {
30474
30352
  description:
30475
- '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.',
30353
+ '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`.',
30476
30354
  type: 'string',
30477
30355
  },
30478
30356
  starts_at_time: {
30479
30357
  description:
30480
- 'Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
30358
+ 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
30481
30359
  pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
30482
30360
  type: 'string',
30483
30361
  },
@@ -30502,6 +30380,8 @@ export default {
30502
30380
  properties: {
30503
30381
  ok: { type: 'boolean' },
30504
30382
  thermostat_daily_program: {
30383
+ description:
30384
+ '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.',
30505
30385
  properties: {
30506
30386
  created_at: {
30507
30387
  description:
@@ -30510,7 +30390,8 @@ export default {
30510
30390
  type: 'string',
30511
30391
  },
30512
30392
  device_id: {
30513
- description: 'ID of the desired thermostat device.',
30393
+ description:
30394
+ 'ID of the thermostat device on which the thermostat daily program is configured.',
30514
30395
  format: 'uuid',
30515
30396
  type: 'string',
30516
30397
  },
@@ -30524,15 +30405,17 @@ export default {
30524
30405
  description:
30525
30406
  'Array of thermostat daily program periods.',
30526
30407
  items: {
30408
+ description:
30409
+ '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.',
30527
30410
  properties: {
30528
30411
  climate_preset_key: {
30529
30412
  description:
30530
- '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.',
30413
+ '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`.',
30531
30414
  type: 'string',
30532
30415
  },
30533
30416
  starts_at_time: {
30534
30417
  description:
30535
- 'Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
30418
+ 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
30536
30419
  pattern:
30537
30420
  '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
30538
30421
  type: 'string',
@@ -30564,6 +30447,7 @@ export default {
30564
30447
  'created_at',
30565
30448
  ],
30566
30449
  type: 'object',
30450
+ 'x-route-path': '/thermostats/thermostat_daily_programs',
30567
30451
  },
30568
30452
  },
30569
30453
  required: ['thermostat_daily_program', 'ok'],
@@ -30589,7 +30473,6 @@ export default {
30589
30473
  'x-fern-sdk-return-value': 'thermostat_daily_program',
30590
30474
  'x-response-key': 'thermostat_daily_program',
30591
30475
  'x-title': 'Create a Thermostat Daily Program',
30592
- 'x-undocumented': 'Unreleased.',
30593
30476
  },
30594
30477
  },
30595
30478
  '/thermostats/daily_programs/delete': {
@@ -30602,7 +30485,8 @@ export default {
30602
30485
  schema: {
30603
30486
  properties: {
30604
30487
  thermostat_daily_program_id: {
30605
- description: 'ID of the desired thermostat schedule.',
30488
+ description:
30489
+ 'ID of the thermostat daily program that you want to delete.',
30606
30490
  format: 'uuid',
30607
30491
  type: 'string',
30608
30492
  },
@@ -30641,12 +30525,12 @@ export default {
30641
30525
  'x-fern-sdk-method-name': 'delete',
30642
30526
  'x-response-key': null,
30643
30527
  'x-title': 'Delete a Thermostat Daily Program',
30644
- 'x-undocumented': 'Unreleased.',
30645
30528
  },
30646
30529
  },
30647
30530
  '/thermostats/daily_programs/update': {
30648
30531
  patch: {
30649
- description: 'Updates a specified thermostat daily program.',
30532
+ description:
30533
+ 'Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.',
30650
30534
  operationId: 'thermostatsDailyProgramsUpdatePatch',
30651
30535
  requestBody: {
30652
30536
  content: {
@@ -30655,21 +30539,24 @@ export default {
30655
30539
  properties: {
30656
30540
  name: {
30657
30541
  description:
30658
- 'User-friendly name to identify the thermostat daily program.',
30542
+ 'User-friendly name to identify the thermostat daily program that you want to update.',
30659
30543
  type: 'string',
30660
30544
  },
30661
30545
  periods: {
30662
- description: 'Array of thermostat daily program periods.',
30546
+ description:
30547
+ 'Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.',
30663
30548
  items: {
30549
+ description:
30550
+ '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.',
30664
30551
  properties: {
30665
30552
  climate_preset_key: {
30666
30553
  description:
30667
- '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.',
30554
+ '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`.',
30668
30555
  type: 'string',
30669
30556
  },
30670
30557
  starts_at_time: {
30671
30558
  description:
30672
- 'Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
30559
+ 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
30673
30560
  pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
30674
30561
  type: 'string',
30675
30562
  },
@@ -30680,7 +30567,8 @@ export default {
30680
30567
  type: 'array',
30681
30568
  },
30682
30569
  thermostat_daily_program_id: {
30683
- description: 'ID of the desired thermostat daily program.',
30570
+ description:
30571
+ 'ID of the thermostat daily program that you want to update.',
30684
30572
  format: 'uuid',
30685
30573
  type: 'string',
30686
30574
  },
@@ -30724,10 +30612,10 @@ export default {
30724
30612
  'x-fern-ignore': true,
30725
30613
  'x-response-key': 'action_attempt',
30726
30614
  'x-title': 'Update a Thermostat Daily Program',
30727
- 'x-undocumented': 'Unreleased.',
30728
30615
  },
30729
30616
  post: {
30730
- description: 'Updates a specified thermostat daily program.',
30617
+ description:
30618
+ 'Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.',
30731
30619
  operationId: 'thermostatsDailyProgramsUpdatePost',
30732
30620
  requestBody: {
30733
30621
  content: {
@@ -30736,21 +30624,24 @@ export default {
30736
30624
  properties: {
30737
30625
  name: {
30738
30626
  description:
30739
- 'User-friendly name to identify the thermostat daily program.',
30627
+ 'User-friendly name to identify the thermostat daily program that you want to update.',
30740
30628
  type: 'string',
30741
30629
  },
30742
30630
  periods: {
30743
- description: 'Array of thermostat daily program periods.',
30631
+ description:
30632
+ 'Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.',
30744
30633
  items: {
30634
+ description:
30635
+ '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.',
30745
30636
  properties: {
30746
30637
  climate_preset_key: {
30747
30638
  description:
30748
- '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.',
30639
+ '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`.',
30749
30640
  type: 'string',
30750
30641
  },
30751
30642
  starts_at_time: {
30752
30643
  description:
30753
- 'Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
30644
+ 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
30754
30645
  pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
30755
30646
  type: 'string',
30756
30647
  },
@@ -30761,7 +30652,8 @@ export default {
30761
30652
  type: 'array',
30762
30653
  },
30763
30654
  thermostat_daily_program_id: {
30764
- description: 'ID of the desired thermostat daily program.',
30655
+ description:
30656
+ 'ID of the thermostat daily program that you want to update.',
30765
30657
  format: 'uuid',
30766
30658
  type: 'string',
30767
30659
  },
@@ -30807,7 +30699,6 @@ export default {
30807
30699
  'x-fern-sdk-return-value': 'action_attempt',
30808
30700
  'x-response-key': 'action_attempt',
30809
30701
  'x-title': 'Update a Thermostat Daily Program',
30810
- 'x-undocumented': 'Unreleased.',
30811
30702
  },
30812
30703
  },
30813
30704
  '/thermostats/delete_climate_preset': {
@@ -30822,11 +30713,12 @@ export default {
30822
30713
  properties: {
30823
30714
  climate_preset_key: {
30824
30715
  description:
30825
- 'Climate preset key of the desired climate preset.',
30716
+ 'Climate preset key of the climate preset that you want to delete.',
30826
30717
  type: 'string',
30827
30718
  },
30828
30719
  device_id: {
30829
- description: 'ID of the desired thermostat device.',
30720
+ description:
30721
+ 'ID of the thermostat device for which you want to delete a climate preset.',
30830
30722
  format: 'uuid',
30831
30723
  type: 'string',
30832
30724
  },
@@ -30878,13 +30770,14 @@ export default {
30878
30770
  schema: {
30879
30771
  properties: {
30880
30772
  device_id: {
30881
- description: 'ID of the desired thermostat device.',
30773
+ description:
30774
+ 'ID of the thermostat device that you want to retrieve.',
30882
30775
  format: 'uuid',
30883
30776
  type: 'string',
30884
30777
  },
30885
30778
  name: {
30886
30779
  description:
30887
- 'User-friendly name of the desired thermostat device.',
30780
+ 'User-friendly name of the thermostat device that you want to retrieve.',
30888
30781
  type: 'string',
30889
30782
  },
30890
30783
  },
@@ -30940,7 +30833,8 @@ export default {
30940
30833
  schema: {
30941
30834
  properties: {
30942
30835
  device_id: {
30943
- description: 'ID of the desired thermostat device.',
30836
+ description:
30837
+ 'ID of the thermostat device that you want to set to heat mode.',
30944
30838
  format: 'uuid',
30945
30839
  type: 'string',
30946
30840
  },
@@ -31028,7 +30922,8 @@ export default {
31028
30922
  type: 'number',
31029
30923
  },
31030
30924
  device_id: {
31031
- description: 'ID of the desired thermostat device.',
30925
+ description:
30926
+ 'ID of the thermostat device that you want to set to heat-cool mode.',
31032
30927
  format: 'uuid',
31033
30928
  type: 'string',
31034
30929
  },
@@ -31135,6 +31030,10 @@ export default {
31135
31030
  '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.',
31136
31031
  type: 'object',
31137
31032
  },
31033
+ customer_ids: {
31034
+ items: { format: 'uuid', type: 'string' },
31035
+ type: 'array',
31036
+ },
31138
31037
  device_ids: {
31139
31038
  description:
31140
31039
  'Array of device IDs by which to filter devices.',
@@ -31142,7 +31041,8 @@ export default {
31142
31041
  type: 'array',
31143
31042
  },
31144
31043
  device_type: {
31145
- description: 'Device type by which to filter devices.',
31044
+ description:
31045
+ 'Device type by which to filter thermostat devices.',
31146
31046
  enum: [
31147
31047
  'ecobee_thermostat',
31148
31048
  'nest_thermostat',
@@ -31154,7 +31054,7 @@ export default {
31154
31054
  },
31155
31055
  device_types: {
31156
31056
  description:
31157
- 'Array of device types by which to filter devices.',
31057
+ 'Array of device types by which to filter thermostat devices.',
31158
31058
  items: {
31159
31059
  enum: [
31160
31060
  'ecobee_thermostat',
@@ -31215,8 +31115,15 @@ export default {
31215
31115
  type: 'number',
31216
31116
  },
31217
31117
  manufacturer: {
31218
- description: 'Manufacturer by which to filter devices.',
31219
- enum: ['ecobee', 'nest', 'honeywell_resideo', 'tado'],
31118
+ description:
31119
+ 'Manufacturer by which to filter thermostat devices.',
31120
+ enum: [
31121
+ 'ecobee',
31122
+ 'honeywell_resideo',
31123
+ 'nest',
31124
+ 'tado',
31125
+ 'sensi',
31126
+ ],
31220
31127
  type: 'string',
31221
31128
  },
31222
31129
  page_cursor: {
@@ -31294,7 +31201,8 @@ export default {
31294
31201
  schema: {
31295
31202
  properties: {
31296
31203
  device_id: {
31297
- description: 'ID of the desired thermostat device.',
31204
+ description:
31205
+ 'ID of the thermostat device that you want to set to off mode.',
31298
31206
  format: 'uuid',
31299
31207
  type: 'string',
31300
31208
  },
@@ -31797,11 +31705,12 @@ export default {
31797
31705
  properties: {
31798
31706
  climate_preset_key: {
31799
31707
  description:
31800
- 'Climate preset key of the desired climate preset.',
31708
+ 'Climate preset key of the climate preset that you want to set as the fallback climate preset.',
31801
31709
  type: 'string',
31802
31710
  },
31803
31711
  device_id: {
31804
- description: 'ID of the desired thermostat device.',
31712
+ description:
31713
+ 'ID of the thermostat device for which you want to set the fallback climate preset.',
31805
31714
  format: 'uuid',
31806
31715
  type: 'string',
31807
31716
  },
@@ -31851,7 +31760,12 @@ export default {
31851
31760
  'application/json': {
31852
31761
  schema: {
31853
31762
  properties: {
31854
- device_id: { format: 'uuid', type: 'string' },
31763
+ device_id: {
31764
+ description:
31765
+ 'ID of the thermostat device for which you want to set the fan mode.',
31766
+ format: 'uuid',
31767
+ type: 'string',
31768
+ },
31855
31769
  fan_mode: {
31856
31770
  deprecated: true,
31857
31771
  enum: ['auto', 'on', 'circulate'],
@@ -31927,7 +31841,8 @@ export default {
31927
31841
  {
31928
31842
  properties: {
31929
31843
  device_id: {
31930
- description: 'ID of the desired thermostat device.',
31844
+ description:
31845
+ 'ID of the thermostat device for which you want to set the HVAC mode.',
31931
31846
  format: 'uuid',
31932
31847
  type: 'string',
31933
31848
  },
@@ -31951,7 +31866,8 @@ export default {
31951
31866
  type: 'number',
31952
31867
  },
31953
31868
  device_id: {
31954
- description: 'ID of the desired thermostat device.',
31869
+ description:
31870
+ 'ID of the thermostat device for which you want to set the HVAC mode.',
31955
31871
  format: 'uuid',
31956
31872
  type: 'string',
31957
31873
  },
@@ -31963,7 +31879,8 @@ export default {
31963
31879
  {
31964
31880
  properties: {
31965
31881
  device_id: {
31966
- description: 'ID of the desired thermostat device.',
31882
+ description:
31883
+ 'ID of the thermostat device for which you want to set the HVAC mode.',
31967
31884
  format: 'uuid',
31968
31885
  type: 'string',
31969
31886
  },
@@ -31999,7 +31916,8 @@ export default {
31999
31916
  type: 'number',
32000
31917
  },
32001
31918
  device_id: {
32002
- description: 'ID of the desired thermostat device.',
31919
+ description:
31920
+ 'ID of the thermostat device for which you want to set the HVAC mode.',
32003
31921
  format: 'uuid',
32004
31922
  type: 'string',
32005
31923
  },
@@ -32076,7 +31994,8 @@ export default {
32076
31994
  schema: {
32077
31995
  properties: {
32078
31996
  device_id: {
32079
- description: 'ID of the desired thermostat device.',
31997
+ description:
31998
+ 'ID of the thermostat device for which you want to set a temperature threshold.',
32080
31999
  format: 'uuid',
32081
32000
  type: 'string',
32082
32001
  },
@@ -32156,7 +32075,8 @@ export default {
32156
32075
  schema: {
32157
32076
  properties: {
32158
32077
  device_id: {
32159
- description: 'ID of the desired thermostat device.',
32078
+ description:
32079
+ 'ID of the thermostat device for which you want to set a temperature threshold.',
32160
32080
  format: 'uuid',
32161
32081
  type: 'string',
32162
32082
  },
@@ -32480,7 +32400,8 @@ export default {
32480
32400
  type: 'number',
32481
32401
  },
32482
32402
  device_id: {
32483
- description: 'ID of the desired thermostat device.',
32403
+ description:
32404
+ 'ID of the thermostat device for which you want to update a climate preset.',
32484
32405
  format: 'uuid',
32485
32406
  type: 'string',
32486
32407
  },
@@ -32589,7 +32510,8 @@ export default {
32589
32510
  type: 'number',
32590
32511
  },
32591
32512
  device_id: {
32592
- description: 'ID of the desired thermostat device.',
32513
+ description:
32514
+ 'ID of the thermostat device for which you want to update a climate preset.',
32593
32515
  format: 'uuid',
32594
32516
  type: 'string',
32595
32517
  },
@@ -32673,6 +32595,115 @@ export default {
32673
32595
  'x-title': 'Update a Climate Preset',
32674
32596
  },
32675
32597
  },
32598
+ '/thermostats/update_weekly_program': {
32599
+ post: {
32600
+ description:
32601
+ '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.',
32602
+ operationId: 'thermostatsUpdateWeeklyProgramPost',
32603
+ requestBody: {
32604
+ content: {
32605
+ 'application/json': {
32606
+ schema: {
32607
+ properties: {
32608
+ device_id: {
32609
+ description:
32610
+ 'ID of the thermostat device for which you want to update the weekly program.',
32611
+ format: 'uuid',
32612
+ type: 'string',
32613
+ },
32614
+ friday_program_id: {
32615
+ description:
32616
+ 'ID of the thermostat daily program to run on Fridays.',
32617
+ format: 'uuid',
32618
+ nullable: true,
32619
+ type: 'string',
32620
+ },
32621
+ monday_program_id: {
32622
+ description:
32623
+ 'ID of the thermostat daily program to run on Mondays.',
32624
+ format: 'uuid',
32625
+ nullable: true,
32626
+ type: 'string',
32627
+ },
32628
+ saturday_program_id: {
32629
+ description:
32630
+ 'ID of the thermostat daily program to run on Saturdays.',
32631
+ format: 'uuid',
32632
+ nullable: true,
32633
+ type: 'string',
32634
+ },
32635
+ sunday_program_id: {
32636
+ description:
32637
+ 'ID of the thermostat daily program to run on Sundays.',
32638
+ format: 'uuid',
32639
+ nullable: true,
32640
+ type: 'string',
32641
+ },
32642
+ thursday_program_id: {
32643
+ description:
32644
+ 'ID of the thermostat daily program to run on Thursdays.',
32645
+ format: 'uuid',
32646
+ nullable: true,
32647
+ type: 'string',
32648
+ },
32649
+ tuesday_program_id: {
32650
+ description:
32651
+ 'ID of the thermostat daily program to run on Tuesdays.',
32652
+ format: 'uuid',
32653
+ nullable: true,
32654
+ type: 'string',
32655
+ },
32656
+ wednesday_program_id: {
32657
+ description:
32658
+ 'ID of the thermostat daily program to run on Wednesdays.',
32659
+ format: 'uuid',
32660
+ nullable: true,
32661
+ type: 'string',
32662
+ },
32663
+ },
32664
+ required: ['device_id'],
32665
+ type: 'object',
32666
+ },
32667
+ },
32668
+ },
32669
+ },
32670
+ responses: {
32671
+ 200: {
32672
+ content: {
32673
+ 'application/json': {
32674
+ schema: {
32675
+ properties: {
32676
+ action_attempt: {
32677
+ $ref: '#/components/schemas/action_attempt',
32678
+ },
32679
+ ok: { type: 'boolean' },
32680
+ },
32681
+ required: ['action_attempt', 'ok'],
32682
+ type: 'object',
32683
+ },
32684
+ },
32685
+ },
32686
+ description: 'OK',
32687
+ },
32688
+ 400: { description: 'Bad Request' },
32689
+ 401: { description: 'Unauthorized' },
32690
+ },
32691
+ security: [
32692
+ { client_session: [] },
32693
+ { pat_with_workspace: [] },
32694
+ { console_session_with_workspace: [] },
32695
+ { api_key: [] },
32696
+ ],
32697
+ summary: '/thermostats/update_weekly_program',
32698
+ tags: ['/thermostats'],
32699
+ 'x-action-attempt-type': 'PUSH_THERMOSTAT_PROGRAMS',
32700
+ 'x-fern-sdk-group-name': ['thermostats'],
32701
+ 'x-fern-sdk-method-name': 'update_weekly_program',
32702
+ 'x-fern-sdk-return-value': 'action_attempt',
32703
+ 'x-response-key': 'action_attempt',
32704
+ 'x-title': 'Update the Thermostat Weekly Program',
32705
+ },
32706
+ },
32676
32707
  '/unstable_access_grants/create': {
32677
32708
  post: {
32678
32709
  description: 'Creates a new access grant.',
@@ -34547,6 +34578,12 @@ export default {
34547
34578
  'application/json': {
34548
34579
  schema: {
34549
34580
  properties: {
34581
+ acs_system_ids: {
34582
+ description:
34583
+ "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.",
34584
+ items: { format: 'uuid', type: 'string' },
34585
+ type: 'array',
34586
+ },
34550
34587
  email_address: {
34551
34588
  description: 'Unique email address for the user identity.',
34552
34589
  format: 'email',