@seamapi/types 1.385.0 → 1.386.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.
@@ -25420,7 +25420,1012 @@ export interface Routes {
25420
25420
  commonParams: {};
25421
25421
  formData: {};
25422
25422
  jsonResponse: {
25423
- action_attempt?: any;
25423
+ /** */
25424
+ action_attempt: {
25425
+ /** ID of the action attempt. */
25426
+ action_attempt_id: string;
25427
+ status: 'pending';
25428
+ /** Result of the action attempt. Null for pending action attempts. */
25429
+ result: null;
25430
+ /** Errors associated with the action attempt. Null for pending action attempts. */
25431
+ error: null;
25432
+ action_type: 'LOCK_DOOR';
25433
+ } | {
25434
+ /** ID of the action attempt. */
25435
+ action_attempt_id: string;
25436
+ status: 'success';
25437
+ /** Errors associated with the action attempt. Null for successful action attempts. */
25438
+ error: null;
25439
+ action_type: 'LOCK_DOOR';
25440
+ result: {};
25441
+ } | {
25442
+ /** ID of the action attempt. */
25443
+ action_attempt_id: string;
25444
+ status: 'error';
25445
+ /** Result of the action attempt. Null for failed action attempts. */
25446
+ result: null;
25447
+ action_type: 'LOCK_DOOR';
25448
+ error: {
25449
+ type: string;
25450
+ message: string;
25451
+ };
25452
+ } | {
25453
+ /** ID of the action attempt. */
25454
+ action_attempt_id: string;
25455
+ status: 'pending';
25456
+ /** Result of the action attempt. Null for pending action attempts. */
25457
+ result: null;
25458
+ /** Errors associated with the action attempt. Null for pending action attempts. */
25459
+ error: null;
25460
+ action_type: 'UNLOCK_DOOR';
25461
+ } | {
25462
+ /** ID of the action attempt. */
25463
+ action_attempt_id: string;
25464
+ status: 'success';
25465
+ /** Errors associated with the action attempt. Null for successful action attempts. */
25466
+ error: null;
25467
+ action_type: 'UNLOCK_DOOR';
25468
+ result: {};
25469
+ } | {
25470
+ /** ID of the action attempt. */
25471
+ action_attempt_id: string;
25472
+ status: 'error';
25473
+ /** Result of the action attempt. Null for failed action attempts. */
25474
+ result: null;
25475
+ action_type: 'UNLOCK_DOOR';
25476
+ error: {
25477
+ type: string;
25478
+ message: string;
25479
+ };
25480
+ } | {
25481
+ /** ID of the action attempt. */
25482
+ action_attempt_id: string;
25483
+ status: 'pending';
25484
+ /** Result of the action attempt. Null for pending action attempts. */
25485
+ result: null;
25486
+ /** Errors associated with the action attempt. Null for pending action attempts. */
25487
+ error: null;
25488
+ action_type: 'SCAN_CREDENTIAL';
25489
+ } | {
25490
+ /** ID of the action attempt. */
25491
+ action_attempt_id: string;
25492
+ status: 'success';
25493
+ /** Errors associated with the action attempt. Null for successful action attempts. */
25494
+ error: null;
25495
+ action_type: 'SCAN_CREDENTIAL';
25496
+ result: {
25497
+ /** Snapshot of credential data read from physical encoder. */
25498
+ acs_credential_on_encoder: {
25499
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
25500
+ created_at: string | null;
25501
+ is_issued: boolean | null;
25502
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
25503
+ starts_at: string | null;
25504
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
25505
+ ends_at: string | null;
25506
+ /** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25507
+ card_number: string | null;
25508
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25509
+ visionline_metadata?: {
25510
+ /** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25511
+ card_id: string;
25512
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
25513
+ cancelled: boolean;
25514
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
25515
+ discarded: boolean;
25516
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
25517
+ expired: boolean;
25518
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
25519
+ overwritten: boolean;
25520
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
25521
+ overridden?: boolean | undefined;
25522
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
25523
+ pending_auto_update: boolean;
25524
+ /** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25525
+ card_format: 'TLCode' | 'rfid48';
25526
+ /** Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25527
+ card_holder?: string | undefined;
25528
+ /** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25529
+ number_of_issued_cards: number;
25530
+ /** IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25531
+ guest_acs_entrance_ids?: string[] | undefined;
25532
+ /** IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25533
+ common_acs_entrance_ids?: string[] | undefined;
25534
+ } | undefined;
25535
+ } | null;
25536
+ /** Matching acs_credential currently encoded on this card. */
25537
+ acs_credential_on_seam: ({
25538
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25539
+ acs_credential_id: string;
25540
+ /** 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. */
25541
+ acs_user_id?: string | undefined;
25542
+ acs_credential_pool_id?: string | undefined;
25543
+ /** 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). */
25544
+ acs_system_id: string;
25545
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25546
+ parent_acs_credential_id?: string | undefined;
25547
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
25548
+ display_name: string;
25549
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25550
+ code?: (string | undefined) | null;
25551
+ /** 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. */
25552
+ is_one_time_use?: boolean | undefined;
25553
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25554
+ card_number?: (string | undefined) | null;
25555
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
25556
+ is_issued?: boolean | undefined;
25557
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
25558
+ issued_at?: (string | undefined) | null;
25559
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
25560
+ access_method: 'code' | 'card' | 'mobile_key';
25561
+ /** 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`. */
25562
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
25563
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
25564
+ external_type_display_name?: string | undefined;
25565
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
25566
+ created_at: string;
25567
+ /** 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). */
25568
+ workspace_id: string;
25569
+ /** 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. */
25570
+ starts_at?: string | undefined;
25571
+ /** 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`. */
25572
+ ends_at?: string | undefined;
25573
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25574
+ errors: Array<{
25575
+ error_code: string;
25576
+ message: string;
25577
+ }>;
25578
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25579
+ warnings: Array<{
25580
+ /** Date and time at which Seam created the warning. */
25581
+ created_at: string;
25582
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25583
+ message: string;
25584
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25585
+ warning_code: 'waiting_to_be_issued';
25586
+ } | {
25587
+ /** Date and time at which Seam created the warning. */
25588
+ created_at: string;
25589
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25590
+ message: string;
25591
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25592
+ warning_code: 'schedule_externally_modified';
25593
+ } | {
25594
+ /** Date and time at which Seam created the warning. */
25595
+ created_at: string;
25596
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25597
+ message: string;
25598
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25599
+ warning_code: 'schedule_modified';
25600
+ } | {
25601
+ /** Date and time at which Seam created the warning. */
25602
+ created_at: string;
25603
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25604
+ message: string;
25605
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25606
+ warning_code: 'being_deleted';
25607
+ } | {
25608
+ /** Date and time at which Seam created the warning. */
25609
+ created_at: string;
25610
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25611
+ message: string;
25612
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25613
+ warning_code: 'unknown_issue_with_acs_credential';
25614
+ } | {
25615
+ /** Date and time at which Seam created the warning. */
25616
+ created_at: string;
25617
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25618
+ message: string;
25619
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25620
+ warning_code: 'needs_to_be_reissued';
25621
+ }>;
25622
+ /** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
25623
+ is_multi_phone_sync_credential?: boolean | undefined;
25624
+ /** 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. */
25625
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
25626
+ /** 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. */
25627
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
25628
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25629
+ visionline_metadata?: {
25630
+ card_function_type: 'guest' | 'staff';
25631
+ joiner_acs_credential_ids?: string[] | undefined;
25632
+ guest_acs_entrance_ids?: string[] | undefined;
25633
+ common_acs_entrance_ids?: string[] | undefined;
25634
+ is_valid?: boolean | undefined;
25635
+ auto_join?: boolean | undefined;
25636
+ card_id?: string | undefined;
25637
+ credential_id?: string | undefined;
25638
+ } | undefined;
25639
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25640
+ assa_abloy_vostio_metadata?: {
25641
+ override_guest_acs_entrance_ids?: string[] | undefined;
25642
+ key_id?: string | undefined;
25643
+ key_issuing_request_id?: string | undefined;
25644
+ door_names?: string[] | undefined;
25645
+ endpoint_id?: string | undefined;
25646
+ } | undefined;
25647
+ is_managed: true;
25648
+ } | {
25649
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25650
+ acs_credential_id: string;
25651
+ /** 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. */
25652
+ acs_user_id?: string | undefined;
25653
+ acs_credential_pool_id?: string | undefined;
25654
+ /** 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). */
25655
+ acs_system_id: string;
25656
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25657
+ parent_acs_credential_id?: string | undefined;
25658
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
25659
+ display_name: string;
25660
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25661
+ code?: (string | undefined) | null;
25662
+ /** 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. */
25663
+ is_one_time_use?: boolean | undefined;
25664
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25665
+ card_number?: (string | undefined) | null;
25666
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
25667
+ is_issued?: boolean | undefined;
25668
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
25669
+ issued_at?: (string | undefined) | null;
25670
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
25671
+ access_method: 'code' | 'card' | 'mobile_key';
25672
+ /** 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`. */
25673
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
25674
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
25675
+ external_type_display_name?: string | undefined;
25676
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
25677
+ created_at: string;
25678
+ /** 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). */
25679
+ workspace_id: string;
25680
+ /** 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. */
25681
+ starts_at?: string | undefined;
25682
+ /** 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`. */
25683
+ ends_at?: string | undefined;
25684
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25685
+ errors: Array<{
25686
+ error_code: string;
25687
+ message: string;
25688
+ }>;
25689
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25690
+ warnings: Array<{
25691
+ /** Date and time at which Seam created the warning. */
25692
+ created_at: string;
25693
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25694
+ message: string;
25695
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25696
+ warning_code: 'waiting_to_be_issued';
25697
+ } | {
25698
+ /** Date and time at which Seam created the warning. */
25699
+ created_at: string;
25700
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25701
+ message: string;
25702
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25703
+ warning_code: 'schedule_externally_modified';
25704
+ } | {
25705
+ /** Date and time at which Seam created the warning. */
25706
+ created_at: string;
25707
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25708
+ message: string;
25709
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25710
+ warning_code: 'schedule_modified';
25711
+ } | {
25712
+ /** Date and time at which Seam created the warning. */
25713
+ created_at: string;
25714
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25715
+ message: string;
25716
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25717
+ warning_code: 'being_deleted';
25718
+ } | {
25719
+ /** Date and time at which Seam created the warning. */
25720
+ created_at: string;
25721
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25722
+ message: string;
25723
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25724
+ warning_code: 'unknown_issue_with_acs_credential';
25725
+ } | {
25726
+ /** Date and time at which Seam created the warning. */
25727
+ created_at: string;
25728
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25729
+ message: string;
25730
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25731
+ warning_code: 'needs_to_be_reissued';
25732
+ }>;
25733
+ /** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
25734
+ is_multi_phone_sync_credential?: boolean | undefined;
25735
+ /** 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. */
25736
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
25737
+ /** 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. */
25738
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
25739
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25740
+ visionline_metadata?: {
25741
+ card_function_type: 'guest' | 'staff';
25742
+ joiner_acs_credential_ids?: string[] | undefined;
25743
+ guest_acs_entrance_ids?: string[] | undefined;
25744
+ common_acs_entrance_ids?: string[] | undefined;
25745
+ is_valid?: boolean | undefined;
25746
+ auto_join?: boolean | undefined;
25747
+ card_id?: string | undefined;
25748
+ credential_id?: string | undefined;
25749
+ } | undefined;
25750
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25751
+ assa_abloy_vostio_metadata?: {
25752
+ override_guest_acs_entrance_ids?: string[] | undefined;
25753
+ key_id?: string | undefined;
25754
+ key_issuing_request_id?: string | undefined;
25755
+ door_names?: string[] | undefined;
25756
+ endpoint_id?: string | undefined;
25757
+ } | undefined;
25758
+ is_managed: false;
25759
+ }) | null;
25760
+ warnings: Array<{
25761
+ warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
25762
+ warning_message: string;
25763
+ }>;
25764
+ };
25765
+ } | {
25766
+ /** ID of the action attempt. */
25767
+ action_attempt_id: string;
25768
+ status: 'error';
25769
+ /** Result of the action attempt. Null for failed action attempts. */
25770
+ result: null;
25771
+ action_type: 'SCAN_CREDENTIAL';
25772
+ error: {
25773
+ /** Type of the error associated with the action attempt. */
25774
+ type: 'uncategorized_error';
25775
+ /** Message for the error associated with the action attempt. */
25776
+ message: string;
25777
+ } | {
25778
+ /** Type of the error associated with the action attempt. */
25779
+ type: 'action_attempt_expired';
25780
+ /** Message for the error associated with the action attempt. */
25781
+ message: string;
25782
+ } | {
25783
+ type: 'no_credential_on_encoder';
25784
+ message: string;
25785
+ };
25786
+ } | {
25787
+ /** ID of the action attempt. */
25788
+ action_attempt_id: string;
25789
+ status: 'pending';
25790
+ /** Result of the action attempt. Null for pending action attempts. */
25791
+ result: null;
25792
+ /** Errors associated with the action attempt. Null for pending action attempts. */
25793
+ error: null;
25794
+ /** Type of action that the action attempt tracks. */
25795
+ action_type: 'ENCODE_CREDENTIAL';
25796
+ } | {
25797
+ /** ID of the action attempt. */
25798
+ action_attempt_id: string;
25799
+ status: 'success';
25800
+ /** Errors associated with the action attempt. Null for successful action attempts. */
25801
+ error: null;
25802
+ /** Type of action that the action attempt tracks. */
25803
+ action_type: 'ENCODE_CREDENTIAL';
25804
+ /** If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card. */
25805
+ result: {
25806
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25807
+ acs_credential_id: string;
25808
+ /** 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. */
25809
+ acs_user_id?: string | undefined;
25810
+ acs_credential_pool_id?: string | undefined;
25811
+ /** 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). */
25812
+ acs_system_id: string;
25813
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25814
+ parent_acs_credential_id?: string | undefined;
25815
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
25816
+ display_name: string;
25817
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25818
+ code?: (string | undefined) | null;
25819
+ /** 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. */
25820
+ is_one_time_use?: boolean | undefined;
25821
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25822
+ card_number?: (string | undefined) | null;
25823
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
25824
+ is_issued?: boolean | undefined;
25825
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
25826
+ issued_at?: (string | undefined) | null;
25827
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
25828
+ access_method: 'code' | 'card' | 'mobile_key';
25829
+ /** 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`. */
25830
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
25831
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
25832
+ external_type_display_name?: string | undefined;
25833
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
25834
+ created_at: string;
25835
+ /** 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). */
25836
+ workspace_id: string;
25837
+ /** 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. */
25838
+ starts_at?: string | undefined;
25839
+ /** 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`. */
25840
+ ends_at?: string | undefined;
25841
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25842
+ errors: Array<{
25843
+ error_code: string;
25844
+ message: string;
25845
+ }>;
25846
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25847
+ warnings: Array<{
25848
+ /** Date and time at which Seam created the warning. */
25849
+ created_at: string;
25850
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25851
+ message: string;
25852
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25853
+ warning_code: 'waiting_to_be_issued';
25854
+ } | {
25855
+ /** Date and time at which Seam created the warning. */
25856
+ created_at: string;
25857
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25858
+ message: string;
25859
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25860
+ warning_code: 'schedule_externally_modified';
25861
+ } | {
25862
+ /** Date and time at which Seam created the warning. */
25863
+ created_at: string;
25864
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25865
+ message: string;
25866
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25867
+ warning_code: 'schedule_modified';
25868
+ } | {
25869
+ /** Date and time at which Seam created the warning. */
25870
+ created_at: string;
25871
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25872
+ message: string;
25873
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25874
+ warning_code: 'being_deleted';
25875
+ } | {
25876
+ /** Date and time at which Seam created the warning. */
25877
+ created_at: string;
25878
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25879
+ message: string;
25880
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25881
+ warning_code: 'unknown_issue_with_acs_credential';
25882
+ } | {
25883
+ /** Date and time at which Seam created the warning. */
25884
+ created_at: string;
25885
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25886
+ message: string;
25887
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25888
+ warning_code: 'needs_to_be_reissued';
25889
+ }>;
25890
+ /** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
25891
+ is_multi_phone_sync_credential?: boolean | undefined;
25892
+ /** 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. */
25893
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
25894
+ /** 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. */
25895
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
25896
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25897
+ visionline_metadata?: {
25898
+ card_function_type: 'guest' | 'staff';
25899
+ joiner_acs_credential_ids?: string[] | undefined;
25900
+ guest_acs_entrance_ids?: string[] | undefined;
25901
+ common_acs_entrance_ids?: string[] | undefined;
25902
+ is_valid?: boolean | undefined;
25903
+ auto_join?: boolean | undefined;
25904
+ card_id?: string | undefined;
25905
+ credential_id?: string | undefined;
25906
+ } | undefined;
25907
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25908
+ assa_abloy_vostio_metadata?: {
25909
+ override_guest_acs_entrance_ids?: string[] | undefined;
25910
+ key_id?: string | undefined;
25911
+ key_issuing_request_id?: string | undefined;
25912
+ door_names?: string[] | undefined;
25913
+ endpoint_id?: string | undefined;
25914
+ } | undefined;
25915
+ is_managed: true;
25916
+ } | {
25917
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25918
+ acs_credential_id: string;
25919
+ /** 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. */
25920
+ acs_user_id?: string | undefined;
25921
+ acs_credential_pool_id?: string | undefined;
25922
+ /** 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). */
25923
+ acs_system_id: string;
25924
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25925
+ parent_acs_credential_id?: string | undefined;
25926
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
25927
+ display_name: string;
25928
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25929
+ code?: (string | undefined) | null;
25930
+ /** 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. */
25931
+ is_one_time_use?: boolean | undefined;
25932
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25933
+ card_number?: (string | undefined) | null;
25934
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
25935
+ is_issued?: boolean | undefined;
25936
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
25937
+ issued_at?: (string | undefined) | null;
25938
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
25939
+ access_method: 'code' | 'card' | 'mobile_key';
25940
+ /** 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`. */
25941
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
25942
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
25943
+ external_type_display_name?: string | undefined;
25944
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
25945
+ created_at: string;
25946
+ /** 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). */
25947
+ workspace_id: string;
25948
+ /** 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. */
25949
+ starts_at?: string | undefined;
25950
+ /** 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`. */
25951
+ ends_at?: string | undefined;
25952
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25953
+ errors: Array<{
25954
+ error_code: string;
25955
+ message: string;
25956
+ }>;
25957
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
25958
+ warnings: Array<{
25959
+ /** Date and time at which Seam created the warning. */
25960
+ created_at: string;
25961
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25962
+ message: string;
25963
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25964
+ warning_code: 'waiting_to_be_issued';
25965
+ } | {
25966
+ /** Date and time at which Seam created the warning. */
25967
+ created_at: string;
25968
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25969
+ message: string;
25970
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25971
+ warning_code: 'schedule_externally_modified';
25972
+ } | {
25973
+ /** Date and time at which Seam created the warning. */
25974
+ created_at: string;
25975
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25976
+ message: string;
25977
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25978
+ warning_code: 'schedule_modified';
25979
+ } | {
25980
+ /** Date and time at which Seam created the warning. */
25981
+ created_at: string;
25982
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25983
+ message: string;
25984
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25985
+ warning_code: 'being_deleted';
25986
+ } | {
25987
+ /** Date and time at which Seam created the warning. */
25988
+ created_at: string;
25989
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25990
+ message: string;
25991
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25992
+ warning_code: 'unknown_issue_with_acs_credential';
25993
+ } | {
25994
+ /** Date and time at which Seam created the warning. */
25995
+ created_at: string;
25996
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
25997
+ message: string;
25998
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
25999
+ warning_code: 'needs_to_be_reissued';
26000
+ }>;
26001
+ /** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
26002
+ is_multi_phone_sync_credential?: boolean | undefined;
26003
+ /** 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. */
26004
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
26005
+ /** 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. */
26006
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
26007
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26008
+ visionline_metadata?: {
26009
+ card_function_type: 'guest' | 'staff';
26010
+ joiner_acs_credential_ids?: string[] | undefined;
26011
+ guest_acs_entrance_ids?: string[] | undefined;
26012
+ common_acs_entrance_ids?: string[] | undefined;
26013
+ is_valid?: boolean | undefined;
26014
+ auto_join?: boolean | undefined;
26015
+ card_id?: string | undefined;
26016
+ credential_id?: string | undefined;
26017
+ } | undefined;
26018
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26019
+ assa_abloy_vostio_metadata?: {
26020
+ override_guest_acs_entrance_ids?: string[] | undefined;
26021
+ key_id?: string | undefined;
26022
+ key_issuing_request_id?: string | undefined;
26023
+ door_names?: string[] | undefined;
26024
+ endpoint_id?: string | undefined;
26025
+ } | undefined;
26026
+ is_managed: false;
26027
+ };
26028
+ } | {
26029
+ /** ID of the action attempt. */
26030
+ action_attempt_id: string;
26031
+ status: 'error';
26032
+ /** Result of the action attempt. Null for failed action attempts. */
26033
+ result: null;
26034
+ /** Type of action that the action attempt tracks. */
26035
+ action_type: 'ENCODE_CREDENTIAL';
26036
+ error: {
26037
+ /** Type of the error associated with the action attempt. */
26038
+ type: 'uncategorized_error';
26039
+ /** Message for the error associated with the action attempt. */
26040
+ message: string;
26041
+ } | {
26042
+ /** Type of the error associated with the action attempt. */
26043
+ type: 'action_attempt_expired';
26044
+ /** Message for the error associated with the action attempt. */
26045
+ message: string;
26046
+ } | {
26047
+ type: 'no_credential_on_encoder';
26048
+ message: string;
26049
+ } | {
26050
+ type: 'incompatible_card_format';
26051
+ message: string;
26052
+ } | {
26053
+ type: 'credential_cannot_be_reissued';
26054
+ message: string;
26055
+ };
26056
+ } | {
26057
+ /** ID of the action attempt. */
26058
+ action_attempt_id: string;
26059
+ status: 'pending';
26060
+ /** Result of the action attempt. Null for pending action attempts. */
26061
+ result: null;
26062
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26063
+ error: null;
26064
+ action_type: 'RESET_SANDBOX_WORKSPACE';
26065
+ } | {
26066
+ /** ID of the action attempt. */
26067
+ action_attempt_id: string;
26068
+ status: 'success';
26069
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26070
+ error: null;
26071
+ action_type: 'RESET_SANDBOX_WORKSPACE';
26072
+ result: {};
26073
+ } | {
26074
+ /** ID of the action attempt. */
26075
+ action_attempt_id: string;
26076
+ status: 'error';
26077
+ /** Result of the action attempt. Null for failed action attempts. */
26078
+ result: null;
26079
+ action_type: 'RESET_SANDBOX_WORKSPACE';
26080
+ error: {
26081
+ type: string;
26082
+ message: string;
26083
+ };
26084
+ } | {
26085
+ /** ID of the action attempt. */
26086
+ action_attempt_id: string;
26087
+ status: 'pending';
26088
+ /** Result of the action attempt. Null for pending action attempts. */
26089
+ result: null;
26090
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26091
+ error: null;
26092
+ action_type: 'SET_FAN_MODE';
26093
+ } | {
26094
+ /** ID of the action attempt. */
26095
+ action_attempt_id: string;
26096
+ status: 'success';
26097
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26098
+ error: null;
26099
+ action_type: 'SET_FAN_MODE';
26100
+ result: {};
26101
+ } | {
26102
+ /** ID of the action attempt. */
26103
+ action_attempt_id: string;
26104
+ status: 'error';
26105
+ /** Result of the action attempt. Null for failed action attempts. */
26106
+ result: null;
26107
+ action_type: 'SET_FAN_MODE';
26108
+ error: {
26109
+ type: string;
26110
+ message: string;
26111
+ };
26112
+ } | {
26113
+ /** ID of the action attempt. */
26114
+ action_attempt_id: string;
26115
+ status: 'pending';
26116
+ /** Result of the action attempt. Null for pending action attempts. */
26117
+ result: null;
26118
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26119
+ error: null;
26120
+ action_type: 'SET_HVAC_MODE';
26121
+ } | {
26122
+ /** ID of the action attempt. */
26123
+ action_attempt_id: string;
26124
+ status: 'success';
26125
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26126
+ error: null;
26127
+ action_type: 'SET_HVAC_MODE';
26128
+ result: {};
26129
+ } | {
26130
+ /** ID of the action attempt. */
26131
+ action_attempt_id: string;
26132
+ status: 'error';
26133
+ /** Result of the action attempt. Null for failed action attempts. */
26134
+ result: null;
26135
+ action_type: 'SET_HVAC_MODE';
26136
+ error: {
26137
+ type: string;
26138
+ message: string;
26139
+ };
26140
+ } | {
26141
+ /** ID of the action attempt. */
26142
+ action_attempt_id: string;
26143
+ status: 'pending';
26144
+ /** Result of the action attempt. Null for pending action attempts. */
26145
+ result: null;
26146
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26147
+ error: null;
26148
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
26149
+ } | {
26150
+ /** ID of the action attempt. */
26151
+ action_attempt_id: string;
26152
+ status: 'success';
26153
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26154
+ error: null;
26155
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
26156
+ result: {};
26157
+ } | {
26158
+ /** ID of the action attempt. */
26159
+ action_attempt_id: string;
26160
+ status: 'error';
26161
+ /** Result of the action attempt. Null for failed action attempts. */
26162
+ result: null;
26163
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
26164
+ error: {
26165
+ type: string;
26166
+ message: string;
26167
+ };
26168
+ } | {
26169
+ /** ID of the action attempt. */
26170
+ action_attempt_id: string;
26171
+ status: 'pending';
26172
+ /** Result of the action attempt. Null for pending action attempts. */
26173
+ result: null;
26174
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26175
+ error: null;
26176
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
26177
+ } | {
26178
+ /** ID of the action attempt. */
26179
+ action_attempt_id: string;
26180
+ status: 'success';
26181
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26182
+ error: null;
26183
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
26184
+ result: {};
26185
+ } | {
26186
+ /** ID of the action attempt. */
26187
+ action_attempt_id: string;
26188
+ status: 'error';
26189
+ /** Result of the action attempt. Null for failed action attempts. */
26190
+ result: null;
26191
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
26192
+ error: {
26193
+ type: string;
26194
+ message: string;
26195
+ };
26196
+ } | {
26197
+ /** ID of the action attempt. */
26198
+ action_attempt_id: string;
26199
+ status: 'pending';
26200
+ /** Result of the action attempt. Null for pending action attempts. */
26201
+ result: null;
26202
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26203
+ error: null;
26204
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
26205
+ } | {
26206
+ /** ID of the action attempt. */
26207
+ action_attempt_id: string;
26208
+ status: 'success';
26209
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26210
+ error: null;
26211
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
26212
+ result: {};
26213
+ } | {
26214
+ /** ID of the action attempt. */
26215
+ action_attempt_id: string;
26216
+ status: 'error';
26217
+ /** Result of the action attempt. Null for failed action attempts. */
26218
+ result: null;
26219
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
26220
+ error: {
26221
+ type: string;
26222
+ message: string;
26223
+ };
26224
+ } | {
26225
+ /** ID of the action attempt. */
26226
+ action_attempt_id: string;
26227
+ status: 'pending';
26228
+ /** Result of the action attempt. Null for pending action attempts. */
26229
+ result: null;
26230
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26231
+ error: null;
26232
+ action_type: 'SYNC_ACCESS_CODES';
26233
+ } | {
26234
+ /** ID of the action attempt. */
26235
+ action_attempt_id: string;
26236
+ status: 'success';
26237
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26238
+ error: null;
26239
+ action_type: 'SYNC_ACCESS_CODES';
26240
+ result: {};
26241
+ } | {
26242
+ /** ID of the action attempt. */
26243
+ action_attempt_id: string;
26244
+ status: 'error';
26245
+ /** Result of the action attempt. Null for failed action attempts. */
26246
+ result: null;
26247
+ action_type: 'SYNC_ACCESS_CODES';
26248
+ error: {
26249
+ type: string;
26250
+ message: string;
26251
+ };
26252
+ } | {
26253
+ /** ID of the action attempt. */
26254
+ action_attempt_id: string;
26255
+ status: 'pending';
26256
+ /** Result of the action attempt. Null for pending action attempts. */
26257
+ result: null;
26258
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26259
+ error: null;
26260
+ action_type: 'CREATE_ACCESS_CODE';
26261
+ } | {
26262
+ /** ID of the action attempt. */
26263
+ action_attempt_id: string;
26264
+ status: 'success';
26265
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26266
+ error: null;
26267
+ action_type: 'CREATE_ACCESS_CODE';
26268
+ result: {
26269
+ access_code?: any;
26270
+ };
26271
+ } | {
26272
+ /** ID of the action attempt. */
26273
+ action_attempt_id: string;
26274
+ status: 'error';
26275
+ /** Result of the action attempt. Null for failed action attempts. */
26276
+ result: null;
26277
+ action_type: 'CREATE_ACCESS_CODE';
26278
+ error: {
26279
+ type: string;
26280
+ message: string;
26281
+ };
26282
+ } | {
26283
+ /** ID of the action attempt. */
26284
+ action_attempt_id: string;
26285
+ status: 'pending';
26286
+ /** Result of the action attempt. Null for pending action attempts. */
26287
+ result: null;
26288
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26289
+ error: null;
26290
+ action_type: 'DELETE_ACCESS_CODE';
26291
+ } | {
26292
+ /** ID of the action attempt. */
26293
+ action_attempt_id: string;
26294
+ status: 'success';
26295
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26296
+ error: null;
26297
+ action_type: 'DELETE_ACCESS_CODE';
26298
+ result: {};
26299
+ } | {
26300
+ /** ID of the action attempt. */
26301
+ action_attempt_id: string;
26302
+ status: 'error';
26303
+ /** Result of the action attempt. Null for failed action attempts. */
26304
+ result: null;
26305
+ action_type: 'DELETE_ACCESS_CODE';
26306
+ error: {
26307
+ type: string;
26308
+ message: string;
26309
+ };
26310
+ } | {
26311
+ /** ID of the action attempt. */
26312
+ action_attempt_id: string;
26313
+ status: 'pending';
26314
+ /** Result of the action attempt. Null for pending action attempts. */
26315
+ result: null;
26316
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26317
+ error: null;
26318
+ action_type: 'UPDATE_ACCESS_CODE';
26319
+ } | {
26320
+ /** ID of the action attempt. */
26321
+ action_attempt_id: string;
26322
+ status: 'success';
26323
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26324
+ error: null;
26325
+ action_type: 'UPDATE_ACCESS_CODE';
26326
+ result: {
26327
+ access_code?: any;
26328
+ };
26329
+ } | {
26330
+ /** ID of the action attempt. */
26331
+ action_attempt_id: string;
26332
+ status: 'error';
26333
+ /** Result of the action attempt. Null for failed action attempts. */
26334
+ result: null;
26335
+ action_type: 'UPDATE_ACCESS_CODE';
26336
+ error: {
26337
+ type: string;
26338
+ message: string;
26339
+ };
26340
+ } | {
26341
+ /** ID of the action attempt. */
26342
+ action_attempt_id: string;
26343
+ status: 'pending';
26344
+ /** Result of the action attempt. Null for pending action attempts. */
26345
+ result: null;
26346
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26347
+ error: null;
26348
+ action_type: 'CREATE_NOISE_THRESHOLD';
26349
+ } | {
26350
+ /** ID of the action attempt. */
26351
+ action_attempt_id: string;
26352
+ status: 'success';
26353
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26354
+ error: null;
26355
+ action_type: 'CREATE_NOISE_THRESHOLD';
26356
+ result: {
26357
+ noise_threshold?: any;
26358
+ };
26359
+ } | {
26360
+ /** ID of the action attempt. */
26361
+ action_attempt_id: string;
26362
+ status: 'error';
26363
+ /** Result of the action attempt. Null for failed action attempts. */
26364
+ result: null;
26365
+ action_type: 'CREATE_NOISE_THRESHOLD';
26366
+ error: {
26367
+ type: string;
26368
+ message: string;
26369
+ };
26370
+ } | {
26371
+ /** ID of the action attempt. */
26372
+ action_attempt_id: string;
26373
+ status: 'pending';
26374
+ /** Result of the action attempt. Null for pending action attempts. */
26375
+ result: null;
26376
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26377
+ error: null;
26378
+ action_type: 'DELETE_NOISE_THRESHOLD';
26379
+ } | {
26380
+ /** ID of the action attempt. */
26381
+ action_attempt_id: string;
26382
+ status: 'success';
26383
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26384
+ error: null;
26385
+ action_type: 'DELETE_NOISE_THRESHOLD';
26386
+ result: {};
26387
+ } | {
26388
+ /** ID of the action attempt. */
26389
+ action_attempt_id: string;
26390
+ status: 'error';
26391
+ /** Result of the action attempt. Null for failed action attempts. */
26392
+ result: null;
26393
+ action_type: 'DELETE_NOISE_THRESHOLD';
26394
+ error: {
26395
+ type: string;
26396
+ message: string;
26397
+ };
26398
+ } | {
26399
+ /** ID of the action attempt. */
26400
+ action_attempt_id: string;
26401
+ status: 'pending';
26402
+ /** Result of the action attempt. Null for pending action attempts. */
26403
+ result: null;
26404
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26405
+ error: null;
26406
+ action_type: 'UPDATE_NOISE_THRESHOLD';
26407
+ } | {
26408
+ /** ID of the action attempt. */
26409
+ action_attempt_id: string;
26410
+ status: 'success';
26411
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26412
+ error: null;
26413
+ action_type: 'UPDATE_NOISE_THRESHOLD';
26414
+ result: {
26415
+ noise_threshold?: any;
26416
+ };
26417
+ } | {
26418
+ /** ID of the action attempt. */
26419
+ action_attempt_id: string;
26420
+ status: 'error';
26421
+ /** Result of the action attempt. Null for failed action attempts. */
26422
+ result: null;
26423
+ action_type: 'UPDATE_NOISE_THRESHOLD';
26424
+ error: {
26425
+ type: string;
26426
+ message: string;
26427
+ };
26428
+ };
25424
26429
  };
25425
26430
  };
25426
26431
  '/locks/simulate/manual_lock_via_keypad': {
@@ -25433,7 +26438,1012 @@ export interface Routes {
25433
26438
  commonParams: {};
25434
26439
  formData: {};
25435
26440
  jsonResponse: {
25436
- action_attempt?: any;
26441
+ /** */
26442
+ action_attempt: {
26443
+ /** ID of the action attempt. */
26444
+ action_attempt_id: string;
26445
+ status: 'pending';
26446
+ /** Result of the action attempt. Null for pending action attempts. */
26447
+ result: null;
26448
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26449
+ error: null;
26450
+ action_type: 'LOCK_DOOR';
26451
+ } | {
26452
+ /** ID of the action attempt. */
26453
+ action_attempt_id: string;
26454
+ status: 'success';
26455
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26456
+ error: null;
26457
+ action_type: 'LOCK_DOOR';
26458
+ result: {};
26459
+ } | {
26460
+ /** ID of the action attempt. */
26461
+ action_attempt_id: string;
26462
+ status: 'error';
26463
+ /** Result of the action attempt. Null for failed action attempts. */
26464
+ result: null;
26465
+ action_type: 'LOCK_DOOR';
26466
+ error: {
26467
+ type: string;
26468
+ message: string;
26469
+ };
26470
+ } | {
26471
+ /** ID of the action attempt. */
26472
+ action_attempt_id: string;
26473
+ status: 'pending';
26474
+ /** Result of the action attempt. Null for pending action attempts. */
26475
+ result: null;
26476
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26477
+ error: null;
26478
+ action_type: 'UNLOCK_DOOR';
26479
+ } | {
26480
+ /** ID of the action attempt. */
26481
+ action_attempt_id: string;
26482
+ status: 'success';
26483
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26484
+ error: null;
26485
+ action_type: 'UNLOCK_DOOR';
26486
+ result: {};
26487
+ } | {
26488
+ /** ID of the action attempt. */
26489
+ action_attempt_id: string;
26490
+ status: 'error';
26491
+ /** Result of the action attempt. Null for failed action attempts. */
26492
+ result: null;
26493
+ action_type: 'UNLOCK_DOOR';
26494
+ error: {
26495
+ type: string;
26496
+ message: string;
26497
+ };
26498
+ } | {
26499
+ /** ID of the action attempt. */
26500
+ action_attempt_id: string;
26501
+ status: 'pending';
26502
+ /** Result of the action attempt. Null for pending action attempts. */
26503
+ result: null;
26504
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26505
+ error: null;
26506
+ action_type: 'SCAN_CREDENTIAL';
26507
+ } | {
26508
+ /** ID of the action attempt. */
26509
+ action_attempt_id: string;
26510
+ status: 'success';
26511
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26512
+ error: null;
26513
+ action_type: 'SCAN_CREDENTIAL';
26514
+ result: {
26515
+ /** Snapshot of credential data read from physical encoder. */
26516
+ acs_credential_on_encoder: {
26517
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
26518
+ created_at: string | null;
26519
+ is_issued: boolean | null;
26520
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
26521
+ starts_at: string | null;
26522
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
26523
+ ends_at: string | null;
26524
+ /** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26525
+ card_number: string | null;
26526
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26527
+ visionline_metadata?: {
26528
+ /** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26529
+ card_id: string;
26530
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
26531
+ cancelled: boolean;
26532
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
26533
+ discarded: boolean;
26534
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
26535
+ expired: boolean;
26536
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
26537
+ overwritten: boolean;
26538
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
26539
+ overridden?: boolean | undefined;
26540
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
26541
+ pending_auto_update: boolean;
26542
+ /** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26543
+ card_format: 'TLCode' | 'rfid48';
26544
+ /** Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26545
+ card_holder?: string | undefined;
26546
+ /** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26547
+ number_of_issued_cards: number;
26548
+ /** IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26549
+ guest_acs_entrance_ids?: string[] | undefined;
26550
+ /** IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26551
+ common_acs_entrance_ids?: string[] | undefined;
26552
+ } | undefined;
26553
+ } | null;
26554
+ /** Matching acs_credential currently encoded on this card. */
26555
+ acs_credential_on_seam: ({
26556
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26557
+ acs_credential_id: string;
26558
+ /** 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. */
26559
+ acs_user_id?: string | undefined;
26560
+ acs_credential_pool_id?: string | undefined;
26561
+ /** 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). */
26562
+ acs_system_id: string;
26563
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26564
+ parent_acs_credential_id?: string | undefined;
26565
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26566
+ display_name: string;
26567
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26568
+ code?: (string | undefined) | null;
26569
+ /** 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. */
26570
+ is_one_time_use?: boolean | undefined;
26571
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26572
+ card_number?: (string | undefined) | null;
26573
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
26574
+ is_issued?: boolean | undefined;
26575
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
26576
+ issued_at?: (string | undefined) | null;
26577
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
26578
+ access_method: 'code' | 'card' | 'mobile_key';
26579
+ /** 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`. */
26580
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
26581
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26582
+ external_type_display_name?: string | undefined;
26583
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
26584
+ created_at: string;
26585
+ /** 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). */
26586
+ workspace_id: string;
26587
+ /** 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. */
26588
+ starts_at?: string | undefined;
26589
+ /** 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`. */
26590
+ ends_at?: string | undefined;
26591
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26592
+ errors: Array<{
26593
+ error_code: string;
26594
+ message: string;
26595
+ }>;
26596
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26597
+ warnings: Array<{
26598
+ /** Date and time at which Seam created the warning. */
26599
+ created_at: string;
26600
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26601
+ message: string;
26602
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26603
+ warning_code: 'waiting_to_be_issued';
26604
+ } | {
26605
+ /** Date and time at which Seam created the warning. */
26606
+ created_at: string;
26607
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26608
+ message: string;
26609
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26610
+ warning_code: 'schedule_externally_modified';
26611
+ } | {
26612
+ /** Date and time at which Seam created the warning. */
26613
+ created_at: string;
26614
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26615
+ message: string;
26616
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26617
+ warning_code: 'schedule_modified';
26618
+ } | {
26619
+ /** Date and time at which Seam created the warning. */
26620
+ created_at: string;
26621
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26622
+ message: string;
26623
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26624
+ warning_code: 'being_deleted';
26625
+ } | {
26626
+ /** Date and time at which Seam created the warning. */
26627
+ created_at: string;
26628
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26629
+ message: string;
26630
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26631
+ warning_code: 'unknown_issue_with_acs_credential';
26632
+ } | {
26633
+ /** Date and time at which Seam created the warning. */
26634
+ created_at: string;
26635
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26636
+ message: string;
26637
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26638
+ warning_code: 'needs_to_be_reissued';
26639
+ }>;
26640
+ /** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
26641
+ is_multi_phone_sync_credential?: boolean | undefined;
26642
+ /** 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. */
26643
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
26644
+ /** 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. */
26645
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
26646
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26647
+ visionline_metadata?: {
26648
+ card_function_type: 'guest' | 'staff';
26649
+ joiner_acs_credential_ids?: string[] | undefined;
26650
+ guest_acs_entrance_ids?: string[] | undefined;
26651
+ common_acs_entrance_ids?: string[] | undefined;
26652
+ is_valid?: boolean | undefined;
26653
+ auto_join?: boolean | undefined;
26654
+ card_id?: string | undefined;
26655
+ credential_id?: string | undefined;
26656
+ } | undefined;
26657
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26658
+ assa_abloy_vostio_metadata?: {
26659
+ override_guest_acs_entrance_ids?: string[] | undefined;
26660
+ key_id?: string | undefined;
26661
+ key_issuing_request_id?: string | undefined;
26662
+ door_names?: string[] | undefined;
26663
+ endpoint_id?: string | undefined;
26664
+ } | undefined;
26665
+ is_managed: true;
26666
+ } | {
26667
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26668
+ acs_credential_id: string;
26669
+ /** 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. */
26670
+ acs_user_id?: string | undefined;
26671
+ acs_credential_pool_id?: string | undefined;
26672
+ /** 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). */
26673
+ acs_system_id: string;
26674
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26675
+ parent_acs_credential_id?: string | undefined;
26676
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26677
+ display_name: string;
26678
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26679
+ code?: (string | undefined) | null;
26680
+ /** 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. */
26681
+ is_one_time_use?: boolean | undefined;
26682
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26683
+ card_number?: (string | undefined) | null;
26684
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
26685
+ is_issued?: boolean | undefined;
26686
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
26687
+ issued_at?: (string | undefined) | null;
26688
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
26689
+ access_method: 'code' | 'card' | 'mobile_key';
26690
+ /** 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`. */
26691
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
26692
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26693
+ external_type_display_name?: string | undefined;
26694
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
26695
+ created_at: string;
26696
+ /** 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). */
26697
+ workspace_id: string;
26698
+ /** 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. */
26699
+ starts_at?: string | undefined;
26700
+ /** 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`. */
26701
+ ends_at?: string | undefined;
26702
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26703
+ errors: Array<{
26704
+ error_code: string;
26705
+ message: string;
26706
+ }>;
26707
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26708
+ warnings: Array<{
26709
+ /** Date and time at which Seam created the warning. */
26710
+ created_at: string;
26711
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26712
+ message: string;
26713
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26714
+ warning_code: 'waiting_to_be_issued';
26715
+ } | {
26716
+ /** Date and time at which Seam created the warning. */
26717
+ created_at: string;
26718
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26719
+ message: string;
26720
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26721
+ warning_code: 'schedule_externally_modified';
26722
+ } | {
26723
+ /** Date and time at which Seam created the warning. */
26724
+ created_at: string;
26725
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26726
+ message: string;
26727
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26728
+ warning_code: 'schedule_modified';
26729
+ } | {
26730
+ /** Date and time at which Seam created the warning. */
26731
+ created_at: string;
26732
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26733
+ message: string;
26734
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26735
+ warning_code: 'being_deleted';
26736
+ } | {
26737
+ /** Date and time at which Seam created the warning. */
26738
+ created_at: string;
26739
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26740
+ message: string;
26741
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26742
+ warning_code: 'unknown_issue_with_acs_credential';
26743
+ } | {
26744
+ /** Date and time at which Seam created the warning. */
26745
+ created_at: string;
26746
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26747
+ message: string;
26748
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26749
+ warning_code: 'needs_to_be_reissued';
26750
+ }>;
26751
+ /** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
26752
+ is_multi_phone_sync_credential?: boolean | undefined;
26753
+ /** 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. */
26754
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
26755
+ /** 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. */
26756
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
26757
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26758
+ visionline_metadata?: {
26759
+ card_function_type: 'guest' | 'staff';
26760
+ joiner_acs_credential_ids?: string[] | undefined;
26761
+ guest_acs_entrance_ids?: string[] | undefined;
26762
+ common_acs_entrance_ids?: string[] | undefined;
26763
+ is_valid?: boolean | undefined;
26764
+ auto_join?: boolean | undefined;
26765
+ card_id?: string | undefined;
26766
+ credential_id?: string | undefined;
26767
+ } | undefined;
26768
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26769
+ assa_abloy_vostio_metadata?: {
26770
+ override_guest_acs_entrance_ids?: string[] | undefined;
26771
+ key_id?: string | undefined;
26772
+ key_issuing_request_id?: string | undefined;
26773
+ door_names?: string[] | undefined;
26774
+ endpoint_id?: string | undefined;
26775
+ } | undefined;
26776
+ is_managed: false;
26777
+ }) | null;
26778
+ warnings: Array<{
26779
+ warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
26780
+ warning_message: string;
26781
+ }>;
26782
+ };
26783
+ } | {
26784
+ /** ID of the action attempt. */
26785
+ action_attempt_id: string;
26786
+ status: 'error';
26787
+ /** Result of the action attempt. Null for failed action attempts. */
26788
+ result: null;
26789
+ action_type: 'SCAN_CREDENTIAL';
26790
+ error: {
26791
+ /** Type of the error associated with the action attempt. */
26792
+ type: 'uncategorized_error';
26793
+ /** Message for the error associated with the action attempt. */
26794
+ message: string;
26795
+ } | {
26796
+ /** Type of the error associated with the action attempt. */
26797
+ type: 'action_attempt_expired';
26798
+ /** Message for the error associated with the action attempt. */
26799
+ message: string;
26800
+ } | {
26801
+ type: 'no_credential_on_encoder';
26802
+ message: string;
26803
+ };
26804
+ } | {
26805
+ /** ID of the action attempt. */
26806
+ action_attempt_id: string;
26807
+ status: 'pending';
26808
+ /** Result of the action attempt. Null for pending action attempts. */
26809
+ result: null;
26810
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26811
+ error: null;
26812
+ /** Type of action that the action attempt tracks. */
26813
+ action_type: 'ENCODE_CREDENTIAL';
26814
+ } | {
26815
+ /** ID of the action attempt. */
26816
+ action_attempt_id: string;
26817
+ status: 'success';
26818
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26819
+ error: null;
26820
+ /** Type of action that the action attempt tracks. */
26821
+ action_type: 'ENCODE_CREDENTIAL';
26822
+ /** If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card. */
26823
+ result: {
26824
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26825
+ acs_credential_id: string;
26826
+ /** 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. */
26827
+ acs_user_id?: string | undefined;
26828
+ acs_credential_pool_id?: string | undefined;
26829
+ /** 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). */
26830
+ acs_system_id: string;
26831
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26832
+ parent_acs_credential_id?: string | undefined;
26833
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26834
+ display_name: string;
26835
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26836
+ code?: (string | undefined) | null;
26837
+ /** 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. */
26838
+ is_one_time_use?: boolean | undefined;
26839
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26840
+ card_number?: (string | undefined) | null;
26841
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
26842
+ is_issued?: boolean | undefined;
26843
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
26844
+ issued_at?: (string | undefined) | null;
26845
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
26846
+ access_method: 'code' | 'card' | 'mobile_key';
26847
+ /** 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`. */
26848
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
26849
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26850
+ external_type_display_name?: string | undefined;
26851
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
26852
+ created_at: string;
26853
+ /** 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). */
26854
+ workspace_id: string;
26855
+ /** 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. */
26856
+ starts_at?: string | undefined;
26857
+ /** 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`. */
26858
+ ends_at?: string | undefined;
26859
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26860
+ errors: Array<{
26861
+ error_code: string;
26862
+ message: string;
26863
+ }>;
26864
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26865
+ warnings: Array<{
26866
+ /** Date and time at which Seam created the warning. */
26867
+ created_at: string;
26868
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26869
+ message: string;
26870
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26871
+ warning_code: 'waiting_to_be_issued';
26872
+ } | {
26873
+ /** Date and time at which Seam created the warning. */
26874
+ created_at: string;
26875
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26876
+ message: string;
26877
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26878
+ warning_code: 'schedule_externally_modified';
26879
+ } | {
26880
+ /** Date and time at which Seam created the warning. */
26881
+ created_at: string;
26882
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26883
+ message: string;
26884
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26885
+ warning_code: 'schedule_modified';
26886
+ } | {
26887
+ /** Date and time at which Seam created the warning. */
26888
+ created_at: string;
26889
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26890
+ message: string;
26891
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26892
+ warning_code: 'being_deleted';
26893
+ } | {
26894
+ /** Date and time at which Seam created the warning. */
26895
+ created_at: string;
26896
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26897
+ message: string;
26898
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26899
+ warning_code: 'unknown_issue_with_acs_credential';
26900
+ } | {
26901
+ /** Date and time at which Seam created the warning. */
26902
+ created_at: string;
26903
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26904
+ message: string;
26905
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26906
+ warning_code: 'needs_to_be_reissued';
26907
+ }>;
26908
+ /** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
26909
+ is_multi_phone_sync_credential?: boolean | undefined;
26910
+ /** 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. */
26911
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
26912
+ /** 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. */
26913
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
26914
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26915
+ visionline_metadata?: {
26916
+ card_function_type: 'guest' | 'staff';
26917
+ joiner_acs_credential_ids?: string[] | undefined;
26918
+ guest_acs_entrance_ids?: string[] | undefined;
26919
+ common_acs_entrance_ids?: string[] | undefined;
26920
+ is_valid?: boolean | undefined;
26921
+ auto_join?: boolean | undefined;
26922
+ card_id?: string | undefined;
26923
+ credential_id?: string | undefined;
26924
+ } | undefined;
26925
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26926
+ assa_abloy_vostio_metadata?: {
26927
+ override_guest_acs_entrance_ids?: string[] | undefined;
26928
+ key_id?: string | undefined;
26929
+ key_issuing_request_id?: string | undefined;
26930
+ door_names?: string[] | undefined;
26931
+ endpoint_id?: string | undefined;
26932
+ } | undefined;
26933
+ is_managed: true;
26934
+ } | {
26935
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26936
+ acs_credential_id: string;
26937
+ /** 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. */
26938
+ acs_user_id?: string | undefined;
26939
+ acs_credential_pool_id?: string | undefined;
26940
+ /** 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). */
26941
+ acs_system_id: string;
26942
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26943
+ parent_acs_credential_id?: string | undefined;
26944
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26945
+ display_name: string;
26946
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26947
+ code?: (string | undefined) | null;
26948
+ /** 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. */
26949
+ is_one_time_use?: boolean | undefined;
26950
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26951
+ card_number?: (string | undefined) | null;
26952
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
26953
+ is_issued?: boolean | undefined;
26954
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
26955
+ issued_at?: (string | undefined) | null;
26956
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
26957
+ access_method: 'code' | 'card' | 'mobile_key';
26958
+ /** 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`. */
26959
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
26960
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26961
+ external_type_display_name?: string | undefined;
26962
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
26963
+ created_at: string;
26964
+ /** 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). */
26965
+ workspace_id: string;
26966
+ /** 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. */
26967
+ starts_at?: string | undefined;
26968
+ /** 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`. */
26969
+ ends_at?: string | undefined;
26970
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26971
+ errors: Array<{
26972
+ error_code: string;
26973
+ message: string;
26974
+ }>;
26975
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26976
+ warnings: Array<{
26977
+ /** Date and time at which Seam created the warning. */
26978
+ created_at: string;
26979
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26980
+ message: string;
26981
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26982
+ warning_code: 'waiting_to_be_issued';
26983
+ } | {
26984
+ /** Date and time at which Seam created the warning. */
26985
+ created_at: string;
26986
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26987
+ message: string;
26988
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26989
+ warning_code: 'schedule_externally_modified';
26990
+ } | {
26991
+ /** Date and time at which Seam created the warning. */
26992
+ created_at: string;
26993
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26994
+ message: string;
26995
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26996
+ warning_code: 'schedule_modified';
26997
+ } | {
26998
+ /** Date and time at which Seam created the warning. */
26999
+ created_at: string;
27000
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27001
+ message: string;
27002
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27003
+ warning_code: 'being_deleted';
27004
+ } | {
27005
+ /** Date and time at which Seam created the warning. */
27006
+ created_at: string;
27007
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27008
+ message: string;
27009
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27010
+ warning_code: 'unknown_issue_with_acs_credential';
27011
+ } | {
27012
+ /** Date and time at which Seam created the warning. */
27013
+ created_at: string;
27014
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27015
+ message: string;
27016
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27017
+ warning_code: 'needs_to_be_reissued';
27018
+ }>;
27019
+ /** 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-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
27020
+ is_multi_phone_sync_credential?: boolean | undefined;
27021
+ /** 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. */
27022
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
27023
+ /** 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. */
27024
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
27025
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27026
+ visionline_metadata?: {
27027
+ card_function_type: 'guest' | 'staff';
27028
+ joiner_acs_credential_ids?: string[] | undefined;
27029
+ guest_acs_entrance_ids?: string[] | undefined;
27030
+ common_acs_entrance_ids?: string[] | undefined;
27031
+ is_valid?: boolean | undefined;
27032
+ auto_join?: boolean | undefined;
27033
+ card_id?: string | undefined;
27034
+ credential_id?: string | undefined;
27035
+ } | undefined;
27036
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27037
+ assa_abloy_vostio_metadata?: {
27038
+ override_guest_acs_entrance_ids?: string[] | undefined;
27039
+ key_id?: string | undefined;
27040
+ key_issuing_request_id?: string | undefined;
27041
+ door_names?: string[] | undefined;
27042
+ endpoint_id?: string | undefined;
27043
+ } | undefined;
27044
+ is_managed: false;
27045
+ };
27046
+ } | {
27047
+ /** ID of the action attempt. */
27048
+ action_attempt_id: string;
27049
+ status: 'error';
27050
+ /** Result of the action attempt. Null for failed action attempts. */
27051
+ result: null;
27052
+ /** Type of action that the action attempt tracks. */
27053
+ action_type: 'ENCODE_CREDENTIAL';
27054
+ error: {
27055
+ /** Type of the error associated with the action attempt. */
27056
+ type: 'uncategorized_error';
27057
+ /** Message for the error associated with the action attempt. */
27058
+ message: string;
27059
+ } | {
27060
+ /** Type of the error associated with the action attempt. */
27061
+ type: 'action_attempt_expired';
27062
+ /** Message for the error associated with the action attempt. */
27063
+ message: string;
27064
+ } | {
27065
+ type: 'no_credential_on_encoder';
27066
+ message: string;
27067
+ } | {
27068
+ type: 'incompatible_card_format';
27069
+ message: string;
27070
+ } | {
27071
+ type: 'credential_cannot_be_reissued';
27072
+ message: string;
27073
+ };
27074
+ } | {
27075
+ /** ID of the action attempt. */
27076
+ action_attempt_id: string;
27077
+ status: 'pending';
27078
+ /** Result of the action attempt. Null for pending action attempts. */
27079
+ result: null;
27080
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27081
+ error: null;
27082
+ action_type: 'RESET_SANDBOX_WORKSPACE';
27083
+ } | {
27084
+ /** ID of the action attempt. */
27085
+ action_attempt_id: string;
27086
+ status: 'success';
27087
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27088
+ error: null;
27089
+ action_type: 'RESET_SANDBOX_WORKSPACE';
27090
+ result: {};
27091
+ } | {
27092
+ /** ID of the action attempt. */
27093
+ action_attempt_id: string;
27094
+ status: 'error';
27095
+ /** Result of the action attempt. Null for failed action attempts. */
27096
+ result: null;
27097
+ action_type: 'RESET_SANDBOX_WORKSPACE';
27098
+ error: {
27099
+ type: string;
27100
+ message: string;
27101
+ };
27102
+ } | {
27103
+ /** ID of the action attempt. */
27104
+ action_attempt_id: string;
27105
+ status: 'pending';
27106
+ /** Result of the action attempt. Null for pending action attempts. */
27107
+ result: null;
27108
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27109
+ error: null;
27110
+ action_type: 'SET_FAN_MODE';
27111
+ } | {
27112
+ /** ID of the action attempt. */
27113
+ action_attempt_id: string;
27114
+ status: 'success';
27115
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27116
+ error: null;
27117
+ action_type: 'SET_FAN_MODE';
27118
+ result: {};
27119
+ } | {
27120
+ /** ID of the action attempt. */
27121
+ action_attempt_id: string;
27122
+ status: 'error';
27123
+ /** Result of the action attempt. Null for failed action attempts. */
27124
+ result: null;
27125
+ action_type: 'SET_FAN_MODE';
27126
+ error: {
27127
+ type: string;
27128
+ message: string;
27129
+ };
27130
+ } | {
27131
+ /** ID of the action attempt. */
27132
+ action_attempt_id: string;
27133
+ status: 'pending';
27134
+ /** Result of the action attempt. Null for pending action attempts. */
27135
+ result: null;
27136
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27137
+ error: null;
27138
+ action_type: 'SET_HVAC_MODE';
27139
+ } | {
27140
+ /** ID of the action attempt. */
27141
+ action_attempt_id: string;
27142
+ status: 'success';
27143
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27144
+ error: null;
27145
+ action_type: 'SET_HVAC_MODE';
27146
+ result: {};
27147
+ } | {
27148
+ /** ID of the action attempt. */
27149
+ action_attempt_id: string;
27150
+ status: 'error';
27151
+ /** Result of the action attempt. Null for failed action attempts. */
27152
+ result: null;
27153
+ action_type: 'SET_HVAC_MODE';
27154
+ error: {
27155
+ type: string;
27156
+ message: string;
27157
+ };
27158
+ } | {
27159
+ /** ID of the action attempt. */
27160
+ action_attempt_id: string;
27161
+ status: 'pending';
27162
+ /** Result of the action attempt. Null for pending action attempts. */
27163
+ result: null;
27164
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27165
+ error: null;
27166
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
27167
+ } | {
27168
+ /** ID of the action attempt. */
27169
+ action_attempt_id: string;
27170
+ status: 'success';
27171
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27172
+ error: null;
27173
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
27174
+ result: {};
27175
+ } | {
27176
+ /** ID of the action attempt. */
27177
+ action_attempt_id: string;
27178
+ status: 'error';
27179
+ /** Result of the action attempt. Null for failed action attempts. */
27180
+ result: null;
27181
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
27182
+ error: {
27183
+ type: string;
27184
+ message: string;
27185
+ };
27186
+ } | {
27187
+ /** ID of the action attempt. */
27188
+ action_attempt_id: string;
27189
+ status: 'pending';
27190
+ /** Result of the action attempt. Null for pending action attempts. */
27191
+ result: null;
27192
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27193
+ error: null;
27194
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
27195
+ } | {
27196
+ /** ID of the action attempt. */
27197
+ action_attempt_id: string;
27198
+ status: 'success';
27199
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27200
+ error: null;
27201
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
27202
+ result: {};
27203
+ } | {
27204
+ /** ID of the action attempt. */
27205
+ action_attempt_id: string;
27206
+ status: 'error';
27207
+ /** Result of the action attempt. Null for failed action attempts. */
27208
+ result: null;
27209
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
27210
+ error: {
27211
+ type: string;
27212
+ message: string;
27213
+ };
27214
+ } | {
27215
+ /** ID of the action attempt. */
27216
+ action_attempt_id: string;
27217
+ status: 'pending';
27218
+ /** Result of the action attempt. Null for pending action attempts. */
27219
+ result: null;
27220
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27221
+ error: null;
27222
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
27223
+ } | {
27224
+ /** ID of the action attempt. */
27225
+ action_attempt_id: string;
27226
+ status: 'success';
27227
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27228
+ error: null;
27229
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
27230
+ result: {};
27231
+ } | {
27232
+ /** ID of the action attempt. */
27233
+ action_attempt_id: string;
27234
+ status: 'error';
27235
+ /** Result of the action attempt. Null for failed action attempts. */
27236
+ result: null;
27237
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
27238
+ error: {
27239
+ type: string;
27240
+ message: string;
27241
+ };
27242
+ } | {
27243
+ /** ID of the action attempt. */
27244
+ action_attempt_id: string;
27245
+ status: 'pending';
27246
+ /** Result of the action attempt. Null for pending action attempts. */
27247
+ result: null;
27248
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27249
+ error: null;
27250
+ action_type: 'SYNC_ACCESS_CODES';
27251
+ } | {
27252
+ /** ID of the action attempt. */
27253
+ action_attempt_id: string;
27254
+ status: 'success';
27255
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27256
+ error: null;
27257
+ action_type: 'SYNC_ACCESS_CODES';
27258
+ result: {};
27259
+ } | {
27260
+ /** ID of the action attempt. */
27261
+ action_attempt_id: string;
27262
+ status: 'error';
27263
+ /** Result of the action attempt. Null for failed action attempts. */
27264
+ result: null;
27265
+ action_type: 'SYNC_ACCESS_CODES';
27266
+ error: {
27267
+ type: string;
27268
+ message: string;
27269
+ };
27270
+ } | {
27271
+ /** ID of the action attempt. */
27272
+ action_attempt_id: string;
27273
+ status: 'pending';
27274
+ /** Result of the action attempt. Null for pending action attempts. */
27275
+ result: null;
27276
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27277
+ error: null;
27278
+ action_type: 'CREATE_ACCESS_CODE';
27279
+ } | {
27280
+ /** ID of the action attempt. */
27281
+ action_attempt_id: string;
27282
+ status: 'success';
27283
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27284
+ error: null;
27285
+ action_type: 'CREATE_ACCESS_CODE';
27286
+ result: {
27287
+ access_code?: any;
27288
+ };
27289
+ } | {
27290
+ /** ID of the action attempt. */
27291
+ action_attempt_id: string;
27292
+ status: 'error';
27293
+ /** Result of the action attempt. Null for failed action attempts. */
27294
+ result: null;
27295
+ action_type: 'CREATE_ACCESS_CODE';
27296
+ error: {
27297
+ type: string;
27298
+ message: string;
27299
+ };
27300
+ } | {
27301
+ /** ID of the action attempt. */
27302
+ action_attempt_id: string;
27303
+ status: 'pending';
27304
+ /** Result of the action attempt. Null for pending action attempts. */
27305
+ result: null;
27306
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27307
+ error: null;
27308
+ action_type: 'DELETE_ACCESS_CODE';
27309
+ } | {
27310
+ /** ID of the action attempt. */
27311
+ action_attempt_id: string;
27312
+ status: 'success';
27313
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27314
+ error: null;
27315
+ action_type: 'DELETE_ACCESS_CODE';
27316
+ result: {};
27317
+ } | {
27318
+ /** ID of the action attempt. */
27319
+ action_attempt_id: string;
27320
+ status: 'error';
27321
+ /** Result of the action attempt. Null for failed action attempts. */
27322
+ result: null;
27323
+ action_type: 'DELETE_ACCESS_CODE';
27324
+ error: {
27325
+ type: string;
27326
+ message: string;
27327
+ };
27328
+ } | {
27329
+ /** ID of the action attempt. */
27330
+ action_attempt_id: string;
27331
+ status: 'pending';
27332
+ /** Result of the action attempt. Null for pending action attempts. */
27333
+ result: null;
27334
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27335
+ error: null;
27336
+ action_type: 'UPDATE_ACCESS_CODE';
27337
+ } | {
27338
+ /** ID of the action attempt. */
27339
+ action_attempt_id: string;
27340
+ status: 'success';
27341
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27342
+ error: null;
27343
+ action_type: 'UPDATE_ACCESS_CODE';
27344
+ result: {
27345
+ access_code?: any;
27346
+ };
27347
+ } | {
27348
+ /** ID of the action attempt. */
27349
+ action_attempt_id: string;
27350
+ status: 'error';
27351
+ /** Result of the action attempt. Null for failed action attempts. */
27352
+ result: null;
27353
+ action_type: 'UPDATE_ACCESS_CODE';
27354
+ error: {
27355
+ type: string;
27356
+ message: string;
27357
+ };
27358
+ } | {
27359
+ /** ID of the action attempt. */
27360
+ action_attempt_id: string;
27361
+ status: 'pending';
27362
+ /** Result of the action attempt. Null for pending action attempts. */
27363
+ result: null;
27364
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27365
+ error: null;
27366
+ action_type: 'CREATE_NOISE_THRESHOLD';
27367
+ } | {
27368
+ /** ID of the action attempt. */
27369
+ action_attempt_id: string;
27370
+ status: 'success';
27371
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27372
+ error: null;
27373
+ action_type: 'CREATE_NOISE_THRESHOLD';
27374
+ result: {
27375
+ noise_threshold?: any;
27376
+ };
27377
+ } | {
27378
+ /** ID of the action attempt. */
27379
+ action_attempt_id: string;
27380
+ status: 'error';
27381
+ /** Result of the action attempt. Null for failed action attempts. */
27382
+ result: null;
27383
+ action_type: 'CREATE_NOISE_THRESHOLD';
27384
+ error: {
27385
+ type: string;
27386
+ message: string;
27387
+ };
27388
+ } | {
27389
+ /** ID of the action attempt. */
27390
+ action_attempt_id: string;
27391
+ status: 'pending';
27392
+ /** Result of the action attempt. Null for pending action attempts. */
27393
+ result: null;
27394
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27395
+ error: null;
27396
+ action_type: 'DELETE_NOISE_THRESHOLD';
27397
+ } | {
27398
+ /** ID of the action attempt. */
27399
+ action_attempt_id: string;
27400
+ status: 'success';
27401
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27402
+ error: null;
27403
+ action_type: 'DELETE_NOISE_THRESHOLD';
27404
+ result: {};
27405
+ } | {
27406
+ /** ID of the action attempt. */
27407
+ action_attempt_id: string;
27408
+ status: 'error';
27409
+ /** Result of the action attempt. Null for failed action attempts. */
27410
+ result: null;
27411
+ action_type: 'DELETE_NOISE_THRESHOLD';
27412
+ error: {
27413
+ type: string;
27414
+ message: string;
27415
+ };
27416
+ } | {
27417
+ /** ID of the action attempt. */
27418
+ action_attempt_id: string;
27419
+ status: 'pending';
27420
+ /** Result of the action attempt. Null for pending action attempts. */
27421
+ result: null;
27422
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27423
+ error: null;
27424
+ action_type: 'UPDATE_NOISE_THRESHOLD';
27425
+ } | {
27426
+ /** ID of the action attempt. */
27427
+ action_attempt_id: string;
27428
+ status: 'success';
27429
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27430
+ error: null;
27431
+ action_type: 'UPDATE_NOISE_THRESHOLD';
27432
+ result: {
27433
+ noise_threshold?: any;
27434
+ };
27435
+ } | {
27436
+ /** ID of the action attempt. */
27437
+ action_attempt_id: string;
27438
+ status: 'error';
27439
+ /** Result of the action attempt. Null for failed action attempts. */
27440
+ result: null;
27441
+ action_type: 'UPDATE_NOISE_THRESHOLD';
27442
+ error: {
27443
+ type: string;
27444
+ message: string;
27445
+ };
27446
+ };
25437
27447
  };
25438
27448
  };
25439
27449
  '/locks/unlock_door': {
@@ -41750,6 +43760,8 @@ export interface Routes {
41750
43760
  commonParams: {
41751
43761
  /** ID of the user identity for which you want to generate an instant key. */
41752
43762
  user_identity_id: string;
43763
+ /** The maximum number of times the instant key can be used. Defaults to 1. */
43764
+ max_use_count?: number;
41753
43765
  };
41754
43766
  formData: {};
41755
43767
  jsonResponse: {
@@ -43702,10 +45714,24 @@ export interface Routes {
43702
45714
  * @deprecated use company_name */
43703
45715
  connect_partner_name?: ((string | null) | null) | undefined;
43704
45716
  is_sandbox?: boolean;
45717
+ /**
45718
+ * @deprecated Use `connect_webview_customization.webview_primary_button_color` instead. */
43705
45719
  webview_primary_button_color?: string | undefined;
45720
+ /**
45721
+ * @deprecated Use `connect_webview_customization.webview_primary_button_text_color` instead. */
43706
45722
  webview_primary_button_text_color?: string | undefined;
45723
+ /**
45724
+ * @deprecated Use `connect_webview_customization.webview_logo_shape` instead. */
43707
45725
  webview_logo_shape?: ('circle' | 'square') | undefined;
45726
+ /**
45727
+ * @deprecated Use `connect_webview_customization.webview_success_message` instead. */
43708
45728
  webview_success_message?: string | undefined;
45729
+ connect_webview_customization?: {
45730
+ primary_button_color?: (string | null) | undefined;
45731
+ primary_button_text_color?: (string | null) | undefined;
45732
+ success_message?: (string | null) | undefined;
45733
+ logo_shape?: (('circle' | 'square') | null) | undefined;
45734
+ } | undefined;
43709
45735
  };
43710
45736
  commonParams: {};
43711
45737
  formData: {};
@@ -43716,6 +45742,13 @@ export interface Routes {
43716
45742
  name: string;
43717
45743
  company_name: string;
43718
45744
  is_sandbox: boolean;
45745
+ connect_webview_customization: {
45746
+ primary_button_color?: string | undefined;
45747
+ primary_button_text_color?: string | undefined;
45748
+ success_message?: string | undefined;
45749
+ logo_shape?: ('circle' | 'square') | undefined;
45750
+ inviter_logo_url?: string | undefined;
45751
+ };
43719
45752
  /** True if a sandbox workspace has not been accessed in 14 days */
43720
45753
  is_suspended: boolean;
43721
45754
  /**
@@ -43738,6 +45771,13 @@ export interface Routes {
43738
45771
  name: string;
43739
45772
  company_name: string;
43740
45773
  is_sandbox: boolean;
45774
+ connect_webview_customization: {
45775
+ primary_button_color?: string | undefined;
45776
+ primary_button_text_color?: string | undefined;
45777
+ success_message?: string | undefined;
45778
+ logo_shape?: ('circle' | 'square') | undefined;
45779
+ inviter_logo_url?: string | undefined;
45780
+ };
43741
45781
  /** True if a sandbox workspace has not been accessed in 14 days */
43742
45782
  is_suspended: boolean;
43743
45783
  /**
@@ -43759,6 +45799,13 @@ export interface Routes {
43759
45799
  name: string;
43760
45800
  company_name: string;
43761
45801
  is_sandbox: boolean;
45802
+ connect_webview_customization: {
45803
+ primary_button_color?: string | undefined;
45804
+ primary_button_text_color?: string | undefined;
45805
+ success_message?: string | undefined;
45806
+ logo_shape?: ('circle' | 'square') | undefined;
45807
+ inviter_logo_url?: string | undefined;
45808
+ };
43762
45809
  /** True if a sandbox workspace has not been accessed in 14 days */
43763
45810
  is_suspended: boolean;
43764
45811
  /**
@@ -44783,6 +46830,25 @@ export interface Routes {
44783
46830
  };
44784
46831
  };
44785
46832
  };
46833
+ '/workspaces/update': {
46834
+ route: '/workspaces/update';
46835
+ method: 'POST' | 'PATCH';
46836
+ queryParams: {};
46837
+ jsonBody: {
46838
+ name?: string | undefined;
46839
+ connect_partner_name?: string | undefined;
46840
+ connect_webview_customization?: {
46841
+ primary_button_color?: (string | null) | undefined;
46842
+ primary_button_text_color?: (string | null) | undefined;
46843
+ success_message?: (string | null) | undefined;
46844
+ logo_shape?: (('circle' | 'square') | null) | undefined;
46845
+ } | undefined;
46846
+ is_suspended?: boolean | undefined;
46847
+ };
46848
+ commonParams: {};
46849
+ formData: {};
46850
+ jsonResponse: {};
46851
+ };
44786
46852
  }
44787
46853
  export type RouteResponse<Path extends keyof Routes> = Routes[Path]['jsonResponse'];
44788
46854
  export type RouteRequestBody<Path extends keyof Routes> = Routes[Path]['jsonBody'] & Routes[Path]['commonParams'];