@seamapi/types 1.951.0 → 1.953.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 (31) hide show
  1. package/dist/connect.cjs +156 -5
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +343 -4
  4. package/dist/index.cjs +156 -5
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-entrance.d.ts +49 -4
  7. package/lib/seam/connect/models/acs/acs-entrance.js +7 -0
  8. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  9. package/lib/seam/connect/models/acs/metadata/salto.d.ts +2 -2
  10. package/lib/seam/connect/models/devices/device.d.ts +58 -0
  11. package/lib/seam/connect/models/devices/device.js +11 -0
  12. package/lib/seam/connect/models/devices/device.js.map +1 -1
  13. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +21 -0
  14. package/lib/seam/connect/models/events/common.d.ts +2 -0
  15. package/lib/seam/connect/models/events/common.js +10 -0
  16. package/lib/seam/connect/models/events/common.js.map +1 -1
  17. package/lib/seam/connect/models/events/devices.d.ts +36 -0
  18. package/lib/seam/connect/models/events/devices.js +10 -1
  19. package/lib/seam/connect/models/events/devices.js.map +1 -1
  20. package/lib/seam/connect/models/events/seam-event.d.ts +18 -0
  21. package/lib/seam/connect/models/phones/phone-session.d.ts +100 -18
  22. package/lib/seam/connect/openapi.js +119 -2
  23. package/lib/seam/connect/openapi.js.map +1 -1
  24. package/lib/seam/connect/route-types.d.ts +245 -0
  25. package/package.json +1 -1
  26. package/src/lib/seam/connect/models/acs/acs-entrance.ts +10 -0
  27. package/src/lib/seam/connect/models/devices/device.ts +12 -0
  28. package/src/lib/seam/connect/models/events/common.ts +15 -0
  29. package/src/lib/seam/connect/models/events/devices.ts +12 -0
  30. package/src/lib/seam/connect/openapi.ts +138 -2
  31. package/src/lib/seam/connect/route-types.ts +308 -0
@@ -5489,6 +5489,19 @@ declare const acs_entrance: z.ZodObject<{
5489
5489
  message: string;
5490
5490
  created_at: string;
5491
5491
  warning_code: "salto_ks_privacy_mode";
5492
+ }>, z.ZodObject<{
5493
+ created_at: z.ZodString;
5494
+ message: z.ZodString;
5495
+ } & {
5496
+ warning_code: z.ZodLiteral<"privacy_mode">;
5497
+ }, "strip", z.ZodTypeAny, {
5498
+ message: string;
5499
+ created_at: string;
5500
+ warning_code: "privacy_mode";
5501
+ }, {
5502
+ message: string;
5503
+ created_at: string;
5504
+ warning_code: "privacy_mode";
5492
5505
  }>]>, "many">;
5493
5506
  latch_metadata: z.ZodOptional<z.ZodObject<{
5494
5507
  accessibility_type: z.ZodString;
@@ -5561,19 +5574,19 @@ declare const acs_entrance: z.ZodObject<{
5561
5574
  battery_level: string;
5562
5575
  locked_state: string;
5563
5576
  door_name: string;
5577
+ privacy_mode?: boolean | undefined;
5564
5578
  online?: boolean | undefined;
5565
5579
  left_open_alarm?: boolean | undefined;
5566
5580
  intrusion_alarm?: boolean | undefined;
5567
- privacy_mode?: boolean | undefined;
5568
5581
  }, {
5569
5582
  lock_type: string;
5570
5583
  battery_level: string;
5571
5584
  locked_state: string;
5572
5585
  door_name: string;
5586
+ privacy_mode?: boolean | undefined;
5573
5587
  online?: boolean | undefined;
5574
5588
  left_open_alarm?: boolean | undefined;
5575
5589
  intrusion_alarm?: boolean | undefined;
5576
- privacy_mode?: boolean | undefined;
5577
5590
  }>>;
5578
5591
  dormakaba_community_metadata: z.ZodOptional<z.ZodObject<{
5579
5592
  access_point_profile: z.ZodString;
@@ -5699,6 +5712,10 @@ declare const acs_entrance: z.ZodObject<{
5699
5712
  message: string;
5700
5713
  created_at: string;
5701
5714
  warning_code: "salto_ks_privacy_mode";
5715
+ } | {
5716
+ message: string;
5717
+ created_at: string;
5718
+ warning_code: "privacy_mode";
5702
5719
  })[];
5703
5720
  space_ids: string[];
5704
5721
  acs_entrance_id: string;
@@ -5708,10 +5725,10 @@ declare const acs_entrance: z.ZodObject<{
5708
5725
  battery_level: string;
5709
5726
  locked_state: string;
5710
5727
  door_name: string;
5728
+ privacy_mode?: boolean | undefined;
5711
5729
  online?: boolean | undefined;
5712
5730
  left_open_alarm?: boolean | undefined;
5713
5731
  intrusion_alarm?: boolean | undefined;
5714
- privacy_mode?: boolean | undefined;
5715
5732
  } | undefined;
5716
5733
  avigilon_alta_metadata?: {
5717
5734
  site_id: number;
@@ -5797,6 +5814,10 @@ declare const acs_entrance: z.ZodObject<{
5797
5814
  message: string;
5798
5815
  created_at: string;
5799
5816
  warning_code: "salto_ks_privacy_mode";
5817
+ } | {
5818
+ message: string;
5819
+ created_at: string;
5820
+ warning_code: "privacy_mode";
5800
5821
  })[];
5801
5822
  space_ids: string[];
5802
5823
  acs_entrance_id: string;
@@ -5806,10 +5827,10 @@ declare const acs_entrance: z.ZodObject<{
5806
5827
  battery_level: string;
5807
5828
  locked_state: string;
5808
5829
  door_name: string;
5830
+ privacy_mode?: boolean | undefined;
5809
5831
  online?: boolean | undefined;
5810
5832
  left_open_alarm?: boolean | undefined;
5811
5833
  intrusion_alarm?: boolean | undefined;
5812
- privacy_mode?: boolean | undefined;
5813
5834
  } | undefined;
5814
5835
  avigilon_alta_metadata?: {
5815
5836
  site_id: number;
@@ -14457,6 +14478,19 @@ declare const device_warning: z.ZodDiscriminatedUnion<"warning_code", [z.ZodObje
14457
14478
  }>, z.ZodObject<{
14458
14479
  message: z.ZodString;
14459
14480
  created_at: z.ZodString;
14481
+ } & {
14482
+ warning_code: z.ZodLiteral<"privacy_mode">;
14483
+ }, "strip", z.ZodTypeAny, {
14484
+ message: string;
14485
+ created_at: string;
14486
+ warning_code: "privacy_mode";
14487
+ }, {
14488
+ message: string;
14489
+ created_at: string;
14490
+ warning_code: "privacy_mode";
14491
+ }>, z.ZodObject<{
14492
+ message: z.ZodString;
14493
+ created_at: z.ZodString;
14460
14494
  } & {
14461
14495
  warning_code: z.ZodLiteral<"salto_ks_subscription_limit_almost_reached">;
14462
14496
  }, "strip", z.ZodTypeAny, {
@@ -17812,6 +17846,19 @@ declare const device: z.ZodObject<{
17812
17846
  }>, z.ZodObject<{
17813
17847
  message: z.ZodString;
17814
17848
  created_at: z.ZodString;
17849
+ } & {
17850
+ warning_code: z.ZodLiteral<"privacy_mode">;
17851
+ }, "strip", z.ZodTypeAny, {
17852
+ message: string;
17853
+ created_at: string;
17854
+ warning_code: "privacy_mode";
17855
+ }, {
17856
+ message: string;
17857
+ created_at: string;
17858
+ warning_code: "privacy_mode";
17859
+ }>, z.ZodObject<{
17860
+ message: z.ZodString;
17861
+ created_at: z.ZodString;
17815
17862
  } & {
17816
17863
  warning_code: z.ZodLiteral<"salto_ks_subscription_limit_almost_reached">;
17817
17864
  }, "strip", z.ZodTypeAny, {
@@ -18197,6 +18244,10 @@ declare const device: z.ZodObject<{
18197
18244
  message: string;
18198
18245
  created_at: string;
18199
18246
  warning_code: "salto_ks_privacy_mode";
18247
+ } | {
18248
+ message: string;
18249
+ created_at: string;
18250
+ warning_code: "privacy_mode";
18200
18251
  } | {
18201
18252
  message: string;
18202
18253
  created_at: string;
@@ -18997,6 +19048,10 @@ declare const device: z.ZodObject<{
18997
19048
  message: string;
18998
19049
  created_at: string;
18999
19050
  warning_code: "salto_ks_privacy_mode";
19051
+ } | {
19052
+ message: string;
19053
+ created_at: string;
19054
+ warning_code: "privacy_mode";
19000
19055
  } | {
19001
19056
  message: string;
19002
19057
  created_at: string;
@@ -22965,6 +23020,19 @@ declare const unmanaged_device: z.ZodObject<Pick<{
22965
23020
  }>, z.ZodObject<{
22966
23021
  message: z.ZodString;
22967
23022
  created_at: z.ZodString;
23023
+ } & {
23024
+ warning_code: z.ZodLiteral<"privacy_mode">;
23025
+ }, "strip", z.ZodTypeAny, {
23026
+ message: string;
23027
+ created_at: string;
23028
+ warning_code: "privacy_mode";
23029
+ }, {
23030
+ message: string;
23031
+ created_at: string;
23032
+ warning_code: "privacy_mode";
23033
+ }>, z.ZodObject<{
23034
+ message: z.ZodString;
23035
+ created_at: z.ZodString;
22968
23036
  } & {
22969
23037
  warning_code: z.ZodLiteral<"salto_ks_subscription_limit_almost_reached">;
22970
23038
  }, "strip", z.ZodTypeAny, {
@@ -23506,6 +23574,10 @@ declare const unmanaged_device: z.ZodObject<Pick<{
23506
23574
  message: string;
23507
23575
  created_at: string;
23508
23576
  warning_code: "salto_ks_privacy_mode";
23577
+ } | {
23578
+ message: string;
23579
+ created_at: string;
23580
+ warning_code: "privacy_mode";
23509
23581
  } | {
23510
23582
  message: string;
23511
23583
  created_at: string;
@@ -23795,6 +23867,10 @@ declare const unmanaged_device: z.ZodObject<Pick<{
23795
23867
  message: string;
23796
23868
  created_at: string;
23797
23869
  warning_code: "salto_ks_privacy_mode";
23870
+ } | {
23871
+ message: string;
23872
+ created_at: string;
23873
+ warning_code: "privacy_mode";
23798
23874
  } | {
23799
23875
  message: string;
23800
23876
  created_at: string;
@@ -28812,6 +28888,16 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
28812
28888
  acs_user_id: z.ZodOptional<z.ZodString>;
28813
28889
  acs_entrance_id: z.ZodOptional<z.ZodString>;
28814
28890
  device_id: z.ZodOptional<z.ZodString>;
28891
+ reason: z.ZodOptional<z.ZodObject<{
28892
+ reason_code: z.ZodEnum<["unknown_code", "expired_code", "blocklisted_code", "too_many_attempts", "blocked_by_privacy_mode", "credential_error"]>;
28893
+ message: z.ZodString;
28894
+ }, "strip", z.ZodTypeAny, {
28895
+ message: string;
28896
+ reason_code: "unknown_code" | "expired_code" | "blocklisted_code" | "too_many_attempts" | "blocked_by_privacy_mode" | "credential_error";
28897
+ }, {
28898
+ message: string;
28899
+ reason_code: "unknown_code" | "expired_code" | "blocklisted_code" | "too_many_attempts" | "blocked_by_privacy_mode" | "credential_error";
28900
+ }>>;
28815
28901
  }, "strip", z.ZodTypeAny, {
28816
28902
  workspace_id: string;
28817
28903
  created_at: string;
@@ -28822,6 +28908,10 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
28822
28908
  device_id?: string | undefined;
28823
28909
  customer_key?: string | undefined;
28824
28910
  access_code_id?: string | undefined;
28911
+ reason?: {
28912
+ message: string;
28913
+ reason_code: "unknown_code" | "expired_code" | "blocklisted_code" | "too_many_attempts" | "blocked_by_privacy_mode" | "credential_error";
28914
+ } | undefined;
28825
28915
  user_identity_id?: string | undefined;
28826
28916
  acs_user_id?: string | undefined;
28827
28917
  acs_entrance_id?: string | undefined;
@@ -28839,6 +28929,10 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
28839
28929
  device_id?: string | undefined;
28840
28930
  customer_key?: string | undefined;
28841
28931
  access_code_id?: string | undefined;
28932
+ reason?: {
28933
+ message: string;
28934
+ reason_code: "unknown_code" | "expired_code" | "blocklisted_code" | "too_many_attempts" | "blocked_by_privacy_mode" | "credential_error";
28935
+ } | undefined;
28842
28936
  user_identity_id?: string | undefined;
28843
28937
  acs_user_id?: string | undefined;
28844
28938
  acs_entrance_id?: string | undefined;
@@ -43056,6 +43150,13 @@ type Routes = {
43056
43150
  created_at: string;
43057
43151
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
43058
43152
  warning_code: 'salto_ks_privacy_mode';
43153
+ } | {
43154
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
43155
+ message: string;
43156
+ /** Date and time at which Seam created the warning. */
43157
+ created_at: string;
43158
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
43159
+ warning_code: 'privacy_mode';
43059
43160
  } | {
43060
43161
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
43061
43162
  message: string;
@@ -43284,6 +43385,13 @@ type Routes = {
43284
43385
  message: string;
43285
43386
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
43286
43387
  warning_code: 'salto_ks_privacy_mode';
43388
+ } | {
43389
+ /** Date and time at which Seam created the warning. */
43390
+ created_at: string;
43391
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
43392
+ message: string;
43393
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
43394
+ warning_code: 'privacy_mode';
43287
43395
  })[];
43288
43396
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
43289
43397
  latch_metadata?: {
@@ -49787,6 +49895,13 @@ type Routes = {
49787
49895
  created_at: string;
49788
49896
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
49789
49897
  warning_code: 'salto_ks_privacy_mode';
49898
+ } | {
49899
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
49900
+ message: string;
49901
+ /** Date and time at which Seam created the warning. */
49902
+ created_at: string;
49903
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
49904
+ warning_code: 'privacy_mode';
49790
49905
  } | {
49791
49906
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
49792
49907
  message: string;
@@ -50015,6 +50130,13 @@ type Routes = {
50015
50130
  message: string;
50016
50131
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
50017
50132
  warning_code: 'salto_ks_privacy_mode';
50133
+ } | {
50134
+ /** Date and time at which Seam created the warning. */
50135
+ created_at: string;
50136
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
50137
+ message: string;
50138
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
50139
+ warning_code: 'privacy_mode';
50018
50140
  })[];
50019
50141
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
50020
50142
  latch_metadata?: {
@@ -53162,6 +53284,13 @@ type Routes = {
53162
53284
  message: string;
53163
53285
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
53164
53286
  warning_code: 'salto_ks_privacy_mode';
53287
+ } | {
53288
+ /** Date and time at which Seam created the warning. */
53289
+ created_at: string;
53290
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
53291
+ message: string;
53292
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
53293
+ warning_code: 'privacy_mode';
53165
53294
  })[];
53166
53295
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
53167
53296
  latch_metadata?: {
@@ -54928,6 +55057,13 @@ type Routes = {
54928
55057
  message: string;
54929
55058
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
54930
55059
  warning_code: 'salto_ks_privacy_mode';
55060
+ } | {
55061
+ /** Date and time at which Seam created the warning. */
55062
+ created_at: string;
55063
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
55064
+ message: string;
55065
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
55066
+ warning_code: 'privacy_mode';
54931
55067
  })[];
54932
55068
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
54933
55069
  latch_metadata?: {
@@ -60997,6 +61133,13 @@ type Routes = {
60997
61133
  message: string;
60998
61134
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
60999
61135
  warning_code: 'salto_ks_privacy_mode';
61136
+ } | {
61137
+ /** Date and time at which Seam created the warning. */
61138
+ created_at: string;
61139
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61140
+ message: string;
61141
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61142
+ warning_code: 'privacy_mode';
61000
61143
  })[];
61001
61144
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
61002
61145
  latch_metadata?: {
@@ -61227,6 +61370,13 @@ type Routes = {
61227
61370
  message: string;
61228
61371
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61229
61372
  warning_code: 'salto_ks_privacy_mode';
61373
+ } | {
61374
+ /** Date and time at which Seam created the warning. */
61375
+ created_at: string;
61376
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61377
+ message: string;
61378
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61379
+ warning_code: 'privacy_mode';
61230
61380
  })[];
61231
61381
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
61232
61382
  latch_metadata?: {
@@ -64656,6 +64806,13 @@ type Routes = {
64656
64806
  message: string;
64657
64807
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
64658
64808
  warning_code: 'salto_ks_privacy_mode';
64809
+ } | {
64810
+ /** Date and time at which Seam created the warning. */
64811
+ created_at: string;
64812
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
64813
+ message: string;
64814
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
64815
+ warning_code: 'privacy_mode';
64659
64816
  })[];
64660
64817
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
64661
64818
  latch_metadata?: {
@@ -72290,6 +72447,13 @@ type Routes = {
72290
72447
  created_at: string;
72291
72448
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
72292
72449
  warning_code: 'salto_ks_privacy_mode';
72450
+ } | {
72451
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
72452
+ message: string;
72453
+ /** Date and time at which Seam created the warning. */
72454
+ created_at: string;
72455
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
72456
+ warning_code: 'privacy_mode';
72293
72457
  } | {
72294
72458
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
72295
72459
  message: string;
@@ -73815,6 +73979,13 @@ type Routes = {
73815
73979
  created_at: string;
73816
73980
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
73817
73981
  warning_code: 'salto_ks_privacy_mode';
73982
+ } | {
73983
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
73984
+ message: string;
73985
+ /** Date and time at which Seam created the warning. */
73986
+ created_at: string;
73987
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
73988
+ warning_code: 'privacy_mode';
73818
73989
  } | {
73819
73990
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
73820
73991
  message: string;
@@ -74464,6 +74635,13 @@ type Routes = {
74464
74635
  created_at: string;
74465
74636
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
74466
74637
  warning_code: 'salto_ks_privacy_mode';
74638
+ } | {
74639
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
74640
+ message: string;
74641
+ /** Date and time at which Seam created the warning. */
74642
+ created_at: string;
74643
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
74644
+ warning_code: 'privacy_mode';
74467
74645
  } | {
74468
74646
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
74469
74647
  message: string;
@@ -75015,6 +75193,13 @@ type Routes = {
75015
75193
  created_at: string;
75016
75194
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
75017
75195
  warning_code: 'salto_ks_privacy_mode';
75196
+ } | {
75197
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
75198
+ message: string;
75199
+ /** Date and time at which Seam created the warning. */
75200
+ created_at: string;
75201
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
75202
+ warning_code: 'privacy_mode';
75018
75203
  } | {
75019
75204
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
75020
75205
  message: string;
@@ -78110,6 +78295,13 @@ type Routes = {
78110
78295
  ID of the ACS entrance associated with the access-denied event.
78111
78296
  */
78112
78297
  acs_entrance_id?: string | undefined;
78298
+ /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
78299
+ reason?: {
78300
+ /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
78301
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
78302
+ /** Human-readable explanation of why access was denied. */
78303
+ message: string;
78304
+ } | undefined;
78113
78305
  } | {
78114
78306
  /** ID of the event. */
78115
78307
  event_id: string;
@@ -81369,6 +81561,13 @@ type Routes = {
81369
81561
  ID of the ACS entrance associated with the access-denied event.
81370
81562
  */
81371
81563
  acs_entrance_id?: string | undefined;
81564
+ /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
81565
+ reason?: {
81566
+ /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
81567
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
81568
+ /** Human-readable explanation of why access was denied. */
81569
+ message: string;
81570
+ } | undefined;
81372
81571
  } | {
81373
81572
  /** ID of the event. */
81374
81573
  event_id: string;
@@ -84865,6 +85064,13 @@ type Routes = {
84865
85064
  created_at: string;
84866
85065
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84867
85066
  warning_code: 'salto_ks_privacy_mode';
85067
+ } | {
85068
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85069
+ message: string;
85070
+ /** Date and time at which Seam created the warning. */
85071
+ created_at: string;
85072
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85073
+ warning_code: 'privacy_mode';
84868
85074
  } | {
84869
85075
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
84870
85076
  message: string;
@@ -86340,6 +86546,13 @@ type Routes = {
86340
86546
  created_at: string;
86341
86547
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
86342
86548
  warning_code: 'salto_ks_privacy_mode';
86549
+ } | {
86550
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
86551
+ message: string;
86552
+ /** Date and time at which Seam created the warning. */
86553
+ created_at: string;
86554
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
86555
+ warning_code: 'privacy_mode';
86343
86556
  } | {
86344
86557
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
86345
86558
  message: string;
@@ -87865,6 +88078,13 @@ type Routes = {
87865
88078
  created_at: string;
87866
88079
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
87867
88080
  warning_code: 'salto_ks_privacy_mode';
88081
+ } | {
88082
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
88083
+ message: string;
88084
+ /** Date and time at which Seam created the warning. */
88085
+ created_at: string;
88086
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
88087
+ warning_code: 'privacy_mode';
87868
88088
  } | {
87869
88089
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
87870
88090
  message: string;
@@ -89339,6 +89559,13 @@ type Routes = {
89339
89559
  created_at: string;
89340
89560
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
89341
89561
  warning_code: 'salto_ks_privacy_mode';
89562
+ } | {
89563
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
89564
+ message: string;
89565
+ /** Date and time at which Seam created the warning. */
89566
+ created_at: string;
89567
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
89568
+ warning_code: 'privacy_mode';
89342
89569
  } | {
89343
89570
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
89344
89571
  message: string;
@@ -97590,6 +97817,13 @@ type Routes = {
97590
97817
  created_at: string;
97591
97818
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97592
97819
  warning_code: 'salto_ks_privacy_mode';
97820
+ } | {
97821
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97822
+ message: string;
97823
+ /** Date and time at which Seam created the warning. */
97824
+ created_at: string;
97825
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97826
+ warning_code: 'privacy_mode';
97593
97827
  } | {
97594
97828
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97595
97829
  message: string;
@@ -99064,6 +99298,13 @@ type Routes = {
99064
99298
  created_at: string;
99065
99299
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99066
99300
  warning_code: 'salto_ks_privacy_mode';
99301
+ } | {
99302
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99303
+ message: string;
99304
+ /** Date and time at which Seam created the warning. */
99305
+ created_at: string;
99306
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99307
+ warning_code: 'privacy_mode';
99067
99308
  } | {
99068
99309
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99069
99310
  message: string;
@@ -111091,6 +111332,13 @@ type Routes = {
111091
111332
  ID of the ACS entrance associated with the access-denied event.
111092
111333
  */
111093
111334
  acs_entrance_id?: string | undefined;
111335
+ /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
111336
+ reason?: {
111337
+ /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
111338
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
111339
+ /** Human-readable explanation of why access was denied. */
111340
+ message: string;
111341
+ } | undefined;
111094
111342
  } | {
111095
111343
  /** ID of the event. */
111096
111344
  event_id: string;
@@ -113156,6 +113404,13 @@ type Routes = {
113156
113404
  message: string;
113157
113405
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
113158
113406
  warning_code: 'salto_ks_privacy_mode';
113407
+ } | {
113408
+ /** Date and time at which Seam created the warning. */
113409
+ created_at: string;
113410
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
113411
+ message: string;
113412
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
113413
+ warning_code: 'privacy_mode';
113159
113414
  })[];
113160
113415
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
113161
113416
  latch_metadata?: {
@@ -114950,6 +115205,13 @@ type Routes = {
114950
115205
  created_at: string;
114951
115206
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
114952
115207
  warning_code: 'salto_ks_privacy_mode';
115208
+ } | {
115209
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115210
+ message: string;
115211
+ /** Date and time at which Seam created the warning. */
115212
+ created_at: string;
115213
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115214
+ warning_code: 'privacy_mode';
114953
115215
  } | {
114954
115216
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
114955
115217
  message: string;
@@ -115178,6 +115440,13 @@ type Routes = {
115178
115440
  message: string;
115179
115441
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115180
115442
  warning_code: 'salto_ks_privacy_mode';
115443
+ } | {
115444
+ /** Date and time at which Seam created the warning. */
115445
+ created_at: string;
115446
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115447
+ message: string;
115448
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115449
+ warning_code: 'privacy_mode';
115181
115450
  })[];
115182
115451
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
115183
115452
  latch_metadata?: {
@@ -122432,6 +122701,13 @@ type Routes = {
122432
122701
  created_at: string;
122433
122702
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
122434
122703
  warning_code: 'salto_ks_privacy_mode';
122704
+ } | {
122705
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
122706
+ message: string;
122707
+ /** Date and time at which Seam created the warning. */
122708
+ created_at: string;
122709
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
122710
+ warning_code: 'privacy_mode';
122435
122711
  } | {
122436
122712
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
122437
122713
  message: string;
@@ -127333,6 +127609,13 @@ type Routes = {
127333
127609
  created_at: string;
127334
127610
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
127335
127611
  warning_code: 'salto_ks_privacy_mode';
127612
+ } | {
127613
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
127614
+ message: string;
127615
+ /** Date and time at which Seam created the warning. */
127616
+ created_at: string;
127617
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
127618
+ warning_code: 'privacy_mode';
127336
127619
  } | {
127337
127620
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
127338
127621
  message: string;
@@ -128807,6 +129090,13 @@ type Routes = {
128807
129090
  created_at: string;
128808
129091
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
128809
129092
  warning_code: 'salto_ks_privacy_mode';
129093
+ } | {
129094
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
129095
+ message: string;
129096
+ /** Date and time at which Seam created the warning. */
129097
+ created_at: string;
129098
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
129099
+ warning_code: 'privacy_mode';
128810
129100
  } | {
128811
129101
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
128812
129102
  message: string;
@@ -137997,6 +138287,13 @@ type Routes = {
137997
138287
  created_at: string;
137998
138288
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
137999
138289
  warning_code: 'salto_ks_privacy_mode';
138290
+ } | {
138291
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
138292
+ message: string;
138293
+ /** Date and time at which Seam created the warning. */
138294
+ created_at: string;
138295
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
138296
+ warning_code: 'privacy_mode';
138000
138297
  } | {
138001
138298
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
138002
138299
  message: string;
@@ -139473,6 +139770,13 @@ type Routes = {
139473
139770
  created_at: string;
139474
139771
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
139475
139772
  warning_code: 'salto_ks_privacy_mode';
139773
+ } | {
139774
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
139775
+ message: string;
139776
+ /** Date and time at which Seam created the warning. */
139777
+ created_at: string;
139778
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
139779
+ warning_code: 'privacy_mode';
139476
139780
  } | {
139477
139781
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
139478
139782
  message: string;
@@ -139715,6 +140019,13 @@ type Routes = {
139715
140019
  message: string;
139716
140020
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
139717
140021
  warning_code: 'salto_ks_privacy_mode';
140022
+ } | {
140023
+ /** Date and time at which Seam created the warning. */
140024
+ created_at: string;
140025
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
140026
+ message: string;
140027
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
140028
+ warning_code: 'privacy_mode';
139718
140029
  })[];
139719
140030
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
139720
140031
  latch_metadata?: {
@@ -142204,6 +142515,13 @@ type Routes = {
142204
142515
  created_at: string;
142205
142516
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
142206
142517
  warning_code: 'salto_ks_privacy_mode';
142518
+ } | {
142519
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
142520
+ message: string;
142521
+ /** Date and time at which Seam created the warning. */
142522
+ created_at: string;
142523
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
142524
+ warning_code: 'privacy_mode';
142207
142525
  } | {
142208
142526
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
142209
142527
  message: string;
@@ -142432,6 +142750,13 @@ type Routes = {
142432
142750
  message: string;
142433
142751
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
142434
142752
  warning_code: 'salto_ks_privacy_mode';
142753
+ } | {
142754
+ /** Date and time at which Seam created the warning. */
142755
+ created_at: string;
142756
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
142757
+ message: string;
142758
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
142759
+ warning_code: 'privacy_mode';
142435
142760
  })[];
142436
142761
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
142437
142762
  latch_metadata?: {
@@ -145520,6 +145845,13 @@ type Routes = {
145520
145845
  created_at: string;
145521
145846
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
145522
145847
  warning_code: 'salto_ks_privacy_mode';
145848
+ } | {
145849
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
145850
+ message: string;
145851
+ /** Date and time at which Seam created the warning. */
145852
+ created_at: string;
145853
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
145854
+ warning_code: 'privacy_mode';
145523
145855
  } | {
145524
145856
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
145525
145857
  message: string;
@@ -149102,6 +149434,13 @@ type Routes = {
149102
149434
  ID of the ACS entrance associated with the access-denied event.
149103
149435
  */
149104
149436
  acs_entrance_id?: string | undefined;
149437
+ /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
149438
+ reason?: {
149439
+ /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
149440
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
149441
+ /** Human-readable explanation of why access was denied. */
149442
+ message: string;
149443
+ } | undefined;
149105
149444
  } | {
149106
149445
  /** ID of the event. */
149107
149446
  event_id: string;