@seamapi/types 1.460.0 → 1.461.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11177,6 +11177,8 @@ export interface Routes {
11177
11177
  location_ids?: string[] | undefined
11178
11178
  /** Set of IDs of existing spaces to which access is being granted. */
11179
11179
  space_ids?: string[] | undefined
11180
+ /** Set of keys of existing spaces to which access is being granted. */
11181
+ space_keys?: string[] | undefined
11180
11182
  /** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
11181
11183
  location?:
11182
11184
  | {
@@ -11331,95 +11333,31 @@ export interface Routes {
11331
11333
  commonParams: {
11332
11334
  /** IDs of the access grants that you want to get along with their related resources. */
11333
11335
  access_grant_ids: string[]
11334
- include?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined
11335
- exclude?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined
11336
+ include?:
11337
+ | Array<
11338
+ | 'spaces'
11339
+ | 'devices'
11340
+ | 'acs_entrances'
11341
+ | 'connected_accounts'
11342
+ | 'acs_systems'
11343
+ | 'user_identity'
11344
+ >
11345
+ | undefined
11346
+ exclude?:
11347
+ | Array<
11348
+ | 'spaces'
11349
+ | 'devices'
11350
+ | 'acs_entrances'
11351
+ | 'connected_accounts'
11352
+ | 'acs_systems'
11353
+ | 'user_identity'
11354
+ >
11355
+ | undefined
11336
11356
  }
11337
11357
  formData: {}
11338
11358
  jsonResponse: {
11339
- /** Represents a resource batch. */
11340
11359
  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
11360
+ batch_type: 'access_grants'
11423
11361
  spaces?:
11424
11362
  | Array<{
11425
11363
  /** ID of the space. */
@@ -13091,6 +13029,368 @@ export interface Routes {
13091
13029
  can_unlock_with_code?: boolean | undefined
13092
13030
  }>
13093
13031
  | undefined
13032
+ user_identities?:
13033
+ | Array<{
13034
+ /** ID of the user identity. */
13035
+ user_identity_id: string
13036
+ /** Unique key for the user identity. */
13037
+ user_identity_key: string | null
13038
+ /** Unique email address for the user identity. */
13039
+ email_address: string | null
13040
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
13041
+ phone_number: string | null
13042
+ display_name: string
13043
+ full_name: string | null
13044
+ /** Date and time at which the user identity was created. */
13045
+ created_at: string
13046
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
13047
+ workspace_id: string
13048
+ /** 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. */
13049
+ errors: Array<{
13050
+ /** Date and time at which Seam created the error. */
13051
+ created_at: string
13052
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13053
+ message: string
13054
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13055
+ error_code: 'issue_with_acs_user'
13056
+ /** ID of the access system user that has an issue. */
13057
+ acs_user_id: string
13058
+ /** ID of the access system that the user identity is associated with. */
13059
+ acs_system_id: string
13060
+ }>
13061
+ /** 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. */
13062
+ warnings: Array<
13063
+ | {
13064
+ /** Date and time at which Seam created the warning. */
13065
+ created_at: string
13066
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13067
+ message: string
13068
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13069
+ warning_code: 'being_deleted'
13070
+ }
13071
+ | {
13072
+ /** Date and time at which Seam created the warning. */
13073
+ created_at: string
13074
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13075
+ message: string
13076
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13077
+ warning_code: 'acs_user_profile_does_not_match_user_identity'
13078
+ }
13079
+ >
13080
+ /** Array of access system user IDs associated with the user identity. */
13081
+ acs_user_ids: string[]
13082
+ }>
13083
+ | undefined
13084
+ connected_accounts?:
13085
+ | Array<{
13086
+ /** ID of the connected account. */
13087
+ connected_account_id?: string | undefined
13088
+ /** Date and time at which the connected account was created. */
13089
+ created_at?: string | undefined
13090
+ /** User identifier associated with the connected account. */
13091
+ user_identifier?:
13092
+ | {
13093
+ /** Username of the user identifier associated with the connected account. */
13094
+ username?: string | undefined
13095
+ /** API URL for the user identifier associated with the connected account. */
13096
+ api_url?: string | undefined
13097
+ /** Email address of the user identifier associated with the connected account. */
13098
+ email?: string | undefined
13099
+ /** Phone number of the user identifier associated with the connected account. */
13100
+ phone?: string | undefined
13101
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
13102
+ exclusive?: boolean | undefined
13103
+ }
13104
+ | undefined
13105
+ /** Type of connected account. */
13106
+ account_type?: string | undefined
13107
+ /** Display name for the connected account type. */
13108
+ account_type_display_name: string
13109
+ /** Errors associated with the connected account. */
13110
+ errors: Array<
13111
+ | {
13112
+ /** Date and time at which Seam created the error. */
13113
+ created_at: string
13114
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13115
+ message: string
13116
+ /** Indicates whether the error is related specifically to the connected account. */
13117
+ is_connected_account_error?: boolean | undefined
13118
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
13119
+ is_bridge_error?: boolean | undefined
13120
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13121
+ error_code: 'account_disconnected'
13122
+ }
13123
+ | {
13124
+ /** Date and time at which Seam created the error. */
13125
+ created_at: string
13126
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13127
+ message: string
13128
+ /** Indicates whether the error is related specifically to the connected account. */
13129
+ is_connected_account_error?: boolean | undefined
13130
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
13131
+ is_bridge_error?: boolean | undefined
13132
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13133
+ error_code: 'invalid_credentials'
13134
+ }
13135
+ | {
13136
+ /** Date and time at which Seam created the error. */
13137
+ created_at: string
13138
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13139
+ message: string
13140
+ /** Indicates whether the error is related specifically to the connected account. */
13141
+ is_connected_account_error?: boolean | undefined
13142
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
13143
+ is_bridge_error?: boolean | undefined
13144
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13145
+ error_code: 'bridge_disconnected'
13146
+ }
13147
+ | {
13148
+ /** Date and time at which Seam created the error. */
13149
+ created_at: string
13150
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13151
+ message: string
13152
+ /** Indicates whether the error is related specifically to the connected account. */
13153
+ is_connected_account_error?: boolean | undefined
13154
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
13155
+ is_bridge_error?: boolean | undefined
13156
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13157
+ error_code: 'salto_ks_subscription_limit_exceeded'
13158
+ /** Salto KS metadata associated with the connected account that has an error. */
13159
+ salto_ks_metadata: {
13160
+ /** Salto sites associated with the connected account that has an error. */
13161
+ sites: Array<{
13162
+ /** ID of a Salto site associated with the connected account that has an error. */
13163
+ site_id: string
13164
+ /** Name of a Salto site associated with the connected account that has an error. */
13165
+ site_name: string
13166
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
13167
+ subscribed_site_user_count: number
13168
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
13169
+ site_user_subscription_limit: number
13170
+ }>
13171
+ }
13172
+ }
13173
+ >
13174
+ /** Warnings associated with the connected account. */
13175
+ warnings: Array<
13176
+ | {
13177
+ /** Date and time at which Seam created the warning. */
13178
+ created_at: string
13179
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13180
+ message: string
13181
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13182
+ warning_code: 'scheduled_maintenance_window'
13183
+ }
13184
+ | {
13185
+ /** Date and time at which Seam created the warning. */
13186
+ created_at: string
13187
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13188
+ message: string
13189
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13190
+ warning_code: 'unknown_issue_with_connected_account'
13191
+ }
13192
+ | {
13193
+ /** Date and time at which Seam created the warning. */
13194
+ created_at: string
13195
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13196
+ message: string
13197
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13198
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
13199
+ /** Salto KS metadata associated with the connected account that has a warning. */
13200
+ salto_ks_metadata: {
13201
+ /** Salto sites associated with the connected account that has a warning. */
13202
+ sites: Array<{
13203
+ /** ID of a Salto site associated with the connected account that has a warning. */
13204
+ site_id: string
13205
+ /** Name of a Salto site associated with the connected account that has a warning. */
13206
+ site_name: string
13207
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
13208
+ site_user_subscription_limit: number
13209
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
13210
+ subscribed_site_user_count: number
13211
+ }>
13212
+ }
13213
+ }
13214
+ >
13215
+ /** 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. */
13216
+ custom_metadata: Record<string, string | boolean>
13217
+ /** 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. */
13218
+ automatically_manage_new_devices: boolean
13219
+ /** Your unique key for the customer associated with this connected account. */
13220
+ customer_key?: string | undefined
13221
+ /** List of capabilities that were accepted during the account connection process. */
13222
+ accepted_capabilities: Array<
13223
+ 'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
13224
+ >
13225
+ }>
13226
+ | undefined
13227
+ acs_systems?:
13228
+ | Array<{
13229
+ /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13230
+ default_credential_manager_acs_system_id?:
13231
+ | (string | null)
13232
+ | undefined
13233
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13234
+ acs_system_id: string
13235
+ acs_user_count?: number | undefined
13236
+ acs_access_group_count?: number | undefined
13237
+ /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
13238
+ external_type?:
13239
+ | (
13240
+ | 'pti_site'
13241
+ | 'alta_org'
13242
+ | 'salto_ks_site'
13243
+ | 'salto_space_system'
13244
+ | 'brivo_account'
13245
+ | 'hid_credential_manager_organization'
13246
+ | 'visionline_system'
13247
+ | 'assa_abloy_credential_service'
13248
+ | 'latch_building'
13249
+ | 'dormakaba_community_site'
13250
+ | 'legic_connect_credential_service'
13251
+ | 'assa_abloy_vostio'
13252
+ | 'assa_abloy_vostio_credential_service'
13253
+ )
13254
+ | undefined
13255
+ /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
13256
+ external_type_display_name?: string | undefined
13257
+ /** Indicates whether the `acs_system` is a credential manager. */
13258
+ is_credential_manager: boolean
13259
+ visionline_metadata?:
13260
+ | {
13261
+ /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
13262
+ mobile_access_uuid: string
13263
+ /** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
13264
+ system_id: string
13265
+ /** 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. */
13266
+ lan_address: string
13267
+ }
13268
+ | undefined
13269
+ /**
13270
+ * @deprecated Use `external_type`. */
13271
+ system_type?:
13272
+ | (
13273
+ | 'pti_site'
13274
+ | 'alta_org'
13275
+ | 'salto_ks_site'
13276
+ | 'salto_space_system'
13277
+ | 'brivo_account'
13278
+ | 'hid_credential_manager_organization'
13279
+ | 'visionline_system'
13280
+ | 'assa_abloy_credential_service'
13281
+ | 'latch_building'
13282
+ | 'dormakaba_community_site'
13283
+ | 'legic_connect_credential_service'
13284
+ | 'assa_abloy_vostio'
13285
+ | 'assa_abloy_vostio_credential_service'
13286
+ )
13287
+ | undefined
13288
+ /**
13289
+ * @deprecated Use `external_type_display_name`. */
13290
+ system_type_display_name?: string | undefined
13291
+ location: {
13292
+ /** Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. */
13293
+ time_zone: string | null
13294
+ }
13295
+ /** Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13296
+ name: string
13297
+ /** Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. */
13298
+ created_at: string
13299
+ /** 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). */
13300
+ workspace_id: string
13301
+ /** 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).
13302
+ * @deprecated Use `connected_account_id`. */
13303
+ connected_account_ids: string[]
13304
+ /** 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). */
13305
+ connected_account_id: string
13306
+ /** URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13307
+ image_url: string
13308
+ /** Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. */
13309
+ image_alt_text: string
13310
+ /** Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13311
+ errors: Array<
13312
+ | {
13313
+ /** Date and time at which Seam created the error. */
13314
+ created_at: string
13315
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13316
+ message: string
13317
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13318
+ error_code: 'seam_bridge_disconnected'
13319
+ }
13320
+ | {
13321
+ /** Date and time at which Seam created the error. */
13322
+ created_at: string
13323
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13324
+ message: string
13325
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13326
+ error_code: 'bridge_disconnected'
13327
+ is_bridge_error?: boolean | undefined
13328
+ }
13329
+ | {
13330
+ /** Date and time at which Seam created the error. */
13331
+ created_at: string
13332
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13333
+ message: string
13334
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13335
+ error_code: 'visionline_instance_unreachable'
13336
+ }
13337
+ | {
13338
+ /** Date and time at which Seam created the error. */
13339
+ created_at: string
13340
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13341
+ message: string
13342
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13343
+ error_code: 'salto_ks_subscription_limit_exceeded'
13344
+ }
13345
+ | {
13346
+ /** Date and time at which Seam created the error. */
13347
+ created_at: string
13348
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13349
+ message: string
13350
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13351
+ error_code: 'acs_system_disconnected'
13352
+ }
13353
+ | {
13354
+ /** Date and time at which Seam created the error. */
13355
+ created_at: string
13356
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13357
+ message: string
13358
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13359
+ error_code: 'account_disconnected'
13360
+ }
13361
+ | {
13362
+ /** Date and time at which Seam created the error. */
13363
+ created_at: string
13364
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13365
+ message: string
13366
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
13367
+ error_code: 'salto_ks_certification_expired'
13368
+ }
13369
+ >
13370
+ /** Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
13371
+ warnings: Array<
13372
+ | {
13373
+ /** Date and time at which Seam created the warning. */
13374
+ created_at: string
13375
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13376
+ message: string
13377
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13378
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
13379
+ }
13380
+ | {
13381
+ /** Date and time at which Seam created the warning. */
13382
+ created_at: string
13383
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
13384
+ message: string
13385
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
13386
+ warning_code: 'time_zone_does_not_match_location'
13387
+ /**
13388
+ * @deprecated this field is deprecated. */
13389
+ misconfigured_acs_entrance_ids?: string[] | undefined
13390
+ }
13391
+ >
13392
+ }>
13393
+ | undefined
13094
13394
  }
13095
13395
  }
13096
13396
  }
@@ -28970,8 +29270,8 @@ export interface Routes {
28970
29270
  /** List of reservations. */
28971
29271
  reservations?:
28972
29272
  | Array<{
28973
- /** Your display name for this access grant resource. */
28974
- name: string
29273
+ /** Your name for this access grant resource. */
29274
+ name?: string | undefined
28975
29275
  /** Starting date and time for the access grant. */
28976
29276
  starts_at?: string | undefined
28977
29277
  /** Ending date and time for the access grant. */
@@ -29009,8 +29309,8 @@ export interface Routes {
29009
29309
  /** List of bookings. */
29010
29310
  bookings?:
29011
29311
  | Array<{
29012
- /** Your display name for this access grant resource. */
29013
- name: string
29312
+ /** Your name for this access grant resource. */
29313
+ name?: string | undefined
29014
29314
  /** Starting date and time for the access grant. */
29015
29315
  starts_at?: string | undefined
29016
29316
  /** Ending date and time for the access grant. */
@@ -29048,8 +29348,8 @@ export interface Routes {
29048
29348
  /** List of access grants. */
29049
29349
  access_grants?:
29050
29350
  | Array<{
29051
- /** Your display name for this access grant resource. */
29052
- name: string
29351
+ /** Your name for this access grant resource. */
29352
+ name?: string | undefined
29053
29353
  /** Starting date and time for the access grant. */
29054
29354
  starts_at?: string | undefined
29055
29355
  /** Ending date and time for the access grant. */
@@ -29265,8 +29565,8 @@ export interface Routes {
29265
29565
  /** List of reservations. */
29266
29566
  reservations?:
29267
29567
  | Array<{
29268
- /** Your display name for this access grant resource. */
29269
- name: string
29568
+ /** Your name for this access grant resource. */
29569
+ name?: string | undefined
29270
29570
  /** Starting date and time for the access grant. */
29271
29571
  starts_at?: string | undefined
29272
29572
  /** Ending date and time for the access grant. */
@@ -29304,8 +29604,8 @@ export interface Routes {
29304
29604
  /** List of bookings. */
29305
29605
  bookings?:
29306
29606
  | Array<{
29307
- /** Your display name for this access grant resource. */
29308
- name: string
29607
+ /** Your name for this access grant resource. */
29608
+ name?: string | undefined
29309
29609
  /** Starting date and time for the access grant. */
29310
29610
  starts_at?: string | undefined
29311
29611
  /** Ending date and time for the access grant. */
@@ -29343,8 +29643,8 @@ export interface Routes {
29343
29643
  /** List of access grants. */
29344
29644
  access_grants?:
29345
29645
  | Array<{
29346
- /** Your display name for this access grant resource. */
29347
- name: string
29646
+ /** Your name for this access grant resource. */
29647
+ name?: string | undefined
29348
29648
  /** Starting date and time for the access grant. */
29349
29649
  starts_at?: string | undefined
29350
29650
  /** Ending date and time for the access grant. */
@@ -38103,6 +38403,35 @@ export interface Routes {
38103
38403
  >
38104
38404
  }
38105
38405
  }
38406
+ '/instant_keys/list': {
38407
+ route: '/instant_keys/list'
38408
+ method: 'GET' | 'POST'
38409
+ queryParams: {}
38410
+ jsonBody: {}
38411
+ commonParams: {
38412
+ /** ID of the user identity by which you want to filter the list of Instant Keys. */
38413
+ user_identity_id?: string | undefined
38414
+ }
38415
+ formData: {}
38416
+ jsonResponse: {
38417
+ instant_keys: Array<{
38418
+ /** ID of the Instant Key. */
38419
+ instant_key_id: string
38420
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key. */
38421
+ workspace_id: string
38422
+ /** Date and time at which the Instant Key was created. */
38423
+ created_at: string
38424
+ /** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */
38425
+ instant_key_url: string
38426
+ /** ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */
38427
+ client_session_id: string
38428
+ /** ID of the user identity associated with the Instant Key. */
38429
+ user_identity_id: string
38430
+ /** Date and time at which the Instant Key expires. */
38431
+ expires_at: string
38432
+ }>
38433
+ }
38434
+ }
38106
38435
  '/locks/get': {
38107
38436
  route: '/locks/get'
38108
38437
  method: 'GET' | 'POST'
@@ -58133,8 +58462,8 @@ export interface Routes {
58133
58462
  }>
58134
58463
  }
58135
58464
  }
58136
- '/seam/console/v1/get_resource_type': {
58137
- route: '/seam/console/v1/get_resource_type'
58465
+ '/seam/console/v1/get_resource_locator': {
58466
+ route: '/seam/console/v1/get_resource_locator'
58138
58467
  method: 'GET' | 'POST'
58139
58468
  queryParams: {
58140
58469
  uuid: string
@@ -58143,7 +58472,11 @@ export interface Routes {
58143
58472
  commonParams: {}
58144
58473
  formData: {}
58145
58474
  jsonResponse: {
58146
- resource_type: string
58475
+ resource_locator: {
58476
+ resource_type: string
58477
+ acs_system_id?: string | undefined
58478
+ device_id?: string | undefined
58479
+ }
58147
58480
  }
58148
58481
  }
58149
58482
  '/seam/customer/v1/automation_runs/list': {
@@ -58242,13 +58575,13 @@ export interface Routes {
58242
58575
  reservation_time_updated?:
58243
58576
  | {
58244
58577
  rule: 'reservation_time_updated'
58245
- config: {}
58578
+ config?: {} | undefined
58246
58579
  }
58247
58580
  | undefined
58248
58581
  reservation_deleted?:
58249
58582
  | {
58250
58583
  rule: 'reservation_deleted'
58251
- config: {}
58584
+ config?: {} | undefined
58252
58585
  }
58253
58586
  | undefined
58254
58587
  }
@@ -58278,13 +58611,13 @@ export interface Routes {
58278
58611
  reservation_time_updated?:
58279
58612
  | {
58280
58613
  rule: 'reservation_time_updated'
58281
- config: {}
58614
+ config?: {} | undefined
58282
58615
  }
58283
58616
  | undefined
58284
58617
  reservation_deleted?:
58285
58618
  | {
58286
58619
  rule: 'reservation_deleted'
58287
- config: {}
58620
+ config?: {} | undefined
58288
58621
  }
58289
58622
  | undefined
58290
58623
  }
@@ -58898,6 +59231,59 @@ export interface Routes {
58898
59231
  }>
58899
59232
  }>
58900
59233
  }>
59234
+ /** User identity. */
59235
+ user_identity: {
59236
+ /** ID of the user identity. */
59237
+ user_identity_id: string
59238
+ /** Unique key for the user identity. */
59239
+ user_identity_key: string | null
59240
+ /** Unique email address for the user identity. */
59241
+ email_address: string | null
59242
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
59243
+ phone_number: string | null
59244
+ display_name: string
59245
+ full_name: string | null
59246
+ /** Date and time at which the user identity was created. */
59247
+ created_at: string
59248
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
59249
+ workspace_id: string
59250
+ /** 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. */
59251
+ errors: Array<{
59252
+ /** Date and time at which Seam created the error. */
59253
+ created_at: string
59254
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
59255
+ message: string
59256
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
59257
+ error_code: 'issue_with_acs_user'
59258
+ /** ID of the access system user that has an issue. */
59259
+ acs_user_id: string
59260
+ /** ID of the access system that the user identity is associated with. */
59261
+ acs_system_id: string
59262
+ }>
59263
+ /** 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. */
59264
+ warnings: Array<
59265
+ | {
59266
+ /** Date and time at which Seam created the warning. */
59267
+ created_at: string
59268
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59269
+ message: string
59270
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59271
+ warning_code: 'being_deleted'
59272
+ }
59273
+ | {
59274
+ /** Date and time at which Seam created the warning. */
59275
+ created_at: string
59276
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59277
+ message: string
59278
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59279
+ warning_code: 'acs_user_profile_does_not_match_user_identity'
59280
+ }
59281
+ >
59282
+ /** Array of access system user IDs associated with the user identity. */
59283
+ acs_user_ids: string[]
59284
+ }
59285
+ /** Workspace ID. */
59286
+ workspace_id: string
58901
59287
  }
58902
59288
  }
58903
59289
  }
@@ -59052,95 +59438,30 @@ export interface Routes {
59052
59438
  commonParams: {
59053
59439
  /** IDs of the spaces that you want to get along with their related resources. */
59054
59440
  space_ids: string[]
59055
- include?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined
59056
- exclude?: Array<'spaces' | 'devices' | 'acs_entrances'> | undefined
59441
+ include?:
59442
+ | Array<
59443
+ | 'spaces'
59444
+ | 'devices'
59445
+ | 'acs_entrances'
59446
+ | 'connected_accounts'
59447
+ | 'acs_systems'
59448
+ >
59449
+ | undefined
59450
+ exclude?:
59451
+ | Array<
59452
+ | 'spaces'
59453
+ | 'devices'
59454
+ | 'acs_entrances'
59455
+ | 'connected_accounts'
59456
+ | 'acs_systems'
59457
+ >
59458
+ | undefined
59057
59459
  }
59058
59460
  formData: {}
59059
59461
  jsonResponse: {
59060
- /** Represents a resource batch. */
59462
+ /** ID of the affected access system user. */
59061
59463
  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
59464
+ batch_type: 'spaces'
59144
59465
  spaces?:
59145
59466
  | Array<{
59146
59467
  /** ID of the space. */
@@ -60812,6 +61133,316 @@ export interface Routes {
60812
61133
  can_unlock_with_code?: boolean | undefined
60813
61134
  }>
60814
61135
  | undefined
61136
+ connected_accounts?:
61137
+ | Array<{
61138
+ /** ID of the connected account. */
61139
+ connected_account_id?: string | undefined
61140
+ /** Date and time at which the connected account was created. */
61141
+ created_at?: string | undefined
61142
+ /** User identifier associated with the connected account. */
61143
+ user_identifier?:
61144
+ | {
61145
+ /** Username of the user identifier associated with the connected account. */
61146
+ username?: string | undefined
61147
+ /** API URL for the user identifier associated with the connected account. */
61148
+ api_url?: string | undefined
61149
+ /** Email address of the user identifier associated with the connected account. */
61150
+ email?: string | undefined
61151
+ /** Phone number of the user identifier associated with the connected account. */
61152
+ phone?: string | undefined
61153
+ /** Indicates whether the user identifier associated with the connected account is exclusive. */
61154
+ exclusive?: boolean | undefined
61155
+ }
61156
+ | undefined
61157
+ /** Type of connected account. */
61158
+ account_type?: string | undefined
61159
+ /** Display name for the connected account type. */
61160
+ account_type_display_name: string
61161
+ /** Errors associated with the connected account. */
61162
+ errors: Array<
61163
+ | {
61164
+ /** Date and time at which Seam created the error. */
61165
+ created_at: string
61166
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61167
+ message: string
61168
+ /** Indicates whether the error is related specifically to the connected account. */
61169
+ is_connected_account_error?: boolean | undefined
61170
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
61171
+ is_bridge_error?: boolean | undefined
61172
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61173
+ error_code: 'account_disconnected'
61174
+ }
61175
+ | {
61176
+ /** Date and time at which Seam created the error. */
61177
+ created_at: string
61178
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61179
+ message: string
61180
+ /** Indicates whether the error is related specifically to the connected account. */
61181
+ is_connected_account_error?: boolean | undefined
61182
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
61183
+ is_bridge_error?: boolean | undefined
61184
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61185
+ error_code: 'invalid_credentials'
61186
+ }
61187
+ | {
61188
+ /** Date and time at which Seam created the error. */
61189
+ created_at: string
61190
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61191
+ message: string
61192
+ /** Indicates whether the error is related specifically to the connected account. */
61193
+ is_connected_account_error?: boolean | undefined
61194
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
61195
+ is_bridge_error?: boolean | undefined
61196
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61197
+ error_code: 'bridge_disconnected'
61198
+ }
61199
+ | {
61200
+ /** Date and time at which Seam created the error. */
61201
+ created_at: string
61202
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61203
+ message: string
61204
+ /** Indicates whether the error is related specifically to the connected account. */
61205
+ is_connected_account_error?: boolean | undefined
61206
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
61207
+ is_bridge_error?: boolean | undefined
61208
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61209
+ error_code: 'salto_ks_subscription_limit_exceeded'
61210
+ /** Salto KS metadata associated with the connected account that has an error. */
61211
+ salto_ks_metadata: {
61212
+ /** Salto sites associated with the connected account that has an error. */
61213
+ sites: Array<{
61214
+ /** ID of a Salto site associated with the connected account that has an error. */
61215
+ site_id: string
61216
+ /** Name of a Salto site associated with the connected account that has an error. */
61217
+ site_name: string
61218
+ /** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
61219
+ subscribed_site_user_count: number
61220
+ /** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
61221
+ site_user_subscription_limit: number
61222
+ }>
61223
+ }
61224
+ }
61225
+ >
61226
+ /** Warnings associated with the connected account. */
61227
+ warnings: Array<
61228
+ | {
61229
+ /** Date and time at which Seam created the warning. */
61230
+ created_at: string
61231
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61232
+ message: string
61233
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61234
+ warning_code: 'scheduled_maintenance_window'
61235
+ }
61236
+ | {
61237
+ /** Date and time at which Seam created the warning. */
61238
+ created_at: string
61239
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61240
+ message: string
61241
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61242
+ warning_code: 'unknown_issue_with_connected_account'
61243
+ }
61244
+ | {
61245
+ /** Date and time at which Seam created the warning. */
61246
+ created_at: string
61247
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61248
+ message: string
61249
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61250
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
61251
+ /** Salto KS metadata associated with the connected account that has a warning. */
61252
+ salto_ks_metadata: {
61253
+ /** Salto sites associated with the connected account that has a warning. */
61254
+ sites: Array<{
61255
+ /** ID of a Salto site associated with the connected account that has a warning. */
61256
+ site_id: string
61257
+ /** Name of a Salto site associated with the connected account that has a warning. */
61258
+ site_name: string
61259
+ /** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
61260
+ site_user_subscription_limit: number
61261
+ /** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
61262
+ subscribed_site_user_count: number
61263
+ }>
61264
+ }
61265
+ }
61266
+ >
61267
+ /** 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. */
61268
+ custom_metadata: Record<string, string | boolean>
61269
+ /** 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. */
61270
+ automatically_manage_new_devices: boolean
61271
+ /** Your unique key for the customer associated with this connected account. */
61272
+ customer_key?: string | undefined
61273
+ /** List of capabilities that were accepted during the account connection process. */
61274
+ accepted_capabilities: Array<
61275
+ 'lock' | 'thermostat' | 'noise_sensor' | 'access_control'
61276
+ >
61277
+ }>
61278
+ | undefined
61279
+ acs_systems?:
61280
+ | Array<{
61281
+ /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61282
+ default_credential_manager_acs_system_id?:
61283
+ | (string | null)
61284
+ | undefined
61285
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61286
+ acs_system_id: string
61287
+ acs_user_count?: number | undefined
61288
+ acs_access_group_count?: number | undefined
61289
+ /** Brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
61290
+ external_type?:
61291
+ | (
61292
+ | 'pti_site'
61293
+ | 'alta_org'
61294
+ | 'salto_ks_site'
61295
+ | 'salto_space_system'
61296
+ | 'brivo_account'
61297
+ | 'hid_credential_manager_organization'
61298
+ | 'visionline_system'
61299
+ | 'assa_abloy_credential_service'
61300
+ | 'latch_building'
61301
+ | 'dormakaba_community_site'
61302
+ | 'legic_connect_credential_service'
61303
+ | 'assa_abloy_vostio'
61304
+ | 'assa_abloy_vostio_credential_service'
61305
+ )
61306
+ | undefined
61307
+ /** Display name that corresponds to the brand-specific terminology for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) type. */
61308
+ external_type_display_name?: string | undefined
61309
+ /** Indicates whether the `acs_system` is a credential manager. */
61310
+ is_credential_manager: boolean
61311
+ visionline_metadata?:
61312
+ | {
61313
+ /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
61314
+ mobile_access_uuid: string
61315
+ /** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
61316
+ system_id: string
61317
+ /** 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. */
61318
+ lan_address: string
61319
+ }
61320
+ | undefined
61321
+ /**
61322
+ * @deprecated Use `external_type`. */
61323
+ system_type?:
61324
+ | (
61325
+ | 'pti_site'
61326
+ | 'alta_org'
61327
+ | 'salto_ks_site'
61328
+ | 'salto_space_system'
61329
+ | 'brivo_account'
61330
+ | 'hid_credential_manager_organization'
61331
+ | 'visionline_system'
61332
+ | 'assa_abloy_credential_service'
61333
+ | 'latch_building'
61334
+ | 'dormakaba_community_site'
61335
+ | 'legic_connect_credential_service'
61336
+ | 'assa_abloy_vostio'
61337
+ | 'assa_abloy_vostio_credential_service'
61338
+ )
61339
+ | undefined
61340
+ /**
61341
+ * @deprecated Use `external_type_display_name`. */
61342
+ system_type_display_name?: string | undefined
61343
+ location: {
61344
+ /** Time zone in which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) is located. */
61345
+ time_zone: string | null
61346
+ }
61347
+ /** Name of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61348
+ name: string
61349
+ /** Date and time at which the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) was created. */
61350
+ created_at: string
61351
+ /** 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). */
61352
+ workspace_id: string
61353
+ /** 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).
61354
+ * @deprecated Use `connected_account_id`. */
61355
+ connected_account_ids: string[]
61356
+ /** 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). */
61357
+ connected_account_id: string
61358
+ /** URL for the image that represents the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61359
+ image_url: string
61360
+ /** Alternative text for the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) image. */
61361
+ image_alt_text: string
61362
+ /** Errors associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61363
+ errors: Array<
61364
+ | {
61365
+ /** Date and time at which Seam created the error. */
61366
+ created_at: string
61367
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61368
+ message: string
61369
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61370
+ error_code: 'seam_bridge_disconnected'
61371
+ }
61372
+ | {
61373
+ /** Date and time at which Seam created the error. */
61374
+ created_at: string
61375
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61376
+ message: string
61377
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61378
+ error_code: 'bridge_disconnected'
61379
+ is_bridge_error?: boolean | undefined
61380
+ }
61381
+ | {
61382
+ /** Date and time at which Seam created the error. */
61383
+ created_at: string
61384
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61385
+ message: string
61386
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61387
+ error_code: 'visionline_instance_unreachable'
61388
+ }
61389
+ | {
61390
+ /** Date and time at which Seam created the error. */
61391
+ created_at: string
61392
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61393
+ message: string
61394
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61395
+ error_code: 'salto_ks_subscription_limit_exceeded'
61396
+ }
61397
+ | {
61398
+ /** Date and time at which Seam created the error. */
61399
+ created_at: string
61400
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61401
+ message: string
61402
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61403
+ error_code: 'acs_system_disconnected'
61404
+ }
61405
+ | {
61406
+ /** Date and time at which Seam created the error. */
61407
+ created_at: string
61408
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61409
+ message: string
61410
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61411
+ error_code: 'account_disconnected'
61412
+ }
61413
+ | {
61414
+ /** Date and time at which Seam created the error. */
61415
+ created_at: string
61416
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61417
+ message: string
61418
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
61419
+ error_code: 'salto_ks_certification_expired'
61420
+ }
61421
+ >
61422
+ /** Warnings associated with the [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
61423
+ warnings: Array<
61424
+ | {
61425
+ /** Date and time at which Seam created the warning. */
61426
+ created_at: string
61427
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61428
+ message: string
61429
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61430
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
61431
+ }
61432
+ | {
61433
+ /** Date and time at which Seam created the warning. */
61434
+ created_at: string
61435
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
61436
+ message: string
61437
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
61438
+ warning_code: 'time_zone_does_not_match_location'
61439
+ /**
61440
+ * @deprecated this field is deprecated. */
61441
+ misconfigured_acs_entrance_ids?: string[] | undefined
61442
+ }
61443
+ >
61444
+ }>
61445
+ | undefined
60815
61446
  }
60816
61447
  }
60817
61448
  }