@seamapi/types 1.460.0 → 1.460.1
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.
- package/dist/connect.cjs +331 -120
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +848 -238
- package/dist/index.cjs +331 -120
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/batch.d.ts +2338 -276
- package/lib/seam/connect/models/batch.js +7 -0
- package/lib/seam/connect/models/batch.js.map +1 -1
- package/lib/seam/connect/models/customer/access-grant-resources.d.ts +18 -18
- package/lib/seam/connect/models/customer/access-grant-resources.js +2 -1
- package/lib/seam/connect/models/customer/access-grant-resources.js.map +1 -1
- package/lib/seam/connect/models/customer/customer-data.d.ts +15 -15
- package/lib/seam/connect/models/phones/phone-session.d.ts +167 -0
- package/lib/seam/connect/models/phones/phone-session.js +3 -0
- package/lib/seam/connect/models/phones/phone-session.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +199 -33
- package/lib/seam/connect/openapi.js +319 -113
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +619 -175
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/batch.ts +7 -0
- package/src/lib/seam/connect/models/customer/access-grant-resources.ts +2 -1
- package/src/lib/seam/connect/models/phones/phone-session.ts +5 -0
- package/src/lib/seam/connect/openapi.ts +341 -113
- package/src/lib/seam/connect/route-types.ts +789 -189
|
@@ -10105,88 +10105,13 @@ export interface Routes {
|
|
|
10105
10105
|
commonParams: {
|
|
10106
10106
|
/** IDs of the access grants that you want to get along with their related resources. */
|
|
10107
10107
|
access_grant_ids: string[];
|
|
10108
|
-
include?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
|
|
10109
|
-
exclude?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
|
|
10108
|
+
include?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identity'> | undefined;
|
|
10109
|
+
exclude?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems' | 'user_identity'> | undefined;
|
|
10110
10110
|
};
|
|
10111
10111
|
formData: {};
|
|
10112
10112
|
jsonResponse: {
|
|
10113
|
-
/** Represents a resource batch. */
|
|
10114
10113
|
batch: {
|
|
10115
|
-
batch_type: '
|
|
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;
|
|
10114
|
+
batch_type: 'access_grants';
|
|
10190
10115
|
spaces?: Array<{
|
|
10191
10116
|
/** ID of the space. */
|
|
10192
10117
|
space_id: string;
|
|
@@ -11511,6 +11436,299 @@ export interface Routes {
|
|
|
11511
11436
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
11512
11437
|
can_unlock_with_code?: boolean | undefined;
|
|
11513
11438
|
}> | undefined;
|
|
11439
|
+
user_identities?: Array<{
|
|
11440
|
+
/** ID of the user identity. */
|
|
11441
|
+
user_identity_id: string;
|
|
11442
|
+
/** Unique key for the user identity. */
|
|
11443
|
+
user_identity_key: string | null;
|
|
11444
|
+
/** Unique email address for the user identity. */
|
|
11445
|
+
email_address: string | null;
|
|
11446
|
+
/** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
|
|
11447
|
+
phone_number: string | null;
|
|
11448
|
+
display_name: string;
|
|
11449
|
+
full_name: string | null;
|
|
11450
|
+
/** Date and time at which the user identity was created. */
|
|
11451
|
+
created_at: string;
|
|
11452
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
|
|
11453
|
+
workspace_id: string;
|
|
11454
|
+
/** 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. */
|
|
11455
|
+
errors: Array<{
|
|
11456
|
+
/** Date and time at which Seam created the error. */
|
|
11457
|
+
created_at: string;
|
|
11458
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11459
|
+
message: string;
|
|
11460
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11461
|
+
error_code: 'issue_with_acs_user';
|
|
11462
|
+
/** ID of the access system user that has an issue. */
|
|
11463
|
+
acs_user_id: string;
|
|
11464
|
+
/** ID of the access system that the user identity is associated with. */
|
|
11465
|
+
acs_system_id: string;
|
|
11466
|
+
}>;
|
|
11467
|
+
/** 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. */
|
|
11468
|
+
warnings: Array<{
|
|
11469
|
+
/** Date and time at which Seam created the warning. */
|
|
11470
|
+
created_at: string;
|
|
11471
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
11472
|
+
message: string;
|
|
11473
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
11474
|
+
warning_code: 'being_deleted';
|
|
11475
|
+
} | {
|
|
11476
|
+
/** Date and time at which Seam created the warning. */
|
|
11477
|
+
created_at: string;
|
|
11478
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
11479
|
+
message: string;
|
|
11480
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
11481
|
+
warning_code: 'acs_user_profile_does_not_match_user_identity';
|
|
11482
|
+
}>;
|
|
11483
|
+
/** Array of access system user IDs associated with the user identity. */
|
|
11484
|
+
acs_user_ids: string[];
|
|
11485
|
+
}> | undefined;
|
|
11486
|
+
connected_accounts?: Array<{
|
|
11487
|
+
/** ID of the connected account. */
|
|
11488
|
+
connected_account_id?: string | undefined;
|
|
11489
|
+
/** Date and time at which the connected account was created. */
|
|
11490
|
+
created_at?: string | undefined;
|
|
11491
|
+
/** User identifier associated with the connected account. */
|
|
11492
|
+
user_identifier?: {
|
|
11493
|
+
/** Username of the user identifier associated with the connected account. */
|
|
11494
|
+
username?: string | undefined;
|
|
11495
|
+
/** API URL for the user identifier associated with the connected account. */
|
|
11496
|
+
api_url?: string | undefined;
|
|
11497
|
+
/** Email address of the user identifier associated with the connected account. */
|
|
11498
|
+
email?: string | undefined;
|
|
11499
|
+
/** Phone number of the user identifier associated with the connected account. */
|
|
11500
|
+
phone?: string | undefined;
|
|
11501
|
+
/** Indicates whether the user identifier associated with the connected account is exclusive. */
|
|
11502
|
+
exclusive?: boolean | undefined;
|
|
11503
|
+
} | undefined;
|
|
11504
|
+
/** Type of connected account. */
|
|
11505
|
+
account_type?: string | undefined;
|
|
11506
|
+
/** Display name for the connected account type. */
|
|
11507
|
+
account_type_display_name: string;
|
|
11508
|
+
/** Errors associated with the connected account. */
|
|
11509
|
+
errors: Array<{
|
|
11510
|
+
/** Date and time at which Seam created the error. */
|
|
11511
|
+
created_at: string;
|
|
11512
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11513
|
+
message: string;
|
|
11514
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
11515
|
+
is_connected_account_error?: boolean | undefined;
|
|
11516
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
11517
|
+
is_bridge_error?: boolean | undefined;
|
|
11518
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11519
|
+
error_code: 'account_disconnected';
|
|
11520
|
+
} | {
|
|
11521
|
+
/** Date and time at which Seam created the error. */
|
|
11522
|
+
created_at: string;
|
|
11523
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11524
|
+
message: string;
|
|
11525
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
11526
|
+
is_connected_account_error?: boolean | undefined;
|
|
11527
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
11528
|
+
is_bridge_error?: boolean | undefined;
|
|
11529
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11530
|
+
error_code: 'invalid_credentials';
|
|
11531
|
+
} | {
|
|
11532
|
+
/** Date and time at which Seam created the error. */
|
|
11533
|
+
created_at: string;
|
|
11534
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11535
|
+
message: string;
|
|
11536
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
11537
|
+
is_connected_account_error?: boolean | undefined;
|
|
11538
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
11539
|
+
is_bridge_error?: boolean | undefined;
|
|
11540
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11541
|
+
error_code: 'bridge_disconnected';
|
|
11542
|
+
} | {
|
|
11543
|
+
/** Date and time at which Seam created the error. */
|
|
11544
|
+
created_at: string;
|
|
11545
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11546
|
+
message: string;
|
|
11547
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
11548
|
+
is_connected_account_error?: boolean | undefined;
|
|
11549
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
11550
|
+
is_bridge_error?: boolean | undefined;
|
|
11551
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11552
|
+
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
11553
|
+
/** Salto KS metadata associated with the connected account that has an error. */
|
|
11554
|
+
salto_ks_metadata: {
|
|
11555
|
+
/** Salto sites associated with the connected account that has an error. */
|
|
11556
|
+
sites: Array<{
|
|
11557
|
+
/** ID of a Salto site associated with the connected account that has an error. */
|
|
11558
|
+
site_id: string;
|
|
11559
|
+
/** Name of a Salto site associated with the connected account that has an error. */
|
|
11560
|
+
site_name: string;
|
|
11561
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
|
|
11562
|
+
subscribed_site_user_count: number;
|
|
11563
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
|
|
11564
|
+
site_user_subscription_limit: number;
|
|
11565
|
+
}>;
|
|
11566
|
+
};
|
|
11567
|
+
}>;
|
|
11568
|
+
/** Warnings associated with the connected account. */
|
|
11569
|
+
warnings: Array<{
|
|
11570
|
+
/** Date and time at which Seam created the warning. */
|
|
11571
|
+
created_at: string;
|
|
11572
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
11573
|
+
message: string;
|
|
11574
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
11575
|
+
warning_code: 'scheduled_maintenance_window';
|
|
11576
|
+
} | {
|
|
11577
|
+
/** Date and time at which Seam created the warning. */
|
|
11578
|
+
created_at: string;
|
|
11579
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
11580
|
+
message: string;
|
|
11581
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
11582
|
+
warning_code: 'unknown_issue_with_connected_account';
|
|
11583
|
+
} | {
|
|
11584
|
+
/** Date and time at which Seam created the warning. */
|
|
11585
|
+
created_at: string;
|
|
11586
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
11587
|
+
message: string;
|
|
11588
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
11589
|
+
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
11590
|
+
/** Salto KS metadata associated with the connected account that has a warning. */
|
|
11591
|
+
salto_ks_metadata: {
|
|
11592
|
+
/** Salto sites associated with the connected account that has a warning. */
|
|
11593
|
+
sites: Array<{
|
|
11594
|
+
/** ID of a Salto site associated with the connected account that has a warning. */
|
|
11595
|
+
site_id: string;
|
|
11596
|
+
/** Name of a Salto site associated with the connected account that has a warning. */
|
|
11597
|
+
site_name: string;
|
|
11598
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
|
|
11599
|
+
site_user_subscription_limit: number;
|
|
11600
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
|
|
11601
|
+
subscribed_site_user_count: number;
|
|
11602
|
+
}>;
|
|
11603
|
+
};
|
|
11604
|
+
}>;
|
|
11605
|
+
/** 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. */
|
|
11606
|
+
custom_metadata: Record<string, string | boolean>;
|
|
11607
|
+
/** 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. */
|
|
11608
|
+
automatically_manage_new_devices: boolean;
|
|
11609
|
+
/** Your unique key for the customer associated with this connected account. */
|
|
11610
|
+
customer_key?: string | undefined;
|
|
11611
|
+
/** List of capabilities that were accepted during the account connection process. */
|
|
11612
|
+
accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
|
|
11613
|
+
}> | undefined;
|
|
11614
|
+
acs_systems?: Array<{
|
|
11615
|
+
/** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
11616
|
+
default_credential_manager_acs_system_id?: (string | null) | undefined;
|
|
11617
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
11618
|
+
acs_system_id: string;
|
|
11619
|
+
acs_user_count?: number | undefined;
|
|
11620
|
+
acs_access_group_count?: number | undefined;
|
|
11621
|
+
/** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
|
|
11622
|
+
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;
|
|
11623
|
+
/** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
|
|
11624
|
+
external_type_display_name?: string | undefined;
|
|
11625
|
+
/** Indicates whether the `acs_system` is a credential manager. */
|
|
11626
|
+
is_credential_manager: boolean;
|
|
11627
|
+
visionline_metadata?: {
|
|
11628
|
+
/** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
|
|
11629
|
+
mobile_access_uuid: string;
|
|
11630
|
+
/** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
|
|
11631
|
+
system_id: string;
|
|
11632
|
+
/** 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. */
|
|
11633
|
+
lan_address: string;
|
|
11634
|
+
} | undefined;
|
|
11635
|
+
/**
|
|
11636
|
+
* @deprecated Use `external_type`. */
|
|
11637
|
+
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;
|
|
11638
|
+
/**
|
|
11639
|
+
* @deprecated Use `external_type_display_name`. */
|
|
11640
|
+
system_type_display_name?: string | undefined;
|
|
11641
|
+
location: {
|
|
11642
|
+
/** Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. */
|
|
11643
|
+
time_zone: string | null;
|
|
11644
|
+
};
|
|
11645
|
+
/** Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
11646
|
+
name: string;
|
|
11647
|
+
/** Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. */
|
|
11648
|
+
created_at: string;
|
|
11649
|
+
/** 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). */
|
|
11650
|
+
workspace_id: string;
|
|
11651
|
+
/** 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).
|
|
11652
|
+
* @deprecated Use `connected_account_id`. */
|
|
11653
|
+
connected_account_ids: string[];
|
|
11654
|
+
/** 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). */
|
|
11655
|
+
connected_account_id: string;
|
|
11656
|
+
/** URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
11657
|
+
image_url: string;
|
|
11658
|
+
/** Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. */
|
|
11659
|
+
image_alt_text: string;
|
|
11660
|
+
/** Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
11661
|
+
errors: Array<{
|
|
11662
|
+
/** Date and time at which Seam created the error. */
|
|
11663
|
+
created_at: string;
|
|
11664
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11665
|
+
message: string;
|
|
11666
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11667
|
+
error_code: 'seam_bridge_disconnected';
|
|
11668
|
+
} | {
|
|
11669
|
+
/** Date and time at which Seam created the error. */
|
|
11670
|
+
created_at: string;
|
|
11671
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11672
|
+
message: string;
|
|
11673
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11674
|
+
error_code: 'bridge_disconnected';
|
|
11675
|
+
is_bridge_error?: boolean | undefined;
|
|
11676
|
+
} | {
|
|
11677
|
+
/** Date and time at which Seam created the error. */
|
|
11678
|
+
created_at: string;
|
|
11679
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11680
|
+
message: string;
|
|
11681
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11682
|
+
error_code: 'visionline_instance_unreachable';
|
|
11683
|
+
} | {
|
|
11684
|
+
/** Date and time at which Seam created the error. */
|
|
11685
|
+
created_at: string;
|
|
11686
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11687
|
+
message: string;
|
|
11688
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11689
|
+
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
11690
|
+
} | {
|
|
11691
|
+
/** Date and time at which Seam created the error. */
|
|
11692
|
+
created_at: string;
|
|
11693
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11694
|
+
message: string;
|
|
11695
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11696
|
+
error_code: 'acs_system_disconnected';
|
|
11697
|
+
} | {
|
|
11698
|
+
/** Date and time at which Seam created the error. */
|
|
11699
|
+
created_at: string;
|
|
11700
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11701
|
+
message: string;
|
|
11702
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11703
|
+
error_code: 'account_disconnected';
|
|
11704
|
+
} | {
|
|
11705
|
+
/** Date and time at which Seam created the error. */
|
|
11706
|
+
created_at: string;
|
|
11707
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11708
|
+
message: string;
|
|
11709
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
11710
|
+
error_code: 'salto_ks_certification_expired';
|
|
11711
|
+
}>;
|
|
11712
|
+
/** Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
11713
|
+
warnings: Array<{
|
|
11714
|
+
/** Date and time at which Seam created the warning. */
|
|
11715
|
+
created_at: string;
|
|
11716
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
11717
|
+
message: string;
|
|
11718
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
11719
|
+
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
11720
|
+
} | {
|
|
11721
|
+
/** Date and time at which Seam created the warning. */
|
|
11722
|
+
created_at: string;
|
|
11723
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
11724
|
+
message: string;
|
|
11725
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
11726
|
+
warning_code: 'time_zone_does_not_match_location';
|
|
11727
|
+
/**
|
|
11728
|
+
* @deprecated this field is deprecated. */
|
|
11729
|
+
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
11730
|
+
}>;
|
|
11731
|
+
}> | undefined;
|
|
11514
11732
|
};
|
|
11515
11733
|
};
|
|
11516
11734
|
};
|
|
@@ -25197,8 +25415,8 @@ export interface Routes {
|
|
|
25197
25415
|
}> | undefined;
|
|
25198
25416
|
/** List of reservations. */
|
|
25199
25417
|
reservations?: Array<{
|
|
25200
|
-
/** Your
|
|
25201
|
-
name
|
|
25418
|
+
/** Your name for this access grant resource. */
|
|
25419
|
+
name?: string | undefined;
|
|
25202
25420
|
/** Starting date and time for the access grant. */
|
|
25203
25421
|
starts_at?: string | undefined;
|
|
25204
25422
|
/** Ending date and time for the access grant. */
|
|
@@ -25234,8 +25452,8 @@ export interface Routes {
|
|
|
25234
25452
|
}> | undefined;
|
|
25235
25453
|
/** List of bookings. */
|
|
25236
25454
|
bookings?: Array<{
|
|
25237
|
-
/** Your
|
|
25238
|
-
name
|
|
25455
|
+
/** Your name for this access grant resource. */
|
|
25456
|
+
name?: string | undefined;
|
|
25239
25457
|
/** Starting date and time for the access grant. */
|
|
25240
25458
|
starts_at?: string | undefined;
|
|
25241
25459
|
/** Ending date and time for the access grant. */
|
|
@@ -25271,8 +25489,8 @@ export interface Routes {
|
|
|
25271
25489
|
}> | undefined;
|
|
25272
25490
|
/** List of access grants. */
|
|
25273
25491
|
access_grants?: Array<{
|
|
25274
|
-
/** Your
|
|
25275
|
-
name
|
|
25492
|
+
/** Your name for this access grant resource. */
|
|
25493
|
+
name?: string | undefined;
|
|
25276
25494
|
/** Starting date and time for the access grant. */
|
|
25277
25495
|
starts_at?: string | undefined;
|
|
25278
25496
|
/** Ending date and time for the access grant. */
|
|
@@ -25457,8 +25675,8 @@ export interface Routes {
|
|
|
25457
25675
|
}> | undefined;
|
|
25458
25676
|
/** List of reservations. */
|
|
25459
25677
|
reservations?: Array<{
|
|
25460
|
-
/** Your
|
|
25461
|
-
name
|
|
25678
|
+
/** Your name for this access grant resource. */
|
|
25679
|
+
name?: string | undefined;
|
|
25462
25680
|
/** Starting date and time for the access grant. */
|
|
25463
25681
|
starts_at?: string | undefined;
|
|
25464
25682
|
/** Ending date and time for the access grant. */
|
|
@@ -25494,8 +25712,8 @@ export interface Routes {
|
|
|
25494
25712
|
}> | undefined;
|
|
25495
25713
|
/** List of bookings. */
|
|
25496
25714
|
bookings?: Array<{
|
|
25497
|
-
/** Your
|
|
25498
|
-
name
|
|
25715
|
+
/** Your name for this access grant resource. */
|
|
25716
|
+
name?: string | undefined;
|
|
25499
25717
|
/** Starting date and time for the access grant. */
|
|
25500
25718
|
starts_at?: string | undefined;
|
|
25501
25719
|
/** Ending date and time for the access grant. */
|
|
@@ -25531,8 +25749,8 @@ export interface Routes {
|
|
|
25531
25749
|
}> | undefined;
|
|
25532
25750
|
/** List of access grants. */
|
|
25533
25751
|
access_grants?: Array<{
|
|
25534
|
-
/** Your
|
|
25535
|
-
name
|
|
25752
|
+
/** Your name for this access grant resource. */
|
|
25753
|
+
name?: string | undefined;
|
|
25536
25754
|
/** Starting date and time for the access grant. */
|
|
25537
25755
|
starts_at?: string | undefined;
|
|
25538
25756
|
/** Ending date and time for the access grant. */
|
|
@@ -49132,8 +49350,8 @@ export interface Routes {
|
|
|
49132
49350
|
}>;
|
|
49133
49351
|
};
|
|
49134
49352
|
};
|
|
49135
|
-
'/seam/console/v1/
|
|
49136
|
-
route: '/seam/console/v1/
|
|
49353
|
+
'/seam/console/v1/get_resource_locator': {
|
|
49354
|
+
route: '/seam/console/v1/get_resource_locator';
|
|
49137
49355
|
method: 'GET' | 'POST';
|
|
49138
49356
|
queryParams: {
|
|
49139
49357
|
uuid: string;
|
|
@@ -49142,7 +49360,11 @@ export interface Routes {
|
|
|
49142
49360
|
commonParams: {};
|
|
49143
49361
|
formData: {};
|
|
49144
49362
|
jsonResponse: {
|
|
49145
|
-
|
|
49363
|
+
resource_locator: {
|
|
49364
|
+
resource_type: string;
|
|
49365
|
+
acs_system_id?: string | undefined;
|
|
49366
|
+
device_id?: string | undefined;
|
|
49367
|
+
};
|
|
49146
49368
|
};
|
|
49147
49369
|
};
|
|
49148
49370
|
'/seam/customer/v1/automation_runs/list': {
|
|
@@ -49223,11 +49445,11 @@ export interface Routes {
|
|
|
49223
49445
|
} | undefined;
|
|
49224
49446
|
reservation_time_updated?: {
|
|
49225
49447
|
rule: 'reservation_time_updated';
|
|
49226
|
-
config
|
|
49448
|
+
config?: {} | undefined;
|
|
49227
49449
|
} | undefined;
|
|
49228
49450
|
reservation_deleted?: {
|
|
49229
49451
|
rule: 'reservation_deleted';
|
|
49230
|
-
config
|
|
49452
|
+
config?: {} | undefined;
|
|
49231
49453
|
} | undefined;
|
|
49232
49454
|
} | undefined;
|
|
49233
49455
|
};
|
|
@@ -49248,11 +49470,11 @@ export interface Routes {
|
|
|
49248
49470
|
} | undefined;
|
|
49249
49471
|
reservation_time_updated?: {
|
|
49250
49472
|
rule: 'reservation_time_updated';
|
|
49251
|
-
config
|
|
49473
|
+
config?: {} | undefined;
|
|
49252
49474
|
} | undefined;
|
|
49253
49475
|
reservation_deleted?: {
|
|
49254
49476
|
rule: 'reservation_deleted';
|
|
49255
|
-
config
|
|
49477
|
+
config?: {} | undefined;
|
|
49256
49478
|
} | undefined;
|
|
49257
49479
|
} | undefined;
|
|
49258
49480
|
};
|
|
@@ -49760,6 +49982,56 @@ export interface Routes {
|
|
|
49760
49982
|
}>;
|
|
49761
49983
|
}>;
|
|
49762
49984
|
}>;
|
|
49985
|
+
/** User identity. */
|
|
49986
|
+
user_identity: {
|
|
49987
|
+
/** ID of the user identity. */
|
|
49988
|
+
user_identity_id: string;
|
|
49989
|
+
/** Unique key for the user identity. */
|
|
49990
|
+
user_identity_key: string | null;
|
|
49991
|
+
/** Unique email address for the user identity. */
|
|
49992
|
+
email_address: string | null;
|
|
49993
|
+
/** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
|
|
49994
|
+
phone_number: string | null;
|
|
49995
|
+
display_name: string;
|
|
49996
|
+
full_name: string | null;
|
|
49997
|
+
/** Date and time at which the user identity was created. */
|
|
49998
|
+
created_at: string;
|
|
49999
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
|
|
50000
|
+
workspace_id: string;
|
|
50001
|
+
/** 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. */
|
|
50002
|
+
errors: Array<{
|
|
50003
|
+
/** Date and time at which Seam created the error. */
|
|
50004
|
+
created_at: string;
|
|
50005
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
50006
|
+
message: string;
|
|
50007
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
50008
|
+
error_code: 'issue_with_acs_user';
|
|
50009
|
+
/** ID of the access system user that has an issue. */
|
|
50010
|
+
acs_user_id: string;
|
|
50011
|
+
/** ID of the access system that the user identity is associated with. */
|
|
50012
|
+
acs_system_id: string;
|
|
50013
|
+
}>;
|
|
50014
|
+
/** 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. */
|
|
50015
|
+
warnings: Array<{
|
|
50016
|
+
/** Date and time at which Seam created the warning. */
|
|
50017
|
+
created_at: string;
|
|
50018
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
50019
|
+
message: string;
|
|
50020
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
50021
|
+
warning_code: 'being_deleted';
|
|
50022
|
+
} | {
|
|
50023
|
+
/** Date and time at which Seam created the warning. */
|
|
50024
|
+
created_at: string;
|
|
50025
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
50026
|
+
message: string;
|
|
50027
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
50028
|
+
warning_code: 'acs_user_profile_does_not_match_user_identity';
|
|
50029
|
+
}>;
|
|
50030
|
+
/** Array of access system user IDs associated with the user identity. */
|
|
50031
|
+
acs_user_ids: string[];
|
|
50032
|
+
};
|
|
50033
|
+
/** Workspace ID. */
|
|
50034
|
+
workspace_id: string;
|
|
49763
50035
|
};
|
|
49764
50036
|
};
|
|
49765
50037
|
};
|
|
@@ -49912,88 +50184,14 @@ export interface Routes {
|
|
|
49912
50184
|
commonParams: {
|
|
49913
50185
|
/** IDs of the spaces that you want to get along with their related resources. */
|
|
49914
50186
|
space_ids: string[];
|
|
49915
|
-
include?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
|
|
49916
|
-
exclude?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined;
|
|
50187
|
+
include?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems'> | undefined;
|
|
50188
|
+
exclude?: Array<'spaces' | 'devices' | 'acs_entrances' | 'connected_accounts' | 'acs_systems'> | undefined;
|
|
49917
50189
|
};
|
|
49918
50190
|
formData: {};
|
|
49919
50191
|
jsonResponse: {
|
|
49920
|
-
/**
|
|
50192
|
+
/** ID of the affected access system user. */
|
|
49921
50193
|
batch: {
|
|
49922
|
-
batch_type: '
|
|
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;
|
|
50194
|
+
batch_type: 'spaces';
|
|
49997
50195
|
spaces?: Array<{
|
|
49998
50196
|
/** ID of the space. */
|
|
49999
50197
|
space_id: string;
|
|
@@ -51318,6 +51516,252 @@ export interface Routes {
|
|
|
51318
51516
|
/** Indicates whether the ACS entrance can be unlocked with pin codes. */
|
|
51319
51517
|
can_unlock_with_code?: boolean | undefined;
|
|
51320
51518
|
}> | undefined;
|
|
51519
|
+
connected_accounts?: Array<{
|
|
51520
|
+
/** ID of the connected account. */
|
|
51521
|
+
connected_account_id?: string | undefined;
|
|
51522
|
+
/** Date and time at which the connected account was created. */
|
|
51523
|
+
created_at?: string | undefined;
|
|
51524
|
+
/** User identifier associated with the connected account. */
|
|
51525
|
+
user_identifier?: {
|
|
51526
|
+
/** Username of the user identifier associated with the connected account. */
|
|
51527
|
+
username?: string | undefined;
|
|
51528
|
+
/** API URL for the user identifier associated with the connected account. */
|
|
51529
|
+
api_url?: string | undefined;
|
|
51530
|
+
/** Email address of the user identifier associated with the connected account. */
|
|
51531
|
+
email?: string | undefined;
|
|
51532
|
+
/** Phone number of the user identifier associated with the connected account. */
|
|
51533
|
+
phone?: string | undefined;
|
|
51534
|
+
/** Indicates whether the user identifier associated with the connected account is exclusive. */
|
|
51535
|
+
exclusive?: boolean | undefined;
|
|
51536
|
+
} | undefined;
|
|
51537
|
+
/** Type of connected account. */
|
|
51538
|
+
account_type?: string | undefined;
|
|
51539
|
+
/** Display name for the connected account type. */
|
|
51540
|
+
account_type_display_name: string;
|
|
51541
|
+
/** Errors associated with the connected account. */
|
|
51542
|
+
errors: Array<{
|
|
51543
|
+
/** Date and time at which Seam created the error. */
|
|
51544
|
+
created_at: string;
|
|
51545
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51546
|
+
message: string;
|
|
51547
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
51548
|
+
is_connected_account_error?: boolean | undefined;
|
|
51549
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
51550
|
+
is_bridge_error?: boolean | undefined;
|
|
51551
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51552
|
+
error_code: 'account_disconnected';
|
|
51553
|
+
} | {
|
|
51554
|
+
/** Date and time at which Seam created the error. */
|
|
51555
|
+
created_at: string;
|
|
51556
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51557
|
+
message: string;
|
|
51558
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
51559
|
+
is_connected_account_error?: boolean | undefined;
|
|
51560
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
51561
|
+
is_bridge_error?: boolean | undefined;
|
|
51562
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51563
|
+
error_code: 'invalid_credentials';
|
|
51564
|
+
} | {
|
|
51565
|
+
/** Date and time at which Seam created the error. */
|
|
51566
|
+
created_at: string;
|
|
51567
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51568
|
+
message: string;
|
|
51569
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
51570
|
+
is_connected_account_error?: boolean | undefined;
|
|
51571
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
51572
|
+
is_bridge_error?: boolean | undefined;
|
|
51573
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51574
|
+
error_code: 'bridge_disconnected';
|
|
51575
|
+
} | {
|
|
51576
|
+
/** Date and time at which Seam created the error. */
|
|
51577
|
+
created_at: string;
|
|
51578
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51579
|
+
message: string;
|
|
51580
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
51581
|
+
is_connected_account_error?: boolean | undefined;
|
|
51582
|
+
/** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
|
|
51583
|
+
is_bridge_error?: boolean | undefined;
|
|
51584
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51585
|
+
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
51586
|
+
/** Salto KS metadata associated with the connected account that has an error. */
|
|
51587
|
+
salto_ks_metadata: {
|
|
51588
|
+
/** Salto sites associated with the connected account that has an error. */
|
|
51589
|
+
sites: Array<{
|
|
51590
|
+
/** ID of a Salto site associated with the connected account that has an error. */
|
|
51591
|
+
site_id: string;
|
|
51592
|
+
/** Name of a Salto site associated with the connected account that has an error. */
|
|
51593
|
+
site_name: string;
|
|
51594
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
|
|
51595
|
+
subscribed_site_user_count: number;
|
|
51596
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
|
|
51597
|
+
site_user_subscription_limit: number;
|
|
51598
|
+
}>;
|
|
51599
|
+
};
|
|
51600
|
+
}>;
|
|
51601
|
+
/** Warnings associated with the connected account. */
|
|
51602
|
+
warnings: Array<{
|
|
51603
|
+
/** Date and time at which Seam created the warning. */
|
|
51604
|
+
created_at: string;
|
|
51605
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
51606
|
+
message: string;
|
|
51607
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
51608
|
+
warning_code: 'scheduled_maintenance_window';
|
|
51609
|
+
} | {
|
|
51610
|
+
/** Date and time at which Seam created the warning. */
|
|
51611
|
+
created_at: string;
|
|
51612
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
51613
|
+
message: string;
|
|
51614
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
51615
|
+
warning_code: 'unknown_issue_with_connected_account';
|
|
51616
|
+
} | {
|
|
51617
|
+
/** Date and time at which Seam created the warning. */
|
|
51618
|
+
created_at: string;
|
|
51619
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
51620
|
+
message: string;
|
|
51621
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
51622
|
+
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
51623
|
+
/** Salto KS metadata associated with the connected account that has a warning. */
|
|
51624
|
+
salto_ks_metadata: {
|
|
51625
|
+
/** Salto sites associated with the connected account that has a warning. */
|
|
51626
|
+
sites: Array<{
|
|
51627
|
+
/** ID of a Salto site associated with the connected account that has a warning. */
|
|
51628
|
+
site_id: string;
|
|
51629
|
+
/** Name of a Salto site associated with the connected account that has a warning. */
|
|
51630
|
+
site_name: string;
|
|
51631
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
|
|
51632
|
+
site_user_subscription_limit: number;
|
|
51633
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
|
|
51634
|
+
subscribed_site_user_count: number;
|
|
51635
|
+
}>;
|
|
51636
|
+
};
|
|
51637
|
+
}>;
|
|
51638
|
+
/** 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. */
|
|
51639
|
+
custom_metadata: Record<string, string | boolean>;
|
|
51640
|
+
/** 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. */
|
|
51641
|
+
automatically_manage_new_devices: boolean;
|
|
51642
|
+
/** Your unique key for the customer associated with this connected account. */
|
|
51643
|
+
customer_key?: string | undefined;
|
|
51644
|
+
/** List of capabilities that were accepted during the account connection process. */
|
|
51645
|
+
accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control'>;
|
|
51646
|
+
}> | undefined;
|
|
51647
|
+
acs_systems?: Array<{
|
|
51648
|
+
/** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
51649
|
+
default_credential_manager_acs_system_id?: (string | null) | undefined;
|
|
51650
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
51651
|
+
acs_system_id: string;
|
|
51652
|
+
acs_user_count?: number | undefined;
|
|
51653
|
+
acs_access_group_count?: number | undefined;
|
|
51654
|
+
/** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
|
|
51655
|
+
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;
|
|
51656
|
+
/** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
|
|
51657
|
+
external_type_display_name?: string | undefined;
|
|
51658
|
+
/** Indicates whether the `acs_system` is a credential manager. */
|
|
51659
|
+
is_credential_manager: boolean;
|
|
51660
|
+
visionline_metadata?: {
|
|
51661
|
+
/** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
|
|
51662
|
+
mobile_access_uuid: string;
|
|
51663
|
+
/** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
|
|
51664
|
+
system_id: string;
|
|
51665
|
+
/** 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. */
|
|
51666
|
+
lan_address: string;
|
|
51667
|
+
} | undefined;
|
|
51668
|
+
/**
|
|
51669
|
+
* @deprecated Use `external_type`. */
|
|
51670
|
+
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;
|
|
51671
|
+
/**
|
|
51672
|
+
* @deprecated Use `external_type_display_name`. */
|
|
51673
|
+
system_type_display_name?: string | undefined;
|
|
51674
|
+
location: {
|
|
51675
|
+
/** Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. */
|
|
51676
|
+
time_zone: string | null;
|
|
51677
|
+
};
|
|
51678
|
+
/** Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
51679
|
+
name: string;
|
|
51680
|
+
/** Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. */
|
|
51681
|
+
created_at: string;
|
|
51682
|
+
/** 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). */
|
|
51683
|
+
workspace_id: string;
|
|
51684
|
+
/** 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).
|
|
51685
|
+
* @deprecated Use `connected_account_id`. */
|
|
51686
|
+
connected_account_ids: string[];
|
|
51687
|
+
/** 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). */
|
|
51688
|
+
connected_account_id: string;
|
|
51689
|
+
/** URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
51690
|
+
image_url: string;
|
|
51691
|
+
/** Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. */
|
|
51692
|
+
image_alt_text: string;
|
|
51693
|
+
/** Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
51694
|
+
errors: Array<{
|
|
51695
|
+
/** Date and time at which Seam created the error. */
|
|
51696
|
+
created_at: string;
|
|
51697
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51698
|
+
message: string;
|
|
51699
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51700
|
+
error_code: 'seam_bridge_disconnected';
|
|
51701
|
+
} | {
|
|
51702
|
+
/** Date and time at which Seam created the error. */
|
|
51703
|
+
created_at: string;
|
|
51704
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51705
|
+
message: string;
|
|
51706
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51707
|
+
error_code: 'bridge_disconnected';
|
|
51708
|
+
is_bridge_error?: boolean | undefined;
|
|
51709
|
+
} | {
|
|
51710
|
+
/** Date and time at which Seam created the error. */
|
|
51711
|
+
created_at: string;
|
|
51712
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51713
|
+
message: string;
|
|
51714
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51715
|
+
error_code: 'visionline_instance_unreachable';
|
|
51716
|
+
} | {
|
|
51717
|
+
/** Date and time at which Seam created the error. */
|
|
51718
|
+
created_at: string;
|
|
51719
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51720
|
+
message: string;
|
|
51721
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51722
|
+
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
51723
|
+
} | {
|
|
51724
|
+
/** Date and time at which Seam created the error. */
|
|
51725
|
+
created_at: string;
|
|
51726
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51727
|
+
message: string;
|
|
51728
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51729
|
+
error_code: 'acs_system_disconnected';
|
|
51730
|
+
} | {
|
|
51731
|
+
/** Date and time at which Seam created the error. */
|
|
51732
|
+
created_at: string;
|
|
51733
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51734
|
+
message: string;
|
|
51735
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51736
|
+
error_code: 'account_disconnected';
|
|
51737
|
+
} | {
|
|
51738
|
+
/** Date and time at which Seam created the error. */
|
|
51739
|
+
created_at: string;
|
|
51740
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
51741
|
+
message: string;
|
|
51742
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
51743
|
+
error_code: 'salto_ks_certification_expired';
|
|
51744
|
+
}>;
|
|
51745
|
+
/** Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
|
|
51746
|
+
warnings: Array<{
|
|
51747
|
+
/** Date and time at which Seam created the warning. */
|
|
51748
|
+
created_at: string;
|
|
51749
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
51750
|
+
message: string;
|
|
51751
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
51752
|
+
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
51753
|
+
} | {
|
|
51754
|
+
/** Date and time at which Seam created the warning. */
|
|
51755
|
+
created_at: string;
|
|
51756
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
51757
|
+
message: string;
|
|
51758
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
51759
|
+
warning_code: 'time_zone_does_not_match_location';
|
|
51760
|
+
/**
|
|
51761
|
+
* @deprecated this field is deprecated. */
|
|
51762
|
+
misconfigured_acs_entrance_ids?: string[] | undefined;
|
|
51763
|
+
}>;
|
|
51764
|
+
}> | undefined;
|
|
51321
51765
|
};
|
|
51322
51766
|
};
|
|
51323
51767
|
};
|