@seamapi/types 1.801.0 → 1.803.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 +107 -58
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +209 -19
  4. package/dist/index.cjs +107 -58
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +58 -0
  7. package/lib/seam/connect/models/access-codes/managed-access-code.js +9 -0
  8. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  9. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +21 -0
  10. package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
  11. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  12. package/lib/seam/connect/models/acs/acs-system.js +2 -2
  13. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  14. package/lib/seam/connect/models/batch.d.ts +58 -0
  15. package/lib/seam/connect/models/events/access-grants.js +1 -1
  16. package/lib/seam/connect/models/events/access-grants.js.map +1 -1
  17. package/lib/seam/connect/models/events/acs/entrances.js +2 -2
  18. package/lib/seam/connect/models/events/connect-webviews.js +3 -3
  19. package/lib/seam/connect/models/events/connected-accounts.js +1 -1
  20. package/lib/seam/connect/openapi.js +89 -47
  21. package/lib/seam/connect/openapi.js.map +1 -1
  22. package/lib/seam/connect/route-types.d.ts +96 -19
  23. package/package.json +1 -1
  24. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +14 -0
  25. package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
  26. package/src/lib/seam/connect/models/acs/acs-system.ts +2 -2
  27. package/src/lib/seam/connect/models/events/access-grants.ts +1 -1
  28. package/src/lib/seam/connect/models/events/acs/entrances.ts +2 -2
  29. package/src/lib/seam/connect/models/events/connect-webviews.ts +3 -3
  30. package/src/lib/seam/connect/models/events/connected-accounts.ts +1 -1
  31. package/src/lib/seam/connect/openapi.ts +97 -47
  32. package/src/lib/seam/connect/route-types.ts +107 -19
@@ -27,7 +27,7 @@ export type Routes = {
27
27
  common_code_key?: string | undefined;
28
28
  /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
29
29
  prefer_native_scheduling?: boolean | undefined;
30
- /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
30
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
31
31
  use_backup_access_code_pool?: boolean | undefined;
32
32
  /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
33
33
  allow_external_modification?: boolean | undefined;
@@ -1765,6 +1765,13 @@ export type Routes = {
1765
1765
  created_at?: string | undefined;
1766
1766
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1767
1767
  warning_code: 'schlage_creation_outage';
1768
+ } | {
1769
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1770
+ message: string;
1771
+ /** Date and time at which Seam created the warning. */
1772
+ created_at?: string | undefined;
1773
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1774
+ warning_code: 'schlage_access_code_ambiguous_timezone_dst_risk';
1768
1775
  } | {
1769
1776
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1770
1777
  message: string;
@@ -2393,6 +2400,13 @@ export type Routes = {
2393
2400
  created_at?: string | undefined;
2394
2401
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
2395
2402
  warning_code: 'schlage_creation_outage';
2403
+ } | {
2404
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
2405
+ message: string;
2406
+ /** Date and time at which Seam created the warning. */
2407
+ created_at?: string | undefined;
2408
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
2409
+ warning_code: 'schlage_access_code_ambiguous_timezone_dst_risk';
2396
2410
  } | {
2397
2411
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
2398
2412
  message: string;
@@ -4369,6 +4383,13 @@ export type Routes = {
4369
4383
  created_at?: string | undefined;
4370
4384
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4371
4385
  warning_code: 'schlage_creation_outage';
4386
+ } | {
4387
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4388
+ message: string;
4389
+ /** Date and time at which Seam created the warning. */
4390
+ created_at?: string | undefined;
4391
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4392
+ warning_code: 'schlage_access_code_ambiguous_timezone_dst_risk';
4372
4393
  } | {
4373
4394
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4374
4395
  message: string;
@@ -5045,6 +5066,13 @@ export type Routes = {
5045
5066
  created_at?: string | undefined;
5046
5067
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5047
5068
  warning_code: 'schlage_creation_outage';
5069
+ } | {
5070
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5071
+ message: string;
5072
+ /** Date and time at which Seam created the warning. */
5073
+ created_at?: string | undefined;
5074
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5075
+ warning_code: 'schlage_access_code_ambiguous_timezone_dst_risk';
5048
5076
  } | {
5049
5077
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5050
5078
  message: string;
@@ -5664,6 +5692,13 @@ export type Routes = {
5664
5692
  created_at?: string | undefined;
5665
5693
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5666
5694
  warning_code: 'schlage_creation_outage';
5695
+ } | {
5696
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5697
+ message: string;
5698
+ /** Date and time at which Seam created the warning. */
5699
+ created_at?: string | undefined;
5700
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5701
+ warning_code: 'schlage_access_code_ambiguous_timezone_dst_risk';
5667
5702
  } | {
5668
5703
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5669
5704
  message: string;
@@ -6260,6 +6295,13 @@ export type Routes = {
6260
6295
  created_at?: string | undefined;
6261
6296
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6262
6297
  warning_code: 'schlage_creation_outage';
6298
+ } | {
6299
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6300
+ message: string;
6301
+ /** Date and time at which Seam created the warning. */
6302
+ created_at?: string | undefined;
6303
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6304
+ warning_code: 'schlage_access_code_ambiguous_timezone_dst_risk';
6263
6305
  } | {
6264
6306
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6265
6307
  message: string;
@@ -6891,6 +6933,13 @@ export type Routes = {
6891
6933
  created_at?: string | undefined;
6892
6934
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6893
6935
  warning_code: 'schlage_creation_outage';
6936
+ } | {
6937
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6938
+ message: string;
6939
+ /** Date and time at which Seam created the warning. */
6940
+ created_at?: string | undefined;
6941
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6942
+ warning_code: 'schlage_access_code_ambiguous_timezone_dst_risk';
6894
6943
  } | {
6895
6944
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6896
6945
  message: string;
@@ -8774,6 +8823,13 @@ export type Routes = {
8774
8823
  created_at?: string | undefined;
8775
8824
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
8776
8825
  warning_code: 'schlage_creation_outage';
8826
+ } | {
8827
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
8828
+ message: string;
8829
+ /** Date and time at which Seam created the warning. */
8830
+ created_at?: string | undefined;
8831
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
8832
+ warning_code: 'schlage_access_code_ambiguous_timezone_dst_risk';
8777
8833
  } | {
8778
8834
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
8779
8835
  message: string;
@@ -9287,6 +9343,13 @@ export type Routes = {
9287
9343
  created_at?: string | undefined;
9288
9344
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
9289
9345
  warning_code: 'schlage_creation_outage';
9346
+ } | {
9347
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
9348
+ message: string;
9349
+ /** Date and time at which Seam created the warning. */
9350
+ created_at?: string | undefined;
9351
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
9352
+ warning_code: 'schlage_access_code_ambiguous_timezone_dst_risk';
9290
9353
  } | {
9291
9354
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
9292
9355
  message: string;
@@ -9456,7 +9519,7 @@ export type Routes = {
9456
9519
  attempt_for_offline_device?: boolean;
9457
9520
  /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
9458
9521
  prefer_native_scheduling?: boolean | undefined;
9459
- /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
9522
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). */
9460
9523
  use_backup_access_code_pool?: boolean | undefined;
9461
9524
  /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
9462
9525
  allow_external_modification?: boolean | undefined;
@@ -18015,7 +18078,7 @@ export type Routes = {
18015
18078
  jsonResponse: {
18016
18079
  /** Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
18017
18080
 
18018
- Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
18081
+ Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
18019
18082
 
18020
18083
  To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
18021
18084
  acs_access_group: {
@@ -36811,7 +36874,7 @@ export type Routes = {
36811
36874
  /** ID of the affected Access Grant. */
36812
36875
  access_grant_id: string;
36813
36876
  event_type: 'access_grant.access_granted_to_door';
36814
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
36877
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
36815
36878
  acs_entrance_id: string;
36816
36879
  } | {
36817
36880
  /** ID of the event. */
@@ -36825,7 +36888,7 @@ export type Routes = {
36825
36888
  /** ID of the affected Access Grant. */
36826
36889
  access_grant_id: string;
36827
36890
  event_type: 'access_grant.access_to_door_lost';
36828
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
36891
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
36829
36892
  acs_entrance_id: string;
36830
36893
  } | {
36831
36894
  /** ID of the event. */
@@ -37570,7 +37633,7 @@ export type Routes = {
37570
37633
  created_at: string;
37571
37634
  /** Date and time at which the event occurred. */
37572
37635
  occurred_at: string;
37573
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
37636
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
37574
37637
  connect_webview_id: string;
37575
37638
  event_type: 'connect_webview.login_succeeded';
37576
37639
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -37590,7 +37653,7 @@ export type Routes = {
37590
37653
  created_at: string;
37591
37654
  /** Date and time at which the event occurred. */
37592
37655
  occurred_at: string;
37593
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
37656
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
37594
37657
  connect_webview_id: string;
37595
37658
  event_type: 'connect_webview.login_failed';
37596
37659
  } | {
@@ -39639,7 +39702,7 @@ export type Routes = {
39639
39702
  /** ID of the affected Access Grant. */
39640
39703
  access_grant_id: string;
39641
39704
  event_type: 'access_grant.access_granted_to_door';
39642
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
39705
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
39643
39706
  acs_entrance_id: string;
39644
39707
  } | {
39645
39708
  /** ID of the event. */
@@ -39653,7 +39716,7 @@ export type Routes = {
39653
39716
  /** ID of the affected Access Grant. */
39654
39717
  access_grant_id: string;
39655
39718
  event_type: 'access_grant.access_to_door_lost';
39656
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
39719
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
39657
39720
  acs_entrance_id: string;
39658
39721
  } | {
39659
39722
  /** ID of the event. */
@@ -40398,7 +40461,7 @@ export type Routes = {
40398
40461
  created_at: string;
40399
40462
  /** Date and time at which the event occurred. */
40400
40463
  occurred_at: string;
40401
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
40464
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
40402
40465
  connect_webview_id: string;
40403
40466
  event_type: 'connect_webview.login_succeeded';
40404
40467
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -40418,7 +40481,7 @@ export type Routes = {
40418
40481
  created_at: string;
40419
40482
  /** Date and time at which the event occurred. */
40420
40483
  occurred_at: string;
40421
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
40484
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
40422
40485
  connect_webview_id: string;
40423
40486
  event_type: 'connect_webview.login_failed';
40424
40487
  } | {
@@ -64711,7 +64774,7 @@ export type Routes = {
64711
64774
  /** ID of the affected Access Grant. */
64712
64775
  access_grant_id: string;
64713
64776
  event_type: 'access_grant.access_granted_to_door';
64714
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
64777
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
64715
64778
  acs_entrance_id: string;
64716
64779
  } | {
64717
64780
  /** ID of the event. */
@@ -64725,7 +64788,7 @@ export type Routes = {
64725
64788
  /** ID of the affected Access Grant. */
64726
64789
  access_grant_id: string;
64727
64790
  event_type: 'access_grant.access_to_door_lost';
64728
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
64791
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
64729
64792
  acs_entrance_id: string;
64730
64793
  } | {
64731
64794
  /** ID of the event. */
@@ -65470,7 +65533,7 @@ export type Routes = {
65470
65533
  created_at: string;
65471
65534
  /** Date and time at which the event occurred. */
65472
65535
  occurred_at: string;
65473
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
65536
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
65474
65537
  connect_webview_id: string;
65475
65538
  event_type: 'connect_webview.login_succeeded';
65476
65539
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -65490,7 +65553,7 @@ export type Routes = {
65490
65553
  created_at: string;
65491
65554
  /** Date and time at which the event occurred. */
65492
65555
  occurred_at: string;
65493
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
65556
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
65494
65557
  connect_webview_id: string;
65495
65558
  event_type: 'connect_webview.login_failed';
65496
65559
  } | {
@@ -96976,7 +97039,7 @@ export type Routes = {
96976
97039
  /** ID of the affected Access Grant. */
96977
97040
  access_grant_id: string;
96978
97041
  event_type: 'access_grant.access_granted_to_door';
96979
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
97042
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
96980
97043
  acs_entrance_id: string;
96981
97044
  } | {
96982
97045
  /** ID of the event. */
@@ -96990,7 +97053,7 @@ export type Routes = {
96990
97053
  /** ID of the affected Access Grant. */
96991
97054
  access_grant_id: string;
96992
97055
  event_type: 'access_grant.access_to_door_lost';
96993
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
97056
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
96994
97057
  acs_entrance_id: string;
96995
97058
  } | {
96996
97059
  /** ID of the event. */
@@ -97735,7 +97798,7 @@ export type Routes = {
97735
97798
  created_at: string;
97736
97799
  /** Date and time at which the event occurred. */
97737
97800
  occurred_at: string;
97738
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
97801
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
97739
97802
  connect_webview_id: string;
97740
97803
  event_type: 'connect_webview.login_succeeded';
97741
97804
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -97755,7 +97818,7 @@ export type Routes = {
97755
97818
  created_at: string;
97756
97819
  /** Date and time at which the event occurred. */
97757
97820
  occurred_at: string;
97758
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
97821
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
97759
97822
  connect_webview_id: string;
97760
97823
  event_type: 'connect_webview.login_failed';
97761
97824
  } | {
@@ -99669,6 +99732,13 @@ export type Routes = {
99669
99732
  created_at?: string | undefined;
99670
99733
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99671
99734
  warning_code: 'schlage_creation_outage';
99735
+ } | {
99736
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99737
+ message: string;
99738
+ /** Date and time at which Seam created the warning. */
99739
+ created_at?: string | undefined;
99740
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
99741
+ warning_code: 'schlage_access_code_ambiguous_timezone_dst_risk';
99672
99742
  } | {
99673
99743
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
99674
99744
  message: string;
@@ -100166,6 +100236,13 @@ export type Routes = {
100166
100236
  created_at?: string | undefined;
100167
100237
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
100168
100238
  warning_code: 'schlage_creation_outage';
100239
+ } | {
100240
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
100241
+ message: string;
100242
+ /** Date and time at which Seam created the warning. */
100243
+ created_at?: string | undefined;
100244
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
100245
+ warning_code: 'schlage_access_code_ambiguous_timezone_dst_risk';
100169
100246
  } | {
100170
100247
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
100171
100248
  message: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.801.0",
3
+ "version": "1.803.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -368,6 +368,17 @@ const schlage_creation_outage = common_access_code_warning
368
368
  })
369
369
  .describe('Received an error when attempting to create this code.')
370
370
 
371
+ const schlage_access_code_ambiguous_timezone_dst_risk =
372
+ common_access_code_warning
373
+ .extend({
374
+ warning_code: z
375
+ .literal('schlage_access_code_ambiguous_timezone_dst_risk')
376
+ .describe(warning_code_description),
377
+ })
378
+ .describe(
379
+ "The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift — the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.",
380
+ )
381
+
371
382
  const delay_in_setting_on_device = common_access_code_warning
372
383
  .extend({
373
384
  warning_code: z
@@ -449,6 +460,7 @@ const access_code_warning = z
449
460
  smartthings_failed_to_set_access_code_warning,
450
461
  schlage_detected_duplicate,
451
462
  schlage_creation_outage,
463
+ schlage_access_code_ambiguous_timezone_dst_risk,
452
464
  code_modified_external_to_seam_warning,
453
465
  delay_in_setting_on_device,
454
466
  delay_in_removing_from_device,
@@ -473,6 +485,8 @@ const _access_code_warning_map = z.object({
473
485
  smartthings_failed_to_set_access_code_warning.optional().nullable(),
474
486
  schlage_detected_duplicate: schlage_detected_duplicate.optional().nullable(),
475
487
  schlage_creation_outage: schlage_creation_outage.optional().nullable(),
488
+ schlage_access_code_ambiguous_timezone_dst_risk:
489
+ schlage_access_code_ambiguous_timezone_dst_risk.optional().nullable(),
476
490
  code_modified_external_to_seam_warning: code_modified_external_to_seam_warning
477
491
  .optional()
478
492
  .nullable(),
@@ -41,7 +41,7 @@ const acs_access_groups_failed_to_create_on_acs_system =
41
41
  .describe(error_code_description),
42
42
  })
43
43
  .describe(
44
- `Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
44
+ `Indicates that the [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/latest/capability-guides/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).`,
45
45
  )
46
46
 
47
47
  const acs_access_group_errors = z
@@ -176,7 +176,7 @@ export const acs_access_group = common_acs_access_group.extend({
176
176
  ---
177
177
  Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
178
178
 
179
- Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
179
+ Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
180
180
 
181
181
  To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).
182
182
  `)
@@ -75,7 +75,7 @@ const visionline_instance_unreachable = common_acs_system_error.extend({
75
75
  })
76
76
  .describe(`Indicates that [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) is functioning correctly and the Seam API can communicate with Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
77
77
  For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
78
- See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`)
78
+ See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`)
79
79
 
80
80
  const salto_ks_subscription_limit_exceeded = common_acs_system_error
81
81
  .extend({
@@ -104,7 +104,7 @@ const account_disconnected = common_acs_system_error
104
104
  .describe(error_code_description),
105
105
  })
106
106
  .describe(
107
- 'Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) to restore access.',
107
+ 'Indicates that the login credentials are invalid. Reconnect the account using a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) to restore access.',
108
108
  )
109
109
 
110
110
  const salto_ks_certification_expired = common_acs_system_error
@@ -45,7 +45,7 @@ const acs_entrance_id = z
45
45
  .string()
46
46
  .uuid()
47
47
  .describe(
48
- 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
48
+ 'ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
49
49
  )
50
50
 
51
51
  export const access_grant_access_granted_to_door_event =
@@ -14,7 +14,7 @@ export const acs_entrance_added_event = acs_entrance_event.extend({
14
14
  ---
15
15
  route_path: /acs/entrances
16
16
  ---
17
- An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was added.
17
+ An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was added.
18
18
  `)
19
19
 
20
20
  export const acs_entrance_removed_event = acs_entrance_event.extend({
@@ -23,7 +23,7 @@ export const acs_entrance_removed_event = acs_entrance_event.extend({
23
23
  ---
24
24
  route_path: /acs/entrances
25
25
  ---
26
- An [access system entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details) was removed.
26
+ An [access system entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was removed.
27
27
  `)
28
28
 
29
29
  export type AcsUserDeletedEvent = z.infer<typeof acs_entrance_removed_event>
@@ -8,7 +8,7 @@ const connect_webview_event = common_event.extend({
8
8
  .string()
9
9
  .uuid()
10
10
  .describe(
11
- 'ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).',
11
+ 'ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).',
12
12
  ),
13
13
  })
14
14
 
@@ -40,7 +40,7 @@ export const connect_webview_login_succeeded_event =
40
40
  ---
41
41
  route_path: /connect_webviews
42
42
  ---
43
- A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login succeeded.
43
+ A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login succeeded.
44
44
  `)
45
45
 
46
46
  export type ConnectWebviewLoginSucceededEvent = z.infer<
@@ -53,7 +53,7 @@ export const connect_webview_login_failed_event = connect_webview_event.extend({
53
53
  ---
54
54
  route_path: /connect_webviews
55
55
  ---
56
- A [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews) login failed.
56
+ A [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) login failed.
57
57
  `)
58
58
 
59
59
  export type ConnectWebviewLoginFailedEvent = z.infer<
@@ -82,7 +82,7 @@ export const connected_account_successful_login_event =
82
82
  deprecated: Use \`connect_webview.login_succeeded\`.
83
83
  route_path: /connected_accounts
84
84
  ---
85
- A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews).
85
+ A [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) had a successful login using a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
86
86
  `)
87
87
 
88
88
  /** @deprecated Rely on ConnectWebviewLoginSucceededEvent instead */