@seamapi/types 1.429.0 → 1.430.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.
Files changed (27) hide show
  1. package/dist/connect.cjs +252 -8
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +453 -12
  4. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +18 -0
  5. package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +18 -0
  6. package/lib/seam/connect/models/devices/capability-properties/thermostat.js +8 -1
  7. package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
  8. package/lib/seam/connect/models/devices/device.d.ts +26 -0
  9. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +18 -0
  10. package/lib/seam/connect/models/events/devices.d.ts +2 -0
  11. package/lib/seam/connect/models/events/seam-event.d.ts +1 -0
  12. package/lib/seam/connect/models/thermostats/climate-preset.d.ts +6 -0
  13. package/lib/seam/connect/models/thermostats/climate-preset.js +4 -1
  14. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  15. package/lib/seam/connect/models/thermostats/modes.d.ts +2 -0
  16. package/lib/seam/connect/models/thermostats/modes.js +8 -0
  17. package/lib/seam/connect/models/thermostats/modes.js.map +1 -1
  18. package/lib/seam/connect/openapi.d.ts +210 -4
  19. package/lib/seam/connect/openapi.js +234 -8
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +198 -8
  22. package/package.json +2 -2
  23. package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +8 -0
  24. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +8 -1
  25. package/src/lib/seam/connect/models/thermostats/modes.ts +11 -0
  26. package/src/lib/seam/connect/openapi.ts +243 -8
  27. package/src/lib/seam/connect/route-types.ts +683 -8
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.429.0",
3
+ "version": "1.430.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -92,7 +92,7 @@
92
92
  "zod": "^3.24.0"
93
93
  },
94
94
  "devDependencies": {
95
- "@seamapi/blueprint": "^0.50.2",
95
+ "@seamapi/blueprint": "^0.50.6",
96
96
  "@types/node": "^20.8.10",
97
97
  "concurrently": "^8.2.0",
98
98
  "del-cli": "^5.0.0",
@@ -2,6 +2,7 @@ import { z } from 'zod'
2
2
 
3
3
  import {
4
4
  climate_preset,
5
+ climate_preset_mode,
5
6
  climate_setting,
6
7
  fan_mode_setting,
7
8
  hvac_mode_setting,
@@ -42,6 +43,13 @@ export const thermostat_capability_properties = z
42
43
  ---
43
44
  Fan mode settings that the thermostat supports.
44
45
  `),
46
+ available_climate_preset_modes: z.array(climate_preset_mode).describe(`
47
+ ---
48
+ property_group_key: thermostats
49
+ draft: Needs review.
50
+ ---
51
+ Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".
52
+ `),
45
53
  is_heating: z.boolean().describe(`
46
54
  ---
47
55
  property_group_key: thermostats
@@ -1,6 +1,10 @@
1
1
  import { z } from 'zod'
2
2
 
3
- import { fan_mode_setting, hvac_mode_setting } from './modes.js'
3
+ import {
4
+ climate_preset_mode,
5
+ fan_mode_setting,
6
+ hvac_mode_setting,
7
+ } from './modes.js'
4
8
 
5
9
  export const climate_preset = z.object({
6
10
  climate_preset_key: z
@@ -36,6 +40,9 @@ export const climate_preset = z.object({
36
40
  .describe(
37
41
  'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
38
42
  ),
43
+ climate_preset_mode: climate_preset_mode.optional().describe(`
44
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
45
+ `),
39
46
  fan_mode_setting: fan_mode_setting
40
47
  .optional()
41
48
  .describe(
@@ -13,3 +13,14 @@ export const available_fan_mode_settings = z.array(fan_mode_setting)
13
13
  export type AvailableFanModeSettings = z.infer<
14
14
  typeof available_fan_mode_settings
15
15
  >
16
+
17
+ export const climate_preset_mode = z.enum([
18
+ 'home',
19
+ 'away',
20
+ 'wake',
21
+ 'sleep',
22
+ 'occupied',
23
+ 'unoccupied',
24
+ ])
25
+
26
+ export type ClimatePresetMode = z.infer<typeof climate_preset_mode>
@@ -11466,6 +11466,24 @@ export default {
11466
11466
  type: 'string',
11467
11467
  'x-property-group-key': 'thermostats',
11468
11468
  },
11469
+ available_climate_preset_modes: {
11470
+ description:
11471
+ 'Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".',
11472
+ items: {
11473
+ enum: [
11474
+ 'home',
11475
+ 'away',
11476
+ 'wake',
11477
+ 'sleep',
11478
+ 'occupied',
11479
+ 'unoccupied',
11480
+ ],
11481
+ type: 'string',
11482
+ },
11483
+ type: 'array',
11484
+ 'x-draft': 'Needs review.',
11485
+ 'x-property-group-key': 'thermostats',
11486
+ },
11469
11487
  available_climate_presets: {
11470
11488
  description:
11471
11489
  'Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.',
@@ -11491,6 +11509,19 @@ export default {
11491
11509
  'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
11492
11510
  type: 'string',
11493
11511
  },
11512
+ climate_preset_mode: {
11513
+ description:
11514
+ '\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ',
11515
+ enum: [
11516
+ 'home',
11517
+ 'away',
11518
+ 'wake',
11519
+ 'sleep',
11520
+ 'occupied',
11521
+ 'unoccupied',
11522
+ ],
11523
+ type: 'string',
11524
+ },
11494
11525
  cooling_set_point_celsius: {
11495
11526
  description:
11496
11527
  'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
@@ -11604,6 +11635,19 @@ export default {
11604
11635
  'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
11605
11636
  type: 'string',
11606
11637
  },
11638
+ climate_preset_mode: {
11639
+ description:
11640
+ '\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ',
11641
+ enum: [
11642
+ 'home',
11643
+ 'away',
11644
+ 'wake',
11645
+ 'sleep',
11646
+ 'occupied',
11647
+ 'unoccupied',
11648
+ ],
11649
+ type: 'string',
11650
+ },
11607
11651
  cooling_set_point_celsius: {
11608
11652
  description:
11609
11653
  'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
@@ -11687,6 +11731,19 @@ export default {
11687
11731
  'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
11688
11732
  type: 'string',
11689
11733
  },
11734
+ climate_preset_mode: {
11735
+ description:
11736
+ '\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ',
11737
+ enum: [
11738
+ 'home',
11739
+ 'away',
11740
+ 'wake',
11741
+ 'sleep',
11742
+ 'occupied',
11743
+ 'unoccupied',
11744
+ ],
11745
+ type: 'string',
11746
+ },
11690
11747
  cooling_set_point_celsius: {
11691
11748
  description:
11692
11749
  'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
@@ -26540,9 +26597,9 @@ export default {
26540
26597
  },
26541
26598
  },
26542
26599
  '/access_grants/delete': {
26543
- get: {
26600
+ delete: {
26544
26601
  description: 'Delete an access grant.',
26545
- operationId: 'accessGrantsDeleteGet',
26602
+ operationId: 'accessGrantsDeleteDelete',
26546
26603
  parameters: [
26547
26604
  {
26548
26605
  in: 'query',
@@ -27044,9 +27101,9 @@ export default {
27044
27101
  },
27045
27102
  },
27046
27103
  '/access_methods/delete': {
27047
- get: {
27104
+ delete: {
27048
27105
  description: 'Delete an access method.',
27049
- operationId: 'accessMethodsDeleteGet',
27106
+ operationId: 'accessMethodsDeleteDelete',
27050
27107
  parameters: [
27051
27108
  {
27052
27109
  in: 'query',
@@ -44227,6 +44284,44 @@ export default {
44227
44284
  'x-title': 'Delete Customer Portal Automation Configuration',
44228
44285
  'x-undocumented': 'Internal endpoint for customer portals.',
44229
44286
  },
44287
+ post: {
44288
+ description:
44289
+ 'Deletes the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
44290
+ operationId: 'seamCustomerV1AutomationsDeletePost',
44291
+ requestBody: {
44292
+ content: {
44293
+ 'application/json': { schema: { properties: {}, type: 'object' } },
44294
+ },
44295
+ },
44296
+ responses: {
44297
+ 200: {
44298
+ content: {
44299
+ 'application/json': {
44300
+ schema: {
44301
+ properties: { ok: { type: 'boolean' } },
44302
+ required: ['ok'],
44303
+ type: 'object',
44304
+ },
44305
+ },
44306
+ },
44307
+ description: 'OK',
44308
+ },
44309
+ 400: { description: 'Bad Request' },
44310
+ 401: { description: 'Unauthorized' },
44311
+ },
44312
+ security: [
44313
+ { console_session_with_workspace: [] },
44314
+ { api_key: [] },
44315
+ { client_session_with_customer: [] },
44316
+ ],
44317
+ summary: '/seam/customer/v1/automations/delete',
44318
+ tags: [],
44319
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
44320
+ 'x-fern-sdk-method-name': 'delete',
44321
+ 'x-response-key': null,
44322
+ 'x-title': 'Delete Customer Portal Automation Configuration',
44323
+ 'x-undocumented': 'Internal endpoint for customer portals.',
44324
+ },
44230
44325
  },
44231
44326
  '/seam/customer/v1/automations/get': {
44232
44327
  get: {
@@ -44330,6 +44425,107 @@ export default {
44330
44425
  'x-title': 'Get Customer Portal Automation Configuration',
44331
44426
  'x-undocumented': 'Internal endpoint for customer portals.',
44332
44427
  },
44428
+ post: {
44429
+ description:
44430
+ 'Gets the current automation configuration for a customer portal workspace.\nFor customer client sessions, returns customer-specific config if available,\notherwise falls back to workspace-level config.',
44431
+ operationId: 'seamCustomerV1AutomationsGetPost',
44432
+ responses: {
44433
+ 200: {
44434
+ content: {
44435
+ 'application/json': {
44436
+ schema: {
44437
+ properties: {
44438
+ access_rules: {
44439
+ properties: {
44440
+ reservation_created: {
44441
+ properties: {
44442
+ config: {
44443
+ properties: {
44444
+ access_methods: {
44445
+ items: {
44446
+ enum: ['card', 'mobile_key', 'code'],
44447
+ type: 'string',
44448
+ },
44449
+ minItems: 1,
44450
+ type: 'array',
44451
+ },
44452
+ method_issuance_strategy: {
44453
+ enum: [
44454
+ 'first_available',
44455
+ 'first_two_available',
44456
+ 'all_available',
44457
+ ],
44458
+ type: 'string',
44459
+ },
44460
+ },
44461
+ required: [
44462
+ 'access_methods',
44463
+ 'method_issuance_strategy',
44464
+ ],
44465
+ type: 'object',
44466
+ },
44467
+ rule: {
44468
+ enum: ['reservation_created'],
44469
+ type: 'string',
44470
+ },
44471
+ },
44472
+ required: ['rule', 'config'],
44473
+ type: 'object',
44474
+ },
44475
+ reservation_deleted: {
44476
+ properties: {
44477
+ config: {
44478
+ $ref: '#/components/schemas/access_code',
44479
+ },
44480
+ rule: {
44481
+ enum: ['reservation_deleted'],
44482
+ type: 'string',
44483
+ },
44484
+ },
44485
+ required: ['rule', 'config'],
44486
+ type: 'object',
44487
+ },
44488
+ reservation_time_updated: {
44489
+ properties: {
44490
+ config: {
44491
+ $ref: '#/components/schemas/access_code',
44492
+ },
44493
+ rule: {
44494
+ enum: ['reservation_time_updated'],
44495
+ type: 'string',
44496
+ },
44497
+ },
44498
+ required: ['rule', 'config'],
44499
+ type: 'object',
44500
+ },
44501
+ },
44502
+ type: 'object',
44503
+ },
44504
+ ok: { type: 'boolean' },
44505
+ },
44506
+ required: ['ok'],
44507
+ type: 'object',
44508
+ },
44509
+ },
44510
+ },
44511
+ description: 'OK',
44512
+ },
44513
+ 400: { description: 'Bad Request' },
44514
+ 401: { description: 'Unauthorized' },
44515
+ },
44516
+ security: [
44517
+ { console_session_with_workspace: [] },
44518
+ { api_key: [] },
44519
+ { client_session_with_customer: [] },
44520
+ ],
44521
+ summary: '/seam/customer/v1/automations/get',
44522
+ tags: [],
44523
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
44524
+ 'x-fern-sdk-method-name': 'get',
44525
+ 'x-response-key': null,
44526
+ 'x-title': 'Get Customer Portal Automation Configuration',
44527
+ 'x-undocumented': 'Internal endpoint for customer portals.',
44528
+ },
44333
44529
  },
44334
44530
  '/seam/customer/v1/automations/update': {
44335
44531
  patch: {
@@ -46294,6 +46490,19 @@ export default {
46294
46490
  'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
46295
46491
  type: 'string',
46296
46492
  },
46493
+ climate_preset_mode: {
46494
+ description:
46495
+ '\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ',
46496
+ enum: [
46497
+ 'home',
46498
+ 'away',
46499
+ 'wake',
46500
+ 'sleep',
46501
+ 'occupied',
46502
+ 'unoccupied',
46503
+ ],
46504
+ type: 'string',
46505
+ },
46297
46506
  cooling_set_point_celsius: {
46298
46507
  description:
46299
46508
  'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
@@ -49019,6 +49228,19 @@ export default {
49019
49228
  'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
49020
49229
  type: 'string',
49021
49230
  },
49231
+ climate_preset_mode: {
49232
+ description:
49233
+ '\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ',
49234
+ enum: [
49235
+ 'home',
49236
+ 'away',
49237
+ 'wake',
49238
+ 'sleep',
49239
+ 'occupied',
49240
+ 'unoccupied',
49241
+ ],
49242
+ type: 'string',
49243
+ },
49022
49244
  cooling_set_point_celsius: {
49023
49245
  description:
49024
49246
  'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
@@ -49126,6 +49348,19 @@ export default {
49126
49348
  'Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
49127
49349
  type: 'string',
49128
49350
  },
49351
+ climate_preset_mode: {
49352
+ description:
49353
+ '\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ',
49354
+ enum: [
49355
+ 'home',
49356
+ 'away',
49357
+ 'wake',
49358
+ 'sleep',
49359
+ 'occupied',
49360
+ 'unoccupied',
49361
+ ],
49362
+ type: 'string',
49363
+ },
49129
49364
  cooling_set_point_celsius: {
49130
49365
  description:
49131
49366
  'Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).',
@@ -49511,9 +49746,9 @@ export default {
49511
49746
  },
49512
49747
  },
49513
49748
  '/unstable_access_grants/delete': {
49514
- get: {
49749
+ delete: {
49515
49750
  description: 'Deletes an access grant.',
49516
- operationId: 'unstableAccessGrantsDeleteGet',
49751
+ operationId: 'unstableAccessGrantsDeleteDelete',
49517
49752
  parameters: [
49518
49753
  {
49519
49754
  in: 'query',
@@ -49888,9 +50123,9 @@ export default {
49888
50123
  },
49889
50124
  },
49890
50125
  '/unstable_access_methods/delete': {
49891
- get: {
50126
+ delete: {
49892
50127
  description: 'Deletes an access method.',
49893
- operationId: 'unstableAccessMethodsDeleteGet',
50128
+ operationId: 'unstableAccessMethodsDeleteDelete',
49894
50129
  parameters: [
49895
50130
  {
49896
50131
  in: 'query',