@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
@@ -152,6 +152,22 @@ export const device_metadata = z
152
152
  lock_id: z.number(),
153
153
  lock_alias: z.string(),
154
154
  feature_value: z.string(),
155
+ features: z.object({
156
+ passcode: z.boolean(),
157
+ passcode_management: z.boolean(),
158
+ unlock_via_gateway: z.boolean(),
159
+ lock_command: z.boolean(),
160
+ incomplete_keyboard_passcode: z.boolean(),
161
+ }),
162
+ has_gateway: z.boolean().optional(),
163
+ wireless_keypads: z
164
+ .array(
165
+ z.object({
166
+ wireless_keypad_id: z.number(),
167
+ wireless_keypad_name: z.string(),
168
+ }),
169
+ )
170
+ .optional(),
155
171
  }),
156
172
 
157
173
  seam_bridge_metadata: z.object({
@@ -6,7 +6,7 @@ export const climate_preset = z.object({
6
6
  climate_preset_key: z.string(),
7
7
  can_edit: z.boolean(),
8
8
  can_delete: z.boolean(),
9
- name: z.string().nullable(),
9
+ name: z.string().nullable().default(null),
10
10
  display_name: z.string(),
11
11
  fan_mode_setting: fan_mode_setting.optional(),
12
12
  hvac_mode_setting: hvac_mode_setting.optional(),
@@ -1,3 +1,3 @@
1
1
  export * from './climate-preset.js'
2
- export * from './climate-setting-schedule.js'
3
2
  export * from './modes.js'
3
+ export * from './thermostat-schedule.js'
@@ -552,7 +552,30 @@ export default {
552
552
  error_code: {
553
553
  description:
554
554
  '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.',
555
- enum: ['salto_site_user_limit_reached'],
555
+ enum: ['salto_ks_subscription_limit_exceeded'],
556
+ type: 'string',
557
+ },
558
+ message: {
559
+ description:
560
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
561
+ type: 'string',
562
+ },
563
+ },
564
+ required: ['created_at', 'message', 'error_code'],
565
+ type: 'object',
566
+ },
567
+ {
568
+ properties: {
569
+ created_at: {
570
+ description:
571
+ 'Date and time at which Seam created the error.',
572
+ format: 'date-time',
573
+ type: 'string',
574
+ },
575
+ error_code: {
576
+ description:
577
+ '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.',
578
+ enum: ['acs_system_disconnected'],
556
579
  type: 'string',
557
580
  },
558
581
  message: {
@@ -574,8 +597,8 @@ export default {
574
597
  },
575
598
  error_code: {
576
599
  description:
577
- "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",
578
- enum: ['salto_seam_integration_blocked'],
600
+ 'Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access.',
601
+ enum: ['account_disconnected'],
579
602
  type: 'string',
580
603
  },
581
604
  message: {
@@ -667,8 +690,8 @@ export default {
667
690
  },
668
691
  warning_code: {
669
692
  description:
670
- '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.',
671
- enum: ['salto_site_user_limit_almost_reached'],
693
+ '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.',
694
+ enum: ['salto_ks_subscription_limit_almost_reached'],
672
695
  type: 'string',
673
696
  },
674
697
  },
@@ -3061,10 +3084,50 @@ export default {
3061
3084
  ttlock_metadata: {
3062
3085
  properties: {
3063
3086
  feature_value: { type: 'string' },
3087
+ features: {
3088
+ properties: {
3089
+ incomplete_keyboard_passcode: { type: 'boolean' },
3090
+ lock_command: { type: 'boolean' },
3091
+ passcode: { type: 'boolean' },
3092
+ passcode_management: { type: 'boolean' },
3093
+ unlock_via_gateway: { type: 'boolean' },
3094
+ },
3095
+ required: [
3096
+ 'passcode',
3097
+ 'passcode_management',
3098
+ 'unlock_via_gateway',
3099
+ 'lock_command',
3100
+ 'incomplete_keyboard_passcode',
3101
+ ],
3102
+ type: 'object',
3103
+ },
3104
+ has_gateway: { type: 'boolean' },
3064
3105
  lock_alias: { type: 'string' },
3065
3106
  lock_id: { format: 'float', type: 'number' },
3107
+ wireless_keypads: {
3108
+ items: {
3109
+ properties: {
3110
+ wireless_keypad_id: {
3111
+ format: 'float',
3112
+ type: 'number',
3113
+ },
3114
+ wireless_keypad_name: { type: 'string' },
3115
+ },
3116
+ required: [
3117
+ 'wireless_keypad_id',
3118
+ 'wireless_keypad_name',
3119
+ ],
3120
+ type: 'object',
3121
+ },
3122
+ type: 'array',
3123
+ },
3066
3124
  },
3067
- required: ['lock_id', 'lock_alias', 'feature_value'],
3125
+ required: [
3126
+ 'lock_id',
3127
+ 'lock_alias',
3128
+ 'feature_value',
3129
+ 'features',
3130
+ ],
3068
3131
  type: 'object',
3069
3132
  },
3070
3133
  two_n_metadata: {
@@ -3242,13 +3305,16 @@ export default {
3242
3305
  type: 'string',
3243
3306
  },
3244
3307
  manual_override_allowed: { type: 'boolean' },
3245
- name: { nullable: true, type: 'string' },
3308
+ name: {
3309
+ default: null,
3310
+ nullable: true,
3311
+ type: 'string',
3312
+ },
3246
3313
  },
3247
3314
  required: [
3248
3315
  'climate_preset_key',
3249
3316
  'can_edit',
3250
3317
  'can_delete',
3251
- 'name',
3252
3318
  'display_name',
3253
3319
  'manual_override_allowed',
3254
3320
  ],
@@ -3294,7 +3360,11 @@ export default {
3294
3360
  type: 'string',
3295
3361
  },
3296
3362
  manual_override_allowed: { type: 'boolean' },
3297
- name: { nullable: true, type: 'string' },
3363
+ name: {
3364
+ default: null,
3365
+ nullable: true,
3366
+ type: 'string',
3367
+ },
3298
3368
  },
3299
3369
  type: 'object',
3300
3370
  },
@@ -3330,7 +3400,11 @@ export default {
3330
3400
  type: 'string',
3331
3401
  },
3332
3402
  manual_override_allowed: { type: 'boolean' },
3333
- name: { nullable: true, type: 'string' },
3403
+ name: {
3404
+ default: null,
3405
+ nullable: true,
3406
+ type: 'string',
3407
+ },
3334
3408
  },
3335
3409
  type: 'object',
3336
3410
  'x-deprecated':
@@ -12644,12 +12718,11 @@ export default {
12644
12718
  type: 'string',
12645
12719
  },
12646
12720
  manual_override_allowed: { type: 'boolean' },
12647
- name: { nullable: true, type: 'string' },
12721
+ name: { default: null, nullable: true, type: 'string' },
12648
12722
  },
12649
12723
  required: [
12650
12724
  'device_id',
12651
12725
  'climate_preset_key',
12652
- 'name',
12653
12726
  'manual_override_allowed',
12654
12727
  ],
12655
12728
  type: 'object',
@@ -12694,13 +12767,12 @@ export default {
12694
12767
  type: 'string',
12695
12768
  },
12696
12769
  manual_override_allowed: { type: 'boolean' },
12697
- name: { nullable: true, type: 'string' },
12770
+ name: { default: null, nullable: true, type: 'string' },
12698
12771
  },
12699
12772
  required: [
12700
12773
  'climate_preset_key',
12701
12774
  'can_edit',
12702
12775
  'can_delete',
12703
- 'name',
12704
12776
  'display_name',
12705
12777
  'manual_override_allowed',
12706
12778
  ],
@@ -13702,12 +13774,11 @@ export default {
13702
13774
  type: 'string',
13703
13775
  },
13704
13776
  manual_override_allowed: { type: 'boolean' },
13705
- name: { nullable: true, type: 'string' },
13777
+ name: { default: null, nullable: true, type: 'string' },
13706
13778
  },
13707
13779
  required: [
13708
13780
  'device_id',
13709
13781
  'climate_preset_key',
13710
- 'name',
13711
13782
  'manual_override_allowed',
13712
13783
  ],
13713
13784
  type: 'object',
@@ -13752,13 +13823,12 @@ export default {
13752
13823
  type: 'string',
13753
13824
  },
13754
13825
  manual_override_allowed: { type: 'boolean' },
13755
- name: { nullable: true, type: 'string' },
13826
+ name: { default: null, nullable: true, type: 'string' },
13756
13827
  },
13757
13828
  required: [
13758
13829
  'climate_preset_key',
13759
13830
  'can_edit',
13760
13831
  'can_delete',
13761
- 'name',
13762
13832
  'display_name',
13763
13833
  'manual_override_allowed',
13764
13834
  ],
@@ -13816,12 +13886,11 @@ export default {
13816
13886
  type: 'string',
13817
13887
  },
13818
13888
  manual_override_allowed: { type: 'boolean' },
13819
- name: { nullable: true, type: 'string' },
13889
+ name: { default: null, nullable: true, type: 'string' },
13820
13890
  },
13821
13891
  required: [
13822
13892
  'device_id',
13823
13893
  'climate_preset_key',
13824
- 'name',
13825
13894
  'manual_override_allowed',
13826
13895
  ],
13827
13896
  type: 'object',
@@ -13866,13 +13935,12 @@ export default {
13866
13935
  type: 'string',
13867
13936
  },
13868
13937
  manual_override_allowed: { type: 'boolean' },
13869
- name: { nullable: true, type: 'string' },
13938
+ name: { default: null, nullable: true, type: 'string' },
13870
13939
  },
13871
13940
  required: [
13872
13941
  'climate_preset_key',
13873
13942
  'can_edit',
13874
13943
  'can_delete',
13875
- 'name',
13876
13944
  'display_name',
13877
13945
  'manual_override_allowed',
13878
13946
  ],