@seamapi/types 1.472.0 → 1.474.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/connect.cjs CHANGED
@@ -2265,6 +2265,29 @@ var unmanaged_access_code = access_code.pick({
2265
2265
 
2266
2266
  - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)
2267
2267
  `);
2268
+ var access_method = zod.z.object({
2269
+ workspace_id: zod.z.string().uuid().describe("ID of the Seam workspace associated with the access method."),
2270
+ access_method_id: zod.z.string().uuid().describe("ID of the access method."),
2271
+ display_name: zod.z.string().describe("Display name of the access method."),
2272
+ mode: zod.z.enum(["code", "card", "mobile_key"]).describe(
2273
+ "Access method mode. Supported values: `code`, `card`, `mobile_key`."
2274
+ ),
2275
+ created_at: zod.z.string().datetime().describe("Date and time at which the access method was created."),
2276
+ issued_at: zod.z.string().datetime().nullable().describe("Date and time at which the access method was issued."),
2277
+ is_issued: zod.z.boolean().describe("Indicates whether the access method has been issued."),
2278
+ instant_key_url: zod.z.string().url().optional().describe("URL of the Instant Key for mobile key access methods."),
2279
+ client_session_token: zod.z.string().optional().describe("Token of the client session associated with the access method."),
2280
+ is_encoding_required: zod.z.boolean().optional().describe(
2281
+ "Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method."
2282
+ ),
2283
+ code: zod.z.string().optional().describe("The actual PIN code for code access methods.")
2284
+ }).describe(`
2285
+ ---
2286
+ draft: Early access.
2287
+ route_path: /access_methods
2288
+ ---
2289
+ Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.
2290
+ `);
2268
2291
  var acs_access_group_external_type = zod.z.enum([
2269
2292
  "pti_unit",
2270
2293
  "pti_access_level",
@@ -4134,7 +4157,8 @@ zod.z.object({
4134
4157
  unmanaged_acs_users: unmanaged_acs_user.array().optional(),
4135
4158
  unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
4136
4159
  unmanaged_devices: unmanaged_device.array().optional(),
4137
- connect_webviews: connect_webview.array().optional()
4160
+ connect_webviews: connect_webview.array().optional(),
4161
+ access_methods: access_method.array().optional()
4138
4162
  }).describe("A batch of workspace resources.");
4139
4163
  var batch = zod.z.object({
4140
4164
  batch_type: zod.z.enum([
@@ -4157,7 +4181,8 @@ var batch = zod.z.object({
4157
4181
  unmanaged_acs_users: unmanaged_acs_user.array().optional(),
4158
4182
  unmanaged_acs_access_groups: unmanaged_acs_access_group.array().optional(),
4159
4183
  unmanaged_devices: unmanaged_device.array().optional(),
4160
- connect_webviews: connect_webview.array().optional()
4184
+ connect_webviews: connect_webview.array().optional(),
4185
+ access_methods: access_method.array().optional()
4161
4186
  }).describe("A batch of workspace resources.");
4162
4187
  var bridge = zod.z.object({
4163
4188
  bridge_id: zod.z.string().uuid().describe("ID of Seam Bridge."),
@@ -22598,53 +22623,6 @@ var openapi_default = {
22598
22623
  type: "object",
22599
22624
  "x-route-path": "/instant_keys"
22600
22625
  },
22601
- location: {
22602
- properties: {
22603
- created_at: {
22604
- description: "Date and time at which the location object was created.",
22605
- format: "date-time",
22606
- type: "string"
22607
- },
22608
- display_name: {
22609
- description: "Display name of the location.",
22610
- type: "string"
22611
- },
22612
- geolocation: {
22613
- description: "Geographical location of the location.",
22614
- properties: {
22615
- latitude: { format: "float", type: "number" },
22616
- longitude: { format: "float", type: "number" }
22617
- },
22618
- required: ["latitude", "longitude"],
22619
- type: "object"
22620
- },
22621
- location_id: {
22622
- description: "Unique identifier for the location.",
22623
- format: "uuid",
22624
- type: "string"
22625
- },
22626
- name: { description: "Name of the location.", type: "string" },
22627
- time_zone: {
22628
- description: "Time zone of the location.",
22629
- type: "string"
22630
- },
22631
- workspace_id: {
22632
- description: "Unique identifier for the Seam workspace associated with the location.",
22633
- format: "uuid",
22634
- type: "string"
22635
- }
22636
- },
22637
- required: [
22638
- "location_id",
22639
- "workspace_id",
22640
- "name",
22641
- "display_name",
22642
- "created_at"
22643
- ],
22644
- type: "object",
22645
- "x-route-path": "/unstable_locations",
22646
- "x-undocumented": "Will be removed."
22647
- },
22648
22626
  magic_link: {
22649
22627
  description: "Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product\u2014either by sharing a link with users or embedding a view in an iframe.\n\nWith Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.\n\nSeam hosts these flows, handling everything from account connection and device mapping to full-featured device control.",
22650
22628
  properties: {
@@ -31732,6 +31710,10 @@ var openapi_default = {
31732
31710
  batch: {
31733
31711
  description: "A batch of workspace resources.",
31734
31712
  properties: {
31713
+ access_methods: {
31714
+ items: { $ref: "#/components/schemas/access_method" },
31715
+ type: "array"
31716
+ },
31735
31717
  acs_access_groups: {
31736
31718
  items: {
31737
31719
  $ref: "#/components/schemas/acs_access_group"
@@ -31889,6 +31871,10 @@ var openapi_default = {
31889
31871
  batch: {
31890
31872
  description: "A batch of workspace resources.",
31891
31873
  properties: {
31874
+ access_methods: {
31875
+ items: { $ref: "#/components/schemas/access_method" },
31876
+ type: "array"
31877
+ },
31892
31878
  acs_access_groups: {
31893
31879
  items: {
31894
31880
  $ref: "#/components/schemas/acs_access_group"
@@ -54215,1211 +54201,112 @@ var openapi_default = {
54215
54201
  401: { description: "Unauthorized" }
54216
54202
  },
54217
54203
  security: [
54218
- { api_key: [] },
54219
- { pat_with_workspace: [] },
54220
- { console_session_with_workspace: [] }
54221
- ],
54222
- summary: "/thermostats/simulate/temperature_reached",
54223
- tags: ["/thermostats"],
54224
- "x-fern-sdk-group-name": ["thermostats", "simulate"],
54225
- "x-fern-sdk-method-name": "temperature_reached",
54226
- "x-response-key": null,
54227
- "x-title": "Temperature Reached"
54228
- }
54229
- },
54230
- "/thermostats/update_climate_preset": {
54231
- patch: {
54232
- description: "Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
54233
- operationId: "thermostatsUpdateClimatePresetPatch",
54234
- requestBody: {
54235
- content: {
54236
- "application/json": {
54237
- schema: {
54238
- properties: {
54239
- climate_preset_key: {
54240
- description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
54241
- type: "string"
54242
- },
54243
- climate_preset_mode: {
54244
- description: "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ",
54245
- enum: [
54246
- "home",
54247
- "away",
54248
- "wake",
54249
- "sleep",
54250
- "occupied",
54251
- "unoccupied"
54252
- ],
54253
- type: "string"
54254
- },
54255
- cooling_set_point_celsius: {
54256
- description: "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54257
- format: "float",
54258
- type: "number"
54259
- },
54260
- cooling_set_point_fahrenheit: {
54261
- description: "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54262
- format: "float",
54263
- type: "number"
54264
- },
54265
- device_id: {
54266
- description: "ID of the thermostat device for which you want to update a climate preset.",
54267
- format: "uuid",
54268
- type: "string"
54269
- },
54270
- ecobee_metadata: {
54271
- description: "\n Metadata specific to the Ecobee climate, if applicable.\n ",
54272
- properties: {
54273
- climate_ref: {
54274
- description: "Reference to the Ecobee climate, if applicable.",
54275
- type: "string"
54276
- },
54277
- is_optimized: {
54278
- description: "Indicates if the climate preset is optimized by Ecobee.",
54279
- type: "boolean"
54280
- },
54281
- owner: {
54282
- description: "Indicates whether the climate preset is owned by the user or the system.",
54283
- enum: ["user", "system"],
54284
- type: "string"
54285
- }
54286
- },
54287
- required: ["climate_ref", "is_optimized", "owner"],
54288
- type: "object"
54289
- },
54290
- fan_mode_setting: {
54291
- description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.",
54292
- enum: ["auto", "on", "circulate"],
54293
- type: "string"
54294
- },
54295
- heating_set_point_celsius: {
54296
- description: "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54297
- format: "float",
54298
- type: "number"
54299
- },
54300
- heating_set_point_fahrenheit: {
54301
- description: "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54302
- format: "float",
54303
- type: "number"
54304
- },
54305
- hvac_mode_setting: {
54306
- description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.",
54307
- enum: ["off", "heat", "cool", "heat_cool", "eco"],
54308
- type: "string"
54309
- },
54310
- manual_override_allowed: {
54311
- deprecated: true,
54312
- description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
54313
- type: "boolean",
54314
- "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
54315
- },
54316
- name: {
54317
- default: null,
54318
- description: "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
54319
- nullable: true,
54320
- type: "string"
54321
- }
54322
- },
54323
- required: ["device_id", "climate_preset_key"],
54324
- type: "object"
54325
- }
54326
- }
54327
- }
54328
- },
54329
- responses: {
54330
- 200: {
54331
- content: {
54332
- "application/json": {
54333
- schema: {
54334
- properties: { ok: { type: "boolean" } },
54335
- required: ["ok"],
54336
- type: "object"
54337
- }
54338
- }
54339
- },
54340
- description: "OK"
54341
- },
54342
- 400: { description: "Bad Request" },
54343
- 401: { description: "Unauthorized" }
54344
- },
54345
- security: [
54346
- { pat_with_workspace: [] },
54347
- { console_session_with_workspace: [] },
54348
- { api_key: [] },
54349
- { client_session: [] }
54350
- ],
54351
- summary: "/thermostats/update_climate_preset",
54352
- tags: ["/thermostats"],
54353
- "x-fern-sdk-group-name": ["thermostats"],
54354
- "x-fern-sdk-method-name": "update_climate_preset",
54355
- "x-response-key": null,
54356
- "x-title": "Update a Climate Preset"
54357
- },
54358
- post: {
54359
- description: "Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
54360
- operationId: "thermostatsUpdateClimatePresetPost",
54361
- requestBody: {
54362
- content: {
54363
- "application/json": {
54364
- schema: {
54365
- properties: {
54366
- climate_preset_key: {
54367
- description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
54368
- type: "string"
54369
- },
54370
- climate_preset_mode: {
54371
- description: "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ",
54372
- enum: [
54373
- "home",
54374
- "away",
54375
- "wake",
54376
- "sleep",
54377
- "occupied",
54378
- "unoccupied"
54379
- ],
54380
- type: "string"
54381
- },
54382
- cooling_set_point_celsius: {
54383
- description: "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54384
- format: "float",
54385
- type: "number"
54386
- },
54387
- cooling_set_point_fahrenheit: {
54388
- description: "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54389
- format: "float",
54390
- type: "number"
54391
- },
54392
- device_id: {
54393
- description: "ID of the thermostat device for which you want to update a climate preset.",
54394
- format: "uuid",
54395
- type: "string"
54396
- },
54397
- ecobee_metadata: {
54398
- description: "\n Metadata specific to the Ecobee climate, if applicable.\n ",
54399
- properties: {
54400
- climate_ref: {
54401
- description: "Reference to the Ecobee climate, if applicable.",
54402
- type: "string"
54403
- },
54404
- is_optimized: {
54405
- description: "Indicates if the climate preset is optimized by Ecobee.",
54406
- type: "boolean"
54407
- },
54408
- owner: {
54409
- description: "Indicates whether the climate preset is owned by the user or the system.",
54410
- enum: ["user", "system"],
54411
- type: "string"
54412
- }
54413
- },
54414
- required: ["climate_ref", "is_optimized", "owner"],
54415
- type: "object"
54416
- },
54417
- fan_mode_setting: {
54418
- description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.",
54419
- enum: ["auto", "on", "circulate"],
54420
- type: "string"
54421
- },
54422
- heating_set_point_celsius: {
54423
- description: "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54424
- format: "float",
54425
- type: "number"
54426
- },
54427
- heating_set_point_fahrenheit: {
54428
- description: "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54429
- format: "float",
54430
- type: "number"
54431
- },
54432
- hvac_mode_setting: {
54433
- description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.",
54434
- enum: ["off", "heat", "cool", "heat_cool", "eco"],
54435
- type: "string"
54436
- },
54437
- manual_override_allowed: {
54438
- deprecated: true,
54439
- description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
54440
- type: "boolean",
54441
- "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
54442
- },
54443
- name: {
54444
- default: null,
54445
- description: "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
54446
- nullable: true,
54447
- type: "string"
54448
- }
54449
- },
54450
- required: ["device_id", "climate_preset_key"],
54451
- type: "object"
54452
- }
54453
- }
54454
- }
54455
- },
54456
- responses: {
54457
- 200: {
54458
- content: {
54459
- "application/json": {
54460
- schema: {
54461
- properties: { ok: { type: "boolean" } },
54462
- required: ["ok"],
54463
- type: "object"
54464
- }
54465
- }
54466
- },
54467
- description: "OK"
54468
- },
54469
- 400: { description: "Bad Request" },
54470
- 401: { description: "Unauthorized" }
54471
- },
54472
- security: [
54473
- { pat_with_workspace: [] },
54474
- { console_session_with_workspace: [] },
54475
- { api_key: [] },
54476
- { client_session: [] }
54477
- ],
54478
- summary: "/thermostats/update_climate_preset",
54479
- tags: ["/thermostats"],
54480
- "x-fern-sdk-group-name": ["thermostats"],
54481
- "x-fern-sdk-method-name": "update_climate_preset",
54482
- "x-response-key": null,
54483
- "x-title": "Update a Climate Preset"
54484
- }
54485
- },
54486
- "/thermostats/update_weekly_program": {
54487
- post: {
54488
- 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.",
54489
- operationId: "thermostatsUpdateWeeklyProgramPost",
54490
- requestBody: {
54491
- content: {
54492
- "application/json": {
54493
- schema: {
54494
- properties: {
54495
- device_id: {
54496
- description: "ID of the thermostat device for which you want to update the weekly program.",
54497
- format: "uuid",
54498
- type: "string"
54499
- },
54500
- friday_program_id: {
54501
- description: "ID of the thermostat daily program to run on Fridays.",
54502
- format: "uuid",
54503
- nullable: true,
54504
- type: "string"
54505
- },
54506
- monday_program_id: {
54507
- description: "ID of the thermostat daily program to run on Mondays.",
54508
- format: "uuid",
54509
- nullable: true,
54510
- type: "string"
54511
- },
54512
- saturday_program_id: {
54513
- description: "ID of the thermostat daily program to run on Saturdays.",
54514
- format: "uuid",
54515
- nullable: true,
54516
- type: "string"
54517
- },
54518
- sunday_program_id: {
54519
- description: "ID of the thermostat daily program to run on Sundays.",
54520
- format: "uuid",
54521
- nullable: true,
54522
- type: "string"
54523
- },
54524
- thursday_program_id: {
54525
- description: "ID of the thermostat daily program to run on Thursdays.",
54526
- format: "uuid",
54527
- nullable: true,
54528
- type: "string"
54529
- },
54530
- tuesday_program_id: {
54531
- description: "ID of the thermostat daily program to run on Tuesdays.",
54532
- format: "uuid",
54533
- nullable: true,
54534
- type: "string"
54535
- },
54536
- wednesday_program_id: {
54537
- description: "ID of the thermostat daily program to run on Wednesdays.",
54538
- format: "uuid",
54539
- nullable: true,
54540
- type: "string"
54541
- }
54542
- },
54543
- required: ["device_id"],
54544
- type: "object"
54545
- }
54546
- }
54547
- }
54548
- },
54549
- responses: {
54550
- 200: {
54551
- content: {
54552
- "application/json": {
54553
- schema: {
54554
- properties: {
54555
- action_attempt: {
54556
- $ref: "#/components/schemas/action_attempt"
54557
- },
54558
- ok: { type: "boolean" }
54559
- },
54560
- required: ["action_attempt", "ok"],
54561
- type: "object"
54562
- }
54563
- }
54564
- },
54565
- description: "OK"
54566
- },
54567
- 400: { description: "Bad Request" },
54568
- 401: { description: "Unauthorized" }
54569
- },
54570
- security: [
54571
- { client_session: [] },
54572
- { pat_with_workspace: [] },
54573
- { console_session_with_workspace: [] },
54574
- { api_key: [] }
54575
- ],
54576
- summary: "/thermostats/update_weekly_program",
54577
- tags: ["/thermostats"],
54578
- "x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS",
54579
- "x-fern-sdk-group-name": ["thermostats"],
54580
- "x-fern-sdk-method-name": "update_weekly_program",
54581
- "x-fern-sdk-return-value": "action_attempt",
54582
- "x-response-key": "action_attempt",
54583
- "x-title": "Update the Thermostat Weekly Program"
54584
- }
54585
- },
54586
- "/unstable_locations/add_acs_entrances": {
54587
- post: {
54588
- description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.",
54589
- operationId: "unstableLocationsAddAcsEntrancesPost",
54590
- requestBody: {
54591
- content: {
54592
- "application/json": {
54593
- schema: {
54594
- properties: {
54595
- acs_entrance_ids: {
54596
- description: "IDs of the entrances that you want to add to the location.",
54597
- items: { format: "uuid", type: "string" },
54598
- minItems: 1,
54599
- type: "array"
54600
- },
54601
- location_id: {
54602
- description: "ID of the location to which you want to add entrances.",
54603
- format: "uuid",
54604
- type: "string"
54605
- }
54606
- },
54607
- required: ["location_id", "acs_entrance_ids"],
54608
- type: "object"
54609
- }
54610
- }
54611
- }
54612
- },
54613
- responses: {
54614
- 200: {
54615
- content: {
54616
- "application/json": {
54617
- schema: {
54618
- properties: { ok: { type: "boolean" } },
54619
- required: ["ok"],
54620
- type: "object"
54621
- }
54622
- }
54623
- },
54624
- description: "OK"
54625
- },
54626
- 400: { description: "Bad Request" },
54627
- 401: { description: "Unauthorized" }
54628
- },
54629
- security: [
54630
- { pat_with_workspace: [] },
54631
- { console_session_with_workspace: [] },
54632
- { api_key: [] }
54633
- ],
54634
- summary: "/unstable_locations/add_acs_entrances",
54635
- tags: [],
54636
- "x-fern-sdk-group-name": ["unstable_locations"],
54637
- "x-fern-sdk-method-name": "add_acs_entrances",
54638
- "x-response-key": null,
54639
- "x-title": "Add Entrances to a Location",
54640
- "x-undocumented": "Experimental locations."
54641
- },
54642
- put: {
54643
- description: "Adds [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to a specific location.",
54644
- operationId: "unstableLocationsAddAcsEntrancesPut",
54645
- requestBody: {
54646
- content: {
54647
- "application/json": {
54648
- schema: {
54649
- properties: {
54650
- acs_entrance_ids: {
54651
- description: "IDs of the entrances that you want to add to the location.",
54652
- items: { format: "uuid", type: "string" },
54653
- minItems: 1,
54654
- type: "array"
54655
- },
54656
- location_id: {
54657
- description: "ID of the location to which you want to add entrances.",
54658
- format: "uuid",
54659
- type: "string"
54660
- }
54661
- },
54662
- required: ["location_id", "acs_entrance_ids"],
54663
- type: "object"
54664
- }
54665
- }
54666
- }
54667
- },
54668
- responses: {
54669
- 200: {
54670
- content: {
54671
- "application/json": {
54672
- schema: {
54673
- properties: { ok: { type: "boolean" } },
54674
- required: ["ok"],
54675
- type: "object"
54676
- }
54677
- }
54678
- },
54679
- description: "OK"
54680
- },
54681
- 400: { description: "Bad Request" },
54682
- 401: { description: "Unauthorized" }
54683
- },
54684
- security: [
54685
- { pat_with_workspace: [] },
54686
- { console_session_with_workspace: [] },
54687
- { api_key: [] }
54688
- ],
54689
- summary: "/unstable_locations/add_acs_entrances",
54690
- tags: [],
54691
- "x-fern-sdk-group-name": ["unstable_locations"],
54692
- "x-fern-sdk-method-name": "add_acs_entrances",
54693
- "x-response-key": null,
54694
- "x-title": "Add Entrances to a Location",
54695
- "x-undocumented": "Experimental locations."
54696
- }
54697
- },
54698
- "/unstable_locations/add_devices": {
54699
- post: {
54700
- description: "Adds devices to a specific location.",
54701
- operationId: "unstableLocationsAddDevicesPost",
54702
- requestBody: {
54703
- content: {
54704
- "application/json": {
54705
- schema: {
54706
- properties: {
54707
- device_ids: {
54708
- description: "IDs of the devices that you want to add to the location.",
54709
- items: { format: "uuid", type: "string" },
54710
- minItems: 1,
54711
- type: "array"
54712
- },
54713
- location_id: {
54714
- description: "ID of the location to which you want to add devices.",
54715
- format: "uuid",
54716
- type: "string"
54717
- }
54718
- },
54719
- required: ["location_id", "device_ids"],
54720
- type: "object"
54721
- }
54722
- }
54723
- }
54724
- },
54725
- responses: {
54726
- 200: {
54727
- content: {
54728
- "application/json": {
54729
- schema: {
54730
- properties: { ok: { type: "boolean" } },
54731
- required: ["ok"],
54732
- type: "object"
54733
- }
54734
- }
54735
- },
54736
- description: "OK"
54737
- },
54738
- 400: { description: "Bad Request" },
54739
- 401: { description: "Unauthorized" }
54740
- },
54741
- security: [
54742
- { pat_with_workspace: [] },
54743
- { console_session_with_workspace: [] },
54744
- { api_key: [] }
54745
- ],
54746
- summary: "/unstable_locations/add_devices",
54747
- tags: [],
54748
- "x-fern-sdk-group-name": ["unstable_locations"],
54749
- "x-fern-sdk-method-name": "add_devices",
54750
- "x-response-key": null,
54751
- "x-title": "Add Devices to a Location",
54752
- "x-undocumented": "Experimental locations."
54753
- },
54754
- put: {
54755
- description: "Adds devices to a specific location.",
54756
- operationId: "unstableLocationsAddDevicesPut",
54757
- requestBody: {
54758
- content: {
54759
- "application/json": {
54760
- schema: {
54761
- properties: {
54762
- device_ids: {
54763
- description: "IDs of the devices that you want to add to the location.",
54764
- items: { format: "uuid", type: "string" },
54765
- minItems: 1,
54766
- type: "array"
54767
- },
54768
- location_id: {
54769
- description: "ID of the location to which you want to add devices.",
54770
- format: "uuid",
54771
- type: "string"
54772
- }
54773
- },
54774
- required: ["location_id", "device_ids"],
54775
- type: "object"
54776
- }
54777
- }
54778
- }
54779
- },
54780
- responses: {
54781
- 200: {
54782
- content: {
54783
- "application/json": {
54784
- schema: {
54785
- properties: { ok: { type: "boolean" } },
54786
- required: ["ok"],
54787
- type: "object"
54788
- }
54789
- }
54790
- },
54791
- description: "OK"
54792
- },
54793
- 400: { description: "Bad Request" },
54794
- 401: { description: "Unauthorized" }
54795
- },
54796
- security: [
54797
- { pat_with_workspace: [] },
54798
- { console_session_with_workspace: [] },
54799
- { api_key: [] }
54800
- ],
54801
- summary: "/unstable_locations/add_devices",
54802
- tags: [],
54803
- "x-fern-sdk-group-name": ["unstable_locations"],
54804
- "x-fern-sdk-method-name": "add_devices",
54805
- "x-response-key": null,
54806
- "x-title": "Add Devices to a Location",
54807
- "x-undocumented": "Experimental locations."
54808
- }
54809
- },
54810
- "/unstable_locations/create": {
54811
- post: {
54812
- description: "Creates a new location.",
54813
- operationId: "unstableLocationsCreatePost",
54814
- requestBody: {
54815
- content: {
54816
- "application/json": {
54817
- schema: {
54818
- properties: {
54819
- acs_entrance_ids: {
54820
- description: "IDs of the entrances that you want to add to the new location.",
54821
- items: { format: "uuid", type: "string" },
54822
- type: "array"
54823
- },
54824
- device_ids: {
54825
- description: "IDs of the devices that you want to add to the new location.",
54826
- items: { format: "uuid", type: "string" },
54827
- type: "array"
54828
- },
54829
- geolocation: {
54830
- description: "Geolocation of the new location.",
54831
- properties: {
54832
- latitude: { format: "float", type: "number" },
54833
- longitude: { format: "float", type: "number" }
54834
- },
54835
- required: ["latitude", "longitude"],
54836
- type: "object"
54837
- },
54838
- name: {
54839
- description: "Name of the new location.",
54840
- type: "string"
54841
- },
54842
- time_zone: {
54843
- description: "Time zone of the new location.",
54844
- type: "string"
54845
- }
54846
- },
54847
- required: ["name"],
54848
- type: "object"
54849
- }
54850
- }
54851
- }
54852
- },
54853
- responses: {
54854
- 200: {
54855
- content: {
54856
- "application/json": {
54857
- schema: {
54858
- properties: {
54859
- location: { $ref: "#/components/schemas/location" },
54860
- ok: { type: "boolean" }
54861
- },
54862
- required: ["location", "ok"],
54863
- type: "object"
54864
- }
54865
- }
54866
- },
54867
- description: "OK"
54868
- },
54869
- 400: { description: "Bad Request" },
54870
- 401: { description: "Unauthorized" }
54871
- },
54872
- security: [
54873
- { pat_with_workspace: [] },
54874
- { console_session_with_workspace: [] },
54875
- { api_key: [] }
54876
- ],
54877
- summary: "/unstable_locations/create",
54878
- tags: [],
54879
- "x-fern-sdk-group-name": ["unstable_locations"],
54880
- "x-fern-sdk-method-name": "create",
54881
- "x-fern-sdk-return-value": "location",
54882
- "x-response-key": "location",
54883
- "x-title": "Create a Location",
54884
- "x-undocumented": "Experimental locations."
54885
- }
54886
- },
54887
- "/unstable_locations/delete": {
54888
- delete: {
54889
- description: "Deletes a location.",
54890
- operationId: "unstableLocationsDeleteDelete",
54891
- requestBody: {
54892
- content: {
54893
- "application/json": {
54894
- schema: {
54895
- properties: {
54896
- location_id: {
54897
- description: "ID of the location that you want to delete.",
54898
- format: "uuid",
54899
- type: "string"
54900
- }
54901
- },
54902
- required: ["location_id"],
54903
- type: "object"
54904
- }
54905
- }
54906
- }
54907
- },
54908
- responses: {
54909
- 200: {
54910
- content: {
54911
- "application/json": {
54912
- schema: {
54913
- properties: { ok: { type: "boolean" } },
54914
- required: ["ok"],
54915
- type: "object"
54916
- }
54917
- }
54918
- },
54919
- description: "OK"
54920
- },
54921
- 400: { description: "Bad Request" },
54922
- 401: { description: "Unauthorized" }
54923
- },
54924
- security: [
54925
- { pat_with_workspace: [] },
54926
- { console_session_with_workspace: [] },
54927
- { api_key: [] }
54928
- ],
54929
- summary: "/unstable_locations/delete",
54930
- tags: [],
54931
- "x-fern-sdk-group-name": ["unstable_locations"],
54932
- "x-fern-sdk-method-name": "delete",
54933
- "x-response-key": null,
54934
- "x-title": "Delete a Location",
54935
- "x-undocumented": "Experimental locations."
54936
- },
54937
- post: {
54938
- description: "Deletes a location.",
54939
- operationId: "unstableLocationsDeletePost",
54940
- requestBody: {
54941
- content: {
54942
- "application/json": {
54943
- schema: {
54944
- properties: {
54945
- location_id: {
54946
- description: "ID of the location that you want to delete.",
54947
- format: "uuid",
54948
- type: "string"
54949
- }
54950
- },
54951
- required: ["location_id"],
54952
- type: "object"
54953
- }
54954
- }
54955
- }
54956
- },
54957
- responses: {
54958
- 200: {
54959
- content: {
54960
- "application/json": {
54961
- schema: {
54962
- properties: { ok: { type: "boolean" } },
54963
- required: ["ok"],
54964
- type: "object"
54965
- }
54966
- }
54967
- },
54968
- description: "OK"
54969
- },
54970
- 400: { description: "Bad Request" },
54971
- 401: { description: "Unauthorized" }
54972
- },
54973
- security: [
54974
- { pat_with_workspace: [] },
54975
- { console_session_with_workspace: [] },
54976
- { api_key: [] }
54977
- ],
54978
- summary: "/unstable_locations/delete",
54979
- tags: [],
54980
- "x-fern-sdk-group-name": ["unstable_locations"],
54981
- "x-fern-sdk-method-name": "delete",
54982
- "x-response-key": null,
54983
- "x-title": "Delete a Location",
54984
- "x-undocumented": "Experimental locations."
54985
- }
54986
- },
54987
- "/unstable_locations/get": {
54988
- get: {
54989
- description: "Gets a location.",
54990
- operationId: "unstableLocationsGetGet",
54991
- parameters: [
54992
- {
54993
- in: "query",
54994
- name: "location_id",
54995
- required: true,
54996
- schema: {
54997
- description: "ID of the location that you want to get.",
54998
- format: "uuid",
54999
- type: "string"
55000
- }
55001
- }
55002
- ],
55003
- responses: {
55004
- 200: {
55005
- content: {
55006
- "application/json": {
55007
- schema: {
55008
- properties: {
55009
- location: { $ref: "#/components/schemas/location" },
55010
- ok: { type: "boolean" }
55011
- },
55012
- required: ["location", "ok"],
55013
- type: "object"
55014
- }
55015
- }
55016
- },
55017
- description: "OK"
55018
- },
55019
- 400: { description: "Bad Request" },
55020
- 401: { description: "Unauthorized" }
55021
- },
55022
- security: [
55023
- { pat_with_workspace: [] },
55024
- { console_session_with_workspace: [] },
55025
- { api_key: [] }
55026
- ],
55027
- summary: "/unstable_locations/get",
55028
- tags: [],
55029
- "x-fern-sdk-group-name": ["unstable_locations"],
55030
- "x-fern-sdk-method-name": "get",
55031
- "x-fern-sdk-return-value": "location",
55032
- "x-response-key": "location",
55033
- "x-title": "Get a Location",
55034
- "x-undocumented": "Experimental locations."
55035
- },
55036
- post: {
55037
- description: "Gets a location.",
55038
- operationId: "unstableLocationsGetPost",
55039
- requestBody: {
55040
- content: {
55041
- "application/json": {
55042
- schema: {
55043
- properties: {
55044
- location_id: {
55045
- description: "ID of the location that you want to get.",
55046
- format: "uuid",
55047
- type: "string"
55048
- }
55049
- },
55050
- required: ["location_id"],
55051
- type: "object"
55052
- }
55053
- }
55054
- }
55055
- },
55056
- responses: {
55057
- 200: {
55058
- content: {
55059
- "application/json": {
55060
- schema: {
55061
- properties: {
55062
- location: { $ref: "#/components/schemas/location" },
55063
- ok: { type: "boolean" }
55064
- },
55065
- required: ["location", "ok"],
55066
- type: "object"
55067
- }
55068
- }
55069
- },
55070
- description: "OK"
55071
- },
55072
- 400: { description: "Bad Request" },
55073
- 401: { description: "Unauthorized" }
55074
- },
55075
- security: [
55076
- { pat_with_workspace: [] },
55077
- { console_session_with_workspace: [] },
55078
- { api_key: [] }
55079
- ],
55080
- summary: "/unstable_locations/get",
55081
- tags: [],
55082
- "x-fern-sdk-group-name": ["unstable_locations"],
55083
- "x-fern-sdk-method-name": "get",
55084
- "x-fern-sdk-return-value": "location",
55085
- "x-response-key": "location",
55086
- "x-title": "Get a Location",
55087
- "x-undocumented": "Experimental locations."
55088
- }
55089
- },
55090
- "/unstable_locations/list": {
55091
- get: {
55092
- description: "Returns a list of all locations.",
55093
- operationId: "unstableLocationsListGet",
55094
- responses: {
55095
- 200: {
55096
- content: {
55097
- "application/json": {
55098
- schema: {
55099
- properties: {
55100
- locations: {
55101
- items: { $ref: "#/components/schemas/location" },
55102
- type: "array"
55103
- },
55104
- ok: { type: "boolean" }
55105
- },
55106
- required: ["locations", "ok"],
55107
- type: "object"
55108
- }
55109
- }
55110
- },
55111
- description: "OK"
55112
- },
55113
- 400: { description: "Bad Request" },
55114
- 401: { description: "Unauthorized" }
55115
- },
55116
- security: [
55117
- { pat_with_workspace: [] },
55118
- { console_session_with_workspace: [] },
55119
- { api_key: [] }
55120
- ],
55121
- summary: "/unstable_locations/list",
55122
- tags: [],
55123
- "x-fern-sdk-group-name": ["unstable_locations"],
55124
- "x-fern-sdk-method-name": "list",
55125
- "x-fern-sdk-return-value": "locations",
55126
- "x-response-key": "locations",
55127
- "x-title": "List Locations",
55128
- "x-undocumented": "Experimental locations."
55129
- },
55130
- post: {
55131
- description: "Returns a list of all locations.",
55132
- operationId: "unstableLocationsListPost",
55133
- responses: {
55134
- 200: {
55135
- content: {
55136
- "application/json": {
55137
- schema: {
55138
- properties: {
55139
- locations: {
55140
- items: { $ref: "#/components/schemas/location" },
55141
- type: "array"
55142
- },
55143
- ok: { type: "boolean" }
55144
- },
55145
- required: ["locations", "ok"],
55146
- type: "object"
55147
- }
55148
- }
55149
- },
55150
- description: "OK"
55151
- },
55152
- 400: { description: "Bad Request" },
55153
- 401: { description: "Unauthorized" }
55154
- },
55155
- security: [
55156
- { pat_with_workspace: [] },
55157
- { console_session_with_workspace: [] },
55158
- { api_key: [] }
55159
- ],
55160
- summary: "/unstable_locations/list",
55161
- tags: [],
55162
- "x-fern-sdk-group-name": ["unstable_locations"],
55163
- "x-fern-sdk-method-name": "list",
55164
- "x-fern-sdk-return-value": "locations",
55165
- "x-response-key": "locations",
55166
- "x-title": "List Locations",
55167
- "x-undocumented": "Experimental locations."
55168
- }
55169
- },
55170
- "/unstable_locations/remove_acs_entrances": {
55171
- delete: {
55172
- description: "Removes entrances from a specific location.",
55173
- operationId: "unstableLocationsRemoveAcsEntrancesDelete",
55174
- parameters: [
55175
- {
55176
- in: "query",
55177
- name: "location_id",
55178
- required: true,
55179
- schema: {
55180
- description: "ID of the location from which you want to remove entrances.",
55181
- format: "uuid",
55182
- type: "string"
55183
- }
55184
- },
55185
- {
55186
- in: "query",
55187
- name: "acs_entrance_ids",
55188
- required: true,
55189
- schema: {
55190
- description: "IDs of the entrances that you want to remove from the location.",
55191
- items: { format: "uuid", type: "string" },
55192
- type: "array"
55193
- }
55194
- }
55195
- ],
55196
- responses: {
55197
- 200: {
55198
- content: {
55199
- "application/json": {
55200
- schema: {
55201
- properties: { ok: { type: "boolean" } },
55202
- required: ["ok"],
55203
- type: "object"
55204
- }
55205
- }
55206
- },
55207
- description: "OK"
55208
- },
55209
- 400: { description: "Bad Request" },
55210
- 401: { description: "Unauthorized" }
55211
- },
55212
- security: [
55213
- { pat_with_workspace: [] },
55214
- { console_session_with_workspace: [] },
55215
- { api_key: [] }
55216
- ],
55217
- summary: "/unstable_locations/remove_acs_entrances",
55218
- tags: [],
55219
- "x-fern-sdk-group-name": ["unstable_locations"],
55220
- "x-fern-sdk-method-name": "remove_acs_entrances",
55221
- "x-response-key": null,
55222
- "x-title": "Remove Entrances from a Location",
55223
- "x-undocumented": "Experimental locations."
55224
- },
55225
- post: {
55226
- description: "Removes entrances from a specific location.",
55227
- operationId: "unstableLocationsRemoveAcsEntrancesPost",
55228
- requestBody: {
55229
- content: {
55230
- "application/json": {
55231
- schema: {
55232
- properties: {
55233
- acs_entrance_ids: {
55234
- description: "IDs of the entrances that you want to remove from the location.",
55235
- items: { format: "uuid", type: "string" },
55236
- type: "array"
55237
- },
55238
- location_id: {
55239
- description: "ID of the location from which you want to remove entrances.",
55240
- format: "uuid",
55241
- type: "string"
55242
- }
55243
- },
55244
- required: ["location_id", "acs_entrance_ids"],
55245
- type: "object"
55246
- }
55247
- }
55248
- }
55249
- },
55250
- responses: {
55251
- 200: {
55252
- content: {
55253
- "application/json": {
55254
- schema: {
55255
- properties: { ok: { type: "boolean" } },
55256
- required: ["ok"],
55257
- type: "object"
55258
- }
55259
- }
55260
- },
55261
- description: "OK"
55262
- },
55263
- 400: { description: "Bad Request" },
55264
- 401: { description: "Unauthorized" }
55265
- },
55266
- security: [
55267
- { pat_with_workspace: [] },
55268
- { console_session_with_workspace: [] },
55269
- { api_key: [] }
55270
- ],
55271
- summary: "/unstable_locations/remove_acs_entrances",
55272
- tags: [],
55273
- "x-fern-sdk-group-name": ["unstable_locations"],
55274
- "x-fern-sdk-method-name": "remove_acs_entrances",
55275
- "x-response-key": null,
55276
- "x-title": "Remove Entrances from a Location",
55277
- "x-undocumented": "Experimental locations."
55278
- }
55279
- },
55280
- "/unstable_locations/remove_devices": {
55281
- delete: {
55282
- description: "Removes devices from a specific location.",
55283
- operationId: "unstableLocationsRemoveDevicesDelete",
55284
- parameters: [
55285
- {
55286
- in: "query",
55287
- name: "location_id",
55288
- required: true,
55289
- schema: {
55290
- description: "ID of the location from which you want to remove devices.",
55291
- format: "uuid",
55292
- type: "string"
55293
- }
55294
- },
55295
- {
55296
- in: "query",
55297
- name: "device_ids",
55298
- required: true,
55299
- schema: {
55300
- description: "IDs of the devices that you want to remove from the location.",
55301
- items: { format: "uuid", type: "string" },
55302
- type: "array"
55303
- }
55304
- }
55305
- ],
55306
- responses: {
55307
- 200: {
55308
- content: {
55309
- "application/json": {
55310
- schema: {
55311
- properties: { ok: { type: "boolean" } },
55312
- required: ["ok"],
55313
- type: "object"
55314
- }
55315
- }
55316
- },
55317
- description: "OK"
55318
- },
55319
- 400: { description: "Bad Request" },
55320
- 401: { description: "Unauthorized" }
55321
- },
55322
- security: [
55323
- { pat_with_workspace: [] },
55324
- { console_session_with_workspace: [] },
55325
- { api_key: [] }
55326
- ],
55327
- summary: "/unstable_locations/remove_devices",
55328
- tags: [],
55329
- "x-fern-sdk-group-name": ["unstable_locations"],
55330
- "x-fern-sdk-method-name": "remove_devices",
55331
- "x-response-key": null,
55332
- "x-title": "Remove Devices from a Location",
55333
- "x-undocumented": "Experimental locations."
55334
- },
55335
- post: {
55336
- description: "Removes devices from a specific location.",
55337
- operationId: "unstableLocationsRemoveDevicesPost",
55338
- requestBody: {
55339
- content: {
55340
- "application/json": {
55341
- schema: {
55342
- properties: {
55343
- device_ids: {
55344
- description: "IDs of the devices that you want to remove from the location.",
55345
- items: { format: "uuid", type: "string" },
55346
- type: "array"
55347
- },
55348
- location_id: {
55349
- description: "ID of the location from which you want to remove devices.",
55350
- format: "uuid",
55351
- type: "string"
55352
- }
55353
- },
55354
- required: ["location_id", "device_ids"],
55355
- type: "object"
55356
- }
55357
- }
55358
- }
55359
- },
55360
- responses: {
55361
- 200: {
55362
- content: {
55363
- "application/json": {
55364
- schema: {
55365
- properties: { ok: { type: "boolean" } },
55366
- required: ["ok"],
55367
- type: "object"
55368
- }
55369
- }
55370
- },
55371
- description: "OK"
55372
- },
55373
- 400: { description: "Bad Request" },
55374
- 401: { description: "Unauthorized" }
55375
- },
55376
- security: [
54204
+ { api_key: [] },
55377
54205
  { pat_with_workspace: [] },
55378
- { console_session_with_workspace: [] },
55379
- { api_key: [] }
54206
+ { console_session_with_workspace: [] }
55380
54207
  ],
55381
- summary: "/unstable_locations/remove_devices",
55382
- tags: [],
55383
- "x-fern-sdk-group-name": ["unstable_locations"],
55384
- "x-fern-sdk-method-name": "remove_devices",
54208
+ summary: "/thermostats/simulate/temperature_reached",
54209
+ tags: ["/thermostats"],
54210
+ "x-fern-sdk-group-name": ["thermostats", "simulate"],
54211
+ "x-fern-sdk-method-name": "temperature_reached",
55385
54212
  "x-response-key": null,
55386
- "x-title": "Remove Devices from a Location",
55387
- "x-undocumented": "Experimental locations."
54213
+ "x-title": "Temperature Reached"
55388
54214
  }
55389
54215
  },
55390
- "/unstable_locations/update": {
54216
+ "/thermostats/update_climate_preset": {
55391
54217
  patch: {
55392
- description: "Updates a location.",
55393
- operationId: "unstableLocationsUpdatePatch",
54218
+ description: "Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
54219
+ operationId: "thermostatsUpdateClimatePresetPatch",
55394
54220
  requestBody: {
55395
54221
  content: {
55396
54222
  "application/json": {
55397
54223
  schema: {
55398
54224
  properties: {
55399
- geolocation: {
55400
- description: "Geolocation of the location.",
54225
+ climate_preset_key: {
54226
+ description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
54227
+ type: "string"
54228
+ },
54229
+ climate_preset_mode: {
54230
+ description: "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ",
54231
+ enum: [
54232
+ "home",
54233
+ "away",
54234
+ "wake",
54235
+ "sleep",
54236
+ "occupied",
54237
+ "unoccupied"
54238
+ ],
54239
+ type: "string"
54240
+ },
54241
+ cooling_set_point_celsius: {
54242
+ description: "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54243
+ format: "float",
54244
+ type: "number"
54245
+ },
54246
+ cooling_set_point_fahrenheit: {
54247
+ description: "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54248
+ format: "float",
54249
+ type: "number"
54250
+ },
54251
+ device_id: {
54252
+ description: "ID of the thermostat device for which you want to update a climate preset.",
54253
+ format: "uuid",
54254
+ type: "string"
54255
+ },
54256
+ ecobee_metadata: {
54257
+ description: "\n Metadata specific to the Ecobee climate, if applicable.\n ",
55401
54258
  properties: {
55402
- latitude: { format: "float", type: "number" },
55403
- longitude: { format: "float", type: "number" }
54259
+ climate_ref: {
54260
+ description: "Reference to the Ecobee climate, if applicable.",
54261
+ type: "string"
54262
+ },
54263
+ is_optimized: {
54264
+ description: "Indicates if the climate preset is optimized by Ecobee.",
54265
+ type: "boolean"
54266
+ },
54267
+ owner: {
54268
+ description: "Indicates whether the climate preset is owned by the user or the system.",
54269
+ enum: ["user", "system"],
54270
+ type: "string"
54271
+ }
55404
54272
  },
55405
- required: ["latitude", "longitude"],
54273
+ required: ["climate_ref", "is_optimized", "owner"],
55406
54274
  type: "object"
55407
54275
  },
55408
- location_id: {
55409
- description: "ID of the location that you want to update.",
55410
- format: "uuid",
54276
+ fan_mode_setting: {
54277
+ description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.",
54278
+ enum: ["auto", "on", "circulate"],
55411
54279
  type: "string"
55412
54280
  },
55413
- name: {
55414
- description: "Name of the location.",
54281
+ heating_set_point_celsius: {
54282
+ description: "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54283
+ format: "float",
54284
+ type: "number"
54285
+ },
54286
+ heating_set_point_fahrenheit: {
54287
+ description: "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54288
+ format: "float",
54289
+ type: "number"
54290
+ },
54291
+ hvac_mode_setting: {
54292
+ description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.",
54293
+ enum: ["off", "heat", "cool", "heat_cool", "eco"],
55415
54294
  type: "string"
55416
54295
  },
55417
- time_zone: {
55418
- description: "Time zone of the the location.",
54296
+ manual_override_allowed: {
54297
+ deprecated: true,
54298
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
54299
+ type: "boolean",
54300
+ "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
54301
+ },
54302
+ name: {
54303
+ default: null,
54304
+ description: "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
54305
+ nullable: true,
55419
54306
  type: "string"
55420
54307
  }
55421
54308
  },
55422
- required: ["location_id"],
54309
+ required: ["device_id", "climate_preset_key"],
55423
54310
  type: "object"
55424
54311
  }
55425
54312
  }
@@ -55430,11 +54317,8 @@ var openapi_default = {
55430
54317
  content: {
55431
54318
  "application/json": {
55432
54319
  schema: {
55433
- properties: {
55434
- location: { $ref: "#/components/schemas/location" },
55435
- ok: { type: "boolean" }
55436
- },
55437
- required: ["location", "ok"],
54320
+ properties: { ok: { type: "boolean" } },
54321
+ required: ["ok"],
55438
54322
  type: "object"
55439
54323
  }
55440
54324
  }
@@ -55447,49 +54331,202 @@ var openapi_default = {
55447
54331
  security: [
55448
54332
  { pat_with_workspace: [] },
55449
54333
  { console_session_with_workspace: [] },
55450
- { api_key: [] }
54334
+ { api_key: [] },
54335
+ { client_session: [] }
55451
54336
  ],
55452
- summary: "/unstable_locations/update",
55453
- tags: [],
55454
- "x-fern-sdk-group-name": ["unstable_locations"],
55455
- "x-fern-sdk-method-name": "update",
55456
- "x-fern-sdk-return-value": "location",
55457
- "x-response-key": "location",
55458
- "x-title": "Update a Location",
55459
- "x-undocumented": "Experimental locations."
54337
+ summary: "/thermostats/update_climate_preset",
54338
+ tags: ["/thermostats"],
54339
+ "x-fern-sdk-group-name": ["thermostats"],
54340
+ "x-fern-sdk-method-name": "update_climate_preset",
54341
+ "x-response-key": null,
54342
+ "x-title": "Update a Climate Preset"
55460
54343
  },
55461
54344
  post: {
55462
- description: "Updates a location.",
55463
- operationId: "unstableLocationsUpdatePost",
54345
+ description: "Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
54346
+ operationId: "thermostatsUpdateClimatePresetPost",
55464
54347
  requestBody: {
55465
54348
  content: {
55466
54349
  "application/json": {
55467
54350
  schema: {
55468
54351
  properties: {
55469
- geolocation: {
55470
- description: "Geolocation of the location.",
54352
+ climate_preset_key: {
54353
+ description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
54354
+ type: "string"
54355
+ },
54356
+ climate_preset_mode: {
54357
+ description: "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ",
54358
+ enum: [
54359
+ "home",
54360
+ "away",
54361
+ "wake",
54362
+ "sleep",
54363
+ "occupied",
54364
+ "unoccupied"
54365
+ ],
54366
+ type: "string"
54367
+ },
54368
+ cooling_set_point_celsius: {
54369
+ description: "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54370
+ format: "float",
54371
+ type: "number"
54372
+ },
54373
+ cooling_set_point_fahrenheit: {
54374
+ description: "Temperature to which the thermostat should cool (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54375
+ format: "float",
54376
+ type: "number"
54377
+ },
54378
+ device_id: {
54379
+ description: "ID of the thermostat device for which you want to update a climate preset.",
54380
+ format: "uuid",
54381
+ type: "string"
54382
+ },
54383
+ ecobee_metadata: {
54384
+ description: "\n Metadata specific to the Ecobee climate, if applicable.\n ",
55471
54385
  properties: {
55472
- latitude: { format: "float", type: "number" },
55473
- longitude: { format: "float", type: "number" }
54386
+ climate_ref: {
54387
+ description: "Reference to the Ecobee climate, if applicable.",
54388
+ type: "string"
54389
+ },
54390
+ is_optimized: {
54391
+ description: "Indicates if the climate preset is optimized by Ecobee.",
54392
+ type: "boolean"
54393
+ },
54394
+ owner: {
54395
+ description: "Indicates whether the climate preset is owned by the user or the system.",
54396
+ enum: ["user", "system"],
54397
+ type: "string"
54398
+ }
55474
54399
  },
55475
- required: ["latitude", "longitude"],
54400
+ required: ["climate_ref", "is_optimized", "owner"],
55476
54401
  type: "object"
55477
54402
  },
55478
- location_id: {
55479
- description: "ID of the location that you want to update.",
55480
- format: "uuid",
54403
+ fan_mode_setting: {
54404
+ description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.",
54405
+ enum: ["auto", "on", "circulate"],
55481
54406
  type: "string"
55482
54407
  },
54408
+ heating_set_point_celsius: {
54409
+ description: "Temperature to which the thermostat should heat (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54410
+ format: "float",
54411
+ type: "number"
54412
+ },
54413
+ heating_set_point_fahrenheit: {
54414
+ description: "Temperature to which the thermostat should heat (in \xB0F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
54415
+ format: "float",
54416
+ type: "number"
54417
+ },
54418
+ hvac_mode_setting: {
54419
+ description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.",
54420
+ enum: ["off", "heat", "cool", "heat_cool", "eco"],
54421
+ type: "string"
54422
+ },
54423
+ manual_override_allowed: {
54424
+ deprecated: true,
54425
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
54426
+ type: "boolean",
54427
+ "x-deprecated": "Use 'thermostat_schedule.is_override_allowed'"
54428
+ },
55483
54429
  name: {
55484
- description: "Name of the location.",
54430
+ default: null,
54431
+ description: "User-friendly name to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
54432
+ nullable: true,
54433
+ type: "string"
54434
+ }
54435
+ },
54436
+ required: ["device_id", "climate_preset_key"],
54437
+ type: "object"
54438
+ }
54439
+ }
54440
+ }
54441
+ },
54442
+ responses: {
54443
+ 200: {
54444
+ content: {
54445
+ "application/json": {
54446
+ schema: {
54447
+ properties: { ok: { type: "boolean" } },
54448
+ required: ["ok"],
54449
+ type: "object"
54450
+ }
54451
+ }
54452
+ },
54453
+ description: "OK"
54454
+ },
54455
+ 400: { description: "Bad Request" },
54456
+ 401: { description: "Unauthorized" }
54457
+ },
54458
+ security: [
54459
+ { pat_with_workspace: [] },
54460
+ { console_session_with_workspace: [] },
54461
+ { api_key: [] },
54462
+ { client_session: [] }
54463
+ ],
54464
+ summary: "/thermostats/update_climate_preset",
54465
+ tags: ["/thermostats"],
54466
+ "x-fern-sdk-group-name": ["thermostats"],
54467
+ "x-fern-sdk-method-name": "update_climate_preset",
54468
+ "x-response-key": null,
54469
+ "x-title": "Update a Climate Preset"
54470
+ }
54471
+ },
54472
+ "/thermostats/update_weekly_program": {
54473
+ post: {
54474
+ 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.",
54475
+ operationId: "thermostatsUpdateWeeklyProgramPost",
54476
+ requestBody: {
54477
+ content: {
54478
+ "application/json": {
54479
+ schema: {
54480
+ properties: {
54481
+ device_id: {
54482
+ description: "ID of the thermostat device for which you want to update the weekly program.",
54483
+ format: "uuid",
54484
+ type: "string"
54485
+ },
54486
+ friday_program_id: {
54487
+ description: "ID of the thermostat daily program to run on Fridays.",
54488
+ format: "uuid",
54489
+ nullable: true,
54490
+ type: "string"
54491
+ },
54492
+ monday_program_id: {
54493
+ description: "ID of the thermostat daily program to run on Mondays.",
54494
+ format: "uuid",
54495
+ nullable: true,
54496
+ type: "string"
54497
+ },
54498
+ saturday_program_id: {
54499
+ description: "ID of the thermostat daily program to run on Saturdays.",
54500
+ format: "uuid",
54501
+ nullable: true,
54502
+ type: "string"
54503
+ },
54504
+ sunday_program_id: {
54505
+ description: "ID of the thermostat daily program to run on Sundays.",
54506
+ format: "uuid",
54507
+ nullable: true,
55485
54508
  type: "string"
55486
54509
  },
55487
- time_zone: {
55488
- description: "Time zone of the the location.",
54510
+ thursday_program_id: {
54511
+ description: "ID of the thermostat daily program to run on Thursdays.",
54512
+ format: "uuid",
54513
+ nullable: true,
54514
+ type: "string"
54515
+ },
54516
+ tuesday_program_id: {
54517
+ description: "ID of the thermostat daily program to run on Tuesdays.",
54518
+ format: "uuid",
54519
+ nullable: true,
54520
+ type: "string"
54521
+ },
54522
+ wednesday_program_id: {
54523
+ description: "ID of the thermostat daily program to run on Wednesdays.",
54524
+ format: "uuid",
54525
+ nullable: true,
55489
54526
  type: "string"
55490
54527
  }
55491
54528
  },
55492
- required: ["location_id"],
54529
+ required: ["device_id"],
55493
54530
  type: "object"
55494
54531
  }
55495
54532
  }
@@ -55501,10 +54538,12 @@ var openapi_default = {
55501
54538
  "application/json": {
55502
54539
  schema: {
55503
54540
  properties: {
55504
- location: { $ref: "#/components/schemas/location" },
54541
+ action_attempt: {
54542
+ $ref: "#/components/schemas/action_attempt"
54543
+ },
55505
54544
  ok: { type: "boolean" }
55506
54545
  },
55507
- required: ["location", "ok"],
54546
+ required: ["action_attempt", "ok"],
55508
54547
  type: "object"
55509
54548
  }
55510
54549
  }
@@ -55515,18 +54554,19 @@ var openapi_default = {
55515
54554
  401: { description: "Unauthorized" }
55516
54555
  },
55517
54556
  security: [
54557
+ { client_session: [] },
55518
54558
  { pat_with_workspace: [] },
55519
54559
  { console_session_with_workspace: [] },
55520
54560
  { api_key: [] }
55521
54561
  ],
55522
- summary: "/unstable_locations/update",
55523
- tags: [],
55524
- "x-fern-sdk-group-name": ["unstable_locations"],
55525
- "x-fern-sdk-method-name": "update",
55526
- "x-fern-sdk-return-value": "location",
55527
- "x-response-key": "location",
55528
- "x-title": "Update a Location",
55529
- "x-undocumented": "Experimental locations."
54562
+ summary: "/thermostats/update_weekly_program",
54563
+ tags: ["/thermostats"],
54564
+ "x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS",
54565
+ "x-fern-sdk-group-name": ["thermostats"],
54566
+ "x-fern-sdk-method-name": "update_weekly_program",
54567
+ "x-fern-sdk-return-value": "action_attempt",
54568
+ "x-response-key": "action_attempt",
54569
+ "x-title": "Update the Thermostat Weekly Program"
55530
54570
  }
55531
54571
  },
55532
54572
  "/unstable_partner/building_blocks/connect_accounts": {
@@ -58209,6 +57249,10 @@ var openapi_default = {
58209
57249
  batch: {
58210
57250
  description: "A batch of workspace resources.",
58211
57251
  properties: {
57252
+ access_methods: {
57253
+ items: { $ref: "#/components/schemas/access_method" },
57254
+ type: "array"
57255
+ },
58212
57256
  acs_access_groups: {
58213
57257
  items: {
58214
57258
  $ref: "#/components/schemas/acs_access_group"
@@ -58343,6 +57387,10 @@ var openapi_default = {
58343
57387
  batch: {
58344
57388
  description: "A batch of workspace resources.",
58345
57389
  properties: {
57390
+ access_methods: {
57391
+ items: { $ref: "#/components/schemas/access_method" },
57392
+ type: "array"
57393
+ },
58346
57394
  acs_access_groups: {
58347
57395
  items: {
58348
57396
  $ref: "#/components/schemas/acs_access_group"