Skip to content

Commit 8a1eeec

Browse files
committed
ci: Generate docs
1 parent 89440b4 commit 8a1eeec

File tree

7 files changed

+4047
-974
lines changed

7 files changed

+4047
-974
lines changed

docs/api/_blueprint.json

Lines changed: 3995 additions & 964 deletions
Large diffs are not rendered by default.

docs/api/_report.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,16 @@ These items are intentionally undocumented.
3434
- `/networks`: No undocumented message provided
3535
- `/seam/bridge/v1/bridge_client_sessions`: No undocumented message provided
3636
- `/seam/bridge/v1/bridge_connected_systems`: No undocumented message provided
37+
- `/seam/customer/v1/portals`: No undocumented message provided
38+
- `/seam/customer/v1/settings`: No undocumented message provided
3739
- `/seam/instant_key/v1/client_sessions`: No undocumented message provided
3840
- `/seam/mobile_sdk/v1/acs/credentials`: No undocumented message provided
3941
- `/seam/mobile_sdk/v1/phone_sessions`: No undocumented message provided
4042
- `/seam/partner/v1/building_blocks/spaces`: No undocumented message provided
41-
- `/seam/partner/v1/resources`: No undocumented message provided
4243
- `/unstable_access_grants`: No undocumented message provided
4344
- `/unstable_access_methods`: No undocumented message provided
4445
- `/unstable_locations`: No undocumented message provided
4546
- `/unstable_partner/building_blocks`: No undocumented message provided
46-
- `/unstable_partner/resources`: No undocumented message provided
4747

4848
### Resources
4949

@@ -54,7 +54,6 @@ These items are intentionally undocumented.
5454
- `instant_key`: Unreleased.
5555
- `location`: Will be removed.
5656
- `magic_link`: Unreleased.
57-
- `partner_resource`: Unreleased.
5857
- `phone_session`: Seam Mobile SDK only.
5958
- `unmanaged_acs_access_group`: Unreleased.
6059
- `unmanaged_acs_credential`: Unreleased.
@@ -71,11 +70,11 @@ These items are intentionally undocumented.
7170
### Namespaces
7271

7372
- `/seam/bridge/v1`: No undocumented message provided
73+
- `/seam/customer/v1`: No undocumented message provided
7474
- `/seam/instant_key/v1`: No undocumented message provided
7575
- `/seam/mobile_sdk/v1/acs`: No undocumented message provided
7676
- `/seam/mobile_sdk/v1`: No undocumented message provided
7777
- `/seam/partner/v1/building_blocks`: No undocumented message provided
78-
- `/seam/partner/v1`: No undocumented message provided
7978
- `/unstable_partner`: No undocumented message provided
8079

8180
### Endpoints
@@ -102,11 +101,12 @@ These items are intentionally undocumented.
102101
- `/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code`: Seam Bridge Client only.
103102
- `/seam/bridge/v1/bridge_client_sessions/report_status`: Seam Bridge Client only.
104103
- `/seam/bridge/v1/bridge_connected_systems/list`: Seam Bridge Client only.
104+
- `/seam/customer/v1/portals/get`: Internal endpoint for customer portals.
105+
- `/seam/customer/v1/settings/update`: Internal endpoint for customer portals.
105106
- `/seam/instant_key/v1/client_sessions/exchange_short_code`: Seam Instant Key only.
106107
- `/seam/mobile_sdk/v1/acs/credentials/list`: Mobile SDK only.
107108
- `/seam/mobile_sdk/v1/phone_sessions/get_or_create`: Mobile SDK only.
108109
- `/seam/partner/v1/building_blocks/spaces/auto_map`: Partner building blocks/UI only.
109-
- `/seam/partner/v1/resources/list`: Partner building blocks/UI only.
110110
- `/thermostats/get`: Will be removed.
111111
- `/unstable_access_grants/create`: Unreleased.
112112
- `/unstable_access_grants/delete`: Unreleased.
@@ -128,7 +128,6 @@ These items are intentionally undocumented.
128128
- `/unstable_partner/building_blocks/generate_magic_link`: Experimental partner building blocks.
129129
- `/unstable_partner/building_blocks/manage_devices`: Experimental partner building blocks.
130130
- `/unstable_partner/building_blocks/organize_spaces`: Experimental partner building blocks.
131-
- `/unstable_partner/resources/push`: Experimental partner resources.
132131

133132
### Endpoint parameters
134133

@@ -336,6 +335,9 @@ Items that are intentionally undocumented are not included in this section.
336335
- `sync`
337336
- `/connected_accounts/list`
338337
- `customer_ids`
338+
- `/customers/create_portal`
339+
- `features`
340+
- `customer_data`
339341
- `/devices/list`
340342
- `customer_ids`
341343
- `exclude_if`
@@ -439,6 +441,7 @@ These items are deprecated.
439441

440442
- `acs_credential_pool`: Not used.
441443
- `acs_credential_provisioning_automation`: Not used.
444+
- `enrollment_automation`: Will be removed. Instead, link the `user_identity` to the `acs_user` in the access system in which you want to issue credentials.
442445

443446
### Resource properties
444447

@@ -528,6 +531,7 @@ These items are deprecated.
528531
- `/bridges/list`: `bridges`
529532
- `/networks/get`: `network`
530533
- `/networks/list`: `networks`
534+
- `/seam/customer/v1/portals/get`: `customer_portal`
531535
- `/seam/partner/v1/building_blocks/spaces/auto_map`: `spaces`
532536

533537
### Endpoints without code samples
@@ -581,6 +585,8 @@ These items are deprecated.
581585
- `/connect_webviews/delete`
582586
- `/connect_webviews/get`
583587
- `/connect_webviews/list`
588+
- `/customers/create_portal`
589+
- `/customers/push_data`
584590
- `/devices/get`
585591
- `/devices/list`
586592
- `/devices/list_device_providers`

docs/api/access_codes/create.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https
8080

8181
**`name`** *String*
8282

83-
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
83+
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
84+
85+
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
86+
87+
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
88+
89+
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
8490

8591
---
8692

docs/api/access_codes/create_multiple.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https
8888

8989
**`name`** *String*
9090

91-
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
91+
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
92+
93+
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
94+
95+
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
96+
97+
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
9298

9399
---
94100

docs/api/access_codes/update.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,13 @@ Maximum rounding adjustment. To create a daily-bound [offline access code](https
8888

8989
**`name`** *String*
9090

91-
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
91+
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
92+
93+
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
94+
95+
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
96+
97+
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
9298

9399
---
94100

docs/api/access_codes/update_multiple.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,13 @@ Date and time at which the validity of the new access code ends, in [ISO 8601](h
3838

3939
**`name`** *String*
4040

41-
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
41+
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
42+
43+
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
44+
45+
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
46+
47+
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
4248

4349
---
4450

docs/api/thermostats/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,9 @@ A thermostat device resource.
352352

353353
Active [thermostat schedule](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
354354

355+
{% hint style="warning" %}
356+
**Deprecated**. Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.
357+
{% endhint %}
355358

356359

357360
<details>
@@ -413,6 +416,15 @@ Active [thermostat schedule](../../capability-guides/thermostats/creating-and-ma
413416

414417
</details>
415418

419+
---
420+
421+
**`active_thermostat_schedule_id`** *UUID*
422+
423+
ID of the active [thermostat schedule](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md).
424+
425+
426+
427+
416428
---
417429

418430
**`available_climate_presets`** *List* *of Objects*

0 commit comments

Comments
 (0)