Skip to content

Commit 2e17184

Browse files
razor-xseambot
andauthored
Remove example value placeholders (#629)
* Remove example value placeholders * ci: Generate docs --------- Co-authored-by: Seam Bot <seambot@getseam.com>
1 parent 7363e54 commit 2e17184

File tree

13 files changed

+0
-288
lines changed

13 files changed

+0
-288
lines changed

docs/api/access_codes/README.md

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -17,36 +17,6 @@ Seam supports programming two types of access codes: [ongoing](https://docs.seam
1717

1818
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.
1919

20-
{% tabs %}
21-
{% tab title="JSON" %}
22-
```json
23-
{
24-
access_code_id: [example value],
25-
code: [example value],
26-
common_code_key: [example value],
27-
created_at: [example value],
28-
device_id: [example value],
29-
ends_at: [example value],
30-
errors: [example value],
31-
is_backup: [example value],
32-
is_backup_access_code_available: [example value],
33-
is_external_modification_allowed: [example value],
34-
is_managed: [example value],
35-
is_offline_access_code: [example value],
36-
is_one_time_use: [example value],
37-
is_scheduled_on_device: [example value],
38-
is_waiting_for_code_assignment: [example value],
39-
name: [example value],
40-
pulled_backup_access_code_id: [example value],
41-
starts_at: [example value],
42-
status: [example value],
43-
type: [example value],
44-
warnings: [example value]
45-
}
46-
```
47-
{% endtab %}
48-
{% endtabs %}
49-
5020
---
5121
## Properties
5222

docs/api/access_codes/unmanaged/README.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,6 @@ Not all providers support unmanaged access codes. The following providers do not
2121

2222
- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks)
2323

24-
{% tabs %}
25-
{% tab title="JSON" %}
26-
```json
27-
{
28-
access_code_id: [example value],
29-
code: [example value],
30-
created_at: [example value],
31-
device_id: [example value],
32-
ends_at: [example value],
33-
errors: [example value],
34-
is_managed: [example value],
35-
name: [example value],
36-
starts_at: [example value],
37-
status: [example value],
38-
type: [example value],
39-
warnings: [example value]
40-
}
41-
```
42-
{% endtab %}
43-
{% endtabs %}
44-
4524
---
4625
## Properties
4726

docs/api/acs/access_groups/README.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,6 @@ Some access control systems use [access group](https://docs.seam.co/latest/capab
1515

1616
To learn whether your access control system supports access groups, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems).
1717

18-
{% tabs %}
19-
{% tab title="JSON" %}
20-
```json
21-
{
22-
access_group_type: [example value],
23-
access_group_type_display_name: [example value],
24-
acs_access_group_id: [example value],
25-
acs_system_id: [example value],
26-
created_at: [example value],
27-
display_name: [example value],
28-
external_type: [example value],
29-
external_type_display_name: [example value],
30-
is_managed: [example value],
31-
name: [example value],
32-
warnings: [example value],
33-
workspace_id: [example value]
34-
}
35-
```
36-
{% endtab %}
37-
{% endtabs %}
38-
3918
---
4019
## Properties
4120

docs/api/acs/credentials/README.md

Lines changed: 0 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -15,41 +15,6 @@ An access control system generally uses digital means of access to authorize a u
1515

1616
For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
1717

18-
{% tabs %}
19-
{% tab title="JSON" %}
20-
```json
21-
{
22-
access_method: [example value],
23-
acs_credential_id: [example value],
24-
acs_credential_pool_id: [example value],
25-
acs_system_id: [example value],
26-
acs_user_id: [example value],
27-
assa_abloy_vostio_metadata: [example value],
28-
card_number: [example value],
29-
code: [example value],
30-
created_at: [example value],
31-
display_name: [example value],
32-
ends_at: [example value],
33-
errors: [example value],
34-
external_type: [example value],
35-
external_type_display_name: [example value],
36-
is_issued: [example value],
37-
is_latest_desired_state_synced_with_provider: [example value],
38-
is_managed: [example value],
39-
is_multi_phone_sync_credential: [example value],
40-
is_one_time_use: [example value],
41-
issued_at: [example value],
42-
latest_desired_state_synced_with_provider_at: [example value],
43-
parent_acs_credential_id: [example value],
44-
starts_at: [example value],
45-
visionline_metadata: [example value],
46-
warnings: [example value],
47-
workspace_id: [example value]
48-
}
49-
```
50-
{% endtab %}
51-
{% endtabs %}
52-
5318
---
5419
## Properties
5520

docs/api/acs/encoders/README.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,6 @@ Separately, the Seam API also supports card scanning, which enables you to scan
2424

2525
To verify if your access control system requires a card encoder, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems).
2626

27-
{% tabs %}
28-
{% tab title="JSON" %}
29-
```json
30-
{
31-
acs_encoder_id: [example value],
32-
acs_system_id: [example value],
33-
created_at: [example value],
34-
display_name: [example value],
35-
errors: [example value],
36-
workspace_id: [example value]
37-
}
38-
```
39-
{% endtab %}
40-
{% endtabs %}
41-
4227
---
4328
## Properties
4429

docs/api/acs/entrances/README.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,6 @@ Represents an [entrance](../../../capability-guides/access-systems/retrieving-en
1313

1414
In an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.
1515

16-
{% tabs %}
17-
{% tab title="JSON" %}
18-
```json
19-
{
20-
acs_entrance_id: [example value],
21-
acs_system_id: [example value],
22-
assa_abloy_vostio_metadata: [example value],
23-
created_at: [example value],
24-
display_name: [example value],
25-
dormakaba_community_metadata: [example value],
26-
errors: [example value],
27-
latch_metadata: [example value],
28-
salto_ks_metadata: [example value],
29-
salto_space_metadata: [example value],
30-
visionline_metadata: [example value]
31-
}
32-
```
33-
{% endtab %}
34-
{% endtabs %}
35-
3616
---
3717
## Properties
3818

docs/api/acs/systems/README.md

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -36,35 +36,6 @@ For details about the resources associated with an access control system, see th
3636
{% endtab %}
3737
{% endtabs %}
3838

39-
{% tabs %}
40-
{% tab title="JSON" %}
41-
```json
42-
{
43-
acs_access_group_count: [example value],
44-
acs_system_id: [example value],
45-
acs_user_count: [example value],
46-
connected_account_id: [example value],
47-
connected_account_ids: [example value],
48-
created_at: [example value],
49-
default_credential_manager_acs_system_id: [example value],
50-
errors: [example value],
51-
external_type: [example value],
52-
external_type_display_name: [example value],
53-
image_alt_text: [example value],
54-
image_url: [example value],
55-
is_credential_manager: [example value],
56-
location: [example value],
57-
name: [example value],
58-
system_type: [example value],
59-
system_type_display_name: [example value],
60-
visionline_metadata: [example value],
61-
warnings: [example value],
62-
workspace_id: [example value]
63-
}
64-
```
65-
{% endtab %}
66-
{% endtabs %}
67-
6839
---
6940
## Properties
7041

docs/api/acs/users/README.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -15,38 +15,6 @@ An `acs_user` typically refers to an individual who requires access, like an emp
1515

1616
For details about how to configure `acs_user`s in your access control system, see the corresponding [system integration guide](../../../device-and-system-integration-guides/overview.md#access-control-systems).
1717

18-
{% tabs %}
19-
{% tab title="JSON" %}
20-
```json
21-
{
22-
access_schedule: [example value],
23-
acs_system_id: [example value],
24-
acs_user_id: [example value],
25-
connected_account_id: [example value],
26-
created_at: [example value],
27-
display_name: [example value],
28-
email: [example value],
29-
email_address: [example value],
30-
errors: [example value],
31-
external_type: [example value],
32-
external_type_display_name: [example value],
33-
full_name: [example value],
34-
hid_acs_system_id: [example value],
35-
is_managed: [example value],
36-
is_suspended: [example value],
37-
pending_mutations: [example value],
38-
phone_number: [example value],
39-
user_identity_email_address: [example value],
40-
user_identity_full_name: [example value],
41-
user_identity_id: [example value],
42-
user_identity_phone_number: [example value],
43-
warnings: [example value],
44-
workspace_id: [example value]
45-
}
46-
```
47-
{% endtab %}
48-
{% endtabs %}
49-
5018
---
5119
## Properties
5220

docs/api/phones/README.md

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,6 @@
1111

1212
Represents an app user's mobile phone.
1313

14-
{% tabs %}
15-
{% tab title="JSON" %}
16-
```json
17-
{
18-
created_at: [example value],
19-
custom_metadata: [example value],
20-
device_id: [example value],
21-
device_type: [example value],
22-
display_name: [example value],
23-
errors: [example value],
24-
nickname: [example value],
25-
warnings: [example value],
26-
workspace_id: [example value]
27-
}
28-
```
29-
{% endtab %}
30-
{% endtabs %}
31-
3214
---
3315
## Properties
3416

docs/api/thermostats/schedules/README.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,6 @@
1111

1212
Represents a [thermostat schedule](../../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md) that activates a configured [climate preset](../../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.
1313

14-
{% tabs %}
15-
{% tab title="JSON" %}
16-
```json
17-
{
18-
climate_preset_key: [example value],
19-
created_at: [example value],
20-
device_id: [example value],
21-
ends_at: [example value],
22-
errors: [example value],
23-
is_override_allowed: [example value],
24-
max_override_period_minutes: [example value],
25-
name: [example value],
26-
starts_at: [example value],
27-
thermostat_schedule_id: [example value],
28-
workspace_id: [example value]
29-
}
30-
```
31-
{% endtab %}
32-
{% endtabs %}
33-
3414
---
3515
## Properties
3616

0 commit comments

Comments
 (0)