@seamapi/types 1.750.0 → 1.751.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.
@@ -13692,6 +13692,8 @@ export type Routes = {
13692
13692
  can_unlock_with_code?: boolean | undefined
13693
13693
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
13694
13694
  can_belong_to_reservation?: boolean | undefined
13695
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
13696
+ can_unlock_with_cloud_key?: boolean | undefined
13695
13697
  }[]
13696
13698
  | undefined
13697
13699
  connected_accounts?:
@@ -18681,6 +18683,8 @@ export type Routes = {
18681
18683
  can_unlock_with_code?: boolean | undefined
18682
18684
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
18683
18685
  can_belong_to_reservation?: boolean | undefined
18686
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
18687
+ can_unlock_with_cloud_key?: boolean | undefined
18684
18688
  }[]
18685
18689
  | undefined
18686
18690
  access_grants?:
@@ -20190,6 +20194,8 @@ export type Routes = {
20190
20194
  can_unlock_with_code?: boolean | undefined
20191
20195
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
20192
20196
  can_belong_to_reservation?: boolean | undefined
20197
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
20198
+ can_unlock_with_cloud_key?: boolean | undefined
20193
20199
  }[]
20194
20200
  }
20195
20201
  maxDuration: undefined
@@ -22131,6 +22137,8 @@ export type Routes = {
22131
22137
  can_unlock_with_code?: boolean | undefined
22132
22138
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
22133
22139
  can_belong_to_reservation?: boolean | undefined
22140
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
22141
+ can_unlock_with_cloud_key?: boolean | undefined
22134
22142
  }[]
22135
22143
  }
22136
22144
  maxDuration: undefined
@@ -26204,6 +26212,8 @@ export type Routes = {
26204
26212
  can_unlock_with_code?: boolean | undefined
26205
26213
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
26206
26214
  can_belong_to_reservation?: boolean | undefined
26215
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
26216
+ can_unlock_with_cloud_key?: boolean | undefined
26207
26217
  }
26208
26218
  }
26209
26219
  maxDuration: undefined
@@ -26412,6 +26422,8 @@ export type Routes = {
26412
26422
  can_unlock_with_code?: boolean | undefined
26413
26423
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
26414
26424
  can_belong_to_reservation?: boolean | undefined
26425
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
26426
+ can_unlock_with_cloud_key?: boolean | undefined
26415
26427
  }[]
26416
26428
  /** Information about the current page of results. */
26417
26429
  pagination: {
@@ -26601,6 +26613,1486 @@ export type Routes = {
26601
26613
  }
26602
26614
  maxDuration: undefined
26603
26615
  }
26616
+ '/acs/entrances/unlock': {
26617
+ route: '/acs/entrances/unlock'
26618
+ method: 'POST'
26619
+ queryParams: {}
26620
+ jsonBody: {}
26621
+ commonParams: {
26622
+ /** ID of the entrance to unlock. */
26623
+ acs_entrance_id: string
26624
+ /** ID of the cloud_key credential to use for the unlock operation. */
26625
+ acs_credential_id: string
26626
+ }
26627
+ formData: {}
26628
+ jsonResponse: {
26629
+ /** 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.
26630
+
26631
+ 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.
26632
+
26633
+ See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts). */
26634
+ action_attempt:
26635
+ | {
26636
+ /** ID of the action attempt. */
26637
+ action_attempt_id: string
26638
+ status: 'pending'
26639
+ /** Result of the action attempt. Null for pending action attempts. */
26640
+ result: null
26641
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26642
+ error: null
26643
+ /** Action attempt to track the status of locking a door. */
26644
+ action_type: 'LOCK_DOOR'
26645
+ }
26646
+ | {
26647
+ /** ID of the action attempt. */
26648
+ action_attempt_id: string
26649
+ status: 'success'
26650
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26651
+ error: null
26652
+ /** Action attempt to track the status of locking a door. */
26653
+ action_type: 'LOCK_DOOR'
26654
+ /** Result of the action. */
26655
+ result: {
26656
+ /** Indicates whether the device confirmed that the lock action occurred. */
26657
+ was_confirmed_by_device?: boolean | undefined
26658
+ }
26659
+ }
26660
+ | {
26661
+ /** ID of the action attempt. */
26662
+ action_attempt_id: string
26663
+ status: 'error'
26664
+ /** Result of the action attempt. Null for failed action attempts. */
26665
+ result: null
26666
+ /** Action attempt to track the status of locking a door. */
26667
+ action_type: 'LOCK_DOOR'
26668
+ /** Error associated with the action. */
26669
+ error: {
26670
+ /** Type of the error. */
26671
+ type: string
26672
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
26673
+ message: string
26674
+ }
26675
+ }
26676
+ | {
26677
+ /** ID of the action attempt. */
26678
+ action_attempt_id: string
26679
+ status: 'pending'
26680
+ /** Result of the action attempt. Null for pending action attempts. */
26681
+ result: null
26682
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26683
+ error: null
26684
+ /** Action attempt to track the status of unlocking a door. */
26685
+ action_type: 'UNLOCK_DOOR'
26686
+ }
26687
+ | {
26688
+ /** ID of the action attempt. */
26689
+ action_attempt_id: string
26690
+ status: 'success'
26691
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26692
+ error: null
26693
+ /** Action attempt to track the status of unlocking a door. */
26694
+ action_type: 'UNLOCK_DOOR'
26695
+ /** Result of the action. */
26696
+ result: {
26697
+ /** Indicates whether the device confirmed that the unlock action occurred. */
26698
+ was_confirmed_by_device?: boolean | undefined
26699
+ }
26700
+ }
26701
+ | {
26702
+ /** ID of the action attempt. */
26703
+ action_attempt_id: string
26704
+ status: 'error'
26705
+ /** Result of the action attempt. Null for failed action attempts. */
26706
+ result: null
26707
+ /** Action attempt to track the status of unlocking a door. */
26708
+ action_type: 'UNLOCK_DOOR'
26709
+ /** Error associated with the action. */
26710
+ error: {
26711
+ /** Type of the error. */
26712
+ type: string
26713
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
26714
+ message: string
26715
+ }
26716
+ }
26717
+ | {
26718
+ /** ID of the action attempt. */
26719
+ action_attempt_id: string
26720
+ status: 'pending'
26721
+ /** Result of the action attempt. Null for pending action attempts. */
26722
+ result: null
26723
+ /** Errors associated with the action attempt. Null for pending action attempts. */
26724
+ error: null
26725
+ /** Action attempt to track the status of scanning a credential. */
26726
+ action_type: 'SCAN_CREDENTIAL'
26727
+ }
26728
+ | {
26729
+ /** ID of the action attempt. */
26730
+ action_attempt_id: string
26731
+ status: 'success'
26732
+ /** Errors associated with the action attempt. Null for successful action attempts. */
26733
+ error: null
26734
+ /** Action attempt to track the status of scanning a credential. */
26735
+ action_type: 'SCAN_CREDENTIAL'
26736
+ /** 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. */
26737
+ result: {
26738
+ /** Snapshot of credential data read from the physical encoder. */
26739
+ acs_credential_on_encoder: {
26740
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
26741
+ created_at: string | null
26742
+ is_issued: boolean | null
26743
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
26744
+ starts_at: string | null
26745
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
26746
+ ends_at: string | null
26747
+ /** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26748
+ card_number: string | null
26749
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26750
+ visionline_metadata?:
26751
+ | {
26752
+ /** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26753
+ card_id: string
26754
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
26755
+ cancelled: boolean
26756
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
26757
+ discarded: boolean
26758
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
26759
+ expired: boolean
26760
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
26761
+ overwritten: boolean
26762
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
26763
+ overridden?: boolean | undefined
26764
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
26765
+ pending_auto_update: boolean
26766
+ /** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26767
+ card_format: 'TLCode' | 'rfid48'
26768
+ /** Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26769
+ card_holder?: string | undefined
26770
+ /** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26771
+ number_of_issued_cards: number
26772
+ /** 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). */
26773
+ guest_acs_entrance_ids?: string[] | undefined
26774
+ /** 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). */
26775
+ common_acs_entrance_ids?: string[] | undefined
26776
+ }
26777
+ | undefined
26778
+ } | null
26779
+ /** Corresponding credential data as stored on Seam and the access system. */
26780
+ acs_credential_on_seam:
26781
+ | (
26782
+ | {
26783
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26784
+ acs_credential_id: string
26785
+ /** 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. */
26786
+ acs_user_id?: string | undefined
26787
+ /** 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. */
26788
+ user_identity_id?: string | undefined
26789
+ /** 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. */
26790
+ connected_account_id: string
26791
+ acs_credential_pool_id?: string | undefined
26792
+ /** 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). */
26793
+ acs_system_id: string
26794
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26795
+ parent_acs_credential_id?: string | undefined
26796
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26797
+ display_name: string
26798
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26799
+ code?: (string | undefined) | null
26800
+ /** 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. */
26801
+ is_one_time_use?: boolean | undefined
26802
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26803
+ card_number?: (string | undefined) | null
26804
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
26805
+ is_issued?: boolean | undefined
26806
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
26807
+ issued_at?: (string | undefined) | null
26808
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
26809
+ access_method:
26810
+ | 'code'
26811
+ | 'card'
26812
+ | 'mobile_key'
26813
+ | 'cloud_key'
26814
+ /** 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`. */
26815
+ external_type?:
26816
+ | (
26817
+ | 'pti_card'
26818
+ | 'brivo_credential'
26819
+ | 'brivo_digital_credential'
26820
+ | 'hid_credential'
26821
+ | 'visionline_card'
26822
+ | 'salto_ks_credential'
26823
+ | 'assa_abloy_vostio_key'
26824
+ | 'salto_space_key'
26825
+ | 'latch_access'
26826
+ | 'dormakaba_ambiance_credential'
26827
+ | 'hotek_card'
26828
+ )
26829
+ | undefined
26830
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26831
+ external_type_display_name?: string | undefined
26832
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
26833
+ created_at: string
26834
+ /** 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). */
26835
+ workspace_id: string
26836
+ /** 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. */
26837
+ starts_at?: string | undefined
26838
+ /** 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`. */
26839
+ ends_at?: string | undefined
26840
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26841
+ errors: {
26842
+ error_code: string
26843
+ message: string
26844
+ }[]
26845
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26846
+ warnings: (
26847
+ | {
26848
+ /** Date and time at which Seam created the warning. */
26849
+ created_at: string
26850
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26851
+ message: string
26852
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26853
+ warning_code: 'waiting_to_be_issued'
26854
+ }
26855
+ | {
26856
+ /** Date and time at which Seam created the warning. */
26857
+ created_at: string
26858
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26859
+ message: string
26860
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26861
+ warning_code: 'schedule_externally_modified'
26862
+ }
26863
+ | {
26864
+ /** Date and time at which Seam created the warning. */
26865
+ created_at: string
26866
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26867
+ message: string
26868
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26869
+ warning_code: 'schedule_modified'
26870
+ }
26871
+ | {
26872
+ /** Date and time at which Seam created the warning. */
26873
+ created_at: string
26874
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26875
+ message: string
26876
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26877
+ warning_code: 'being_deleted'
26878
+ }
26879
+ | {
26880
+ /** Date and time at which Seam created the warning. */
26881
+ created_at: string
26882
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26883
+ message: string
26884
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26885
+ warning_code: 'unknown_issue_with_acs_credential'
26886
+ }
26887
+ | {
26888
+ /** Date and time at which Seam created the warning. */
26889
+ created_at: string
26890
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26891
+ message: string
26892
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26893
+ warning_code: 'needs_to_be_reissued'
26894
+ }
26895
+ )[]
26896
+ /** 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). */
26897
+ is_multi_phone_sync_credential?: boolean | undefined
26898
+ /** 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. */
26899
+ is_latest_desired_state_synced_with_provider?:
26900
+ | (boolean | null)
26901
+ | undefined
26902
+ /** 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. */
26903
+ latest_desired_state_synced_with_provider_at?:
26904
+ | (string | null)
26905
+ | undefined
26906
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26907
+ visionline_metadata?:
26908
+ | {
26909
+ /** Card function type in the Visionline access system. */
26910
+ card_function_type: 'guest' | 'staff'
26911
+ /** IDs of the credentials to which you want to join. */
26912
+ joiner_acs_credential_ids?: string[] | undefined
26913
+ /** Guest entrance IDs in the Visionline access system. */
26914
+ guest_acs_entrance_ids?: string[] | undefined
26915
+ /** Common entrance IDs in the Visionline access system. */
26916
+ common_acs_entrance_ids?: string[] | undefined
26917
+ /** Indicates whether the credential is valid. */
26918
+ is_valid?: boolean | undefined
26919
+ /** 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. */
26920
+ auto_join?: boolean | undefined
26921
+ /** ID of the card in the Visionline access system. */
26922
+ card_id?: string | undefined
26923
+ /** ID of the credential in the Visionline access system. */
26924
+ credential_id?: string | undefined
26925
+ }
26926
+ | undefined
26927
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26928
+ assa_abloy_vostio_metadata?:
26929
+ | {
26930
+ /** 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. */
26931
+ auto_join?: boolean | undefined
26932
+ /** IDs of the guest entrances to override in the Vostio access system. */
26933
+ override_guest_acs_entrance_ids?:
26934
+ | string[]
26935
+ | undefined
26936
+ /** Key ID in the Vostio access system. */
26937
+ key_id?: string | undefined
26938
+ /** Key issuing request ID in the Vostio access system. */
26939
+ key_issuing_request_id?: string | undefined
26940
+ /** Names of the doors to which to grant access in the Vostio access system. */
26941
+ door_names?: string[] | undefined
26942
+ /** Endpoint ID in the Vostio access system. */
26943
+ endpoint_id?: string | undefined
26944
+ }
26945
+ | undefined
26946
+ is_managed: true
26947
+ }
26948
+ | {
26949
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26950
+ acs_credential_id: string
26951
+ /** 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. */
26952
+ acs_user_id?: string | undefined
26953
+ /** 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. */
26954
+ user_identity_id?: string | undefined
26955
+ /** 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. */
26956
+ connected_account_id: string
26957
+ acs_credential_pool_id?: string | undefined
26958
+ /** 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). */
26959
+ acs_system_id: string
26960
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26961
+ parent_acs_credential_id?: string | undefined
26962
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26963
+ display_name: string
26964
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26965
+ code?: (string | undefined) | null
26966
+ /** 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. */
26967
+ is_one_time_use?: boolean | undefined
26968
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
26969
+ card_number?: (string | undefined) | null
26970
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
26971
+ is_issued?: boolean | undefined
26972
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
26973
+ issued_at?: (string | undefined) | null
26974
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
26975
+ access_method:
26976
+ | 'code'
26977
+ | 'card'
26978
+ | 'mobile_key'
26979
+ | 'cloud_key'
26980
+ /** 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`. */
26981
+ external_type?:
26982
+ | (
26983
+ | 'pti_card'
26984
+ | 'brivo_credential'
26985
+ | 'brivo_digital_credential'
26986
+ | 'hid_credential'
26987
+ | 'visionline_card'
26988
+ | 'salto_ks_credential'
26989
+ | 'assa_abloy_vostio_key'
26990
+ | 'salto_space_key'
26991
+ | 'latch_access'
26992
+ | 'dormakaba_ambiance_credential'
26993
+ | 'hotek_card'
26994
+ )
26995
+ | undefined
26996
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
26997
+ external_type_display_name?: string | undefined
26998
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
26999
+ created_at: string
27000
+ /** 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). */
27001
+ workspace_id: string
27002
+ /** 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. */
27003
+ starts_at?: string | undefined
27004
+ /** 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`. */
27005
+ ends_at?: string | undefined
27006
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27007
+ errors: {
27008
+ error_code: string
27009
+ message: string
27010
+ }[]
27011
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27012
+ warnings: (
27013
+ | {
27014
+ /** Date and time at which Seam created the warning. */
27015
+ created_at: string
27016
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27017
+ message: string
27018
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27019
+ warning_code: 'waiting_to_be_issued'
27020
+ }
27021
+ | {
27022
+ /** Date and time at which Seam created the warning. */
27023
+ created_at: string
27024
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27025
+ message: string
27026
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27027
+ warning_code: 'schedule_externally_modified'
27028
+ }
27029
+ | {
27030
+ /** Date and time at which Seam created the warning. */
27031
+ created_at: string
27032
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27033
+ message: string
27034
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27035
+ warning_code: 'schedule_modified'
27036
+ }
27037
+ | {
27038
+ /** Date and time at which Seam created the warning. */
27039
+ created_at: string
27040
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27041
+ message: string
27042
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27043
+ warning_code: 'being_deleted'
27044
+ }
27045
+ | {
27046
+ /** Date and time at which Seam created the warning. */
27047
+ created_at: string
27048
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27049
+ message: string
27050
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27051
+ warning_code: 'unknown_issue_with_acs_credential'
27052
+ }
27053
+ | {
27054
+ /** Date and time at which Seam created the warning. */
27055
+ created_at: string
27056
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27057
+ message: string
27058
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27059
+ warning_code: 'needs_to_be_reissued'
27060
+ }
27061
+ )[]
27062
+ /** 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). */
27063
+ is_multi_phone_sync_credential?: boolean | undefined
27064
+ /** 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. */
27065
+ is_latest_desired_state_synced_with_provider?:
27066
+ | (boolean | null)
27067
+ | undefined
27068
+ /** 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. */
27069
+ latest_desired_state_synced_with_provider_at?:
27070
+ | (string | null)
27071
+ | undefined
27072
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27073
+ visionline_metadata?:
27074
+ | {
27075
+ /** Card function type in the Visionline access system. */
27076
+ card_function_type: 'guest' | 'staff'
27077
+ /** IDs of the credentials to which you want to join. */
27078
+ joiner_acs_credential_ids?: string[] | undefined
27079
+ /** Guest entrance IDs in the Visionline access system. */
27080
+ guest_acs_entrance_ids?: string[] | undefined
27081
+ /** Common entrance IDs in the Visionline access system. */
27082
+ common_acs_entrance_ids?: string[] | undefined
27083
+ /** Indicates whether the credential is valid. */
27084
+ is_valid?: boolean | undefined
27085
+ /** 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. */
27086
+ auto_join?: boolean | undefined
27087
+ /** ID of the card in the Visionline access system. */
27088
+ card_id?: string | undefined
27089
+ /** ID of the credential in the Visionline access system. */
27090
+ credential_id?: string | undefined
27091
+ }
27092
+ | undefined
27093
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27094
+ assa_abloy_vostio_metadata?:
27095
+ | {
27096
+ /** 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. */
27097
+ auto_join?: boolean | undefined
27098
+ /** IDs of the guest entrances to override in the Vostio access system. */
27099
+ override_guest_acs_entrance_ids?:
27100
+ | string[]
27101
+ | undefined
27102
+ /** Key ID in the Vostio access system. */
27103
+ key_id?: string | undefined
27104
+ /** Key issuing request ID in the Vostio access system. */
27105
+ key_issuing_request_id?: string | undefined
27106
+ /** Names of the doors to which to grant access in the Vostio access system. */
27107
+ door_names?: string[] | undefined
27108
+ /** Endpoint ID in the Vostio access system. */
27109
+ endpoint_id?: string | undefined
27110
+ }
27111
+ | undefined
27112
+ is_managed: false
27113
+ }
27114
+ )
27115
+ | null
27116
+ /** 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. */
27117
+ warnings: {
27118
+ /** Indicates a warning related to scanning a credential. */
27119
+ warning_code:
27120
+ | 'acs_credential_on_encoder_out_of_sync'
27121
+ | 'acs_credential_on_seam_not_found'
27122
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27123
+ warning_message: string
27124
+ }[]
27125
+ }
27126
+ }
27127
+ | {
27128
+ /** ID of the action attempt. */
27129
+ action_attempt_id: string
27130
+ status: 'error'
27131
+ /** Result of the action attempt. Null for failed action attempts. */
27132
+ result: null
27133
+ /** Action attempt to track the status of scanning a credential. */
27134
+ action_type: 'SCAN_CREDENTIAL'
27135
+ error:
27136
+ | {
27137
+ /** Type of the error associated with the action attempt. */
27138
+ type: 'uncategorized_error'
27139
+ /** Message for the error associated with the action attempt. */
27140
+ message: string
27141
+ }
27142
+ | {
27143
+ /** Type of the error associated with the action attempt. */
27144
+ type: 'action_attempt_expired'
27145
+ /** Message for the error associated with the action attempt. */
27146
+ message: string
27147
+ }
27148
+ | {
27149
+ /** Error type to indicate that there is no credential on the encoder. */
27150
+ type: 'no_credential_on_encoder'
27151
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27152
+ message: string
27153
+ }
27154
+ | {
27155
+ /** Error type to indicate that the encoder is not online. */
27156
+ type: 'encoder_not_online'
27157
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27158
+ message: string
27159
+ }
27160
+ }
27161
+ | {
27162
+ /** ID of the action attempt. */
27163
+ action_attempt_id: string
27164
+ status: 'pending'
27165
+ /** Result of the action attempt. Null for pending action attempts. */
27166
+ result: null
27167
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27168
+ error: null
27169
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
27170
+ action_type: 'ENCODE_CREDENTIAL'
27171
+ }
27172
+ | {
27173
+ /** ID of the action attempt. */
27174
+ action_attempt_id: string
27175
+ status: 'success'
27176
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27177
+ error: null
27178
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
27179
+ action_type: 'ENCODE_CREDENTIAL'
27180
+ /** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
27181
+ result:
27182
+ | {
27183
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27184
+ acs_credential_id: string
27185
+ /** 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. */
27186
+ acs_user_id?: string | undefined
27187
+ /** 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. */
27188
+ user_identity_id?: string | undefined
27189
+ /** 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. */
27190
+ connected_account_id: string
27191
+ acs_credential_pool_id?: string | undefined
27192
+ /** 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). */
27193
+ acs_system_id: string
27194
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27195
+ parent_acs_credential_id?: string | undefined
27196
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
27197
+ display_name: string
27198
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27199
+ code?: (string | undefined) | null
27200
+ /** 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. */
27201
+ is_one_time_use?: boolean | undefined
27202
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27203
+ card_number?: (string | undefined) | null
27204
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
27205
+ is_issued?: boolean | undefined
27206
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
27207
+ issued_at?: (string | undefined) | null
27208
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
27209
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
27210
+ /** 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`. */
27211
+ external_type?:
27212
+ | (
27213
+ | 'pti_card'
27214
+ | 'brivo_credential'
27215
+ | 'brivo_digital_credential'
27216
+ | 'hid_credential'
27217
+ | 'visionline_card'
27218
+ | 'salto_ks_credential'
27219
+ | 'assa_abloy_vostio_key'
27220
+ | 'salto_space_key'
27221
+ | 'latch_access'
27222
+ | 'dormakaba_ambiance_credential'
27223
+ | 'hotek_card'
27224
+ )
27225
+ | undefined
27226
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
27227
+ external_type_display_name?: string | undefined
27228
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
27229
+ created_at: string
27230
+ /** 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). */
27231
+ workspace_id: string
27232
+ /** 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. */
27233
+ starts_at?: string | undefined
27234
+ /** 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`. */
27235
+ ends_at?: string | undefined
27236
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27237
+ errors: {
27238
+ error_code: string
27239
+ message: string
27240
+ }[]
27241
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27242
+ warnings: (
27243
+ | {
27244
+ /** Date and time at which Seam created the warning. */
27245
+ created_at: string
27246
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27247
+ message: string
27248
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27249
+ warning_code: 'waiting_to_be_issued'
27250
+ }
27251
+ | {
27252
+ /** Date and time at which Seam created the warning. */
27253
+ created_at: string
27254
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27255
+ message: string
27256
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27257
+ warning_code: 'schedule_externally_modified'
27258
+ }
27259
+ | {
27260
+ /** Date and time at which Seam created the warning. */
27261
+ created_at: string
27262
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27263
+ message: string
27264
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27265
+ warning_code: 'schedule_modified'
27266
+ }
27267
+ | {
27268
+ /** Date and time at which Seam created the warning. */
27269
+ created_at: string
27270
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27271
+ message: string
27272
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27273
+ warning_code: 'being_deleted'
27274
+ }
27275
+ | {
27276
+ /** Date and time at which Seam created the warning. */
27277
+ created_at: string
27278
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27279
+ message: string
27280
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27281
+ warning_code: 'unknown_issue_with_acs_credential'
27282
+ }
27283
+ | {
27284
+ /** Date and time at which Seam created the warning. */
27285
+ created_at: string
27286
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27287
+ message: string
27288
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27289
+ warning_code: 'needs_to_be_reissued'
27290
+ }
27291
+ )[]
27292
+ /** 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). */
27293
+ is_multi_phone_sync_credential?: boolean | undefined
27294
+ /** 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. */
27295
+ is_latest_desired_state_synced_with_provider?:
27296
+ | (boolean | null)
27297
+ | undefined
27298
+ /** 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. */
27299
+ latest_desired_state_synced_with_provider_at?:
27300
+ | (string | null)
27301
+ | undefined
27302
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27303
+ visionline_metadata?:
27304
+ | {
27305
+ /** Card function type in the Visionline access system. */
27306
+ card_function_type: 'guest' | 'staff'
27307
+ /** IDs of the credentials to which you want to join. */
27308
+ joiner_acs_credential_ids?: string[] | undefined
27309
+ /** Guest entrance IDs in the Visionline access system. */
27310
+ guest_acs_entrance_ids?: string[] | undefined
27311
+ /** Common entrance IDs in the Visionline access system. */
27312
+ common_acs_entrance_ids?: string[] | undefined
27313
+ /** Indicates whether the credential is valid. */
27314
+ is_valid?: boolean | undefined
27315
+ /** 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. */
27316
+ auto_join?: boolean | undefined
27317
+ /** ID of the card in the Visionline access system. */
27318
+ card_id?: string | undefined
27319
+ /** ID of the credential in the Visionline access system. */
27320
+ credential_id?: string | undefined
27321
+ }
27322
+ | undefined
27323
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27324
+ assa_abloy_vostio_metadata?:
27325
+ | {
27326
+ /** 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. */
27327
+ auto_join?: boolean | undefined
27328
+ /** IDs of the guest entrances to override in the Vostio access system. */
27329
+ override_guest_acs_entrance_ids?: string[] | undefined
27330
+ /** Key ID in the Vostio access system. */
27331
+ key_id?: string | undefined
27332
+ /** Key issuing request ID in the Vostio access system. */
27333
+ key_issuing_request_id?: string | undefined
27334
+ /** Names of the doors to which to grant access in the Vostio access system. */
27335
+ door_names?: string[] | undefined
27336
+ /** Endpoint ID in the Vostio access system. */
27337
+ endpoint_id?: string | undefined
27338
+ }
27339
+ | undefined
27340
+ is_managed: true
27341
+ }
27342
+ | {
27343
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27344
+ acs_credential_id: string
27345
+ /** 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. */
27346
+ acs_user_id?: string | undefined
27347
+ /** 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. */
27348
+ user_identity_id?: string | undefined
27349
+ /** 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. */
27350
+ connected_account_id: string
27351
+ acs_credential_pool_id?: string | undefined
27352
+ /** 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). */
27353
+ acs_system_id: string
27354
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27355
+ parent_acs_credential_id?: string | undefined
27356
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
27357
+ display_name: string
27358
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27359
+ code?: (string | undefined) | null
27360
+ /** 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. */
27361
+ is_one_time_use?: boolean | undefined
27362
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27363
+ card_number?: (string | undefined) | null
27364
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
27365
+ is_issued?: boolean | undefined
27366
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
27367
+ issued_at?: (string | undefined) | null
27368
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
27369
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
27370
+ /** 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`. */
27371
+ external_type?:
27372
+ | (
27373
+ | 'pti_card'
27374
+ | 'brivo_credential'
27375
+ | 'brivo_digital_credential'
27376
+ | 'hid_credential'
27377
+ | 'visionline_card'
27378
+ | 'salto_ks_credential'
27379
+ | 'assa_abloy_vostio_key'
27380
+ | 'salto_space_key'
27381
+ | 'latch_access'
27382
+ | 'dormakaba_ambiance_credential'
27383
+ | 'hotek_card'
27384
+ )
27385
+ | undefined
27386
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
27387
+ external_type_display_name?: string | undefined
27388
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
27389
+ created_at: string
27390
+ /** 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). */
27391
+ workspace_id: string
27392
+ /** 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. */
27393
+ starts_at?: string | undefined
27394
+ /** 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`. */
27395
+ ends_at?: string | undefined
27396
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27397
+ errors: {
27398
+ error_code: string
27399
+ message: string
27400
+ }[]
27401
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27402
+ warnings: (
27403
+ | {
27404
+ /** Date and time at which Seam created the warning. */
27405
+ created_at: string
27406
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27407
+ message: string
27408
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27409
+ warning_code: 'waiting_to_be_issued'
27410
+ }
27411
+ | {
27412
+ /** Date and time at which Seam created the warning. */
27413
+ created_at: string
27414
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27415
+ message: string
27416
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27417
+ warning_code: 'schedule_externally_modified'
27418
+ }
27419
+ | {
27420
+ /** Date and time at which Seam created the warning. */
27421
+ created_at: string
27422
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27423
+ message: string
27424
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27425
+ warning_code: 'schedule_modified'
27426
+ }
27427
+ | {
27428
+ /** Date and time at which Seam created the warning. */
27429
+ created_at: string
27430
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27431
+ message: string
27432
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27433
+ warning_code: 'being_deleted'
27434
+ }
27435
+ | {
27436
+ /** Date and time at which Seam created the warning. */
27437
+ created_at: string
27438
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27439
+ message: string
27440
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27441
+ warning_code: 'unknown_issue_with_acs_credential'
27442
+ }
27443
+ | {
27444
+ /** Date and time at which Seam created the warning. */
27445
+ created_at: string
27446
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27447
+ message: string
27448
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27449
+ warning_code: 'needs_to_be_reissued'
27450
+ }
27451
+ )[]
27452
+ /** 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). */
27453
+ is_multi_phone_sync_credential?: boolean | undefined
27454
+ /** 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. */
27455
+ is_latest_desired_state_synced_with_provider?:
27456
+ | (boolean | null)
27457
+ | undefined
27458
+ /** 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. */
27459
+ latest_desired_state_synced_with_provider_at?:
27460
+ | (string | null)
27461
+ | undefined
27462
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27463
+ visionline_metadata?:
27464
+ | {
27465
+ /** Card function type in the Visionline access system. */
27466
+ card_function_type: 'guest' | 'staff'
27467
+ /** IDs of the credentials to which you want to join. */
27468
+ joiner_acs_credential_ids?: string[] | undefined
27469
+ /** Guest entrance IDs in the Visionline access system. */
27470
+ guest_acs_entrance_ids?: string[] | undefined
27471
+ /** Common entrance IDs in the Visionline access system. */
27472
+ common_acs_entrance_ids?: string[] | undefined
27473
+ /** Indicates whether the credential is valid. */
27474
+ is_valid?: boolean | undefined
27475
+ /** 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. */
27476
+ auto_join?: boolean | undefined
27477
+ /** ID of the card in the Visionline access system. */
27478
+ card_id?: string | undefined
27479
+ /** ID of the credential in the Visionline access system. */
27480
+ credential_id?: string | undefined
27481
+ }
27482
+ | undefined
27483
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
27484
+ assa_abloy_vostio_metadata?:
27485
+ | {
27486
+ /** 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. */
27487
+ auto_join?: boolean | undefined
27488
+ /** IDs of the guest entrances to override in the Vostio access system. */
27489
+ override_guest_acs_entrance_ids?: string[] | undefined
27490
+ /** Key ID in the Vostio access system. */
27491
+ key_id?: string | undefined
27492
+ /** Key issuing request ID in the Vostio access system. */
27493
+ key_issuing_request_id?: string | undefined
27494
+ /** Names of the doors to which to grant access in the Vostio access system. */
27495
+ door_names?: string[] | undefined
27496
+ /** Endpoint ID in the Vostio access system. */
27497
+ endpoint_id?: string | undefined
27498
+ }
27499
+ | undefined
27500
+ is_managed: false
27501
+ }
27502
+ }
27503
+ | {
27504
+ /** ID of the action attempt. */
27505
+ action_attempt_id: string
27506
+ status: 'error'
27507
+ /** Result of the action attempt. Null for failed action attempts. */
27508
+ result: null
27509
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
27510
+ action_type: 'ENCODE_CREDENTIAL'
27511
+ error:
27512
+ | {
27513
+ /** Type of the error associated with the action attempt. */
27514
+ type: 'uncategorized_error'
27515
+ /** Message for the error associated with the action attempt. */
27516
+ message: string
27517
+ }
27518
+ | {
27519
+ /** Type of the error associated with the action attempt. */
27520
+ type: 'action_attempt_expired'
27521
+ /** Message for the error associated with the action attempt. */
27522
+ message: string
27523
+ }
27524
+ | {
27525
+ /** Error type to indicate that there is no credential on the encoder. */
27526
+ type: 'no_credential_on_encoder'
27527
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27528
+ message: string
27529
+ }
27530
+ | {
27531
+ /** Error type to indicate an incompatible card format. */
27532
+ type: 'incompatible_card_format'
27533
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27534
+ message: string
27535
+ }
27536
+ | {
27537
+ /** Error type to indicate that the affected credential cannot be reissued. */
27538
+ type: 'credential_cannot_be_reissued'
27539
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27540
+ message: string
27541
+ }
27542
+ | {
27543
+ /** Error type to indicate that the encoder is not online. */
27544
+ type: 'encoder_not_online'
27545
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27546
+ message: string
27547
+ }
27548
+ }
27549
+ | {
27550
+ /** ID of the action attempt. */
27551
+ action_attempt_id: string
27552
+ status: 'pending'
27553
+ /** Result of the action attempt. Null for pending action attempts. */
27554
+ result: null
27555
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27556
+ error: null
27557
+ /** Action attempt to track the status of resetting a sandbox workspace. */
27558
+ action_type: 'RESET_SANDBOX_WORKSPACE'
27559
+ }
27560
+ | {
27561
+ /** ID of the action attempt. */
27562
+ action_attempt_id: string
27563
+ status: 'success'
27564
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27565
+ error: null
27566
+ /** Action attempt to track the status of resetting a sandbox workspace. */
27567
+ action_type: 'RESET_SANDBOX_WORKSPACE'
27568
+ /** Result of the action. */
27569
+ result: {}
27570
+ }
27571
+ | {
27572
+ /** ID of the action attempt. */
27573
+ action_attempt_id: string
27574
+ status: 'error'
27575
+ /** Result of the action attempt. Null for failed action attempts. */
27576
+ result: null
27577
+ /** Action attempt to track the status of resetting a sandbox workspace. */
27578
+ action_type: 'RESET_SANDBOX_WORKSPACE'
27579
+ /** Error associated with the action. */
27580
+ error: {
27581
+ /** Type of the error. */
27582
+ type: string
27583
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27584
+ message: string
27585
+ }
27586
+ }
27587
+ | {
27588
+ /** ID of the action attempt. */
27589
+ action_attempt_id: string
27590
+ status: 'pending'
27591
+ /** Result of the action attempt. Null for pending action attempts. */
27592
+ result: null
27593
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27594
+ error: null
27595
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
27596
+ action_type: 'SET_FAN_MODE'
27597
+ }
27598
+ | {
27599
+ /** ID of the action attempt. */
27600
+ action_attempt_id: string
27601
+ status: 'success'
27602
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27603
+ error: null
27604
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
27605
+ action_type: 'SET_FAN_MODE'
27606
+ /** Result of the action. */
27607
+ result: {}
27608
+ }
27609
+ | {
27610
+ /** ID of the action attempt. */
27611
+ action_attempt_id: string
27612
+ status: 'error'
27613
+ /** Result of the action attempt. Null for failed action attempts. */
27614
+ result: null
27615
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
27616
+ action_type: 'SET_FAN_MODE'
27617
+ /** Error associated with the action. */
27618
+ error: {
27619
+ /** Type of the error. */
27620
+ type: string
27621
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27622
+ message: string
27623
+ }
27624
+ }
27625
+ | {
27626
+ /** ID of the action attempt. */
27627
+ action_attempt_id: string
27628
+ status: 'pending'
27629
+ /** Result of the action attempt. Null for pending action attempts. */
27630
+ result: null
27631
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27632
+ error: null
27633
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
27634
+ action_type: 'SET_HVAC_MODE'
27635
+ }
27636
+ | {
27637
+ /** ID of the action attempt. */
27638
+ action_attempt_id: string
27639
+ status: 'success'
27640
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27641
+ error: null
27642
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
27643
+ action_type: 'SET_HVAC_MODE'
27644
+ /** Result of the action. */
27645
+ result: {}
27646
+ }
27647
+ | {
27648
+ /** ID of the action attempt. */
27649
+ action_attempt_id: string
27650
+ status: 'error'
27651
+ /** Result of the action attempt. Null for failed action attempts. */
27652
+ result: null
27653
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
27654
+ action_type: 'SET_HVAC_MODE'
27655
+ /** Error associated with the action. */
27656
+ error: {
27657
+ /** Type of the error. */
27658
+ type: string
27659
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27660
+ message: string
27661
+ }
27662
+ }
27663
+ | {
27664
+ /** ID of the action attempt. */
27665
+ action_attempt_id: string
27666
+ status: 'pending'
27667
+ /** Result of the action attempt. Null for pending action attempts. */
27668
+ result: null
27669
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27670
+ error: null
27671
+ /** Action attempt to track the status of a climate preset activation. */
27672
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
27673
+ }
27674
+ | {
27675
+ /** ID of the action attempt. */
27676
+ action_attempt_id: string
27677
+ status: 'success'
27678
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27679
+ error: null
27680
+ /** Action attempt to track the status of a climate preset activation. */
27681
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
27682
+ /** Result of the action. */
27683
+ result: {}
27684
+ }
27685
+ | {
27686
+ /** ID of the action attempt. */
27687
+ action_attempt_id: string
27688
+ status: 'error'
27689
+ /** Result of the action attempt. Null for failed action attempts. */
27690
+ result: null
27691
+ /** Action attempt to track the status of a climate preset activation. */
27692
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
27693
+ /** Error associated with the action. */
27694
+ error: {
27695
+ /** Type of the error. */
27696
+ type: string
27697
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27698
+ message: string
27699
+ }
27700
+ }
27701
+ | {
27702
+ /** ID of the action attempt. */
27703
+ action_attempt_id: string
27704
+ status: 'pending'
27705
+ /** Result of the action attempt. Null for pending action attempts. */
27706
+ result: null
27707
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27708
+ error: null
27709
+ /** Action attempt to track the status of simulating a keypad code entry. */
27710
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
27711
+ }
27712
+ | {
27713
+ /** ID of the action attempt. */
27714
+ action_attempt_id: string
27715
+ status: 'success'
27716
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27717
+ error: null
27718
+ /** Action attempt to track the status of simulating a keypad code entry. */
27719
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
27720
+ /** Result of the action. */
27721
+ result: {}
27722
+ }
27723
+ | {
27724
+ /** ID of the action attempt. */
27725
+ action_attempt_id: string
27726
+ status: 'error'
27727
+ /** Result of the action attempt. Null for failed action attempts. */
27728
+ result: null
27729
+ /** Action attempt to track the status of simulating a keypad code entry. */
27730
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
27731
+ /** Error associated with the action. */
27732
+ error: {
27733
+ /** Type of the error. */
27734
+ type: string
27735
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27736
+ message: string
27737
+ }
27738
+ }
27739
+ | {
27740
+ /** ID of the action attempt. */
27741
+ action_attempt_id: string
27742
+ status: 'pending'
27743
+ /** Result of the action attempt. Null for pending action attempts. */
27744
+ result: null
27745
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27746
+ error: null
27747
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
27748
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
27749
+ }
27750
+ | {
27751
+ /** ID of the action attempt. */
27752
+ action_attempt_id: string
27753
+ status: 'success'
27754
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27755
+ error: null
27756
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
27757
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
27758
+ /** Result of the action. */
27759
+ result: {}
27760
+ }
27761
+ | {
27762
+ /** ID of the action attempt. */
27763
+ action_attempt_id: string
27764
+ status: 'error'
27765
+ /** Result of the action attempt. Null for failed action attempts. */
27766
+ result: null
27767
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
27768
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
27769
+ /** Error associated with the action. */
27770
+ error: {
27771
+ /** Type of the error. */
27772
+ type: string
27773
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27774
+ message: string
27775
+ }
27776
+ }
27777
+ | {
27778
+ /** ID of the action attempt. */
27779
+ action_attempt_id: string
27780
+ status: 'pending'
27781
+ /** Result of the action attempt. Null for pending action attempts. */
27782
+ result: null
27783
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27784
+ error: null
27785
+ /** Action attempt to track the status of pushing thermostat programs. */
27786
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
27787
+ }
27788
+ | {
27789
+ /** ID of the action attempt. */
27790
+ action_attempt_id: string
27791
+ status: 'success'
27792
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27793
+ error: null
27794
+ /** Action attempt to track the status of pushing thermostat programs. */
27795
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
27796
+ /** Result of the action. */
27797
+ result: {}
27798
+ }
27799
+ | {
27800
+ /** ID of the action attempt. */
27801
+ action_attempt_id: string
27802
+ status: 'error'
27803
+ /** Result of the action attempt. Null for failed action attempts. */
27804
+ result: null
27805
+ /** Action attempt to track the status of pushing thermostat programs. */
27806
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
27807
+ /** Error associated with the action. */
27808
+ error: {
27809
+ /** Type of the error. */
27810
+ type: string
27811
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27812
+ message: string
27813
+ }
27814
+ }
27815
+ | {
27816
+ /** ID of the action attempt. */
27817
+ action_attempt_id: string
27818
+ status: 'pending'
27819
+ /** Result of the action attempt. Null for pending action attempts. */
27820
+ result: null
27821
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27822
+ error: null
27823
+ /** Syncing access codes is pending. */
27824
+ action_type: 'SYNC_ACCESS_CODES'
27825
+ }
27826
+ | {
27827
+ /** ID of the action attempt. */
27828
+ action_attempt_id: string
27829
+ status: 'success'
27830
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27831
+ error: null
27832
+ /** Syncing access codes succeeded. */
27833
+ action_type: 'SYNC_ACCESS_CODES'
27834
+ /** Result of the action. */
27835
+ result: {}
27836
+ }
27837
+ | {
27838
+ /** ID of the action attempt. */
27839
+ action_attempt_id: string
27840
+ status: 'error'
27841
+ /** Result of the action attempt. Null for failed action attempts. */
27842
+ result: null
27843
+ /** Syncing access codes failed. */
27844
+ action_type: 'SYNC_ACCESS_CODES'
27845
+ /** Error associated with the action. */
27846
+ error: {
27847
+ /** Type of the error. */
27848
+ type: string
27849
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27850
+ message: string
27851
+ }
27852
+ }
27853
+ | {
27854
+ /** ID of the action attempt. */
27855
+ action_attempt_id: string
27856
+ status: 'pending'
27857
+ /** Result of the action attempt. Null for pending action attempts. */
27858
+ result: null
27859
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27860
+ error: null
27861
+ /** Creating an access code is pending. */
27862
+ action_type: 'CREATE_ACCESS_CODE'
27863
+ }
27864
+ | {
27865
+ /** ID of the action attempt. */
27866
+ action_attempt_id: string
27867
+ status: 'success'
27868
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27869
+ error: null
27870
+ /** Creating an access code succeeded. */
27871
+ action_type: 'CREATE_ACCESS_CODE'
27872
+ /** Result of the action. */
27873
+ result: {
27874
+ /** Created access code. */
27875
+ access_code?: any
27876
+ }
27877
+ }
27878
+ | {
27879
+ /** ID of the action attempt. */
27880
+ action_attempt_id: string
27881
+ status: 'error'
27882
+ /** Result of the action attempt. Null for failed action attempts. */
27883
+ result: null
27884
+ /** Creating an access code failed. */
27885
+ action_type: 'CREATE_ACCESS_CODE'
27886
+ /** Error associated with the action. */
27887
+ error: {
27888
+ /** Type of the error. */
27889
+ type: string
27890
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27891
+ message: string
27892
+ }
27893
+ }
27894
+ | {
27895
+ /** ID of the action attempt. */
27896
+ action_attempt_id: string
27897
+ status: 'pending'
27898
+ /** Result of the action attempt. Null for pending action attempts. */
27899
+ result: null
27900
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27901
+ error: null
27902
+ /** Deleting an access code is pending. */
27903
+ action_type: 'DELETE_ACCESS_CODE'
27904
+ }
27905
+ | {
27906
+ /** ID of the action attempt. */
27907
+ action_attempt_id: string
27908
+ status: 'success'
27909
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27910
+ error: null
27911
+ /** Deleting an access code succeeded. */
27912
+ action_type: 'DELETE_ACCESS_CODE'
27913
+ /** Result of the action. */
27914
+ result: {}
27915
+ }
27916
+ | {
27917
+ /** ID of the action attempt. */
27918
+ action_attempt_id: string
27919
+ status: 'error'
27920
+ /** Result of the action attempt. Null for failed action attempts. */
27921
+ result: null
27922
+ /** Deleting an access code failed. */
27923
+ action_type: 'DELETE_ACCESS_CODE'
27924
+ /** Error associated with the action. */
27925
+ error: {
27926
+ /** Type of the error. */
27927
+ type: string
27928
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27929
+ message: string
27930
+ }
27931
+ }
27932
+ | {
27933
+ /** ID of the action attempt. */
27934
+ action_attempt_id: string
27935
+ status: 'pending'
27936
+ /** Result of the action attempt. Null for pending action attempts. */
27937
+ result: null
27938
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27939
+ error: null
27940
+ /** Updating an access code is pending. */
27941
+ action_type: 'UPDATE_ACCESS_CODE'
27942
+ }
27943
+ | {
27944
+ /** ID of the action attempt. */
27945
+ action_attempt_id: string
27946
+ status: 'success'
27947
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27948
+ error: null
27949
+ /** Updating an access code succeeded. */
27950
+ action_type: 'UPDATE_ACCESS_CODE'
27951
+ /** Result of the action. */
27952
+ result: {
27953
+ /** Updated access code. */
27954
+ access_code?: any
27955
+ }
27956
+ }
27957
+ | {
27958
+ /** ID of the action attempt. */
27959
+ action_attempt_id: string
27960
+ status: 'error'
27961
+ /** Result of the action attempt. Null for failed action attempts. */
27962
+ result: null
27963
+ /** Updating an access code failed. */
27964
+ action_type: 'UPDATE_ACCESS_CODE'
27965
+ /** Error associated with the action. */
27966
+ error: {
27967
+ /** Type of the error. */
27968
+ type: string
27969
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27970
+ message: string
27971
+ }
27972
+ }
27973
+ | {
27974
+ /** ID of the action attempt. */
27975
+ action_attempt_id: string
27976
+ status: 'pending'
27977
+ /** Result of the action attempt. Null for pending action attempts. */
27978
+ result: null
27979
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27980
+ error: null
27981
+ /** Creating a noise threshold is pending. */
27982
+ action_type: 'CREATE_NOISE_THRESHOLD'
27983
+ }
27984
+ | {
27985
+ /** ID of the action attempt. */
27986
+ action_attempt_id: string
27987
+ status: 'success'
27988
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27989
+ error: null
27990
+ /** Creating a noise threshold succeeded. */
27991
+ action_type: 'CREATE_NOISE_THRESHOLD'
27992
+ /** Result of the action. */
27993
+ result: {
27994
+ /** Created noise threshold. */
27995
+ noise_threshold?: any
27996
+ }
27997
+ }
27998
+ | {
27999
+ /** ID of the action attempt. */
28000
+ action_attempt_id: string
28001
+ status: 'error'
28002
+ /** Result of the action attempt. Null for failed action attempts. */
28003
+ result: null
28004
+ /** Creating a noise threshold failed. */
28005
+ action_type: 'CREATE_NOISE_THRESHOLD'
28006
+ /** Error associated with the action. */
28007
+ error: {
28008
+ /** Type of the error. */
28009
+ type: string
28010
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
28011
+ message: string
28012
+ }
28013
+ }
28014
+ | {
28015
+ /** ID of the action attempt. */
28016
+ action_attempt_id: string
28017
+ status: 'pending'
28018
+ /** Result of the action attempt. Null for pending action attempts. */
28019
+ result: null
28020
+ /** Errors associated with the action attempt. Null for pending action attempts. */
28021
+ error: null
28022
+ /** Deleting a noise threshold is pending. */
28023
+ action_type: 'DELETE_NOISE_THRESHOLD'
28024
+ }
28025
+ | {
28026
+ /** ID of the action attempt. */
28027
+ action_attempt_id: string
28028
+ status: 'success'
28029
+ /** Errors associated with the action attempt. Null for successful action attempts. */
28030
+ error: null
28031
+ /** Deleting a noise threshold succeeded. */
28032
+ action_type: 'DELETE_NOISE_THRESHOLD'
28033
+ /** Result of the action. */
28034
+ result: {}
28035
+ }
28036
+ | {
28037
+ /** ID of the action attempt. */
28038
+ action_attempt_id: string
28039
+ status: 'error'
28040
+ /** Result of the action attempt. Null for failed action attempts. */
28041
+ result: null
28042
+ /** Deleting a noise threshold failed. */
28043
+ action_type: 'DELETE_NOISE_THRESHOLD'
28044
+ /** Error associated with the action. */
28045
+ error: {
28046
+ /** Type of the error. */
28047
+ type: string
28048
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
28049
+ message: string
28050
+ }
28051
+ }
28052
+ | {
28053
+ /** ID of the action attempt. */
28054
+ action_attempt_id: string
28055
+ status: 'pending'
28056
+ /** Result of the action attempt. Null for pending action attempts. */
28057
+ result: null
28058
+ /** Errors associated with the action attempt. Null for pending action attempts. */
28059
+ error: null
28060
+ /** Updating a noise threshold is pending. */
28061
+ action_type: 'UPDATE_NOISE_THRESHOLD'
28062
+ }
28063
+ | {
28064
+ /** ID of the action attempt. */
28065
+ action_attempt_id: string
28066
+ status: 'success'
28067
+ /** Errors associated with the action attempt. Null for successful action attempts. */
28068
+ error: null
28069
+ /** Updating a noise threshold succeeded. */
28070
+ action_type: 'UPDATE_NOISE_THRESHOLD'
28071
+ /** Result of the action. */
28072
+ result: {
28073
+ /** Updated noise threshold. */
28074
+ noise_threshold?: any
28075
+ }
28076
+ }
28077
+ | {
28078
+ /** ID of the action attempt. */
28079
+ action_attempt_id: string
28080
+ status: 'error'
28081
+ /** Result of the action attempt. Null for failed action attempts. */
28082
+ result: null
28083
+ /** Updating a noise threshold failed. */
28084
+ action_type: 'UPDATE_NOISE_THRESHOLD'
28085
+ /** Error associated with the action. */
28086
+ error: {
28087
+ /** Type of the error. */
28088
+ type: string
28089
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
28090
+ message: string
28091
+ }
28092
+ }
28093
+ }
28094
+ maxDuration: undefined
28095
+ }
26604
28096
  '/acs/systems/get': {
26605
28097
  route: '/acs/systems/get'
26606
28098
  method: 'GET' | 'POST'
@@ -28314,6 +29806,8 @@ export type Routes = {
28314
29806
  can_unlock_with_code?: boolean | undefined
28315
29807
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
28316
29808
  can_belong_to_reservation?: boolean | undefined
29809
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
29810
+ can_unlock_with_cloud_key?: boolean | undefined
28317
29811
  }[]
28318
29812
  }
28319
29813
  maxDuration: undefined
@@ -75042,6 +76536,8 @@ export type Routes = {
75042
76536
  can_unlock_with_code?: boolean | undefined
75043
76537
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
75044
76538
  can_belong_to_reservation?: boolean | undefined
76539
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
76540
+ can_unlock_with_cloud_key?: boolean | undefined
75045
76541
  }[]
75046
76542
  }[]
75047
76543
  }[]
@@ -77157,6 +78653,8 @@ export type Routes = {
77157
78653
  can_unlock_with_code?: boolean | undefined
77158
78654
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
77159
78655
  can_belong_to_reservation?: boolean | undefined
78656
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
78657
+ can_unlock_with_cloud_key?: boolean | undefined
77160
78658
  }[]
77161
78659
  | undefined
77162
78660
  connected_accounts?:
@@ -103353,6 +104851,8 @@ export type Routes = {
103353
104851
  can_unlock_with_code?: boolean | undefined
103354
104852
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
103355
104853
  can_belong_to_reservation?: boolean | undefined
104854
+ /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
104855
+ can_unlock_with_cloud_key?: boolean | undefined
103356
104856
  }[]
103357
104857
  | undefined
103358
104858
  acs_systems?: