@seamapi/types 1.429.1 → 1.431.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 (35) hide show
  1. package/dist/connect.cjs +145 -0
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +573 -0
  4. package/lib/seam/connect/models/acs/acs-credential.d.ts +6 -0
  5. package/lib/seam/connect/models/acs/acs-credential.js +5 -0
  6. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  7. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +24 -0
  8. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +10 -0
  9. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +14 -0
  10. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +18 -0
  11. package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +18 -0
  12. package/lib/seam/connect/models/devices/capability-properties/thermostat.js +8 -1
  13. package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
  14. package/lib/seam/connect/models/devices/device.d.ts +26 -0
  15. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +18 -0
  16. package/lib/seam/connect/models/events/devices.d.ts +2 -0
  17. package/lib/seam/connect/models/events/seam-event.d.ts +1 -0
  18. package/lib/seam/connect/models/phones/phone-session.d.ts +12 -0
  19. package/lib/seam/connect/models/thermostats/climate-preset.d.ts +6 -0
  20. package/lib/seam/connect/models/thermostats/climate-preset.js +4 -1
  21. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  22. package/lib/seam/connect/models/thermostats/modes.d.ts +2 -0
  23. package/lib/seam/connect/models/thermostats/modes.js +8 -0
  24. package/lib/seam/connect/models/thermostats/modes.js.map +1 -1
  25. package/lib/seam/connect/openapi.d.ts +76 -0
  26. package/lib/seam/connect/openapi.js +124 -0
  27. package/lib/seam/connect/openapi.js.map +1 -1
  28. package/lib/seam/connect/route-types.d.ts +422 -0
  29. package/package.json +2 -2
  30. package/src/lib/seam/connect/models/acs/acs-credential.ts +7 -0
  31. package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +8 -0
  32. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +8 -1
  33. package/src/lib/seam/connect/models/thermostats/modes.ts +11 -0
  34. package/src/lib/seam/connect/openapi.ts +138 -0
  35. package/src/lib/seam/connect/route-types.ts +907 -0
package/dist/connect.cjs CHANGED
@@ -148,6 +148,14 @@ var lock_capability_properties = zod.z.object({
148
148
  var hvac_mode_setting = zod.z.enum(["off", "heat", "cool", "heat_cool"]);
149
149
  var fan_mode_setting = zod.z.enum(["auto", "on", "circulate"]);
150
150
  zod.z.array(fan_mode_setting);
151
+ var climate_preset_mode = zod.z.enum([
152
+ "home",
153
+ "away",
154
+ "wake",
155
+ "sleep",
156
+ "occupied",
157
+ "unoccupied"
158
+ ]);
151
159
 
152
160
  // src/lib/seam/connect/models/thermostats/climate-preset.ts
153
161
  var climate_preset = zod.z.object({
@@ -169,6 +177,9 @@ var climate_preset = zod.z.object({
169
177
  display_name: zod.z.string().describe(
170
178
  "Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets)."
171
179
  ),
180
+ climate_preset_mode: climate_preset_mode.optional().describe(`
181
+ The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
182
+ `),
172
183
  fan_mode_setting: fan_mode_setting.optional().describe(
173
184
  "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`."
174
185
  ),
@@ -319,6 +330,13 @@ var thermostat_capability_properties = zod.z.object({
319
330
  ---
320
331
  Fan mode settings that the thermostat supports.
321
332
  `),
333
+ available_climate_preset_modes: zod.z.array(climate_preset_mode).describe(`
334
+ ---
335
+ property_group_key: thermostats
336
+ draft: Needs review.
337
+ ---
338
+ Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".
339
+ `),
322
340
  is_heating: zod.z.boolean().describe(`
323
341
  ---
324
342
  property_group_key: thermostats
@@ -2632,6 +2650,9 @@ var common_acs_credential = zod.z.object({
2632
2650
  acs_user_id: zod.z.string().uuid().optional().describe(
2633
2651
  "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs."
2634
2652
  ),
2653
+ user_identity_id: zod.z.string().uuid().optional().describe(
2654
+ "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs."
2655
+ ),
2635
2656
  connected_account_id: zod.z.string().uuid().describe(
2636
2657
  "ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs."
2637
2658
  ),
@@ -7394,6 +7415,11 @@ var openapi_default = {
7394
7415
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
7395
7416
  type: "string"
7396
7417
  },
7418
+ user_identity_id: {
7419
+ description: "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
7420
+ format: "uuid",
7421
+ type: "string"
7422
+ },
7397
7423
  visionline_metadata: {
7398
7424
  description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
7399
7425
  properties: {
@@ -9484,6 +9510,11 @@ var openapi_default = {
9484
9510
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
9485
9511
  type: "string"
9486
9512
  },
9513
+ user_identity_id: {
9514
+ description: "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
9515
+ format: "uuid",
9516
+ type: "string"
9517
+ },
9487
9518
  visionline_metadata: {
9488
9519
  description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
9489
9520
  properties: {
@@ -9867,6 +9898,11 @@ var openapi_default = {
9867
9898
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
9868
9899
  type: "string"
9869
9900
  },
9901
+ user_identity_id: {
9902
+ description: "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
9903
+ format: "uuid",
9904
+ type: "string"
9905
+ },
9870
9906
  visionline_metadata: {
9871
9907
  description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
9872
9908
  properties: {
@@ -10428,6 +10464,11 @@ var openapi_default = {
10428
10464
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
10429
10465
  type: "string"
10430
10466
  },
10467
+ user_identity_id: {
10468
+ description: "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
10469
+ format: "uuid",
10470
+ type: "string"
10471
+ },
10431
10472
  visionline_metadata: {
10432
10473
  description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
10433
10474
  properties: {
@@ -10809,6 +10850,11 @@ var openapi_default = {
10809
10850
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
10810
10851
  type: "string"
10811
10852
  },
10853
+ user_identity_id: {
10854
+ description: "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
10855
+ format: "uuid",
10856
+ type: "string"
10857
+ },
10812
10858
  visionline_metadata: {
10813
10859
  description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
10814
10860
  properties: {
@@ -15584,6 +15630,23 @@ var openapi_default = {
15584
15630
  type: "string",
15585
15631
  "x-property-group-key": "thermostats"
15586
15632
  },
15633
+ available_climate_preset_modes: {
15634
+ description: 'Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".',
15635
+ items: {
15636
+ enum: [
15637
+ "home",
15638
+ "away",
15639
+ "wake",
15640
+ "sleep",
15641
+ "occupied",
15642
+ "unoccupied"
15643
+ ],
15644
+ type: "string"
15645
+ },
15646
+ type: "array",
15647
+ "x-draft": "Needs review.",
15648
+ "x-property-group-key": "thermostats"
15649
+ },
15587
15650
  available_climate_presets: {
15588
15651
  description: "Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.",
15589
15652
  items: {
@@ -15604,6 +15667,18 @@ var openapi_default = {
15604
15667
  description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
15605
15668
  type: "string"
15606
15669
  },
15670
+ climate_preset_mode: {
15671
+ description: "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ",
15672
+ enum: [
15673
+ "home",
15674
+ "away",
15675
+ "wake",
15676
+ "sleep",
15677
+ "occupied",
15678
+ "unoccupied"
15679
+ ],
15680
+ type: "string"
15681
+ },
15607
15682
  cooling_set_point_celsius: {
15608
15683
  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).",
15609
15684
  format: "float",
@@ -15701,6 +15776,18 @@ var openapi_default = {
15701
15776
  description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
15702
15777
  type: "string"
15703
15778
  },
15779
+ climate_preset_mode: {
15780
+ description: "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ",
15781
+ enum: [
15782
+ "home",
15783
+ "away",
15784
+ "wake",
15785
+ "sleep",
15786
+ "occupied",
15787
+ "unoccupied"
15788
+ ],
15789
+ type: "string"
15790
+ },
15704
15791
  cooling_set_point_celsius: {
15705
15792
  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).",
15706
15793
  format: "float",
@@ -15770,6 +15857,18 @@ var openapi_default = {
15770
15857
  description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
15771
15858
  type: "string"
15772
15859
  },
15860
+ climate_preset_mode: {
15861
+ description: "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ",
15862
+ enum: [
15863
+ "home",
15864
+ "away",
15865
+ "wake",
15866
+ "sleep",
15867
+ "occupied",
15868
+ "unoccupied"
15869
+ ],
15870
+ type: "string"
15871
+ },
15773
15872
  cooling_set_point_celsius: {
15774
15873
  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).",
15775
15874
  format: "float",
@@ -22224,6 +22323,11 @@ var openapi_default = {
22224
22323
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
22225
22324
  type: "string"
22226
22325
  },
22326
+ user_identity_id: {
22327
+ description: "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
22328
+ format: "uuid",
22329
+ type: "string"
22330
+ },
22227
22331
  visionline_metadata: {
22228
22332
  description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
22229
22333
  properties: {
@@ -24459,6 +24563,11 @@ var openapi_default = {
24459
24563
  description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
24460
24564
  type: "string"
24461
24565
  },
24566
+ user_identity_id: {
24567
+ description: "ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
24568
+ format: "uuid",
24569
+ type: "string"
24570
+ },
24462
24571
  visionline_metadata: {
24463
24572
  description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
24464
24573
  properties: {
@@ -48161,6 +48270,18 @@ var openapi_default = {
48161
48270
  description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
48162
48271
  type: "string"
48163
48272
  },
48273
+ climate_preset_mode: {
48274
+ description: "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ",
48275
+ enum: [
48276
+ "home",
48277
+ "away",
48278
+ "wake",
48279
+ "sleep",
48280
+ "occupied",
48281
+ "unoccupied"
48282
+ ],
48283
+ type: "string"
48284
+ },
48164
48285
  cooling_set_point_celsius: {
48165
48286
  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).",
48166
48287
  format: "float",
@@ -50717,6 +50838,18 @@ var openapi_default = {
50717
50838
  description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
50718
50839
  type: "string"
50719
50840
  },
50841
+ climate_preset_mode: {
50842
+ description: "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ",
50843
+ enum: [
50844
+ "home",
50845
+ "away",
50846
+ "wake",
50847
+ "sleep",
50848
+ "occupied",
50849
+ "unoccupied"
50850
+ ],
50851
+ type: "string"
50852
+ },
50720
50853
  cooling_set_point_celsius: {
50721
50854
  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).",
50722
50855
  format: "float",
@@ -50812,6 +50945,18 @@ var openapi_default = {
50812
50945
  description: "Unique key to identify the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
50813
50946
  type: "string"
50814
50947
  },
50948
+ climate_preset_mode: {
50949
+ description: "\n The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.\n ",
50950
+ enum: [
50951
+ "home",
50952
+ "away",
50953
+ "wake",
50954
+ "sleep",
50955
+ "occupied",
50956
+ "unoccupied"
50957
+ ],
50958
+ type: "string"
50959
+ },
50815
50960
  cooling_set_point_celsius: {
50816
50961
  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).",
50817
50962
  format: "float",