diff --git a/docs/api/access_codes/README.md b/docs/api/access_codes/README.md index 0267cf3b0..398b959e3 100644 --- a/docs/api/access_codes/README.md +++ b/docs/api/access_codes/README.md @@ -134,7 +134,7 @@ Failed to set code on SmartThings device. Enum values: - - smartthings_failed_to_set_access_code + - smartthings_failed_to_set_access_code --- @@ -174,7 +174,7 @@ Failed to set code after multiple retries. Enum values: - - smartthings_failed_to_set_after_multiple_retries + - smartthings_failed_to_set_after_multiple_retries --- @@ -214,7 +214,7 @@ No free slots available on the device. Enum values: - - smartthings_no_free_slots_available + - smartthings_no_free_slots_available --- @@ -254,7 +254,7 @@ Failed to set code on device. Enum values: - - failed_to_set_on_device + - failed_to_set_on_device --- @@ -294,7 +294,7 @@ Failed to remove code from device. Enum values: - - failed_to_remove_from_device + - failed_to_remove_from_device --- @@ -334,7 +334,7 @@ Duplicate access code detected on device. Enum values: - - duplicate_code_on_device + - duplicate_code_on_device --- @@ -374,7 +374,7 @@ An attempt to modify this access code was prevented. Enum values: - - duplicate_code_attempt_prevented + - duplicate_code_attempt_prevented --- @@ -414,7 +414,7 @@ No space for access code on device. Enum values: - - no_space_for_access_code_on_device + - no_space_for_access_code_on_device --- @@ -454,7 +454,7 @@ Igloohome bridge has too many pending jobs in the queue. Enum values: - - igloohome_bridge_too_many_pending_jobs + - igloohome_bridge_too_many_pending_jobs --- @@ -494,7 +494,7 @@ Igloohome bridge is offline. Enum values: - - igloohome_bridge_offline + - igloohome_bridge_offline --- @@ -534,7 +534,7 @@ Lock has reached maximum amount of codes. Enum values: - - igloohome_offline_access_code_no_variance_available + - igloohome_offline_access_code_no_variance_available --- @@ -574,7 +574,7 @@ Unable to confirm that the access code is set on Kwikset device. Enum values: - - kwikset_unable_to_confirm_code + - kwikset_unable_to_confirm_code --- @@ -614,7 +614,7 @@ Unable to confirm the deletion of the access code on Kwikset device. Enum values: - - kwikset_unable_to_confirm_deletion + - kwikset_unable_to_confirm_deletion --- @@ -654,7 +654,7 @@ Code was modified or removed externally after Seam successfully set it on the de Enum values: - - code_modified_external_to_seam + - code_modified_external_to_seam --- @@ -694,7 +694,7 @@ Invalid code length for August lock. Enum values: - - august_lock_invalid_code_length + - august_lock_invalid_code_length --- @@ -734,7 +734,7 @@ Access code has not yet been fully moved to the device. Enum values: - - august_device_programming_delay + - august_device_programming_delay --- @@ -774,7 +774,7 @@ All access code slots on the device are full. Enum values: - - august_device_slots_full + - august_device_slots_full --- @@ -814,7 +814,7 @@ August lock is missing a keypad. Enum values: - - august_lock_missing_keypad + - august_lock_missing_keypad --- @@ -854,7 +854,7 @@ August lock is temporarily offline. Enum values: - - august_lock_temporarily_offline + - august_lock_temporarily_offline --- @@ -894,7 +894,7 @@ Salto site user is not subscribed. Enum values: - - salto_ks_user_not_subscribed + - salto_ks_user_not_subscribed --- @@ -934,7 +934,7 @@ Access code has not yet been fully moved to the device. Enum values: - - hubitat_device_programming_delay + - hubitat_device_programming_delay --- @@ -974,7 +974,7 @@ No free positions available on the device. Enum values: - - hubitat_no_free_positions_available + - hubitat_no_free_positions_available --- @@ -1014,7 +1014,7 @@ Duplicate access code name detected. Enum values: - - wyze_duplicate_code_name + - wyze_duplicate_code_name --- @@ -1054,7 +1054,7 @@ Potential duplicate access code detected. Enum values: - - wyze_potential_duplicate_code + - wyze_potential_duplicate_code --- @@ -1094,7 +1094,7 @@ No valid user level for Oracode. Enum values: - - dormakaba_oracode_no_valid_user_level + - dormakaba_oracode_no_valid_user_level --- @@ -1132,7 +1132,7 @@ Account is disconnected Enum values: - - account_disconnected + - account_disconnected --- @@ -1172,7 +1172,7 @@ Salto site user limit reached. Enum values: - - salto_ks_subscription_limit_exceeded + - salto_ks_subscription_limit_exceeded --- @@ -1212,7 +1212,7 @@ Device is offline Enum values: - - device_offline + - device_offline --- @@ -1246,7 +1246,7 @@ Device has been removed Enum values: - - device_removed + - device_removed --- @@ -1280,7 +1280,7 @@ Hub is disconnected Enum values: - - hub_disconnected + - hub_disconnected --- @@ -1314,7 +1314,7 @@ Device is disconnected Enum values: - - device_disconnected + - device_disconnected --- @@ -1348,7 +1348,7 @@ The backup access code pool is empty. Enum values: - - empty_backup_access_code_pool + - empty_backup_access_code_pool --- @@ -1382,7 +1382,7 @@ User is not authorized to use the August Lock. Enum values: - - august_lock_not_authorized + - august_lock_not_authorized --- @@ -1416,7 +1416,7 @@ Lock is not connected to the Seam Bridge. Enum values: - - august_lock_missing_bridge + - august_lock_missing_bridge --- @@ -1450,7 +1450,7 @@ Lock is not paired with a Gateway. Enum values: - - ttlock_lock_not_paired_to_gateway + - ttlock_lock_not_paired_to_gateway --- @@ -1484,7 +1484,7 @@ Missing device credentials. Enum values: - - missing_device_credentials + - missing_device_credentials --- @@ -1518,7 +1518,7 @@ The auxiliary heat is running. Enum values: - - auxiliary_heat_running + - auxiliary_heat_running --- @@ -1552,7 +1552,7 @@ Subscription required to connect. Enum values: - - subscription_required + - subscription_required --- @@ -1588,7 +1588,7 @@ Credentials provided were invalid. Enum values: - - invalid_credentials + - invalid_credentials --- @@ -1636,7 +1636,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../capabili Enum values: - - bridge_disconnected + - bridge_disconnected --- @@ -1837,7 +1837,7 @@ Failed to set code on SmartThings device. Enum values: - - smartthings_failed_to_set_access_code + - smartthings_failed_to_set_access_code @@ -1869,7 +1869,7 @@ Duplicate access code detected. Enum values: - - schlage_detected_duplicate + - schlage_detected_duplicate @@ -1901,7 +1901,7 @@ Received an error when attempting to create this code. Enum values: - - schlage_creation_outage + - schlage_creation_outage @@ -1933,7 +1933,7 @@ Code was modified or removed externally after Seam successfully set it on the de Enum values: - - code_modified_external_to_seam + - code_modified_external_to_seam @@ -1965,7 +1965,7 @@ Delay in setting code on device. Enum values: - - delay_in_setting_on_device + - delay_in_setting_on_device @@ -1997,7 +1997,7 @@ Delay in removing code from device. Enum values: - - delay_in_removing_from_device + - delay_in_removing_from_device @@ -2029,7 +2029,7 @@ Third-party integration detected that may cause access codes to fail. Enum values: - - third_party_integration_detected + - third_party_integration_detected @@ -2061,7 +2061,7 @@ Access code has not yet been fully moved to the device. Enum values: - - august_device_programming_delay + - august_device_programming_delay @@ -2093,7 +2093,7 @@ August lock is temporarily offline. Enum values: - - august_lock_temporarily_offline + - august_lock_temporarily_offline @@ -2125,7 +2125,7 @@ Algopins must be used within 24 hours. Enum values: - - igloo_algopin_must_be_used_within_24_hours + - igloo_algopin_must_be_used_within_24_hours @@ -2157,7 +2157,7 @@ Management was transferred to another workspace. Enum values: - - management_transferred + - management_transferred @@ -2189,7 +2189,7 @@ Unable to confirm that the access code is set on Kwikset device. Enum values: - - kwikset_unable_to_confirm_code + - kwikset_unable_to_confirm_code diff --git a/docs/api/access_codes/unmanaged/README.md b/docs/api/access_codes/unmanaged/README.md index 6a5d7bc46..b9a38e2cd 100644 --- a/docs/api/access_codes/unmanaged/README.md +++ b/docs/api/access_codes/unmanaged/README.md @@ -120,7 +120,7 @@ Failed to set code on SmartThings device. Enum values: - - smartthings_failed_to_set_access_code + - smartthings_failed_to_set_access_code --- @@ -160,7 +160,7 @@ Failed to set code after multiple retries. Enum values: - - smartthings_failed_to_set_after_multiple_retries + - smartthings_failed_to_set_after_multiple_retries --- @@ -200,7 +200,7 @@ No free slots available on the device. Enum values: - - smartthings_no_free_slots_available + - smartthings_no_free_slots_available --- @@ -240,7 +240,7 @@ Failed to set code on device. Enum values: - - failed_to_set_on_device + - failed_to_set_on_device --- @@ -280,7 +280,7 @@ Failed to remove code from device. Enum values: - - failed_to_remove_from_device + - failed_to_remove_from_device --- @@ -320,7 +320,7 @@ Duplicate access code detected on device. Enum values: - - duplicate_code_on_device + - duplicate_code_on_device --- @@ -360,7 +360,7 @@ An attempt to modify this access code was prevented. Enum values: - - duplicate_code_attempt_prevented + - duplicate_code_attempt_prevented --- @@ -400,7 +400,7 @@ No space for access code on device. Enum values: - - no_space_for_access_code_on_device + - no_space_for_access_code_on_device --- @@ -440,7 +440,7 @@ Igloohome bridge has too many pending jobs in the queue. Enum values: - - igloohome_bridge_too_many_pending_jobs + - igloohome_bridge_too_many_pending_jobs --- @@ -480,7 +480,7 @@ Igloohome bridge is offline. Enum values: - - igloohome_bridge_offline + - igloohome_bridge_offline --- @@ -520,7 +520,7 @@ Lock has reached maximum amount of codes. Enum values: - - igloohome_offline_access_code_no_variance_available + - igloohome_offline_access_code_no_variance_available --- @@ -560,7 +560,7 @@ Unable to confirm that the access code is set on Kwikset device. Enum values: - - kwikset_unable_to_confirm_code + - kwikset_unable_to_confirm_code --- @@ -600,7 +600,7 @@ Unable to confirm the deletion of the access code on Kwikset device. Enum values: - - kwikset_unable_to_confirm_deletion + - kwikset_unable_to_confirm_deletion --- @@ -640,7 +640,7 @@ Code was modified or removed externally after Seam successfully set it on the de Enum values: - - code_modified_external_to_seam + - code_modified_external_to_seam --- @@ -680,7 +680,7 @@ Invalid code length for August lock. Enum values: - - august_lock_invalid_code_length + - august_lock_invalid_code_length --- @@ -720,7 +720,7 @@ Access code has not yet been fully moved to the device. Enum values: - - august_device_programming_delay + - august_device_programming_delay --- @@ -760,7 +760,7 @@ All access code slots on the device are full. Enum values: - - august_device_slots_full + - august_device_slots_full --- @@ -800,7 +800,7 @@ August lock is missing a keypad. Enum values: - - august_lock_missing_keypad + - august_lock_missing_keypad --- @@ -840,7 +840,7 @@ August lock is temporarily offline. Enum values: - - august_lock_temporarily_offline + - august_lock_temporarily_offline --- @@ -880,7 +880,7 @@ Salto site user is not subscribed. Enum values: - - salto_ks_user_not_subscribed + - salto_ks_user_not_subscribed --- @@ -920,7 +920,7 @@ Access code has not yet been fully moved to the device. Enum values: - - hubitat_device_programming_delay + - hubitat_device_programming_delay --- @@ -960,7 +960,7 @@ No free positions available on the device. Enum values: - - hubitat_no_free_positions_available + - hubitat_no_free_positions_available --- @@ -1000,7 +1000,7 @@ Duplicate access code name detected. Enum values: - - wyze_duplicate_code_name + - wyze_duplicate_code_name --- @@ -1040,7 +1040,7 @@ Potential duplicate access code detected. Enum values: - - wyze_potential_duplicate_code + - wyze_potential_duplicate_code --- @@ -1080,7 +1080,7 @@ No valid user level for Oracode. Enum values: - - dormakaba_oracode_no_valid_user_level + - dormakaba_oracode_no_valid_user_level --- @@ -1118,7 +1118,7 @@ Account is disconnected Enum values: - - account_disconnected + - account_disconnected --- @@ -1158,7 +1158,7 @@ Salto site user limit reached. Enum values: - - salto_ks_subscription_limit_exceeded + - salto_ks_subscription_limit_exceeded --- @@ -1198,7 +1198,7 @@ Device is offline Enum values: - - device_offline + - device_offline --- @@ -1232,7 +1232,7 @@ Device has been removed Enum values: - - device_removed + - device_removed --- @@ -1266,7 +1266,7 @@ Hub is disconnected Enum values: - - hub_disconnected + - hub_disconnected --- @@ -1300,7 +1300,7 @@ Device is disconnected Enum values: - - device_disconnected + - device_disconnected --- @@ -1334,7 +1334,7 @@ The backup access code pool is empty. Enum values: - - empty_backup_access_code_pool + - empty_backup_access_code_pool --- @@ -1368,7 +1368,7 @@ User is not authorized to use the August Lock. Enum values: - - august_lock_not_authorized + - august_lock_not_authorized --- @@ -1402,7 +1402,7 @@ Lock is not connected to the Seam Bridge. Enum values: - - august_lock_missing_bridge + - august_lock_missing_bridge --- @@ -1436,7 +1436,7 @@ Lock is not paired with a Gateway. Enum values: - - ttlock_lock_not_paired_to_gateway + - ttlock_lock_not_paired_to_gateway --- @@ -1470,7 +1470,7 @@ Missing device credentials. Enum values: - - missing_device_credentials + - missing_device_credentials --- @@ -1504,7 +1504,7 @@ The auxiliary heat is running. Enum values: - - auxiliary_heat_running + - auxiliary_heat_running --- @@ -1538,7 +1538,7 @@ Subscription required to connect. Enum values: - - subscription_required + - subscription_required --- @@ -1574,7 +1574,7 @@ Credentials provided were invalid. Enum values: - - invalid_credentials + - invalid_credentials --- @@ -1622,7 +1622,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab Enum values: - - bridge_disconnected + - bridge_disconnected --- @@ -1747,7 +1747,7 @@ Failed to set code on SmartThings device. Enum values: - - smartthings_failed_to_set_access_code + - smartthings_failed_to_set_access_code @@ -1779,7 +1779,7 @@ Duplicate access code detected. Enum values: - - schlage_detected_duplicate + - schlage_detected_duplicate @@ -1811,7 +1811,7 @@ Received an error when attempting to create this code. Enum values: - - schlage_creation_outage + - schlage_creation_outage @@ -1843,7 +1843,7 @@ Code was modified or removed externally after Seam successfully set it on the de Enum values: - - code_modified_external_to_seam + - code_modified_external_to_seam @@ -1875,7 +1875,7 @@ Delay in setting code on device. Enum values: - - delay_in_setting_on_device + - delay_in_setting_on_device @@ -1907,7 +1907,7 @@ Delay in removing code from device. Enum values: - - delay_in_removing_from_device + - delay_in_removing_from_device @@ -1939,7 +1939,7 @@ Third-party integration detected that may cause access codes to fail. Enum values: - - third_party_integration_detected + - third_party_integration_detected @@ -1971,7 +1971,7 @@ Access code has not yet been fully moved to the device. Enum values: - - august_device_programming_delay + - august_device_programming_delay @@ -2003,7 +2003,7 @@ August lock is temporarily offline. Enum values: - - august_lock_temporarily_offline + - august_lock_temporarily_offline @@ -2035,7 +2035,7 @@ Algopins must be used within 24 hours. Enum values: - - igloo_algopin_must_be_used_within_24_hours + - igloo_algopin_must_be_used_within_24_hours @@ -2067,7 +2067,7 @@ Management was transferred to another workspace. Enum values: - - management_transferred + - management_transferred @@ -2099,7 +2099,7 @@ Unable to confirm that the access code is set on Kwikset device. Enum values: - - kwikset_unable_to_confirm_code + - kwikset_unable_to_confirm_code diff --git a/docs/api/acs/credentials/README.md b/docs/api/acs/credentials/README.md index 714c868a8..a7e7354d4 100644 --- a/docs/api/acs/credentials/README.md +++ b/docs/api/acs/credentials/README.md @@ -371,7 +371,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi Enum values: - - waiting_to_be_issued + - waiting_to_be_issued @@ -403,7 +403,7 @@ Indicates that the schedule of one of the [credential](../../../capability-guide Enum values: - - schedule_externally_modified + - schedule_externally_modified @@ -435,7 +435,7 @@ Indicates that the schedule of the [credential](../../../capability-guides/acces Enum values: - - schedule_modified + - schedule_modified @@ -467,7 +467,7 @@ Indicates that the [credential](../../../capability-guides/access-systems/managi Enum values: - - being_deleted + - being_deleted @@ -499,7 +499,7 @@ An unknown issue occurred while syncing the state of the [credential](../../../c Enum values: - - unknown_issue_with_acs_credential + - unknown_issue_with_acs_credential @@ -531,7 +531,7 @@ Access permissions for the [credential](../../../capability-guides/access-system Enum values: - - needs_to_be_reissued + - needs_to_be_reissued diff --git a/docs/api/acs/systems/README.md b/docs/api/acs/systems/README.md index 833a4b333..61100bdf8 100644 --- a/docs/api/acs/systems/README.md +++ b/docs/api/acs/systems/README.md @@ -164,7 +164,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab Enum values: - - seam_bridge_disconnected + - seam_bridge_disconnected --- @@ -197,7 +197,7 @@ Indicates that the Seam API cannot communicate with [Seam Bridge](../../../capab Enum values: - - bridge_disconnected + - bridge_disconnected --- @@ -237,7 +237,7 @@ Indicates that [Seam Bridge](../../../capability-guides/seam-bridge.md) is funct Enum values: - - visionline_instance_unreachable + - visionline_instance_unreachable --- @@ -269,7 +269,7 @@ Indicates that the maximum number of users allowed for the site has been reached Enum values: - - salto_ks_subscription_limit_exceeded + - salto_ks_subscription_limit_exceeded --- @@ -301,7 +301,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit Enum values: - - acs_system_disconnected + - acs_system_disconnected --- @@ -333,7 +333,7 @@ Indicates that the login credentials are invalid. Reconnect the account using a Enum values: - - account_disconnected + - account_disconnected --- @@ -365,7 +365,7 @@ Indicates that the [access control system](https://docs.seam.co/latest/capabilit Enum values: - - salto_ks_certification_expired + - salto_ks_certification_expired --- @@ -568,7 +568,7 @@ Indicates that the Salto KS site has exceeded 80% of the maximum number of allow Enum values: - - salto_ks_subscription_limit_almost_reached + - salto_ks_subscription_limit_almost_reached @@ -610,7 +610,7 @@ Indicates the [access control system](https://docs.seam.co/latest/capability-gui Enum values: - - time_zone_does_not_match_location + - time_zone_does_not_match_location diff --git a/docs/api/acs/users/README.md b/docs/api/acs/users/README.md index 9f904acb7..3a8838857 100644 --- a/docs/api/acs/users/README.md +++ b/docs/api/acs/users/README.md @@ -91,9 +91,7 @@ ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-system **`connected_account_id`** *UUID* - - The ID of the [connected account](../../../core-concepts/connected-accounts/README.md) that is associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). - +The ID of the [connected account](../../../core-concepts/connected-accounts/README.md) that is associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). @@ -166,7 +164,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce Enum values: - - deleted_externally + - deleted_externally --- @@ -196,7 +194,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce Enum values: - - salto_ks_subscription_limit_exceeded + - salto_ks_subscription_limit_exceeded --- @@ -226,7 +224,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce Enum values: - - failed_to_create_on_acs_system + - failed_to_create_on_acs_system --- @@ -256,7 +254,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce Enum values: - - failed_to_update_on_acs_system + - failed_to_update_on_acs_system --- @@ -286,7 +284,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce Enum values: - - failed_to_delete_on_acs_system + - failed_to_delete_on_acs_system --- @@ -316,7 +314,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce Enum values: - - latch_conflict_with_resident_user + - latch_conflict_with_resident_user --- @@ -430,7 +428,7 @@ Seam is in the process of pushing a user creation to the integrated access syste Enum values: - - creating + - creating @@ -460,7 +458,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste Enum values: - - deleting + - deleting @@ -478,6 +476,14 @@ Seam is in the process of pushing a user deletion to the integrated access syste **`from`** *Object* + Child Properties + + - email_address String + + - full_name String + + - phone_number String + --- @@ -494,7 +500,7 @@ Seam is in the process of pushing a user deletion to the integrated access syste Enum values: - - updating_user_information + - updating_user_information --- @@ -502,6 +508,14 @@ Seam is in the process of pushing a user deletion to the integrated access syste **`to`** *Object* + Child Properties + + - email_address String + + - full_name String + + - phone_number String +
@@ -520,6 +534,12 @@ Seam is in the process of pushing an access schedule update to the integrated ac **`from`** *Object* + Child Properties + + - ends_at Datetime + + - starts_at Datetime + --- @@ -536,7 +556,7 @@ Seam is in the process of pushing an access schedule update to the integrated ac Enum values: - - updating_access_schedule + - updating_access_schedule --- @@ -544,6 +564,12 @@ Seam is in the process of pushing an access schedule update to the integrated ac **`to`** *Object* + Child Properties + + - ends_at Datetime + + - starts_at Datetime +
@@ -562,6 +588,10 @@ Seam is in the process of pushing a suspension state update to the integrated ac **`from`** *Object* + Child Properties + + - is_suspended Boolean + --- @@ -578,7 +608,7 @@ Seam is in the process of pushing a suspension state update to the integrated ac Enum values: - - updating_suspension_state + - updating_suspension_state --- @@ -586,6 +616,10 @@ Seam is in the process of pushing a suspension state update to the integrated ac **`to`** *Object* + Child Properties + + - is_suspended Boolean +
@@ -606,6 +640,12 @@ Seam is in the process of pushing an access group membership update to the integ Old access group membership. + Child Properties + + - acs_access_group_id UUID + + Old access group ID. + --- @@ -622,7 +662,7 @@ Seam is in the process of pushing an access group membership update to the integ Enum values: - - updating_group_membership + - updating_group_membership --- @@ -632,6 +672,12 @@ Seam is in the process of pushing an access group membership update to the integ New access group membership. + Child Properties + + - acs_access_group_id UUID + + New access group ID. +
@@ -718,7 +764,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce Enum values: - - being_deleted + - being_deleted @@ -748,7 +794,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce Enum values: - - salto_ks_user_not_subscribed + - salto_ks_user_not_subscribed @@ -778,7 +824,7 @@ An unknown issue occurred while syncing the state of this [ACS user](https://doc Enum values: - - unknown_issue_with_acs_user + - unknown_issue_with_acs_user @@ -808,7 +854,7 @@ Indicates that the [ACS user](https://docs.seam.co/latest/capability-guides/acce Enum values: - - latch_resident_user + - latch_resident_user diff --git a/docs/api/phones/README.md b/docs/api/phones/README.md index 62b46243b..b5f41257c 100644 --- a/docs/api/phones/README.md +++ b/docs/api/phones/README.md @@ -35,7 +35,6 @@ Represents an app user's mobile phone. **`created_at`** *Datetime* Date and time at which the phone was created. - @@ -45,7 +44,6 @@ Date and time at which the phone was created. **`custom_metadata`** *Record* Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to-a-device.md) for the phone. - @@ -55,7 +53,6 @@ Optional [custom metadata](../../core-concepts/devices/adding-custom-metadata-to **`device_id`** *UUID* ID of the phone. - @@ -65,7 +62,6 @@ ID of the phone. **`device_type`** *Enum* Device type for phones. -
@@ -81,7 +77,6 @@ Device type for phones. **`display_name`** *String* Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. - @@ -105,7 +100,6 @@ Errors associated with the phone. **`nickname`** *String* Optional nickname to describe the phone, settable through Seam. - @@ -129,7 +123,6 @@ Warnings associated with the phone. **`workspace_id`** *UUID* ID of the [workspace](../../core-concepts/workspaces/README.md) that contains the phone. - diff --git a/src/layouts/partials/property-content.hbs b/src/layouts/partials/property-content.hbs index 240a52e1e..7708b6a2b 100644 --- a/src/layouts/partials/property-content.hbs +++ b/src/layouts/partials/property-content.hbs @@ -10,9 +10,9 @@ Enum values: - {{#each enumValues}} - - {{this}} - {{/each}} +{{#each enumValues}} +- {{this}} +{{/each}} {{/if}} {{#if value}} @@ -24,3 +24,15 @@ Value: `{{value}}` - {{> property-nested this}} {{/each}} {{/if}} +{{#unless (eq objectProperties undefined)}} +{{#if (eq objectProperties.length 0)}} + +This object has no properties. +{{else}} +Child Properties + +{{#each objectProperties}} +- {{> property-nested this}} +{{/each}} +{{/if}} +{{/unless}} diff --git a/src/lib/layout/api-route.ts b/src/lib/layout/api-route.ts index 68bb9a6e5..692813bc8 100644 --- a/src/lib/layout/api-route.ts +++ b/src/lib/layout/api-route.ts @@ -242,7 +242,7 @@ export const mapBlueprintPropertyToRouteProperty = ( const { name, description, format, isDeprecated, deprecationMessage } = prop const contextRouteProp: ApiRouteProperty = { name, - description, + description: description.trim(), isDeprecated, deprecationMessage, format: normalizePropertyFormatForDocs(format),