@seamapi/http - v1.121.0
GitHub
Preparing search index...
index
PhoneSessionResource
Type Alias PhoneSessionResource
type
PhoneSessionResource
=
{
is_sandbox_workspace
:
boolean
;
provider_sessions
:
{
acs_credentials
:
{
access_method
:
"code"
|
"card"
|
"mobile_key"
|
"cloud_key"
;
acs_credential_id
:
string
|
null
;
acs_credential_pool_id
?:
string
;
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
;
}
;
avigilon_alta_metadata
?:
{
entry_name
?:
string
;
entry_relays_total_count
?:
number
;
org_name
?:
string
;
site_id
?:
number
;
site_name
?:
string
;
zone_id
?:
number
;
zone_name
?:
string
;
}
;
brivo_metadata
?:
{
access_point_id
?:
string
;
site_id
?:
number
;
site_name
?:
string
;
}
;
can_belong_to_reservation
?:
boolean
;
can_unlock_with_card
?:
boolean
;
can_unlock_with_cloud_key
?:
boolean
;
can_unlock_with_code
?:
boolean
;
can_unlock_with_mobile_key
?:
boolean
;
connected_account_id
:
string
;
created_at
:
string
;
display_name
:
string
;
dormakaba_ambiance_metadata
?:
{
access_point_name
?:
string
}
;
dormakaba_community_metadata
?:
{
access_point_profile
?:
string
}
;
errors
:
{
created_at
:
string
;
error_code
:
string
;
message
:
string
}
[]
;
hotek_metadata
?:
{
common_area_name
?:
string
;
common_area_number
?:
string
;
room_number
?:
string
;
}
;
is_locked
?:
boolean
;
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
?:
{
audit_on_keys
?:
boolean
;
door_description
?:
string
;
door_id
?:
string
;
door_name
?:
string
;
room_description
?:
string
;
room_name
?:
string
;
}
;
space_ids
:
string
[]
;
visionline_metadata
?:
{
door_category
?:
|
"entrance"
|
"guest"
|
"elevator reader"
|
"common"
|
"common (PMS)"
;
door_name
?:
string
;
profiles
?:
(...)
[]
;
}
;
warnings
:
{
created_at
:
string
;
message
:
string
;
warning_code
:
|
"salto_ks_entrance_access_code_support_removed"
|
"entrance_shares_zone"
|
"entrance_setup_required"
|
"salto_ks_privacy_mode"
|
"privacy_mode"
;
}
[]
;
}
[]
;
acs_system_id
:
string
;
acs_user_id
?:
string
;
assa_abloy_vostio_metadata
?:
{
auto_join
?:
boolean
;
door_names
?:
string
[]
;
endpoint_id
?:
string
;
key_id
?:
string
;
key_issuing_request_id
?:
string
;
override_guest_acs_entrance_ids
?:
string
[]
;
}
;
card_number
?:
string
|
null
;
code
?:
string
|
null
;
connected_account_id
:
string
;
created_at
:
string
;
display_name
:
string
;
ends_at
?:
string
;
errors
:
{
created_at
:
string
;
error_code
:
string
;
message
:
string
}
[]
;
external_type
?:
|
"pti_card"
|
"brivo_credential"
|
"hid_credential"
|
"visionline_card"
|
"salto_ks_credential"
|
"assa_abloy_vostio_key"
|
"salto_space_key"
|
"latch_access"
|
"dormakaba_ambiance_credential"
|
"hotek_card"
|
"salto_ks_tag"
|
"avigilon_alta_credential"
|
"kisi_credential"
;
external_type_display_name
?:
string
;
is_issued
?:
boolean
;
is_latest_desired_state_synced_with_provider
?:
boolean
|
null
;
is_managed
:
boolean
;
is_multi_phone_sync_credential
?:
boolean
;
is_one_time_use
?:
boolean
;
issued_at
?:
string
|
null
;
latest_desired_state_synced_with_provider_at
?:
string
|
null
;
parent_acs_credential_id
?:
string
;
starts_at
?:
string
;
user_identity_id
?:
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"
|
"schedule_externally_modified"
|
"schedule_modified"
|
"being_deleted"
|
"unknown_issue_with_acs_credential"
|
"needs_to_be_reissued"
;
}
[]
;
workspace_id
:
string
;
}
[]
;
phone_registration
:
{
is_being_activated
:
boolean
;
phone_registration_id
:
string
;
provider_name
:
string
|
null
;
}
;
}
[]
;
user_identity
:
{
acs_user_ids
:
string
[]
;
created_at
:
string
;
display_name
:
string
;
email_address
:
string
|
null
;
errors
:
{
acs_system_id
:
string
;
acs_user_id
:
string
;
created_at
:
string
;
error_code
:
"issue_with_acs_user"
;
message
:
string
;
}
[]
;
full_name
:
string
|
null
;
phone_number
:
string
|
null
;
user_identity_id
:
string
;
user_identity_key
:
string
|
null
;
warnings
:
{
created_at
:
string
;
message
:
string
;
warning_code
:
|
"being_deleted"
|
"acs_user_profile_does_not_match_user_identity"
;
}
[]
;
workspace_id
:
string
;
}
;
workspace_id
:
string
;
}
Index
Properties
is_
sandbox_
workspace
provider_
sessions
user_
identity
workspace_
id
Properties
is_
sandbox_
workspace
is_sandbox_workspace
:
boolean
provider_
sessions
provider_sessions
:
{
acs_credentials
:
{
access_method
:
"code"
|
"card"
|
"mobile_key"
|
"cloud_key"
;
acs_credential_id
:
string
|
null
;
acs_credential_pool_id
?:
string
;
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
;
}
;
avigilon_alta_metadata
?:
{
entry_name
?:
string
;
entry_relays_total_count
?:
number
;
org_name
?:
string
;
site_id
?:
number
;
site_name
?:
string
;
zone_id
?:
number
;
zone_name
?:
string
;
}
;
brivo_metadata
?:
{
access_point_id
?:
string
;
site_id
?:
number
;
site_name
?:
string
;
}
;
can_belong_to_reservation
?:
boolean
;
can_unlock_with_card
?:
boolean
;
can_unlock_with_cloud_key
?:
boolean
;
can_unlock_with_code
?:
boolean
;
can_unlock_with_mobile_key
?:
boolean
;
connected_account_id
:
string
;
created_at
:
string
;
display_name
:
string
;
dormakaba_ambiance_metadata
?:
{
access_point_name
?:
string
}
;
dormakaba_community_metadata
?:
{
access_point_profile
?:
string
}
;
errors
:
{
created_at
:
string
;
error_code
:
string
;
message
:
string
}
[]
;
hotek_metadata
?:
{
common_area_name
?:
string
;
common_area_number
?:
string
;
room_number
?:
string
;
}
;
is_locked
?:
boolean
;
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
?:
{
audit_on_keys
?:
boolean
;
door_description
?:
string
;
door_id
?:
string
;
door_name
?:
string
;
room_description
?:
string
;
room_name
?:
string
;
}
;
space_ids
:
string
[]
;
visionline_metadata
?:
{
door_category
?:
|
"entrance"
|
"guest"
|
"elevator reader"
|
"common"
|
"common (PMS)"
;
door_name
?:
string
;
profiles
?:
(...)
[]
;
}
;
warnings
:
{
created_at
:
string
;
message
:
string
;
warning_code
:
|
"salto_ks_entrance_access_code_support_removed"
|
"entrance_shares_zone"
|
"entrance_setup_required"
|
"salto_ks_privacy_mode"
|
"privacy_mode"
;
}
[]
;
}
[]
;
acs_system_id
:
string
;
acs_user_id
?:
string
;
assa_abloy_vostio_metadata
?:
{
auto_join
?:
boolean
;
door_names
?:
string
[]
;
endpoint_id
?:
string
;
key_id
?:
string
;
key_issuing_request_id
?:
string
;
override_guest_acs_entrance_ids
?:
string
[]
;
}
;
card_number
?:
string
|
null
;
code
?:
string
|
null
;
connected_account_id
:
string
;
created_at
:
string
;
display_name
:
string
;
ends_at
?:
string
;
errors
:
{
created_at
:
string
;
error_code
:
string
;
message
:
string
}
[]
;
external_type
?:
|
"pti_card"
|
"brivo_credential"
|
"hid_credential"
|
"visionline_card"
|
"salto_ks_credential"
|
"assa_abloy_vostio_key"
|
"salto_space_key"
|
"latch_access"
|
"dormakaba_ambiance_credential"
|
"hotek_card"
|
"salto_ks_tag"
|
"avigilon_alta_credential"
|
"kisi_credential"
;
external_type_display_name
?:
string
;
is_issued
?:
boolean
;
is_latest_desired_state_synced_with_provider
?:
boolean
|
null
;
is_managed
:
boolean
;
is_multi_phone_sync_credential
?:
boolean
;
is_one_time_use
?:
boolean
;
issued_at
?:
string
|
null
;
latest_desired_state_synced_with_provider_at
?:
string
|
null
;
parent_acs_credential_id
?:
string
;
starts_at
?:
string
;
user_identity_id
?:
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"
|
"schedule_externally_modified"
|
"schedule_modified"
|
"being_deleted"
|
"unknown_issue_with_acs_credential"
|
"needs_to_be_reissued"
;
}
[]
;
workspace_id
:
string
;
}
[]
;
phone_registration
:
{
is_being_activated
:
boolean
;
phone_registration_id
:
string
;
provider_name
:
string
|
null
;
}
;
}
[]
user_
identity
user_identity
:
{
acs_user_ids
:
string
[]
;
created_at
:
string
;
display_name
:
string
;
email_address
:
string
|
null
;
errors
:
{
acs_system_id
:
string
;
acs_user_id
:
string
;
created_at
:
string
;
error_code
:
"issue_with_acs_user"
;
message
:
string
;
}
[]
;
full_name
:
string
|
null
;
phone_number
:
string
|
null
;
user_identity_id
:
string
;
user_identity_key
:
string
|
null
;
warnings
:
{
created_at
:
string
;
message
:
string
;
warning_code
:
|
"being_deleted"
|
"acs_user_profile_does_not_match_user_identity"
;
}
[]
;
workspace_id
:
string
;
}
workspace_
id
workspace_id
:
string
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
is_
sandbox_
workspace
provider_
sessions
user_
identity
workspace_
id
GitHub
@seamapi/http - v1.121.0
Loading...