@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
@@ -12919,6 +12919,13 @@ export type Routes = {
12919
12919
  created_at: string;
12920
12920
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
12921
12921
  warning_code: 'salto_ks_privacy_mode';
12922
+ } | {
12923
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
12924
+ message: string;
12925
+ /** Date and time at which Seam created the warning. */
12926
+ created_at: string;
12927
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
12928
+ warning_code: 'privacy_mode';
12922
12929
  } | {
12923
12930
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
12924
12931
  message: string;
@@ -13147,6 +13154,13 @@ export type Routes = {
13147
13154
  message: string;
13148
13155
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13149
13156
  warning_code: 'salto_ks_privacy_mode';
13157
+ } | {
13158
+ /** Date and time at which Seam created the warning. */
13159
+ created_at: string;
13160
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13161
+ message: string;
13162
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13163
+ warning_code: 'privacy_mode';
13150
13164
  })[];
13151
13165
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
13152
13166
  latch_metadata?: {
@@ -19650,6 +19664,13 @@ export type Routes = {
19650
19664
  created_at: string;
19651
19665
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19652
19666
  warning_code: 'salto_ks_privacy_mode';
19667
+ } | {
19668
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19669
+ message: string;
19670
+ /** Date and time at which Seam created the warning. */
19671
+ created_at: string;
19672
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19673
+ warning_code: 'privacy_mode';
19653
19674
  } | {
19654
19675
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19655
19676
  message: string;
@@ -19878,6 +19899,13 @@ export type Routes = {
19878
19899
  message: string;
19879
19900
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19880
19901
  warning_code: 'salto_ks_privacy_mode';
19902
+ } | {
19903
+ /** Date and time at which Seam created the warning. */
19904
+ created_at: string;
19905
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
19906
+ message: string;
19907
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
19908
+ warning_code: 'privacy_mode';
19881
19909
  })[];
19882
19910
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
19883
19911
  latch_metadata?: {
@@ -23025,6 +23053,13 @@ export type Routes = {
23025
23053
  message: string;
23026
23054
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23027
23055
  warning_code: 'salto_ks_privacy_mode';
23056
+ } | {
23057
+ /** Date and time at which Seam created the warning. */
23058
+ created_at: string;
23059
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23060
+ message: string;
23061
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23062
+ warning_code: 'privacy_mode';
23028
23063
  })[];
23029
23064
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
23030
23065
  latch_metadata?: {
@@ -24791,6 +24826,13 @@ export type Routes = {
24791
24826
  message: string;
24792
24827
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
24793
24828
  warning_code: 'salto_ks_privacy_mode';
24829
+ } | {
24830
+ /** Date and time at which Seam created the warning. */
24831
+ created_at: string;
24832
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
24833
+ message: string;
24834
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
24835
+ warning_code: 'privacy_mode';
24794
24836
  })[];
24795
24837
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
24796
24838
  latch_metadata?: {
@@ -30860,6 +30902,13 @@ export type Routes = {
30860
30902
  message: string;
30861
30903
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
30862
30904
  warning_code: 'salto_ks_privacy_mode';
30905
+ } | {
30906
+ /** Date and time at which Seam created the warning. */
30907
+ created_at: string;
30908
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
30909
+ message: string;
30910
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
30911
+ warning_code: 'privacy_mode';
30863
30912
  })[];
30864
30913
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
30865
30914
  latch_metadata?: {
@@ -31090,6 +31139,13 @@ export type Routes = {
31090
31139
  message: string;
31091
31140
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31092
31141
  warning_code: 'salto_ks_privacy_mode';
31142
+ } | {
31143
+ /** Date and time at which Seam created the warning. */
31144
+ created_at: string;
31145
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31146
+ message: string;
31147
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31148
+ warning_code: 'privacy_mode';
31093
31149
  })[];
31094
31150
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
31095
31151
  latch_metadata?: {
@@ -34519,6 +34575,13 @@ export type Routes = {
34519
34575
  message: string;
34520
34576
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
34521
34577
  warning_code: 'salto_ks_privacy_mode';
34578
+ } | {
34579
+ /** Date and time at which Seam created the warning. */
34580
+ created_at: string;
34581
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
34582
+ message: string;
34583
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
34584
+ warning_code: 'privacy_mode';
34522
34585
  })[];
34523
34586
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
34524
34587
  latch_metadata?: {
@@ -42153,6 +42216,13 @@ export type Routes = {
42153
42216
  created_at: string;
42154
42217
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
42155
42218
  warning_code: 'salto_ks_privacy_mode';
42219
+ } | {
42220
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
42221
+ message: string;
42222
+ /** Date and time at which Seam created the warning. */
42223
+ created_at: string;
42224
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
42225
+ warning_code: 'privacy_mode';
42156
42226
  } | {
42157
42227
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
42158
42228
  message: string;
@@ -43678,6 +43748,13 @@ export type Routes = {
43678
43748
  created_at: string;
43679
43749
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
43680
43750
  warning_code: 'salto_ks_privacy_mode';
43751
+ } | {
43752
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
43753
+ message: string;
43754
+ /** Date and time at which Seam created the warning. */
43755
+ created_at: string;
43756
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
43757
+ warning_code: 'privacy_mode';
43681
43758
  } | {
43682
43759
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
43683
43760
  message: string;
@@ -44327,6 +44404,13 @@ export type Routes = {
44327
44404
  created_at: string;
44328
44405
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
44329
44406
  warning_code: 'salto_ks_privacy_mode';
44407
+ } | {
44408
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
44409
+ message: string;
44410
+ /** Date and time at which Seam created the warning. */
44411
+ created_at: string;
44412
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
44413
+ warning_code: 'privacy_mode';
44330
44414
  } | {
44331
44415
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
44332
44416
  message: string;
@@ -44878,6 +44962,13 @@ export type Routes = {
44878
44962
  created_at: string;
44879
44963
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
44880
44964
  warning_code: 'salto_ks_privacy_mode';
44965
+ } | {
44966
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
44967
+ message: string;
44968
+ /** Date and time at which Seam created the warning. */
44969
+ created_at: string;
44970
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
44971
+ warning_code: 'privacy_mode';
44881
44972
  } | {
44882
44973
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
44883
44974
  message: string;
@@ -47973,6 +48064,13 @@ export type Routes = {
47973
48064
  ID of the ACS entrance associated with the access-denied event.
47974
48065
  */
47975
48066
  acs_entrance_id?: string | undefined;
48067
+ /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
48068
+ reason?: {
48069
+ /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
48070
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
48071
+ /** Human-readable explanation of why access was denied. */
48072
+ message: string;
48073
+ } | undefined;
47976
48074
  } | {
47977
48075
  /** ID of the event. */
47978
48076
  event_id: string;
@@ -51232,6 +51330,13 @@ export type Routes = {
51232
51330
  ID of the ACS entrance associated with the access-denied event.
51233
51331
  */
51234
51332
  acs_entrance_id?: string | undefined;
51333
+ /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
51334
+ reason?: {
51335
+ /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
51336
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
51337
+ /** Human-readable explanation of why access was denied. */
51338
+ message: string;
51339
+ } | undefined;
51235
51340
  } | {
51236
51341
  /** ID of the event. */
51237
51342
  event_id: string;
@@ -54728,6 +54833,13 @@ export type Routes = {
54728
54833
  created_at: string;
54729
54834
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
54730
54835
  warning_code: 'salto_ks_privacy_mode';
54836
+ } | {
54837
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
54838
+ message: string;
54839
+ /** Date and time at which Seam created the warning. */
54840
+ created_at: string;
54841
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
54842
+ warning_code: 'privacy_mode';
54731
54843
  } | {
54732
54844
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
54733
54845
  message: string;
@@ -56203,6 +56315,13 @@ export type Routes = {
56203
56315
  created_at: string;
56204
56316
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
56205
56317
  warning_code: 'salto_ks_privacy_mode';
56318
+ } | {
56319
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
56320
+ message: string;
56321
+ /** Date and time at which Seam created the warning. */
56322
+ created_at: string;
56323
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
56324
+ warning_code: 'privacy_mode';
56206
56325
  } | {
56207
56326
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
56208
56327
  message: string;
@@ -57728,6 +57847,13 @@ export type Routes = {
57728
57847
  created_at: string;
57729
57848
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
57730
57849
  warning_code: 'salto_ks_privacy_mode';
57850
+ } | {
57851
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
57852
+ message: string;
57853
+ /** Date and time at which Seam created the warning. */
57854
+ created_at: string;
57855
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
57856
+ warning_code: 'privacy_mode';
57731
57857
  } | {
57732
57858
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
57733
57859
  message: string;
@@ -59202,6 +59328,13 @@ export type Routes = {
59202
59328
  created_at: string;
59203
59329
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59204
59330
  warning_code: 'salto_ks_privacy_mode';
59331
+ } | {
59332
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59333
+ message: string;
59334
+ /** Date and time at which Seam created the warning. */
59335
+ created_at: string;
59336
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59337
+ warning_code: 'privacy_mode';
59205
59338
  } | {
59206
59339
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59207
59340
  message: string;
@@ -67453,6 +67586,13 @@ export type Routes = {
67453
67586
  created_at: string;
67454
67587
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
67455
67588
  warning_code: 'salto_ks_privacy_mode';
67589
+ } | {
67590
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
67591
+ message: string;
67592
+ /** Date and time at which Seam created the warning. */
67593
+ created_at: string;
67594
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
67595
+ warning_code: 'privacy_mode';
67456
67596
  } | {
67457
67597
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
67458
67598
  message: string;
@@ -68927,6 +69067,13 @@ export type Routes = {
68927
69067
  created_at: string;
68928
69068
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
68929
69069
  warning_code: 'salto_ks_privacy_mode';
69070
+ } | {
69071
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
69072
+ message: string;
69073
+ /** Date and time at which Seam created the warning. */
69074
+ created_at: string;
69075
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
69076
+ warning_code: 'privacy_mode';
68930
69077
  } | {
68931
69078
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
68932
69079
  message: string;
@@ -80954,6 +81101,13 @@ export type Routes = {
80954
81101
  ID of the ACS entrance associated with the access-denied event.
80955
81102
  */
80956
81103
  acs_entrance_id?: string | undefined;
81104
+ /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
81105
+ reason?: {
81106
+ /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
81107
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
81108
+ /** Human-readable explanation of why access was denied. */
81109
+ message: string;
81110
+ } | undefined;
80957
81111
  } | {
80958
81112
  /** ID of the event. */
80959
81113
  event_id: string;
@@ -83019,6 +83173,13 @@ export type Routes = {
83019
83173
  message: string;
83020
83174
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
83021
83175
  warning_code: 'salto_ks_privacy_mode';
83176
+ } | {
83177
+ /** Date and time at which Seam created the warning. */
83178
+ created_at: string;
83179
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
83180
+ message: string;
83181
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
83182
+ warning_code: 'privacy_mode';
83022
83183
  })[];
83023
83184
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
83024
83185
  latch_metadata?: {
@@ -84813,6 +84974,13 @@ export type Routes = {
84813
84974
  created_at: string;
84814
84975
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84815
84976
  warning_code: 'salto_ks_privacy_mode';
84977
+ } | {
84978
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
84979
+ message: string;
84980
+ /** Date and time at which Seam created the warning. */
84981
+ created_at: string;
84982
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
84983
+ warning_code: 'privacy_mode';
84816
84984
  } | {
84817
84985
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
84818
84986
  message: string;
@@ -85041,6 +85209,13 @@ export type Routes = {
85041
85209
  message: string;
85042
85210
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85043
85211
  warning_code: 'salto_ks_privacy_mode';
85212
+ } | {
85213
+ /** Date and time at which Seam created the warning. */
85214
+ created_at: string;
85215
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
85216
+ message: string;
85217
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
85218
+ warning_code: 'privacy_mode';
85044
85219
  })[];
85045
85220
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
85046
85221
  latch_metadata?: {
@@ -92295,6 +92470,13 @@ export type Routes = {
92295
92470
  created_at: string;
92296
92471
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
92297
92472
  warning_code: 'salto_ks_privacy_mode';
92473
+ } | {
92474
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
92475
+ message: string;
92476
+ /** Date and time at which Seam created the warning. */
92477
+ created_at: string;
92478
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
92479
+ warning_code: 'privacy_mode';
92298
92480
  } | {
92299
92481
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
92300
92482
  message: string;
@@ -97196,6 +97378,13 @@ export type Routes = {
97196
97378
  created_at: string;
97197
97379
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97198
97380
  warning_code: 'salto_ks_privacy_mode';
97381
+ } | {
97382
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97383
+ message: string;
97384
+ /** Date and time at which Seam created the warning. */
97385
+ created_at: string;
97386
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
97387
+ warning_code: 'privacy_mode';
97199
97388
  } | {
97200
97389
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
97201
97390
  message: string;
@@ -98670,6 +98859,13 @@ export type Routes = {
98670
98859
  created_at: string;
98671
98860
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98672
98861
  warning_code: 'salto_ks_privacy_mode';
98862
+ } | {
98863
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98864
+ message: string;
98865
+ /** Date and time at which Seam created the warning. */
98866
+ created_at: string;
98867
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
98868
+ warning_code: 'privacy_mode';
98673
98869
  } | {
98674
98870
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
98675
98871
  message: string;
@@ -107860,6 +108056,13 @@ export type Routes = {
107860
108056
  created_at: string;
107861
108057
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107862
108058
  warning_code: 'salto_ks_privacy_mode';
108059
+ } | {
108060
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
108061
+ message: string;
108062
+ /** Date and time at which Seam created the warning. */
108063
+ created_at: string;
108064
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
108065
+ warning_code: 'privacy_mode';
107863
108066
  } | {
107864
108067
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107865
108068
  message: string;
@@ -109336,6 +109539,13 @@ export type Routes = {
109336
109539
  created_at: string;
109337
109540
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109338
109541
  warning_code: 'salto_ks_privacy_mode';
109542
+ } | {
109543
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
109544
+ message: string;
109545
+ /** Date and time at which Seam created the warning. */
109546
+ created_at: string;
109547
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109548
+ warning_code: 'privacy_mode';
109339
109549
  } | {
109340
109550
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
109341
109551
  message: string;
@@ -109578,6 +109788,13 @@ export type Routes = {
109578
109788
  message: string;
109579
109789
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109580
109790
  warning_code: 'salto_ks_privacy_mode';
109791
+ } | {
109792
+ /** Date and time at which Seam created the warning. */
109793
+ created_at: string;
109794
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
109795
+ message: string;
109796
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109797
+ warning_code: 'privacy_mode';
109581
109798
  })[];
109582
109799
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
109583
109800
  latch_metadata?: {
@@ -112067,6 +112284,13 @@ export type Routes = {
112067
112284
  created_at: string;
112068
112285
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
112069
112286
  warning_code: 'salto_ks_privacy_mode';
112287
+ } | {
112288
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
112289
+ message: string;
112290
+ /** Date and time at which Seam created the warning. */
112291
+ created_at: string;
112292
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
112293
+ warning_code: 'privacy_mode';
112070
112294
  } | {
112071
112295
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
112072
112296
  message: string;
@@ -112295,6 +112519,13 @@ export type Routes = {
112295
112519
  message: string;
112296
112520
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
112297
112521
  warning_code: 'salto_ks_privacy_mode';
112522
+ } | {
112523
+ /** Date and time at which Seam created the warning. */
112524
+ created_at: string;
112525
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
112526
+ message: string;
112527
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
112528
+ warning_code: 'privacy_mode';
112298
112529
  })[];
112299
112530
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
112300
112531
  latch_metadata?: {
@@ -115383,6 +115614,13 @@ export type Routes = {
115383
115614
  created_at: string;
115384
115615
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115385
115616
  warning_code: 'salto_ks_privacy_mode';
115617
+ } | {
115618
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115619
+ message: string;
115620
+ /** Date and time at which Seam created the warning. */
115621
+ created_at: string;
115622
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115623
+ warning_code: 'privacy_mode';
115386
115624
  } | {
115387
115625
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115388
115626
  message: string;
@@ -118965,6 +119203,13 @@ export type Routes = {
118965
119203
  ID of the ACS entrance associated with the access-denied event.
118966
119204
  */
118967
119205
  acs_entrance_id?: string | undefined;
119206
+ /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
119207
+ reason?: {
119208
+ /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
119209
+ reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
119210
+ /** Human-readable explanation of why access was denied. */
119211
+ message: string;
119212
+ } | undefined;
118968
119213
  } | {
118969
119214
  /** ID of the event. */
118970
119215
  event_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.951.0",
3
+ "version": "1.953.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -65,6 +65,14 @@ const salto_ks_privacy_mode = common_acs_entrance_warning
65
65
  .literal('salto_ks_privacy_mode')
66
66
  .describe(warning_code_description),
67
67
  })
68
+ .describe(
69
+ 'deprecated: Use `privacy_mode` instead. Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
70
+ )
71
+
72
+ const privacy_mode = common_acs_entrance_warning
73
+ .extend({
74
+ warning_code: z.literal('privacy_mode').describe(warning_code_description),
75
+ })
68
76
  .describe(
69
77
  'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
70
78
  )
@@ -75,6 +83,7 @@ const acs_entrance_warning = z
75
83
  entrance_shares_zone,
76
84
  entrance_setup_required,
77
85
  salto_ks_privacy_mode,
86
+ privacy_mode,
78
87
  ])
79
88
  .describe(
80
89
  'Warning associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details).',
@@ -86,6 +95,7 @@ const _acs_entrance_warning_map = z.object({
86
95
  entrance_shares_zone: entrance_shares_zone.optional().nullable(),
87
96
  entrance_setup_required: entrance_setup_required.optional().nullable(),
88
97
  salto_ks_privacy_mode: salto_ks_privacy_mode.optional().nullable(),
98
+ privacy_mode: privacy_mode.optional().nullable(),
89
99
  })
90
100
 
91
101
  export type AcsEntranceWarningMap = z.infer<typeof _acs_entrance_warning_map>
@@ -428,11 +428,21 @@ const salto_ks_privacy_mode = common_device_warning.extend({
428
428
  .describe(warning_code_description),
429
429
  }).describe(`
430
430
  ---
431
+ deprecated: Use \`privacy_mode\` instead.
431
432
  variant_group_key: access_codes
432
433
  ---
433
434
  Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.
434
435
  `)
435
436
 
437
+ const privacy_mode = common_device_warning.extend({
438
+ warning_code: z.literal('privacy_mode').describe(warning_code_description),
439
+ }).describe(`
440
+ ---
441
+ variant_group_key: access_codes
442
+ ---
443
+ Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled.
444
+ `)
445
+
436
446
  const salto_ks_subscription_limit_almost_reached = common_device_warning.extend(
437
447
  {
438
448
  warning_code: z
@@ -710,6 +720,7 @@ const device_warning = z.discriminatedUnion('warning_code', [
710
720
  device_has_flaky_connection,
711
721
  salto_ks_office_mode,
712
722
  salto_ks_privacy_mode,
723
+ privacy_mode,
713
724
  salto_ks_subscription_limit_almost_reached,
714
725
  salto_ks_lock_access_code_support_removed,
715
726
  unknown_issue_with_phone,
@@ -762,6 +773,7 @@ export const device_warning_map = z.object({
762
773
  .nullable(),
763
774
  salto_ks_office_mode: salto_ks_office_mode.optional().nullable(),
764
775
  salto_ks_privacy_mode: salto_ks_privacy_mode.optional().nullable(),
776
+ privacy_mode: privacy_mode.optional().nullable(),
765
777
  salto_ks_subscription_limit_almost_reached:
766
778
  salto_ks_subscription_limit_almost_reached.optional().nullable(),
767
779
  salto_ks_lock_access_code_support_removed:
@@ -60,3 +60,18 @@ export const common_event_warning = z
60
60
  .describe(
61
61
  'Warning associated with the resource, including the warning code, message, and creation timestamp.',
62
62
  )
63
+
64
+ export const lock_access_denied_reason = z
65
+ .enum([
66
+ 'unknown_code',
67
+ 'expired_code',
68
+ 'blocklisted_code',
69
+ 'too_many_attempts',
70
+ 'blocked_by_privacy_mode',
71
+ 'credential_error',
72
+ ])
73
+ .describe(
74
+ 'Normalized reason a lock denied access. Provider-agnostic; not all providers report every value.',
75
+ )
76
+
77
+ export type LockAccessDeniedReason = z.infer<typeof lock_access_denied_reason>
@@ -6,6 +6,7 @@ import {
6
6
  common_event,
7
7
  common_event_error,
8
8
  common_event_warning,
9
+ lock_access_denied_reason,
9
10
  } from './common.js'
10
11
 
11
12
  const device_event = common_event.extend({
@@ -549,6 +550,17 @@ export const lock_access_denied_event = device_event.extend({
549
550
  .uuid()
550
551
  .optional()
551
552
  .describe('ID of the affected device.'),
553
+ reason: z
554
+ .object({
555
+ reason_code: lock_access_denied_reason,
556
+ message: z
557
+ .string()
558
+ .describe('Human-readable explanation of why access was denied.'),
559
+ })
560
+ .optional()
561
+ .describe(
562
+ 'Why access was denied, when the provider reports a determinable cause. Omitted when unknown.',
563
+ ),
552
564
  }).describe(`
553
565
  ---
554
566
  route_path: /locks