@seamapi/types 1.486.0 → 1.488.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.
@@ -17258,6 +17258,324 @@ export type Routes = {
17258
17258
  display_name: string
17259
17259
  }[]
17260
17260
  | undefined
17261
+ acs_credentials?:
17262
+ | {
17263
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17264
+ acs_credential_id: string
17265
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
17266
+ acs_user_id?: string | undefined
17267
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
17268
+ user_identity_id?: string | undefined
17269
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
17270
+ connected_account_id: string
17271
+ acs_credential_pool_id?: string | undefined
17272
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17273
+ acs_system_id: string
17274
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17275
+ parent_acs_credential_id?: string | undefined
17276
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
17277
+ display_name: string
17278
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17279
+ code?: (string | undefined) | null
17280
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
17281
+ is_one_time_use?: boolean | undefined
17282
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17283
+ card_number?: (string | undefined) | null
17284
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
17285
+ is_issued?: boolean | undefined
17286
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
17287
+ issued_at?: (string | undefined) | null
17288
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
17289
+ access_method: 'code' | 'card' | 'mobile_key'
17290
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
17291
+ external_type?:
17292
+ | (
17293
+ | 'pti_card'
17294
+ | 'brivo_credential'
17295
+ | 'hid_credential'
17296
+ | 'visionline_card'
17297
+ | 'salto_ks_credential'
17298
+ | 'assa_abloy_vostio_key'
17299
+ | 'salto_space_key'
17300
+ | 'latch_access'
17301
+ )
17302
+ | undefined
17303
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
17304
+ external_type_display_name?: string | undefined
17305
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
17306
+ created_at: string
17307
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17308
+ workspace_id: string
17309
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
17310
+ starts_at?: string | undefined
17311
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
17312
+ ends_at?: string | undefined
17313
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17314
+ errors: {
17315
+ error_code: string
17316
+ message: string
17317
+ }[]
17318
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17319
+ warnings: (
17320
+ | {
17321
+ /** Date and time at which Seam created the warning. */
17322
+ created_at: string
17323
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17324
+ message: string
17325
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17326
+ warning_code: 'waiting_to_be_issued'
17327
+ }
17328
+ | {
17329
+ /** Date and time at which Seam created the warning. */
17330
+ created_at: string
17331
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17332
+ message: string
17333
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17334
+ warning_code: 'schedule_externally_modified'
17335
+ }
17336
+ | {
17337
+ /** Date and time at which Seam created the warning. */
17338
+ created_at: string
17339
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17340
+ message: string
17341
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17342
+ warning_code: 'schedule_modified'
17343
+ }
17344
+ | {
17345
+ /** Date and time at which Seam created the warning. */
17346
+ created_at: string
17347
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17348
+ message: string
17349
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17350
+ warning_code: 'being_deleted'
17351
+ }
17352
+ | {
17353
+ /** Date and time at which Seam created the warning. */
17354
+ created_at: string
17355
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17356
+ message: string
17357
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17358
+ warning_code: 'unknown_issue_with_acs_credential'
17359
+ }
17360
+ | {
17361
+ /** Date and time at which Seam created the warning. */
17362
+ created_at: string
17363
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17364
+ message: string
17365
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17366
+ warning_code: 'needs_to_be_reissued'
17367
+ }
17368
+ )[]
17369
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
17370
+ is_multi_phone_sync_credential?: boolean | undefined
17371
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
17372
+ is_latest_desired_state_synced_with_provider?:
17373
+ | (boolean | null)
17374
+ | undefined
17375
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
17376
+ latest_desired_state_synced_with_provider_at?:
17377
+ | (string | null)
17378
+ | undefined
17379
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17380
+ visionline_metadata?:
17381
+ | {
17382
+ /** Card function type in the Visionline access system. */
17383
+ card_function_type: 'guest' | 'staff'
17384
+ /** IDs of the credentials to which you want to join. */
17385
+ joiner_acs_credential_ids?: string[] | undefined
17386
+ /** Guest entrance IDs in the Visionline access system. */
17387
+ guest_acs_entrance_ids?: string[] | undefined
17388
+ /** Common entrance IDs in the Visionline access system. */
17389
+ common_acs_entrance_ids?: string[] | undefined
17390
+ /** Indicates whether the credential is valid. */
17391
+ is_valid?: boolean | undefined
17392
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
17393
+ auto_join?: boolean | undefined
17394
+ /** ID of the card in the Visionline access system. */
17395
+ card_id?: string | undefined
17396
+ /** ID of the credential in the Visionline access system. */
17397
+ credential_id?: string | undefined
17398
+ }
17399
+ | undefined
17400
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17401
+ assa_abloy_vostio_metadata?:
17402
+ | {
17403
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
17404
+ auto_join?: boolean | undefined
17405
+ /** IDs of the guest entrances to override in the Vostio access system. */
17406
+ override_guest_acs_entrance_ids?: string[] | undefined
17407
+ /** Key ID in the Vostio access system. */
17408
+ key_id?: string | undefined
17409
+ /** Key issuing request ID in the Vostio access system. */
17410
+ key_issuing_request_id?: string | undefined
17411
+ /** Names of the doors to which to grant access in the Vostio access system. */
17412
+ door_names?: string[] | undefined
17413
+ /** Endpoint ID in the Vostio access system. */
17414
+ endpoint_id?: string | undefined
17415
+ }
17416
+ | undefined
17417
+ is_managed: true
17418
+ }[]
17419
+ | undefined
17420
+ unmanaged_acs_credentials?:
17421
+ | {
17422
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17423
+ acs_credential_id: string
17424
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
17425
+ acs_user_id?: string | undefined
17426
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
17427
+ user_identity_id?: string | undefined
17428
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
17429
+ connected_account_id: string
17430
+ acs_credential_pool_id?: string | undefined
17431
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17432
+ acs_system_id: string
17433
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17434
+ parent_acs_credential_id?: string | undefined
17435
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
17436
+ display_name: string
17437
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17438
+ code?: (string | undefined) | null
17439
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
17440
+ is_one_time_use?: boolean | undefined
17441
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17442
+ card_number?: (string | undefined) | null
17443
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
17444
+ is_issued?: boolean | undefined
17445
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
17446
+ issued_at?: (string | undefined) | null
17447
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
17448
+ access_method: 'code' | 'card' | 'mobile_key'
17449
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
17450
+ external_type?:
17451
+ | (
17452
+ | 'pti_card'
17453
+ | 'brivo_credential'
17454
+ | 'hid_credential'
17455
+ | 'visionline_card'
17456
+ | 'salto_ks_credential'
17457
+ | 'assa_abloy_vostio_key'
17458
+ | 'salto_space_key'
17459
+ | 'latch_access'
17460
+ )
17461
+ | undefined
17462
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
17463
+ external_type_display_name?: string | undefined
17464
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
17465
+ created_at: string
17466
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17467
+ workspace_id: string
17468
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
17469
+ starts_at?: string | undefined
17470
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
17471
+ ends_at?: string | undefined
17472
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17473
+ errors: {
17474
+ error_code: string
17475
+ message: string
17476
+ }[]
17477
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17478
+ warnings: (
17479
+ | {
17480
+ /** Date and time at which Seam created the warning. */
17481
+ created_at: string
17482
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17483
+ message: string
17484
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17485
+ warning_code: 'waiting_to_be_issued'
17486
+ }
17487
+ | {
17488
+ /** Date and time at which Seam created the warning. */
17489
+ created_at: string
17490
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17491
+ message: string
17492
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17493
+ warning_code: 'schedule_externally_modified'
17494
+ }
17495
+ | {
17496
+ /** Date and time at which Seam created the warning. */
17497
+ created_at: string
17498
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17499
+ message: string
17500
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17501
+ warning_code: 'schedule_modified'
17502
+ }
17503
+ | {
17504
+ /** Date and time at which Seam created the warning. */
17505
+ created_at: string
17506
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17507
+ message: string
17508
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17509
+ warning_code: 'being_deleted'
17510
+ }
17511
+ | {
17512
+ /** Date and time at which Seam created the warning. */
17513
+ created_at: string
17514
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17515
+ message: string
17516
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17517
+ warning_code: 'unknown_issue_with_acs_credential'
17518
+ }
17519
+ | {
17520
+ /** Date and time at which Seam created the warning. */
17521
+ created_at: string
17522
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17523
+ message: string
17524
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17525
+ warning_code: 'needs_to_be_reissued'
17526
+ }
17527
+ )[]
17528
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
17529
+ is_multi_phone_sync_credential?: boolean | undefined
17530
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
17531
+ is_latest_desired_state_synced_with_provider?:
17532
+ | (boolean | null)
17533
+ | undefined
17534
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
17535
+ latest_desired_state_synced_with_provider_at?:
17536
+ | (string | null)
17537
+ | undefined
17538
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17539
+ visionline_metadata?:
17540
+ | {
17541
+ /** Card function type in the Visionline access system. */
17542
+ card_function_type: 'guest' | 'staff'
17543
+ /** IDs of the credentials to which you want to join. */
17544
+ joiner_acs_credential_ids?: string[] | undefined
17545
+ /** Guest entrance IDs in the Visionline access system. */
17546
+ guest_acs_entrance_ids?: string[] | undefined
17547
+ /** Common entrance IDs in the Visionline access system. */
17548
+ common_acs_entrance_ids?: string[] | undefined
17549
+ /** Indicates whether the credential is valid. */
17550
+ is_valid?: boolean | undefined
17551
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
17552
+ auto_join?: boolean | undefined
17553
+ /** ID of the card in the Visionline access system. */
17554
+ card_id?: string | undefined
17555
+ /** ID of the credential in the Visionline access system. */
17556
+ credential_id?: string | undefined
17557
+ }
17558
+ | undefined
17559
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
17560
+ assa_abloy_vostio_metadata?:
17561
+ | {
17562
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
17563
+ auto_join?: boolean | undefined
17564
+ /** IDs of the guest entrances to override in the Vostio access system. */
17565
+ override_guest_acs_entrance_ids?: string[] | undefined
17566
+ /** Key ID in the Vostio access system. */
17567
+ key_id?: string | undefined
17568
+ /** Key issuing request ID in the Vostio access system. */
17569
+ key_issuing_request_id?: string | undefined
17570
+ /** Names of the doors to which to grant access in the Vostio access system. */
17571
+ door_names?: string[] | undefined
17572
+ /** Endpoint ID in the Vostio access system. */
17573
+ endpoint_id?: string | undefined
17574
+ }
17575
+ | undefined
17576
+ is_managed: false
17577
+ }[]
17578
+ | undefined
17261
17579
  action_attempts?:
17262
17580
  | (
17263
17581
  | {
@@ -21794,6 +22112,24 @@ export type Routes = {
21794
22112
  }
21795
22113
  )[]
21796
22114
  | undefined
22115
+ instant_keys?:
22116
+ | {
22117
+ /** ID of the Instant Key. */
22118
+ instant_key_id: string
22119
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key. */
22120
+ workspace_id: string
22121
+ /** Date and time at which the Instant Key was created. */
22122
+ created_at: string
22123
+ /** 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. */
22124
+ instant_key_url: string
22125
+ /** ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */
22126
+ client_session_id: string
22127
+ /** ID of the user identity associated with the Instant Key. */
22128
+ user_identity_id: string
22129
+ /** Date and time at which the Instant Key expires. */
22130
+ expires_at: string
22131
+ }[]
22132
+ | undefined
21797
22133
  }
21798
22134
  }
21799
22135
  }
@@ -94431,6 +94767,324 @@ export type Routes = {
94431
94767
  display_name: string
94432
94768
  }[]
94433
94769
  | undefined
94770
+ acs_credentials?:
94771
+ | {
94772
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94773
+ acs_credential_id: string
94774
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
94775
+ acs_user_id?: string | undefined
94776
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
94777
+ user_identity_id?: string | undefined
94778
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
94779
+ connected_account_id: string
94780
+ acs_credential_pool_id?: string | undefined
94781
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94782
+ acs_system_id: string
94783
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94784
+ parent_acs_credential_id?: string | undefined
94785
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
94786
+ display_name: string
94787
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94788
+ code?: (string | undefined) | null
94789
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
94790
+ is_one_time_use?: boolean | undefined
94791
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94792
+ card_number?: (string | undefined) | null
94793
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
94794
+ is_issued?: boolean | undefined
94795
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
94796
+ issued_at?: (string | undefined) | null
94797
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
94798
+ access_method: 'code' | 'card' | 'mobile_key'
94799
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
94800
+ external_type?:
94801
+ | (
94802
+ | 'pti_card'
94803
+ | 'brivo_credential'
94804
+ | 'hid_credential'
94805
+ | 'visionline_card'
94806
+ | 'salto_ks_credential'
94807
+ | 'assa_abloy_vostio_key'
94808
+ | 'salto_space_key'
94809
+ | 'latch_access'
94810
+ )
94811
+ | undefined
94812
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
94813
+ external_type_display_name?: string | undefined
94814
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
94815
+ created_at: string
94816
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94817
+ workspace_id: string
94818
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
94819
+ starts_at?: string | undefined
94820
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
94821
+ ends_at?: string | undefined
94822
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94823
+ errors: {
94824
+ error_code: string
94825
+ message: string
94826
+ }[]
94827
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94828
+ warnings: (
94829
+ | {
94830
+ /** Date and time at which Seam created the warning. */
94831
+ created_at: string
94832
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
94833
+ message: string
94834
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
94835
+ warning_code: 'waiting_to_be_issued'
94836
+ }
94837
+ | {
94838
+ /** Date and time at which Seam created the warning. */
94839
+ created_at: string
94840
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
94841
+ message: string
94842
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
94843
+ warning_code: 'schedule_externally_modified'
94844
+ }
94845
+ | {
94846
+ /** Date and time at which Seam created the warning. */
94847
+ created_at: string
94848
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
94849
+ message: string
94850
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
94851
+ warning_code: 'schedule_modified'
94852
+ }
94853
+ | {
94854
+ /** Date and time at which Seam created the warning. */
94855
+ created_at: string
94856
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
94857
+ message: string
94858
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
94859
+ warning_code: 'being_deleted'
94860
+ }
94861
+ | {
94862
+ /** Date and time at which Seam created the warning. */
94863
+ created_at: string
94864
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
94865
+ message: string
94866
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
94867
+ warning_code: 'unknown_issue_with_acs_credential'
94868
+ }
94869
+ | {
94870
+ /** Date and time at which Seam created the warning. */
94871
+ created_at: string
94872
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
94873
+ message: string
94874
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
94875
+ warning_code: 'needs_to_be_reissued'
94876
+ }
94877
+ )[]
94878
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
94879
+ is_multi_phone_sync_credential?: boolean | undefined
94880
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
94881
+ is_latest_desired_state_synced_with_provider?:
94882
+ | (boolean | null)
94883
+ | undefined
94884
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
94885
+ latest_desired_state_synced_with_provider_at?:
94886
+ | (string | null)
94887
+ | undefined
94888
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94889
+ visionline_metadata?:
94890
+ | {
94891
+ /** Card function type in the Visionline access system. */
94892
+ card_function_type: 'guest' | 'staff'
94893
+ /** IDs of the credentials to which you want to join. */
94894
+ joiner_acs_credential_ids?: string[] | undefined
94895
+ /** Guest entrance IDs in the Visionline access system. */
94896
+ guest_acs_entrance_ids?: string[] | undefined
94897
+ /** Common entrance IDs in the Visionline access system. */
94898
+ common_acs_entrance_ids?: string[] | undefined
94899
+ /** Indicates whether the credential is valid. */
94900
+ is_valid?: boolean | undefined
94901
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
94902
+ auto_join?: boolean | undefined
94903
+ /** ID of the card in the Visionline access system. */
94904
+ card_id?: string | undefined
94905
+ /** ID of the credential in the Visionline access system. */
94906
+ credential_id?: string | undefined
94907
+ }
94908
+ | undefined
94909
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94910
+ assa_abloy_vostio_metadata?:
94911
+ | {
94912
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
94913
+ auto_join?: boolean | undefined
94914
+ /** IDs of the guest entrances to override in the Vostio access system. */
94915
+ override_guest_acs_entrance_ids?: string[] | undefined
94916
+ /** Key ID in the Vostio access system. */
94917
+ key_id?: string | undefined
94918
+ /** Key issuing request ID in the Vostio access system. */
94919
+ key_issuing_request_id?: string | undefined
94920
+ /** Names of the doors to which to grant access in the Vostio access system. */
94921
+ door_names?: string[] | undefined
94922
+ /** Endpoint ID in the Vostio access system. */
94923
+ endpoint_id?: string | undefined
94924
+ }
94925
+ | undefined
94926
+ is_managed: true
94927
+ }[]
94928
+ | undefined
94929
+ unmanaged_acs_credentials?:
94930
+ | {
94931
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94932
+ acs_credential_id: string
94933
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
94934
+ acs_user_id?: string | undefined
94935
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
94936
+ user_identity_id?: string | undefined
94937
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
94938
+ connected_account_id: string
94939
+ acs_credential_pool_id?: string | undefined
94940
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94941
+ acs_system_id: string
94942
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94943
+ parent_acs_credential_id?: string | undefined
94944
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
94945
+ display_name: string
94946
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94947
+ code?: (string | undefined) | null
94948
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
94949
+ is_one_time_use?: boolean | undefined
94950
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94951
+ card_number?: (string | undefined) | null
94952
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
94953
+ is_issued?: boolean | undefined
94954
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
94955
+ issued_at?: (string | undefined) | null
94956
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
94957
+ access_method: 'code' | 'card' | 'mobile_key'
94958
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
94959
+ external_type?:
94960
+ | (
94961
+ | 'pti_card'
94962
+ | 'brivo_credential'
94963
+ | 'hid_credential'
94964
+ | 'visionline_card'
94965
+ | 'salto_ks_credential'
94966
+ | 'assa_abloy_vostio_key'
94967
+ | 'salto_space_key'
94968
+ | 'latch_access'
94969
+ )
94970
+ | undefined
94971
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
94972
+ external_type_display_name?: string | undefined
94973
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
94974
+ created_at: string
94975
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94976
+ workspace_id: string
94977
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
94978
+ starts_at?: string | undefined
94979
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
94980
+ ends_at?: string | undefined
94981
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94982
+ errors: {
94983
+ error_code: string
94984
+ message: string
94985
+ }[]
94986
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
94987
+ warnings: (
94988
+ | {
94989
+ /** Date and time at which Seam created the warning. */
94990
+ created_at: string
94991
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
94992
+ message: string
94993
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
94994
+ warning_code: 'waiting_to_be_issued'
94995
+ }
94996
+ | {
94997
+ /** Date and time at which Seam created the warning. */
94998
+ created_at: string
94999
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
95000
+ message: string
95001
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
95002
+ warning_code: 'schedule_externally_modified'
95003
+ }
95004
+ | {
95005
+ /** Date and time at which Seam created the warning. */
95006
+ created_at: string
95007
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
95008
+ message: string
95009
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
95010
+ warning_code: 'schedule_modified'
95011
+ }
95012
+ | {
95013
+ /** Date and time at which Seam created the warning. */
95014
+ created_at: string
95015
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
95016
+ message: string
95017
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
95018
+ warning_code: 'being_deleted'
95019
+ }
95020
+ | {
95021
+ /** Date and time at which Seam created the warning. */
95022
+ created_at: string
95023
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
95024
+ message: string
95025
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
95026
+ warning_code: 'unknown_issue_with_acs_credential'
95027
+ }
95028
+ | {
95029
+ /** Date and time at which Seam created the warning. */
95030
+ created_at: string
95031
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
95032
+ message: string
95033
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
95034
+ warning_code: 'needs_to_be_reissued'
95035
+ }
95036
+ )[]
95037
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
95038
+ is_multi_phone_sync_credential?: boolean | undefined
95039
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
95040
+ is_latest_desired_state_synced_with_provider?:
95041
+ | (boolean | null)
95042
+ | undefined
95043
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
95044
+ latest_desired_state_synced_with_provider_at?:
95045
+ | (string | null)
95046
+ | undefined
95047
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
95048
+ visionline_metadata?:
95049
+ | {
95050
+ /** Card function type in the Visionline access system. */
95051
+ card_function_type: 'guest' | 'staff'
95052
+ /** IDs of the credentials to which you want to join. */
95053
+ joiner_acs_credential_ids?: string[] | undefined
95054
+ /** Guest entrance IDs in the Visionline access system. */
95055
+ guest_acs_entrance_ids?: string[] | undefined
95056
+ /** Common entrance IDs in the Visionline access system. */
95057
+ common_acs_entrance_ids?: string[] | undefined
95058
+ /** Indicates whether the credential is valid. */
95059
+ is_valid?: boolean | undefined
95060
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
95061
+ auto_join?: boolean | undefined
95062
+ /** ID of the card in the Visionline access system. */
95063
+ card_id?: string | undefined
95064
+ /** ID of the credential in the Visionline access system. */
95065
+ credential_id?: string | undefined
95066
+ }
95067
+ | undefined
95068
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
95069
+ assa_abloy_vostio_metadata?:
95070
+ | {
95071
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
95072
+ auto_join?: boolean | undefined
95073
+ /** IDs of the guest entrances to override in the Vostio access system. */
95074
+ override_guest_acs_entrance_ids?: string[] | undefined
95075
+ /** Key ID in the Vostio access system. */
95076
+ key_id?: string | undefined
95077
+ /** Key issuing request ID in the Vostio access system. */
95078
+ key_issuing_request_id?: string | undefined
95079
+ /** Names of the doors to which to grant access in the Vostio access system. */
95080
+ door_names?: string[] | undefined
95081
+ /** Endpoint ID in the Vostio access system. */
95082
+ endpoint_id?: string | undefined
95083
+ }
95084
+ | undefined
95085
+ is_managed: false
95086
+ }[]
95087
+ | undefined
94434
95088
  action_attempts?:
94435
95089
  | (
94436
95090
  | {
@@ -98967,6 +99621,24 @@ export type Routes = {
98967
99621
  }
98968
99622
  )[]
98969
99623
  | undefined
99624
+ instant_keys?:
99625
+ | {
99626
+ /** ID of the Instant Key. */
99627
+ instant_key_id: string
99628
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key. */
99629
+ workspace_id: string
99630
+ /** Date and time at which the Instant Key was created. */
99631
+ created_at: string
99632
+ /** 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. */
99633
+ instant_key_url: string
99634
+ /** ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */
99635
+ client_session_id: string
99636
+ /** ID of the user identity associated with the Instant Key. */
99637
+ user_identity_id: string
99638
+ /** Date and time at which the Instant Key expires. */
99639
+ expires_at: string
99640
+ }[]
99641
+ | undefined
98970
99642
  }
98971
99643
  }
98972
99644
  }