@seamapi/types 1.802.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.
@@ -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;
@@ -9519,7 +9519,7 @@ export type Routes = {
9519
9519
  attempt_for_offline_device?: boolean;
9520
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`. */
9521
9521
  prefer_native_scheduling?: boolean | undefined;
9522
- /** 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). */
9523
9523
  use_backup_access_code_pool?: boolean | undefined;
9524
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`. */
9525
9525
  allow_external_modification?: boolean | undefined;
@@ -18078,7 +18078,7 @@ export type Routes = {
18078
18078
  jsonResponse: {
18079
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.
18080
18080
 
18081
- 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.
18082
18082
 
18083
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). */
18084
18084
  acs_access_group: {
@@ -36874,7 +36874,7 @@ export type Routes = {
36874
36874
  /** ID of the affected Access Grant. */
36875
36875
  access_grant_id: string;
36876
36876
  event_type: 'access_grant.access_granted_to_door';
36877
- /** 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). */
36878
36878
  acs_entrance_id: string;
36879
36879
  } | {
36880
36880
  /** ID of the event. */
@@ -36888,7 +36888,7 @@ export type Routes = {
36888
36888
  /** ID of the affected Access Grant. */
36889
36889
  access_grant_id: string;
36890
36890
  event_type: 'access_grant.access_to_door_lost';
36891
- /** 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). */
36892
36892
  acs_entrance_id: string;
36893
36893
  } | {
36894
36894
  /** ID of the event. */
@@ -37633,7 +37633,7 @@ export type Routes = {
37633
37633
  created_at: string;
37634
37634
  /** Date and time at which the event occurred. */
37635
37635
  occurred_at: string;
37636
- /** 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). */
37637
37637
  connect_webview_id: string;
37638
37638
  event_type: 'connect_webview.login_succeeded';
37639
37639
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -37653,7 +37653,7 @@ export type Routes = {
37653
37653
  created_at: string;
37654
37654
  /** Date and time at which the event occurred. */
37655
37655
  occurred_at: string;
37656
- /** 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). */
37657
37657
  connect_webview_id: string;
37658
37658
  event_type: 'connect_webview.login_failed';
37659
37659
  } | {
@@ -39702,7 +39702,7 @@ export type Routes = {
39702
39702
  /** ID of the affected Access Grant. */
39703
39703
  access_grant_id: string;
39704
39704
  event_type: 'access_grant.access_granted_to_door';
39705
- /** 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). */
39706
39706
  acs_entrance_id: string;
39707
39707
  } | {
39708
39708
  /** ID of the event. */
@@ -39716,7 +39716,7 @@ export type Routes = {
39716
39716
  /** ID of the affected Access Grant. */
39717
39717
  access_grant_id: string;
39718
39718
  event_type: 'access_grant.access_to_door_lost';
39719
- /** 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). */
39720
39720
  acs_entrance_id: string;
39721
39721
  } | {
39722
39722
  /** ID of the event. */
@@ -40461,7 +40461,7 @@ export type Routes = {
40461
40461
  created_at: string;
40462
40462
  /** Date and time at which the event occurred. */
40463
40463
  occurred_at: string;
40464
- /** 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). */
40465
40465
  connect_webview_id: string;
40466
40466
  event_type: 'connect_webview.login_succeeded';
40467
40467
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -40481,7 +40481,7 @@ export type Routes = {
40481
40481
  created_at: string;
40482
40482
  /** Date and time at which the event occurred. */
40483
40483
  occurred_at: string;
40484
- /** 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). */
40485
40485
  connect_webview_id: string;
40486
40486
  event_type: 'connect_webview.login_failed';
40487
40487
  } | {
@@ -64774,7 +64774,7 @@ export type Routes = {
64774
64774
  /** ID of the affected Access Grant. */
64775
64775
  access_grant_id: string;
64776
64776
  event_type: 'access_grant.access_granted_to_door';
64777
- /** 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). */
64778
64778
  acs_entrance_id: string;
64779
64779
  } | {
64780
64780
  /** ID of the event. */
@@ -64788,7 +64788,7 @@ export type Routes = {
64788
64788
  /** ID of the affected Access Grant. */
64789
64789
  access_grant_id: string;
64790
64790
  event_type: 'access_grant.access_to_door_lost';
64791
- /** 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). */
64792
64792
  acs_entrance_id: string;
64793
64793
  } | {
64794
64794
  /** ID of the event. */
@@ -65533,7 +65533,7 @@ export type Routes = {
65533
65533
  created_at: string;
65534
65534
  /** Date and time at which the event occurred. */
65535
65535
  occurred_at: string;
65536
- /** 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). */
65537
65537
  connect_webview_id: string;
65538
65538
  event_type: 'connect_webview.login_succeeded';
65539
65539
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -65553,7 +65553,7 @@ export type Routes = {
65553
65553
  created_at: string;
65554
65554
  /** Date and time at which the event occurred. */
65555
65555
  occurred_at: string;
65556
- /** 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). */
65557
65557
  connect_webview_id: string;
65558
65558
  event_type: 'connect_webview.login_failed';
65559
65559
  } | {
@@ -97039,7 +97039,7 @@ export type Routes = {
97039
97039
  /** ID of the affected Access Grant. */
97040
97040
  access_grant_id: string;
97041
97041
  event_type: 'access_grant.access_granted_to_door';
97042
- /** 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). */
97043
97043
  acs_entrance_id: string;
97044
97044
  } | {
97045
97045
  /** ID of the event. */
@@ -97053,7 +97053,7 @@ export type Routes = {
97053
97053
  /** ID of the affected Access Grant. */
97054
97054
  access_grant_id: string;
97055
97055
  event_type: 'access_grant.access_to_door_lost';
97056
- /** 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). */
97057
97057
  acs_entrance_id: string;
97058
97058
  } | {
97059
97059
  /** ID of the event. */
@@ -97798,7 +97798,7 @@ export type Routes = {
97798
97798
  created_at: string;
97799
97799
  /** Date and time at which the event occurred. */
97800
97800
  occurred_at: string;
97801
- /** 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). */
97802
97802
  connect_webview_id: string;
97803
97803
  event_type: 'connect_webview.login_succeeded';
97804
97804
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -97818,7 +97818,7 @@ export type Routes = {
97818
97818
  created_at: string;
97819
97819
  /** Date and time at which the event occurred. */
97820
97820
  occurred_at: string;
97821
- /** 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). */
97822
97822
  connect_webview_id: string;
97823
97823
  event_type: 'connect_webview.login_failed';
97824
97824
  } | {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.802.0",
3
+ "version": "1.803.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -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 */