@seamapi/types 1.385.0 → 1.386.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -30697,7 +30697,1186 @@ export interface Routes {
30697
30697
  commonParams: {}
30698
30698
  formData: {}
30699
30699
  jsonResponse: {
30700
- action_attempt?: any
30700
+ /** */
30701
+ action_attempt:
30702
+ | {
30703
+ /** ID of the action attempt. */
30704
+ action_attempt_id: string
30705
+ status: 'pending'
30706
+ /** Result of the action attempt. Null for pending action attempts. */
30707
+ result: null
30708
+ /** Errors associated with the action attempt. Null for pending action attempts. */
30709
+ error: null
30710
+ action_type: 'LOCK_DOOR'
30711
+ }
30712
+ | {
30713
+ /** ID of the action attempt. */
30714
+ action_attempt_id: string
30715
+ status: 'success'
30716
+ /** Errors associated with the action attempt. Null for successful action attempts. */
30717
+ error: null
30718
+ action_type: 'LOCK_DOOR'
30719
+ result: {}
30720
+ }
30721
+ | {
30722
+ /** ID of the action attempt. */
30723
+ action_attempt_id: string
30724
+ status: 'error'
30725
+ /** Result of the action attempt. Null for failed action attempts. */
30726
+ result: null
30727
+ action_type: 'LOCK_DOOR'
30728
+ error: {
30729
+ type: string
30730
+ message: string
30731
+ }
30732
+ }
30733
+ | {
30734
+ /** ID of the action attempt. */
30735
+ action_attempt_id: string
30736
+ status: 'pending'
30737
+ /** Result of the action attempt. Null for pending action attempts. */
30738
+ result: null
30739
+ /** Errors associated with the action attempt. Null for pending action attempts. */
30740
+ error: null
30741
+ action_type: 'UNLOCK_DOOR'
30742
+ }
30743
+ | {
30744
+ /** ID of the action attempt. */
30745
+ action_attempt_id: string
30746
+ status: 'success'
30747
+ /** Errors associated with the action attempt. Null for successful action attempts. */
30748
+ error: null
30749
+ action_type: 'UNLOCK_DOOR'
30750
+ result: {}
30751
+ }
30752
+ | {
30753
+ /** ID of the action attempt. */
30754
+ action_attempt_id: string
30755
+ status: 'error'
30756
+ /** Result of the action attempt. Null for failed action attempts. */
30757
+ result: null
30758
+ action_type: 'UNLOCK_DOOR'
30759
+ error: {
30760
+ type: string
30761
+ message: string
30762
+ }
30763
+ }
30764
+ | {
30765
+ /** ID of the action attempt. */
30766
+ action_attempt_id: string
30767
+ status: 'pending'
30768
+ /** Result of the action attempt. Null for pending action attempts. */
30769
+ result: null
30770
+ /** Errors associated with the action attempt. Null for pending action attempts. */
30771
+ error: null
30772
+ action_type: 'SCAN_CREDENTIAL'
30773
+ }
30774
+ | {
30775
+ /** ID of the action attempt. */
30776
+ action_attempt_id: string
30777
+ status: 'success'
30778
+ /** Errors associated with the action attempt. Null for successful action attempts. */
30779
+ error: null
30780
+ action_type: 'SCAN_CREDENTIAL'
30781
+ result: {
30782
+ /** Snapshot of credential data read from physical encoder. */
30783
+ acs_credential_on_encoder: {
30784
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
30785
+ created_at: string | null
30786
+ is_issued: boolean | null
30787
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
30788
+ starts_at: string | null
30789
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
30790
+ ends_at: string | null
30791
+ /** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30792
+ card_number: string | null
30793
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30794
+ visionline_metadata?:
30795
+ | {
30796
+ /** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30797
+ card_id: string
30798
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
30799
+ cancelled: boolean
30800
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
30801
+ discarded: boolean
30802
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
30803
+ expired: boolean
30804
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
30805
+ overwritten: boolean
30806
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
30807
+ overridden?: boolean | undefined
30808
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
30809
+ pending_auto_update: boolean
30810
+ /** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30811
+ card_format: 'TLCode' | 'rfid48'
30812
+ /** Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30813
+ card_holder?: string | undefined
30814
+ /** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30815
+ number_of_issued_cards: number
30816
+ /** 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). */
30817
+ guest_acs_entrance_ids?: string[] | undefined
30818
+ /** 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). */
30819
+ common_acs_entrance_ids?: string[] | undefined
30820
+ }
30821
+ | undefined
30822
+ } | null
30823
+ /** Matching acs_credential currently encoded on this card. */
30824
+ acs_credential_on_seam:
30825
+ | (
30826
+ | {
30827
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30828
+ acs_credential_id: string
30829
+ /** 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. */
30830
+ acs_user_id?: string | undefined
30831
+ acs_credential_pool_id?: string | undefined
30832
+ /** 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). */
30833
+ acs_system_id: string
30834
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30835
+ parent_acs_credential_id?: string | undefined
30836
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
30837
+ display_name: string
30838
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30839
+ code?: (string | undefined) | null
30840
+ /** 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. */
30841
+ is_one_time_use?: boolean | undefined
30842
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30843
+ card_number?: (string | undefined) | null
30844
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
30845
+ is_issued?: boolean | undefined
30846
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
30847
+ issued_at?: (string | undefined) | null
30848
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
30849
+ access_method: 'code' | 'card' | 'mobile_key'
30850
+ /** 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`. */
30851
+ external_type?:
30852
+ | (
30853
+ | 'pti_card'
30854
+ | 'brivo_credential'
30855
+ | 'hid_credential'
30856
+ | 'visionline_card'
30857
+ | 'salto_ks_credential'
30858
+ | 'assa_abloy_vostio_key'
30859
+ | 'salto_space_key'
30860
+ )
30861
+ | undefined
30862
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
30863
+ external_type_display_name?: string | undefined
30864
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
30865
+ created_at: string
30866
+ /** 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). */
30867
+ workspace_id: string
30868
+ /** 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. */
30869
+ starts_at?: string | undefined
30870
+ /** 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`. */
30871
+ ends_at?: string | undefined
30872
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30873
+ errors: Array<{
30874
+ error_code: string
30875
+ message: string
30876
+ }>
30877
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30878
+ warnings: Array<
30879
+ | {
30880
+ /** Date and time at which Seam created the warning. */
30881
+ created_at: string
30882
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
30883
+ message: string
30884
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
30885
+ warning_code: 'waiting_to_be_issued'
30886
+ }
30887
+ | {
30888
+ /** Date and time at which Seam created the warning. */
30889
+ created_at: string
30890
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
30891
+ message: string
30892
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
30893
+ warning_code: 'schedule_externally_modified'
30894
+ }
30895
+ | {
30896
+ /** Date and time at which Seam created the warning. */
30897
+ created_at: string
30898
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
30899
+ message: string
30900
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
30901
+ warning_code: 'schedule_modified'
30902
+ }
30903
+ | {
30904
+ /** Date and time at which Seam created the warning. */
30905
+ created_at: string
30906
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
30907
+ message: string
30908
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
30909
+ warning_code: 'being_deleted'
30910
+ }
30911
+ | {
30912
+ /** Date and time at which Seam created the warning. */
30913
+ created_at: string
30914
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
30915
+ message: string
30916
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
30917
+ warning_code: 'unknown_issue_with_acs_credential'
30918
+ }
30919
+ | {
30920
+ /** Date and time at which Seam created the warning. */
30921
+ created_at: string
30922
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
30923
+ message: string
30924
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
30925
+ warning_code: 'needs_to_be_reissued'
30926
+ }
30927
+ >
30928
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
30929
+ is_multi_phone_sync_credential?: boolean | undefined
30930
+ /** 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. */
30931
+ is_latest_desired_state_synced_with_provider?:
30932
+ | (boolean | null)
30933
+ | undefined
30934
+ /** 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. */
30935
+ latest_desired_state_synced_with_provider_at?:
30936
+ | (string | null)
30937
+ | undefined
30938
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30939
+ visionline_metadata?:
30940
+ | {
30941
+ card_function_type: 'guest' | 'staff'
30942
+ joiner_acs_credential_ids?: string[] | undefined
30943
+ guest_acs_entrance_ids?: string[] | undefined
30944
+ common_acs_entrance_ids?: string[] | undefined
30945
+ is_valid?: boolean | undefined
30946
+ auto_join?: boolean | undefined
30947
+ card_id?: string | undefined
30948
+ credential_id?: string | undefined
30949
+ }
30950
+ | undefined
30951
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30952
+ assa_abloy_vostio_metadata?:
30953
+ | {
30954
+ override_guest_acs_entrance_ids?:
30955
+ | string[]
30956
+ | undefined
30957
+ key_id?: string | undefined
30958
+ key_issuing_request_id?: string | undefined
30959
+ door_names?: string[] | undefined
30960
+ endpoint_id?: string | undefined
30961
+ }
30962
+ | undefined
30963
+ is_managed: true
30964
+ }
30965
+ | {
30966
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30967
+ acs_credential_id: string
30968
+ /** 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. */
30969
+ acs_user_id?: string | undefined
30970
+ acs_credential_pool_id?: string | undefined
30971
+ /** 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). */
30972
+ acs_system_id: string
30973
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30974
+ parent_acs_credential_id?: string | undefined
30975
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
30976
+ display_name: string
30977
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30978
+ code?: (string | undefined) | null
30979
+ /** 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. */
30980
+ is_one_time_use?: boolean | undefined
30981
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
30982
+ card_number?: (string | undefined) | null
30983
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
30984
+ is_issued?: boolean | undefined
30985
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
30986
+ issued_at?: (string | undefined) | null
30987
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
30988
+ access_method: 'code' | 'card' | 'mobile_key'
30989
+ /** 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`. */
30990
+ external_type?:
30991
+ | (
30992
+ | 'pti_card'
30993
+ | 'brivo_credential'
30994
+ | 'hid_credential'
30995
+ | 'visionline_card'
30996
+ | 'salto_ks_credential'
30997
+ | 'assa_abloy_vostio_key'
30998
+ | 'salto_space_key'
30999
+ )
31000
+ | undefined
31001
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
31002
+ external_type_display_name?: string | undefined
31003
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
31004
+ created_at: string
31005
+ /** 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). */
31006
+ workspace_id: string
31007
+ /** 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. */
31008
+ starts_at?: string | undefined
31009
+ /** 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`. */
31010
+ ends_at?: string | undefined
31011
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31012
+ errors: Array<{
31013
+ error_code: string
31014
+ message: string
31015
+ }>
31016
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31017
+ warnings: Array<
31018
+ | {
31019
+ /** Date and time at which Seam created the warning. */
31020
+ created_at: string
31021
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31022
+ message: string
31023
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31024
+ warning_code: 'waiting_to_be_issued'
31025
+ }
31026
+ | {
31027
+ /** Date and time at which Seam created the warning. */
31028
+ created_at: string
31029
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31030
+ message: string
31031
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31032
+ warning_code: 'schedule_externally_modified'
31033
+ }
31034
+ | {
31035
+ /** Date and time at which Seam created the warning. */
31036
+ created_at: string
31037
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31038
+ message: string
31039
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31040
+ warning_code: 'schedule_modified'
31041
+ }
31042
+ | {
31043
+ /** Date and time at which Seam created the warning. */
31044
+ created_at: string
31045
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31046
+ message: string
31047
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31048
+ warning_code: 'being_deleted'
31049
+ }
31050
+ | {
31051
+ /** Date and time at which Seam created the warning. */
31052
+ created_at: string
31053
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31054
+ message: string
31055
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31056
+ warning_code: 'unknown_issue_with_acs_credential'
31057
+ }
31058
+ | {
31059
+ /** Date and time at which Seam created the warning. */
31060
+ created_at: string
31061
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31062
+ message: string
31063
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31064
+ warning_code: 'needs_to_be_reissued'
31065
+ }
31066
+ >
31067
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
31068
+ is_multi_phone_sync_credential?: boolean | undefined
31069
+ /** 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. */
31070
+ is_latest_desired_state_synced_with_provider?:
31071
+ | (boolean | null)
31072
+ | undefined
31073
+ /** 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. */
31074
+ latest_desired_state_synced_with_provider_at?:
31075
+ | (string | null)
31076
+ | undefined
31077
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31078
+ visionline_metadata?:
31079
+ | {
31080
+ card_function_type: 'guest' | 'staff'
31081
+ joiner_acs_credential_ids?: string[] | undefined
31082
+ guest_acs_entrance_ids?: string[] | undefined
31083
+ common_acs_entrance_ids?: string[] | undefined
31084
+ is_valid?: boolean | undefined
31085
+ auto_join?: boolean | undefined
31086
+ card_id?: string | undefined
31087
+ credential_id?: string | undefined
31088
+ }
31089
+ | undefined
31090
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31091
+ assa_abloy_vostio_metadata?:
31092
+ | {
31093
+ override_guest_acs_entrance_ids?:
31094
+ | string[]
31095
+ | undefined
31096
+ key_id?: string | undefined
31097
+ key_issuing_request_id?: string | undefined
31098
+ door_names?: string[] | undefined
31099
+ endpoint_id?: string | undefined
31100
+ }
31101
+ | undefined
31102
+ is_managed: false
31103
+ }
31104
+ )
31105
+ | null
31106
+ warnings: Array<{
31107
+ warning_code:
31108
+ | 'acs_credential_on_encoder_out_of_sync'
31109
+ | 'acs_credential_on_seam_not_found'
31110
+ warning_message: string
31111
+ }>
31112
+ }
31113
+ }
31114
+ | {
31115
+ /** ID of the action attempt. */
31116
+ action_attempt_id: string
31117
+ status: 'error'
31118
+ /** Result of the action attempt. Null for failed action attempts. */
31119
+ result: null
31120
+ action_type: 'SCAN_CREDENTIAL'
31121
+ error:
31122
+ | {
31123
+ /** Type of the error associated with the action attempt. */
31124
+ type: 'uncategorized_error'
31125
+ /** Message for the error associated with the action attempt. */
31126
+ message: string
31127
+ }
31128
+ | {
31129
+ /** Type of the error associated with the action attempt. */
31130
+ type: 'action_attempt_expired'
31131
+ /** Message for the error associated with the action attempt. */
31132
+ message: string
31133
+ }
31134
+ | {
31135
+ type: 'no_credential_on_encoder'
31136
+ message: string
31137
+ }
31138
+ }
31139
+ | {
31140
+ /** ID of the action attempt. */
31141
+ action_attempt_id: string
31142
+ status: 'pending'
31143
+ /** Result of the action attempt. Null for pending action attempts. */
31144
+ result: null
31145
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31146
+ error: null
31147
+ /** Type of action that the action attempt tracks. */
31148
+ action_type: 'ENCODE_CREDENTIAL'
31149
+ }
31150
+ | {
31151
+ /** ID of the action attempt. */
31152
+ action_attempt_id: string
31153
+ status: 'success'
31154
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31155
+ error: null
31156
+ /** Type of action that the action attempt tracks. */
31157
+ action_type: 'ENCODE_CREDENTIAL'
31158
+ /** If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card. */
31159
+ result:
31160
+ | {
31161
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31162
+ acs_credential_id: string
31163
+ /** 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. */
31164
+ acs_user_id?: string | undefined
31165
+ acs_credential_pool_id?: string | undefined
31166
+ /** 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). */
31167
+ acs_system_id: string
31168
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31169
+ parent_acs_credential_id?: string | undefined
31170
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
31171
+ display_name: string
31172
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31173
+ code?: (string | undefined) | null
31174
+ /** 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. */
31175
+ is_one_time_use?: boolean | undefined
31176
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31177
+ card_number?: (string | undefined) | null
31178
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
31179
+ is_issued?: boolean | undefined
31180
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
31181
+ issued_at?: (string | undefined) | null
31182
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
31183
+ access_method: 'code' | 'card' | 'mobile_key'
31184
+ /** 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`. */
31185
+ external_type?:
31186
+ | (
31187
+ | 'pti_card'
31188
+ | 'brivo_credential'
31189
+ | 'hid_credential'
31190
+ | 'visionline_card'
31191
+ | 'salto_ks_credential'
31192
+ | 'assa_abloy_vostio_key'
31193
+ | 'salto_space_key'
31194
+ )
31195
+ | undefined
31196
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
31197
+ external_type_display_name?: string | undefined
31198
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
31199
+ created_at: string
31200
+ /** 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). */
31201
+ workspace_id: string
31202
+ /** 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. */
31203
+ starts_at?: string | undefined
31204
+ /** 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`. */
31205
+ ends_at?: string | undefined
31206
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31207
+ errors: Array<{
31208
+ error_code: string
31209
+ message: string
31210
+ }>
31211
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31212
+ warnings: Array<
31213
+ | {
31214
+ /** Date and time at which Seam created the warning. */
31215
+ created_at: string
31216
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31217
+ message: string
31218
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31219
+ warning_code: 'waiting_to_be_issued'
31220
+ }
31221
+ | {
31222
+ /** Date and time at which Seam created the warning. */
31223
+ created_at: string
31224
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31225
+ message: string
31226
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31227
+ warning_code: 'schedule_externally_modified'
31228
+ }
31229
+ | {
31230
+ /** Date and time at which Seam created the warning. */
31231
+ created_at: string
31232
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31233
+ message: string
31234
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31235
+ warning_code: 'schedule_modified'
31236
+ }
31237
+ | {
31238
+ /** Date and time at which Seam created the warning. */
31239
+ created_at: string
31240
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31241
+ message: string
31242
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31243
+ warning_code: 'being_deleted'
31244
+ }
31245
+ | {
31246
+ /** Date and time at which Seam created the warning. */
31247
+ created_at: string
31248
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31249
+ message: string
31250
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31251
+ warning_code: 'unknown_issue_with_acs_credential'
31252
+ }
31253
+ | {
31254
+ /** Date and time at which Seam created the warning. */
31255
+ created_at: string
31256
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31257
+ message: string
31258
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31259
+ warning_code: 'needs_to_be_reissued'
31260
+ }
31261
+ >
31262
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
31263
+ is_multi_phone_sync_credential?: boolean | undefined
31264
+ /** 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. */
31265
+ is_latest_desired_state_synced_with_provider?:
31266
+ | (boolean | null)
31267
+ | undefined
31268
+ /** 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. */
31269
+ latest_desired_state_synced_with_provider_at?:
31270
+ | (string | null)
31271
+ | undefined
31272
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31273
+ visionline_metadata?:
31274
+ | {
31275
+ card_function_type: 'guest' | 'staff'
31276
+ joiner_acs_credential_ids?: string[] | undefined
31277
+ guest_acs_entrance_ids?: string[] | undefined
31278
+ common_acs_entrance_ids?: string[] | undefined
31279
+ is_valid?: boolean | undefined
31280
+ auto_join?: boolean | undefined
31281
+ card_id?: string | undefined
31282
+ credential_id?: string | undefined
31283
+ }
31284
+ | undefined
31285
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31286
+ assa_abloy_vostio_metadata?:
31287
+ | {
31288
+ override_guest_acs_entrance_ids?: string[] | undefined
31289
+ key_id?: string | undefined
31290
+ key_issuing_request_id?: string | undefined
31291
+ door_names?: string[] | undefined
31292
+ endpoint_id?: string | undefined
31293
+ }
31294
+ | undefined
31295
+ is_managed: true
31296
+ }
31297
+ | {
31298
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31299
+ acs_credential_id: string
31300
+ /** 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. */
31301
+ acs_user_id?: string | undefined
31302
+ acs_credential_pool_id?: string | undefined
31303
+ /** 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). */
31304
+ acs_system_id: string
31305
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31306
+ parent_acs_credential_id?: string | undefined
31307
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
31308
+ display_name: string
31309
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31310
+ code?: (string | undefined) | null
31311
+ /** 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. */
31312
+ is_one_time_use?: boolean | undefined
31313
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31314
+ card_number?: (string | undefined) | null
31315
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
31316
+ is_issued?: boolean | undefined
31317
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
31318
+ issued_at?: (string | undefined) | null
31319
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
31320
+ access_method: 'code' | 'card' | 'mobile_key'
31321
+ /** 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`. */
31322
+ external_type?:
31323
+ | (
31324
+ | 'pti_card'
31325
+ | 'brivo_credential'
31326
+ | 'hid_credential'
31327
+ | 'visionline_card'
31328
+ | 'salto_ks_credential'
31329
+ | 'assa_abloy_vostio_key'
31330
+ | 'salto_space_key'
31331
+ )
31332
+ | undefined
31333
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
31334
+ external_type_display_name?: string | undefined
31335
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
31336
+ created_at: string
31337
+ /** 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). */
31338
+ workspace_id: string
31339
+ /** 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. */
31340
+ starts_at?: string | undefined
31341
+ /** 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`. */
31342
+ ends_at?: string | undefined
31343
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31344
+ errors: Array<{
31345
+ error_code: string
31346
+ message: string
31347
+ }>
31348
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31349
+ warnings: Array<
31350
+ | {
31351
+ /** Date and time at which Seam created the warning. */
31352
+ created_at: string
31353
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31354
+ message: string
31355
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31356
+ warning_code: 'waiting_to_be_issued'
31357
+ }
31358
+ | {
31359
+ /** Date and time at which Seam created the warning. */
31360
+ created_at: string
31361
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31362
+ message: string
31363
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31364
+ warning_code: 'schedule_externally_modified'
31365
+ }
31366
+ | {
31367
+ /** Date and time at which Seam created the warning. */
31368
+ created_at: string
31369
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31370
+ message: string
31371
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31372
+ warning_code: 'schedule_modified'
31373
+ }
31374
+ | {
31375
+ /** Date and time at which Seam created the warning. */
31376
+ created_at: string
31377
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31378
+ message: string
31379
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31380
+ warning_code: 'being_deleted'
31381
+ }
31382
+ | {
31383
+ /** Date and time at which Seam created the warning. */
31384
+ created_at: string
31385
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31386
+ message: string
31387
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31388
+ warning_code: 'unknown_issue_with_acs_credential'
31389
+ }
31390
+ | {
31391
+ /** Date and time at which Seam created the warning. */
31392
+ created_at: string
31393
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
31394
+ message: string
31395
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
31396
+ warning_code: 'needs_to_be_reissued'
31397
+ }
31398
+ >
31399
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
31400
+ is_multi_phone_sync_credential?: boolean | undefined
31401
+ /** 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. */
31402
+ is_latest_desired_state_synced_with_provider?:
31403
+ | (boolean | null)
31404
+ | undefined
31405
+ /** 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. */
31406
+ latest_desired_state_synced_with_provider_at?:
31407
+ | (string | null)
31408
+ | undefined
31409
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31410
+ visionline_metadata?:
31411
+ | {
31412
+ card_function_type: 'guest' | 'staff'
31413
+ joiner_acs_credential_ids?: string[] | undefined
31414
+ guest_acs_entrance_ids?: string[] | undefined
31415
+ common_acs_entrance_ids?: string[] | undefined
31416
+ is_valid?: boolean | undefined
31417
+ auto_join?: boolean | undefined
31418
+ card_id?: string | undefined
31419
+ credential_id?: string | undefined
31420
+ }
31421
+ | undefined
31422
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31423
+ assa_abloy_vostio_metadata?:
31424
+ | {
31425
+ override_guest_acs_entrance_ids?: string[] | undefined
31426
+ key_id?: string | undefined
31427
+ key_issuing_request_id?: string | undefined
31428
+ door_names?: string[] | undefined
31429
+ endpoint_id?: string | undefined
31430
+ }
31431
+ | undefined
31432
+ is_managed: false
31433
+ }
31434
+ }
31435
+ | {
31436
+ /** ID of the action attempt. */
31437
+ action_attempt_id: string
31438
+ status: 'error'
31439
+ /** Result of the action attempt. Null for failed action attempts. */
31440
+ result: null
31441
+ /** Type of action that the action attempt tracks. */
31442
+ action_type: 'ENCODE_CREDENTIAL'
31443
+ error:
31444
+ | {
31445
+ /** Type of the error associated with the action attempt. */
31446
+ type: 'uncategorized_error'
31447
+ /** Message for the error associated with the action attempt. */
31448
+ message: string
31449
+ }
31450
+ | {
31451
+ /** Type of the error associated with the action attempt. */
31452
+ type: 'action_attempt_expired'
31453
+ /** Message for the error associated with the action attempt. */
31454
+ message: string
31455
+ }
31456
+ | {
31457
+ type: 'no_credential_on_encoder'
31458
+ message: string
31459
+ }
31460
+ | {
31461
+ type: 'incompatible_card_format'
31462
+ message: string
31463
+ }
31464
+ | {
31465
+ type: 'credential_cannot_be_reissued'
31466
+ message: string
31467
+ }
31468
+ }
31469
+ | {
31470
+ /** ID of the action attempt. */
31471
+ action_attempt_id: string
31472
+ status: 'pending'
31473
+ /** Result of the action attempt. Null for pending action attempts. */
31474
+ result: null
31475
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31476
+ error: null
31477
+ action_type: 'RESET_SANDBOX_WORKSPACE'
31478
+ }
31479
+ | {
31480
+ /** ID of the action attempt. */
31481
+ action_attempt_id: string
31482
+ status: 'success'
31483
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31484
+ error: null
31485
+ action_type: 'RESET_SANDBOX_WORKSPACE'
31486
+ result: {}
31487
+ }
31488
+ | {
31489
+ /** ID of the action attempt. */
31490
+ action_attempt_id: string
31491
+ status: 'error'
31492
+ /** Result of the action attempt. Null for failed action attempts. */
31493
+ result: null
31494
+ action_type: 'RESET_SANDBOX_WORKSPACE'
31495
+ error: {
31496
+ type: string
31497
+ message: string
31498
+ }
31499
+ }
31500
+ | {
31501
+ /** ID of the action attempt. */
31502
+ action_attempt_id: string
31503
+ status: 'pending'
31504
+ /** Result of the action attempt. Null for pending action attempts. */
31505
+ result: null
31506
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31507
+ error: null
31508
+ action_type: 'SET_FAN_MODE'
31509
+ }
31510
+ | {
31511
+ /** ID of the action attempt. */
31512
+ action_attempt_id: string
31513
+ status: 'success'
31514
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31515
+ error: null
31516
+ action_type: 'SET_FAN_MODE'
31517
+ result: {}
31518
+ }
31519
+ | {
31520
+ /** ID of the action attempt. */
31521
+ action_attempt_id: string
31522
+ status: 'error'
31523
+ /** Result of the action attempt. Null for failed action attempts. */
31524
+ result: null
31525
+ action_type: 'SET_FAN_MODE'
31526
+ error: {
31527
+ type: string
31528
+ message: string
31529
+ }
31530
+ }
31531
+ | {
31532
+ /** ID of the action attempt. */
31533
+ action_attempt_id: string
31534
+ status: 'pending'
31535
+ /** Result of the action attempt. Null for pending action attempts. */
31536
+ result: null
31537
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31538
+ error: null
31539
+ action_type: 'SET_HVAC_MODE'
31540
+ }
31541
+ | {
31542
+ /** ID of the action attempt. */
31543
+ action_attempt_id: string
31544
+ status: 'success'
31545
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31546
+ error: null
31547
+ action_type: 'SET_HVAC_MODE'
31548
+ result: {}
31549
+ }
31550
+ | {
31551
+ /** ID of the action attempt. */
31552
+ action_attempt_id: string
31553
+ status: 'error'
31554
+ /** Result of the action attempt. Null for failed action attempts. */
31555
+ result: null
31556
+ action_type: 'SET_HVAC_MODE'
31557
+ error: {
31558
+ type: string
31559
+ message: string
31560
+ }
31561
+ }
31562
+ | {
31563
+ /** ID of the action attempt. */
31564
+ action_attempt_id: string
31565
+ status: 'pending'
31566
+ /** Result of the action attempt. Null for pending action attempts. */
31567
+ result: null
31568
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31569
+ error: null
31570
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
31571
+ }
31572
+ | {
31573
+ /** ID of the action attempt. */
31574
+ action_attempt_id: string
31575
+ status: 'success'
31576
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31577
+ error: null
31578
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
31579
+ result: {}
31580
+ }
31581
+ | {
31582
+ /** ID of the action attempt. */
31583
+ action_attempt_id: string
31584
+ status: 'error'
31585
+ /** Result of the action attempt. Null for failed action attempts. */
31586
+ result: null
31587
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
31588
+ error: {
31589
+ type: string
31590
+ message: string
31591
+ }
31592
+ }
31593
+ | {
31594
+ /** ID of the action attempt. */
31595
+ action_attempt_id: string
31596
+ status: 'pending'
31597
+ /** Result of the action attempt. Null for pending action attempts. */
31598
+ result: null
31599
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31600
+ error: null
31601
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
31602
+ }
31603
+ | {
31604
+ /** ID of the action attempt. */
31605
+ action_attempt_id: string
31606
+ status: 'success'
31607
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31608
+ error: null
31609
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
31610
+ result: {}
31611
+ }
31612
+ | {
31613
+ /** ID of the action attempt. */
31614
+ action_attempt_id: string
31615
+ status: 'error'
31616
+ /** Result of the action attempt. Null for failed action attempts. */
31617
+ result: null
31618
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
31619
+ error: {
31620
+ type: string
31621
+ message: string
31622
+ }
31623
+ }
31624
+ | {
31625
+ /** ID of the action attempt. */
31626
+ action_attempt_id: string
31627
+ status: 'pending'
31628
+ /** Result of the action attempt. Null for pending action attempts. */
31629
+ result: null
31630
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31631
+ error: null
31632
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
31633
+ }
31634
+ | {
31635
+ /** ID of the action attempt. */
31636
+ action_attempt_id: string
31637
+ status: 'success'
31638
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31639
+ error: null
31640
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
31641
+ result: {}
31642
+ }
31643
+ | {
31644
+ /** ID of the action attempt. */
31645
+ action_attempt_id: string
31646
+ status: 'error'
31647
+ /** Result of the action attempt. Null for failed action attempts. */
31648
+ result: null
31649
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
31650
+ error: {
31651
+ type: string
31652
+ message: string
31653
+ }
31654
+ }
31655
+ | {
31656
+ /** ID of the action attempt. */
31657
+ action_attempt_id: string
31658
+ status: 'pending'
31659
+ /** Result of the action attempt. Null for pending action attempts. */
31660
+ result: null
31661
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31662
+ error: null
31663
+ action_type: 'SYNC_ACCESS_CODES'
31664
+ }
31665
+ | {
31666
+ /** ID of the action attempt. */
31667
+ action_attempt_id: string
31668
+ status: 'success'
31669
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31670
+ error: null
31671
+ action_type: 'SYNC_ACCESS_CODES'
31672
+ result: {}
31673
+ }
31674
+ | {
31675
+ /** ID of the action attempt. */
31676
+ action_attempt_id: string
31677
+ status: 'error'
31678
+ /** Result of the action attempt. Null for failed action attempts. */
31679
+ result: null
31680
+ action_type: 'SYNC_ACCESS_CODES'
31681
+ error: {
31682
+ type: string
31683
+ message: string
31684
+ }
31685
+ }
31686
+ | {
31687
+ /** ID of the action attempt. */
31688
+ action_attempt_id: string
31689
+ status: 'pending'
31690
+ /** Result of the action attempt. Null for pending action attempts. */
31691
+ result: null
31692
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31693
+ error: null
31694
+ action_type: 'CREATE_ACCESS_CODE'
31695
+ }
31696
+ | {
31697
+ /** ID of the action attempt. */
31698
+ action_attempt_id: string
31699
+ status: 'success'
31700
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31701
+ error: null
31702
+ action_type: 'CREATE_ACCESS_CODE'
31703
+ result: {
31704
+ access_code?: any
31705
+ }
31706
+ }
31707
+ | {
31708
+ /** ID of the action attempt. */
31709
+ action_attempt_id: string
31710
+ status: 'error'
31711
+ /** Result of the action attempt. Null for failed action attempts. */
31712
+ result: null
31713
+ action_type: 'CREATE_ACCESS_CODE'
31714
+ error: {
31715
+ type: string
31716
+ message: string
31717
+ }
31718
+ }
31719
+ | {
31720
+ /** ID of the action attempt. */
31721
+ action_attempt_id: string
31722
+ status: 'pending'
31723
+ /** Result of the action attempt. Null for pending action attempts. */
31724
+ result: null
31725
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31726
+ error: null
31727
+ action_type: 'DELETE_ACCESS_CODE'
31728
+ }
31729
+ | {
31730
+ /** ID of the action attempt. */
31731
+ action_attempt_id: string
31732
+ status: 'success'
31733
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31734
+ error: null
31735
+ action_type: 'DELETE_ACCESS_CODE'
31736
+ result: {}
31737
+ }
31738
+ | {
31739
+ /** ID of the action attempt. */
31740
+ action_attempt_id: string
31741
+ status: 'error'
31742
+ /** Result of the action attempt. Null for failed action attempts. */
31743
+ result: null
31744
+ action_type: 'DELETE_ACCESS_CODE'
31745
+ error: {
31746
+ type: string
31747
+ message: string
31748
+ }
31749
+ }
31750
+ | {
31751
+ /** ID of the action attempt. */
31752
+ action_attempt_id: string
31753
+ status: 'pending'
31754
+ /** Result of the action attempt. Null for pending action attempts. */
31755
+ result: null
31756
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31757
+ error: null
31758
+ action_type: 'UPDATE_ACCESS_CODE'
31759
+ }
31760
+ | {
31761
+ /** ID of the action attempt. */
31762
+ action_attempt_id: string
31763
+ status: 'success'
31764
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31765
+ error: null
31766
+ action_type: 'UPDATE_ACCESS_CODE'
31767
+ result: {
31768
+ access_code?: any
31769
+ }
31770
+ }
31771
+ | {
31772
+ /** ID of the action attempt. */
31773
+ action_attempt_id: string
31774
+ status: 'error'
31775
+ /** Result of the action attempt. Null for failed action attempts. */
31776
+ result: null
31777
+ action_type: 'UPDATE_ACCESS_CODE'
31778
+ error: {
31779
+ type: string
31780
+ message: string
31781
+ }
31782
+ }
31783
+ | {
31784
+ /** ID of the action attempt. */
31785
+ action_attempt_id: string
31786
+ status: 'pending'
31787
+ /** Result of the action attempt. Null for pending action attempts. */
31788
+ result: null
31789
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31790
+ error: null
31791
+ action_type: 'CREATE_NOISE_THRESHOLD'
31792
+ }
31793
+ | {
31794
+ /** ID of the action attempt. */
31795
+ action_attempt_id: string
31796
+ status: 'success'
31797
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31798
+ error: null
31799
+ action_type: 'CREATE_NOISE_THRESHOLD'
31800
+ result: {
31801
+ noise_threshold?: any
31802
+ }
31803
+ }
31804
+ | {
31805
+ /** ID of the action attempt. */
31806
+ action_attempt_id: string
31807
+ status: 'error'
31808
+ /** Result of the action attempt. Null for failed action attempts. */
31809
+ result: null
31810
+ action_type: 'CREATE_NOISE_THRESHOLD'
31811
+ error: {
31812
+ type: string
31813
+ message: string
31814
+ }
31815
+ }
31816
+ | {
31817
+ /** ID of the action attempt. */
31818
+ action_attempt_id: string
31819
+ status: 'pending'
31820
+ /** Result of the action attempt. Null for pending action attempts. */
31821
+ result: null
31822
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31823
+ error: null
31824
+ action_type: 'DELETE_NOISE_THRESHOLD'
31825
+ }
31826
+ | {
31827
+ /** ID of the action attempt. */
31828
+ action_attempt_id: string
31829
+ status: 'success'
31830
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31831
+ error: null
31832
+ action_type: 'DELETE_NOISE_THRESHOLD'
31833
+ result: {}
31834
+ }
31835
+ | {
31836
+ /** ID of the action attempt. */
31837
+ action_attempt_id: string
31838
+ status: 'error'
31839
+ /** Result of the action attempt. Null for failed action attempts. */
31840
+ result: null
31841
+ action_type: 'DELETE_NOISE_THRESHOLD'
31842
+ error: {
31843
+ type: string
31844
+ message: string
31845
+ }
31846
+ }
31847
+ | {
31848
+ /** ID of the action attempt. */
31849
+ action_attempt_id: string
31850
+ status: 'pending'
31851
+ /** Result of the action attempt. Null for pending action attempts. */
31852
+ result: null
31853
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31854
+ error: null
31855
+ action_type: 'UPDATE_NOISE_THRESHOLD'
31856
+ }
31857
+ | {
31858
+ /** ID of the action attempt. */
31859
+ action_attempt_id: string
31860
+ status: 'success'
31861
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31862
+ error: null
31863
+ action_type: 'UPDATE_NOISE_THRESHOLD'
31864
+ result: {
31865
+ noise_threshold?: any
31866
+ }
31867
+ }
31868
+ | {
31869
+ /** ID of the action attempt. */
31870
+ action_attempt_id: string
31871
+ status: 'error'
31872
+ /** Result of the action attempt. Null for failed action attempts. */
31873
+ result: null
31874
+ action_type: 'UPDATE_NOISE_THRESHOLD'
31875
+ error: {
31876
+ type: string
31877
+ message: string
31878
+ }
31879
+ }
30701
31880
  }
30702
31881
  }
30703
31882
  '/locks/simulate/manual_lock_via_keypad': {
@@ -30710,7 +31889,1186 @@ export interface Routes {
30710
31889
  commonParams: {}
30711
31890
  formData: {}
30712
31891
  jsonResponse: {
30713
- action_attempt?: any
31892
+ /** */
31893
+ action_attempt:
31894
+ | {
31895
+ /** ID of the action attempt. */
31896
+ action_attempt_id: string
31897
+ status: 'pending'
31898
+ /** Result of the action attempt. Null for pending action attempts. */
31899
+ result: null
31900
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31901
+ error: null
31902
+ action_type: 'LOCK_DOOR'
31903
+ }
31904
+ | {
31905
+ /** ID of the action attempt. */
31906
+ action_attempt_id: string
31907
+ status: 'success'
31908
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31909
+ error: null
31910
+ action_type: 'LOCK_DOOR'
31911
+ result: {}
31912
+ }
31913
+ | {
31914
+ /** ID of the action attempt. */
31915
+ action_attempt_id: string
31916
+ status: 'error'
31917
+ /** Result of the action attempt. Null for failed action attempts. */
31918
+ result: null
31919
+ action_type: 'LOCK_DOOR'
31920
+ error: {
31921
+ type: string
31922
+ message: string
31923
+ }
31924
+ }
31925
+ | {
31926
+ /** ID of the action attempt. */
31927
+ action_attempt_id: string
31928
+ status: 'pending'
31929
+ /** Result of the action attempt. Null for pending action attempts. */
31930
+ result: null
31931
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31932
+ error: null
31933
+ action_type: 'UNLOCK_DOOR'
31934
+ }
31935
+ | {
31936
+ /** ID of the action attempt. */
31937
+ action_attempt_id: string
31938
+ status: 'success'
31939
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31940
+ error: null
31941
+ action_type: 'UNLOCK_DOOR'
31942
+ result: {}
31943
+ }
31944
+ | {
31945
+ /** ID of the action attempt. */
31946
+ action_attempt_id: string
31947
+ status: 'error'
31948
+ /** Result of the action attempt. Null for failed action attempts. */
31949
+ result: null
31950
+ action_type: 'UNLOCK_DOOR'
31951
+ error: {
31952
+ type: string
31953
+ message: string
31954
+ }
31955
+ }
31956
+ | {
31957
+ /** ID of the action attempt. */
31958
+ action_attempt_id: string
31959
+ status: 'pending'
31960
+ /** Result of the action attempt. Null for pending action attempts. */
31961
+ result: null
31962
+ /** Errors associated with the action attempt. Null for pending action attempts. */
31963
+ error: null
31964
+ action_type: 'SCAN_CREDENTIAL'
31965
+ }
31966
+ | {
31967
+ /** ID of the action attempt. */
31968
+ action_attempt_id: string
31969
+ status: 'success'
31970
+ /** Errors associated with the action attempt. Null for successful action attempts. */
31971
+ error: null
31972
+ action_type: 'SCAN_CREDENTIAL'
31973
+ result: {
31974
+ /** Snapshot of credential data read from physical encoder. */
31975
+ acs_credential_on_encoder: {
31976
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
31977
+ created_at: string | null
31978
+ is_issued: boolean | null
31979
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
31980
+ starts_at: string | null
31981
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
31982
+ ends_at: string | null
31983
+ /** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31984
+ card_number: string | null
31985
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31986
+ visionline_metadata?:
31987
+ | {
31988
+ /** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
31989
+ card_id: string
31990
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
31991
+ cancelled: boolean
31992
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
31993
+ discarded: boolean
31994
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
31995
+ expired: boolean
31996
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
31997
+ overwritten: boolean
31998
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
31999
+ overridden?: boolean | undefined
32000
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
32001
+ pending_auto_update: boolean
32002
+ /** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32003
+ card_format: 'TLCode' | 'rfid48'
32004
+ /** Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32005
+ card_holder?: string | undefined
32006
+ /** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32007
+ number_of_issued_cards: number
32008
+ /** 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). */
32009
+ guest_acs_entrance_ids?: string[] | undefined
32010
+ /** 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). */
32011
+ common_acs_entrance_ids?: string[] | undefined
32012
+ }
32013
+ | undefined
32014
+ } | null
32015
+ /** Matching acs_credential currently encoded on this card. */
32016
+ acs_credential_on_seam:
32017
+ | (
32018
+ | {
32019
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32020
+ acs_credential_id: string
32021
+ /** 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. */
32022
+ acs_user_id?: string | undefined
32023
+ acs_credential_pool_id?: string | undefined
32024
+ /** 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). */
32025
+ acs_system_id: string
32026
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32027
+ parent_acs_credential_id?: string | undefined
32028
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32029
+ display_name: string
32030
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32031
+ code?: (string | undefined) | null
32032
+ /** 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. */
32033
+ is_one_time_use?: boolean | undefined
32034
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32035
+ card_number?: (string | undefined) | null
32036
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
32037
+ is_issued?: boolean | undefined
32038
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
32039
+ issued_at?: (string | undefined) | null
32040
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
32041
+ access_method: 'code' | 'card' | 'mobile_key'
32042
+ /** 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`. */
32043
+ external_type?:
32044
+ | (
32045
+ | 'pti_card'
32046
+ | 'brivo_credential'
32047
+ | 'hid_credential'
32048
+ | 'visionline_card'
32049
+ | 'salto_ks_credential'
32050
+ | 'assa_abloy_vostio_key'
32051
+ | 'salto_space_key'
32052
+ )
32053
+ | undefined
32054
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32055
+ external_type_display_name?: string | undefined
32056
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
32057
+ created_at: string
32058
+ /** 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). */
32059
+ workspace_id: string
32060
+ /** 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. */
32061
+ starts_at?: string | undefined
32062
+ /** 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`. */
32063
+ ends_at?: string | undefined
32064
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32065
+ errors: Array<{
32066
+ error_code: string
32067
+ message: string
32068
+ }>
32069
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32070
+ warnings: Array<
32071
+ | {
32072
+ /** Date and time at which Seam created the warning. */
32073
+ created_at: string
32074
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32075
+ message: string
32076
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32077
+ warning_code: 'waiting_to_be_issued'
32078
+ }
32079
+ | {
32080
+ /** Date and time at which Seam created the warning. */
32081
+ created_at: string
32082
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32083
+ message: string
32084
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32085
+ warning_code: 'schedule_externally_modified'
32086
+ }
32087
+ | {
32088
+ /** Date and time at which Seam created the warning. */
32089
+ created_at: string
32090
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32091
+ message: string
32092
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32093
+ warning_code: 'schedule_modified'
32094
+ }
32095
+ | {
32096
+ /** Date and time at which Seam created the warning. */
32097
+ created_at: string
32098
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32099
+ message: string
32100
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32101
+ warning_code: 'being_deleted'
32102
+ }
32103
+ | {
32104
+ /** Date and time at which Seam created the warning. */
32105
+ created_at: string
32106
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32107
+ message: string
32108
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32109
+ warning_code: 'unknown_issue_with_acs_credential'
32110
+ }
32111
+ | {
32112
+ /** Date and time at which Seam created the warning. */
32113
+ created_at: string
32114
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32115
+ message: string
32116
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32117
+ warning_code: 'needs_to_be_reissued'
32118
+ }
32119
+ >
32120
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
32121
+ is_multi_phone_sync_credential?: boolean | undefined
32122
+ /** 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. */
32123
+ is_latest_desired_state_synced_with_provider?:
32124
+ | (boolean | null)
32125
+ | undefined
32126
+ /** 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. */
32127
+ latest_desired_state_synced_with_provider_at?:
32128
+ | (string | null)
32129
+ | undefined
32130
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32131
+ visionline_metadata?:
32132
+ | {
32133
+ card_function_type: 'guest' | 'staff'
32134
+ joiner_acs_credential_ids?: string[] | undefined
32135
+ guest_acs_entrance_ids?: string[] | undefined
32136
+ common_acs_entrance_ids?: string[] | undefined
32137
+ is_valid?: boolean | undefined
32138
+ auto_join?: boolean | undefined
32139
+ card_id?: string | undefined
32140
+ credential_id?: string | undefined
32141
+ }
32142
+ | undefined
32143
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32144
+ assa_abloy_vostio_metadata?:
32145
+ | {
32146
+ override_guest_acs_entrance_ids?:
32147
+ | string[]
32148
+ | undefined
32149
+ key_id?: string | undefined
32150
+ key_issuing_request_id?: string | undefined
32151
+ door_names?: string[] | undefined
32152
+ endpoint_id?: string | undefined
32153
+ }
32154
+ | undefined
32155
+ is_managed: true
32156
+ }
32157
+ | {
32158
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32159
+ acs_credential_id: string
32160
+ /** 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. */
32161
+ acs_user_id?: string | undefined
32162
+ acs_credential_pool_id?: string | undefined
32163
+ /** 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). */
32164
+ acs_system_id: string
32165
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32166
+ parent_acs_credential_id?: string | undefined
32167
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32168
+ display_name: string
32169
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32170
+ code?: (string | undefined) | null
32171
+ /** 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. */
32172
+ is_one_time_use?: boolean | undefined
32173
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32174
+ card_number?: (string | undefined) | null
32175
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
32176
+ is_issued?: boolean | undefined
32177
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
32178
+ issued_at?: (string | undefined) | null
32179
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
32180
+ access_method: 'code' | 'card' | 'mobile_key'
32181
+ /** 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`. */
32182
+ external_type?:
32183
+ | (
32184
+ | 'pti_card'
32185
+ | 'brivo_credential'
32186
+ | 'hid_credential'
32187
+ | 'visionline_card'
32188
+ | 'salto_ks_credential'
32189
+ | 'assa_abloy_vostio_key'
32190
+ | 'salto_space_key'
32191
+ )
32192
+ | undefined
32193
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32194
+ external_type_display_name?: string | undefined
32195
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
32196
+ created_at: string
32197
+ /** 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). */
32198
+ workspace_id: string
32199
+ /** 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. */
32200
+ starts_at?: string | undefined
32201
+ /** 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`. */
32202
+ ends_at?: string | undefined
32203
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32204
+ errors: Array<{
32205
+ error_code: string
32206
+ message: string
32207
+ }>
32208
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32209
+ warnings: Array<
32210
+ | {
32211
+ /** Date and time at which Seam created the warning. */
32212
+ created_at: string
32213
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32214
+ message: string
32215
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32216
+ warning_code: 'waiting_to_be_issued'
32217
+ }
32218
+ | {
32219
+ /** Date and time at which Seam created the warning. */
32220
+ created_at: string
32221
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32222
+ message: string
32223
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32224
+ warning_code: 'schedule_externally_modified'
32225
+ }
32226
+ | {
32227
+ /** Date and time at which Seam created the warning. */
32228
+ created_at: string
32229
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32230
+ message: string
32231
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32232
+ warning_code: 'schedule_modified'
32233
+ }
32234
+ | {
32235
+ /** Date and time at which Seam created the warning. */
32236
+ created_at: string
32237
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32238
+ message: string
32239
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32240
+ warning_code: 'being_deleted'
32241
+ }
32242
+ | {
32243
+ /** Date and time at which Seam created the warning. */
32244
+ created_at: string
32245
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32246
+ message: string
32247
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32248
+ warning_code: 'unknown_issue_with_acs_credential'
32249
+ }
32250
+ | {
32251
+ /** Date and time at which Seam created the warning. */
32252
+ created_at: string
32253
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32254
+ message: string
32255
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32256
+ warning_code: 'needs_to_be_reissued'
32257
+ }
32258
+ >
32259
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
32260
+ is_multi_phone_sync_credential?: boolean | undefined
32261
+ /** 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. */
32262
+ is_latest_desired_state_synced_with_provider?:
32263
+ | (boolean | null)
32264
+ | undefined
32265
+ /** 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. */
32266
+ latest_desired_state_synced_with_provider_at?:
32267
+ | (string | null)
32268
+ | undefined
32269
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32270
+ visionline_metadata?:
32271
+ | {
32272
+ card_function_type: 'guest' | 'staff'
32273
+ joiner_acs_credential_ids?: string[] | undefined
32274
+ guest_acs_entrance_ids?: string[] | undefined
32275
+ common_acs_entrance_ids?: string[] | undefined
32276
+ is_valid?: boolean | undefined
32277
+ auto_join?: boolean | undefined
32278
+ card_id?: string | undefined
32279
+ credential_id?: string | undefined
32280
+ }
32281
+ | undefined
32282
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32283
+ assa_abloy_vostio_metadata?:
32284
+ | {
32285
+ override_guest_acs_entrance_ids?:
32286
+ | string[]
32287
+ | undefined
32288
+ key_id?: string | undefined
32289
+ key_issuing_request_id?: string | undefined
32290
+ door_names?: string[] | undefined
32291
+ endpoint_id?: string | undefined
32292
+ }
32293
+ | undefined
32294
+ is_managed: false
32295
+ }
32296
+ )
32297
+ | null
32298
+ warnings: Array<{
32299
+ warning_code:
32300
+ | 'acs_credential_on_encoder_out_of_sync'
32301
+ | 'acs_credential_on_seam_not_found'
32302
+ warning_message: string
32303
+ }>
32304
+ }
32305
+ }
32306
+ | {
32307
+ /** ID of the action attempt. */
32308
+ action_attempt_id: string
32309
+ status: 'error'
32310
+ /** Result of the action attempt. Null for failed action attempts. */
32311
+ result: null
32312
+ action_type: 'SCAN_CREDENTIAL'
32313
+ error:
32314
+ | {
32315
+ /** Type of the error associated with the action attempt. */
32316
+ type: 'uncategorized_error'
32317
+ /** Message for the error associated with the action attempt. */
32318
+ message: string
32319
+ }
32320
+ | {
32321
+ /** Type of the error associated with the action attempt. */
32322
+ type: 'action_attempt_expired'
32323
+ /** Message for the error associated with the action attempt. */
32324
+ message: string
32325
+ }
32326
+ | {
32327
+ type: 'no_credential_on_encoder'
32328
+ message: string
32329
+ }
32330
+ }
32331
+ | {
32332
+ /** ID of the action attempt. */
32333
+ action_attempt_id: string
32334
+ status: 'pending'
32335
+ /** Result of the action attempt. Null for pending action attempts. */
32336
+ result: null
32337
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32338
+ error: null
32339
+ /** Type of action that the action attempt tracks. */
32340
+ action_type: 'ENCODE_CREDENTIAL'
32341
+ }
32342
+ | {
32343
+ /** ID of the action attempt. */
32344
+ action_attempt_id: string
32345
+ status: 'success'
32346
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32347
+ error: null
32348
+ /** Type of action that the action attempt tracks. */
32349
+ action_type: 'ENCODE_CREDENTIAL'
32350
+ /** If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card. */
32351
+ result:
32352
+ | {
32353
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32354
+ acs_credential_id: string
32355
+ /** 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. */
32356
+ acs_user_id?: string | undefined
32357
+ acs_credential_pool_id?: string | undefined
32358
+ /** 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). */
32359
+ acs_system_id: string
32360
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32361
+ parent_acs_credential_id?: string | undefined
32362
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32363
+ display_name: string
32364
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32365
+ code?: (string | undefined) | null
32366
+ /** 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. */
32367
+ is_one_time_use?: boolean | undefined
32368
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32369
+ card_number?: (string | undefined) | null
32370
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
32371
+ is_issued?: boolean | undefined
32372
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
32373
+ issued_at?: (string | undefined) | null
32374
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
32375
+ access_method: 'code' | 'card' | 'mobile_key'
32376
+ /** 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`. */
32377
+ external_type?:
32378
+ | (
32379
+ | 'pti_card'
32380
+ | 'brivo_credential'
32381
+ | 'hid_credential'
32382
+ | 'visionline_card'
32383
+ | 'salto_ks_credential'
32384
+ | 'assa_abloy_vostio_key'
32385
+ | 'salto_space_key'
32386
+ )
32387
+ | undefined
32388
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32389
+ external_type_display_name?: string | undefined
32390
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
32391
+ created_at: string
32392
+ /** 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). */
32393
+ workspace_id: string
32394
+ /** 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. */
32395
+ starts_at?: string | undefined
32396
+ /** 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`. */
32397
+ ends_at?: string | undefined
32398
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32399
+ errors: Array<{
32400
+ error_code: string
32401
+ message: string
32402
+ }>
32403
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32404
+ warnings: Array<
32405
+ | {
32406
+ /** Date and time at which Seam created the warning. */
32407
+ created_at: string
32408
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32409
+ message: string
32410
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32411
+ warning_code: 'waiting_to_be_issued'
32412
+ }
32413
+ | {
32414
+ /** Date and time at which Seam created the warning. */
32415
+ created_at: string
32416
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32417
+ message: string
32418
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32419
+ warning_code: 'schedule_externally_modified'
32420
+ }
32421
+ | {
32422
+ /** Date and time at which Seam created the warning. */
32423
+ created_at: string
32424
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32425
+ message: string
32426
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32427
+ warning_code: 'schedule_modified'
32428
+ }
32429
+ | {
32430
+ /** Date and time at which Seam created the warning. */
32431
+ created_at: string
32432
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32433
+ message: string
32434
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32435
+ warning_code: 'being_deleted'
32436
+ }
32437
+ | {
32438
+ /** Date and time at which Seam created the warning. */
32439
+ created_at: string
32440
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32441
+ message: string
32442
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32443
+ warning_code: 'unknown_issue_with_acs_credential'
32444
+ }
32445
+ | {
32446
+ /** Date and time at which Seam created the warning. */
32447
+ created_at: string
32448
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32449
+ message: string
32450
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32451
+ warning_code: 'needs_to_be_reissued'
32452
+ }
32453
+ >
32454
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
32455
+ is_multi_phone_sync_credential?: boolean | undefined
32456
+ /** 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. */
32457
+ is_latest_desired_state_synced_with_provider?:
32458
+ | (boolean | null)
32459
+ | undefined
32460
+ /** 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. */
32461
+ latest_desired_state_synced_with_provider_at?:
32462
+ | (string | null)
32463
+ | undefined
32464
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32465
+ visionline_metadata?:
32466
+ | {
32467
+ card_function_type: 'guest' | 'staff'
32468
+ joiner_acs_credential_ids?: string[] | undefined
32469
+ guest_acs_entrance_ids?: string[] | undefined
32470
+ common_acs_entrance_ids?: string[] | undefined
32471
+ is_valid?: boolean | undefined
32472
+ auto_join?: boolean | undefined
32473
+ card_id?: string | undefined
32474
+ credential_id?: string | undefined
32475
+ }
32476
+ | undefined
32477
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32478
+ assa_abloy_vostio_metadata?:
32479
+ | {
32480
+ override_guest_acs_entrance_ids?: string[] | undefined
32481
+ key_id?: string | undefined
32482
+ key_issuing_request_id?: string | undefined
32483
+ door_names?: string[] | undefined
32484
+ endpoint_id?: string | undefined
32485
+ }
32486
+ | undefined
32487
+ is_managed: true
32488
+ }
32489
+ | {
32490
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32491
+ acs_credential_id: string
32492
+ /** 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. */
32493
+ acs_user_id?: string | undefined
32494
+ acs_credential_pool_id?: string | undefined
32495
+ /** 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). */
32496
+ acs_system_id: string
32497
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32498
+ parent_acs_credential_id?: string | undefined
32499
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32500
+ display_name: string
32501
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32502
+ code?: (string | undefined) | null
32503
+ /** 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. */
32504
+ is_one_time_use?: boolean | undefined
32505
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32506
+ card_number?: (string | undefined) | null
32507
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
32508
+ is_issued?: boolean | undefined
32509
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
32510
+ issued_at?: (string | undefined) | null
32511
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
32512
+ access_method: 'code' | 'card' | 'mobile_key'
32513
+ /** 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`. */
32514
+ external_type?:
32515
+ | (
32516
+ | 'pti_card'
32517
+ | 'brivo_credential'
32518
+ | 'hid_credential'
32519
+ | 'visionline_card'
32520
+ | 'salto_ks_credential'
32521
+ | 'assa_abloy_vostio_key'
32522
+ | 'salto_space_key'
32523
+ )
32524
+ | undefined
32525
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
32526
+ external_type_display_name?: string | undefined
32527
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
32528
+ created_at: string
32529
+ /** 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). */
32530
+ workspace_id: string
32531
+ /** 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. */
32532
+ starts_at?: string | undefined
32533
+ /** 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`. */
32534
+ ends_at?: string | undefined
32535
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32536
+ errors: Array<{
32537
+ error_code: string
32538
+ message: string
32539
+ }>
32540
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32541
+ warnings: Array<
32542
+ | {
32543
+ /** Date and time at which Seam created the warning. */
32544
+ created_at: string
32545
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32546
+ message: string
32547
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32548
+ warning_code: 'waiting_to_be_issued'
32549
+ }
32550
+ | {
32551
+ /** Date and time at which Seam created the warning. */
32552
+ created_at: string
32553
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32554
+ message: string
32555
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32556
+ warning_code: 'schedule_externally_modified'
32557
+ }
32558
+ | {
32559
+ /** Date and time at which Seam created the warning. */
32560
+ created_at: string
32561
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32562
+ message: string
32563
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32564
+ warning_code: 'schedule_modified'
32565
+ }
32566
+ | {
32567
+ /** Date and time at which Seam created the warning. */
32568
+ created_at: string
32569
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32570
+ message: string
32571
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32572
+ warning_code: 'being_deleted'
32573
+ }
32574
+ | {
32575
+ /** Date and time at which Seam created the warning. */
32576
+ created_at: string
32577
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32578
+ message: string
32579
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32580
+ warning_code: 'unknown_issue_with_acs_credential'
32581
+ }
32582
+ | {
32583
+ /** Date and time at which Seam created the warning. */
32584
+ created_at: string
32585
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
32586
+ message: string
32587
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
32588
+ warning_code: 'needs_to_be_reissued'
32589
+ }
32590
+ >
32591
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
32592
+ is_multi_phone_sync_credential?: boolean | undefined
32593
+ /** 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. */
32594
+ is_latest_desired_state_synced_with_provider?:
32595
+ | (boolean | null)
32596
+ | undefined
32597
+ /** 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. */
32598
+ latest_desired_state_synced_with_provider_at?:
32599
+ | (string | null)
32600
+ | undefined
32601
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32602
+ visionline_metadata?:
32603
+ | {
32604
+ card_function_type: 'guest' | 'staff'
32605
+ joiner_acs_credential_ids?: string[] | undefined
32606
+ guest_acs_entrance_ids?: string[] | undefined
32607
+ common_acs_entrance_ids?: string[] | undefined
32608
+ is_valid?: boolean | undefined
32609
+ auto_join?: boolean | undefined
32610
+ card_id?: string | undefined
32611
+ credential_id?: string | undefined
32612
+ }
32613
+ | undefined
32614
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
32615
+ assa_abloy_vostio_metadata?:
32616
+ | {
32617
+ override_guest_acs_entrance_ids?: string[] | undefined
32618
+ key_id?: string | undefined
32619
+ key_issuing_request_id?: string | undefined
32620
+ door_names?: string[] | undefined
32621
+ endpoint_id?: string | undefined
32622
+ }
32623
+ | undefined
32624
+ is_managed: false
32625
+ }
32626
+ }
32627
+ | {
32628
+ /** ID of the action attempt. */
32629
+ action_attempt_id: string
32630
+ status: 'error'
32631
+ /** Result of the action attempt. Null for failed action attempts. */
32632
+ result: null
32633
+ /** Type of action that the action attempt tracks. */
32634
+ action_type: 'ENCODE_CREDENTIAL'
32635
+ error:
32636
+ | {
32637
+ /** Type of the error associated with the action attempt. */
32638
+ type: 'uncategorized_error'
32639
+ /** Message for the error associated with the action attempt. */
32640
+ message: string
32641
+ }
32642
+ | {
32643
+ /** Type of the error associated with the action attempt. */
32644
+ type: 'action_attempt_expired'
32645
+ /** Message for the error associated with the action attempt. */
32646
+ message: string
32647
+ }
32648
+ | {
32649
+ type: 'no_credential_on_encoder'
32650
+ message: string
32651
+ }
32652
+ | {
32653
+ type: 'incompatible_card_format'
32654
+ message: string
32655
+ }
32656
+ | {
32657
+ type: 'credential_cannot_be_reissued'
32658
+ message: string
32659
+ }
32660
+ }
32661
+ | {
32662
+ /** ID of the action attempt. */
32663
+ action_attempt_id: string
32664
+ status: 'pending'
32665
+ /** Result of the action attempt. Null for pending action attempts. */
32666
+ result: null
32667
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32668
+ error: null
32669
+ action_type: 'RESET_SANDBOX_WORKSPACE'
32670
+ }
32671
+ | {
32672
+ /** ID of the action attempt. */
32673
+ action_attempt_id: string
32674
+ status: 'success'
32675
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32676
+ error: null
32677
+ action_type: 'RESET_SANDBOX_WORKSPACE'
32678
+ result: {}
32679
+ }
32680
+ | {
32681
+ /** ID of the action attempt. */
32682
+ action_attempt_id: string
32683
+ status: 'error'
32684
+ /** Result of the action attempt. Null for failed action attempts. */
32685
+ result: null
32686
+ action_type: 'RESET_SANDBOX_WORKSPACE'
32687
+ error: {
32688
+ type: string
32689
+ message: string
32690
+ }
32691
+ }
32692
+ | {
32693
+ /** ID of the action attempt. */
32694
+ action_attempt_id: string
32695
+ status: 'pending'
32696
+ /** Result of the action attempt. Null for pending action attempts. */
32697
+ result: null
32698
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32699
+ error: null
32700
+ action_type: 'SET_FAN_MODE'
32701
+ }
32702
+ | {
32703
+ /** ID of the action attempt. */
32704
+ action_attempt_id: string
32705
+ status: 'success'
32706
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32707
+ error: null
32708
+ action_type: 'SET_FAN_MODE'
32709
+ result: {}
32710
+ }
32711
+ | {
32712
+ /** ID of the action attempt. */
32713
+ action_attempt_id: string
32714
+ status: 'error'
32715
+ /** Result of the action attempt. Null for failed action attempts. */
32716
+ result: null
32717
+ action_type: 'SET_FAN_MODE'
32718
+ error: {
32719
+ type: string
32720
+ message: string
32721
+ }
32722
+ }
32723
+ | {
32724
+ /** ID of the action attempt. */
32725
+ action_attempt_id: string
32726
+ status: 'pending'
32727
+ /** Result of the action attempt. Null for pending action attempts. */
32728
+ result: null
32729
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32730
+ error: null
32731
+ action_type: 'SET_HVAC_MODE'
32732
+ }
32733
+ | {
32734
+ /** ID of the action attempt. */
32735
+ action_attempt_id: string
32736
+ status: 'success'
32737
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32738
+ error: null
32739
+ action_type: 'SET_HVAC_MODE'
32740
+ result: {}
32741
+ }
32742
+ | {
32743
+ /** ID of the action attempt. */
32744
+ action_attempt_id: string
32745
+ status: 'error'
32746
+ /** Result of the action attempt. Null for failed action attempts. */
32747
+ result: null
32748
+ action_type: 'SET_HVAC_MODE'
32749
+ error: {
32750
+ type: string
32751
+ message: string
32752
+ }
32753
+ }
32754
+ | {
32755
+ /** ID of the action attempt. */
32756
+ action_attempt_id: string
32757
+ status: 'pending'
32758
+ /** Result of the action attempt. Null for pending action attempts. */
32759
+ result: null
32760
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32761
+ error: null
32762
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
32763
+ }
32764
+ | {
32765
+ /** ID of the action attempt. */
32766
+ action_attempt_id: string
32767
+ status: 'success'
32768
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32769
+ error: null
32770
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
32771
+ result: {}
32772
+ }
32773
+ | {
32774
+ /** ID of the action attempt. */
32775
+ action_attempt_id: string
32776
+ status: 'error'
32777
+ /** Result of the action attempt. Null for failed action attempts. */
32778
+ result: null
32779
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
32780
+ error: {
32781
+ type: string
32782
+ message: string
32783
+ }
32784
+ }
32785
+ | {
32786
+ /** ID of the action attempt. */
32787
+ action_attempt_id: string
32788
+ status: 'pending'
32789
+ /** Result of the action attempt. Null for pending action attempts. */
32790
+ result: null
32791
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32792
+ error: null
32793
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
32794
+ }
32795
+ | {
32796
+ /** ID of the action attempt. */
32797
+ action_attempt_id: string
32798
+ status: 'success'
32799
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32800
+ error: null
32801
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
32802
+ result: {}
32803
+ }
32804
+ | {
32805
+ /** ID of the action attempt. */
32806
+ action_attempt_id: string
32807
+ status: 'error'
32808
+ /** Result of the action attempt. Null for failed action attempts. */
32809
+ result: null
32810
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
32811
+ error: {
32812
+ type: string
32813
+ message: string
32814
+ }
32815
+ }
32816
+ | {
32817
+ /** ID of the action attempt. */
32818
+ action_attempt_id: string
32819
+ status: 'pending'
32820
+ /** Result of the action attempt. Null for pending action attempts. */
32821
+ result: null
32822
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32823
+ error: null
32824
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
32825
+ }
32826
+ | {
32827
+ /** ID of the action attempt. */
32828
+ action_attempt_id: string
32829
+ status: 'success'
32830
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32831
+ error: null
32832
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
32833
+ result: {}
32834
+ }
32835
+ | {
32836
+ /** ID of the action attempt. */
32837
+ action_attempt_id: string
32838
+ status: 'error'
32839
+ /** Result of the action attempt. Null for failed action attempts. */
32840
+ result: null
32841
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
32842
+ error: {
32843
+ type: string
32844
+ message: string
32845
+ }
32846
+ }
32847
+ | {
32848
+ /** ID of the action attempt. */
32849
+ action_attempt_id: string
32850
+ status: 'pending'
32851
+ /** Result of the action attempt. Null for pending action attempts. */
32852
+ result: null
32853
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32854
+ error: null
32855
+ action_type: 'SYNC_ACCESS_CODES'
32856
+ }
32857
+ | {
32858
+ /** ID of the action attempt. */
32859
+ action_attempt_id: string
32860
+ status: 'success'
32861
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32862
+ error: null
32863
+ action_type: 'SYNC_ACCESS_CODES'
32864
+ result: {}
32865
+ }
32866
+ | {
32867
+ /** ID of the action attempt. */
32868
+ action_attempt_id: string
32869
+ status: 'error'
32870
+ /** Result of the action attempt. Null for failed action attempts. */
32871
+ result: null
32872
+ action_type: 'SYNC_ACCESS_CODES'
32873
+ error: {
32874
+ type: string
32875
+ message: string
32876
+ }
32877
+ }
32878
+ | {
32879
+ /** ID of the action attempt. */
32880
+ action_attempt_id: string
32881
+ status: 'pending'
32882
+ /** Result of the action attempt. Null for pending action attempts. */
32883
+ result: null
32884
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32885
+ error: null
32886
+ action_type: 'CREATE_ACCESS_CODE'
32887
+ }
32888
+ | {
32889
+ /** ID of the action attempt. */
32890
+ action_attempt_id: string
32891
+ status: 'success'
32892
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32893
+ error: null
32894
+ action_type: 'CREATE_ACCESS_CODE'
32895
+ result: {
32896
+ access_code?: any
32897
+ }
32898
+ }
32899
+ | {
32900
+ /** ID of the action attempt. */
32901
+ action_attempt_id: string
32902
+ status: 'error'
32903
+ /** Result of the action attempt. Null for failed action attempts. */
32904
+ result: null
32905
+ action_type: 'CREATE_ACCESS_CODE'
32906
+ error: {
32907
+ type: string
32908
+ message: string
32909
+ }
32910
+ }
32911
+ | {
32912
+ /** ID of the action attempt. */
32913
+ action_attempt_id: string
32914
+ status: 'pending'
32915
+ /** Result of the action attempt. Null for pending action attempts. */
32916
+ result: null
32917
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32918
+ error: null
32919
+ action_type: 'DELETE_ACCESS_CODE'
32920
+ }
32921
+ | {
32922
+ /** ID of the action attempt. */
32923
+ action_attempt_id: string
32924
+ status: 'success'
32925
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32926
+ error: null
32927
+ action_type: 'DELETE_ACCESS_CODE'
32928
+ result: {}
32929
+ }
32930
+ | {
32931
+ /** ID of the action attempt. */
32932
+ action_attempt_id: string
32933
+ status: 'error'
32934
+ /** Result of the action attempt. Null for failed action attempts. */
32935
+ result: null
32936
+ action_type: 'DELETE_ACCESS_CODE'
32937
+ error: {
32938
+ type: string
32939
+ message: string
32940
+ }
32941
+ }
32942
+ | {
32943
+ /** ID of the action attempt. */
32944
+ action_attempt_id: string
32945
+ status: 'pending'
32946
+ /** Result of the action attempt. Null for pending action attempts. */
32947
+ result: null
32948
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32949
+ error: null
32950
+ action_type: 'UPDATE_ACCESS_CODE'
32951
+ }
32952
+ | {
32953
+ /** ID of the action attempt. */
32954
+ action_attempt_id: string
32955
+ status: 'success'
32956
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32957
+ error: null
32958
+ action_type: 'UPDATE_ACCESS_CODE'
32959
+ result: {
32960
+ access_code?: any
32961
+ }
32962
+ }
32963
+ | {
32964
+ /** ID of the action attempt. */
32965
+ action_attempt_id: string
32966
+ status: 'error'
32967
+ /** Result of the action attempt. Null for failed action attempts. */
32968
+ result: null
32969
+ action_type: 'UPDATE_ACCESS_CODE'
32970
+ error: {
32971
+ type: string
32972
+ message: string
32973
+ }
32974
+ }
32975
+ | {
32976
+ /** ID of the action attempt. */
32977
+ action_attempt_id: string
32978
+ status: 'pending'
32979
+ /** Result of the action attempt. Null for pending action attempts. */
32980
+ result: null
32981
+ /** Errors associated with the action attempt. Null for pending action attempts. */
32982
+ error: null
32983
+ action_type: 'CREATE_NOISE_THRESHOLD'
32984
+ }
32985
+ | {
32986
+ /** ID of the action attempt. */
32987
+ action_attempt_id: string
32988
+ status: 'success'
32989
+ /** Errors associated with the action attempt. Null for successful action attempts. */
32990
+ error: null
32991
+ action_type: 'CREATE_NOISE_THRESHOLD'
32992
+ result: {
32993
+ noise_threshold?: any
32994
+ }
32995
+ }
32996
+ | {
32997
+ /** ID of the action attempt. */
32998
+ action_attempt_id: string
32999
+ status: 'error'
33000
+ /** Result of the action attempt. Null for failed action attempts. */
33001
+ result: null
33002
+ action_type: 'CREATE_NOISE_THRESHOLD'
33003
+ error: {
33004
+ type: string
33005
+ message: string
33006
+ }
33007
+ }
33008
+ | {
33009
+ /** ID of the action attempt. */
33010
+ action_attempt_id: string
33011
+ status: 'pending'
33012
+ /** Result of the action attempt. Null for pending action attempts. */
33013
+ result: null
33014
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33015
+ error: null
33016
+ action_type: 'DELETE_NOISE_THRESHOLD'
33017
+ }
33018
+ | {
33019
+ /** ID of the action attempt. */
33020
+ action_attempt_id: string
33021
+ status: 'success'
33022
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33023
+ error: null
33024
+ action_type: 'DELETE_NOISE_THRESHOLD'
33025
+ result: {}
33026
+ }
33027
+ | {
33028
+ /** ID of the action attempt. */
33029
+ action_attempt_id: string
33030
+ status: 'error'
33031
+ /** Result of the action attempt. Null for failed action attempts. */
33032
+ result: null
33033
+ action_type: 'DELETE_NOISE_THRESHOLD'
33034
+ error: {
33035
+ type: string
33036
+ message: string
33037
+ }
33038
+ }
33039
+ | {
33040
+ /** ID of the action attempt. */
33041
+ action_attempt_id: string
33042
+ status: 'pending'
33043
+ /** Result of the action attempt. Null for pending action attempts. */
33044
+ result: null
33045
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33046
+ error: null
33047
+ action_type: 'UPDATE_NOISE_THRESHOLD'
33048
+ }
33049
+ | {
33050
+ /** ID of the action attempt. */
33051
+ action_attempt_id: string
33052
+ status: 'success'
33053
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33054
+ error: null
33055
+ action_type: 'UPDATE_NOISE_THRESHOLD'
33056
+ result: {
33057
+ noise_threshold?: any
33058
+ }
33059
+ }
33060
+ | {
33061
+ /** ID of the action attempt. */
33062
+ action_attempt_id: string
33063
+ status: 'error'
33064
+ /** Result of the action attempt. Null for failed action attempts. */
33065
+ result: null
33066
+ action_type: 'UPDATE_NOISE_THRESHOLD'
33067
+ error: {
33068
+ type: string
33069
+ message: string
33070
+ }
33071
+ }
30714
33072
  }
30715
33073
  }
30716
33074
  '/locks/unlock_door': {
@@ -50181,6 +52539,8 @@ export interface Routes {
50181
52539
  commonParams: {
50182
52540
  /** ID of the user identity for which you want to generate an instant key. */
50183
52541
  user_identity_id: string
52542
+ /** The maximum number of times the instant key can be used. Defaults to 1. */
52543
+ max_use_count?: number
50184
52544
  }
50185
52545
  formData: {}
50186
52546
  jsonResponse: {
@@ -52661,10 +55021,26 @@ export interface Routes {
52661
55021
  * @deprecated use company_name */
52662
55022
  connect_partner_name?: ((string | null) | null) | undefined
52663
55023
  is_sandbox?: boolean
55024
+ /**
55025
+ * @deprecated Use `connect_webview_customization.webview_primary_button_color` instead. */
52664
55026
  webview_primary_button_color?: string | undefined
55027
+ /**
55028
+ * @deprecated Use `connect_webview_customization.webview_primary_button_text_color` instead. */
52665
55029
  webview_primary_button_text_color?: string | undefined
55030
+ /**
55031
+ * @deprecated Use `connect_webview_customization.webview_logo_shape` instead. */
52666
55032
  webview_logo_shape?: ('circle' | 'square') | undefined
55033
+ /**
55034
+ * @deprecated Use `connect_webview_customization.webview_success_message` instead. */
52667
55035
  webview_success_message?: string | undefined
55036
+ connect_webview_customization?:
55037
+ | {
55038
+ primary_button_color?: (string | null) | undefined
55039
+ primary_button_text_color?: (string | null) | undefined
55040
+ success_message?: (string | null) | undefined
55041
+ logo_shape?: (('circle' | 'square') | null) | undefined
55042
+ }
55043
+ | undefined
52668
55044
  }
52669
55045
  commonParams: {}
52670
55046
  formData: {}
@@ -52675,6 +55051,13 @@ export interface Routes {
52675
55051
  name: string
52676
55052
  company_name: string
52677
55053
  is_sandbox: boolean
55054
+ connect_webview_customization: {
55055
+ primary_button_color?: string | undefined
55056
+ primary_button_text_color?: string | undefined
55057
+ success_message?: string | undefined
55058
+ logo_shape?: ('circle' | 'square') | undefined
55059
+ inviter_logo_url?: string | undefined
55060
+ }
52678
55061
  /** True if a sandbox workspace has not been accessed in 14 days */
52679
55062
  is_suspended: boolean
52680
55063
  /**
@@ -52697,6 +55080,13 @@ export interface Routes {
52697
55080
  name: string
52698
55081
  company_name: string
52699
55082
  is_sandbox: boolean
55083
+ connect_webview_customization: {
55084
+ primary_button_color?: string | undefined
55085
+ primary_button_text_color?: string | undefined
55086
+ success_message?: string | undefined
55087
+ logo_shape?: ('circle' | 'square') | undefined
55088
+ inviter_logo_url?: string | undefined
55089
+ }
52700
55090
  /** True if a sandbox workspace has not been accessed in 14 days */
52701
55091
  is_suspended: boolean
52702
55092
  /**
@@ -52718,6 +55108,13 @@ export interface Routes {
52718
55108
  name: string
52719
55109
  company_name: string
52720
55110
  is_sandbox: boolean
55111
+ connect_webview_customization: {
55112
+ primary_button_color?: string | undefined
55113
+ primary_button_text_color?: string | undefined
55114
+ success_message?: string | undefined
55115
+ logo_shape?: ('circle' | 'square') | undefined
55116
+ inviter_logo_url?: string | undefined
55117
+ }
52721
55118
  /** True if a sandbox workspace has not been accessed in 14 days */
52722
55119
  is_suspended: boolean
52723
55120
  /**
@@ -53916,6 +56313,27 @@ export interface Routes {
53916
56313
  }
53917
56314
  }
53918
56315
  }
56316
+ '/workspaces/update': {
56317
+ route: '/workspaces/update'
56318
+ method: 'POST' | 'PATCH'
56319
+ queryParams: {}
56320
+ jsonBody: {
56321
+ name?: string | undefined
56322
+ connect_partner_name?: string | undefined
56323
+ connect_webview_customization?:
56324
+ | {
56325
+ primary_button_color?: (string | null) | undefined
56326
+ primary_button_text_color?: (string | null) | undefined
56327
+ success_message?: (string | null) | undefined
56328
+ logo_shape?: (('circle' | 'square') | null) | undefined
56329
+ }
56330
+ | undefined
56331
+ is_suspended?: boolean | undefined
56332
+ }
56333
+ commonParams: {}
56334
+ formData: {}
56335
+ jsonResponse: {}
56336
+ }
53919
56337
  }
53920
56338
 
53921
56339
  export type RouteResponse<Path extends keyof Routes> =