@seamapi/types 1.457.0 → 1.458.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 (32) hide show
  1. package/dist/connect.cjs +56 -231
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +475 -310
  4. package/dist/devicedb.d.cts +56 -56
  5. package/dist/index.cjs +56 -231
  6. package/dist/index.cjs.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-entrance.d.ts +25 -10
  8. package/lib/seam/connect/models/acs/metadata/salto-space.d.ts +15 -6
  9. package/lib/seam/connect/models/acs/metadata/salto-space.js +13 -4
  10. package/lib/seam/connect/models/acs/metadata/salto-space.js.map +1 -1
  11. package/lib/seam/connect/models/batches/access_grants.d.ts +83 -63
  12. package/lib/seam/connect/models/batches/access_methods.d.ts +83 -63
  13. package/lib/seam/connect/models/batches/batch.d.ts +249 -189
  14. package/lib/seam/connect/models/batches/spaces.d.ts +83 -63
  15. package/lib/seam/connect/models/devices/device-metadata.d.ts +22 -22
  16. package/lib/seam/connect/models/devices/device-provider.d.ts +0 -1
  17. package/lib/seam/connect/models/devices/device.d.ts +49 -51
  18. package/lib/seam/connect/models/devices/device.js +16 -7
  19. package/lib/seam/connect/models/devices/device.js.map +1 -1
  20. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +29 -31
  21. package/lib/seam/connect/models/phones/phone-session.d.ts +100 -40
  22. package/lib/seam/connect/openapi.d.ts +26 -2
  23. package/lib/seam/connect/openapi.js +29 -5
  24. package/lib/seam/connect/openapi.js.map +1 -1
  25. package/lib/seam/connect/route-types.d.ts +100 -30
  26. package/lib/seam/devicedb/models/device-model.d.ts +20 -20
  27. package/lib/seam/devicedb/route-specs.d.ts +41 -41
  28. package/package.json +1 -1
  29. package/src/lib/seam/connect/models/acs/metadata/salto-space.ts +13 -4
  30. package/src/lib/seam/connect/models/devices/device.ts +15 -8
  31. package/src/lib/seam/connect/openapi.ts +32 -5
  32. package/src/lib/seam/connect/route-types.ts +100 -30
@@ -11373,12 +11373,19 @@ export interface Routes {
11373
11373
  } | undefined;
11374
11374
  /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
11375
11375
  salto_space_metadata?: {
11376
+ /**
11377
+ * @deprecated use door_id. */
11378
+ ext_door_id?: string | undefined;
11379
+ /** Door ID in the Salto Space access system. */
11380
+ door_id?: string | undefined;
11376
11381
  /** Name of the door in the Salto Space access system. */
11377
- door_name: string;
11378
- /** External door ID in the Salto Space access system. */
11379
- ext_door_id: string;
11382
+ door_name?: string | undefined;
11380
11383
  /** Description of the door in the Salto Space access system. */
11381
11384
  door_description?: string | undefined;
11385
+ /** Name of the room in the Salto Space access system. */
11386
+ room_name?: string | undefined;
11387
+ /** Description of the room in the Salto Space access system. */
11388
+ room_description?: string | undefined;
11382
11389
  } | undefined;
11383
11390
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
11384
11391
  can_unlock_with_mobile_key?: boolean | undefined;
@@ -12649,12 +12656,19 @@ export interface Routes {
12649
12656
  } | undefined;
12650
12657
  /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
12651
12658
  salto_space_metadata?: {
12659
+ /**
12660
+ * @deprecated use door_id. */
12661
+ ext_door_id?: string | undefined;
12662
+ /** Door ID in the Salto Space access system. */
12663
+ door_id?: string | undefined;
12652
12664
  /** Name of the door in the Salto Space access system. */
12653
- door_name: string;
12654
- /** External door ID in the Salto Space access system. */
12655
- ext_door_id: string;
12665
+ door_name?: string | undefined;
12656
12666
  /** Description of the door in the Salto Space access system. */
12657
12667
  door_description?: string | undefined;
12668
+ /** Name of the room in the Salto Space access system. */
12669
+ room_name?: string | undefined;
12670
+ /** Description of the room in the Salto Space access system. */
12671
+ room_description?: string | undefined;
12658
12672
  } | undefined;
12659
12673
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
12660
12674
  can_unlock_with_mobile_key?: boolean | undefined;
@@ -19438,12 +19452,19 @@ export interface Routes {
19438
19452
  } | undefined;
19439
19453
  /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
19440
19454
  salto_space_metadata?: {
19455
+ /**
19456
+ * @deprecated use door_id. */
19457
+ ext_door_id?: string | undefined;
19458
+ /** Door ID in the Salto Space access system. */
19459
+ door_id?: string | undefined;
19441
19460
  /** Name of the door in the Salto Space access system. */
19442
- door_name: string;
19443
- /** External door ID in the Salto Space access system. */
19444
- ext_door_id: string;
19461
+ door_name?: string | undefined;
19445
19462
  /** Description of the door in the Salto Space access system. */
19446
19463
  door_description?: string | undefined;
19464
+ /** Name of the room in the Salto Space access system. */
19465
+ room_name?: string | undefined;
19466
+ /** Description of the room in the Salto Space access system. */
19467
+ room_description?: string | undefined;
19447
19468
  } | undefined;
19448
19469
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
19449
19470
  can_unlock_with_mobile_key?: boolean | undefined;
@@ -20763,12 +20784,19 @@ export interface Routes {
20763
20784
  } | undefined;
20764
20785
  /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
20765
20786
  salto_space_metadata?: {
20787
+ /**
20788
+ * @deprecated use door_id. */
20789
+ ext_door_id?: string | undefined;
20790
+ /** Door ID in the Salto Space access system. */
20791
+ door_id?: string | undefined;
20766
20792
  /** Name of the door in the Salto Space access system. */
20767
- door_name: string;
20768
- /** External door ID in the Salto Space access system. */
20769
- ext_door_id: string;
20793
+ door_name?: string | undefined;
20770
20794
  /** Description of the door in the Salto Space access system. */
20771
20795
  door_description?: string | undefined;
20796
+ /** Name of the room in the Salto Space access system. */
20797
+ room_name?: string | undefined;
20798
+ /** Description of the room in the Salto Space access system. */
20799
+ room_description?: string | undefined;
20772
20800
  } | undefined;
20773
20801
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
20774
20802
  can_unlock_with_mobile_key?: boolean | undefined;
@@ -24178,12 +24206,19 @@ export interface Routes {
24178
24206
  } | undefined;
24179
24207
  /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
24180
24208
  salto_space_metadata?: {
24209
+ /**
24210
+ * @deprecated use door_id. */
24211
+ ext_door_id?: string | undefined;
24212
+ /** Door ID in the Salto Space access system. */
24213
+ door_id?: string | undefined;
24181
24214
  /** Name of the door in the Salto Space access system. */
24182
- door_name: string;
24183
- /** External door ID in the Salto Space access system. */
24184
- ext_door_id: string;
24215
+ door_name?: string | undefined;
24185
24216
  /** Description of the door in the Salto Space access system. */
24186
24217
  door_description?: string | undefined;
24218
+ /** Name of the room in the Salto Space access system. */
24219
+ room_name?: string | undefined;
24220
+ /** Description of the room in the Salto Space access system. */
24221
+ room_description?: string | undefined;
24187
24222
  } | undefined;
24188
24223
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
24189
24224
  can_unlock_with_mobile_key?: boolean | undefined;
@@ -24320,12 +24355,19 @@ export interface Routes {
24320
24355
  } | undefined;
24321
24356
  /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
24322
24357
  salto_space_metadata?: {
24358
+ /**
24359
+ * @deprecated use door_id. */
24360
+ ext_door_id?: string | undefined;
24361
+ /** Door ID in the Salto Space access system. */
24362
+ door_id?: string | undefined;
24323
24363
  /** Name of the door in the Salto Space access system. */
24324
- door_name: string;
24325
- /** External door ID in the Salto Space access system. */
24326
- ext_door_id: string;
24364
+ door_name?: string | undefined;
24327
24365
  /** Description of the door in the Salto Space access system. */
24328
24366
  door_description?: string | undefined;
24367
+ /** Name of the room in the Salto Space access system. */
24368
+ room_name?: string | undefined;
24369
+ /** Description of the room in the Salto Space access system. */
24370
+ room_description?: string | undefined;
24329
24371
  } | undefined;
24330
24372
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
24331
24373
  can_unlock_with_mobile_key?: boolean | undefined;
@@ -25727,12 +25769,19 @@ export interface Routes {
25727
25769
  } | undefined;
25728
25770
  /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
25729
25771
  salto_space_metadata?: {
25772
+ /**
25773
+ * @deprecated use door_id. */
25774
+ ext_door_id?: string | undefined;
25775
+ /** Door ID in the Salto Space access system. */
25776
+ door_id?: string | undefined;
25730
25777
  /** Name of the door in the Salto Space access system. */
25731
- door_name: string;
25732
- /** External door ID in the Salto Space access system. */
25733
- ext_door_id: string;
25778
+ door_name?: string | undefined;
25734
25779
  /** Description of the door in the Salto Space access system. */
25735
25780
  door_description?: string | undefined;
25781
+ /** Name of the room in the Salto Space access system. */
25782
+ room_name?: string | undefined;
25783
+ /** Description of the room in the Salto Space access system. */
25784
+ room_description?: string | undefined;
25736
25785
  } | undefined;
25737
25786
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
25738
25787
  can_unlock_with_mobile_key?: boolean | undefined;
@@ -54236,12 +54285,19 @@ export interface Routes {
54236
54285
  } | undefined;
54237
54286
  /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
54238
54287
  salto_space_metadata?: {
54288
+ /**
54289
+ * @deprecated use door_id. */
54290
+ ext_door_id?: string | undefined;
54291
+ /** Door ID in the Salto Space access system. */
54292
+ door_id?: string | undefined;
54239
54293
  /** Name of the door in the Salto Space access system. */
54240
- door_name: string;
54241
- /** External door ID in the Salto Space access system. */
54242
- ext_door_id: string;
54294
+ door_name?: string | undefined;
54243
54295
  /** Description of the door in the Salto Space access system. */
54244
54296
  door_description?: string | undefined;
54297
+ /** Name of the room in the Salto Space access system. */
54298
+ room_name?: string | undefined;
54299
+ /** Description of the room in the Salto Space access system. */
54300
+ room_description?: string | undefined;
54245
54301
  } | undefined;
54246
54302
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
54247
54303
  can_unlock_with_mobile_key?: boolean | undefined;
@@ -55672,12 +55728,19 @@ export interface Routes {
55672
55728
  } | undefined;
55673
55729
  /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
55674
55730
  salto_space_metadata?: {
55731
+ /**
55732
+ * @deprecated use door_id. */
55733
+ ext_door_id?: string | undefined;
55734
+ /** Door ID in the Salto Space access system. */
55735
+ door_id?: string | undefined;
55675
55736
  /** Name of the door in the Salto Space access system. */
55676
- door_name: string;
55677
- /** External door ID in the Salto Space access system. */
55678
- ext_door_id: string;
55737
+ door_name?: string | undefined;
55679
55738
  /** Description of the door in the Salto Space access system. */
55680
55739
  door_description?: string | undefined;
55740
+ /** Name of the room in the Salto Space access system. */
55741
+ room_name?: string | undefined;
55742
+ /** Description of the room in the Salto Space access system. */
55743
+ room_description?: string | undefined;
55681
55744
  } | undefined;
55682
55745
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
55683
55746
  can_unlock_with_mobile_key?: boolean | undefined;
@@ -56948,12 +57011,19 @@ export interface Routes {
56948
57011
  } | undefined;
56949
57012
  /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
56950
57013
  salto_space_metadata?: {
57014
+ /**
57015
+ * @deprecated use door_id. */
57016
+ ext_door_id?: string | undefined;
57017
+ /** Door ID in the Salto Space access system. */
57018
+ door_id?: string | undefined;
56951
57019
  /** Name of the door in the Salto Space access system. */
56952
- door_name: string;
56953
- /** External door ID in the Salto Space access system. */
56954
- ext_door_id: string;
57020
+ door_name?: string | undefined;
56955
57021
  /** Description of the door in the Salto Space access system. */
56956
57022
  door_description?: string | undefined;
57023
+ /** Name of the room in the Salto Space access system. */
57024
+ room_name?: string | undefined;
57025
+ /** Description of the room in the Salto Space access system. */
57026
+ room_description?: string | undefined;
56957
57027
  } | undefined;
56958
57028
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
56959
57029
  can_unlock_with_mobile_key?: boolean | undefined;
@@ -91,12 +91,12 @@ export declare const device_model_category_specific_properties: z.ZodDiscriminat
91
91
  has_physical_key: z.ZodBoolean;
92
92
  has_camera: z.ZodBoolean;
93
93
  }, "strip", z.ZodTypeAny, {
94
- has_physical_key: boolean;
95
94
  lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
95
+ has_physical_key: boolean;
96
96
  has_camera: boolean;
97
97
  }, {
98
- has_physical_key: boolean;
99
98
  lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
99
+ has_physical_key: boolean;
100
100
  has_camera: boolean;
101
101
  }>;
102
102
  software_features: z.ZodObject<{
@@ -127,8 +127,8 @@ export declare const device_model_category_specific_properties: z.ZodDiscriminat
127
127
  }, "can_remotely_unlock" | "can_remotely_lock" | "can_program_offline_access_codes" | "can_program_online_access_codes">, "strip", z.ZodTypeAny, {
128
128
  main_category: "smartlock";
129
129
  physical_properties: {
130
- has_physical_key: boolean;
131
130
  lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
131
+ has_physical_key: boolean;
132
132
  has_camera: boolean;
133
133
  };
134
134
  software_features: {
@@ -144,8 +144,8 @@ export declare const device_model_category_specific_properties: z.ZodDiscriminat
144
144
  }, {
145
145
  main_category: "smartlock";
146
146
  physical_properties: {
147
- has_physical_key: boolean;
148
147
  lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
148
+ has_physical_key: boolean;
149
149
  has_camera: boolean;
150
150
  };
151
151
  software_features: {
@@ -546,7 +546,6 @@ export declare const base_device_model_v1: z.ZodObject<{
546
546
  }, "strip", z.ZodTypeAny, {
547
547
  description: string;
548
548
  display_name: string;
549
- device_model_id: string;
550
549
  manufacturer: {
551
550
  display_name: string;
552
551
  manufacturer_id: string;
@@ -575,11 +574,12 @@ export declare const base_device_model_v1: z.ZodObject<{
575
574
  us_customer_support_contact_url?: string | undefined;
576
575
  seam_api_guide?: string | undefined;
577
576
  };
578
- is_device_supported: boolean;
579
- main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
580
577
  hardware: {
581
578
  has_physical_key?: boolean | undefined;
582
579
  };
580
+ device_model_id: string;
581
+ is_device_supported: boolean;
582
+ main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
583
583
  aesthetic_variants: {
584
584
  display_name: string;
585
585
  slug: string;
@@ -606,7 +606,6 @@ export declare const base_device_model_v1: z.ZodObject<{
606
606
  }, {
607
607
  description: string;
608
608
  display_name: string;
609
- device_model_id: string;
610
609
  manufacturer: {
611
610
  display_name: string;
612
611
  manufacturer_id: string;
@@ -635,11 +634,12 @@ export declare const base_device_model_v1: z.ZodObject<{
635
634
  us_customer_support_contact_url?: string | undefined;
636
635
  seam_api_guide?: string | undefined;
637
636
  };
638
- is_device_supported: boolean;
639
- main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
640
637
  hardware: {
641
638
  has_physical_key?: boolean | undefined;
642
639
  };
640
+ device_model_id: string;
641
+ is_device_supported: boolean;
642
+ main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
643
643
  aesthetic_variants: {
644
644
  display_name: string;
645
645
  slug: string;
@@ -865,7 +865,6 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
865
865
  }, "strip", z.ZodTypeAny, {
866
866
  description: string;
867
867
  display_name: string;
868
- device_model_id: string;
869
868
  manufacturer: {
870
869
  display_name: string;
871
870
  manufacturer_id: string;
@@ -894,11 +893,12 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
894
893
  us_customer_support_contact_url?: string | undefined;
895
894
  seam_api_guide?: string | undefined;
896
895
  };
897
- is_device_supported: boolean;
898
- main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
899
896
  hardware: {
900
897
  has_physical_key?: boolean | undefined;
901
898
  };
899
+ device_model_id: string;
900
+ is_device_supported: boolean;
901
+ main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
902
902
  aesthetic_variants: {
903
903
  display_name: string;
904
904
  slug: string;
@@ -925,7 +925,6 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
925
925
  }, {
926
926
  description: string;
927
927
  display_name: string;
928
- device_model_id: string;
929
928
  manufacturer: {
930
929
  display_name: string;
931
930
  manufacturer_id: string;
@@ -954,11 +953,12 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
954
953
  us_customer_support_contact_url?: string | undefined;
955
954
  seam_api_guide?: string | undefined;
956
955
  };
957
- is_device_supported: boolean;
958
- main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
959
956
  hardware: {
960
957
  has_physical_key?: boolean | undefined;
961
958
  };
959
+ device_model_id: string;
960
+ is_device_supported: boolean;
961
+ main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
962
962
  aesthetic_variants: {
963
963
  display_name: string;
964
964
  slug: string;
@@ -989,12 +989,12 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
989
989
  has_physical_key: z.ZodBoolean;
990
990
  has_camera: z.ZodBoolean;
991
991
  }, "strip", z.ZodTypeAny, {
992
- has_physical_key: boolean;
993
992
  lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
993
+ has_physical_key: boolean;
994
994
  has_camera: boolean;
995
995
  }, {
996
- has_physical_key: boolean;
997
996
  lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
997
+ has_physical_key: boolean;
998
998
  has_camera: boolean;
999
999
  }>;
1000
1000
  software_features: z.ZodObject<{
@@ -1025,8 +1025,8 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
1025
1025
  }, "can_remotely_unlock" | "can_remotely_lock" | "can_program_offline_access_codes" | "can_program_online_access_codes">, "strip", z.ZodTypeAny, {
1026
1026
  main_category: "smartlock";
1027
1027
  physical_properties: {
1028
- has_physical_key: boolean;
1029
1028
  lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
1029
+ has_physical_key: boolean;
1030
1030
  has_camera: boolean;
1031
1031
  };
1032
1032
  software_features: {
@@ -1042,8 +1042,8 @@ export declare const device_model_v1: z.ZodIntersection<z.ZodObject<{
1042
1042
  }, {
1043
1043
  main_category: "smartlock";
1044
1044
  physical_properties: {
1045
- has_physical_key: boolean;
1046
1045
  lock_type: "unknown" | "deadbolt" | "lever" | "mortise" | "lockbox" | "cylinder" | "padlock" | "locker";
1046
+ has_physical_key: boolean;
1047
1047
  has_camera: boolean;
1048
1048
  };
1049
1049
  software_features: {