@seamapi/types 1.433.0 → 1.435.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 (28) hide show
  1. package/dist/connect.cjs +188 -13
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +882 -28
  4. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +99 -0
  5. package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +99 -0
  6. package/lib/seam/connect/models/devices/device-metadata.d.ts +8 -8
  7. package/lib/seam/connect/models/devices/device.d.ts +145 -16
  8. package/lib/seam/connect/models/devices/device.js +14 -8
  9. package/lib/seam/connect/models/devices/device.js.map +1 -1
  10. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +107 -8
  11. package/lib/seam/connect/models/events/devices.d.ts +26 -0
  12. package/lib/seam/connect/models/events/seam-event.d.ts +13 -0
  13. package/lib/seam/connect/models/thermostats/climate-preset.d.ts +46 -0
  14. package/lib/seam/connect/models/thermostats/climate-preset.js +15 -0
  15. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  16. package/lib/seam/connect/models/user-identities/user-identity.d.ts +49 -4
  17. package/lib/seam/connect/models/user-identities/user-identity.js +12 -1
  18. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  19. package/lib/seam/connect/openapi.d.ts +120 -0
  20. package/lib/seam/connect/openapi.js +149 -0
  21. package/lib/seam/connect/openapi.js.map +1 -1
  22. package/lib/seam/connect/route-types.d.ts +472 -0
  23. package/package.json +2 -2
  24. package/src/lib/seam/connect/models/devices/device.ts +20 -18
  25. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +17 -0
  26. package/src/lib/seam/connect/models/user-identities/user-identity.ts +19 -1
  27. package/src/lib/seam/connect/openapi.ts +177 -0
  28. package/src/lib/seam/connect/route-types.ts +665 -24
package/dist/connect.cjs CHANGED
@@ -204,7 +204,16 @@ var climate_preset = zod.z.object({
204
204
  deprecated: Use 'thermostat_schedule.is_override_allowed'
205
205
  ---
206
206
  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).`
207
- )
207
+ ),
208
+ ecobee_metadata: zod.z.object({
209
+ climate_ref: zod.z.string().describe(`Reference to the Ecobee climate, if applicable.`),
210
+ is_optimized: zod.z.boolean().describe(`Indicates if the climate preset is optimized by Ecobee.`),
211
+ owner: zod.z.enum(["user", "system"]).describe(
212
+ `Indicates whether the climate preset is owned by the user or the system.`
213
+ )
214
+ }).optional().describe(`
215
+ Metadata specific to the Ecobee climate, if applicable.
216
+ `)
208
217
  });
209
218
  var climate_setting = climate_preset.partial();
210
219
  var thermostat_daily_program_period = zod.z.object({
@@ -1457,14 +1466,20 @@ var many_active_backup_codes = common_device_warning.extend({
1457
1466
  `);
1458
1467
  var salto_ks_office_mode = common_device_warning.extend({
1459
1468
  warning_code: zod.z.literal("salto_ks_office_mode").describe(warning_code_description2)
1460
- }).describe(
1461
- "Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors."
1462
- );
1469
+ }).describe(`
1470
+ ---
1471
+ variant_group_key: access_codes
1472
+ ---
1473
+ Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.
1474
+ `);
1463
1475
  var salto_ks_privacy_mode = common_device_warning.extend({
1464
1476
  warning_code: zod.z.literal("salto_ks_privacy_mode").describe(warning_code_description2)
1465
- }).describe(
1466
- "Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors."
1467
- );
1477
+ }).describe(`
1478
+ ---
1479
+ variant_group_key: access_codes
1480
+ ---
1481
+ Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.
1482
+ `);
1468
1483
  var salto_ks_subscription_limit_almost_reached2 = common_device_warning.extend({
1469
1484
  warning_code: zod.z.literal("salto_ks_subscription_limit_almost_reached").describe(warning_code_description2)
1470
1485
  }).describe(
@@ -5313,6 +5328,13 @@ var user_identity_being_deleted = common_user_identity_warning.extend({
5313
5328
  "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue."
5314
5329
  )
5315
5330
  }).describe("Indicates that the user identity is currently being deleted.");
5331
+ var acs_user_profile_does_not_match_user_identity = common_user_identity_warning.extend({
5332
+ warning_code: zod.z.literal("acs_user_profile_does_not_match_user_identity").describe(
5333
+ "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue."
5334
+ )
5335
+ }).describe(
5336
+ "Indicates that the ACS user's profile does not match the user identity's profile"
5337
+ );
5316
5338
  var user_identity_issue_with_acs_user = common_user_identity_error.extend({
5317
5339
  error_code: zod.z.literal("issue_with_acs_user").describe(
5318
5340
  "Unique identifier of the type of error. Enables quick recognition and categorization of the issue."
@@ -5329,9 +5351,13 @@ zod.z.object({
5329
5351
  "Map of access system user IDs to issues with the access system user. The key is the access system user ID, and the value is the issue with the access system user."
5330
5352
  )
5331
5353
  });
5332
- var user_identity_warnings = zod.z.discriminatedUnion("warning_code", [user_identity_being_deleted]).describe("Warnings associated with the user identity.");
5354
+ var user_identity_warnings = zod.z.discriminatedUnion("warning_code", [
5355
+ user_identity_being_deleted,
5356
+ acs_user_profile_does_not_match_user_identity
5357
+ ]).describe("Warnings associated with the user identity.");
5333
5358
  zod.z.object({
5334
- user_identity_being_deleted: user_identity_being_deleted.optional().nullable()
5359
+ user_identity_being_deleted: user_identity_being_deleted.optional().nullable(),
5360
+ acs_user_profile_does_not_match_user_identity: acs_user_profile_does_not_match_user_identity.optional().nullable()
5335
5361
  });
5336
5362
  var user_identity_errors = zod.z.discriminatedUnion("error_code", [user_identity_issue_with_acs_user]).describe("Errors associated with the user identity.");
5337
5363
  var user_identity = zod.z.object({
@@ -15706,6 +15732,30 @@ var openapi_default = {
15706
15732
  description: "Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
15707
15733
  type: "string"
15708
15734
  },
15735
+ ecobee_metadata: {
15736
+ description: "\n Metadata specific to the Ecobee climate, if applicable.\n ",
15737
+ properties: {
15738
+ climate_ref: {
15739
+ description: "Reference to the Ecobee climate, if applicable.",
15740
+ type: "string"
15741
+ },
15742
+ is_optimized: {
15743
+ description: "Indicates if the climate preset is optimized by Ecobee.",
15744
+ type: "boolean"
15745
+ },
15746
+ owner: {
15747
+ description: "Indicates whether the climate preset is owned by the user or the system.",
15748
+ enum: ["user", "system"],
15749
+ type: "string"
15750
+ }
15751
+ },
15752
+ required: [
15753
+ "climate_ref",
15754
+ "is_optimized",
15755
+ "owner"
15756
+ ],
15757
+ type: "object"
15758
+ },
15709
15759
  fan_mode_setting: {
15710
15760
  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`.",
15711
15761
  enum: ["auto", "on", "circulate"],
@@ -15815,6 +15865,26 @@ var openapi_default = {
15815
15865
  description: "Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
15816
15866
  type: "string"
15817
15867
  },
15868
+ ecobee_metadata: {
15869
+ description: "\n Metadata specific to the Ecobee climate, if applicable.\n ",
15870
+ properties: {
15871
+ climate_ref: {
15872
+ description: "Reference to the Ecobee climate, if applicable.",
15873
+ type: "string"
15874
+ },
15875
+ is_optimized: {
15876
+ description: "Indicates if the climate preset is optimized by Ecobee.",
15877
+ type: "boolean"
15878
+ },
15879
+ owner: {
15880
+ description: "Indicates whether the climate preset is owned by the user or the system.",
15881
+ enum: ["user", "system"],
15882
+ type: "string"
15883
+ }
15884
+ },
15885
+ required: ["climate_ref", "is_optimized", "owner"],
15886
+ type: "object"
15887
+ },
15818
15888
  fan_mode_setting: {
15819
15889
  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`.",
15820
15890
  enum: ["auto", "on", "circulate"],
@@ -15896,6 +15966,26 @@ var openapi_default = {
15896
15966
  description: "Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).",
15897
15967
  type: "string"
15898
15968
  },
15969
+ ecobee_metadata: {
15970
+ description: "\n Metadata specific to the Ecobee climate, if applicable.\n ",
15971
+ properties: {
15972
+ climate_ref: {
15973
+ description: "Reference to the Ecobee climate, if applicable.",
15974
+ type: "string"
15975
+ },
15976
+ is_optimized: {
15977
+ description: "Indicates if the climate preset is optimized by Ecobee.",
15978
+ type: "boolean"
15979
+ },
15980
+ owner: {
15981
+ description: "Indicates whether the climate preset is owned by the user or the system.",
15982
+ enum: ["user", "system"],
15983
+ type: "string"
15984
+ }
15985
+ },
15986
+ required: ["climate_ref", "is_optimized", "owner"],
15987
+ type: "object"
15988
+ },
15899
15989
  fan_mode_setting: {
15900
15990
  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`.",
15901
15991
  enum: ["auto", "on", "circulate"],
@@ -16537,7 +16627,8 @@ var openapi_default = {
16537
16627
  }
16538
16628
  },
16539
16629
  required: ["message", "created_at", "warning_code"],
16540
- type: "object"
16630
+ type: "object",
16631
+ "x-variant-group-key": "access_codes"
16541
16632
  },
16542
16633
  {
16543
16634
  description: "Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.",
@@ -16558,7 +16649,8 @@ var openapi_default = {
16558
16649
  }
16559
16650
  },
16560
16651
  required: ["message", "created_at", "warning_code"],
16561
- type: "object"
16652
+ type: "object",
16653
+ "x-variant-group-key": "access_codes"
16562
16654
  },
16563
16655
  {
16564
16656
  description: "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.",
@@ -26509,7 +26601,8 @@ var openapi_default = {
26509
26601
  }
26510
26602
  },
26511
26603
  required: ["message", "created_at", "warning_code"],
26512
- type: "object"
26604
+ type: "object",
26605
+ "x-variant-group-key": "access_codes"
26513
26606
  },
26514
26607
  {
26515
26608
  description: "Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.",
@@ -26530,7 +26623,8 @@ var openapi_default = {
26530
26623
  }
26531
26624
  },
26532
26625
  required: ["message", "created_at", "warning_code"],
26533
- type: "object"
26626
+ type: "object",
26627
+ "x-variant-group-key": "access_codes"
26534
26628
  },
26535
26629
  {
26536
26630
  description: "Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.",
@@ -26745,6 +26839,27 @@ var openapi_default = {
26745
26839
  },
26746
26840
  required: ["created_at", "message", "warning_code"],
26747
26841
  type: "object"
26842
+ },
26843
+ {
26844
+ description: "Indicates that the ACS user's profile does not match the user identity's profile",
26845
+ properties: {
26846
+ created_at: {
26847
+ description: "Date and time at which Seam created the warning.",
26848
+ format: "date-time",
26849
+ type: "string"
26850
+ },
26851
+ message: {
26852
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
26853
+ type: "string"
26854
+ },
26855
+ warning_code: {
26856
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
26857
+ enum: ["acs_user_profile_does_not_match_user_identity"],
26858
+ type: "string"
26859
+ }
26860
+ },
26861
+ required: ["created_at", "message", "warning_code"],
26862
+ type: "object"
26748
26863
  }
26749
26864
  ]
26750
26865
  },
@@ -48352,6 +48467,26 @@ var openapi_default = {
48352
48467
  format: "uuid",
48353
48468
  type: "string"
48354
48469
  },
48470
+ ecobee_metadata: {
48471
+ description: "\n Metadata specific to the Ecobee climate, if applicable.\n ",
48472
+ properties: {
48473
+ climate_ref: {
48474
+ description: "Reference to the Ecobee climate, if applicable.",
48475
+ type: "string"
48476
+ },
48477
+ is_optimized: {
48478
+ description: "Indicates if the climate preset is optimized by Ecobee.",
48479
+ type: "boolean"
48480
+ },
48481
+ owner: {
48482
+ description: "Indicates whether the climate preset is owned by the user or the system.",
48483
+ enum: ["user", "system"],
48484
+ type: "string"
48485
+ }
48486
+ },
48487
+ required: ["climate_ref", "is_optimized", "owner"],
48488
+ type: "object"
48489
+ },
48355
48490
  fan_mode_setting: {
48356
48491
  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`.",
48357
48492
  enum: ["auto", "on", "circulate"],
@@ -50920,6 +51055,26 @@ var openapi_default = {
50920
51055
  format: "uuid",
50921
51056
  type: "string"
50922
51057
  },
51058
+ ecobee_metadata: {
51059
+ description: "\n Metadata specific to the Ecobee climate, if applicable.\n ",
51060
+ properties: {
51061
+ climate_ref: {
51062
+ description: "Reference to the Ecobee climate, if applicable.",
51063
+ type: "string"
51064
+ },
51065
+ is_optimized: {
51066
+ description: "Indicates if the climate preset is optimized by Ecobee.",
51067
+ type: "boolean"
51068
+ },
51069
+ owner: {
51070
+ description: "Indicates whether the climate preset is owned by the user or the system.",
51071
+ enum: ["user", "system"],
51072
+ type: "string"
51073
+ }
51074
+ },
51075
+ required: ["climate_ref", "is_optimized", "owner"],
51076
+ type: "object"
51077
+ },
50923
51078
  fan_mode_setting: {
50924
51079
  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`.",
50925
51080
  enum: ["auto", "on", "circulate"],
@@ -51027,6 +51182,26 @@ var openapi_default = {
51027
51182
  format: "uuid",
51028
51183
  type: "string"
51029
51184
  },
51185
+ ecobee_metadata: {
51186
+ description: "\n Metadata specific to the Ecobee climate, if applicable.\n ",
51187
+ properties: {
51188
+ climate_ref: {
51189
+ description: "Reference to the Ecobee climate, if applicable.",
51190
+ type: "string"
51191
+ },
51192
+ is_optimized: {
51193
+ description: "Indicates if the climate preset is optimized by Ecobee.",
51194
+ type: "boolean"
51195
+ },
51196
+ owner: {
51197
+ description: "Indicates whether the climate preset is owned by the user or the system.",
51198
+ enum: ["user", "system"],
51199
+ type: "string"
51200
+ }
51201
+ },
51202
+ required: ["climate_ref", "is_optimized", "owner"],
51203
+ type: "object"
51204
+ },
51030
51205
  fan_mode_setting: {
51031
51206
  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`.",
51032
51207
  enum: ["auto", "on", "circulate"],