@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.
@@ -137607,7 +137607,7 @@ type Routes = {
137607
137607
  common_code_key?: string | undefined;
137608
137608
  /** 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`. */
137609
137609
  prefer_native_scheduling?: boolean | undefined;
137610
- /** 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). */
137610
+ /** 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). */
137611
137611
  use_backup_access_code_pool?: boolean | undefined;
137612
137612
  /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
137613
137613
  allow_external_modification?: boolean | undefined;
@@ -147099,7 +147099,7 @@ type Routes = {
147099
147099
  attempt_for_offline_device?: boolean;
147100
147100
  /** 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`. */
147101
147101
  prefer_native_scheduling?: boolean | undefined;
147102
- /** 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). */
147102
+ /** 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). */
147103
147103
  use_backup_access_code_pool?: boolean | undefined;
147104
147104
  /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
147105
147105
  allow_external_modification?: boolean | undefined;
@@ -155658,7 +155658,7 @@ type Routes = {
155658
155658
  jsonResponse: {
155659
155659
  /** 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.
155660
155660
 
155661
- 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.
155661
+ 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.
155662
155662
 
155663
155663
  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). */
155664
155664
  acs_access_group: {
@@ -174454,7 +174454,7 @@ type Routes = {
174454
174454
  /** ID of the affected Access Grant. */
174455
174455
  access_grant_id: string;
174456
174456
  event_type: 'access_grant.access_granted_to_door';
174457
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
174457
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
174458
174458
  acs_entrance_id: string;
174459
174459
  } | {
174460
174460
  /** ID of the event. */
@@ -174468,7 +174468,7 @@ type Routes = {
174468
174468
  /** ID of the affected Access Grant. */
174469
174469
  access_grant_id: string;
174470
174470
  event_type: 'access_grant.access_to_door_lost';
174471
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
174471
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
174472
174472
  acs_entrance_id: string;
174473
174473
  } | {
174474
174474
  /** ID of the event. */
@@ -175213,7 +175213,7 @@ type Routes = {
175213
175213
  created_at: string;
175214
175214
  /** Date and time at which the event occurred. */
175215
175215
  occurred_at: string;
175216
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
175216
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
175217
175217
  connect_webview_id: string;
175218
175218
  event_type: 'connect_webview.login_succeeded';
175219
175219
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -175233,7 +175233,7 @@ type Routes = {
175233
175233
  created_at: string;
175234
175234
  /** Date and time at which the event occurred. */
175235
175235
  occurred_at: string;
175236
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
175236
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
175237
175237
  connect_webview_id: string;
175238
175238
  event_type: 'connect_webview.login_failed';
175239
175239
  } | {
@@ -177282,7 +177282,7 @@ type Routes = {
177282
177282
  /** ID of the affected Access Grant. */
177283
177283
  access_grant_id: string;
177284
177284
  event_type: 'access_grant.access_granted_to_door';
177285
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
177285
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
177286
177286
  acs_entrance_id: string;
177287
177287
  } | {
177288
177288
  /** ID of the event. */
@@ -177296,7 +177296,7 @@ type Routes = {
177296
177296
  /** ID of the affected Access Grant. */
177297
177297
  access_grant_id: string;
177298
177298
  event_type: 'access_grant.access_to_door_lost';
177299
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
177299
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
177300
177300
  acs_entrance_id: string;
177301
177301
  } | {
177302
177302
  /** ID of the event. */
@@ -178041,7 +178041,7 @@ type Routes = {
178041
178041
  created_at: string;
178042
178042
  /** Date and time at which the event occurred. */
178043
178043
  occurred_at: string;
178044
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
178044
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
178045
178045
  connect_webview_id: string;
178046
178046
  event_type: 'connect_webview.login_succeeded';
178047
178047
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -178061,7 +178061,7 @@ type Routes = {
178061
178061
  created_at: string;
178062
178062
  /** Date and time at which the event occurred. */
178063
178063
  occurred_at: string;
178064
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
178064
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
178065
178065
  connect_webview_id: string;
178066
178066
  event_type: 'connect_webview.login_failed';
178067
178067
  } | {
@@ -202354,7 +202354,7 @@ type Routes = {
202354
202354
  /** ID of the affected Access Grant. */
202355
202355
  access_grant_id: string;
202356
202356
  event_type: 'access_grant.access_granted_to_door';
202357
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
202357
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
202358
202358
  acs_entrance_id: string;
202359
202359
  } | {
202360
202360
  /** ID of the event. */
@@ -202368,7 +202368,7 @@ type Routes = {
202368
202368
  /** ID of the affected Access Grant. */
202369
202369
  access_grant_id: string;
202370
202370
  event_type: 'access_grant.access_to_door_lost';
202371
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
202371
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
202372
202372
  acs_entrance_id: string;
202373
202373
  } | {
202374
202374
  /** ID of the event. */
@@ -203113,7 +203113,7 @@ type Routes = {
203113
203113
  created_at: string;
203114
203114
  /** Date and time at which the event occurred. */
203115
203115
  occurred_at: string;
203116
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
203116
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
203117
203117
  connect_webview_id: string;
203118
203118
  event_type: 'connect_webview.login_succeeded';
203119
203119
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -203133,7 +203133,7 @@ type Routes = {
203133
203133
  created_at: string;
203134
203134
  /** Date and time at which the event occurred. */
203135
203135
  occurred_at: string;
203136
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
203136
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
203137
203137
  connect_webview_id: string;
203138
203138
  event_type: 'connect_webview.login_failed';
203139
203139
  } | {
@@ -234619,7 +234619,7 @@ type Routes = {
234619
234619
  /** ID of the affected Access Grant. */
234620
234620
  access_grant_id: string;
234621
234621
  event_type: 'access_grant.access_granted_to_door';
234622
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
234622
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
234623
234623
  acs_entrance_id: string;
234624
234624
  } | {
234625
234625
  /** ID of the event. */
@@ -234633,7 +234633,7 @@ type Routes = {
234633
234633
  /** ID of the affected Access Grant. */
234634
234634
  access_grant_id: string;
234635
234635
  event_type: 'access_grant.access_to_door_lost';
234636
- /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
234636
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
234637
234637
  acs_entrance_id: string;
234638
234638
  } | {
234639
234639
  /** ID of the event. */
@@ -235378,7 +235378,7 @@ type Routes = {
235378
235378
  created_at: string;
235379
235379
  /** Date and time at which the event occurred. */
235380
235380
  occurred_at: string;
235381
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
235381
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
235382
235382
  connect_webview_id: string;
235383
235383
  event_type: 'connect_webview.login_succeeded';
235384
235384
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
@@ -235398,7 +235398,7 @@ type Routes = {
235398
235398
  created_at: string;
235399
235399
  /** Date and time at which the event occurred. */
235400
235400
  occurred_at: string;
235401
- /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
235401
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews). */
235402
235402
  connect_webview_id: string;
235403
235403
  event_type: 'connect_webview.login_failed';
235404
235404
  } | {