@seamapi/types 1.306.0 → 1.308.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 (38) hide show
  1. package/dist/connect.cjs +124 -53
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +311 -150
  4. package/lib/seam/connect/models/acs/acs-access-group.d.ts +13 -13
  5. package/lib/seam/connect/models/acs/acs-access-group.js +1 -1
  6. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-system.d.ts +34 -13
  8. package/lib/seam/connect/models/acs/acs-system.js +11 -4
  9. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  10. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +13 -13
  11. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +13 -13
  12. package/lib/seam/connect/models/action-attempts/scan-credential.js +7 -2
  13. package/lib/seam/connect/models/action-attempts/scan-credential.js.map +1 -1
  14. package/lib/seam/connect/models/devices/device-metadata.d.ts +18 -0
  15. package/lib/seam/connect/models/devices/device-metadata.js +4 -0
  16. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  17. package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
  18. package/lib/seam/connect/models/devices/device-provider.js +2 -0
  19. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  20. package/lib/seam/connect/models/devices/device-type.d.ts +1 -0
  21. package/lib/seam/connect/models/devices/device-type.js +1 -0
  22. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  23. package/lib/seam/connect/models/devices/device.d.ts +29 -3
  24. package/lib/seam/connect/models/devices/phone.d.ts +19 -1
  25. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +21 -3
  26. package/lib/seam/connect/openapi.d.ts +32 -17
  27. package/lib/seam/connect/openapi.js +80 -23
  28. package/lib/seam/connect/openapi.js.map +1 -1
  29. package/lib/seam/connect/route-types.d.ts +170 -90
  30. package/package.json +1 -1
  31. package/src/lib/seam/connect/models/acs/acs-access-group.ts +1 -1
  32. package/src/lib/seam/connect/models/acs/acs-system.ts +15 -5
  33. package/src/lib/seam/connect/models/action-attempts/scan-credential.ts +7 -4
  34. package/src/lib/seam/connect/models/devices/device-metadata.ts +5 -0
  35. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -0
  36. package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
  37. package/src/lib/seam/connect/openapi.ts +86 -26
  38. package/src/lib/seam/connect/route-types.ts +282 -82
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.306.0",
3
+ "version": "1.308.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -4,7 +4,7 @@ import { z } from 'zod'
4
4
  export const acs_access_group_external_type = z.enum([
5
5
  'pti_unit',
6
6
  'pti_access_level',
7
- 'salto_access_group',
7
+ 'salto_ks_access_group',
8
8
  'brivo_group',
9
9
  ])
10
10
 
@@ -39,6 +39,7 @@ export const acs_system_external_type = z.enum([
39
39
  'pti_site',
40
40
  'alta_org',
41
41
  'salto_ks_site',
42
+ 'salto_space_system',
42
43
  'brivo_account',
43
44
  'hid_credential_manager_organization',
44
45
  'visionline_system',
@@ -171,11 +172,20 @@ const salto_ks_subscription_limit_almost_reached =
171
172
  ),
172
173
  })
173
174
 
174
- const acs_system_warning =
175
- // z.union([
176
- salto_ks_subscription_limit_almost_reached
177
- // ])
178
- .describe('Warning associated with the `acs_system`.')
175
+ const time_zone_does_not_match_location = common_acs_system_warning.extend({
176
+ warning_code: z
177
+ .literal('time_zone_does_not_match_location')
178
+ .describe(
179
+ 'Indicates the ACS system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances.',
180
+ ),
181
+ })
182
+
183
+ const acs_system_warning = z
184
+ .union([
185
+ salto_ks_subscription_limit_almost_reached,
186
+ time_zone_does_not_match_location,
187
+ ])
188
+ .describe('Warning associated with the `acs_system`.')
179
189
 
180
190
  export const acs_system_warning_map = z.object({
181
191
  salto_ks_subscription_limit_almost_reached:
@@ -25,16 +25,19 @@ const error = z.union([
25
25
  ])
26
26
 
27
27
  const warning = z.object({
28
- warning_code: z.literal('acs_credential_on_encoder_out_of_sync'),
28
+ warning_code: z.union([
29
+ z.literal('acs_credential_on_encoder_out_of_sync'),
30
+ z.literal('acs_credential_on_seam_not_found'),
31
+ ]),
29
32
  warning_message: z.string(),
30
33
  })
31
34
 
32
35
  const acs_credential_on_seam = acs_credential.or(unmanaged_acs_credential)
33
36
 
34
37
  const result = z.object({
35
- acs_credential_on_encoder: acs_credential_on_encoder.describe(
36
- 'Snapshot of credential data read from physical encoder.',
37
- ),
38
+ acs_credential_on_encoder: acs_credential_on_encoder
39
+ .nullable()
40
+ .describe('Snapshot of credential data read from physical encoder.'),
38
41
  acs_credential_on_seam: acs_credential_on_seam
39
42
  .nullable()
40
43
  .describe('Matching acs_credential currently encoded on this card.'),
@@ -266,6 +266,11 @@ export const device_metadata = z
266
266
  assa_abloy_vostio_metadata: z.object({
267
267
  encoder_name: z.string(),
268
268
  }),
269
+
270
+ tado_metadata: z.object({
271
+ serial_no: z.string(),
272
+ device_type: z.string(),
273
+ }),
269
274
  })
270
275
  .partial()
271
276
 
@@ -47,6 +47,7 @@ export const DEVICE_PROVIDERS = {
47
47
  VOSTIO: 'assa_abloy_vostio',
48
48
  ASSA_ABLOY_VOSTIO_CREDENTIAL_SERVICE: 'assa_abloy_vostio_credential_service',
49
49
  TADO: 'tado',
50
+ SALTO_SPACE: 'salto_space',
50
51
  } as const
51
52
 
52
53
  export type DeviceProviderName =
@@ -113,6 +114,7 @@ export const PROVIDER_CATEGORY_MAP = {
113
114
  'salto_ks',
114
115
  'assa_abloy_vostio',
115
116
  'assa_abloy_vostio_credential_service',
117
+ 'salto_space',
116
118
  ],
117
119
 
118
120
  internal_beta: ALL_DEVICE_PROVIDERS,
@@ -68,6 +68,7 @@ export const THERMOSTAT_DEVICE_TYPE = {
68
68
  ECOBEE_THERMOSTAT: 'ecobee_thermostat',
69
69
  NEST_THERMOSTAT: 'nest_thermostat',
70
70
  HONEYWELL_RESIDEO_THERMOSTAT: 'honeywell_resideo_thermostat',
71
+ TADO_THERMOSTAT: 'tado_thermostat',
71
72
  } as const
72
73
 
73
74
  type ThermostatDeviceTypeFromMapping =
@@ -194,7 +194,7 @@ export default {
194
194
  enum: [
195
195
  'pti_unit',
196
196
  'pti_access_level',
197
- 'salto_access_group',
197
+ 'salto_ks_access_group',
198
198
  'brivo_group',
199
199
  ],
200
200
  type: 'string',
@@ -228,7 +228,7 @@ export default {
228
228
  enum: [
229
229
  'pti_unit',
230
230
  'pti_access_level',
231
- 'salto_access_group',
231
+ 'salto_ks_access_group',
232
232
  'brivo_group',
233
233
  ],
234
234
  type: 'string',
@@ -912,6 +912,7 @@ export default {
912
912
  'pti_site',
913
913
  'alta_org',
914
914
  'salto_ks_site',
915
+ 'salto_space_system',
915
916
  'brivo_account',
916
917
  'hid_credential_manager_organization',
917
918
  'visionline_system',
@@ -960,6 +961,7 @@ export default {
960
961
  'pti_site',
961
962
  'alta_org',
962
963
  'salto_ks_site',
964
+ 'salto_space_system',
963
965
  'brivo_account',
964
966
  'hid_credential_manager_organization',
965
967
  'visionline_system',
@@ -1003,27 +1005,54 @@ export default {
1003
1005
  description: 'Warnings associated with the `acs_system`.',
1004
1006
  items: {
1005
1007
  description: 'Warning associated with the `acs_system`.',
1006
- properties: {
1007
- created_at: {
1008
- description:
1009
- 'Date and time at which Seam created the warning.',
1010
- format: 'date-time',
1011
- type: 'string',
1012
- },
1013
- message: {
1014
- description:
1015
- 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1016
- type: 'string',
1008
+ oneOf: [
1009
+ {
1010
+ properties: {
1011
+ created_at: {
1012
+ description:
1013
+ 'Date and time at which Seam created the warning.',
1014
+ format: 'date-time',
1015
+ type: 'string',
1016
+ },
1017
+ message: {
1018
+ description:
1019
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1020
+ type: 'string',
1021
+ },
1022
+ warning_code: {
1023
+ description:
1024
+ '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.',
1025
+ enum: ['salto_ks_subscription_limit_almost_reached'],
1026
+ type: 'string',
1027
+ },
1028
+ },
1029
+ required: ['created_at', 'message', 'warning_code'],
1030
+ type: 'object',
1017
1031
  },
1018
- warning_code: {
1019
- description:
1020
- '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.',
1021
- enum: ['salto_ks_subscription_limit_almost_reached'],
1022
- type: 'string',
1032
+ {
1033
+ properties: {
1034
+ created_at: {
1035
+ description:
1036
+ 'Date and time at which Seam created the warning.',
1037
+ format: 'date-time',
1038
+ type: 'string',
1039
+ },
1040
+ message: {
1041
+ description:
1042
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1043
+ type: 'string',
1044
+ },
1045
+ warning_code: {
1046
+ description:
1047
+ 'Indicates the ACS system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances.',
1048
+ enum: ['time_zone_does_not_match_location'],
1049
+ type: 'string',
1050
+ },
1051
+ },
1052
+ required: ['created_at', 'message', 'warning_code'],
1053
+ type: 'object',
1023
1054
  },
1024
- },
1025
- required: ['created_at', 'message', 'warning_code'],
1026
- type: 'object',
1055
+ ],
1027
1056
  },
1028
1057
  type: 'array',
1029
1058
  },
@@ -1542,6 +1571,7 @@ export default {
1542
1571
  acs_credential_on_encoder: {
1543
1572
  description:
1544
1573
  'Snapshot of credential data read from physical encoder.',
1574
+ nullable: true,
1545
1575
  properties: {
1546
1576
  card_number: {
1547
1577
  description:
@@ -2229,7 +2259,10 @@ export default {
2229
2259
  items: {
2230
2260
  properties: {
2231
2261
  warning_code: {
2232
- enum: ['acs_credential_on_encoder_out_of_sync'],
2262
+ enum: [
2263
+ 'acs_credential_on_encoder_out_of_sync',
2264
+ 'acs_credential_on_seam_not_found',
2265
+ ],
2233
2266
  type: 'string',
2234
2267
  },
2235
2268
  warning_message: { type: 'string' },
@@ -4426,6 +4459,7 @@ export default {
4426
4459
  'ecobee_thermostat',
4427
4460
  'nest_thermostat',
4428
4461
  'honeywell_resideo_thermostat',
4462
+ 'tado_thermostat',
4429
4463
  ],
4430
4464
  type: 'string',
4431
4465
  },
@@ -5125,6 +5159,14 @@ export default {
5125
5159
  required: ['device_id', 'device_name'],
5126
5160
  type: 'object',
5127
5161
  },
5162
+ tado_metadata: {
5163
+ properties: {
5164
+ device_type: { type: 'string' },
5165
+ serial_no: { type: 'string' },
5166
+ },
5167
+ required: ['serial_no', 'device_type'],
5168
+ type: 'object',
5169
+ },
5128
5170
  tedee_metadata: {
5129
5171
  properties: {
5130
5172
  bridge_id: { format: 'float', type: 'number' },
@@ -5836,6 +5878,7 @@ export default {
5836
5878
  'assa_abloy_vostio',
5837
5879
  'assa_abloy_vostio_credential_service',
5838
5880
  'tado',
5881
+ 'salto_space',
5839
5882
  ],
5840
5883
  type: 'string',
5841
5884
  },
@@ -6438,6 +6481,7 @@ export default {
6438
6481
  'ecobee_thermostat',
6439
6482
  'nest_thermostat',
6440
6483
  'honeywell_resideo_thermostat',
6484
+ 'tado_thermostat',
6441
6485
  ],
6442
6486
  type: 'string',
6443
6487
  },
@@ -8481,7 +8525,7 @@ export default {
8481
8525
  enum: [
8482
8526
  'pti_unit',
8483
8527
  'pti_access_level',
8484
- 'salto_access_group',
8528
+ 'salto_ks_access_group',
8485
8529
  'brivo_group',
8486
8530
  ],
8487
8531
  type: 'string',
@@ -8516,7 +8560,7 @@ export default {
8516
8560
  enum: [
8517
8561
  'pti_unit',
8518
8562
  'pti_access_level',
8519
- 'salto_access_group',
8563
+ 'salto_ks_access_group',
8520
8564
  'brivo_group',
8521
8565
  ],
8522
8566
  type: 'string',
@@ -8622,7 +8666,7 @@ export default {
8622
8666
  enum: [
8623
8667
  'pti_unit',
8624
8668
  'pti_access_level',
8625
- 'salto_access_group',
8669
+ 'salto_ks_access_group',
8626
8670
  'brivo_group',
8627
8671
  ],
8628
8672
  type: 'string',
@@ -8657,7 +8701,7 @@ export default {
8657
8701
  enum: [
8658
8702
  'pti_unit',
8659
8703
  'pti_access_level',
8660
- 'salto_access_group',
8704
+ 'salto_ks_access_group',
8661
8705
  'brivo_group',
8662
8706
  ],
8663
8707
  type: 'string',
@@ -13476,6 +13520,7 @@ export default {
13476
13520
  'assa_abloy_vostio',
13477
13521
  'assa_abloy_vostio_credential_service',
13478
13522
  'tado',
13523
+ 'salto_space',
13479
13524
  'yale_access',
13480
13525
  'hid_cm',
13481
13526
  'google_nest',
@@ -14130,6 +14175,7 @@ export default {
14130
14175
  'ecobee_thermostat',
14131
14176
  'nest_thermostat',
14132
14177
  'honeywell_resideo_thermostat',
14178
+ 'tado_thermostat',
14133
14179
  ],
14134
14180
  type: 'string',
14135
14181
  },
@@ -14182,6 +14228,7 @@ export default {
14182
14228
  'ecobee_thermostat',
14183
14229
  'nest_thermostat',
14184
14230
  'honeywell_resideo_thermostat',
14231
+ 'tado_thermostat',
14185
14232
  ],
14186
14233
  type: 'string',
14187
14234
  },
@@ -14278,6 +14325,7 @@ export default {
14278
14325
  'tedee',
14279
14326
  'honeywell_resideo',
14280
14327
  'akiles',
14328
+ 'tado',
14281
14329
  ],
14282
14330
  type: 'string',
14283
14331
  },
@@ -14654,6 +14702,7 @@ export default {
14654
14702
  'ecobee_thermostat',
14655
14703
  'nest_thermostat',
14656
14704
  'honeywell_resideo_thermostat',
14705
+ 'tado_thermostat',
14657
14706
  ],
14658
14707
  type: 'string',
14659
14708
  },
@@ -14706,6 +14755,7 @@ export default {
14706
14755
  'ecobee_thermostat',
14707
14756
  'nest_thermostat',
14708
14757
  'honeywell_resideo_thermostat',
14758
+ 'tado_thermostat',
14709
14759
  ],
14710
14760
  type: 'string',
14711
14761
  },
@@ -14802,6 +14852,7 @@ export default {
14802
14852
  'tedee',
14803
14853
  'honeywell_resideo',
14804
14854
  'akiles',
14855
+ 'tado',
14805
14856
  ],
14806
14857
  type: 'string',
14807
14858
  },
@@ -15483,6 +15534,7 @@ export default {
15483
15534
  'ecobee_thermostat',
15484
15535
  'nest_thermostat',
15485
15536
  'honeywell_resideo_thermostat',
15537
+ 'tado_thermostat',
15486
15538
  ],
15487
15539
  type: 'string',
15488
15540
  },
@@ -15535,6 +15587,7 @@ export default {
15535
15587
  'ecobee_thermostat',
15536
15588
  'nest_thermostat',
15537
15589
  'honeywell_resideo_thermostat',
15590
+ 'tado_thermostat',
15538
15591
  ],
15539
15592
  type: 'string',
15540
15593
  },
@@ -15631,6 +15684,7 @@ export default {
15631
15684
  'tedee',
15632
15685
  'honeywell_resideo',
15633
15686
  'akiles',
15687
+ 'tado',
15634
15688
  ],
15635
15689
  type: 'string',
15636
15690
  },
@@ -15968,6 +16022,7 @@ export default {
15968
16022
  'ecobee_thermostat',
15969
16023
  'nest_thermostat',
15970
16024
  'honeywell_resideo_thermostat',
16025
+ 'tado_thermostat',
15971
16026
  ],
15972
16027
  type: 'string',
15973
16028
  },
@@ -16020,6 +16075,7 @@ export default {
16020
16075
  'ecobee_thermostat',
16021
16076
  'nest_thermostat',
16022
16077
  'honeywell_resideo_thermostat',
16078
+ 'tado_thermostat',
16023
16079
  ],
16024
16080
  type: 'string',
16025
16081
  },
@@ -16116,6 +16172,7 @@ export default {
16116
16172
  'tedee',
16117
16173
  'honeywell_resideo',
16118
16174
  'akiles',
16175
+ 'tado',
16119
16176
  ],
16120
16177
  type: 'string',
16121
16178
  },
@@ -17374,6 +17431,7 @@ export default {
17374
17431
  'ecobee_thermostat',
17375
17432
  'nest_thermostat',
17376
17433
  'honeywell_resideo_thermostat',
17434
+ 'tado_thermostat',
17377
17435
  ],
17378
17436
  type: 'string',
17379
17437
  },
@@ -17426,6 +17484,7 @@ export default {
17426
17484
  'ecobee_thermostat',
17427
17485
  'nest_thermostat',
17428
17486
  'honeywell_resideo_thermostat',
17487
+ 'tado_thermostat',
17429
17488
  ],
17430
17489
  type: 'string',
17431
17490
  },
@@ -17522,6 +17581,7 @@ export default {
17522
17581
  'tedee',
17523
17582
  'honeywell_resideo',
17524
17583
  'akiles',
17584
+ 'tado',
17525
17585
  ],
17526
17586
  type: 'string',
17527
17587
  },