@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.
@@ -11331,95 +11331,31 @@ export interface Routes {
11331
11331
  commonParams: {
11332
11332
  /** IDs of the access grants that you want to get along with their related resources. */
11333
11333
  access_grant_ids: string[]
11334
- include?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined
11335
- exclude?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined
11334
+ include?:
11335
+ | Array<
11336
+ | 'spaces'
11337
+ | 'devices'
11338
+ | 'acs_entrances'
11339
+ | 'connected_accounts'
11340
+ | 'acs_systems'
11341
+ | 'user_identity'
11342
+ >
11343
+ | undefined
11344
+ exclude?:
11345
+ | Array<
11346
+ | 'spaces'
11347
+ | 'devices'
11348
+ | 'acs_entrances'
11349
+ | 'connected_accounts'
11350
+ | 'acs_systems'
11351
+ | 'user_identity'
11352
+ >
11353
+ | undefined
11336
11354
  }
11337
11355
  formData: {}
11338
11356
  jsonResponse: {
11339
- /** Represents a resource batch. */
11340
11357
  batch: {
11341
- batch_type: 'workspaces' | 'access_grants' | 'access_methods' | 'spaces'
11342
- user_identities?:
11343
- | Array<{
11344
- /** ID of the user identity. */
11345
- user_identity_id: string
11346
- /** Unique key for the user identity. */
11347
- user_identity_key: string | null
11348
- /** Unique email address for the user identity. */
11349
- email_address: string | null
11350
- /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
11351
- phone_number: string | null
11352
- display_name: string
11353
- full_name: string | null
11354
- /** Date and time at which the user identity was created. */
11355
- created_at: string
11356
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
11357
- workspace_id: string
11358
- /** 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. */
11359
- errors: Array<{
11360
- /** Date and time at which Seam created the error. */
11361
- created_at: string
11362
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
11363
- message: string
11364
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
11365
- error_code: 'issue_with_acs_user'
11366
- /** ID of the access system user that has an issue. */
11367
- acs_user_id: string
11368
- /** ID of the access system that the user identity is associated with. */
11369
- acs_system_id: string
11370
- }>
11371
- /** 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. */
11372
- warnings: Array<
11373
- | {
11374
- /** Date and time at which Seam created the warning. */
11375
- created_at: string
11376
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11377
- message: string
11378
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11379
- warning_code: 'being_deleted'
11380
- }
11381
- | {
11382
- /** Date and time at which Seam created the warning. */
11383
- created_at: string
11384
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
11385
- message: string
11386
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
11387
- warning_code: 'acs_user_profile_does_not_match_user_identity'
11388
- }
11389
- >
11390
- /** Array of access system user IDs associated with the user identity. */
11391
- acs_user_ids: string[]
11392
- }>
11393
- | undefined
11394
- workspaces?:
11395
- | Array<{
11396
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
11397
- workspace_id: string
11398
- /** Name of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
11399
- name: string
11400
- /** Company name associated with the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
11401
- company_name: string
11402
- /** Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). */
11403
- is_sandbox: boolean
11404
- connect_webview_customization: {
11405
- /** 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). */
11406
- primary_button_color?: string | undefined
11407
- /** 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). */
11408
- primary_button_text_color?: string | undefined
11409
- /** 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). */
11410
- success_message?: string | undefined
11411
- /** 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). */
11412
- logo_shape?: ('circle' | 'square') | undefined
11413
- /** 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). */
11414
- inviter_logo_url?: string | undefined
11415
- }
11416
- /** 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. */
11417
- is_suspended: boolean
11418
- /**
11419
- * @deprecated Use `company_name` instead. */
11420
- connect_partner_name: (string | null) | null
11421
- }>
11422
- | undefined
11358
+ batch_type: 'access_grants'
11423
11359
  spaces?:
11424
11360
  | Array<{
11425
11361
  /** ID of the space. */
@@ -13091,6 +13027,368 @@ export interface Routes {
13091
13027
  can_unlock_with_code?: boolean | undefined
13092
13028
  }>
13093
13029
  | undefined
13030
+ user_identities?:
13031
+ | Array<{
13032
+ /** ID of the user identity. */
13033
+ user_identity_id: string
13034
+ /** Unique key for the user identity. */
13035
+ user_identity_key: string | null
13036
+ /** Unique email address for the user identity. */
13037
+ email_address: string | null
13038
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
13039
+ phone_number: string | null
13040
+ display_name: string
13041
+ full_name: string | null
13042
+ /** Date and time at which the user identity was created. */
13043
+ created_at: string
13044
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
13045
+ workspace_id: string
13046
+ /** 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. */
13047
+ errors: Array<{
13048
+ /** Date and time at which Seam created the error. */
13049
+ created_at: string
13050
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13051
+ message: string
13052
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13053
+ error_code: 'issue_with_acs_user'
13054
+ /** ID of the access system user that has an issue. */
13055
+ acs_user_id: string
13056
+ /** ID of the access system that the user identity is associated with. */
13057
+ acs_system_id: string
13058
+ }>
13059
+ /** 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. */
13060
+ warnings: Array<
13061
+ | {
13062
+ /** Date and time at which Seam created the warning. */
13063
+ created_at: string
13064
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13065
+ message: string
13066
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13067
+ warning_code: 'being_deleted'
13068
+ }
13069
+ | {
13070
+ /** Date and time at which Seam created the warning. */
13071
+ created_at: string
13072
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13073
+ message: string
13074
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13075
+ warning_code: 'acs_user_profile_does_not_match_user_identity'
13076
+ }
13077
+ >
13078
+ /** Array of access system user IDs associated with the user identity. */
13079
+ acs_user_ids: string[]
13080
+ }>
13081
+ | undefined
13082
+ connected_accounts?:
13083
+ | Array<{
13084
+ /** ID of the connected account. */
13085
+ connected_account_id?: string | undefined
13086
+ /** Date and time at which the connected account was created. */
13087
+ created_at?: string | undefined
13088
+ /** User identifier associated with the connected account. */
13089
+ user_identifier?:
13090
+ | {
13091
+ /** Username of the user identifier associated with the connected account. */
13092
+ username?: string | undefined
13093
+ /** API URL for the user identifier associated with the connected account. */
13094
+ api_url?: string | undefined
13095
+ /** Email address of the user identifier associated with the connected account. */
13096
+ email?: string | undefined
13097
+ /** Phone number of the user identifier associated with the connected account. */
13098
+ phone?: string | undefined
13099
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
13100
+ exclusive?: boolean | undefined
13101
+ }
13102
+ | undefined
13103
+ /** Type of connected account. */
13104
+ account_type?: string | undefined
13105
+ /** Display name for the connected account type. */
13106
+ account_type_display_name: string
13107
+ /** Errors associated with the connected account. */
13108
+ errors: Array<
13109
+ | {
13110
+ /** Date and time at which Seam created the error. */
13111
+ created_at: string
13112
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13113
+ message: string
13114
+ /** Indicates whether the error is related specifically to the connected account. */
13115
+ is_connected_account_error?: boolean | undefined
13116
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
13117
+ is_bridge_error?: boolean | undefined
13118
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13119
+ error_code: 'account_disconnected'
13120
+ }
13121
+ | {
13122
+ /** Date and time at which Seam created the error. */
13123
+ created_at: string
13124
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13125
+ message: string
13126
+ /** Indicates whether the error is related specifically to the connected account. */
13127
+ is_connected_account_error?: boolean | undefined
13128
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
13129
+ is_bridge_error?: boolean | undefined
13130
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13131
+ error_code: 'invalid_credentials'
13132
+ }
13133
+ | {
13134
+ /** Date and time at which Seam created the error. */
13135
+ created_at: string
13136
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13137
+ message: string
13138
+ /** Indicates whether the error is related specifically to the connected account. */
13139
+ is_connected_account_error?: boolean | undefined
13140
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
13141
+ is_bridge_error?: boolean | undefined
13142
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13143
+ error_code: 'bridge_disconnected'
13144
+ }
13145
+ | {
13146
+ /** Date and time at which Seam created the error. */
13147
+ created_at: string
13148
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13149
+ message: string
13150
+ /** Indicates whether the error is related specifically to the connected account. */
13151
+ is_connected_account_error?: boolean | undefined
13152
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
13153
+ is_bridge_error?: boolean | undefined
13154
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13155
+ error_code: 'salto_ks_subscription_limit_exceeded'
13156
+ /** Salto KS metadata associated with the connected account that has an error. */
13157
+ salto_ks_metadata: {
13158
+ /** Salto sites associated with the connected account that has an error. */
13159
+ sites: Array<{
13160
+ /** ID of a Salto site associated with the connected account that has an error. */
13161
+ site_id: string
13162
+ /** Name of a Salto site associated with the connected account that has an error. */
13163
+ site_name: string
13164
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
13165
+ subscribed_site_user_count: number
13166
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
13167
+ site_user_subscription_limit: number
13168
+ }>
13169
+ }
13170
+ }
13171
+ >
13172
+ /** Warnings associated with the connected account. */
13173
+ warnings: Array<
13174
+ | {
13175
+ /** Date and time at which Seam created the warning. */
13176
+ created_at: string
13177
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13178
+ message: string
13179
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13180
+ warning_code: 'scheduled_maintenance_window'
13181
+ }
13182
+ | {
13183
+ /** Date and time at which Seam created the warning. */
13184
+ created_at: string
13185
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13186
+ message: string
13187
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13188
+ warning_code: 'unknown_issue_with_connected_account'
13189
+ }
13190
+ | {
13191
+ /** Date and time at which Seam created the warning. */
13192
+ created_at: string
13193
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13194
+ message: string
13195
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13196
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
13197
+ /** Salto KS metadata associated with the connected account that has a warning. */
13198
+ salto_ks_metadata: {
13199
+ /** Salto sites associated with the connected account that has a warning. */
13200
+ sites: Array<{
13201
+ /** ID of a Salto site associated with the connected account that has a warning. */
13202
+ site_id: string
13203
+ /** Name of a Salto site associated with the connected account that has a warning. */
13204
+ site_name: string
13205
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
13206
+ site_user_subscription_limit: number
13207
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
13208
+ subscribed_site_user_count: number
13209
+ }>
13210
+ }
13211
+ }
13212
+ >
13213
+ /** 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. */
13214
+ custom_metadata: Record<string, string | boolean>
13215
+ /** 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. */
13216
+ automatically_manage_new_devices: boolean
13217
+ /** Your unique key for the customer associated with this connected account. */
13218
+ customer_key?: string | undefined
13219
+ /** List of capabilities that were accepted during the account connection process. */
13220
+ accepted_capabilities: Array<
13221
+ 'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
13222
+ >
13223
+ }>
13224
+ | undefined
13225
+ acs_systems?:
13226
+ | Array<{
13227
+ /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13228
+ default_credential_manager_acs_system_id?:
13229
+ | (string | null)
13230
+ | undefined
13231
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13232
+ acs_system_id: string
13233
+ acs_user_count?: number | undefined
13234
+ acs_access_group_count?: number | undefined
13235
+ /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
13236
+ external_type?:
13237
+ | (
13238
+ | 'pti_site'
13239
+ | 'alta_org'
13240
+ | 'salto_ks_site'
13241
+ | 'salto_space_system'
13242
+ | 'brivo_account'
13243
+ | 'hid_credential_manager_organization'
13244
+ | 'visionline_system'
13245
+ | 'assa_abloy_credential_service'
13246
+ | 'latch_building'
13247
+ | 'dormakaba_community_site'
13248
+ | 'legic_connect_credential_service'
13249
+ | 'assa_abloy_vostio'
13250
+ | 'assa_abloy_vostio_credential_service'
13251
+ )
13252
+ | undefined
13253
+ /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
13254
+ external_type_display_name?: string | undefined
13255
+ /** Indicates whether the `acs_system` is a credential manager. */
13256
+ is_credential_manager: boolean
13257
+ visionline_metadata?:
13258
+ | {
13259
+ /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
13260
+ mobile_access_uuid: string
13261
+ /** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
13262
+ system_id: string
13263
+ /** 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. */
13264
+ lan_address: string
13265
+ }
13266
+ | undefined
13267
+ /**
13268
+ * @deprecated Use `external_type`. */
13269
+ system_type?:
13270
+ | (
13271
+ | 'pti_site'
13272
+ | 'alta_org'
13273
+ | 'salto_ks_site'
13274
+ | 'salto_space_system'
13275
+ | 'brivo_account'
13276
+ | 'hid_credential_manager_organization'
13277
+ | 'visionline_system'
13278
+ | 'assa_abloy_credential_service'
13279
+ | 'latch_building'
13280
+ | 'dormakaba_community_site'
13281
+ | 'legic_connect_credential_service'
13282
+ | 'assa_abloy_vostio'
13283
+ | 'assa_abloy_vostio_credential_service'
13284
+ )
13285
+ | undefined
13286
+ /**
13287
+ * @deprecated Use `external_type_display_name`. */
13288
+ system_type_display_name?: string | undefined
13289
+ location: {
13290
+ /** Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. */
13291
+ time_zone: string | null
13292
+ }
13293
+ /** Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13294
+ name: string
13295
+ /** Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. */
13296
+ created_at: string
13297
+ /** 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). */
13298
+ workspace_id: string
13299
+ /** 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).
13300
+ * @deprecated Use `connected_account_id`. */
13301
+ connected_account_ids: string[]
13302
+ /** 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). */
13303
+ connected_account_id: string
13304
+ /** URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13305
+ image_url: string
13306
+ /** Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. */
13307
+ image_alt_text: string
13308
+ /** Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13309
+ errors: Array<
13310
+ | {
13311
+ /** Date and time at which Seam created the error. */
13312
+ created_at: string
13313
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13314
+ message: string
13315
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13316
+ error_code: 'seam_bridge_disconnected'
13317
+ }
13318
+ | {
13319
+ /** Date and time at which Seam created the error. */
13320
+ created_at: string
13321
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13322
+ message: string
13323
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13324
+ error_code: 'bridge_disconnected'
13325
+ is_bridge_error?: boolean | undefined
13326
+ }
13327
+ | {
13328
+ /** Date and time at which Seam created the error. */
13329
+ created_at: string
13330
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13331
+ message: string
13332
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13333
+ error_code: 'visionline_instance_unreachable'
13334
+ }
13335
+ | {
13336
+ /** Date and time at which Seam created the error. */
13337
+ created_at: string
13338
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13339
+ message: string
13340
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13341
+ error_code: 'salto_ks_subscription_limit_exceeded'
13342
+ }
13343
+ | {
13344
+ /** Date and time at which Seam created the error. */
13345
+ created_at: string
13346
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13347
+ message: string
13348
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13349
+ error_code: 'acs_system_disconnected'
13350
+ }
13351
+ | {
13352
+ /** Date and time at which Seam created the error. */
13353
+ created_at: string
13354
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13355
+ message: string
13356
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13357
+ error_code: 'account_disconnected'
13358
+ }
13359
+ | {
13360
+ /** Date and time at which Seam created the error. */
13361
+ created_at: string
13362
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13363
+ message: string
13364
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13365
+ error_code: 'salto_ks_certification_expired'
13366
+ }
13367
+ >
13368
+ /** Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13369
+ warnings: Array<
13370
+ | {
13371
+ /** Date and time at which Seam created the warning. */
13372
+ created_at: string
13373
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13374
+ message: string
13375
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13376
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
13377
+ }
13378
+ | {
13379
+ /** Date and time at which Seam created the warning. */
13380
+ created_at: string
13381
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13382
+ message: string
13383
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13384
+ warning_code: 'time_zone_does_not_match_location'
13385
+ /**
13386
+ * @deprecated this field is deprecated. */
13387
+ misconfigured_acs_entrance_ids?: string[] | undefined
13388
+ }
13389
+ >
13390
+ }>
13391
+ | undefined
13094
13392
  }
13095
13393
  }
13096
13394
  }
@@ -28970,8 +29268,8 @@ export interface Routes {
28970
29268
  /** List of reservations. */
28971
29269
  reservations?:
28972
29270
  | Array<{
28973
- /** Your display name for this access grant resource. */
28974
- name: string
29271
+ /** Your name for this access grant resource. */
29272
+ name?: string | undefined
28975
29273
  /** Starting date and time for the access grant. */
28976
29274
  starts_at?: string | undefined
28977
29275
  /** Ending date and time for the access grant. */
@@ -29009,8 +29307,8 @@ export interface Routes {
29009
29307
  /** List of bookings. */
29010
29308
  bookings?:
29011
29309
  | Array<{
29012
- /** Your display name for this access grant resource. */
29013
- name: string
29310
+ /** Your name for this access grant resource. */
29311
+ name?: string | undefined
29014
29312
  /** Starting date and time for the access grant. */
29015
29313
  starts_at?: string | undefined
29016
29314
  /** Ending date and time for the access grant. */
@@ -29048,8 +29346,8 @@ export interface Routes {
29048
29346
  /** List of access grants. */
29049
29347
  access_grants?:
29050
29348
  | Array<{
29051
- /** Your display name for this access grant resource. */
29052
- name: string
29349
+ /** Your name for this access grant resource. */
29350
+ name?: string | undefined
29053
29351
  /** Starting date and time for the access grant. */
29054
29352
  starts_at?: string | undefined
29055
29353
  /** Ending date and time for the access grant. */
@@ -29265,8 +29563,8 @@ export interface Routes {
29265
29563
  /** List of reservations. */
29266
29564
  reservations?:
29267
29565
  | Array<{
29268
- /** Your display name for this access grant resource. */
29269
- name: string
29566
+ /** Your name for this access grant resource. */
29567
+ name?: string | undefined
29270
29568
  /** Starting date and time for the access grant. */
29271
29569
  starts_at?: string | undefined
29272
29570
  /** Ending date and time for the access grant. */
@@ -29304,8 +29602,8 @@ export interface Routes {
29304
29602
  /** List of bookings. */
29305
29603
  bookings?:
29306
29604
  | Array<{
29307
- /** Your display name for this access grant resource. */
29308
- name: string
29605
+ /** Your name for this access grant resource. */
29606
+ name?: string | undefined
29309
29607
  /** Starting date and time for the access grant. */
29310
29608
  starts_at?: string | undefined
29311
29609
  /** Ending date and time for the access grant. */
@@ -29343,8 +29641,8 @@ export interface Routes {
29343
29641
  /** List of access grants. */
29344
29642
  access_grants?:
29345
29643
  | Array<{
29346
- /** Your display name for this access grant resource. */
29347
- name: string
29644
+ /** Your name for this access grant resource. */
29645
+ name?: string | undefined
29348
29646
  /** Starting date and time for the access grant. */
29349
29647
  starts_at?: string | undefined
29350
29648
  /** Ending date and time for the access grant. */
@@ -58133,8 +58431,8 @@ export interface Routes {
58133
58431
  }>
58134
58432
  }
58135
58433
  }
58136
- '/seam/console/v1/get_resource_type': {
58137
- route: '/seam/console/v1/get_resource_type'
58434
+ '/seam/console/v1/get_resource_locator': {
58435
+ route: '/seam/console/v1/get_resource_locator'
58138
58436
  method: 'GET' | 'POST'
58139
58437
  queryParams: {
58140
58438
  uuid: string
@@ -58143,7 +58441,11 @@ export interface Routes {
58143
58441
  commonParams: {}
58144
58442
  formData: {}
58145
58443
  jsonResponse: {
58146
- resource_type: string
58444
+ resource_locator: {
58445
+ resource_type: string
58446
+ acs_system_id?: string | undefined
58447
+ device_id?: string | undefined
58448
+ }
58147
58449
  }
58148
58450
  }
58149
58451
  '/seam/customer/v1/automation_runs/list': {
@@ -58242,13 +58544,13 @@ export interface Routes {
58242
58544
  reservation_time_updated?:
58243
58545
  | {
58244
58546
  rule: 'reservation_time_updated'
58245
- config: {}
58547
+ config?: {} | undefined
58246
58548
  }
58247
58549
  | undefined
58248
58550
  reservation_deleted?:
58249
58551
  | {
58250
58552
  rule: 'reservation_deleted'
58251
- config: {}
58553
+ config?: {} | undefined
58252
58554
  }
58253
58555
  | undefined
58254
58556
  }
@@ -58278,13 +58580,13 @@ export interface Routes {
58278
58580
  reservation_time_updated?:
58279
58581
  | {
58280
58582
  rule: 'reservation_time_updated'
58281
- config: {}
58583
+ config?: {} | undefined
58282
58584
  }
58283
58585
  | undefined
58284
58586
  reservation_deleted?:
58285
58587
  | {
58286
58588
  rule: 'reservation_deleted'
58287
- config: {}
58589
+ config?: {} | undefined
58288
58590
  }
58289
58591
  | undefined
58290
58592
  }
@@ -58898,6 +59200,59 @@ export interface Routes {
58898
59200
  }>
58899
59201
  }>
58900
59202
  }>
59203
+ /** User identity. */
59204
+ user_identity: {
59205
+ /** ID of the user identity. */
59206
+ user_identity_id: string
59207
+ /** Unique key for the user identity. */
59208
+ user_identity_key: string | null
59209
+ /** Unique email address for the user identity. */
59210
+ email_address: string | null
59211
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
59212
+ phone_number: string | null
59213
+ display_name: string
59214
+ full_name: string | null
59215
+ /** Date and time at which the user identity was created. */
59216
+ created_at: string
59217
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
59218
+ workspace_id: string
59219
+ /** 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. */
59220
+ errors: Array<{
59221
+ /** Date and time at which Seam created the error. */
59222
+ created_at: string
59223
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
59224
+ message: string
59225
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
59226
+ error_code: 'issue_with_acs_user'
59227
+ /** ID of the access system user that has an issue. */
59228
+ acs_user_id: string
59229
+ /** ID of the access system that the user identity is associated with. */
59230
+ acs_system_id: string
59231
+ }>
59232
+ /** 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. */
59233
+ warnings: Array<
59234
+ | {
59235
+ /** Date and time at which Seam created the warning. */
59236
+ created_at: string
59237
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59238
+ message: string
59239
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59240
+ warning_code: 'being_deleted'
59241
+ }
59242
+ | {
59243
+ /** Date and time at which Seam created the warning. */
59244
+ created_at: string
59245
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59246
+ message: string
59247
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59248
+ warning_code: 'acs_user_profile_does_not_match_user_identity'
59249
+ }
59250
+ >
59251
+ /** Array of access system user IDs associated with the user identity. */
59252
+ acs_user_ids: string[]
59253
+ }
59254
+ /** Workspace ID. */
59255
+ workspace_id: string
58901
59256
  }
58902
59257
  }
58903
59258
  }
@@ -59052,95 +59407,30 @@ export interface Routes {
59052
59407
  commonParams: {
59053
59408
  /** IDs of the spaces that you want to get along with their related resources. */
59054
59409
  space_ids: string[]
59055
- include?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined
59056
- exclude?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined
59410
+ include?:
59411
+ | Array<
59412
+ | 'spaces'
59413
+ | 'devices'
59414
+ | 'acs_entrances'
59415
+ | 'connected_accounts'
59416
+ | 'acs_systems'
59417
+ >
59418
+ | undefined
59419
+ exclude?:
59420
+ | Array<
59421
+ | 'spaces'
59422
+ | 'devices'
59423
+ | 'acs_entrances'
59424
+ | 'connected_accounts'
59425
+ | 'acs_systems'
59426
+ >
59427
+ | undefined
59057
59428
  }
59058
59429
  formData: {}
59059
59430
  jsonResponse: {
59060
- /** Represents a resource batch. */
59431
+ /** ID of the affected access system user. */
59061
59432
  batch: {
59062
- batch_type: 'workspaces' | 'access_grants' | 'access_methods' | 'spaces'
59063
- user_identities?:
59064
- | Array<{
59065
- /** ID of the user identity. */
59066
- user_identity_id: string
59067
- /** Unique key for the user identity. */
59068
- user_identity_key: string | null
59069
- /** Unique email address for the user identity. */
59070
- email_address: string | null
59071
- /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
59072
- phone_number: string | null
59073
- display_name: string
59074
- full_name: string | null
59075
- /** Date and time at which the user identity was created. */
59076
- created_at: string
59077
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
59078
- workspace_id: string
59079
- /** 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. */
59080
- errors: Array<{
59081
- /** Date and time at which Seam created the error. */
59082
- created_at: string
59083
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
59084
- message: string
59085
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
59086
- error_code: 'issue_with_acs_user'
59087
- /** ID of the access system user that has an issue. */
59088
- acs_user_id: string
59089
- /** ID of the access system that the user identity is associated with. */
59090
- acs_system_id: string
59091
- }>
59092
- /** 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. */
59093
- warnings: Array<
59094
- | {
59095
- /** Date and time at which Seam created the warning. */
59096
- created_at: string
59097
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59098
- message: string
59099
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59100
- warning_code: 'being_deleted'
59101
- }
59102
- | {
59103
- /** Date and time at which Seam created the warning. */
59104
- created_at: string
59105
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59106
- message: string
59107
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59108
- warning_code: 'acs_user_profile_does_not_match_user_identity'
59109
- }
59110
- >
59111
- /** Array of access system user IDs associated with the user identity. */
59112
- acs_user_ids: string[]
59113
- }>
59114
- | undefined
59115
- workspaces?:
59116
- | Array<{
59117
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
59118
- workspace_id: string
59119
- /** Name of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
59120
- name: string
59121
- /** Company name associated with the [workspace](https://docs.seam.co/latest/core-concepts/workspaces). */
59122
- company_name: string
59123
- /** Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). */
59124
- is_sandbox: boolean
59125
- connect_webview_customization: {
59126
- /** 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). */
59127
- primary_button_color?: string | undefined
59128
- /** 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). */
59129
- primary_button_text_color?: string | undefined
59130
- /** 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). */
59131
- success_message?: string | undefined
59132
- /** 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). */
59133
- logo_shape?: ('circle' | 'square') | undefined
59134
- /** 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). */
59135
- inviter_logo_url?: string | undefined
59136
- }
59137
- /** 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. */
59138
- is_suspended: boolean
59139
- /**
59140
- * @deprecated Use `company_name` instead. */
59141
- connect_partner_name: (string | null) | null
59142
- }>
59143
- | undefined
59433
+ batch_type: 'spaces'
59144
59434
  spaces?:
59145
59435
  | Array<{
59146
59436
  /** ID of the space. */
@@ -60812,6 +61102,316 @@ export interface Routes {
60812
61102
  can_unlock_with_code?: boolean | undefined
60813
61103
  }>
60814
61104
  | undefined
61105
+ connected_accounts?:
61106
+ | Array<{
61107
+ /** ID of the connected account. */
61108
+ connected_account_id?: string | undefined
61109
+ /** Date and time at which the connected account was created. */
61110
+ created_at?: string | undefined
61111
+ /** User identifier associated with the connected account. */
61112
+ user_identifier?:
61113
+ | {
61114
+ /** Username of the user identifier associated with the connected account. */
61115
+ username?: string | undefined
61116
+ /** API URL for the user identifier associated with the connected account. */
61117
+ api_url?: string | undefined
61118
+ /** Email address of the user identifier associated with the connected account. */
61119
+ email?: string | undefined
61120
+ /** Phone number of the user identifier associated with the connected account. */
61121
+ phone?: string | undefined
61122
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
61123
+ exclusive?: boolean | undefined
61124
+ }
61125
+ | undefined
61126
+ /** Type of connected account. */
61127
+ account_type?: string | undefined
61128
+ /** Display name for the connected account type. */
61129
+ account_type_display_name: string
61130
+ /** Errors associated with the connected account. */
61131
+ errors: Array<
61132
+ | {
61133
+ /** Date and time at which Seam created the error. */
61134
+ created_at: string
61135
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61136
+ message: string
61137
+ /** Indicates whether the error is related specifically to the connected account. */
61138
+ is_connected_account_error?: boolean | undefined
61139
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
61140
+ is_bridge_error?: boolean | undefined
61141
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61142
+ error_code: 'account_disconnected'
61143
+ }
61144
+ | {
61145
+ /** Date and time at which Seam created the error. */
61146
+ created_at: string
61147
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61148
+ message: string
61149
+ /** Indicates whether the error is related specifically to the connected account. */
61150
+ is_connected_account_error?: boolean | undefined
61151
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
61152
+ is_bridge_error?: boolean | undefined
61153
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61154
+ error_code: 'invalid_credentials'
61155
+ }
61156
+ | {
61157
+ /** Date and time at which Seam created the error. */
61158
+ created_at: string
61159
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61160
+ message: string
61161
+ /** Indicates whether the error is related specifically to the connected account. */
61162
+ is_connected_account_error?: boolean | undefined
61163
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
61164
+ is_bridge_error?: boolean | undefined
61165
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61166
+ error_code: 'bridge_disconnected'
61167
+ }
61168
+ | {
61169
+ /** Date and time at which Seam created the error. */
61170
+ created_at: string
61171
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61172
+ message: string
61173
+ /** Indicates whether the error is related specifically to the connected account. */
61174
+ is_connected_account_error?: boolean | undefined
61175
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
61176
+ is_bridge_error?: boolean | undefined
61177
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61178
+ error_code: 'salto_ks_subscription_limit_exceeded'
61179
+ /** Salto KS metadata associated with the connected account that has an error. */
61180
+ salto_ks_metadata: {
61181
+ /** Salto sites associated with the connected account that has an error. */
61182
+ sites: Array<{
61183
+ /** ID of a Salto site associated with the connected account that has an error. */
61184
+ site_id: string
61185
+ /** Name of a Salto site associated with the connected account that has an error. */
61186
+ site_name: string
61187
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
61188
+ subscribed_site_user_count: number
61189
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
61190
+ site_user_subscription_limit: number
61191
+ }>
61192
+ }
61193
+ }
61194
+ >
61195
+ /** Warnings associated with the connected account. */
61196
+ warnings: Array<
61197
+ | {
61198
+ /** Date and time at which Seam created the warning. */
61199
+ created_at: string
61200
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61201
+ message: string
61202
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61203
+ warning_code: 'scheduled_maintenance_window'
61204
+ }
61205
+ | {
61206
+ /** Date and time at which Seam created the warning. */
61207
+ created_at: string
61208
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61209
+ message: string
61210
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61211
+ warning_code: 'unknown_issue_with_connected_account'
61212
+ }
61213
+ | {
61214
+ /** Date and time at which Seam created the warning. */
61215
+ created_at: string
61216
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61217
+ message: string
61218
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61219
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
61220
+ /** Salto KS metadata associated with the connected account that has a warning. */
61221
+ salto_ks_metadata: {
61222
+ /** Salto sites associated with the connected account that has a warning. */
61223
+ sites: Array<{
61224
+ /** ID of a Salto site associated with the connected account that has a warning. */
61225
+ site_id: string
61226
+ /** Name of a Salto site associated with the connected account that has a warning. */
61227
+ site_name: string
61228
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
61229
+ site_user_subscription_limit: number
61230
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
61231
+ subscribed_site_user_count: number
61232
+ }>
61233
+ }
61234
+ }
61235
+ >
61236
+ /** 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. */
61237
+ custom_metadata: Record<string, string | boolean>
61238
+ /** 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. */
61239
+ automatically_manage_new_devices: boolean
61240
+ /** Your unique key for the customer associated with this connected account. */
61241
+ customer_key?: string | undefined
61242
+ /** List of capabilities that were accepted during the account connection process. */
61243
+ accepted_capabilities: Array<
61244
+ 'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
61245
+ >
61246
+ }>
61247
+ | undefined
61248
+ acs_systems?:
61249
+ | Array<{
61250
+ /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61251
+ default_credential_manager_acs_system_id?:
61252
+ | (string | null)
61253
+ | undefined
61254
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61255
+ acs_system_id: string
61256
+ acs_user_count?: number | undefined
61257
+ acs_access_group_count?: number | undefined
61258
+ /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
61259
+ external_type?:
61260
+ | (
61261
+ | 'pti_site'
61262
+ | 'alta_org'
61263
+ | 'salto_ks_site'
61264
+ | 'salto_space_system'
61265
+ | 'brivo_account'
61266
+ | 'hid_credential_manager_organization'
61267
+ | 'visionline_system'
61268
+ | 'assa_abloy_credential_service'
61269
+ | 'latch_building'
61270
+ | 'dormakaba_community_site'
61271
+ | 'legic_connect_credential_service'
61272
+ | 'assa_abloy_vostio'
61273
+ | 'assa_abloy_vostio_credential_service'
61274
+ )
61275
+ | undefined
61276
+ /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
61277
+ external_type_display_name?: string | undefined
61278
+ /** Indicates whether the `acs_system` is a credential manager. */
61279
+ is_credential_manager: boolean
61280
+ visionline_metadata?:
61281
+ | {
61282
+ /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
61283
+ mobile_access_uuid: string
61284
+ /** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
61285
+ system_id: string
61286
+ /** 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. */
61287
+ lan_address: string
61288
+ }
61289
+ | undefined
61290
+ /**
61291
+ * @deprecated Use `external_type`. */
61292
+ system_type?:
61293
+ | (
61294
+ | 'pti_site'
61295
+ | 'alta_org'
61296
+ | 'salto_ks_site'
61297
+ | 'salto_space_system'
61298
+ | 'brivo_account'
61299
+ | 'hid_credential_manager_organization'
61300
+ | 'visionline_system'
61301
+ | 'assa_abloy_credential_service'
61302
+ | 'latch_building'
61303
+ | 'dormakaba_community_site'
61304
+ | 'legic_connect_credential_service'
61305
+ | 'assa_abloy_vostio'
61306
+ | 'assa_abloy_vostio_credential_service'
61307
+ )
61308
+ | undefined
61309
+ /**
61310
+ * @deprecated Use `external_type_display_name`. */
61311
+ system_type_display_name?: string | undefined
61312
+ location: {
61313
+ /** Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. */
61314
+ time_zone: string | null
61315
+ }
61316
+ /** Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61317
+ name: string
61318
+ /** Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. */
61319
+ created_at: string
61320
+ /** 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). */
61321
+ workspace_id: string
61322
+ /** 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).
61323
+ * @deprecated Use `connected_account_id`. */
61324
+ connected_account_ids: string[]
61325
+ /** 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). */
61326
+ connected_account_id: string
61327
+ /** URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61328
+ image_url: string
61329
+ /** Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. */
61330
+ image_alt_text: string
61331
+ /** Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61332
+ errors: Array<
61333
+ | {
61334
+ /** Date and time at which Seam created the error. */
61335
+ created_at: string
61336
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61337
+ message: string
61338
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61339
+ error_code: 'seam_bridge_disconnected'
61340
+ }
61341
+ | {
61342
+ /** Date and time at which Seam created the error. */
61343
+ created_at: string
61344
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61345
+ message: string
61346
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61347
+ error_code: 'bridge_disconnected'
61348
+ is_bridge_error?: boolean | undefined
61349
+ }
61350
+ | {
61351
+ /** Date and time at which Seam created the error. */
61352
+ created_at: string
61353
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61354
+ message: string
61355
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61356
+ error_code: 'visionline_instance_unreachable'
61357
+ }
61358
+ | {
61359
+ /** Date and time at which Seam created the error. */
61360
+ created_at: string
61361
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61362
+ message: string
61363
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61364
+ error_code: 'salto_ks_subscription_limit_exceeded'
61365
+ }
61366
+ | {
61367
+ /** Date and time at which Seam created the error. */
61368
+ created_at: string
61369
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61370
+ message: string
61371
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61372
+ error_code: 'acs_system_disconnected'
61373
+ }
61374
+ | {
61375
+ /** Date and time at which Seam created the error. */
61376
+ created_at: string
61377
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61378
+ message: string
61379
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61380
+ error_code: 'account_disconnected'
61381
+ }
61382
+ | {
61383
+ /** Date and time at which Seam created the error. */
61384
+ created_at: string
61385
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61386
+ message: string
61387
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61388
+ error_code: 'salto_ks_certification_expired'
61389
+ }
61390
+ >
61391
+ /** Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61392
+ warnings: Array<
61393
+ | {
61394
+ /** Date and time at which Seam created the warning. */
61395
+ created_at: string
61396
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61397
+ message: string
61398
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61399
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
61400
+ }
61401
+ | {
61402
+ /** Date and time at which Seam created the warning. */
61403
+ created_at: string
61404
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61405
+ message: string
61406
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61407
+ warning_code: 'time_zone_does_not_match_location'
61408
+ /**
61409
+ * @deprecated this field is deprecated. */
61410
+ misconfigured_acs_entrance_ids?: string[] | undefined
61411
+ }
61412
+ >
61413
+ }>
61414
+ | undefined
60815
61415
  }
60816
61416
  }
60817
61417
  }