@seamapi/types 1.460.0 → 1.461.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.
@@ -9955,6 +9955,8 @@ export interface Routes {
9955
9955
  location_ids?: string[] | undefined;
9956
9956
  /** Set of IDs of existing spaces to which access is being granted. */
9957
9957
  space_ids?: string[] | undefined;
9958
+ /** Set of keys of existing spaces to which access is being granted. */
9959
+ space_keys?: string[] | undefined;
9958
9960
  /** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
9959
9961
  location?: {
9960
9962
  /** Name of the location. */
@@ -10105,88 +10107,13 @@ export interface Routes {
10105
10107
  commonParams: {
10106
10108
  /** IDs of the access grants that you want to get along with their related resources. */
10107
10109
  access_grant_ids: string[];
10108
- include?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
10109
- exclude?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
10110
+ include?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identity'> | undefined;
10111
+ exclude?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identity'> | undefined;
10110
10112
  };
10111
10113
  formData: {};
10112
10114
  jsonResponse: {
10113
- /** Represents a resource batch. */
10114
10115
  batch: {
10115
- batch_type: 'workspaces' | 'access_grants' | 'access_methods' | 'spaces';
10116
- user_identities?: Array<{
10117
- /** ID of the user identity. */
10118
- user_identity_id: string;
10119
- /** Unique key for the user identity. */
10120
- user_identity_key: string | null;
10121
- /** Unique email address for the user identity. */
10122
- email_address: string | null;
10123
- /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
10124
- phone_number: string | null;
10125
- display_name: string;
10126
- full_name: string | null;
10127
- /** Date and time at which the user identity was created. */
10128
- created_at: string;
10129
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
10130
- workspace_id: string;
10131
- /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
10132
- errors: Array<{
10133
- /** Date and time at which Seam created the error. */
10134
- created_at: string;
10135
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
10136
- message: string;
10137
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
10138
- error_code: 'issue_with_acs_user';
10139
- /** ID of the access system user that has an issue. */
10140
- acs_user_id: string;
10141
- /** ID of the access system that the user identity is associated with. */
10142
- acs_system_id: string;
10143
- }>;
10144
- /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
10145
- warnings: Array<{
10146
- /** Date and time at which Seam created the warning. */
10147
- created_at: string;
10148
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
10149
- message: string;
10150
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
10151
- warning_code: 'being_deleted';
10152
- } | {
10153
- /** Date and time at which Seam created the warning. */
10154
- created_at: string;
10155
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
10156
- message: string;
10157
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
10158
- warning_code: 'acs_user_profile_does_not_match_user_identity';
10159
- }>;
10160
- /** Array of access system user IDs associated with the user identity. */
10161
- acs_user_ids: string[];
10162
- }> | undefined;
10163
- workspaces?: Array<{
10164
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
10165
- workspace_id: string;
10166
- /** Name of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
10167
- name: string;
10168
- /** Company name associated with the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
10169
- company_name: string;
10170
- /** Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). */
10171
- is_sandbox: boolean;
10172
- connect_webview_customization: {
10173
- /** Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
10174
- primary_button_color?: string | undefined;
10175
- /** Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
10176
- primary_button_text_color?: string | undefined;
10177
- /** Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
10178
- success_message?: string | undefined;
10179
- /** Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
10180
- logo_shape?: ('circle' | 'square') | undefined;
10181
- /** URL of the inviter logo for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
10182
- inviter_logo_url?: string | undefined;
10183
- };
10184
- /** Indicates whether the [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days. */
10185
- is_suspended: boolean;
10186
- /**
10187
- * @deprecated Use `company_name` instead. */
10188
- connect_partner_name: (string | null) | null;
10189
- }> | undefined;
10116
+ batch_type: 'access_grants';
10190
10117
  spaces?: Array<{
10191
10118
  /** ID of the space. */
10192
10119
  space_id: string;
@@ -11511,6 +11438,299 @@ export interface Routes {
11511
11438
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
11512
11439
  can_unlock_with_code?: boolean | undefined;
11513
11440
  }> | undefined;
11441
+ user_identities?: Array<{
11442
+ /** ID of the user identity. */
11443
+ user_identity_id: string;
11444
+ /** Unique key for the user identity. */
11445
+ user_identity_key: string | null;
11446
+ /** Unique email address for the user identity. */
11447
+ email_address: string | null;
11448
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
11449
+ phone_number: string | null;
11450
+ display_name: string;
11451
+ full_name: string | null;
11452
+ /** Date and time at which the user identity was created. */
11453
+ created_at: string;
11454
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
11455
+ workspace_id: string;
11456
+ /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
11457
+ errors: Array<{
11458
+ /** Date and time at which Seam created the error. */
11459
+ created_at: string;
11460
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11461
+ message: string;
11462
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11463
+ error_code: 'issue_with_acs_user';
11464
+ /** ID of the access system user that has an issue. */
11465
+ acs_user_id: string;
11466
+ /** ID of the access system that the user identity is associated with. */
11467
+ acs_system_id: string;
11468
+ }>;
11469
+ /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
11470
+ warnings: Array<{
11471
+ /** Date and time at which Seam created the warning. */
11472
+ created_at: string;
11473
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11474
+ message: string;
11475
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11476
+ warning_code: 'being_deleted';
11477
+ } | {
11478
+ /** Date and time at which Seam created the warning. */
11479
+ created_at: string;
11480
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11481
+ message: string;
11482
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11483
+ warning_code: 'acs_user_profile_does_not_match_user_identity';
11484
+ }>;
11485
+ /** Array of access system user IDs associated with the user identity. */
11486
+ acs_user_ids: string[];
11487
+ }> | undefined;
11488
+ connected_accounts?: Array<{
11489
+ /** ID of the connected account. */
11490
+ connected_account_id?: string | undefined;
11491
+ /** Date and time at which the connected account was created. */
11492
+ created_at?: string | undefined;
11493
+ /** User identifier associated with the connected account. */
11494
+ user_identifier?: {
11495
+ /** Username of the user identifier associated with the connected account. */
11496
+ username?: string | undefined;
11497
+ /** API URL for the user identifier associated with the connected account. */
11498
+ api_url?: string | undefined;
11499
+ /** Email address of the user identifier associated with the connected account. */
11500
+ email?: string | undefined;
11501
+ /** Phone number of the user identifier associated with the connected account. */
11502
+ phone?: string | undefined;
11503
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
11504
+ exclusive?: boolean | undefined;
11505
+ } | undefined;
11506
+ /** Type of connected account. */
11507
+ account_type?: string | undefined;
11508
+ /** Display name for the connected account type. */
11509
+ account_type_display_name: string;
11510
+ /** Errors associated with the connected account. */
11511
+ errors: Array<{
11512
+ /** Date and time at which Seam created the error. */
11513
+ created_at: string;
11514
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11515
+ message: string;
11516
+ /** Indicates whether the error is related specifically to the connected account. */
11517
+ is_connected_account_error?: boolean | undefined;
11518
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
11519
+ is_bridge_error?: boolean | undefined;
11520
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11521
+ error_code: 'account_disconnected';
11522
+ } | {
11523
+ /** Date and time at which Seam created the error. */
11524
+ created_at: string;
11525
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11526
+ message: string;
11527
+ /** Indicates whether the error is related specifically to the connected account. */
11528
+ is_connected_account_error?: boolean | undefined;
11529
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
11530
+ is_bridge_error?: boolean | undefined;
11531
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11532
+ error_code: 'invalid_credentials';
11533
+ } | {
11534
+ /** Date and time at which Seam created the error. */
11535
+ created_at: string;
11536
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11537
+ message: string;
11538
+ /** Indicates whether the error is related specifically to the connected account. */
11539
+ is_connected_account_error?: boolean | undefined;
11540
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
11541
+ is_bridge_error?: boolean | undefined;
11542
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11543
+ error_code: 'bridge_disconnected';
11544
+ } | {
11545
+ /** Date and time at which Seam created the error. */
11546
+ created_at: string;
11547
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11548
+ message: string;
11549
+ /** Indicates whether the error is related specifically to the connected account. */
11550
+ is_connected_account_error?: boolean | undefined;
11551
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
11552
+ is_bridge_error?: boolean | undefined;
11553
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11554
+ error_code: 'salto_ks_subscription_limit_exceeded';
11555
+ /** Salto KS metadata associated with the connected account that has an error. */
11556
+ salto_ks_metadata: {
11557
+ /** Salto sites associated with the connected account that has an error. */
11558
+ sites: Array<{
11559
+ /** ID of a Salto site associated with the connected account that has an error. */
11560
+ site_id: string;
11561
+ /** Name of a Salto site associated with the connected account that has an error. */
11562
+ site_name: string;
11563
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
11564
+ subscribed_site_user_count: number;
11565
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
11566
+ site_user_subscription_limit: number;
11567
+ }>;
11568
+ };
11569
+ }>;
11570
+ /** Warnings associated with the connected account. */
11571
+ warnings: Array<{
11572
+ /** Date and time at which Seam created the warning. */
11573
+ created_at: string;
11574
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11575
+ message: string;
11576
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11577
+ warning_code: 'scheduled_maintenance_window';
11578
+ } | {
11579
+ /** Date and time at which Seam created the warning. */
11580
+ created_at: string;
11581
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11582
+ message: string;
11583
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11584
+ warning_code: 'unknown_issue_with_connected_account';
11585
+ } | {
11586
+ /** Date and time at which Seam created the warning. */
11587
+ created_at: string;
11588
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11589
+ message: string;
11590
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11591
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
11592
+ /** Salto KS metadata associated with the connected account that has a warning. */
11593
+ salto_ks_metadata: {
11594
+ /** Salto sites associated with the connected account that has a warning. */
11595
+ sites: Array<{
11596
+ /** ID of a Salto site associated with the connected account that has a warning. */
11597
+ site_id: string;
11598
+ /** Name of a Salto site associated with the connected account that has a warning. */
11599
+ site_name: string;
11600
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
11601
+ site_user_subscription_limit: number;
11602
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
11603
+ subscribed_site_user_count: number;
11604
+ }>;
11605
+ };
11606
+ }>;
11607
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
11608
+ custom_metadata: Record<string, string | boolean>;
11609
+ /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API. */
11610
+ automatically_manage_new_devices: boolean;
11611
+ /** Your unique key for the customer associated with this connected account. */
11612
+ customer_key?: string | undefined;
11613
+ /** List of capabilities that were accepted during the account connection process. */
11614
+ accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
11615
+ }> | undefined;
11616
+ acs_systems?: Array<{
11617
+ /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11618
+ default_credential_manager_acs_system_id?: (string | null) | undefined;
11619
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11620
+ acs_system_id: string;
11621
+ acs_user_count?: number | undefined;
11622
+ acs_access_group_count?: number | undefined;
11623
+ /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
11624
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
11625
+ /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
11626
+ external_type_display_name?: string | undefined;
11627
+ /** Indicates whether the `acs_system` is a credential manager. */
11628
+ is_credential_manager: boolean;
11629
+ visionline_metadata?: {
11630
+ /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
11631
+ mobile_access_uuid: string;
11632
+ /** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
11633
+ system_id: string;
11634
+ /** IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network. */
11635
+ lan_address: string;
11636
+ } | undefined;
11637
+ /**
11638
+ * @deprecated Use `external_type`. */
11639
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
11640
+ /**
11641
+ * @deprecated Use `external_type_display_name`. */
11642
+ system_type_display_name?: string | undefined;
11643
+ location: {
11644
+ /** Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. */
11645
+ time_zone: string | null;
11646
+ };
11647
+ /** Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11648
+ name: string;
11649
+ /** Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. */
11650
+ created_at: string;
11651
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11652
+ workspace_id: string;
11653
+ /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
11654
+ * @deprecated Use `connected_account_id`. */
11655
+ connected_account_ids: string[];
11656
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11657
+ connected_account_id: string;
11658
+ /** URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11659
+ image_url: string;
11660
+ /** Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. */
11661
+ image_alt_text: string;
11662
+ /** Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11663
+ errors: Array<{
11664
+ /** Date and time at which Seam created the error. */
11665
+ created_at: string;
11666
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11667
+ message: string;
11668
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11669
+ error_code: 'seam_bridge_disconnected';
11670
+ } | {
11671
+ /** Date and time at which Seam created the error. */
11672
+ created_at: string;
11673
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11674
+ message: string;
11675
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11676
+ error_code: 'bridge_disconnected';
11677
+ is_bridge_error?: boolean | undefined;
11678
+ } | {
11679
+ /** Date and time at which Seam created the error. */
11680
+ created_at: string;
11681
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11682
+ message: string;
11683
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11684
+ error_code: 'visionline_instance_unreachable';
11685
+ } | {
11686
+ /** Date and time at which Seam created the error. */
11687
+ created_at: string;
11688
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11689
+ message: string;
11690
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11691
+ error_code: 'salto_ks_subscription_limit_exceeded';
11692
+ } | {
11693
+ /** Date and time at which Seam created the error. */
11694
+ created_at: string;
11695
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11696
+ message: string;
11697
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11698
+ error_code: 'acs_system_disconnected';
11699
+ } | {
11700
+ /** Date and time at which Seam created the error. */
11701
+ created_at: string;
11702
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11703
+ message: string;
11704
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11705
+ error_code: 'account_disconnected';
11706
+ } | {
11707
+ /** Date and time at which Seam created the error. */
11708
+ created_at: string;
11709
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11710
+ message: string;
11711
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11712
+ error_code: 'salto_ks_certification_expired';
11713
+ }>;
11714
+ /** Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
11715
+ warnings: Array<{
11716
+ /** Date and time at which Seam created the warning. */
11717
+ created_at: string;
11718
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11719
+ message: string;
11720
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11721
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
11722
+ } | {
11723
+ /** Date and time at which Seam created the warning. */
11724
+ created_at: string;
11725
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11726
+ message: string;
11727
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11728
+ warning_code: 'time_zone_does_not_match_location';
11729
+ /**
11730
+ * @deprecated this field is deprecated. */
11731
+ misconfigured_acs_entrance_ids?: string[] | undefined;
11732
+ }>;
11733
+ }> | undefined;
11514
11734
  };
11515
11735
  };
11516
11736
  };
@@ -25197,8 +25417,8 @@ export interface Routes {
25197
25417
  }> | undefined;
25198
25418
  /** List of reservations. */
25199
25419
  reservations?: Array<{
25200
- /** Your display name for this access grant resource. */
25201
- name: string;
25420
+ /** Your name for this access grant resource. */
25421
+ name?: string | undefined;
25202
25422
  /** Starting date and time for the access grant. */
25203
25423
  starts_at?: string | undefined;
25204
25424
  /** Ending date and time for the access grant. */
@@ -25234,8 +25454,8 @@ export interface Routes {
25234
25454
  }> | undefined;
25235
25455
  /** List of bookings. */
25236
25456
  bookings?: Array<{
25237
- /** Your display name for this access grant resource. */
25238
- name: string;
25457
+ /** Your name for this access grant resource. */
25458
+ name?: string | undefined;
25239
25459
  /** Starting date and time for the access grant. */
25240
25460
  starts_at?: string | undefined;
25241
25461
  /** Ending date and time for the access grant. */
@@ -25271,8 +25491,8 @@ export interface Routes {
25271
25491
  }> | undefined;
25272
25492
  /** List of access grants. */
25273
25493
  access_grants?: Array<{
25274
- /** Your display name for this access grant resource. */
25275
- name: string;
25494
+ /** Your name for this access grant resource. */
25495
+ name?: string | undefined;
25276
25496
  /** Starting date and time for the access grant. */
25277
25497
  starts_at?: string | undefined;
25278
25498
  /** Ending date and time for the access grant. */
@@ -25457,8 +25677,8 @@ export interface Routes {
25457
25677
  }> | undefined;
25458
25678
  /** List of reservations. */
25459
25679
  reservations?: Array<{
25460
- /** Your display name for this access grant resource. */
25461
- name: string;
25680
+ /** Your name for this access grant resource. */
25681
+ name?: string | undefined;
25462
25682
  /** Starting date and time for the access grant. */
25463
25683
  starts_at?: string | undefined;
25464
25684
  /** Ending date and time for the access grant. */
@@ -25494,8 +25714,8 @@ export interface Routes {
25494
25714
  }> | undefined;
25495
25715
  /** List of bookings. */
25496
25716
  bookings?: Array<{
25497
- /** Your display name for this access grant resource. */
25498
- name: string;
25717
+ /** Your name for this access grant resource. */
25718
+ name?: string | undefined;
25499
25719
  /** Starting date and time for the access grant. */
25500
25720
  starts_at?: string | undefined;
25501
25721
  /** Ending date and time for the access grant. */
@@ -25531,8 +25751,8 @@ export interface Routes {
25531
25751
  }> | undefined;
25532
25752
  /** List of access grants. */
25533
25753
  access_grants?: Array<{
25534
- /** Your display name for this access grant resource. */
25535
- name: string;
25754
+ /** Your name for this access grant resource. */
25755
+ name?: string | undefined;
25536
25756
  /** Starting date and time for the access grant. */
25537
25757
  starts_at?: string | undefined;
25538
25758
  /** Ending date and time for the access grant. */
@@ -32310,6 +32530,35 @@ export interface Routes {
32310
32530
  }>;
32311
32531
  };
32312
32532
  };
32533
+ '/instant_keys/list': {
32534
+ route: '/instant_keys/list';
32535
+ method: 'GET' | 'POST';
32536
+ queryParams: {};
32537
+ jsonBody: {};
32538
+ commonParams: {
32539
+ /** ID of the user identity by which you want to filter the list of Instant Keys. */
32540
+ user_identity_id?: string | undefined;
32541
+ };
32542
+ formData: {};
32543
+ jsonResponse: {
32544
+ instant_keys: Array<{
32545
+ /** ID of the Instant Key. */
32546
+ instant_key_id: string;
32547
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key. */
32548
+ workspace_id: string;
32549
+ /** Date and time at which the Instant Key was created. */
32550
+ created_at: string;
32551
+ /** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */
32552
+ instant_key_url: string;
32553
+ /** ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */
32554
+ client_session_id: string;
32555
+ /** ID of the user identity associated with the Instant Key. */
32556
+ user_identity_id: string;
32557
+ /** Date and time at which the Instant Key expires. */
32558
+ expires_at: string;
32559
+ }>;
32560
+ };
32561
+ };
32313
32562
  '/locks/get': {
32314
32563
  route: '/locks/get';
32315
32564
  method: 'GET' | 'POST';
@@ -49132,8 +49381,8 @@ export interface Routes {
49132
49381
  }>;
49133
49382
  };
49134
49383
  };
49135
- '/seam/console/v1/get_resource_type': {
49136
- route: '/seam/console/v1/get_resource_type';
49384
+ '/seam/console/v1/get_resource_locator': {
49385
+ route: '/seam/console/v1/get_resource_locator';
49137
49386
  method: 'GET' | 'POST';
49138
49387
  queryParams: {
49139
49388
  uuid: string;
@@ -49142,7 +49391,11 @@ export interface Routes {
49142
49391
  commonParams: {};
49143
49392
  formData: {};
49144
49393
  jsonResponse: {
49145
- resource_type: string;
49394
+ resource_locator: {
49395
+ resource_type: string;
49396
+ acs_system_id?: string | undefined;
49397
+ device_id?: string | undefined;
49398
+ };
49146
49399
  };
49147
49400
  };
49148
49401
  '/seam/customer/v1/automation_runs/list': {
@@ -49223,11 +49476,11 @@ export interface Routes {
49223
49476
  } | undefined;
49224
49477
  reservation_time_updated?: {
49225
49478
  rule: 'reservation_time_updated';
49226
- config: {};
49479
+ config?: {} | undefined;
49227
49480
  } | undefined;
49228
49481
  reservation_deleted?: {
49229
49482
  rule: 'reservation_deleted';
49230
- config: {};
49483
+ config?: {} | undefined;
49231
49484
  } | undefined;
49232
49485
  } | undefined;
49233
49486
  };
@@ -49248,11 +49501,11 @@ export interface Routes {
49248
49501
  } | undefined;
49249
49502
  reservation_time_updated?: {
49250
49503
  rule: 'reservation_time_updated';
49251
- config: {};
49504
+ config?: {} | undefined;
49252
49505
  } | undefined;
49253
49506
  reservation_deleted?: {
49254
49507
  rule: 'reservation_deleted';
49255
- config: {};
49508
+ config?: {} | undefined;
49256
49509
  } | undefined;
49257
49510
  } | undefined;
49258
49511
  };
@@ -49760,6 +50013,56 @@ export interface Routes {
49760
50013
  }>;
49761
50014
  }>;
49762
50015
  }>;
50016
+ /** User identity. */
50017
+ user_identity: {
50018
+ /** ID of the user identity. */
50019
+ user_identity_id: string;
50020
+ /** Unique key for the user identity. */
50021
+ user_identity_key: string | null;
50022
+ /** Unique email address for the user identity. */
50023
+ email_address: string | null;
50024
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
50025
+ phone_number: string | null;
50026
+ display_name: string;
50027
+ full_name: string | null;
50028
+ /** Date and time at which the user identity was created. */
50029
+ created_at: string;
50030
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
50031
+ workspace_id: string;
50032
+ /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
50033
+ errors: Array<{
50034
+ /** Date and time at which Seam created the error. */
50035
+ created_at: string;
50036
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
50037
+ message: string;
50038
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
50039
+ error_code: 'issue_with_acs_user';
50040
+ /** ID of the access system user that has an issue. */
50041
+ acs_user_id: string;
50042
+ /** ID of the access system that the user identity is associated with. */
50043
+ acs_system_id: string;
50044
+ }>;
50045
+ /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
50046
+ warnings: Array<{
50047
+ /** Date and time at which Seam created the warning. */
50048
+ created_at: string;
50049
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
50050
+ message: string;
50051
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
50052
+ warning_code: 'being_deleted';
50053
+ } | {
50054
+ /** Date and time at which Seam created the warning. */
50055
+ created_at: string;
50056
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
50057
+ message: string;
50058
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
50059
+ warning_code: 'acs_user_profile_does_not_match_user_identity';
50060
+ }>;
50061
+ /** Array of access system user IDs associated with the user identity. */
50062
+ acs_user_ids: string[];
50063
+ };
50064
+ /** Workspace ID. */
50065
+ workspace_id: string;
49763
50066
  };
49764
50067
  };
49765
50068
  };
@@ -49912,88 +50215,14 @@ export interface Routes {
49912
50215
  commonParams: {
49913
50216
  /** IDs of the spaces that you want to get along with their related resources. */
49914
50217
  space_ids: string[];
49915
- include?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
49916
- exclude?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
50218
+ include?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems'> | undefined;
50219
+ exclude?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems'> | undefined;
49917
50220
  };
49918
50221
  formData: {};
49919
50222
  jsonResponse: {
49920
- /** Represents a resource batch. */
50223
+ /** ID of the affected access system user. */
49921
50224
  batch: {
49922
- batch_type: 'workspaces' | 'access_grants' | 'access_methods' | 'spaces';
49923
- user_identities?: Array<{
49924
- /** ID of the user identity. */
49925
- user_identity_id: string;
49926
- /** Unique key for the user identity. */
49927
- user_identity_key: string | null;
49928
- /** Unique email address for the user identity. */
49929
- email_address: string | null;
49930
- /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
49931
- phone_number: string | null;
49932
- display_name: string;
49933
- full_name: string | null;
49934
- /** Date and time at which the user identity was created. */
49935
- created_at: string;
49936
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
49937
- workspace_id: string;
49938
- /** Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
49939
- errors: Array<{
49940
- /** Date and time at which Seam created the error. */
49941
- created_at: string;
49942
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
49943
- message: string;
49944
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
49945
- error_code: 'issue_with_acs_user';
49946
- /** ID of the access system user that has an issue. */
49947
- acs_user_id: string;
49948
- /** ID of the access system that the user identity is associated with. */
49949
- acs_system_id: string;
49950
- }>;
49951
- /** Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
49952
- warnings: Array<{
49953
- /** Date and time at which Seam created the warning. */
49954
- created_at: string;
49955
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
49956
- message: string;
49957
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
49958
- warning_code: 'being_deleted';
49959
- } | {
49960
- /** Date and time at which Seam created the warning. */
49961
- created_at: string;
49962
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
49963
- message: string;
49964
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
49965
- warning_code: 'acs_user_profile_does_not_match_user_identity';
49966
- }>;
49967
- /** Array of access system user IDs associated with the user identity. */
49968
- acs_user_ids: string[];
49969
- }> | undefined;
49970
- workspaces?: Array<{
49971
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
49972
- workspace_id: string;
49973
- /** Name of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
49974
- name: string;
49975
- /** Company name associated with the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
49976
- company_name: string;
49977
- /** Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). */
49978
- is_sandbox: boolean;
49979
- connect_webview_customization: {
49980
- /** Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
49981
- primary_button_color?: string | undefined;
49982
- /** Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
49983
- primary_button_text_color?: string | undefined;
49984
- /** Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
49985
- success_message?: string | undefined;
49986
- /** Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
49987
- logo_shape?: ('circle' | 'square') | undefined;
49988
- /** URL of the inviter logo for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
49989
- inviter_logo_url?: string | undefined;
49990
- };
49991
- /** Indicates whether the [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days. */
49992
- is_suspended: boolean;
49993
- /**
49994
- * @deprecated Use `company_name` instead. */
49995
- connect_partner_name: (string | null) | null;
49996
- }> | undefined;
50225
+ batch_type: 'spaces';
49997
50226
  spaces?: Array<{
49998
50227
  /** ID of the space. */
49999
50228
  space_id: string;
@@ -51318,6 +51547,252 @@ export interface Routes {
51318
51547
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
51319
51548
  can_unlock_with_code?: boolean | undefined;
51320
51549
  }> | undefined;
51550
+ connected_accounts?: Array<{
51551
+ /** ID of the connected account. */
51552
+ connected_account_id?: string | undefined;
51553
+ /** Date and time at which the connected account was created. */
51554
+ created_at?: string | undefined;
51555
+ /** User identifier associated with the connected account. */
51556
+ user_identifier?: {
51557
+ /** Username of the user identifier associated with the connected account. */
51558
+ username?: string | undefined;
51559
+ /** API URL for the user identifier associated with the connected account. */
51560
+ api_url?: string | undefined;
51561
+ /** Email address of the user identifier associated with the connected account. */
51562
+ email?: string | undefined;
51563
+ /** Phone number of the user identifier associated with the connected account. */
51564
+ phone?: string | undefined;
51565
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
51566
+ exclusive?: boolean | undefined;
51567
+ } | undefined;
51568
+ /** Type of connected account. */
51569
+ account_type?: string | undefined;
51570
+ /** Display name for the connected account type. */
51571
+ account_type_display_name: string;
51572
+ /** Errors associated with the connected account. */
51573
+ errors: Array<{
51574
+ /** Date and time at which Seam created the error. */
51575
+ created_at: string;
51576
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51577
+ message: string;
51578
+ /** Indicates whether the error is related specifically to the connected account. */
51579
+ is_connected_account_error?: boolean | undefined;
51580
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
51581
+ is_bridge_error?: boolean | undefined;
51582
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51583
+ error_code: 'account_disconnected';
51584
+ } | {
51585
+ /** Date and time at which Seam created the error. */
51586
+ created_at: string;
51587
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51588
+ message: string;
51589
+ /** Indicates whether the error is related specifically to the connected account. */
51590
+ is_connected_account_error?: boolean | undefined;
51591
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
51592
+ is_bridge_error?: boolean | undefined;
51593
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51594
+ error_code: 'invalid_credentials';
51595
+ } | {
51596
+ /** Date and time at which Seam created the error. */
51597
+ created_at: string;
51598
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51599
+ message: string;
51600
+ /** Indicates whether the error is related specifically to the connected account. */
51601
+ is_connected_account_error?: boolean | undefined;
51602
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
51603
+ is_bridge_error?: boolean | undefined;
51604
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51605
+ error_code: 'bridge_disconnected';
51606
+ } | {
51607
+ /** Date and time at which Seam created the error. */
51608
+ created_at: string;
51609
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51610
+ message: string;
51611
+ /** Indicates whether the error is related specifically to the connected account. */
51612
+ is_connected_account_error?: boolean | undefined;
51613
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
51614
+ is_bridge_error?: boolean | undefined;
51615
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51616
+ error_code: 'salto_ks_subscription_limit_exceeded';
51617
+ /** Salto KS metadata associated with the connected account that has an error. */
51618
+ salto_ks_metadata: {
51619
+ /** Salto sites associated with the connected account that has an error. */
51620
+ sites: Array<{
51621
+ /** ID of a Salto site associated with the connected account that has an error. */
51622
+ site_id: string;
51623
+ /** Name of a Salto site associated with the connected account that has an error. */
51624
+ site_name: string;
51625
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
51626
+ subscribed_site_user_count: number;
51627
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
51628
+ site_user_subscription_limit: number;
51629
+ }>;
51630
+ };
51631
+ }>;
51632
+ /** Warnings associated with the connected account. */
51633
+ warnings: Array<{
51634
+ /** Date and time at which Seam created the warning. */
51635
+ created_at: string;
51636
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
51637
+ message: string;
51638
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
51639
+ warning_code: 'scheduled_maintenance_window';
51640
+ } | {
51641
+ /** Date and time at which Seam created the warning. */
51642
+ created_at: string;
51643
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
51644
+ message: string;
51645
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
51646
+ warning_code: 'unknown_issue_with_connected_account';
51647
+ } | {
51648
+ /** Date and time at which Seam created the warning. */
51649
+ created_at: string;
51650
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
51651
+ message: string;
51652
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
51653
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
51654
+ /** Salto KS metadata associated with the connected account that has a warning. */
51655
+ salto_ks_metadata: {
51656
+ /** Salto sites associated with the connected account that has a warning. */
51657
+ sites: Array<{
51658
+ /** ID of a Salto site associated with the connected account that has a warning. */
51659
+ site_id: string;
51660
+ /** Name of a Salto site associated with the connected account that has a warning. */
51661
+ site_name: string;
51662
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
51663
+ site_user_subscription_limit: number;
51664
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
51665
+ subscribed_site_user_count: number;
51666
+ }>;
51667
+ };
51668
+ }>;
51669
+ /** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
51670
+ custom_metadata: Record<string, string | boolean>;
51671
+ /** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API. */
51672
+ automatically_manage_new_devices: boolean;
51673
+ /** Your unique key for the customer associated with this connected account. */
51674
+ customer_key?: string | undefined;
51675
+ /** List of capabilities that were accepted during the account connection process. */
51676
+ accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
51677
+ }> | undefined;
51678
+ acs_systems?: Array<{
51679
+ /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
51680
+ default_credential_manager_acs_system_id?: (string | null) | undefined;
51681
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
51682
+ acs_system_id: string;
51683
+ acs_user_count?: number | undefined;
51684
+ acs_access_group_count?: number | undefined;
51685
+ /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
51686
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
51687
+ /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
51688
+ external_type_display_name?: string | undefined;
51689
+ /** Indicates whether the `acs_system` is a credential manager. */
51690
+ is_credential_manager: boolean;
51691
+ visionline_metadata?: {
51692
+ /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
51693
+ mobile_access_uuid: string;
51694
+ /** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
51695
+ system_id: string;
51696
+ /** IP address or hostname of the main Visionline server relative to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge) on the local network. */
51697
+ lan_address: string;
51698
+ } | undefined;
51699
+ /**
51700
+ * @deprecated Use `external_type`. */
51701
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community_site' | 'legic_connect_credential_service' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
51702
+ /**
51703
+ * @deprecated Use `external_type_display_name`. */
51704
+ system_type_display_name?: string | undefined;
51705
+ location: {
51706
+ /** Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. */
51707
+ time_zone: string | null;
51708
+ };
51709
+ /** Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
51710
+ name: string;
51711
+ /** Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. */
51712
+ created_at: string;
51713
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
51714
+ workspace_id: string;
51715
+ /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
51716
+ * @deprecated Use `connected_account_id`. */
51717
+ connected_account_ids: string[];
51718
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
51719
+ connected_account_id: string;
51720
+ /** URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
51721
+ image_url: string;
51722
+ /** Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. */
51723
+ image_alt_text: string;
51724
+ /** Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
51725
+ errors: Array<{
51726
+ /** Date and time at which Seam created the error. */
51727
+ created_at: string;
51728
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51729
+ message: string;
51730
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51731
+ error_code: 'seam_bridge_disconnected';
51732
+ } | {
51733
+ /** Date and time at which Seam created the error. */
51734
+ created_at: string;
51735
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51736
+ message: string;
51737
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51738
+ error_code: 'bridge_disconnected';
51739
+ is_bridge_error?: boolean | undefined;
51740
+ } | {
51741
+ /** Date and time at which Seam created the error. */
51742
+ created_at: string;
51743
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51744
+ message: string;
51745
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51746
+ error_code: 'visionline_instance_unreachable';
51747
+ } | {
51748
+ /** Date and time at which Seam created the error. */
51749
+ created_at: string;
51750
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51751
+ message: string;
51752
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51753
+ error_code: 'salto_ks_subscription_limit_exceeded';
51754
+ } | {
51755
+ /** Date and time at which Seam created the error. */
51756
+ created_at: string;
51757
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51758
+ message: string;
51759
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51760
+ error_code: 'acs_system_disconnected';
51761
+ } | {
51762
+ /** Date and time at which Seam created the error. */
51763
+ created_at: string;
51764
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51765
+ message: string;
51766
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51767
+ error_code: 'account_disconnected';
51768
+ } | {
51769
+ /** Date and time at which Seam created the error. */
51770
+ created_at: string;
51771
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51772
+ message: string;
51773
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
51774
+ error_code: 'salto_ks_certification_expired';
51775
+ }>;
51776
+ /** Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
51777
+ warnings: Array<{
51778
+ /** Date and time at which Seam created the warning. */
51779
+ created_at: string;
51780
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
51781
+ message: string;
51782
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
51783
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
51784
+ } | {
51785
+ /** Date and time at which Seam created the warning. */
51786
+ created_at: string;
51787
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
51788
+ message: string;
51789
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
51790
+ warning_code: 'time_zone_does_not_match_location';
51791
+ /**
51792
+ * @deprecated this field is deprecated. */
51793
+ misconfigured_acs_entrance_ids?: string[] | undefined;
51794
+ }>;
51795
+ }> | undefined;
51321
51796
  };
51322
51797
  };
51323
51798
  };