@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
@@ -5960,6 +5960,26 @@ declare const _default: {
5960
5960
  description: string;
5961
5961
  type: string;
5962
5962
  };
5963
+ ecobee_metadata: {
5964
+ description: string;
5965
+ properties: {
5966
+ climate_ref: {
5967
+ description: string;
5968
+ type: string;
5969
+ };
5970
+ is_optimized: {
5971
+ description: string;
5972
+ type: string;
5973
+ };
5974
+ owner: {
5975
+ description: string;
5976
+ enum: string[];
5977
+ type: string;
5978
+ };
5979
+ };
5980
+ required: string[];
5981
+ type: string;
5982
+ };
5963
5983
  fan_mode_setting: {
5964
5984
  description: string;
5965
5985
  enum: string[];
@@ -6055,6 +6075,26 @@ declare const _default: {
6055
6075
  description: string;
6056
6076
  type: string;
6057
6077
  };
6078
+ ecobee_metadata: {
6079
+ description: string;
6080
+ properties: {
6081
+ climate_ref: {
6082
+ description: string;
6083
+ type: string;
6084
+ };
6085
+ is_optimized: {
6086
+ description: string;
6087
+ type: string;
6088
+ };
6089
+ owner: {
6090
+ description: string;
6091
+ enum: string[];
6092
+ type: string;
6093
+ };
6094
+ };
6095
+ required: string[];
6096
+ type: string;
6097
+ };
6058
6098
  fan_mode_setting: {
6059
6099
  description: string;
6060
6100
  enum: string[];
@@ -6129,6 +6169,26 @@ declare const _default: {
6129
6169
  description: string;
6130
6170
  type: string;
6131
6171
  };
6172
+ ecobee_metadata: {
6173
+ description: string;
6174
+ properties: {
6175
+ climate_ref: {
6176
+ description: string;
6177
+ type: string;
6178
+ };
6179
+ is_optimized: {
6180
+ description: string;
6181
+ type: string;
6182
+ };
6183
+ owner: {
6184
+ description: string;
6185
+ enum: string[];
6186
+ type: string;
6187
+ };
6188
+ };
6189
+ required: string[];
6190
+ type: string;
6191
+ };
6132
6192
  fan_mode_setting: {
6133
6193
  description: string;
6134
6194
  enum: string[];
@@ -37954,6 +38014,26 @@ declare const _default: {
37954
38014
  format: string;
37955
38015
  type: string;
37956
38016
  };
38017
+ ecobee_metadata: {
38018
+ description: string;
38019
+ properties: {
38020
+ climate_ref: {
38021
+ description: string;
38022
+ type: string;
38023
+ };
38024
+ is_optimized: {
38025
+ description: string;
38026
+ type: string;
38027
+ };
38028
+ owner: {
38029
+ description: string;
38030
+ enum: string[];
38031
+ type: string;
38032
+ };
38033
+ };
38034
+ required: string[];
38035
+ type: string;
38036
+ };
37957
38037
  fan_mode_setting: {
37958
38038
  description: string;
37959
38039
  enum: string[];
@@ -41144,6 +41224,26 @@ declare const _default: {
41144
41224
  format: string;
41145
41225
  type: string;
41146
41226
  };
41227
+ ecobee_metadata: {
41228
+ description: string;
41229
+ properties: {
41230
+ climate_ref: {
41231
+ description: string;
41232
+ type: string;
41233
+ };
41234
+ is_optimized: {
41235
+ description: string;
41236
+ type: string;
41237
+ };
41238
+ owner: {
41239
+ description: string;
41240
+ enum: string[];
41241
+ type: string;
41242
+ };
41243
+ };
41244
+ required: string[];
41245
+ type: string;
41246
+ };
41147
41247
  fan_mode_setting: {
41148
41248
  description: string;
41149
41249
  enum: string[];
@@ -41267,6 +41367,26 @@ declare const _default: {
41267
41367
  format: string;
41268
41368
  type: string;
41269
41369
  };
41370
+ ecobee_metadata: {
41371
+ description: string;
41372
+ properties: {
41373
+ climate_ref: {
41374
+ description: string;
41375
+ type: string;
41376
+ };
41377
+ is_optimized: {
41378
+ description: string;
41379
+ type: string;
41380
+ };
41381
+ owner: {
41382
+ description: string;
41383
+ enum: string[];
41384
+ type: string;
41385
+ };
41386
+ };
41387
+ required: string[];
41388
+ type: string;
41389
+ };
41270
41390
  fan_mode_setting: {
41271
41391
  description: string;
41272
41392
  enum: string[];
@@ -10270,6 +10270,30 @@ export default {
10270
10270
  description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
10271
10271
  type: 'string',
10272
10272
  },
10273
+ ecobee_metadata: {
10274
+ description: '\n Metadata specific to the Ecobee climate, if applicable.\n ',
10275
+ properties: {
10276
+ climate_ref: {
10277
+ description: 'Reference to the Ecobee climate, if applicable.',
10278
+ type: 'string',
10279
+ },
10280
+ is_optimized: {
10281
+ description: 'Indicates if the climate preset is optimized by Ecobee.',
10282
+ type: 'boolean',
10283
+ },
10284
+ owner: {
10285
+ description: 'Indicates whether the climate preset is owned by the user or the system.',
10286
+ enum: ['user', 'system'],
10287
+ type: 'string',
10288
+ },
10289
+ },
10290
+ required: [
10291
+ 'climate_ref',
10292
+ 'is_optimized',
10293
+ 'owner',
10294
+ ],
10295
+ type: 'object',
10296
+ },
10273
10297
  fan_mode_setting: {
10274
10298
  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`.',
10275
10299
  enum: ['auto', 'on', 'circulate'],
@@ -10379,6 +10403,26 @@ export default {
10379
10403
  description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
10380
10404
  type: 'string',
10381
10405
  },
10406
+ ecobee_metadata: {
10407
+ description: '\n Metadata specific to the Ecobee climate, if applicable.\n ',
10408
+ properties: {
10409
+ climate_ref: {
10410
+ description: 'Reference to the Ecobee climate, if applicable.',
10411
+ type: 'string',
10412
+ },
10413
+ is_optimized: {
10414
+ description: 'Indicates if the climate preset is optimized by Ecobee.',
10415
+ type: 'boolean',
10416
+ },
10417
+ owner: {
10418
+ description: 'Indicates whether the climate preset is owned by the user or the system.',
10419
+ enum: ['user', 'system'],
10420
+ type: 'string',
10421
+ },
10422
+ },
10423
+ required: ['climate_ref', 'is_optimized', 'owner'],
10424
+ type: 'object',
10425
+ },
10382
10426
  fan_mode_setting: {
10383
10427
  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`.',
10384
10428
  enum: ['auto', 'on', 'circulate'],
@@ -10460,6 +10504,26 @@ export default {
10460
10504
  description: 'Display name for the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets).',
10461
10505
  type: 'string',
10462
10506
  },
10507
+ ecobee_metadata: {
10508
+ description: '\n Metadata specific to the Ecobee climate, if applicable.\n ',
10509
+ properties: {
10510
+ climate_ref: {
10511
+ description: 'Reference to the Ecobee climate, if applicable.',
10512
+ type: 'string',
10513
+ },
10514
+ is_optimized: {
10515
+ description: 'Indicates if the climate preset is optimized by Ecobee.',
10516
+ type: 'boolean',
10517
+ },
10518
+ owner: {
10519
+ description: 'Indicates whether the climate preset is owned by the user or the system.',
10520
+ enum: ['user', 'system'],
10521
+ type: 'string',
10522
+ },
10523
+ },
10524
+ required: ['climate_ref', 'is_optimized', 'owner'],
10525
+ type: 'object',
10526
+ },
10463
10527
  fan_mode_setting: {
10464
10528
  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`.',
10465
10529
  enum: ['auto', 'on', 'circulate'],
@@ -11102,6 +11166,7 @@ export default {
11102
11166
  },
11103
11167
  required: ['message', 'created_at', 'warning_code'],
11104
11168
  type: 'object',
11169
+ 'x-variant-group-key': 'access_codes',
11105
11170
  },
11106
11171
  {
11107
11172
  description: 'Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.',
@@ -11123,6 +11188,7 @@ export default {
11123
11188
  },
11124
11189
  required: ['message', 'created_at', 'warning_code'],
11125
11190
  type: 'object',
11191
+ 'x-variant-group-key': 'access_codes',
11126
11192
  },
11127
11193
  {
11128
11194
  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.',
@@ -21074,6 +21140,7 @@ export default {
21074
21140
  },
21075
21141
  required: ['message', 'created_at', 'warning_code'],
21076
21142
  type: 'object',
21143
+ 'x-variant-group-key': 'access_codes',
21077
21144
  },
21078
21145
  {
21079
21146
  description: 'Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.',
@@ -21095,6 +21162,7 @@ export default {
21095
21162
  },
21096
21163
  required: ['message', 'created_at', 'warning_code'],
21097
21164
  type: 'object',
21165
+ 'x-variant-group-key': 'access_codes',
21098
21166
  },
21099
21167
  {
21100
21168
  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.',
@@ -21310,6 +21378,27 @@ export default {
21310
21378
  required: ['created_at', 'message', 'warning_code'],
21311
21379
  type: 'object',
21312
21380
  },
21381
+ {
21382
+ description: "Indicates that the ACS user's profile does not match the user identity's profile",
21383
+ properties: {
21384
+ created_at: {
21385
+ description: 'Date and time at which Seam created the warning.',
21386
+ format: 'date-time',
21387
+ type: 'string',
21388
+ },
21389
+ message: {
21390
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21391
+ type: 'string',
21392
+ },
21393
+ warning_code: {
21394
+ description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21395
+ enum: ['acs_user_profile_does_not_match_user_identity'],
21396
+ type: 'string',
21397
+ },
21398
+ },
21399
+ required: ['created_at', 'message', 'warning_code'],
21400
+ type: 'object',
21401
+ },
21313
21402
  ],
21314
21403
  },
21315
21404
  type: 'array',
@@ -42916,6 +43005,26 @@ export default {
42916
43005
  format: 'uuid',
42917
43006
  type: 'string',
42918
43007
  },
43008
+ ecobee_metadata: {
43009
+ description: '\n Metadata specific to the Ecobee climate, if applicable.\n ',
43010
+ properties: {
43011
+ climate_ref: {
43012
+ description: 'Reference to the Ecobee climate, if applicable.',
43013
+ type: 'string',
43014
+ },
43015
+ is_optimized: {
43016
+ description: 'Indicates if the climate preset is optimized by Ecobee.',
43017
+ type: 'boolean',
43018
+ },
43019
+ owner: {
43020
+ description: 'Indicates whether the climate preset is owned by the user or the system.',
43021
+ enum: ['user', 'system'],
43022
+ type: 'string',
43023
+ },
43024
+ },
43025
+ required: ['climate_ref', 'is_optimized', 'owner'],
43026
+ type: 'object',
43027
+ },
42919
43028
  fan_mode_setting: {
42920
43029
  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`.',
42921
43030
  enum: ['auto', 'on', 'circulate'],
@@ -45484,6 +45593,26 @@ export default {
45484
45593
  format: 'uuid',
45485
45594
  type: 'string',
45486
45595
  },
45596
+ ecobee_metadata: {
45597
+ description: '\n Metadata specific to the Ecobee climate, if applicable.\n ',
45598
+ properties: {
45599
+ climate_ref: {
45600
+ description: 'Reference to the Ecobee climate, if applicable.',
45601
+ type: 'string',
45602
+ },
45603
+ is_optimized: {
45604
+ description: 'Indicates if the climate preset is optimized by Ecobee.',
45605
+ type: 'boolean',
45606
+ },
45607
+ owner: {
45608
+ description: 'Indicates whether the climate preset is owned by the user or the system.',
45609
+ enum: ['user', 'system'],
45610
+ type: 'string',
45611
+ },
45612
+ },
45613
+ required: ['climate_ref', 'is_optimized', 'owner'],
45614
+ type: 'object',
45615
+ },
45487
45616
  fan_mode_setting: {
45488
45617
  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`.',
45489
45618
  enum: ['auto', 'on', 'circulate'],
@@ -45591,6 +45720,26 @@ export default {
45591
45720
  format: 'uuid',
45592
45721
  type: 'string',
45593
45722
  },
45723
+ ecobee_metadata: {
45724
+ description: '\n Metadata specific to the Ecobee climate, if applicable.\n ',
45725
+ properties: {
45726
+ climate_ref: {
45727
+ description: 'Reference to the Ecobee climate, if applicable.',
45728
+ type: 'string',
45729
+ },
45730
+ is_optimized: {
45731
+ description: 'Indicates if the climate preset is optimized by Ecobee.',
45732
+ type: 'boolean',
45733
+ },
45734
+ owner: {
45735
+ description: 'Indicates whether the climate preset is owned by the user or the system.',
45736
+ enum: ['user', 'system'],
45737
+ type: 'string',
45738
+ },
45739
+ },
45740
+ required: ['climate_ref', 'is_optimized', 'owner'],
45741
+ type: 'object',
45742
+ },
45594
45743
  fan_mode_setting: {
45595
45744
  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`.',
45596
45745
  enum: ['auto', 'on', 'circulate'],