@seamapi/types 1.242.0 → 1.243.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 (47) hide show
  1. package/dist/connect.cjs +134 -45
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +484 -62
  4. package/dist/devicedb.cjs +9 -6
  5. package/dist/devicedb.cjs.map +1 -1
  6. package/dist/devicedb.d.cts +123 -70
  7. package/lib/seam/connect/models/acs/acs-system.d.ts +86 -42
  8. package/lib/seam/connect/models/acs/acs-system.js +23 -20
  9. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  10. package/lib/seam/connect/models/acs/acs-user.d.ts +8 -8
  11. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +5 -5
  12. package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +5 -5
  13. package/lib/seam/connect/models/devices/device-metadata.d.ts +78 -0
  14. package/lib/seam/connect/models/devices/device-metadata.js +14 -0
  15. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.d.ts +108 -6
  17. package/lib/seam/connect/models/devices/phone.d.ts +83 -5
  18. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +83 -5
  19. package/lib/seam/connect/models/thermostats/climate-preset.d.ts +3 -3
  20. package/lib/seam/connect/models/thermostats/climate-preset.js +1 -1
  21. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  22. package/lib/seam/connect/models/thermostats/index.d.ts +1 -1
  23. package/lib/seam/connect/models/thermostats/index.js +1 -1
  24. package/lib/seam/connect/models/thermostats/index.js.map +1 -1
  25. package/lib/seam/connect/models/thermostats/{climate-setting-schedule.js → thermostat-schedule.js} +1 -1
  26. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -0
  27. package/lib/seam/connect/openapi.d.ts +49 -0
  28. package/lib/seam/connect/openapi.js +87 -22
  29. package/lib/seam/connect/openapi.js.map +1 -1
  30. package/lib/seam/connect/route-types.d.ts +208 -36
  31. package/lib/seam/devicedb/models/device-model.d.ts +59 -24
  32. package/lib/seam/devicedb/models/device-model.js +9 -6
  33. package/lib/seam/devicedb/models/device-model.js.map +1 -1
  34. package/lib/seam/devicedb/route-specs.d.ts +56 -38
  35. package/lib/seam/devicedb/route-types.d.ts +8 -8
  36. package/package.json +1 -1
  37. package/src/lib/seam/connect/models/acs/acs-system.ts +32 -24
  38. package/src/lib/seam/connect/models/devices/device-metadata.ts +16 -0
  39. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +1 -1
  40. package/src/lib/seam/connect/models/thermostats/index.ts +1 -1
  41. package/src/lib/seam/connect/openapi.ts +90 -22
  42. package/src/lib/seam/connect/route-types.ts +236 -36
  43. package/src/lib/seam/devicedb/models/device-model.ts +24 -19
  44. package/src/lib/seam/devicedb/route-types.ts +8 -8
  45. package/lib/seam/connect/models/thermostats/climate-setting-schedule.js.map +0 -1
  46. /package/lib/seam/connect/models/thermostats/{climate-setting-schedule.d.ts → thermostat-schedule.d.ts} +0 -0
  47. /package/src/lib/seam/connect/models/thermostats/{climate-setting-schedule.ts → thermostat-schedule.ts} +0 -0
@@ -2198,6 +2198,30 @@ declare const _default: {
2198
2198
  feature_value: {
2199
2199
  type: string;
2200
2200
  };
2201
+ features: {
2202
+ properties: {
2203
+ incomplete_keyboard_passcode: {
2204
+ type: string;
2205
+ };
2206
+ lock_command: {
2207
+ type: string;
2208
+ };
2209
+ passcode: {
2210
+ type: string;
2211
+ };
2212
+ passcode_management: {
2213
+ type: string;
2214
+ };
2215
+ unlock_via_gateway: {
2216
+ type: string;
2217
+ };
2218
+ };
2219
+ required: string[];
2220
+ type: string;
2221
+ };
2222
+ has_gateway: {
2223
+ type: string;
2224
+ };
2201
2225
  lock_alias: {
2202
2226
  type: string;
2203
2227
  };
@@ -2205,6 +2229,22 @@ declare const _default: {
2205
2229
  format: string;
2206
2230
  type: string;
2207
2231
  };
2232
+ wireless_keypads: {
2233
+ items: {
2234
+ properties: {
2235
+ wireless_keypad_id: {
2236
+ format: string;
2237
+ type: string;
2238
+ };
2239
+ wireless_keypad_name: {
2240
+ type: string;
2241
+ };
2242
+ };
2243
+ required: string[];
2244
+ type: string;
2245
+ };
2246
+ type: string;
2247
+ };
2208
2248
  };
2209
2249
  required: string[];
2210
2250
  type: string;
@@ -2447,6 +2487,7 @@ declare const _default: {
2447
2487
  type: string;
2448
2488
  };
2449
2489
  name: {
2490
+ default: null;
2450
2491
  nullable: boolean;
2451
2492
  type: string;
2452
2493
  };
@@ -2505,6 +2546,7 @@ declare const _default: {
2505
2546
  type: string;
2506
2547
  };
2507
2548
  name: {
2549
+ default: null;
2508
2550
  nullable: boolean;
2509
2551
  type: string;
2510
2552
  };
@@ -2554,6 +2596,7 @@ declare const _default: {
2554
2596
  type: string;
2555
2597
  };
2556
2598
  name: {
2599
+ default: null;
2557
2600
  nullable: boolean;
2558
2601
  type: string;
2559
2602
  };
@@ -14277,6 +14320,7 @@ declare const _default: {
14277
14320
  type: string;
14278
14321
  };
14279
14322
  name: {
14323
+ default: null;
14280
14324
  nullable: boolean;
14281
14325
  type: string;
14282
14326
  };
@@ -14335,6 +14379,7 @@ declare const _default: {
14335
14379
  type: string;
14336
14380
  };
14337
14381
  name: {
14382
+ default: null;
14338
14383
  nullable: boolean;
14339
14384
  type: string;
14340
14385
  };
@@ -15612,6 +15657,7 @@ declare const _default: {
15612
15657
  type: string;
15613
15658
  };
15614
15659
  name: {
15660
+ default: null;
15615
15661
  nullable: boolean;
15616
15662
  type: string;
15617
15663
  };
@@ -15670,6 +15716,7 @@ declare const _default: {
15670
15716
  type: string;
15671
15717
  };
15672
15718
  name: {
15719
+ default: null;
15673
15720
  nullable: boolean;
15674
15721
  type: string;
15675
15722
  };
@@ -15754,6 +15801,7 @@ declare const _default: {
15754
15801
  type: string;
15755
15802
  };
15756
15803
  name: {
15804
+ default: null;
15757
15805
  nullable: boolean;
15758
15806
  type: string;
15759
15807
  };
@@ -15812,6 +15860,7 @@ declare const _default: {
15812
15860
  type: string;
15813
15861
  };
15814
15862
  name: {
15863
+ default: null;
15815
15864
  nullable: boolean;
15816
15865
  type: string;
15817
15866
  };
@@ -519,7 +519,27 @@ export default {
519
519
  },
520
520
  error_code: {
521
521
  description: 'Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.',
522
- enum: ['salto_site_user_limit_reached'],
522
+ enum: ['salto_ks_subscription_limit_exceeded'],
523
+ type: 'string',
524
+ },
525
+ message: {
526
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
527
+ type: 'string',
528
+ },
529
+ },
530
+ required: ['created_at', 'message', 'error_code'],
531
+ type: 'object',
532
+ },
533
+ {
534
+ properties: {
535
+ created_at: {
536
+ description: 'Date and time at which Seam created the error.',
537
+ format: 'date-time',
538
+ type: 'string',
539
+ },
540
+ error_code: {
541
+ description: 'Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue.',
542
+ enum: ['acs_system_disconnected'],
523
543
  type: 'string',
524
544
  },
525
545
  message: {
@@ -538,8 +558,8 @@ export default {
538
558
  type: 'string',
539
559
  },
540
560
  error_code: {
541
- description: "Indicates that the Seam Integration user site is blocked. This means that Seam does not have permission to access Salto resources. Go to Salto Dashboard to remove 'Seam Integration' block",
542
- enum: ['salto_seam_integration_blocked'],
561
+ description: 'Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access.',
562
+ enum: ['account_disconnected'],
543
563
  type: 'string',
544
564
  },
545
565
  message: {
@@ -625,8 +645,8 @@ export default {
625
645
  type: 'string',
626
646
  },
627
647
  warning_code: {
628
- description: 'You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit.',
629
- enum: ['salto_site_user_limit_almost_reached'],
648
+ description: 'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this.',
649
+ enum: ['salto_ks_subscription_limit_almost_reached'],
630
650
  type: 'string',
631
651
  },
632
652
  },
@@ -2972,10 +2992,50 @@ export default {
2972
2992
  ttlock_metadata: {
2973
2993
  properties: {
2974
2994
  feature_value: { type: 'string' },
2995
+ features: {
2996
+ properties: {
2997
+ incomplete_keyboard_passcode: { type: 'boolean' },
2998
+ lock_command: { type: 'boolean' },
2999
+ passcode: { type: 'boolean' },
3000
+ passcode_management: { type: 'boolean' },
3001
+ unlock_via_gateway: { type: 'boolean' },
3002
+ },
3003
+ required: [
3004
+ 'passcode',
3005
+ 'passcode_management',
3006
+ 'unlock_via_gateway',
3007
+ 'lock_command',
3008
+ 'incomplete_keyboard_passcode',
3009
+ ],
3010
+ type: 'object',
3011
+ },
3012
+ has_gateway: { type: 'boolean' },
2975
3013
  lock_alias: { type: 'string' },
2976
3014
  lock_id: { format: 'float', type: 'number' },
3015
+ wireless_keypads: {
3016
+ items: {
3017
+ properties: {
3018
+ wireless_keypad_id: {
3019
+ format: 'float',
3020
+ type: 'number',
3021
+ },
3022
+ wireless_keypad_name: { type: 'string' },
3023
+ },
3024
+ required: [
3025
+ 'wireless_keypad_id',
3026
+ 'wireless_keypad_name',
3027
+ ],
3028
+ type: 'object',
3029
+ },
3030
+ type: 'array',
3031
+ },
2977
3032
  },
2978
- required: ['lock_id', 'lock_alias', 'feature_value'],
3033
+ required: [
3034
+ 'lock_id',
3035
+ 'lock_alias',
3036
+ 'feature_value',
3037
+ 'features',
3038
+ ],
2979
3039
  type: 'object',
2980
3040
  },
2981
3041
  two_n_metadata: {
@@ -3152,13 +3212,16 @@ export default {
3152
3212
  type: 'string',
3153
3213
  },
3154
3214
  manual_override_allowed: { type: 'boolean' },
3155
- name: { nullable: true, type: 'string' },
3215
+ name: {
3216
+ default: null,
3217
+ nullable: true,
3218
+ type: 'string',
3219
+ },
3156
3220
  },
3157
3221
  required: [
3158
3222
  'climate_preset_key',
3159
3223
  'can_edit',
3160
3224
  'can_delete',
3161
- 'name',
3162
3225
  'display_name',
3163
3226
  'manual_override_allowed',
3164
3227
  ],
@@ -3204,7 +3267,11 @@ export default {
3204
3267
  type: 'string',
3205
3268
  },
3206
3269
  manual_override_allowed: { type: 'boolean' },
3207
- name: { nullable: true, type: 'string' },
3270
+ name: {
3271
+ default: null,
3272
+ nullable: true,
3273
+ type: 'string',
3274
+ },
3208
3275
  },
3209
3276
  type: 'object',
3210
3277
  },
@@ -3240,7 +3307,11 @@ export default {
3240
3307
  type: 'string',
3241
3308
  },
3242
3309
  manual_override_allowed: { type: 'boolean' },
3243
- name: { nullable: true, type: 'string' },
3310
+ name: {
3311
+ default: null,
3312
+ nullable: true,
3313
+ type: 'string',
3314
+ },
3244
3315
  },
3245
3316
  type: 'object',
3246
3317
  'x-deprecated': 'use fallback_climate_preset_key to specify a fallback climate preset instead.',
@@ -12459,12 +12530,11 @@ export default {
12459
12530
  type: 'string',
12460
12531
  },
12461
12532
  manual_override_allowed: { type: 'boolean' },
12462
- name: { nullable: true, type: 'string' },
12533
+ name: { default: null, nullable: true, type: 'string' },
12463
12534
  },
12464
12535
  required: [
12465
12536
  'device_id',
12466
12537
  'climate_preset_key',
12467
- 'name',
12468
12538
  'manual_override_allowed',
12469
12539
  ],
12470
12540
  type: 'object',
@@ -12509,13 +12579,12 @@ export default {
12509
12579
  type: 'string',
12510
12580
  },
12511
12581
  manual_override_allowed: { type: 'boolean' },
12512
- name: { nullable: true, type: 'string' },
12582
+ name: { default: null, nullable: true, type: 'string' },
12513
12583
  },
12514
12584
  required: [
12515
12585
  'climate_preset_key',
12516
12586
  'can_edit',
12517
12587
  'can_delete',
12518
- 'name',
12519
12588
  'display_name',
12520
12589
  'manual_override_allowed',
12521
12590
  ],
@@ -13516,12 +13585,11 @@ export default {
13516
13585
  type: 'string',
13517
13586
  },
13518
13587
  manual_override_allowed: { type: 'boolean' },
13519
- name: { nullable: true, type: 'string' },
13588
+ name: { default: null, nullable: true, type: 'string' },
13520
13589
  },
13521
13590
  required: [
13522
13591
  'device_id',
13523
13592
  'climate_preset_key',
13524
- 'name',
13525
13593
  'manual_override_allowed',
13526
13594
  ],
13527
13595
  type: 'object',
@@ -13566,13 +13634,12 @@ export default {
13566
13634
  type: 'string',
13567
13635
  },
13568
13636
  manual_override_allowed: { type: 'boolean' },
13569
- name: { nullable: true, type: 'string' },
13637
+ name: { default: null, nullable: true, type: 'string' },
13570
13638
  },
13571
13639
  required: [
13572
13640
  'climate_preset_key',
13573
13641
  'can_edit',
13574
13642
  'can_delete',
13575
- 'name',
13576
13643
  'display_name',
13577
13644
  'manual_override_allowed',
13578
13645
  ],
@@ -13630,12 +13697,11 @@ export default {
13630
13697
  type: 'string',
13631
13698
  },
13632
13699
  manual_override_allowed: { type: 'boolean' },
13633
- name: { nullable: true, type: 'string' },
13700
+ name: { default: null, nullable: true, type: 'string' },
13634
13701
  },
13635
13702
  required: [
13636
13703
  'device_id',
13637
13704
  'climate_preset_key',
13638
- 'name',
13639
13705
  'manual_override_allowed',
13640
13706
  ],
13641
13707
  type: 'object',
@@ -13680,13 +13746,12 @@ export default {
13680
13746
  type: 'string',
13681
13747
  },
13682
13748
  manual_override_allowed: { type: 'boolean' },
13683
- name: { nullable: true, type: 'string' },
13749
+ name: { default: null, nullable: true, type: 'string' },
13684
13750
  },
13685
13751
  required: [
13686
13752
  'climate_preset_key',
13687
13753
  'can_edit',
13688
13754
  'can_delete',
13689
- 'name',
13690
13755
  'display_name',
13691
13756
  'manual_override_allowed',
13692
13757
  ],