Merge branch 'main' of github.com:seamapi/docs into auth-methods

docs/SUMMARY.md

@@ -56,6 +56,9 @@
   * [Managing Credentials](capability-guides/access-systems/managing-credentials.md)
     * [Assigning Credentials to ACS Users](capability-guides/access-systems/assigning-credentials-to-users.md)
     * [Listing Credentials and Associated Entrances](capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md)
+  * [Working with Card Encoders and Scanners](capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md)
+    * [Creating and Encoding Card-based Credentials](capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md)
+    * [Scanning Encoded Cards](capability-guides/access-systems/working-with-card-encoders-and-scanners/scanning-encoded-cards.md)
   * [Troubleshooting Your Access Control System](capability-guides/access-systems/troubleshooting-your-access-control-system.md)
 * [📱 Mobile Access](products/mobile-access-in-development/README.md)
   * [Prepare your Workspace](products/mobile-access-in-development/mobile-access-setup.md)
@@ -321,6 +324,7 @@
   * [Common Use Cases](device-guides/assa-abloy-visionline-access-control-system-in-development/common-use-cases.md)
   * [Special Requirements for Android Mobile Access SDK Development](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/special-requirements-for-android-mobile-access-sdk-development.md)
   * [Special Requirements for iOS Mobile Access SDK Development](device-and-system-integration-guides/assa-abloy-visionline-access-control-system/special-requirements-for-ios-mobile-access-sdk-development.md)
+  * [Creating Visionline Card-based Credentials](device-and-system-integration-guides/assa-abloy-visionline-access-control-system-in-development/creating-visionline-card-based-credentials.md)
 * [August Locks](device-guides/august-locks.md)
   * [Get started with August locks](device-guides/get-started-with-august-locks.md)
 * [Avigilon Alta Access System](device-guides/avigilon-alta-access-system.md)

docs/api/_report.md

@@ -214,6 +214,7 @@ Items that are intentionally undocumented are not included in this section.
 - `acs_entrance.errors`
 - `acs_entrance.latch_metadata`
 - `acs_entrance.salto_ks_metadata`
+- `acs_entrance.salto_space_metadata`
 - `acs_entrance.visionline_metadata`
 - `acs_system.location`
 - `acs_system.system_type`
@@ -750,8 +751,6 @@ Items that are intentionally undocumented are not included in this section.
     - `user_identity_id`
 - `/thermostats/cool`
     - `sync`
-- `/thermostats/create_climate_preset`
-    - `manual_override_allowed`
 - `/thermostats/heat`
     - `sync`
 - `/thermostats/heat_cool`
@@ -765,10 +764,6 @@ Items that are intentionally undocumented are not included in this section.
     - `device_id`
     - `fan_mode`
     - `sync`
-- `/thermostats/schedules/create`
-    - `is_override_allowed`
-- `/thermostats/schedules/update`
-    - `is_override_allowed`
 - `/user_identities/list`
     - `credential_manager_acs_system_id`
 - `/user_identities/update`
@@ -821,6 +816,8 @@ These items are deprecated.
     - `email`: use email_address.
 - `/acs/users/update`
     - `email`: use email_address.
+- `/thermostats/create_climate_preset`
+    - `manual_override_allowed`: Use 'thermostat_schedule.is_override_allowed'
 - `/thermostats/set_fan_mode`
     - `fan_mode`: Use `fan_mode_setting` instead.
 - `/thermostats/update_climate_preset`

docs/api/acs/entrances/README.md

@@ -69,6 +69,12 @@ Format: `Object`
 <details>
 <summary>access_point_name <code>string</code></summary>
 </details>
+<details>
+<summary>common_area_number <code>number</code></summary>
+</details>
+<details>
+<summary>inner_access_points_names <code>list</code></summary>
+</details>
 
 ---
 
@@ -129,6 +135,22 @@ Format: `Object`
 
 ---
 
+### `salto_space_metadata`
+
+Format: `Object`
+
+<details>
+<summary>door_description <code>string</code></summary>
+</details>
+<details>
+<summary>door_name <code>string</code></summary>
+</details>
+<details>
+<summary>ext_door_id <code>string</code></summary>
+</details>
+
+---
+
 ### `visionline_metadata`
 
 Format: `Object`

docs/api/thermostats/create_climate_preset.md

@@ -224,7 +224,7 @@ Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat
 Type: `boolean`
 Required: No
 
-
+Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
 
 ***
 

docs/api/thermostats/schedules/create.md

@@ -206,7 +206,7 @@ Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.i
 Type: `boolean`
 Required: No
 
-
+Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
 
 ***
 
@@ -215,7 +215,7 @@ Required: No
 Type: `number`
 Required: No
 
-Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
 
 ***
 

docs/api/thermostats/schedules/update.md

@@ -148,7 +148,7 @@ Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.i
 Type: `boolean`
 Required: No
 
-
+Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
 
 ***
 
@@ -157,7 +157,7 @@ Required: No
 Type: `number`
 Required: No
 
-Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
+Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
 
 ***
 

docs/capability-guides/access-systems/managing-credentials.md

@@ -4,7 +4,7 @@ description: Learn how to manage credentials and assign them to users.
 
 # Managing Credentials
 
-An ACS generally uses digital means of access to authorize an [ACS user](../../products/access-systems/user-management.md) trying to get through a specific entrance. Examples of credentials include RFID cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
+An ACS generally uses digital means of access to authorize an [ACS user](../../products/access-systems/user-management.md) trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
 
 <figure><img src="../../.gitbook/assets/acs-credential-types.png" alt="Examples of ACS user credentials"><figcaption><p>Examples of ACS user credentials</p></figcaption></figure>
 
@@ -21,7 +21,7 @@ You can assign a credential to an ACS user when you create the credential. You c
 To [create a credential for an ACS user](../../api/acs/credentials/create.md), provide the `acs_user_id` and the desired `access_method`. Seam supports the following access methods:
 
 * `code` for a PIN code-based credential
-* `card` for a key card-based credential
+* `card` for a plastic key card-based credential
 * `mobile_key` for a [Seam mobile key](../../products/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system.md#what-are-multi-phone-sync-credentials).
 
 Depending on the ACS and the type of credential you are issuing, you can also specify the following properties for the new credential:
@@ -38,6 +38,10 @@ Make sure to note any manufacturer-specific metadata and restrictions. For detai
 
 The response includes the `acs_credential_id` of the newly-created credential, the `acs_user_id` associated with the credential, and additional attributes of the credential.
 
+{% hint style="info" %}
+If you are creating card-based credentials, and your ACS requires card encoding, see also [Creating and Encoding Card-based Credentials](working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md).
+{% endhint %}
+
 ***
 
 ### Create a PIN Code-based Credential
@@ -231,7 +235,9 @@ credential, uErr := client.Acs.Credentials.Create(
 
 ***
 
-### Create a Key Card-based Credential
+### Create a Card-based Credential
+
+To create a plastic key card-based credential, set the `access_method` to `card`. Once you've created a credential, some access control systems require you to encode the card with the credential. To learn whether your ACS requires card encoding, see the [system integration guide](../../device-and-system-integration-guides/overview.md#access-control-systems) for your ACS. For card encoding instructions, see [Creating and Encoding Card-based Credentials](working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md).
 
 {% tabs %}
 {% tab title="Python" %}

docs/capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md

@@ -0,0 +1,24 @@
+---
+description: Learn how to encode plastic cards and then scan these cards.
+---
+
+# Working with Card Encoders and Scanners
+
+<figure><img src="../../../.gitbook/assets/card-scanner.png" alt=""><figcaption></figcaption></figure>
+
+Some access control systems require credentials to be [encoded onto plastic key cards](creating-and-encoding-card-based-credentials.md) using a card encoder. This process involves the following two key steps:
+
+1.  Credential creation
+
+    Configure the access parameters for the credential.
+2.  Card encoding
+
+    Write the credential data onto the card using a compatible card encoder.
+
+Separately, the Seam API also supports [card scanning](scanning-encoded-cards.md), which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with ACS records or diagnose discrepancies if needed.
+
+To verify if your ACS requires a card encoder, see the [system integration guide](../../../products/access-systems/) for your ACS.
+
+***
+
+<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Creating and Encoding Card-based Credentials</strong></td><td></td><td></td><td><a href="creating-and-encoding-card-based-credentials.md">creating-and-encoding-card-based-credentials.md</a></td><td><a href="../../../.gitbook/assets/encode-card.png">encode-card.png</a></td></tr><tr><td><strong>Scanning Encoded Cards</strong></td><td></td><td></td><td></td><td><a href="../../../.gitbook/assets/scan-card.png">scan-card.png</a></td></tr></tbody></table>