Class SeamHttpAcsCredentials Defined in src/lib/seam/connect/routes/acs-credentials.ts:39 Constructorsconstructor new Seam Http Acs Credentials ( apiKeyOrOptions ? ) : SeamHttpAcsCredentials Defined in src/lib/seam/connect/routes/acs-credentials.ts:43 Propertiesclient client : AxiosInstance
Defined in src/lib/seam/connect/routes/acs-credentials.ts:40 Readonly
defaults Defined in src/lib/seam/connect/routes/acs-credentials.ts:41 Accessors Methodsassign assign ( body ? ) : SeamHttpRequest < void , undefined > Parameters Optional
body : { acs_credential_id : string ; acs_user_id : string ; } acs_ credential_ id : string acs_ user_ id : string Defined in src/lib/seam/connect/routes/acs-credentials.ts:165 create create ( body ? ) : SeamHttpRequest < SetNonNullable < Required < { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; card_number ?: null | string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: | "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" ; external_type_display_name ?: string ; is_issued ?: boolean ; is_latest_desired_state_synced_with_provider ?: boolean ; is_managed : true ; is_multi_phone_sync_credential ?: boolean ; is_one_time_use ?: boolean ; issued_at ?: null | string ; latest_desired_state_synced_with_provider_at ?: string ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { auto_join ?: boolean ; card_function_type : "guest" | "staff" ; card_id ?: string ; common_acs_entrance_ids ?: string [] ; credential_id ?: string ; guest_acs_entrance_ids ?: string [] ; is_valid ?: boolean ; joiner_acs_credential_ids ?: string [] ; } ; warnings : ( | { created_at : string ; message : string ; warning_code : "waiting_to_be_issued" ; } | { created_at : string ; message : string ; warning_code : "schedule_externally_modified" ; } | { created_at : string ; message : string ; warning_code : "schedule_modified" ; } | { created_at : string ; message : string ; warning_code : "being_deleted" ; } | { created_at : string ; message : string ; warning_code : "unknown_issue_with_credential" ; } ) [] ; workspace_id : string ; } ; } > , "acs_credential" > , "acs_credential" > Parameters Optional
body : { access_method : "code" | "card" | "mobile_key" ; acs_user_id : string ; allowed_acs_entrance_ids ?: string [] ; assa_abloy_vostio_metadata ?: { join_all_guest_acs_entrances ?: boolean ; override_all_guest_acs_entrances ?: boolean ; override_guest_acs_entrance_ids ?: string [] ; } ; code ?: string ; credential_manager_acs_system_id ?: string ; ends_at ?: string ; is_multi_phone_sync_credential ?: boolean ; starts_at ?: string ; visionline_metadata ?: { assa_abloy_credential_service_mobile_endpoint_id ?: string ; auto_join ?: boolean ; card_format ?: "TLCode" | "rfid48" ; card_function_type ?: "guest" | "staff" ; is_override_key ?: boolean ; joiner_acs_credential_ids ?: string [] ; override ?: boolean ; } ; } access_ method : "code" | "card" | "mobile_key" acs_ user_ id : string Optional
allowed_ acs_ entrance_ ids ?: string [] Optional
assa_ abloy_ vostio_ metadata ?: { join_all_guest_acs_entrances ?: boolean ; override_all_guest_acs_entrances ?: boolean ; override_guest_acs_entrance_ids ?: string [] ; } Optional
join_ all_ guest_ acs_ entrances ?: boolean Optional
override_ all_ guest_ acs_ entrances ?: boolean Optional
override_ guest_ acs_ entrance_ ids ?: string [] Optional
code ?: string Optional
credential_ manager_ acs_ system_ id ?: string Optional
ends_ at ?: string Optional
is_ multi_ phone_ sync_ credential ?: boolean Optional
starts_ at ?: string Optional
visionline_ metadata ?: { assa_abloy_credential_service_mobile_endpoint_id ?: string ; auto_join ?: boolean ; card_format ?: "TLCode" | "rfid48" ; card_function_type ?: "guest" | "staff" ; is_override_key ?: boolean ; joiner_acs_credential_ids ?: string [] ; override ?: boolean ; } Optional
assa_ abloy_ credential_ service_ mobile_ endpoint_ id ?: string Optional
auto_ join ?: boolean Optional
card_ format ?: "TLCode" | "rfid48" Optional
card_ function_ type ?: "guest" | "staff" Optional
is_ override_ key ?: boolean Optional
joiner_ acs_ credential_ ids ?: string [] Optional
override ?: boolean Returns SeamHttpRequest < SetNonNullable < Required < { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; card_number ?: null | string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: | "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" ; external_type_display_name ?: string ; is_issued ?: boolean ; is_latest_desired_state_synced_with_provider ?: boolean ; is_managed : true ; is_multi_phone_sync_credential ?: boolean ; is_one_time_use ?: boolean ; issued_at ?: null | string ; latest_desired_state_synced_with_provider_at ?: string ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { auto_join ?: boolean ; card_function_type : "guest" | "staff" ; card_id ?: string ; common_acs_entrance_ids ?: string [] ; credential_id ?: string ; guest_acs_entrance_ids ?: string [] ; is_valid ?: boolean ; joiner_acs_credential_ids ?: string [] ; } ; warnings : ( | { created_at : string ; message : string ; warning_code : "waiting_to_be_issued" ; } | { created_at : string ; message : string ; warning_code : "schedule_externally_modified" ; } | { created_at : string ; message : string ; warning_code : "schedule_modified" ; } | { created_at : string ; message : string ; warning_code : "being_deleted" ; } | { created_at : string ; message : string ; warning_code : "unknown_issue_with_credential" ; } ) [] ; workspace_id : string ; } ; } > , "acs_credential" > , "acs_credential" > Defined in src/lib/seam/connect/routes/acs-credentials.ts:174 create Offline Code create Offline Code ( body ? ) : SeamHttpRequest < SetNonNullable < Required < { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; card_number ?: null | string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: | "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" ; external_type_display_name ?: string ; is_issued ?: boolean ; is_latest_desired_state_synced_with_provider ?: boolean ; is_managed : true ; is_multi_phone_sync_credential ?: boolean ; is_one_time_use ?: boolean ; issued_at ?: null | string ; latest_desired_state_synced_with_provider_at ?: string ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { auto_join ?: boolean ; card_function_type : "guest" | "staff" ; card_id ?: string ; common_acs_entrance_ids ?: string [] ; credential_id ?: string ; guest_acs_entrance_ids ?: string [] ; is_valid ?: boolean ; joiner_acs_credential_ids ?: string [] ; } ; warnings : ( | { created_at : string ; message : string ; warning_code : "waiting_to_be_issued" ; } | { created_at : string ; message : string ; warning_code : "schedule_externally_modified" ; } | { created_at : string ; message : string ; warning_code : "schedule_modified" ; } | { created_at : string ; message : string ; warning_code : "being_deleted" ; } | { created_at : string ; message : string ; warning_code : "unknown_issue_with_credential" ; } ) [] ; workspace_id : string ; } ; } > , "acs_credential" > , "acs_credential" > Parameters Optional
body : { acs_user_id : string ; allowed_acs_entrance_id : string ; ends_at ?: string ; is_one_time_use ?: boolean ; starts_at ?: string ; } acs_ user_ id : string allowed_ acs_ entrance_ id : string Optional
ends_ at ?: string Optional
is_ one_ time_ use ?: boolean Optional
starts_ at ?: string Returns SeamHttpRequest < SetNonNullable < Required < { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; card_number ?: null | string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: | "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" ; external_type_display_name ?: string ; is_issued ?: boolean ; is_latest_desired_state_synced_with_provider ?: boolean ; is_managed : true ; is_multi_phone_sync_credential ?: boolean ; is_one_time_use ?: boolean ; issued_at ?: null | string ; latest_desired_state_synced_with_provider_at ?: string ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { auto_join ?: boolean ; card_function_type : "guest" | "staff" ; card_id ?: string ; common_acs_entrance_ids ?: string [] ; credential_id ?: string ; guest_acs_entrance_ids ?: string [] ; is_valid ?: boolean ; joiner_acs_credential_ids ?: string [] ; } ; warnings : ( | { created_at : string ; message : string ; warning_code : "waiting_to_be_issued" ; } | { created_at : string ; message : string ; warning_code : "schedule_externally_modified" ; } | { created_at : string ; message : string ; warning_code : "schedule_modified" ; } | { created_at : string ; message : string ; warning_code : "being_deleted" ; } | { created_at : string ; message : string ; warning_code : "unknown_issue_with_credential" ; } ) [] ; workspace_id : string ; } ; } > , "acs_credential" > , "acs_credential" > Defined in src/lib/seam/connect/routes/acs-credentials.ts:185 delete delete ( body ? ) : SeamHttpRequest < void , undefined > Parameters Optional
body : { acs_credential_id : string ; } acs_ credential_ id : string Defined in src/lib/seam/connect/routes/acs-credentials.ts:199 get get ( body ? ) : SeamHttpRequest < SetNonNullable < Required < { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; card_number ?: null | string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: | "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" ; external_type_display_name ?: string ; is_issued ?: boolean ; is_latest_desired_state_synced_with_provider ?: boolean ; is_managed : true ; is_multi_phone_sync_credential ?: boolean ; is_one_time_use ?: boolean ; issued_at ?: null | string ; latest_desired_state_synced_with_provider_at ?: string ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { auto_join ?: boolean ; card_function_type : "guest" | "staff" ; card_id ?: string ; common_acs_entrance_ids ?: string [] ; credential_id ?: string ; guest_acs_entrance_ids ?: string [] ; is_valid ?: boolean ; joiner_acs_credential_ids ?: string [] ; } ; warnings : ( | { created_at : string ; message : string ; warning_code : "waiting_to_be_issued" ; } | { created_at : string ; message : string ; warning_code : "schedule_externally_modified" ; } | { created_at : string ; message : string ; warning_code : "schedule_modified" ; } | { created_at : string ; message : string ; warning_code : "being_deleted" ; } | { created_at : string ; message : string ; warning_code : "unknown_issue_with_credential" ; } ) [] ; workspace_id : string ; } ; } > , "acs_credential" > , "acs_credential" > Parameters Optional
body : { acs_credential_id : string ; } acs_ credential_ id : string Returns SeamHttpRequest < SetNonNullable < Required < { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; card_number ?: null | string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: | "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" ; external_type_display_name ?: string ; is_issued ?: boolean ; is_latest_desired_state_synced_with_provider ?: boolean ; is_managed : true ; is_multi_phone_sync_credential ?: boolean ; is_one_time_use ?: boolean ; issued_at ?: null | string ; latest_desired_state_synced_with_provider_at ?: string ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { auto_join ?: boolean ; card_function_type : "guest" | "staff" ; card_id ?: string ; common_acs_entrance_ids ?: string [] ; credential_id ?: string ; guest_acs_entrance_ids ?: string [] ; is_valid ?: boolean ; joiner_acs_credential_ids ?: string [] ; } ; warnings : ( | { created_at : string ; message : string ; warning_code : "waiting_to_be_issued" ; } | { created_at : string ; message : string ; warning_code : "schedule_externally_modified" ; } | { created_at : string ; message : string ; warning_code : "schedule_modified" ; } | { created_at : string ; message : string ; warning_code : "being_deleted" ; } | { created_at : string ; message : string ; warning_code : "unknown_issue_with_credential" ; } ) [] ; workspace_id : string ; } ; } > , "acs_credential" > , "acs_credential" > Defined in src/lib/seam/connect/routes/acs-credentials.ts:208 list list ( body ? ) : SeamHttpRequest < SetNonNullable < Required < { acs_credentials : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; card_number ?: null | string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: | "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" ; external_type_display_name ?: string ; is_issued ?: boolean ; is_latest_desired_state_synced_with_provider ?: boolean ; is_managed : true ; is_multi_phone_sync_credential ?: boolean ; is_one_time_use ?: boolean ; issued_at ?: null | string ; latest_desired_state_synced_with_provider_at ?: string ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { auto_join ?: boolean ; card_function_type : "guest" | "staff" ; card_id ?: string ; common_acs_entrance_ids ?: string [] ; credential_id ?: string ; guest_acs_entrance_ids ?: string [] ; is_valid ?: boolean ; joiner_acs_credential_ids ?: string [] ; } ; warnings : ( | { created_at : string ; message : string ; warning_code : "waiting_to_be_issued" ; } | { created_at : string ; message : string ; warning_code : "schedule_externally_modified" ; } | { created_at : string ; message : string ; warning_code : "schedule_modified" ; } | { created_at : string ; message : string ; warning_code : "being_deleted" ; } | { created_at : string ; message : string ; warning_code : "unknown_issue_with_credential" ; } ) [] ; workspace_id : string ; } [] ; } > , "acs_credentials" > , "acs_credentials" > Returns SeamHttpRequest < SetNonNullable < Required < { acs_credentials : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; card_number ?: null | string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: | "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" | "salto_ks_credential" ; external_type_display_name ?: string ; is_issued ?: boolean ; is_latest_desired_state_synced_with_provider ?: boolean ; is_managed : true ; is_multi_phone_sync_credential ?: boolean ; is_one_time_use ?: boolean ; issued_at ?: null | string ; latest_desired_state_synced_with_provider_at ?: string ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { auto_join ?: boolean ; card_function_type : "guest" | "staff" ; card_id ?: string ; common_acs_entrance_ids ?: string [] ; credential_id ?: string ; guest_acs_entrance_ids ?: string [] ; is_valid ?: boolean ; joiner_acs_credential_ids ?: string [] ; } ; warnings : ( | { created_at : string ; message : string ; warning_code : "waiting_to_be_issued" ; } | { created_at : string ; message : string ; warning_code : "schedule_externally_modified" ; } | { created_at : string ; message : string ; warning_code : "schedule_modified" ; } | { created_at : string ; message : string ; warning_code : "being_deleted" ; } | { created_at : string ; message : string ; warning_code : "unknown_issue_with_credential" ; } ) [] ; workspace_id : string ; } [] ; } > , "acs_credentials" > , "acs_credentials" > Defined in src/lib/seam/connect/routes/acs-credentials.ts:219 list Accessible Entrances list Accessible Entrances ( body ? ) : SeamHttpRequest < SetNonNullable < Required < { acs_entrances : { acs_entrance_id : string ; acs_system_id : string ; assa_abloy_vostio_metadata ?: { door_name : string ; door_number ?: number ; door_type : | "CommonDoor" | "EntranceDoor" | "GuestDoor" | "Elevator" ; pms_id ?: string ; stand_open ?: boolean ; } ; created_at : string ; display_name : string ; dormakaba_community_metadata ?: { access_point_name : string ; common_area_number ?: number ; inner_access_points_names ?: string [] ; lease_ids ?: string [] ; } ; errors : { error_code : string ; message : string ; } [] ; latch_metadata ?: { accessibility_type : string ; door_name : string ; door_type : string ; is_connected : boolean ; } ; salto_ks_metadata ?: { battery_level : string ; door_name : string ; intrusion_alarm ?: boolean ; left_open_alarm ?: boolean ; lock_type : string ; locked_state : string ; online ?: boolean ; privacy_mode ?: boolean ; } ; salto_space_metadata ?: { door_description ?: string ; door_name : string ; ext_door_id : string ; } ; visionline_metadata ?: { door_category : | "common" | "guest" | "entrance" | "elevator reader" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : ...; visionline_door_profile_type : ...; } [] ; } ; } [] ; } > , "acs_entrances" > , "acs_entrances" > Parameters Optional
body : { acs_credential_id : string ; } acs_ credential_ id : string Returns SeamHttpRequest < SetNonNullable < Required < { acs_entrances : { acs_entrance_id : string ; acs_system_id : string ; assa_abloy_vostio_metadata ?: { door_name : string ; door_number ?: number ; door_type : | "CommonDoor" | "EntranceDoor" | "GuestDoor" | "Elevator" ; pms_id ?: string ; stand_open ?: boolean ; } ; created_at : string ; display_name : string ; dormakaba_community_metadata ?: { access_point_name : string ; common_area_number ?: number ; inner_access_points_names ?: string [] ; lease_ids ?: string [] ; } ; errors : { error_code : string ; message : string ; } [] ; latch_metadata ?: { accessibility_type : string ; door_name : string ; door_type : string ; is_connected : boolean ; } ; salto_ks_metadata ?: { battery_level : string ; door_name : string ; intrusion_alarm ?: boolean ; left_open_alarm ?: boolean ; lock_type : string ; locked_state : string ; online ?: boolean ; privacy_mode ?: boolean ; } ; salto_space_metadata ?: { door_description ?: string ; door_name : string ; ext_door_id : string ; } ; visionline_metadata ?: { door_category : | "common" | "guest" | "entrance" | "elevator reader" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : ...; visionline_door_profile_type : ...; } [] ; } ; } [] ; } > , "acs_entrances" > , "acs_entrances" > Defined in src/lib/seam/connect/routes/acs-credentials.ts:230 unassign unassign ( body ? ) : SeamHttpRequest < void , undefined > Parameters Optional
body : { acs_credential_id : string ; acs_user_id : string ; } acs_ credential_ id : string acs_ user_ id : string Defined in src/lib/seam/connect/routes/acs-credentials.ts:244 update update ( body ? ) : SeamHttpRequest < void , undefined > Parameters Optional
body : { acs_credential_id : string ; code ?: string ; ends_at ?: string ; } acs_ credential_ id : string Optional
code ?: string Optional
ends_ at ?: string Defined in src/lib/seam/connect/routes/acs-credentials.ts:255 update Client Session Token update Client Session Token ( clientSessionToken ) : Promise < void > Parameters clientSessionToken : string Returns Promise < void > Defined in src/lib/seam/connect/routes/acs-credentials.ts:139 Static
from Api Key from Api Key ( apiKey , options ? ) : SeamHttpAcsCredentials Defined in src/lib/seam/connect/routes/acs-credentials.ts:60 Static
from Client from Client ( client , options ? ) : SeamHttpAcsCredentials Defined in src/lib/seam/connect/routes/acs-credentials.ts:49 Static
from Client Session Token from Client Session Token ( clientSessionToken , options ? ) : SeamHttpAcsCredentials Defined in src/lib/seam/connect/routes/acs-credentials.ts:71 Static
from Console Session Token from Console Session Token ( consoleSessionToken , workspaceId , options ? ) : SeamHttpAcsCredentials Defined in src/lib/seam/connect/routes/acs-credentials.ts:105 Static
from Personal Access Token from Personal Access Token ( personalAccessToken , workspaceId , options ? ) : SeamHttpAcsCredentials Defined in src/lib/seam/connect/routes/acs-credentials.ts:122 Static
from Publishable Key from Publishable Key ( publishableKey , userIdentifierKey , options ? ) : Promise < SeamHttpAcsCredentials > Defined in src/lib/seam/connect/routes/acs-credentials.ts:85
ID of the desired credential.