@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
@@ -4566,6 +4566,13 @@ declare const acs_entrance: z.ZodObject<{
4566
4566
  door_type: string;
4567
4567
  accessibility_type: string;
4568
4568
  }>>;
4569
+ hotek_metadata: z.ZodOptional<z.ZodObject<{
4570
+ room_number: z.ZodString;
4571
+ }, "strip", z.ZodTypeAny, {
4572
+ room_number: string;
4573
+ }, {
4574
+ room_number: string;
4575
+ }>>;
4569
4576
  visionline_metadata: z.ZodOptional<z.ZodObject<{
4570
4577
  door_name: z.ZodString;
4571
4578
  door_category: z.ZodEnum<["entrance", "guest", "elevator reader", "common", "common (PMS)"]>;
@@ -4725,6 +4732,9 @@ declare const acs_entrance: z.ZodObject<{
4725
4732
  door_type: string;
4726
4733
  accessibility_type: string;
4727
4734
  } | undefined;
4735
+ hotek_metadata?: {
4736
+ room_number: string;
4737
+ } | undefined;
4728
4738
  dormakaba_community_metadata?: {
4729
4739
  access_point_name: string;
4730
4740
  } | undefined;
@@ -4783,6 +4793,9 @@ declare const acs_entrance: z.ZodObject<{
4783
4793
  door_type: string;
4784
4794
  accessibility_type: string;
4785
4795
  } | undefined;
4796
+ hotek_metadata?: {
4797
+ room_number: string;
4798
+ } | undefined;
4786
4799
  dormakaba_community_metadata?: {
4787
4800
  access_point_name: string;
4788
4801
  } | undefined;
@@ -14443,6 +14456,13 @@ declare const batch: z.ZodObject<{
14443
14456
  door_type: string;
14444
14457
  accessibility_type: string;
14445
14458
  }>>;
14459
+ hotek_metadata: z.ZodOptional<z.ZodObject<{
14460
+ room_number: z.ZodString;
14461
+ }, "strip", z.ZodTypeAny, {
14462
+ room_number: string;
14463
+ }, {
14464
+ room_number: string;
14465
+ }>>;
14446
14466
  visionline_metadata: z.ZodOptional<z.ZodObject<{
14447
14467
  door_name: z.ZodString;
14448
14468
  door_category: z.ZodEnum<["entrance", "guest", "elevator reader", "common", "common (PMS)"]>;
@@ -14602,6 +14622,9 @@ declare const batch: z.ZodObject<{
14602
14622
  door_type: string;
14603
14623
  accessibility_type: string;
14604
14624
  } | undefined;
14625
+ hotek_metadata?: {
14626
+ room_number: string;
14627
+ } | undefined;
14605
14628
  dormakaba_community_metadata?: {
14606
14629
  access_point_name: string;
14607
14630
  } | undefined;
@@ -14660,6 +14683,9 @@ declare const batch: z.ZodObject<{
14660
14683
  door_type: string;
14661
14684
  accessibility_type: string;
14662
14685
  } | undefined;
14686
+ hotek_metadata?: {
14687
+ room_number: string;
14688
+ } | undefined;
14663
14689
  dormakaba_community_metadata?: {
14664
14690
  access_point_name: string;
14665
14691
  } | undefined;
@@ -23592,7 +23618,7 @@ declare const batch: z.ZodObject<{
23592
23618
  can_simulate_hub_connection: z.ZodOptional<z.ZodBoolean>;
23593
23619
  can_simulate_hub_disconnection: z.ZodOptional<z.ZodBoolean>;
23594
23620
  can_simulate_paid_subscription: z.ZodOptional<z.ZodBoolean>;
23595
- }, "device_id" | "workspace_id" | "created_at" | "errors" | "connected_account_id" | "warnings" | "device_type" | "capabilities_supported" | "location"> & {
23621
+ }, "device_id" | "workspace_id" | "created_at" | "errors" | "connected_account_id" | "warnings" | "custom_metadata" | "device_type" | "capabilities_supported" | "location"> & {
23596
23622
  is_managed: z.ZodLiteral<false>;
23597
23623
  properties: z.ZodObject<Pick<{
23598
23624
  online: z.ZodBoolean;
@@ -23924,6 +23950,7 @@ declare const batch: z.ZodObject<{
23924
23950
  created_at: string;
23925
23951
  warning_code: "unknown_issue_with_phone";
23926
23952
  })[];
23953
+ custom_metadata: Record<string, string | boolean>;
23927
23954
  device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
23928
23955
  capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
23929
23956
  properties: {
@@ -24155,6 +24182,7 @@ declare const batch: z.ZodObject<{
24155
24182
  created_at: string;
24156
24183
  warning_code: "unknown_issue_with_phone";
24157
24184
  })[];
24185
+ custom_metadata: Record<string, string | boolean>;
24158
24186
  device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
24159
24187
  capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
24160
24188
  properties: {
@@ -31273,6 +31301,9 @@ declare const batch: z.ZodObject<{
31273
31301
  door_type: string;
31274
31302
  accessibility_type: string;
31275
31303
  } | undefined;
31304
+ hotek_metadata?: {
31305
+ room_number: string;
31306
+ } | undefined;
31276
31307
  dormakaba_community_metadata?: {
31277
31308
  access_point_name: string;
31278
31309
  } | undefined;
@@ -32790,6 +32821,7 @@ declare const batch: z.ZodObject<{
32790
32821
  created_at: string;
32791
32822
  warning_code: "unknown_issue_with_phone";
32792
32823
  })[];
32824
+ custom_metadata: Record<string, string | boolean>;
32793
32825
  device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
32794
32826
  capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
32795
32827
  properties: {
@@ -35125,6 +35157,9 @@ declare const batch: z.ZodObject<{
35125
35157
  door_type: string;
35126
35158
  accessibility_type: string;
35127
35159
  } | undefined;
35160
+ hotek_metadata?: {
35161
+ room_number: string;
35162
+ } | undefined;
35128
35163
  dormakaba_community_metadata?: {
35129
35164
  access_point_name: string;
35130
35165
  } | undefined;
@@ -36642,6 +36677,7 @@ declare const batch: z.ZodObject<{
36642
36677
  created_at: string;
36643
36678
  warning_code: "unknown_issue_with_phone";
36644
36679
  })[];
36680
+ custom_metadata: Record<string, string | boolean>;
36645
36681
  device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
36646
36682
  capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
36647
36683
  properties: {
@@ -43635,6 +43671,7 @@ declare const device: z.ZodObject<{
43635
43671
  type Device = z.infer<typeof device>;
43636
43672
 
43637
43673
  declare const DEVICE_PROVIDERS: {
43674
+ readonly HOTEK: "hotek";
43638
43675
  readonly DORMAKABA_COMMUNITY: "dormakaba_community";
43639
43676
  readonly LEGIC_CONNECT: "legic_connect";
43640
43677
  readonly AKUVOX: "akuvox";
@@ -46506,7 +46543,7 @@ declare const unmanaged_device: z.ZodObject<Pick<{
46506
46543
  can_simulate_hub_connection: z.ZodOptional<z.ZodBoolean>;
46507
46544
  can_simulate_hub_disconnection: z.ZodOptional<z.ZodBoolean>;
46508
46545
  can_simulate_paid_subscription: z.ZodOptional<z.ZodBoolean>;
46509
- }, "device_id" | "workspace_id" | "created_at" | "errors" | "connected_account_id" | "warnings" | "device_type" | "capabilities_supported" | "location"> & {
46546
+ }, "device_id" | "workspace_id" | "created_at" | "errors" | "connected_account_id" | "warnings" | "custom_metadata" | "device_type" | "capabilities_supported" | "location"> & {
46510
46547
  is_managed: z.ZodLiteral<false>;
46511
46548
  properties: z.ZodObject<Pick<{
46512
46549
  online: z.ZodBoolean;
@@ -46838,6 +46875,7 @@ declare const unmanaged_device: z.ZodObject<Pick<{
46838
46875
  created_at: string;
46839
46876
  warning_code: "unknown_issue_with_phone";
46840
46877
  })[];
46878
+ custom_metadata: Record<string, string | boolean>;
46841
46879
  device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
46842
46880
  capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
46843
46881
  properties: {
@@ -47069,6 +47107,7 @@ declare const unmanaged_device: z.ZodObject<Pick<{
47069
47107
  created_at: string;
47070
47108
  warning_code: "unknown_issue_with_phone";
47071
47109
  })[];
47110
+ custom_metadata: Record<string, string | boolean>;
47072
47111
  device_type: ("akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "akiles_lock") | ("noiseaware_activity_zone" | "minut_sensor") | ("ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "tado_thermostat" | "sensi_thermostat" | "smartthings_thermostat") | ("ios_phone" | "android_phone");
47073
47112
  capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
47074
47113
  properties: {
@@ -51793,6 +51832,17 @@ declare const _default: {
51793
51832
  };
51794
51833
  type: string;
51795
51834
  };
51835
+ hotek_metadata: {
51836
+ description: string;
51837
+ properties: {
51838
+ room_number: {
51839
+ description: string;
51840
+ type: string;
51841
+ };
51842
+ };
51843
+ required: string[];
51844
+ type: string;
51845
+ };
51796
51846
  latch_metadata: {
51797
51847
  description: string;
51798
51848
  properties: {
@@ -61607,6 +61657,17 @@ declare const _default: {
61607
61657
  };
61608
61658
  type: string;
61609
61659
  };
61660
+ hotek_metadata: {
61661
+ description: string;
61662
+ properties: {
61663
+ room_number: {
61664
+ description: string;
61665
+ type: string;
61666
+ };
61667
+ };
61668
+ required: string[];
61669
+ type: string;
61670
+ };
61610
61671
  latch_metadata: {
61611
61672
  description: string;
61612
61673
  properties: {
@@ -63549,6 +63610,15 @@ declare const _default: {
63549
63610
  format: string;
63550
63611
  type: string;
63551
63612
  };
63613
+ custom_metadata: {
63614
+ additionalProperties: {
63615
+ oneOf: {
63616
+ type: string;
63617
+ }[];
63618
+ };
63619
+ description: string;
63620
+ type: string;
63621
+ };
63552
63622
  device_id: {
63553
63623
  description: string;
63554
63624
  format: string;
@@ -83403,6 +83473,20 @@ declare const _default: {
83403
83473
  'application/json': {
83404
83474
  schema: {
83405
83475
  properties: {
83476
+ custom_metadata: {
83477
+ additionalProperties: {
83478
+ nullable: boolean;
83479
+ oneOf: ({
83480
+ maxLength: number;
83481
+ type: string;
83482
+ } | {
83483
+ type: string;
83484
+ maxLength?: never;
83485
+ })[];
83486
+ };
83487
+ description: string;
83488
+ type: string;
83489
+ };
83406
83490
  device_id: {
83407
83491
  description: string;
83408
83492
  format: string;
@@ -83472,6 +83556,20 @@ declare const _default: {
83472
83556
  'application/json': {
83473
83557
  schema: {
83474
83558
  properties: {
83559
+ custom_metadata: {
83560
+ additionalProperties: {
83561
+ nullable: boolean;
83562
+ oneOf: ({
83563
+ maxLength: number;
83564
+ type: string;
83565
+ } | {
83566
+ type: string;
83567
+ maxLength?: never;
83568
+ })[];
83569
+ };
83570
+ description: string;
83571
+ type: string;
83572
+ };
83475
83573
  device_id: {
83476
83574
  description: string;
83477
83575
  format: string;
@@ -112686,6 +112784,11 @@ type Routes = {
112686
112784
  /** Indicates whether the entrance is connected. */
112687
112785
  is_connected: boolean;
112688
112786
  } | undefined;
112787
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
112788
+ hotek_metadata?: {
112789
+ /** Room number of the entrance. */
112790
+ room_number: string;
112791
+ } | undefined;
112689
112792
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
112690
112793
  visionline_metadata?: {
112691
112794
  /** Name of the door in the Visionline access system. */
@@ -115809,6 +115912,11 @@ type Routes = {
115809
115912
  /** Indicates whether the entrance is connected. */
115810
115913
  is_connected: boolean;
115811
115914
  } | undefined;
115915
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
115916
+ hotek_metadata?: {
115917
+ /** Room number of the entrance. */
115918
+ room_number: string;
115919
+ } | undefined;
115812
115920
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
115813
115921
  visionline_metadata?: {
115814
115922
  /** Name of the door in the Visionline access system. */
@@ -118343,6 +118451,10 @@ type Routes = {
118343
118451
  })[];
118344
118452
  /** Date and time at which the device object was created. */
118345
118453
  created_at: string;
118454
+ /** 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. */
118455
+ custom_metadata: {
118456
+ [x: string]: string | boolean;
118457
+ };
118346
118458
  is_managed: false;
118347
118459
  /** properties of the device. */
118348
118460
  properties: {
@@ -121707,6 +121819,11 @@ type Routes = {
121707
121819
  /** Indicates whether the entrance is connected. */
121708
121820
  is_connected: boolean;
121709
121821
  } | undefined;
121822
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
121823
+ hotek_metadata?: {
121824
+ /** Room number of the entrance. */
121825
+ room_number: string;
121826
+ } | undefined;
121710
121827
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
121711
121828
  visionline_metadata?: {
121712
121829
  /** Name of the door in the Visionline access system. */
@@ -123057,6 +123174,11 @@ type Routes = {
123057
123174
  /** Indicates whether the entrance is connected. */
123058
123175
  is_connected: boolean;
123059
123176
  } | undefined;
123177
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
123178
+ hotek_metadata?: {
123179
+ /** Room number of the entrance. */
123180
+ room_number: string;
123181
+ } | undefined;
123060
123182
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
123061
123183
  visionline_metadata?: {
123062
123184
  /** Name of the door in the Visionline access system. */
@@ -126492,6 +126614,11 @@ type Routes = {
126492
126614
  /** Indicates whether the entrance is connected. */
126493
126615
  is_connected: boolean;
126494
126616
  } | undefined;
126617
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
126618
+ hotek_metadata?: {
126619
+ /** Room number of the entrance. */
126620
+ room_number: string;
126621
+ } | undefined;
126495
126622
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
126496
126623
  visionline_metadata?: {
126497
126624
  /** Name of the door in the Visionline access system. */
@@ -126652,6 +126779,11 @@ type Routes = {
126652
126779
  /** Indicates whether the entrance is connected. */
126653
126780
  is_connected: boolean;
126654
126781
  } | undefined;
126782
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
126783
+ hotek_metadata?: {
126784
+ /** Room number of the entrance. */
126785
+ room_number: string;
126786
+ } | undefined;
126655
126787
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
126656
126788
  visionline_metadata?: {
126657
126789
  /** Name of the door in the Visionline access system. */
@@ -128082,6 +128214,11 @@ type Routes = {
128082
128214
  /** Indicates whether the entrance is connected. */
128083
128215
  is_connected: boolean;
128084
128216
  } | undefined;
128217
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
128218
+ hotek_metadata?: {
128219
+ /** Room number of the entrance. */
128220
+ room_number: string;
128221
+ } | undefined;
128085
128222
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
128086
128223
  visionline_metadata?: {
128087
128224
  /** Name of the door in the Visionline access system. */
@@ -131583,7 +131720,7 @@ type Routes = {
131583
131720
  /** 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. */
131584
131721
  customer_key?: string | undefined;
131585
131722
  /** 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. */
131586
- 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;
131723
+ 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;
131587
131724
  /** 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. */
131588
131725
  provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
131589
131726
  /** 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). */
@@ -135345,7 +135482,7 @@ type Routes = {
135345
135482
  formData: {};
135346
135483
  jsonResponse: {
135347
135484
  device_providers: {
135348
- 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';
135485
+ 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';
135349
135486
  display_name: string;
135350
135487
  image_url: string;
135351
135488
  provider_categories: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems')[];
@@ -135753,6 +135890,10 @@ type Routes = {
135753
135890
  })[];
135754
135891
  /** Date and time at which the device object was created. */
135755
135892
  created_at: string;
135893
+ /** 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. */
135894
+ custom_metadata: {
135895
+ [x: string]: string | boolean;
135896
+ };
135756
135897
  is_managed: false;
135757
135898
  /** properties of the device. */
135758
135899
  properties: {
@@ -136192,6 +136333,10 @@ type Routes = {
136192
136333
  })[];
136193
136334
  /** Date and time at which the device object was created. */
136194
136335
  created_at: string;
136336
+ /** 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. */
136337
+ custom_metadata: {
136338
+ [x: string]: string | boolean;
136339
+ };
136195
136340
  is_managed: false;
136196
136341
  /** properties of the device. */
136197
136342
  properties: {
@@ -136291,7 +136436,11 @@ type Routes = {
136291
136436
  /** ID of the unmanaged device that you want to update. */
136292
136437
  device_id: string;
136293
136438
  /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
136294
- is_managed: true;
136439
+ is_managed?: true | undefined;
136440
+ /** Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. */
136441
+ custom_metadata?: {
136442
+ [x: string]: string | boolean | null;
136443
+ } | undefined;
136295
136444
  };
136296
136445
  formData: {};
136297
136446
  jsonResponse: {};
@@ -159357,6 +159506,11 @@ type Routes = {
159357
159506
  /** Indicates whether the entrance is connected. */
159358
159507
  is_connected: boolean;
159359
159508
  } | undefined;
159509
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
159510
+ hotek_metadata?: {
159511
+ /** Room number of the entrance. */
159512
+ room_number: string;
159513
+ } | undefined;
159360
159514
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
159361
159515
  visionline_metadata?: {
159362
159516
  /** Name of the door in the Visionline access system. */
@@ -160869,6 +161023,11 @@ type Routes = {
160869
161023
  /** Indicates whether the entrance is connected. */
160870
161024
  is_connected: boolean;
160871
161025
  } | undefined;
161026
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
161027
+ hotek_metadata?: {
161028
+ /** Room number of the entrance. */
161029
+ room_number: string;
161030
+ } | undefined;
160872
161031
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
160873
161032
  visionline_metadata?: {
160874
161033
  /** Name of the door in the Visionline access system. */
@@ -181575,6 +181734,11 @@ type Routes = {
181575
181734
  /** Indicates whether the entrance is connected. */
181576
181735
  is_connected: boolean;
181577
181736
  } | undefined;
181737
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
181738
+ hotek_metadata?: {
181739
+ /** Room number of the entrance. */
181740
+ room_number: string;
181741
+ } | undefined;
181578
181742
  /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
181579
181743
  visionline_metadata?: {
181580
181744
  /** Name of the door in the Visionline access system. */
@@ -184109,6 +184273,10 @@ type Routes = {
184109
184273
  })[];
184110
184274
  /** Date and time at which the device object was created. */
184111
184275
  created_at: string;
184276
+ /** 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. */
184277
+ custom_metadata: {
184278
+ [x: string]: string | boolean;
184279
+ };
184112
184280
  is_managed: false;
184113
184281
  /** properties of the device. */
184114
184282
  properties: {
package/dist/index.cjs CHANGED
@@ -1711,6 +1711,7 @@ var device = zod.z.object({
1711
1711
  Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam.
1712
1712
  `);
1713
1713
  var DEVICE_PROVIDERS = {
1714
+ HOTEK: "hotek",
1714
1715
  DORMAKABA_COMMUNITY: "dormakaba_community",
1715
1716
  LEGIC_CONNECT: "legic_connect",
1716
1717
  AKUVOX: "akuvox",
@@ -1816,7 +1817,8 @@ var PROVIDER_CATEGORY_MAP = {
1816
1817
  "salto_space",
1817
1818
  "dormakaba_ambiance",
1818
1819
  "dormakaba_community",
1819
- "legic_connect"
1820
+ "legic_connect",
1821
+ "hotek"
1820
1822
  ],
1821
1823
  internal_beta: ALL_DEVICE_PROVIDERS
1822
1824
  };
@@ -1841,7 +1843,8 @@ var unmanaged_device = device.pick({
1841
1843
  workspace_id: true,
1842
1844
  errors: true,
1843
1845
  warnings: true,
1844
- created_at: true
1846
+ created_at: true,
1847
+ custom_metadata: true
1845
1848
  }).extend({
1846
1849
  is_managed: zod.z.literal(false),
1847
1850
  properties: common_device_properties.pick({
@@ -2461,6 +2464,9 @@ var acs_entrance_dormakaba_community_metadata = zod.z.object({
2461
2464
  }).describe(
2462
2465
  "dormakaba Community-specific metadata associated with the entrance."
2463
2466
  );
2467
+ var acs_entrance_hotek_metadata = zod.z.object({
2468
+ room_number: zod.z.string().describe("Room number of the entrance.")
2469
+ }).describe("Hotek-specific metadata associated with the entrance.");
2464
2470
  var acs_entrance_latch_metadata = zod.z.object({
2465
2471
  accessibility_type: zod.z.string().describe("Accessibility type in the Latch access system."),
2466
2472
  door_name: zod.z.string().describe("Name of the door in the Latch access system."),
@@ -2855,6 +2861,9 @@ var acs_entrance = zod.z.object({
2855
2861
  latch_metadata: acs_entrance_latch_metadata.optional().describe(
2856
2862
  "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
2857
2863
  ),
2864
+ hotek_metadata: acs_entrance_hotek_metadata.optional().describe(
2865
+ "Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
2866
+ ),
2858
2867
  visionline_metadata: acs_entrance_visionline_metadata.optional().describe(
2859
2868
  "Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
2860
2869
  ),
@@ -8040,6 +8049,17 @@ var openapi_default = {
8040
8049
  },
8041
8050
  type: "array"
8042
8051
  },
8052
+ hotek_metadata: {
8053
+ description: "Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
8054
+ properties: {
8055
+ room_number: {
8056
+ description: "Room number of the entrance.",
8057
+ type: "string"
8058
+ }
8059
+ },
8060
+ required: ["room_number"],
8061
+ type: "object"
8062
+ },
8043
8063
  latch_metadata: {
8044
8064
  description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
8045
8065
  properties: {
@@ -17008,6 +17028,7 @@ var openapi_default = {
17008
17028
  can_unlock_with_code: { type: "boolean" },
17009
17029
  device_provider_name: {
17010
17030
  enum: [
17031
+ "hotek",
17011
17032
  "dormakaba_community",
17012
17033
  "legic_connect",
17013
17034
  "akuvox",
@@ -23178,6 +23199,17 @@ var openapi_default = {
23178
23199
  },
23179
23200
  type: "array"
23180
23201
  },
23202
+ hotek_metadata: {
23203
+ description: "Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
23204
+ properties: {
23205
+ room_number: {
23206
+ description: "Room number of the entrance.",
23207
+ type: "string"
23208
+ }
23209
+ },
23210
+ required: ["room_number"],
23211
+ type: "object"
23212
+ },
23181
23213
  latch_metadata: {
23182
23214
  description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
23183
23215
  properties: {
@@ -26787,6 +26819,13 @@ var openapi_default = {
26787
26819
  format: "date-time",
26788
26820
  type: "string"
26789
26821
  },
26822
+ custom_metadata: {
26823
+ additionalProperties: {
26824
+ oneOf: [{ type: "string" }, { type: "boolean" }]
26825
+ },
26826
+ description: "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.",
26827
+ type: "object"
26828
+ },
26790
26829
  device_id: {
26791
26830
  description: "ID of the device.",
26792
26831
  format: "uuid",
@@ -27942,6 +27981,7 @@ var openapi_default = {
27942
27981
  "errors",
27943
27982
  "warnings",
27944
27983
  "created_at",
27984
+ "custom_metadata",
27945
27985
  "is_managed",
27946
27986
  "properties"
27947
27987
  ],
@@ -39452,6 +39492,7 @@ var openapi_default = {
39452
39492
  description: "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.",
39453
39493
  items: {
39454
39494
  enum: [
39495
+ "hotek",
39455
39496
  "dormakaba_community",
39456
39497
  "legic_connect",
39457
39498
  "akuvox",
@@ -44432,6 +44473,17 @@ var openapi_default = {
44432
44473
  "application/json": {
44433
44474
  schema: {
44434
44475
  properties: {
44476
+ custom_metadata: {
44477
+ additionalProperties: {
44478
+ nullable: true,
44479
+ oneOf: [
44480
+ { maxLength: 500, type: "string" },
44481
+ { type: "boolean" }
44482
+ ]
44483
+ },
44484
+ description: "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.",
44485
+ type: "object"
44486
+ },
44435
44487
  device_id: {
44436
44488
  description: "ID of the unmanaged device that you want to update.",
44437
44489
  format: "uuid",
@@ -44443,7 +44495,7 @@ var openapi_default = {
44443
44495
  type: "boolean"
44444
44496
  }
44445
44497
  },
44446
- required: ["device_id", "is_managed"],
44498
+ required: ["device_id"],
44447
44499
  type: "object"
44448
44500
  }
44449
44501
  }
@@ -44485,6 +44537,17 @@ var openapi_default = {
44485
44537
  "application/json": {
44486
44538
  schema: {
44487
44539
  properties: {
44540
+ custom_metadata: {
44541
+ additionalProperties: {
44542
+ nullable: true,
44543
+ oneOf: [
44544
+ { maxLength: 500, type: "string" },
44545
+ { type: "boolean" }
44546
+ ]
44547
+ },
44548
+ description: "Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.",
44549
+ type: "object"
44550
+ },
44488
44551
  device_id: {
44489
44552
  description: "ID of the unmanaged device that you want to update.",
44490
44553
  format: "uuid",
@@ -44496,7 +44559,7 @@ var openapi_default = {
44496
44559
  type: "boolean"
44497
44560
  }
44498
44561
  },
44499
- required: ["device_id", "is_managed"],
44562
+ required: ["device_id"],
44500
44563
  type: "object"
44501
44564
  }
44502
44565
  }