@seamapi/types 1.876.0 → 1.877.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.
@@ -22550,6 +22550,1774 @@ export type Routes = {
22550
22550
  }
22551
22551
  maxDuration: undefined
22552
22552
  }
22553
+ '/access_methods/unlock_door': {
22554
+ route: '/access_methods/unlock_door'
22555
+ method: 'POST'
22556
+ queryParams: {}
22557
+ jsonBody: {}
22558
+ commonParams: {
22559
+ /** ID of the cloud_key `access_method` to use for the unlock operation. */
22560
+ access_method_id: string
22561
+ /** ID of the entrance to unlock. */
22562
+ acs_entrance_id: string
22563
+ }
22564
+ formData: {}
22565
+ jsonResponse: {
22566
+ /** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
22567
+
22568
+ When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
22569
+
22570
+ See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts). */
22571
+ action_attempt:
22572
+ | {
22573
+ /** ID of the action attempt. */
22574
+ action_attempt_id: string
22575
+ status: 'pending'
22576
+ /** Result of the action attempt. Null for pending action attempts. */
22577
+ result: null
22578
+ /** Errors associated with the action attempt. Null for pending action attempts. */
22579
+ error: null
22580
+ /** Action attempt to track the status of locking a door. */
22581
+ action_type: 'LOCK_DOOR'
22582
+ }
22583
+ | {
22584
+ /** ID of the action attempt. */
22585
+ action_attempt_id: string
22586
+ status: 'success'
22587
+ /** Errors associated with the action attempt. Null for successful action attempts. */
22588
+ error: null
22589
+ /** Action attempt to track the status of locking a door. */
22590
+ action_type: 'LOCK_DOOR'
22591
+ /** Result of the action. */
22592
+ result: {
22593
+ /** Indicates whether the device confirmed that the lock action occurred. */
22594
+ was_confirmed_by_device?: boolean | undefined
22595
+ }
22596
+ }
22597
+ | {
22598
+ /** ID of the action attempt. */
22599
+ action_attempt_id: string
22600
+ status: 'error'
22601
+ /** Result of the action attempt. Null for failed action attempts. */
22602
+ result: null
22603
+ /** Action attempt to track the status of locking a door. */
22604
+ action_type: 'LOCK_DOOR'
22605
+ /** Error associated with the action. */
22606
+ error: {
22607
+ /** Type of the error. */
22608
+ type: string
22609
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22610
+ message: string
22611
+ }
22612
+ }
22613
+ | {
22614
+ /** ID of the action attempt. */
22615
+ action_attempt_id: string
22616
+ status: 'pending'
22617
+ /** Result of the action attempt. Null for pending action attempts. */
22618
+ result: null
22619
+ /** Errors associated with the action attempt. Null for pending action attempts. */
22620
+ error: null
22621
+ /** Action attempt to track the status of unlocking a door. */
22622
+ action_type: 'UNLOCK_DOOR'
22623
+ }
22624
+ | {
22625
+ /** ID of the action attempt. */
22626
+ action_attempt_id: string
22627
+ status: 'success'
22628
+ /** Errors associated with the action attempt. Null for successful action attempts. */
22629
+ error: null
22630
+ /** Action attempt to track the status of unlocking a door. */
22631
+ action_type: 'UNLOCK_DOOR'
22632
+ /** Result of the action. */
22633
+ result: {
22634
+ /** Indicates whether the device confirmed that the unlock action occurred. */
22635
+ was_confirmed_by_device?: boolean | undefined
22636
+ }
22637
+ }
22638
+ | {
22639
+ /** ID of the action attempt. */
22640
+ action_attempt_id: string
22641
+ status: 'error'
22642
+ /** Result of the action attempt. Null for failed action attempts. */
22643
+ result: null
22644
+ /** Action attempt to track the status of unlocking a door. */
22645
+ action_type: 'UNLOCK_DOOR'
22646
+ /** Error associated with the action. */
22647
+ error: {
22648
+ /** Type of the error. */
22649
+ type: string
22650
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22651
+ message: string
22652
+ }
22653
+ }
22654
+ | {
22655
+ /** ID of the action attempt. */
22656
+ action_attempt_id: string
22657
+ status: 'pending'
22658
+ /** Result of the action attempt. Null for pending action attempts. */
22659
+ result: null
22660
+ /** Errors associated with the action attempt. Null for pending action attempts. */
22661
+ error: null
22662
+ /** Action attempt to track the status of scanning a credential. */
22663
+ action_type: 'SCAN_CREDENTIAL'
22664
+ }
22665
+ | {
22666
+ /** ID of the action attempt. */
22667
+ action_attempt_id: string
22668
+ status: 'success'
22669
+ /** Errors associated with the action attempt. Null for successful action attempts. */
22670
+ error: null
22671
+ /** Action attempt to track the status of scanning a credential. */
22672
+ action_type: 'SCAN_CREDENTIAL'
22673
+ /** Result of scanning a card. If the attempt was successful, includes a snapshot of credential data read from the physical encoder, the corresponding data stored on Seam and the access system, and any associated warnings. */
22674
+ result: {
22675
+ /** Snapshot of credential data read from the physical encoder. */
22676
+ acs_credential_on_encoder: {
22677
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
22678
+ created_at: string | null
22679
+ is_issued: boolean | null
22680
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
22681
+ starts_at: string | null
22682
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
22683
+ ends_at: string | null
22684
+ /** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22685
+ card_number: string | null
22686
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22687
+ visionline_metadata?:
22688
+ | {
22689
+ /** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22690
+ card_id: string
22691
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
22692
+ cancelled: boolean
22693
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
22694
+ discarded: boolean
22695
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
22696
+ expired: boolean
22697
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
22698
+ overwritten: boolean
22699
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
22700
+ overridden?: boolean | undefined
22701
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
22702
+ pending_auto_update: boolean
22703
+ /** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22704
+ card_format: 'TLCode' | 'rfid48'
22705
+ /** Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22706
+ card_holder?: string | undefined
22707
+ /** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22708
+ number_of_issued_cards: number
22709
+ /** 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). */
22710
+ guest_acs_entrance_ids?: string[] | undefined
22711
+ /** 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). */
22712
+ common_acs_entrance_ids?: string[] | undefined
22713
+ }
22714
+ | undefined
22715
+ } | null
22716
+ /** Corresponding credential data as stored on Seam and the access system. */
22717
+ acs_credential_on_seam:
22718
+ | (
22719
+ | {
22720
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22721
+ acs_credential_id: string
22722
+ /** 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. */
22723
+ acs_user_id?: string | undefined
22724
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
22725
+ user_identity_id?: string | undefined
22726
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
22727
+ connected_account_id: string
22728
+ acs_credential_pool_id?: string | undefined
22729
+ /** 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). */
22730
+ acs_system_id: string
22731
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22732
+ parent_acs_credential_id?: string | undefined
22733
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
22734
+ display_name: string
22735
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22736
+ code?: (string | undefined) | null
22737
+ /** 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. */
22738
+ is_one_time_use?: boolean | undefined
22739
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22740
+ card_number?: (string | undefined) | null
22741
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
22742
+ is_issued?: boolean | undefined
22743
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
22744
+ issued_at?: (string | undefined) | null
22745
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
22746
+ access_method:
22747
+ | 'code'
22748
+ | 'card'
22749
+ | 'mobile_key'
22750
+ | 'cloud_key'
22751
+ /** 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`. */
22752
+ external_type?:
22753
+ | (
22754
+ | 'pti_card'
22755
+ | 'brivo_credential'
22756
+ | 'hid_credential'
22757
+ | 'visionline_card'
22758
+ | 'salto_ks_credential'
22759
+ | 'assa_abloy_vostio_key'
22760
+ | 'salto_space_key'
22761
+ | 'latch_access'
22762
+ | 'dormakaba_ambiance_credential'
22763
+ | 'hotek_card'
22764
+ | 'salto_ks_tag'
22765
+ | 'avigilon_alta_credential'
22766
+ )
22767
+ | undefined
22768
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
22769
+ external_type_display_name?: string | undefined
22770
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
22771
+ created_at: string
22772
+ /** 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). */
22773
+ workspace_id: string
22774
+ /** 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. */
22775
+ starts_at?: string | undefined
22776
+ /** 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`. */
22777
+ ends_at?: string | undefined
22778
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22779
+ errors: {
22780
+ error_code: string
22781
+ message: string
22782
+ }[]
22783
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22784
+ warnings: (
22785
+ | {
22786
+ /** Date and time at which Seam created the warning. */
22787
+ created_at: string
22788
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22789
+ message: string
22790
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22791
+ warning_code: 'waiting_to_be_issued'
22792
+ }
22793
+ | {
22794
+ /** Date and time at which Seam created the warning. */
22795
+ created_at: string
22796
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22797
+ message: string
22798
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22799
+ warning_code: 'schedule_externally_modified'
22800
+ }
22801
+ | {
22802
+ /** Date and time at which Seam created the warning. */
22803
+ created_at: string
22804
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22805
+ message: string
22806
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22807
+ warning_code: 'schedule_modified'
22808
+ }
22809
+ | {
22810
+ /** Date and time at which Seam created the warning. */
22811
+ created_at: string
22812
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22813
+ message: string
22814
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22815
+ warning_code: 'being_deleted'
22816
+ }
22817
+ | {
22818
+ /** Date and time at which Seam created the warning. */
22819
+ created_at: string
22820
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22821
+ message: string
22822
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22823
+ warning_code: 'unknown_issue_with_acs_credential'
22824
+ }
22825
+ | {
22826
+ /** Date and time at which Seam created the warning. */
22827
+ created_at: string
22828
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22829
+ message: string
22830
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22831
+ warning_code: 'needs_to_be_reissued'
22832
+ }
22833
+ )[]
22834
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
22835
+ is_multi_phone_sync_credential?: boolean | undefined
22836
+ /** 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. */
22837
+ is_latest_desired_state_synced_with_provider?:
22838
+ | (boolean | null)
22839
+ | undefined
22840
+ /** 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. */
22841
+ latest_desired_state_synced_with_provider_at?:
22842
+ | (string | null)
22843
+ | undefined
22844
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22845
+ visionline_metadata?:
22846
+ | {
22847
+ /** Card function type in the Visionline access system. */
22848
+ card_function_type: 'guest' | 'staff'
22849
+ /** IDs of the credentials to which you want to join. */
22850
+ joiner_acs_credential_ids?: string[] | undefined
22851
+ /** Guest entrance IDs in the Visionline access system. */
22852
+ guest_acs_entrance_ids?: string[] | undefined
22853
+ /** Common entrance IDs in the Visionline access system. */
22854
+ common_acs_entrance_ids?: string[] | undefined
22855
+ /** Indicates whether the credential is valid. */
22856
+ is_valid?: boolean | undefined
22857
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
22858
+ auto_join?: boolean | undefined
22859
+ /** ID of the card in the Visionline access system. */
22860
+ card_id?: string | undefined
22861
+ /** ID of the credential in the Visionline access system. */
22862
+ credential_id?: string | undefined
22863
+ }
22864
+ | undefined
22865
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22866
+ assa_abloy_vostio_metadata?:
22867
+ | {
22868
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
22869
+ auto_join?: boolean | undefined
22870
+ /** IDs of the guest entrances to override in the Vostio access system. */
22871
+ override_guest_acs_entrance_ids?:
22872
+ | string[]
22873
+ | undefined
22874
+ /** Key ID in the Vostio access system. */
22875
+ key_id?: string | undefined
22876
+ /** Key issuing request ID in the Vostio access system. */
22877
+ key_issuing_request_id?: string | undefined
22878
+ /** Names of the doors to which to grant access in the Vostio access system. */
22879
+ door_names?: string[] | undefined
22880
+ /** Endpoint ID in the Vostio access system. */
22881
+ endpoint_id?: string | undefined
22882
+ }
22883
+ | undefined
22884
+ is_managed: true
22885
+ }
22886
+ | {
22887
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22888
+ acs_credential_id: string
22889
+ /** 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. */
22890
+ acs_user_id?: string | undefined
22891
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
22892
+ user_identity_id?: string | undefined
22893
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
22894
+ connected_account_id: string
22895
+ acs_credential_pool_id?: string | undefined
22896
+ /** 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). */
22897
+ acs_system_id: string
22898
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22899
+ parent_acs_credential_id?: string | undefined
22900
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
22901
+ display_name: string
22902
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22903
+ code?: (string | undefined) | null
22904
+ /** 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. */
22905
+ is_one_time_use?: boolean | undefined
22906
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22907
+ card_number?: (string | undefined) | null
22908
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
22909
+ is_issued?: boolean | undefined
22910
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
22911
+ issued_at?: (string | undefined) | null
22912
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
22913
+ access_method:
22914
+ | 'code'
22915
+ | 'card'
22916
+ | 'mobile_key'
22917
+ | 'cloud_key'
22918
+ /** 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`. */
22919
+ external_type?:
22920
+ | (
22921
+ | 'pti_card'
22922
+ | 'brivo_credential'
22923
+ | 'hid_credential'
22924
+ | 'visionline_card'
22925
+ | 'salto_ks_credential'
22926
+ | 'assa_abloy_vostio_key'
22927
+ | 'salto_space_key'
22928
+ | 'latch_access'
22929
+ | 'dormakaba_ambiance_credential'
22930
+ | 'hotek_card'
22931
+ | 'salto_ks_tag'
22932
+ | 'avigilon_alta_credential'
22933
+ )
22934
+ | undefined
22935
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
22936
+ external_type_display_name?: string | undefined
22937
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
22938
+ created_at: string
22939
+ /** 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). */
22940
+ workspace_id: string
22941
+ /** 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. */
22942
+ starts_at?: string | undefined
22943
+ /** 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`. */
22944
+ ends_at?: string | undefined
22945
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22946
+ errors: {
22947
+ error_code: string
22948
+ message: string
22949
+ }[]
22950
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
22951
+ warnings: (
22952
+ | {
22953
+ /** Date and time at which Seam created the warning. */
22954
+ created_at: string
22955
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22956
+ message: string
22957
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22958
+ warning_code: 'waiting_to_be_issued'
22959
+ }
22960
+ | {
22961
+ /** Date and time at which Seam created the warning. */
22962
+ created_at: string
22963
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22964
+ message: string
22965
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22966
+ warning_code: 'schedule_externally_modified'
22967
+ }
22968
+ | {
22969
+ /** Date and time at which Seam created the warning. */
22970
+ created_at: string
22971
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22972
+ message: string
22973
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22974
+ warning_code: 'schedule_modified'
22975
+ }
22976
+ | {
22977
+ /** Date and time at which Seam created the warning. */
22978
+ created_at: string
22979
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22980
+ message: string
22981
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22982
+ warning_code: 'being_deleted'
22983
+ }
22984
+ | {
22985
+ /** Date and time at which Seam created the warning. */
22986
+ created_at: string
22987
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22988
+ message: string
22989
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22990
+ warning_code: 'unknown_issue_with_acs_credential'
22991
+ }
22992
+ | {
22993
+ /** Date and time at which Seam created the warning. */
22994
+ created_at: string
22995
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22996
+ message: string
22997
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22998
+ warning_code: 'needs_to_be_reissued'
22999
+ }
23000
+ )[]
23001
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
23002
+ is_multi_phone_sync_credential?: boolean | undefined
23003
+ /** 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. */
23004
+ is_latest_desired_state_synced_with_provider?:
23005
+ | (boolean | null)
23006
+ | undefined
23007
+ /** 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. */
23008
+ latest_desired_state_synced_with_provider_at?:
23009
+ | (string | null)
23010
+ | undefined
23011
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23012
+ visionline_metadata?:
23013
+ | {
23014
+ /** Card function type in the Visionline access system. */
23015
+ card_function_type: 'guest' | 'staff'
23016
+ /** IDs of the credentials to which you want to join. */
23017
+ joiner_acs_credential_ids?: string[] | undefined
23018
+ /** Guest entrance IDs in the Visionline access system. */
23019
+ guest_acs_entrance_ids?: string[] | undefined
23020
+ /** Common entrance IDs in the Visionline access system. */
23021
+ common_acs_entrance_ids?: string[] | undefined
23022
+ /** Indicates whether the credential is valid. */
23023
+ is_valid?: boolean | undefined
23024
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23025
+ auto_join?: boolean | undefined
23026
+ /** ID of the card in the Visionline access system. */
23027
+ card_id?: string | undefined
23028
+ /** ID of the credential in the Visionline access system. */
23029
+ credential_id?: string | undefined
23030
+ }
23031
+ | undefined
23032
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23033
+ assa_abloy_vostio_metadata?:
23034
+ | {
23035
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23036
+ auto_join?: boolean | undefined
23037
+ /** IDs of the guest entrances to override in the Vostio access system. */
23038
+ override_guest_acs_entrance_ids?:
23039
+ | string[]
23040
+ | undefined
23041
+ /** Key ID in the Vostio access system. */
23042
+ key_id?: string | undefined
23043
+ /** Key issuing request ID in the Vostio access system. */
23044
+ key_issuing_request_id?: string | undefined
23045
+ /** Names of the doors to which to grant access in the Vostio access system. */
23046
+ door_names?: string[] | undefined
23047
+ /** Endpoint ID in the Vostio access system. */
23048
+ endpoint_id?: string | undefined
23049
+ }
23050
+ | undefined
23051
+ is_managed: false
23052
+ }
23053
+ )
23054
+ | null
23055
+ /** Warnings related to scanning the credential, such as mismatches between the credential data currently encoded on the card and the corresponding data stored on Seam and the access system. */
23056
+ warnings: {
23057
+ /** Indicates a warning related to scanning a credential. */
23058
+ warning_code:
23059
+ | 'acs_credential_on_encoder_out_of_sync'
23060
+ | 'acs_credential_on_seam_not_found'
23061
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23062
+ warning_message: string
23063
+ }[]
23064
+ }
23065
+ }
23066
+ | {
23067
+ /** ID of the action attempt. */
23068
+ action_attempt_id: string
23069
+ status: 'error'
23070
+ /** Result of the action attempt. Null for failed action attempts. */
23071
+ result: null
23072
+ /** Action attempt to track the status of scanning a credential. */
23073
+ action_type: 'SCAN_CREDENTIAL'
23074
+ error:
23075
+ | {
23076
+ /** Type of the error associated with the action attempt. */
23077
+ type: 'uncategorized_error'
23078
+ /** Message for the error associated with the action attempt. */
23079
+ message: string
23080
+ }
23081
+ | {
23082
+ /** Type of the error associated with the action attempt. */
23083
+ type: 'action_attempt_expired'
23084
+ /** Message for the error associated with the action attempt. */
23085
+ message: string
23086
+ }
23087
+ | {
23088
+ /** Error type to indicate that there is no credential on the encoder. */
23089
+ type: 'no_credential_on_encoder'
23090
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23091
+ message: string
23092
+ }
23093
+ | {
23094
+ /** Error type to indicate that the encoder is not online. */
23095
+ type: 'encoder_not_online'
23096
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23097
+ message: string
23098
+ }
23099
+ | {
23100
+ /** Error type to indicate that communication with the encoder timed out. */
23101
+ type: 'encoder_communication_timeout'
23102
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23103
+ message: string
23104
+ }
23105
+ | {
23106
+ /** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
23107
+ type: 'bridge_disconnected'
23108
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23109
+ message: string
23110
+ }
23111
+ }
23112
+ | {
23113
+ /** ID of the action attempt. */
23114
+ action_attempt_id: string
23115
+ status: 'pending'
23116
+ /** Result of the action attempt. Null for pending action attempts. */
23117
+ result: null
23118
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23119
+ error: null
23120
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
23121
+ action_type: 'ENCODE_CREDENTIAL'
23122
+ }
23123
+ | {
23124
+ /** ID of the action attempt. */
23125
+ action_attempt_id: string
23126
+ status: 'success'
23127
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23128
+ error: null
23129
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
23130
+ action_type: 'ENCODE_CREDENTIAL'
23131
+ /** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
23132
+ result:
23133
+ | {
23134
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23135
+ acs_credential_id: string
23136
+ /** 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. */
23137
+ acs_user_id?: string | undefined
23138
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23139
+ user_identity_id?: string | undefined
23140
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23141
+ connected_account_id: string
23142
+ acs_credential_pool_id?: string | undefined
23143
+ /** 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). */
23144
+ acs_system_id: string
23145
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23146
+ parent_acs_credential_id?: string | undefined
23147
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23148
+ display_name: string
23149
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23150
+ code?: (string | undefined) | null
23151
+ /** 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. */
23152
+ is_one_time_use?: boolean | undefined
23153
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23154
+ card_number?: (string | undefined) | null
23155
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
23156
+ is_issued?: boolean | undefined
23157
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
23158
+ issued_at?: (string | undefined) | null
23159
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
23160
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
23161
+ /** 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`. */
23162
+ external_type?:
23163
+ | (
23164
+ | 'pti_card'
23165
+ | 'brivo_credential'
23166
+ | 'hid_credential'
23167
+ | 'visionline_card'
23168
+ | 'salto_ks_credential'
23169
+ | 'assa_abloy_vostio_key'
23170
+ | 'salto_space_key'
23171
+ | 'latch_access'
23172
+ | 'dormakaba_ambiance_credential'
23173
+ | 'hotek_card'
23174
+ | 'salto_ks_tag'
23175
+ | 'avigilon_alta_credential'
23176
+ )
23177
+ | undefined
23178
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23179
+ external_type_display_name?: string | undefined
23180
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
23181
+ created_at: string
23182
+ /** 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). */
23183
+ workspace_id: string
23184
+ /** 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. */
23185
+ starts_at?: string | undefined
23186
+ /** 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`. */
23187
+ ends_at?: string | undefined
23188
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23189
+ errors: {
23190
+ error_code: string
23191
+ message: string
23192
+ }[]
23193
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23194
+ warnings: (
23195
+ | {
23196
+ /** Date and time at which Seam created the warning. */
23197
+ created_at: string
23198
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23199
+ message: string
23200
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23201
+ warning_code: 'waiting_to_be_issued'
23202
+ }
23203
+ | {
23204
+ /** Date and time at which Seam created the warning. */
23205
+ created_at: string
23206
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23207
+ message: string
23208
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23209
+ warning_code: 'schedule_externally_modified'
23210
+ }
23211
+ | {
23212
+ /** Date and time at which Seam created the warning. */
23213
+ created_at: string
23214
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23215
+ message: string
23216
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23217
+ warning_code: 'schedule_modified'
23218
+ }
23219
+ | {
23220
+ /** Date and time at which Seam created the warning. */
23221
+ created_at: string
23222
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23223
+ message: string
23224
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23225
+ warning_code: 'being_deleted'
23226
+ }
23227
+ | {
23228
+ /** Date and time at which Seam created the warning. */
23229
+ created_at: string
23230
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23231
+ message: string
23232
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23233
+ warning_code: 'unknown_issue_with_acs_credential'
23234
+ }
23235
+ | {
23236
+ /** Date and time at which Seam created the warning. */
23237
+ created_at: string
23238
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23239
+ message: string
23240
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23241
+ warning_code: 'needs_to_be_reissued'
23242
+ }
23243
+ )[]
23244
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
23245
+ is_multi_phone_sync_credential?: boolean | undefined
23246
+ /** 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. */
23247
+ is_latest_desired_state_synced_with_provider?:
23248
+ | (boolean | null)
23249
+ | undefined
23250
+ /** 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. */
23251
+ latest_desired_state_synced_with_provider_at?:
23252
+ | (string | null)
23253
+ | undefined
23254
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23255
+ visionline_metadata?:
23256
+ | {
23257
+ /** Card function type in the Visionline access system. */
23258
+ card_function_type: 'guest' | 'staff'
23259
+ /** IDs of the credentials to which you want to join. */
23260
+ joiner_acs_credential_ids?: string[] | undefined
23261
+ /** Guest entrance IDs in the Visionline access system. */
23262
+ guest_acs_entrance_ids?: string[] | undefined
23263
+ /** Common entrance IDs in the Visionline access system. */
23264
+ common_acs_entrance_ids?: string[] | undefined
23265
+ /** Indicates whether the credential is valid. */
23266
+ is_valid?: boolean | undefined
23267
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23268
+ auto_join?: boolean | undefined
23269
+ /** ID of the card in the Visionline access system. */
23270
+ card_id?: string | undefined
23271
+ /** ID of the credential in the Visionline access system. */
23272
+ credential_id?: string | undefined
23273
+ }
23274
+ | undefined
23275
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23276
+ assa_abloy_vostio_metadata?:
23277
+ | {
23278
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23279
+ auto_join?: boolean | undefined
23280
+ /** IDs of the guest entrances to override in the Vostio access system. */
23281
+ override_guest_acs_entrance_ids?: string[] | undefined
23282
+ /** Key ID in the Vostio access system. */
23283
+ key_id?: string | undefined
23284
+ /** Key issuing request ID in the Vostio access system. */
23285
+ key_issuing_request_id?: string | undefined
23286
+ /** Names of the doors to which to grant access in the Vostio access system. */
23287
+ door_names?: string[] | undefined
23288
+ /** Endpoint ID in the Vostio access system. */
23289
+ endpoint_id?: string | undefined
23290
+ }
23291
+ | undefined
23292
+ is_managed: true
23293
+ }
23294
+ | {
23295
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23296
+ acs_credential_id: string
23297
+ /** 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. */
23298
+ acs_user_id?: string | undefined
23299
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23300
+ user_identity_id?: string | undefined
23301
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23302
+ connected_account_id: string
23303
+ acs_credential_pool_id?: string | undefined
23304
+ /** 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). */
23305
+ acs_system_id: string
23306
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23307
+ parent_acs_credential_id?: string | undefined
23308
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23309
+ display_name: string
23310
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23311
+ code?: (string | undefined) | null
23312
+ /** 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. */
23313
+ is_one_time_use?: boolean | undefined
23314
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23315
+ card_number?: (string | undefined) | null
23316
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
23317
+ is_issued?: boolean | undefined
23318
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
23319
+ issued_at?: (string | undefined) | null
23320
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
23321
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
23322
+ /** 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`. */
23323
+ external_type?:
23324
+ | (
23325
+ | 'pti_card'
23326
+ | 'brivo_credential'
23327
+ | 'hid_credential'
23328
+ | 'visionline_card'
23329
+ | 'salto_ks_credential'
23330
+ | 'assa_abloy_vostio_key'
23331
+ | 'salto_space_key'
23332
+ | 'latch_access'
23333
+ | 'dormakaba_ambiance_credential'
23334
+ | 'hotek_card'
23335
+ | 'salto_ks_tag'
23336
+ | 'avigilon_alta_credential'
23337
+ )
23338
+ | undefined
23339
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23340
+ external_type_display_name?: string | undefined
23341
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
23342
+ created_at: string
23343
+ /** 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). */
23344
+ workspace_id: string
23345
+ /** 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. */
23346
+ starts_at?: string | undefined
23347
+ /** 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`. */
23348
+ ends_at?: string | undefined
23349
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23350
+ errors: {
23351
+ error_code: string
23352
+ message: string
23353
+ }[]
23354
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23355
+ warnings: (
23356
+ | {
23357
+ /** Date and time at which Seam created the warning. */
23358
+ created_at: string
23359
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23360
+ message: string
23361
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23362
+ warning_code: 'waiting_to_be_issued'
23363
+ }
23364
+ | {
23365
+ /** Date and time at which Seam created the warning. */
23366
+ created_at: string
23367
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23368
+ message: string
23369
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23370
+ warning_code: 'schedule_externally_modified'
23371
+ }
23372
+ | {
23373
+ /** Date and time at which Seam created the warning. */
23374
+ created_at: string
23375
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23376
+ message: string
23377
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23378
+ warning_code: 'schedule_modified'
23379
+ }
23380
+ | {
23381
+ /** Date and time at which Seam created the warning. */
23382
+ created_at: string
23383
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23384
+ message: string
23385
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23386
+ warning_code: 'being_deleted'
23387
+ }
23388
+ | {
23389
+ /** Date and time at which Seam created the warning. */
23390
+ created_at: string
23391
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23392
+ message: string
23393
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23394
+ warning_code: 'unknown_issue_with_acs_credential'
23395
+ }
23396
+ | {
23397
+ /** Date and time at which Seam created the warning. */
23398
+ created_at: string
23399
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23400
+ message: string
23401
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23402
+ warning_code: 'needs_to_be_reissued'
23403
+ }
23404
+ )[]
23405
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
23406
+ is_multi_phone_sync_credential?: boolean | undefined
23407
+ /** 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. */
23408
+ is_latest_desired_state_synced_with_provider?:
23409
+ | (boolean | null)
23410
+ | undefined
23411
+ /** 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. */
23412
+ latest_desired_state_synced_with_provider_at?:
23413
+ | (string | null)
23414
+ | undefined
23415
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23416
+ visionline_metadata?:
23417
+ | {
23418
+ /** Card function type in the Visionline access system. */
23419
+ card_function_type: 'guest' | 'staff'
23420
+ /** IDs of the credentials to which you want to join. */
23421
+ joiner_acs_credential_ids?: string[] | undefined
23422
+ /** Guest entrance IDs in the Visionline access system. */
23423
+ guest_acs_entrance_ids?: string[] | undefined
23424
+ /** Common entrance IDs in the Visionline access system. */
23425
+ common_acs_entrance_ids?: string[] | undefined
23426
+ /** Indicates whether the credential is valid. */
23427
+ is_valid?: boolean | undefined
23428
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23429
+ auto_join?: boolean | undefined
23430
+ /** ID of the card in the Visionline access system. */
23431
+ card_id?: string | undefined
23432
+ /** ID of the credential in the Visionline access system. */
23433
+ credential_id?: string | undefined
23434
+ }
23435
+ | undefined
23436
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23437
+ assa_abloy_vostio_metadata?:
23438
+ | {
23439
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23440
+ auto_join?: boolean | undefined
23441
+ /** IDs of the guest entrances to override in the Vostio access system. */
23442
+ override_guest_acs_entrance_ids?: string[] | undefined
23443
+ /** Key ID in the Vostio access system. */
23444
+ key_id?: string | undefined
23445
+ /** Key issuing request ID in the Vostio access system. */
23446
+ key_issuing_request_id?: string | undefined
23447
+ /** Names of the doors to which to grant access in the Vostio access system. */
23448
+ door_names?: string[] | undefined
23449
+ /** Endpoint ID in the Vostio access system. */
23450
+ endpoint_id?: string | undefined
23451
+ }
23452
+ | undefined
23453
+ is_managed: false
23454
+ }
23455
+ }
23456
+ | {
23457
+ /** ID of the action attempt. */
23458
+ action_attempt_id: string
23459
+ status: 'error'
23460
+ /** Result of the action attempt. Null for failed action attempts. */
23461
+ result: null
23462
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
23463
+ action_type: 'ENCODE_CREDENTIAL'
23464
+ error:
23465
+ | {
23466
+ /** Type of the error associated with the action attempt. */
23467
+ type: 'uncategorized_error'
23468
+ /** Message for the error associated with the action attempt. */
23469
+ message: string
23470
+ }
23471
+ | {
23472
+ /** Type of the error associated with the action attempt. */
23473
+ type: 'action_attempt_expired'
23474
+ /** Message for the error associated with the action attempt. */
23475
+ message: string
23476
+ }
23477
+ | {
23478
+ /** Error type to indicate that there is no credential on the encoder. */
23479
+ type: 'no_credential_on_encoder'
23480
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23481
+ message: string
23482
+ }
23483
+ | {
23484
+ /** Error type to indicate an incompatible card format. */
23485
+ type: 'incompatible_card_format'
23486
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23487
+ message: string
23488
+ }
23489
+ | {
23490
+ /** Error type to indicate that the affected credential cannot be reissued. */
23491
+ type: 'credential_cannot_be_reissued'
23492
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23493
+ message: string
23494
+ }
23495
+ | {
23496
+ /** Error type to indicate that the encoder is not online. */
23497
+ type: 'encoder_not_online'
23498
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23499
+ message: string
23500
+ }
23501
+ | {
23502
+ /** Error type to indicate that communication with the encoder timed out. */
23503
+ type: 'encoder_communication_timeout'
23504
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23505
+ message: string
23506
+ }
23507
+ | {
23508
+ /** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
23509
+ type: 'bridge_disconnected'
23510
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23511
+ message: string
23512
+ }
23513
+ | {
23514
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
23515
+ type: 'encoding_interrupted'
23516
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23517
+ message: string
23518
+ }
23519
+ | {
23520
+ /** Error type to indicate that the credential was deleted and can no longer be encoded. */
23521
+ type: 'credential_deleted'
23522
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23523
+ message: string
23524
+ }
23525
+ }
23526
+ | {
23527
+ /** ID of the action attempt. */
23528
+ action_attempt_id: string
23529
+ status: 'pending'
23530
+ /** Result of the action attempt. Null for pending action attempts. */
23531
+ result: null
23532
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23533
+ error: null
23534
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
23535
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
23536
+ }
23537
+ | {
23538
+ /** ID of the action attempt. */
23539
+ action_attempt_id: string
23540
+ status: 'success'
23541
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23542
+ error: null
23543
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
23544
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
23545
+ /** Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned. */
23546
+ result: {
23547
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23548
+ acs_credential_id: string
23549
+ /** 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. */
23550
+ acs_user_id?: string | undefined
23551
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23552
+ user_identity_id?: string | undefined
23553
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
23554
+ connected_account_id: string
23555
+ acs_credential_pool_id?: string | undefined
23556
+ /** 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). */
23557
+ acs_system_id: string
23558
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23559
+ parent_acs_credential_id?: string | undefined
23560
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23561
+ display_name: string
23562
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23563
+ code?: (string | undefined) | null
23564
+ /** 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. */
23565
+ is_one_time_use?: boolean | undefined
23566
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23567
+ card_number?: (string | undefined) | null
23568
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
23569
+ is_issued?: boolean | undefined
23570
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
23571
+ issued_at?: (string | undefined) | null
23572
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
23573
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
23574
+ /** 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`. */
23575
+ external_type?:
23576
+ | (
23577
+ | 'pti_card'
23578
+ | 'brivo_credential'
23579
+ | 'hid_credential'
23580
+ | 'visionline_card'
23581
+ | 'salto_ks_credential'
23582
+ | 'assa_abloy_vostio_key'
23583
+ | 'salto_space_key'
23584
+ | 'latch_access'
23585
+ | 'dormakaba_ambiance_credential'
23586
+ | 'hotek_card'
23587
+ | 'salto_ks_tag'
23588
+ | 'avigilon_alta_credential'
23589
+ )
23590
+ | undefined
23591
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
23592
+ external_type_display_name?: string | undefined
23593
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
23594
+ created_at: string
23595
+ /** 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). */
23596
+ workspace_id: string
23597
+ /** 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. */
23598
+ starts_at?: string | undefined
23599
+ /** 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`. */
23600
+ ends_at?: string | undefined
23601
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23602
+ errors: {
23603
+ error_code: string
23604
+ message: string
23605
+ }[]
23606
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23607
+ warnings: (
23608
+ | {
23609
+ /** Date and time at which Seam created the warning. */
23610
+ created_at: string
23611
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23612
+ message: string
23613
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23614
+ warning_code: 'waiting_to_be_issued'
23615
+ }
23616
+ | {
23617
+ /** Date and time at which Seam created the warning. */
23618
+ created_at: string
23619
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23620
+ message: string
23621
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23622
+ warning_code: 'schedule_externally_modified'
23623
+ }
23624
+ | {
23625
+ /** Date and time at which Seam created the warning. */
23626
+ created_at: string
23627
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23628
+ message: string
23629
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23630
+ warning_code: 'schedule_modified'
23631
+ }
23632
+ | {
23633
+ /** Date and time at which Seam created the warning. */
23634
+ created_at: string
23635
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23636
+ message: string
23637
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23638
+ warning_code: 'being_deleted'
23639
+ }
23640
+ | {
23641
+ /** Date and time at which Seam created the warning. */
23642
+ created_at: string
23643
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23644
+ message: string
23645
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23646
+ warning_code: 'unknown_issue_with_acs_credential'
23647
+ }
23648
+ | {
23649
+ /** Date and time at which Seam created the warning. */
23650
+ created_at: string
23651
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23652
+ message: string
23653
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23654
+ warning_code: 'needs_to_be_reissued'
23655
+ }
23656
+ )[]
23657
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
23658
+ is_multi_phone_sync_credential?: boolean | undefined
23659
+ /** 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. */
23660
+ is_latest_desired_state_synced_with_provider?:
23661
+ | (boolean | null)
23662
+ | undefined
23663
+ /** 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. */
23664
+ latest_desired_state_synced_with_provider_at?:
23665
+ | (string | null)
23666
+ | undefined
23667
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23668
+ visionline_metadata?:
23669
+ | {
23670
+ /** Card function type in the Visionline access system. */
23671
+ card_function_type: 'guest' | 'staff'
23672
+ /** IDs of the credentials to which you want to join. */
23673
+ joiner_acs_credential_ids?: string[] | undefined
23674
+ /** Guest entrance IDs in the Visionline access system. */
23675
+ guest_acs_entrance_ids?: string[] | undefined
23676
+ /** Common entrance IDs in the Visionline access system. */
23677
+ common_acs_entrance_ids?: string[] | undefined
23678
+ /** Indicates whether the credential is valid. */
23679
+ is_valid?: boolean | undefined
23680
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23681
+ auto_join?: boolean | undefined
23682
+ /** ID of the card in the Visionline access system. */
23683
+ card_id?: string | undefined
23684
+ /** ID of the credential in the Visionline access system. */
23685
+ credential_id?: string | undefined
23686
+ }
23687
+ | undefined
23688
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
23689
+ assa_abloy_vostio_metadata?:
23690
+ | {
23691
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
23692
+ auto_join?: boolean | undefined
23693
+ /** IDs of the guest entrances to override in the Vostio access system. */
23694
+ override_guest_acs_entrance_ids?: string[] | undefined
23695
+ /** Key ID in the Vostio access system. */
23696
+ key_id?: string | undefined
23697
+ /** Key issuing request ID in the Vostio access system. */
23698
+ key_issuing_request_id?: string | undefined
23699
+ /** Names of the doors to which to grant access in the Vostio access system. */
23700
+ door_names?: string[] | undefined
23701
+ /** Endpoint ID in the Vostio access system. */
23702
+ endpoint_id?: string | undefined
23703
+ }
23704
+ | undefined
23705
+ is_managed: true
23706
+ }
23707
+ }
23708
+ | {
23709
+ /** ID of the action attempt. */
23710
+ action_attempt_id: string
23711
+ status: 'error'
23712
+ /** Result of the action attempt. Null for failed action attempts. */
23713
+ result: null
23714
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
23715
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
23716
+ error:
23717
+ | {
23718
+ /** Type of the error associated with the action attempt. */
23719
+ type: 'uncategorized_error'
23720
+ /** Message for the error associated with the action attempt. */
23721
+ message: string
23722
+ }
23723
+ | {
23724
+ /** Type of the error associated with the action attempt. */
23725
+ type: 'action_attempt_expired'
23726
+ /** Message for the error associated with the action attempt. */
23727
+ message: string
23728
+ }
23729
+ | {
23730
+ /** Error type to indicate that there is no credential on the encoder. */
23731
+ type: 'no_credential_on_encoder'
23732
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23733
+ message: string
23734
+ }
23735
+ }
23736
+ | {
23737
+ /** ID of the action attempt. */
23738
+ action_attempt_id: string
23739
+ status: 'pending'
23740
+ /** Result of the action attempt. Null for pending action attempts. */
23741
+ result: null
23742
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23743
+ error: null
23744
+ /** Action attempt to track the status of resetting a sandbox workspace. */
23745
+ action_type: 'RESET_SANDBOX_WORKSPACE'
23746
+ }
23747
+ | {
23748
+ /** ID of the action attempt. */
23749
+ action_attempt_id: string
23750
+ status: 'success'
23751
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23752
+ error: null
23753
+ /** Action attempt to track the status of resetting a sandbox workspace. */
23754
+ action_type: 'RESET_SANDBOX_WORKSPACE'
23755
+ /** Result of the action. */
23756
+ result: {}
23757
+ }
23758
+ | {
23759
+ /** ID of the action attempt. */
23760
+ action_attempt_id: string
23761
+ status: 'error'
23762
+ /** Result of the action attempt. Null for failed action attempts. */
23763
+ result: null
23764
+ /** Action attempt to track the status of resetting a sandbox workspace. */
23765
+ action_type: 'RESET_SANDBOX_WORKSPACE'
23766
+ /** Error associated with the action. */
23767
+ error: {
23768
+ /** Type of the error. */
23769
+ type: string
23770
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23771
+ message: string
23772
+ }
23773
+ }
23774
+ | {
23775
+ /** ID of the action attempt. */
23776
+ action_attempt_id: string
23777
+ status: 'pending'
23778
+ /** Result of the action attempt. Null for pending action attempts. */
23779
+ result: null
23780
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23781
+ error: null
23782
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
23783
+ action_type: 'SET_FAN_MODE'
23784
+ }
23785
+ | {
23786
+ /** ID of the action attempt. */
23787
+ action_attempt_id: string
23788
+ status: 'success'
23789
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23790
+ error: null
23791
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
23792
+ action_type: 'SET_FAN_MODE'
23793
+ /** Result of the action. */
23794
+ result: {}
23795
+ }
23796
+ | {
23797
+ /** ID of the action attempt. */
23798
+ action_attempt_id: string
23799
+ status: 'error'
23800
+ /** Result of the action attempt. Null for failed action attempts. */
23801
+ result: null
23802
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
23803
+ action_type: 'SET_FAN_MODE'
23804
+ /** Error associated with the action. */
23805
+ error: {
23806
+ /** Type of the error. */
23807
+ type: string
23808
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23809
+ message: string
23810
+ }
23811
+ }
23812
+ | {
23813
+ /** ID of the action attempt. */
23814
+ action_attempt_id: string
23815
+ status: 'pending'
23816
+ /** Result of the action attempt. Null for pending action attempts. */
23817
+ result: null
23818
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23819
+ error: null
23820
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
23821
+ action_type: 'SET_HVAC_MODE'
23822
+ }
23823
+ | {
23824
+ /** ID of the action attempt. */
23825
+ action_attempt_id: string
23826
+ status: 'success'
23827
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23828
+ error: null
23829
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
23830
+ action_type: 'SET_HVAC_MODE'
23831
+ /** Result of the action. */
23832
+ result: {}
23833
+ }
23834
+ | {
23835
+ /** ID of the action attempt. */
23836
+ action_attempt_id: string
23837
+ status: 'error'
23838
+ /** Result of the action attempt. Null for failed action attempts. */
23839
+ result: null
23840
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
23841
+ action_type: 'SET_HVAC_MODE'
23842
+ /** Error associated with the action. */
23843
+ error: {
23844
+ /** Type of the error. */
23845
+ type: string
23846
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23847
+ message: string
23848
+ }
23849
+ }
23850
+ | {
23851
+ /** ID of the action attempt. */
23852
+ action_attempt_id: string
23853
+ status: 'pending'
23854
+ /** Result of the action attempt. Null for pending action attempts. */
23855
+ result: null
23856
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23857
+ error: null
23858
+ /** Action attempt to track the status of a climate preset activation. */
23859
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
23860
+ }
23861
+ | {
23862
+ /** ID of the action attempt. */
23863
+ action_attempt_id: string
23864
+ status: 'success'
23865
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23866
+ error: null
23867
+ /** Action attempt to track the status of a climate preset activation. */
23868
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
23869
+ /** Result of the action. */
23870
+ result: {}
23871
+ }
23872
+ | {
23873
+ /** ID of the action attempt. */
23874
+ action_attempt_id: string
23875
+ status: 'error'
23876
+ /** Result of the action attempt. Null for failed action attempts. */
23877
+ result: null
23878
+ /** Action attempt to track the status of a climate preset activation. */
23879
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
23880
+ /** Error associated with the action. */
23881
+ error: {
23882
+ /** Type of the error. */
23883
+ type: string
23884
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23885
+ message: string
23886
+ }
23887
+ }
23888
+ | {
23889
+ /** ID of the action attempt. */
23890
+ action_attempt_id: string
23891
+ status: 'pending'
23892
+ /** Result of the action attempt. Null for pending action attempts. */
23893
+ result: null
23894
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23895
+ error: null
23896
+ /** Action attempt to track the status of simulating a keypad code entry. */
23897
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
23898
+ }
23899
+ | {
23900
+ /** ID of the action attempt. */
23901
+ action_attempt_id: string
23902
+ status: 'success'
23903
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23904
+ error: null
23905
+ /** Action attempt to track the status of simulating a keypad code entry. */
23906
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
23907
+ /** Result of the action. */
23908
+ result: {}
23909
+ }
23910
+ | {
23911
+ /** ID of the action attempt. */
23912
+ action_attempt_id: string
23913
+ status: 'error'
23914
+ /** Result of the action attempt. Null for failed action attempts. */
23915
+ result: null
23916
+ /** Action attempt to track the status of simulating a keypad code entry. */
23917
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
23918
+ /** Error associated with the action. */
23919
+ error: {
23920
+ /** Type of the error. */
23921
+ type: string
23922
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23923
+ message: string
23924
+ }
23925
+ }
23926
+ | {
23927
+ /** ID of the action attempt. */
23928
+ action_attempt_id: string
23929
+ status: 'pending'
23930
+ /** Result of the action attempt. Null for pending action attempts. */
23931
+ result: null
23932
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23933
+ error: null
23934
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
23935
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
23936
+ }
23937
+ | {
23938
+ /** ID of the action attempt. */
23939
+ action_attempt_id: string
23940
+ status: 'success'
23941
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23942
+ error: null
23943
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
23944
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
23945
+ /** Result of the action. */
23946
+ result: {}
23947
+ }
23948
+ | {
23949
+ /** ID of the action attempt. */
23950
+ action_attempt_id: string
23951
+ status: 'error'
23952
+ /** Result of the action attempt. Null for failed action attempts. */
23953
+ result: null
23954
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
23955
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
23956
+ /** Error associated with the action. */
23957
+ error: {
23958
+ /** Type of the error. */
23959
+ type: string
23960
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23961
+ message: string
23962
+ }
23963
+ }
23964
+ | {
23965
+ /** ID of the action attempt. */
23966
+ action_attempt_id: string
23967
+ status: 'pending'
23968
+ /** Result of the action attempt. Null for pending action attempts. */
23969
+ result: null
23970
+ /** Errors associated with the action attempt. Null for pending action attempts. */
23971
+ error: null
23972
+ /** Action attempt to track the status of pushing thermostat programs. */
23973
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
23974
+ }
23975
+ | {
23976
+ /** ID of the action attempt. */
23977
+ action_attempt_id: string
23978
+ status: 'success'
23979
+ /** Errors associated with the action attempt. Null for successful action attempts. */
23980
+ error: null
23981
+ /** Action attempt to track the status of pushing thermostat programs. */
23982
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
23983
+ /** Result of the action. */
23984
+ result: {}
23985
+ }
23986
+ | {
23987
+ /** ID of the action attempt. */
23988
+ action_attempt_id: string
23989
+ status: 'error'
23990
+ /** Result of the action attempt. Null for failed action attempts. */
23991
+ result: null
23992
+ /** Action attempt to track the status of pushing thermostat programs. */
23993
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
23994
+ /** Error associated with the action. */
23995
+ error: {
23996
+ /** Type of the error. */
23997
+ type: string
23998
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23999
+ message: string
24000
+ }
24001
+ }
24002
+ | {
24003
+ /** ID of the action attempt. */
24004
+ action_attempt_id: string
24005
+ status: 'pending'
24006
+ /** Result of the action attempt. Null for pending action attempts. */
24007
+ result: null
24008
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24009
+ error: null
24010
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
24011
+ action_type: 'CONFIGURE_AUTO_LOCK'
24012
+ }
24013
+ | {
24014
+ /** ID of the action attempt. */
24015
+ action_attempt_id: string
24016
+ status: 'success'
24017
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24018
+ error: null
24019
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
24020
+ action_type: 'CONFIGURE_AUTO_LOCK'
24021
+ /** Result of the action. */
24022
+ result: {}
24023
+ }
24024
+ | {
24025
+ /** ID of the action attempt. */
24026
+ action_attempt_id: string
24027
+ status: 'error'
24028
+ /** Result of the action attempt. Null for failed action attempts. */
24029
+ result: null
24030
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
24031
+ action_type: 'CONFIGURE_AUTO_LOCK'
24032
+ /** Error associated with the action. */
24033
+ error: {
24034
+ /** Type of the error. */
24035
+ type: string
24036
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24037
+ message: string
24038
+ }
24039
+ }
24040
+ | {
24041
+ /** ID of the action attempt. */
24042
+ action_attempt_id: string
24043
+ status: 'pending'
24044
+ /** Result of the action attempt. Null for pending action attempts. */
24045
+ result: null
24046
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24047
+ error: null
24048
+ /** Syncing access codes is pending. */
24049
+ action_type: 'SYNC_ACCESS_CODES'
24050
+ }
24051
+ | {
24052
+ /** ID of the action attempt. */
24053
+ action_attempt_id: string
24054
+ status: 'success'
24055
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24056
+ error: null
24057
+ /** Syncing access codes succeeded. */
24058
+ action_type: 'SYNC_ACCESS_CODES'
24059
+ /** Result of the action. */
24060
+ result: {}
24061
+ }
24062
+ | {
24063
+ /** ID of the action attempt. */
24064
+ action_attempt_id: string
24065
+ status: 'error'
24066
+ /** Result of the action attempt. Null for failed action attempts. */
24067
+ result: null
24068
+ /** Syncing access codes failed. */
24069
+ action_type: 'SYNC_ACCESS_CODES'
24070
+ /** Error associated with the action. */
24071
+ error: {
24072
+ /** Type of the error. */
24073
+ type: string
24074
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24075
+ message: string
24076
+ }
24077
+ }
24078
+ | {
24079
+ /** ID of the action attempt. */
24080
+ action_attempt_id: string
24081
+ status: 'pending'
24082
+ /** Result of the action attempt. Null for pending action attempts. */
24083
+ result: null
24084
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24085
+ error: null
24086
+ /** Creating an access code is pending. */
24087
+ action_type: 'CREATE_ACCESS_CODE'
24088
+ }
24089
+ | {
24090
+ /** ID of the action attempt. */
24091
+ action_attempt_id: string
24092
+ status: 'success'
24093
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24094
+ error: null
24095
+ /** Creating an access code succeeded. */
24096
+ action_type: 'CREATE_ACCESS_CODE'
24097
+ /** Result of the action. */
24098
+ result: {
24099
+ /** Created access code. */
24100
+ access_code?: any
24101
+ }
24102
+ }
24103
+ | {
24104
+ /** ID of the action attempt. */
24105
+ action_attempt_id: string
24106
+ status: 'error'
24107
+ /** Result of the action attempt. Null for failed action attempts. */
24108
+ result: null
24109
+ /** Creating an access code failed. */
24110
+ action_type: 'CREATE_ACCESS_CODE'
24111
+ /** Error associated with the action. */
24112
+ error: {
24113
+ /** Type of the error. */
24114
+ type: string
24115
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24116
+ message: string
24117
+ }
24118
+ }
24119
+ | {
24120
+ /** ID of the action attempt. */
24121
+ action_attempt_id: string
24122
+ status: 'pending'
24123
+ /** Result of the action attempt. Null for pending action attempts. */
24124
+ result: null
24125
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24126
+ error: null
24127
+ /** Deleting an access code is pending. */
24128
+ action_type: 'DELETE_ACCESS_CODE'
24129
+ }
24130
+ | {
24131
+ /** ID of the action attempt. */
24132
+ action_attempt_id: string
24133
+ status: 'success'
24134
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24135
+ error: null
24136
+ /** Deleting an access code succeeded. */
24137
+ action_type: 'DELETE_ACCESS_CODE'
24138
+ /** Result of the action. */
24139
+ result: {}
24140
+ }
24141
+ | {
24142
+ /** ID of the action attempt. */
24143
+ action_attempt_id: string
24144
+ status: 'error'
24145
+ /** Result of the action attempt. Null for failed action attempts. */
24146
+ result: null
24147
+ /** Deleting an access code failed. */
24148
+ action_type: 'DELETE_ACCESS_CODE'
24149
+ /** Error associated with the action. */
24150
+ error: {
24151
+ /** Type of the error. */
24152
+ type: string
24153
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24154
+ message: string
24155
+ }
24156
+ }
24157
+ | {
24158
+ /** ID of the action attempt. */
24159
+ action_attempt_id: string
24160
+ status: 'pending'
24161
+ /** Result of the action attempt. Null for pending action attempts. */
24162
+ result: null
24163
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24164
+ error: null
24165
+ /** Updating an access code is pending. */
24166
+ action_type: 'UPDATE_ACCESS_CODE'
24167
+ }
24168
+ | {
24169
+ /** ID of the action attempt. */
24170
+ action_attempt_id: string
24171
+ status: 'success'
24172
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24173
+ error: null
24174
+ /** Updating an access code succeeded. */
24175
+ action_type: 'UPDATE_ACCESS_CODE'
24176
+ /** Result of the action. */
24177
+ result: {
24178
+ /** Updated access code. */
24179
+ access_code?: any
24180
+ }
24181
+ }
24182
+ | {
24183
+ /** ID of the action attempt. */
24184
+ action_attempt_id: string
24185
+ status: 'error'
24186
+ /** Result of the action attempt. Null for failed action attempts. */
24187
+ result: null
24188
+ /** Updating an access code failed. */
24189
+ action_type: 'UPDATE_ACCESS_CODE'
24190
+ /** Error associated with the action. */
24191
+ error: {
24192
+ /** Type of the error. */
24193
+ type: string
24194
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24195
+ message: string
24196
+ }
24197
+ }
24198
+ | {
24199
+ /** ID of the action attempt. */
24200
+ action_attempt_id: string
24201
+ status: 'pending'
24202
+ /** Result of the action attempt. Null for pending action attempts. */
24203
+ result: null
24204
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24205
+ error: null
24206
+ /** Creating a noise threshold is pending. */
24207
+ action_type: 'CREATE_NOISE_THRESHOLD'
24208
+ }
24209
+ | {
24210
+ /** ID of the action attempt. */
24211
+ action_attempt_id: string
24212
+ status: 'success'
24213
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24214
+ error: null
24215
+ /** Creating a noise threshold succeeded. */
24216
+ action_type: 'CREATE_NOISE_THRESHOLD'
24217
+ /** Result of the action. */
24218
+ result: {
24219
+ /** Created noise threshold. */
24220
+ noise_threshold?: any
24221
+ }
24222
+ }
24223
+ | {
24224
+ /** ID of the action attempt. */
24225
+ action_attempt_id: string
24226
+ status: 'error'
24227
+ /** Result of the action attempt. Null for failed action attempts. */
24228
+ result: null
24229
+ /** Creating a noise threshold failed. */
24230
+ action_type: 'CREATE_NOISE_THRESHOLD'
24231
+ /** Error associated with the action. */
24232
+ error: {
24233
+ /** Type of the error. */
24234
+ type: string
24235
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24236
+ message: string
24237
+ }
24238
+ }
24239
+ | {
24240
+ /** ID of the action attempt. */
24241
+ action_attempt_id: string
24242
+ status: 'pending'
24243
+ /** Result of the action attempt. Null for pending action attempts. */
24244
+ result: null
24245
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24246
+ error: null
24247
+ /** Deleting a noise threshold is pending. */
24248
+ action_type: 'DELETE_NOISE_THRESHOLD'
24249
+ }
24250
+ | {
24251
+ /** ID of the action attempt. */
24252
+ action_attempt_id: string
24253
+ status: 'success'
24254
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24255
+ error: null
24256
+ /** Deleting a noise threshold succeeded. */
24257
+ action_type: 'DELETE_NOISE_THRESHOLD'
24258
+ /** Result of the action. */
24259
+ result: {}
24260
+ }
24261
+ | {
24262
+ /** ID of the action attempt. */
24263
+ action_attempt_id: string
24264
+ status: 'error'
24265
+ /** Result of the action attempt. Null for failed action attempts. */
24266
+ result: null
24267
+ /** Deleting a noise threshold failed. */
24268
+ action_type: 'DELETE_NOISE_THRESHOLD'
24269
+ /** Error associated with the action. */
24270
+ error: {
24271
+ /** Type of the error. */
24272
+ type: string
24273
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24274
+ message: string
24275
+ }
24276
+ }
24277
+ | {
24278
+ /** ID of the action attempt. */
24279
+ action_attempt_id: string
24280
+ status: 'pending'
24281
+ /** Result of the action attempt. Null for pending action attempts. */
24282
+ result: null
24283
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24284
+ error: null
24285
+ /** Updating a noise threshold is pending. */
24286
+ action_type: 'UPDATE_NOISE_THRESHOLD'
24287
+ }
24288
+ | {
24289
+ /** ID of the action attempt. */
24290
+ action_attempt_id: string
24291
+ status: 'success'
24292
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24293
+ error: null
24294
+ /** Updating a noise threshold succeeded. */
24295
+ action_type: 'UPDATE_NOISE_THRESHOLD'
24296
+ /** Result of the action. */
24297
+ result: {
24298
+ /** Updated noise threshold. */
24299
+ noise_threshold?: any
24300
+ }
24301
+ }
24302
+ | {
24303
+ /** ID of the action attempt. */
24304
+ action_attempt_id: string
24305
+ status: 'error'
24306
+ /** Result of the action attempt. Null for failed action attempts. */
24307
+ result: null
24308
+ /** Updating a noise threshold failed. */
24309
+ action_type: 'UPDATE_NOISE_THRESHOLD'
24310
+ /** Error associated with the action. */
24311
+ error: {
24312
+ /** Type of the error. */
24313
+ type: string
24314
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24315
+ message: string
24316
+ }
24317
+ }
24318
+ }
24319
+ maxDuration: undefined
24320
+ }
22553
24321
  '/access_methods/unmanaged/get': {
22554
24322
  route: '/access_methods/unmanaged/get'
22555
24323
  method: 'GET' | 'POST'