@seamapi/types 1.138.0 → 1.139.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.
@@ -669,6 +669,19 @@ export default {
669
669
  allOf: [
670
670
  {
671
671
  properties: {
672
+ accessory_keypad: {
673
+ description:
674
+ 'Represents the accessory keypad state.',
675
+ properties: {
676
+ is_connected: {
677
+ description:
678
+ 'Indicates if the accessory_keypad is connected to the device.',
679
+ type: 'boolean',
680
+ },
681
+ },
682
+ required: ['is_connected'],
683
+ type: 'object',
684
+ },
672
685
  appearance: {
673
686
  properties: {
674
687
  name: {
@@ -725,11 +738,21 @@ export default {
725
738
  'Indicates whether the device supports an accessory keypad.',
726
739
  type: 'boolean',
727
740
  },
741
+ can_connect_accessory_keypad: {
742
+ description:
743
+ 'Indicates whether the device can connect a accessory keypad.',
744
+ type: 'boolean',
745
+ },
728
746
  display_name: {
729
747
  description:
730
748
  'Display name of the device model.',
731
749
  type: 'string',
732
750
  },
751
+ has_built_in_keypad: {
752
+ description:
753
+ 'Indicates whether the device has a built in accessory keypad.',
754
+ type: 'boolean',
755
+ },
733
756
  manufacturer_display_name: {
734
757
  description:
735
758
  'Display name that corresponds to the manufacturer-specific terminology for the device.',
@@ -2244,10 +2267,20 @@ export default {
2244
2267
  'Indicates whether the device supports an accessory keypad.',
2245
2268
  type: 'boolean',
2246
2269
  },
2270
+ can_connect_accessory_keypad: {
2271
+ description:
2272
+ 'Indicates whether the device can connect a accessory keypad.',
2273
+ type: 'boolean',
2274
+ },
2247
2275
  display_name: {
2248
2276
  description: 'Display name of the device model.',
2249
2277
  type: 'string',
2250
2278
  },
2279
+ has_built_in_keypad: {
2280
+ description:
2281
+ 'Indicates whether the device has a built in accessory keypad.',
2282
+ type: 'boolean',
2283
+ },
2251
2284
  manufacturer_display_name: {
2252
2285
  description:
2253
2286
  'Display name that corresponds to the manufacturer-specific terminology for the device.',
@@ -4240,7 +4273,6 @@ export default {
4240
4273
  acs_user_id: { format: 'uuid', type: 'string' },
4241
4274
  code: { pattern: '^\\d+$', type: 'string' },
4242
4275
  ends_at: { format: 'date-time', type: 'string' },
4243
- external_type: { enum: ['visionline_card'], type: 'string' },
4244
4276
  is_multi_phone_sync_credential: {
4245
4277
  default: false,
4246
4278
  type: 'boolean',
@@ -879,7 +879,6 @@ export interface Routes {
879
879
  access_method: 'code' | 'card' | 'mobile_key'
880
880
  code?: string | undefined
881
881
  is_multi_phone_sync_credential?: boolean
882
- external_type?: 'visionline_card' | undefined
883
882
  visionline_metadata?:
884
883
  | {
885
884
  assa_abloy_credential_service_mobile_endpoint_id?:
@@ -2251,15 +2250,26 @@ export interface Routes {
2251
2250
  online: boolean
2252
2251
  /** Name of the device. Deprecated - use device.display_name instead */
2253
2252
  name: string
2253
+ /** Represents the accessory keypad state. */
2254
+ accessory_keypad?:
2255
+ | {
2256
+ /** Indicates if the accessory_keypad is connected to the device. */
2257
+ is_connected: boolean
2258
+ }
2259
+ | undefined
2254
2260
  appearance: {
2255
2261
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
2256
2262
  name: string
2257
2263
  }
2258
2264
  model: {
2265
+ /** Indicates whether the device can connect a accessory keypad. */
2266
+ can_connect_accessory_keypad?: boolean | undefined
2259
2267
  /** Display name of the device model. */
2260
2268
  display_name: string
2261
2269
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
2262
2270
  manufacturer_display_name: string
2271
+ /** Indicates whether the device has a built in accessory keypad. */
2272
+ has_built_in_keypad?: boolean | undefined
2263
2273
  /** Indicates whether the device supports offline access codes. */
2264
2274
  offline_access_codes_supported?: boolean | undefined
2265
2275
  /** Indicates whether the device supports online access codes. */
@@ -3078,15 +3088,26 @@ export interface Routes {
3078
3088
  online: boolean
3079
3089
  /** Name of the device. Deprecated - use device.display_name instead */
3080
3090
  name: string
3091
+ /** Represents the accessory keypad state. */
3092
+ accessory_keypad?:
3093
+ | {
3094
+ /** Indicates if the accessory_keypad is connected to the device. */
3095
+ is_connected: boolean
3096
+ }
3097
+ | undefined
3081
3098
  appearance: {
3082
3099
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
3083
3100
  name: string
3084
3101
  }
3085
3102
  model: {
3103
+ /** Indicates whether the device can connect a accessory keypad. */
3104
+ can_connect_accessory_keypad?: boolean | undefined
3086
3105
  /** Display name of the device model. */
3087
3106
  display_name: string
3088
3107
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
3089
3108
  manufacturer_display_name: string
3109
+ /** Indicates whether the device has a built in accessory keypad. */
3110
+ has_built_in_keypad?: boolean | undefined
3090
3111
  /** Indicates whether the device supports offline access codes. */
3091
3112
  offline_access_codes_supported?: boolean | undefined
3092
3113
  /** Indicates whether the device supports online access codes. */
@@ -3894,10 +3915,14 @@ export interface Routes {
3894
3915
  /** Indicates whether it is currently possible to use offline access codes for the device. */
3895
3916
  offline_access_codes_enabled?: boolean | undefined
3896
3917
  model: {
3918
+ /** Indicates whether the device can connect a accessory keypad. */
3919
+ can_connect_accessory_keypad?: boolean | undefined
3897
3920
  /** Display name of the device model. */
3898
3921
  display_name: string
3899
3922
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
3900
3923
  manufacturer_display_name: string
3924
+ /** Indicates whether the device has a built in accessory keypad. */
3925
+ has_built_in_keypad?: boolean | undefined
3901
3926
  /** Indicates whether the device supports offline access codes. */
3902
3927
  offline_access_codes_supported?: boolean | undefined
3903
3928
  /** Indicates whether the device supports online access codes. */
@@ -4137,10 +4162,14 @@ export interface Routes {
4137
4162
  /** Indicates whether it is currently possible to use offline access codes for the device. */
4138
4163
  offline_access_codes_enabled?: boolean | undefined
4139
4164
  model: {
4165
+ /** Indicates whether the device can connect a accessory keypad. */
4166
+ can_connect_accessory_keypad?: boolean | undefined
4140
4167
  /** Display name of the device model. */
4141
4168
  display_name: string
4142
4169
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
4143
4170
  manufacturer_display_name: string
4171
+ /** Indicates whether the device has a built in accessory keypad. */
4172
+ has_built_in_keypad?: boolean | undefined
4144
4173
  /** Indicates whether the device supports offline access codes. */
4145
4174
  offline_access_codes_supported?: boolean | undefined
4146
4175
  /** Indicates whether the device supports online access codes. */
@@ -4492,15 +4521,26 @@ export interface Routes {
4492
4521
  online: boolean
4493
4522
  /** Name of the device. Deprecated - use device.display_name instead */
4494
4523
  name: string
4524
+ /** Represents the accessory keypad state. */
4525
+ accessory_keypad?:
4526
+ | {
4527
+ /** Indicates if the accessory_keypad is connected to the device. */
4528
+ is_connected: boolean
4529
+ }
4530
+ | undefined
4495
4531
  appearance: {
4496
4532
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
4497
4533
  name: string
4498
4534
  }
4499
4535
  model: {
4536
+ /** Indicates whether the device can connect a accessory keypad. */
4537
+ can_connect_accessory_keypad?: boolean | undefined
4500
4538
  /** Display name of the device model. */
4501
4539
  display_name: string
4502
4540
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
4503
4541
  manufacturer_display_name: string
4542
+ /** Indicates whether the device has a built in accessory keypad. */
4543
+ has_built_in_keypad?: boolean | undefined
4504
4544
  /** Indicates whether the device supports offline access codes. */
4505
4545
  offline_access_codes_supported?: boolean | undefined
4506
4546
  /** Indicates whether the device supports online access codes. */
@@ -5183,15 +5223,26 @@ export interface Routes {
5183
5223
  online: boolean
5184
5224
  /** Name of the device. Deprecated - use device.display_name instead */
5185
5225
  name: string
5226
+ /** Represents the accessory keypad state. */
5227
+ accessory_keypad?:
5228
+ | {
5229
+ /** Indicates if the accessory_keypad is connected to the device. */
5230
+ is_connected: boolean
5231
+ }
5232
+ | undefined
5186
5233
  appearance: {
5187
5234
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
5188
5235
  name: string
5189
5236
  }
5190
5237
  model: {
5238
+ /** Indicates whether the device can connect a accessory keypad. */
5239
+ can_connect_accessory_keypad?: boolean | undefined
5191
5240
  /** Display name of the device model. */
5192
5241
  display_name: string
5193
5242
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
5194
5243
  manufacturer_display_name: string
5244
+ /** Indicates whether the device has a built in accessory keypad. */
5245
+ has_built_in_keypad?: boolean | undefined
5195
5246
  /** Indicates whether the device supports offline access codes. */
5196
5247
  offline_access_codes_supported?: boolean | undefined
5197
5248
  /** Indicates whether the device supports online access codes. */
@@ -6010,15 +6061,26 @@ export interface Routes {
6010
6061
  online: boolean
6011
6062
  /** Name of the device. Deprecated - use device.display_name instead */
6012
6063
  name: string
6064
+ /** Represents the accessory keypad state. */
6065
+ accessory_keypad?:
6066
+ | {
6067
+ /** Indicates if the accessory_keypad is connected to the device. */
6068
+ is_connected: boolean
6069
+ }
6070
+ | undefined
6013
6071
  appearance: {
6014
6072
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
6015
6073
  name: string
6016
6074
  }
6017
6075
  model: {
6076
+ /** Indicates whether the device can connect a accessory keypad. */
6077
+ can_connect_accessory_keypad?: boolean | undefined
6018
6078
  /** Display name of the device model. */
6019
6079
  display_name: string
6020
6080
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
6021
6081
  manufacturer_display_name: string
6082
+ /** Indicates whether the device has a built in accessory keypad. */
6083
+ has_built_in_keypad?: boolean | undefined
6022
6084
  /** Indicates whether the device supports offline access codes. */
6023
6085
  offline_access_codes_supported?: boolean | undefined
6024
6086
  /** Indicates whether the device supports online access codes. */
@@ -6701,15 +6763,26 @@ export interface Routes {
6701
6763
  online: boolean
6702
6764
  /** Name of the device. Deprecated - use device.display_name instead */
6703
6765
  name: string
6766
+ /** Represents the accessory keypad state. */
6767
+ accessory_keypad?:
6768
+ | {
6769
+ /** Indicates if the accessory_keypad is connected to the device. */
6770
+ is_connected: boolean
6771
+ }
6772
+ | undefined
6704
6773
  appearance: {
6705
6774
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
6706
6775
  name: string
6707
6776
  }
6708
6777
  model: {
6778
+ /** Indicates whether the device can connect a accessory keypad. */
6779
+ can_connect_accessory_keypad?: boolean | undefined
6709
6780
  /** Display name of the device model. */
6710
6781
  display_name: string
6711
6782
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
6712
6783
  manufacturer_display_name: string
6784
+ /** Indicates whether the device has a built in accessory keypad. */
6785
+ has_built_in_keypad?: boolean | undefined
6713
6786
  /** Indicates whether the device supports offline access codes. */
6714
6787
  offline_access_codes_supported?: boolean | undefined
6715
6788
  /** Indicates whether the device supports online access codes. */
@@ -8067,15 +8140,26 @@ export interface Routes {
8067
8140
  online: boolean
8068
8141
  /** Name of the device. Deprecated - use device.display_name instead */
8069
8142
  name: string
8143
+ /** Represents the accessory keypad state. */
8144
+ accessory_keypad?:
8145
+ | {
8146
+ /** Indicates if the accessory_keypad is connected to the device. */
8147
+ is_connected: boolean
8148
+ }
8149
+ | undefined
8070
8150
  appearance: {
8071
8151
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
8072
8152
  name: string
8073
8153
  }
8074
8154
  model: {
8155
+ /** Indicates whether the device can connect a accessory keypad. */
8156
+ can_connect_accessory_keypad?: boolean | undefined
8075
8157
  /** Display name of the device model. */
8076
8158
  display_name: string
8077
8159
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
8078
8160
  manufacturer_display_name: string
8161
+ /** Indicates whether the device has a built in accessory keypad. */
8162
+ has_built_in_keypad?: boolean | undefined
8079
8163
  /** Indicates whether the device supports offline access codes. */
8080
8164
  offline_access_codes_supported?: boolean | undefined
8081
8165
  /** Indicates whether the device supports online access codes. */
@@ -8976,15 +9060,26 @@ export interface Routes {
8976
9060
  online: boolean
8977
9061
  /** Name of the device. Deprecated - use device.display_name instead */
8978
9062
  name: string
9063
+ /** Represents the accessory keypad state. */
9064
+ accessory_keypad?:
9065
+ | {
9066
+ /** Indicates if the accessory_keypad is connected to the device. */
9067
+ is_connected: boolean
9068
+ }
9069
+ | undefined
8979
9070
  appearance: {
8980
9071
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
8981
9072
  name: string
8982
9073
  }
8983
9074
  model: {
9075
+ /** Indicates whether the device can connect a accessory keypad. */
9076
+ can_connect_accessory_keypad?: boolean | undefined
8984
9077
  /** Display name of the device model. */
8985
9078
  display_name: string
8986
9079
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
8987
9080
  manufacturer_display_name: string
9081
+ /** Indicates whether the device has a built in accessory keypad. */
9082
+ has_built_in_keypad?: boolean | undefined
8988
9083
  /** Indicates whether the device supports offline access codes. */
8989
9084
  offline_access_codes_supported?: boolean | undefined
8990
9085
  /** Indicates whether the device supports online access codes. */
@@ -9959,15 +10054,26 @@ export interface Routes {
9959
10054
  online: boolean
9960
10055
  /** Name of the device. Deprecated - use device.display_name instead */
9961
10056
  name: string
10057
+ /** Represents the accessory keypad state. */
10058
+ accessory_keypad?:
10059
+ | {
10060
+ /** Indicates if the accessory_keypad is connected to the device. */
10061
+ is_connected: boolean
10062
+ }
10063
+ | undefined
9962
10064
  appearance: {
9963
10065
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
9964
10066
  name: string
9965
10067
  }
9966
10068
  model: {
10069
+ /** Indicates whether the device can connect a accessory keypad. */
10070
+ can_connect_accessory_keypad?: boolean | undefined
9967
10071
  /** Display name of the device model. */
9968
10072
  display_name: string
9969
10073
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
9970
10074
  manufacturer_display_name: string
10075
+ /** Indicates whether the device has a built in accessory keypad. */
10076
+ has_built_in_keypad?: boolean | undefined
9971
10077
  /** Indicates whether the device supports offline access codes. */
9972
10078
  offline_access_codes_supported?: boolean | undefined
9973
10079
  /** Indicates whether the device supports online access codes. */
@@ -21,6 +21,16 @@ export const common_device_properties = z.object({
21
21
  .describe(
22
22
  'Name of the device. Deprecated - use device.display_name instead',
23
23
  ),
24
+ accessory_keypad: z
25
+ .object({
26
+ is_connected: z
27
+ .boolean()
28
+ .describe(
29
+ 'Indicates if the accessory_keypad is connected to the device.',
30
+ ),
31
+ })
32
+ .optional()
33
+ .describe('Represents the accessory keypad state.'),
24
34
  appearance: z.object({
25
35
  name: z
26
36
  .string()
@@ -29,13 +39,22 @@ export const common_device_properties = z.object({
29
39
  ),
30
40
  }),
31
41
  model: z.object({
42
+ can_connect_accessory_keypad: z
43
+ .boolean()
44
+ .optional()
45
+ .describe('Indicates whether the device can connect a accessory keypad.'),
32
46
  display_name: z.string().describe('Display name of the device model.'),
33
47
  manufacturer_display_name: z
34
48
  .string()
35
49
  .describe(
36
50
  'Display name that corresponds to the manufacturer-specific terminology for the device.',
37
51
  ),
38
-
52
+ has_built_in_keypad: z
53
+ .boolean()
54
+ .optional()
55
+ .describe(
56
+ 'Indicates whether the device has a built in accessory keypad.',
57
+ ),
39
58
  offline_access_codes_supported: z
40
59
  .boolean()
41
60
  .optional()