@seamapi/types 1.530.0 → 1.532.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 (34) hide show
  1. package/dist/connect.cjs +67 -4
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +173 -5
  4. package/dist/index.cjs +67 -4
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-entrance.d.ts +13 -0
  7. package/lib/seam/connect/models/acs/acs-entrance.js +4 -1
  8. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  9. package/lib/seam/connect/models/acs/metadata/hotek.d.ts +9 -0
  10. package/lib/seam/connect/models/acs/metadata/hotek.js +7 -0
  11. package/lib/seam/connect/models/acs/metadata/hotek.js.map +1 -0
  12. package/lib/seam/connect/models/acs/metadata/index.d.ts +1 -0
  13. package/lib/seam/connect/models/acs/metadata/index.js +1 -0
  14. package/lib/seam/connect/models/acs/metadata/index.js.map +1 -1
  15. package/lib/seam/connect/models/batch.d.ts +105 -2
  16. package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
  17. package/lib/seam/connect/models/devices/device-provider.js +2 -0
  18. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  19. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +3 -1
  20. package/lib/seam/connect/models/devices/unmanaged-device.js +1 -0
  21. package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
  22. package/lib/seam/connect/models/phones/phone-session.d.ts +56 -0
  23. package/lib/seam/connect/openapi.d.ts +59 -0
  24. package/lib/seam/connect/openapi.js +56 -2
  25. package/lib/seam/connect/openapi.js.map +1 -1
  26. package/lib/seam/connect/route-types.d.ts +73 -3
  27. package/package.json +1 -1
  28. package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
  29. package/src/lib/seam/connect/models/acs/metadata/hotek.ts +11 -0
  30. package/src/lib/seam/connect/models/acs/metadata/index.ts +1 -0
  31. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -0
  32. package/src/lib/seam/connect/models/devices/unmanaged-device.ts +1 -0
  33. package/src/lib/seam/connect/openapi.ts +61 -2
  34. package/src/lib/seam/connect/route-types.ts +95 -1
@@ -11365,6 +11365,11 @@ export type Routes = {
11365
11365
  /** Indicates whether the entrance is connected. */
11366
11366
  is_connected: boolean;
11367
11367
  } | undefined;
11368
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
11369
+ hotek_metadata?: {
11370
+ /** Room number of the entrance. */
11371
+ room_number: string;
11372
+ } | undefined;
11368
11373
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
11369
11374
  visionline_metadata?: {
11370
11375
  /** Name of the door in the Visionline access system. */
@@ -14488,6 +14493,11 @@ export type Routes = {
14488
14493
  /** Indicates whether the entrance is connected. */
14489
14494
  is_connected: boolean;
14490
14495
  } | undefined;
14496
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
14497
+ hotek_metadata?: {
14498
+ /** Room number of the entrance. */
14499
+ room_number: string;
14500
+ } | undefined;
14491
14501
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
14492
14502
  visionline_metadata?: {
14493
14503
  /** Name of the door in the Visionline access system. */
@@ -17022,6 +17032,10 @@ export type Routes = {
17022
17032
  })[];
17023
17033
  /** Date and time at which the device object was created. */
17024
17034
  created_at: string;
17035
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
17036
+ custom_metadata: {
17037
+ [x: string]: string | boolean;
17038
+ };
17025
17039
  is_managed: false;
17026
17040
  /** properties of the device. */
17027
17041
  properties: {
@@ -20386,6 +20400,11 @@ export type Routes = {
20386
20400
  /** Indicates whether the entrance is connected. */
20387
20401
  is_connected: boolean;
20388
20402
  } | undefined;
20403
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
20404
+ hotek_metadata?: {
20405
+ /** Room number of the entrance. */
20406
+ room_number: string;
20407
+ } | undefined;
20389
20408
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
20390
20409
  visionline_metadata?: {
20391
20410
  /** Name of the door in the Visionline access system. */
@@ -21736,6 +21755,11 @@ export type Routes = {
21736
21755
  /** Indicates whether the entrance is connected. */
21737
21756
  is_connected: boolean;
21738
21757
  } | undefined;
21758
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
21759
+ hotek_metadata?: {
21760
+ /** Room number of the entrance. */
21761
+ room_number: string;
21762
+ } | undefined;
21739
21763
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
21740
21764
  visionline_metadata?: {
21741
21765
  /** Name of the door in the Visionline access system. */
@@ -25171,6 +25195,11 @@ export type Routes = {
25171
25195
  /** Indicates whether the entrance is connected. */
25172
25196
  is_connected: boolean;
25173
25197
  } | undefined;
25198
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
25199
+ hotek_metadata?: {
25200
+ /** Room number of the entrance. */
25201
+ room_number: string;
25202
+ } | undefined;
25174
25203
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
25175
25204
  visionline_metadata?: {
25176
25205
  /** Name of the door in the Visionline access system. */
@@ -25331,6 +25360,11 @@ export type Routes = {
25331
25360
  /** Indicates whether the entrance is connected. */
25332
25361
  is_connected: boolean;
25333
25362
  } | undefined;
25363
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
25364
+ hotek_metadata?: {
25365
+ /** Room number of the entrance. */
25366
+ room_number: string;
25367
+ } | undefined;
25334
25368
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
25335
25369
  visionline_metadata?: {
25336
25370
  /** Name of the door in the Visionline access system. */
@@ -26761,6 +26795,11 @@ export type Routes = {
26761
26795
  /** Indicates whether the entrance is connected. */
26762
26796
  is_connected: boolean;
26763
26797
  } | undefined;
26798
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
26799
+ hotek_metadata?: {
26800
+ /** Room number of the entrance. */
26801
+ room_number: string;
26802
+ } | undefined;
26764
26803
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
26765
26804
  visionline_metadata?: {
26766
26805
  /** Name of the door in the Visionline access system. */
@@ -30262,7 +30301,7 @@ export type Routes = {
30262
30301
  /** Optional unique string key that can be used to identify the customer. If provided, the customer will be created or retrieved based on this key. */
30263
30302
  customer_key?: string | undefined;
30264
30303
  /** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters. */
30265
- accepted_providers?: ('dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
30304
+ accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
30266
30305
  /** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter. */
30267
30306
  provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
30268
30307
  /** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/latest/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). */
@@ -34024,7 +34063,7 @@ export type Routes = {
34024
34063
  formData: {};
34025
34064
  jsonResponse: {
34026
34065
  device_providers: {
34027
- device_provider_name: 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance';
34066
+ device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'keynest' | 'dormakaba_ambiance';
34028
34067
  display_name: string;
34029
34068
  image_url: string;
34030
34069
  provider_categories: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems')[];
@@ -34432,6 +34471,10 @@ export type Routes = {
34432
34471
  })[];
34433
34472
  /** Date and time at which the device object was created. */
34434
34473
  created_at: string;
34474
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
34475
+ custom_metadata: {
34476
+ [x: string]: string | boolean;
34477
+ };
34435
34478
  is_managed: false;
34436
34479
  /** properties of the device. */
34437
34480
  properties: {
@@ -34871,6 +34914,10 @@ export type Routes = {
34871
34914
  })[];
34872
34915
  /** Date and time at which the device object was created. */
34873
34916
  created_at: string;
34917
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
34918
+ custom_metadata: {
34919
+ [x: string]: string | boolean;
34920
+ };
34874
34921
  is_managed: false;
34875
34922
  /** properties of the device. */
34876
34923
  properties: {
@@ -34970,7 +35017,11 @@ export type Routes = {
34970
35017
  /** ID of the unmanaged device that you want to update. */
34971
35018
  device_id: string;
34972
35019
  /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
34973
- is_managed: true;
35020
+ is_managed?: true | undefined;
35021
+ /** Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. */
35022
+ custom_metadata?: {
35023
+ [x: string]: string | boolean | null;
35024
+ } | undefined;
34974
35025
  };
34975
35026
  formData: {};
34976
35027
  jsonResponse: {};
@@ -58036,6 +58087,11 @@ export type Routes = {
58036
58087
  /** Indicates whether the entrance is connected. */
58037
58088
  is_connected: boolean;
58038
58089
  } | undefined;
58090
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
58091
+ hotek_metadata?: {
58092
+ /** Room number of the entrance. */
58093
+ room_number: string;
58094
+ } | undefined;
58039
58095
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
58040
58096
  visionline_metadata?: {
58041
58097
  /** Name of the door in the Visionline access system. */
@@ -59548,6 +59604,11 @@ export type Routes = {
59548
59604
  /** Indicates whether the entrance is connected. */
59549
59605
  is_connected: boolean;
59550
59606
  } | undefined;
59607
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
59608
+ hotek_metadata?: {
59609
+ /** Room number of the entrance. */
59610
+ room_number: string;
59611
+ } | undefined;
59551
59612
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
59552
59613
  visionline_metadata?: {
59553
59614
  /** Name of the door in the Visionline access system. */
@@ -80254,6 +80315,11 @@ export type Routes = {
80254
80315
  /** Indicates whether the entrance is connected. */
80255
80316
  is_connected: boolean;
80256
80317
  } | undefined;
80318
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
80319
+ hotek_metadata?: {
80320
+ /** Room number of the entrance. */
80321
+ room_number: string;
80322
+ } | undefined;
80257
80323
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
80258
80324
  visionline_metadata?: {
80259
80325
  /** Name of the door in the Visionline access system. */
@@ -82788,6 +82854,10 @@ export type Routes = {
82788
82854
  })[];
82789
82855
  /** Date and time at which the device object was created. */
82790
82856
  created_at: string;
82857
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
82858
+ custom_metadata: {
82859
+ [x: string]: string | boolean;
82860
+ };
82791
82861
  is_managed: false;
82792
82862
  /** properties of the device. */
82793
82863
  properties: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.530.0",
3
+ "version": "1.532.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -4,6 +4,7 @@ import { acs_entrance_dormakaba_ambiance_metadata } from './metadata/dormakaba-a
4
4
  import {
5
5
  acs_entrance_assa_abloy_vostio_metadata,
6
6
  acs_entrance_dormakaba_community_metadata,
7
+ acs_entrance_hotek_metadata,
7
8
  acs_entrance_latch_metadata,
8
9
  acs_entrance_salto_ks_metadata,
9
10
  acs_entrance_visionline_metadata,
@@ -85,6 +86,11 @@ export const acs_entrance = z
85
86
  .describe(
86
87
  'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
87
88
  ),
89
+ hotek_metadata: acs_entrance_hotek_metadata
90
+ .optional()
91
+ .describe(
92
+ 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
93
+ ),
88
94
  visionline_metadata: acs_entrance_visionline_metadata
89
95
  .optional()
90
96
  .describe(
@@ -0,0 +1,11 @@
1
+ import { z } from 'zod'
2
+
3
+ export const acs_entrance_hotek_metadata = z
4
+ .object({
5
+ room_number: z.string().describe('Room number of the entrance.'),
6
+ })
7
+ .describe('Hotek-specific metadata associated with the entrance.')
8
+
9
+ export type AcsEntranceHotekMetadata = z.infer<
10
+ typeof acs_entrance_hotek_metadata
11
+ >
@@ -1,6 +1,7 @@
1
1
  export * from './assa-abloy-vostio.js'
2
2
  export * from './dormakaba-ambiance.js'
3
3
  export * from './dormakaba-community.js'
4
+ export * from './hotek.js'
4
5
  export * from './latch.js'
5
6
  export * from './salto.js'
6
7
  export * from './visionline.js'
@@ -4,6 +4,7 @@ import type { ProviderCapability } from '../provider-capability.js'
4
4
  import { device_capability_flags } from './device.js'
5
5
 
6
6
  export const DEVICE_PROVIDERS = {
7
+ HOTEK: 'hotek',
7
8
  DORMAKABA_COMMUNITY: 'dormakaba_community',
8
9
  LEGIC_CONNECT: 'legic_connect',
9
10
  AKUVOX: 'akuvox',
@@ -122,6 +123,7 @@ export const PROVIDER_CATEGORY_MAP = {
122
123
  'dormakaba_ambiance',
123
124
  'dormakaba_community',
124
125
  'legic_connect',
126
+ 'hotek',
125
127
  ],
126
128
 
127
129
  internal_beta: ALL_DEVICE_PROVIDERS,
@@ -17,6 +17,7 @@ export const unmanaged_device = device
17
17
  errors: true,
18
18
  warnings: true,
19
19
  created_at: true,
20
+ custom_metadata: true,
20
21
  })
21
22
  .extend({
22
23
  is_managed: z.literal(false),
@@ -2851,6 +2851,18 @@ export default {
2851
2851
  },
2852
2852
  type: 'array',
2853
2853
  },
2854
+ hotek_metadata: {
2855
+ description:
2856
+ 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
2857
+ properties: {
2858
+ room_number: {
2859
+ description: 'Room number of the entrance.',
2860
+ type: 'string',
2861
+ },
2862
+ },
2863
+ required: ['room_number'],
2864
+ type: 'object',
2865
+ },
2854
2866
  latch_metadata: {
2855
2867
  description:
2856
2868
  'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -12932,6 +12944,7 @@ export default {
12932
12944
  can_unlock_with_code: { type: 'boolean' },
12933
12945
  device_provider_name: {
12934
12946
  enum: [
12947
+ 'hotek',
12935
12948
  'dormakaba_community',
12936
12949
  'legic_connect',
12937
12950
  'akuvox',
@@ -19572,6 +19585,18 @@ export default {
19572
19585
  },
19573
19586
  type: 'array',
19574
19587
  },
19588
+ hotek_metadata: {
19589
+ description:
19590
+ 'Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
19591
+ properties: {
19592
+ room_number: {
19593
+ description: 'Room number of the entrance.',
19594
+ type: 'string',
19595
+ },
19596
+ },
19597
+ required: ['room_number'],
19598
+ type: 'object',
19599
+ },
19575
19600
  latch_metadata: {
19576
19601
  description:
19577
19602
  'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -23704,6 +23729,14 @@ export default {
23704
23729
  format: 'date-time',
23705
23730
  type: 'string',
23706
23731
  },
23732
+ custom_metadata: {
23733
+ additionalProperties: {
23734
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
23735
+ },
23736
+ description:
23737
+ 'Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.',
23738
+ type: 'object',
23739
+ },
23707
23740
  device_id: {
23708
23741
  description: 'ID of the device.',
23709
23742
  format: 'uuid',
@@ -25022,6 +25055,7 @@ export default {
25022
25055
  'errors',
25023
25056
  'warnings',
25024
25057
  'created_at',
25058
+ 'custom_metadata',
25025
25059
  'is_managed',
25026
25060
  'properties',
25027
25061
  ],
@@ -37217,6 +37251,7 @@ export default {
37217
37251
  'Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters.',
37218
37252
  items: {
37219
37253
  enum: [
37254
+ 'hotek',
37220
37255
  'dormakaba_community',
37221
37256
  'legic_connect',
37222
37257
  'akuvox',
@@ -42545,6 +42580,18 @@ export default {
42545
42580
  'application/json': {
42546
42581
  schema: {
42547
42582
  properties: {
42583
+ custom_metadata: {
42584
+ additionalProperties: {
42585
+ nullable: true,
42586
+ oneOf: [
42587
+ { maxLength: 500, type: 'string' },
42588
+ { type: 'boolean' },
42589
+ ],
42590
+ },
42591
+ description:
42592
+ 'Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.',
42593
+ type: 'object',
42594
+ },
42548
42595
  device_id: {
42549
42596
  description:
42550
42597
  'ID of the unmanaged device that you want to update.',
@@ -42558,7 +42605,7 @@ export default {
42558
42605
  type: 'boolean',
42559
42606
  },
42560
42607
  },
42561
- required: ['device_id', 'is_managed'],
42608
+ required: ['device_id'],
42562
42609
  type: 'object',
42563
42610
  },
42564
42611
  },
@@ -42601,6 +42648,18 @@ export default {
42601
42648
  'application/json': {
42602
42649
  schema: {
42603
42650
  properties: {
42651
+ custom_metadata: {
42652
+ additionalProperties: {
42653
+ nullable: true,
42654
+ oneOf: [
42655
+ { maxLength: 500, type: 'string' },
42656
+ { type: 'boolean' },
42657
+ ],
42658
+ },
42659
+ description:
42660
+ 'Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.',
42661
+ type: 'object',
42662
+ },
42604
42663
  device_id: {
42605
42664
  description:
42606
42665
  'ID of the unmanaged device that you want to update.',
@@ -42614,7 +42673,7 @@ export default {
42614
42673
  type: 'boolean',
42615
42674
  },
42616
42675
  },
42617
- required: ['device_id', 'is_managed'],
42676
+ required: ['device_id'],
42618
42677
  type: 'object',
42619
42678
  },
42620
42679
  },
@@ -12953,6 +12953,13 @@ export type Routes = {
12953
12953
  is_connected: boolean
12954
12954
  }
12955
12955
  | undefined
12956
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
12957
+ hotek_metadata?:
12958
+ | {
12959
+ /** Room number of the entrance. */
12960
+ room_number: string
12961
+ }
12962
+ | undefined
12956
12963
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
12957
12964
  visionline_metadata?:
12958
12965
  | {
@@ -16711,6 +16718,13 @@ export type Routes = {
16711
16718
  is_connected: boolean
16712
16719
  }
16713
16720
  | undefined
16721
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
16722
+ hotek_metadata?:
16723
+ | {
16724
+ /** Room number of the entrance. */
16725
+ room_number: string
16726
+ }
16727
+ | undefined
16714
16728
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
16715
16729
  visionline_metadata?:
16716
16730
  | {
@@ -19785,6 +19799,10 @@ export type Routes = {
19785
19799
  )[]
19786
19800
  /** Date and time at which the device object was created. */
19787
19801
  created_at: string
19802
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
19803
+ custom_metadata: {
19804
+ [x: string]: string | boolean
19805
+ }
19788
19806
  is_managed: false
19789
19807
  /** properties of the device. */
19790
19808
  properties: {
@@ -23665,6 +23683,13 @@ export type Routes = {
23665
23683
  is_connected: boolean
23666
23684
  }
23667
23685
  | undefined
23686
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
23687
+ hotek_metadata?:
23688
+ | {
23689
+ /** Room number of the entrance. */
23690
+ room_number: string
23691
+ }
23692
+ | undefined
23668
23693
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
23669
23694
  visionline_metadata?:
23670
23695
  | {
@@ -25250,6 +25275,13 @@ export type Routes = {
25250
25275
  is_connected: boolean
25251
25276
  }
25252
25277
  | undefined
25278
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
25279
+ hotek_metadata?:
25280
+ | {
25281
+ /** Room number of the entrance. */
25282
+ room_number: string
25283
+ }
25284
+ | undefined
25253
25285
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
25254
25286
  visionline_metadata?:
25255
25287
  | {
@@ -29205,6 +29237,13 @@ export type Routes = {
29205
29237
  is_connected: boolean
29206
29238
  }
29207
29239
  | undefined
29240
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
29241
+ hotek_metadata?:
29242
+ | {
29243
+ /** Room number of the entrance. */
29244
+ room_number: string
29245
+ }
29246
+ | undefined
29208
29247
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
29209
29248
  visionline_metadata?:
29210
29249
  | {
@@ -29390,6 +29429,13 @@ export type Routes = {
29390
29429
  is_connected: boolean
29391
29430
  }
29392
29431
  | undefined
29432
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
29433
+ hotek_metadata?:
29434
+ | {
29435
+ /** Room number of the entrance. */
29436
+ room_number: string
29437
+ }
29438
+ | undefined
29393
29439
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
29394
29440
  visionline_metadata?:
29395
29441
  | {
@@ -31114,6 +31160,13 @@ export type Routes = {
31114
31160
  is_connected: boolean
31115
31161
  }
31116
31162
  | undefined
31163
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
31164
+ hotek_metadata?:
31165
+ | {
31166
+ /** Room number of the entrance. */
31167
+ room_number: string
31168
+ }
31169
+ | undefined
31117
31170
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
31118
31171
  visionline_metadata?:
31119
31172
  | {
@@ -35079,6 +35132,7 @@ export type Routes = {
35079
35132
  /** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters. */
35080
35133
  accepted_providers?:
35081
35134
  | (
35135
+ | 'hotek'
35082
35136
  | 'dormakaba_community'
35083
35137
  | 'legic_connect'
35084
35138
  | 'akuvox'
@@ -39831,6 +39885,7 @@ export type Routes = {
39831
39885
  jsonResponse: {
39832
39886
  device_providers: {
39833
39887
  device_provider_name:
39888
+ | 'hotek'
39834
39889
  | 'dormakaba_community'
39835
39890
  | 'legic_connect'
39836
39891
  | 'akuvox'
@@ -40373,6 +40428,10 @@ export type Routes = {
40373
40428
  )[]
40374
40429
  /** Date and time at which the device object was created. */
40375
40430
  created_at: string
40431
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
40432
+ custom_metadata: {
40433
+ [x: string]: string | boolean
40434
+ }
40376
40435
  is_managed: false
40377
40436
  /** properties of the device. */
40378
40437
  properties: {
@@ -41066,6 +41125,10 @@ export type Routes = {
41066
41125
  )[]
41067
41126
  /** Date and time at which the device object was created. */
41068
41127
  created_at: string
41128
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
41129
+ custom_metadata: {
41130
+ [x: string]: string | boolean
41131
+ }
41069
41132
  is_managed: false
41070
41133
  /** properties of the device. */
41071
41134
  properties: {
@@ -41171,7 +41234,13 @@ export type Routes = {
41171
41234
  /** ID of the unmanaged device that you want to update. */
41172
41235
  device_id: string
41173
41236
  /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
41174
- is_managed: true
41237
+ is_managed?: true | undefined
41238
+ /** Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. */
41239
+ custom_metadata?:
41240
+ | {
41241
+ [x: string]: string | boolean | null
41242
+ }
41243
+ | undefined
41175
41244
  }
41176
41245
  formData: {}
41177
41246
  jsonResponse: {}
@@ -69047,6 +69116,13 @@ export type Routes = {
69047
69116
  is_connected: boolean
69048
69117
  }
69049
69118
  | undefined
69119
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
69120
+ hotek_metadata?:
69121
+ | {
69122
+ /** Room number of the entrance. */
69123
+ room_number: string
69124
+ }
69125
+ | undefined
69050
69126
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
69051
69127
  visionline_metadata?:
69052
69128
  | {
@@ -70932,6 +71008,13 @@ export type Routes = {
70932
71008
  is_connected: boolean
70933
71009
  }
70934
71010
  | undefined
71011
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
71012
+ hotek_metadata?:
71013
+ | {
71014
+ /** Room number of the entrance. */
71015
+ room_number: string
71016
+ }
71017
+ | undefined
70935
71018
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
70936
71019
  visionline_metadata?:
70937
71020
  | {
@@ -95454,6 +95537,13 @@ export type Routes = {
95454
95537
  is_connected: boolean
95455
95538
  }
95456
95539
  | undefined
95540
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
95541
+ hotek_metadata?:
95542
+ | {
95543
+ /** Room number of the entrance. */
95544
+ room_number: string
95545
+ }
95546
+ | undefined
95457
95547
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
95458
95548
  visionline_metadata?:
95459
95549
  | {
@@ -98528,6 +98618,10 @@ export type Routes = {
98528
98618
  )[]
98529
98619
  /** Date and time at which the device object was created. */
98530
98620
  created_at: string
98621
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
98622
+ custom_metadata: {
98623
+ [x: string]: string | boolean
98624
+ }
98531
98625
  is_managed: false
98532
98626
  /** properties of the device. */
98533
98627
  properties: {