Skip to content

Update types to v1.411.1 #640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
968 changes: 681 additions & 287 deletions docs/api/_blueprint.json

Large diffs are not rendered by default.

132 changes: 8 additions & 124 deletions docs/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,6 @@
- `/webhooks`
- `/workspaces`

### Endpoints

- `/webhooks/create`
- `/webhooks/delete`
- `/webhooks/get`
- `/webhooks/list`
- `/webhooks/update`
- `/workspaces/create`
- `/workspaces/get`
- `/workspaces/list`
- `/workspaces/reset_sandbox`
- `/workspaces/update`

## Undocumented

These items are intentionally undocumented.
Expand Down Expand Up @@ -103,7 +90,7 @@ These items are intentionally undocumented.
- `/locks/simulate/manual_lock_via_keypad`: Unreleased.
- `/networks/get`: Deprecated.
- `/networks/list`: Deprecated.
- `/seam/bridge/v1/bridge_client_sessions/create`: Seam Bridge Client only.
- `/seam/bridge/v1/bridge_client_sessions/create`: Seam Bridge client only.
- `/seam/bridge/v1/bridge_client_sessions/get`: Seam Bridge Client only.
- `/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token`: Seam Bridge Client only.
- `/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code`: Seam Bridge Client only.
Expand Down Expand Up @@ -198,6 +185,8 @@ Items that are intentionally undocumented are not included in this section.

### Resources

- `access_grant`
- `access_method`
- `acs_credential_pool`
- `acs_credential_provisioning_automation`
- `device_provider`
Expand All @@ -211,6 +200,7 @@ Items that are intentionally undocumented are not included in this section.

### Resource properties

- `access_grant.location_ids`
- `acs_access_group.access_group_type`
- `acs_access_group.access_group_type_display_name`
- `acs_access_group.display_name`
Expand Down Expand Up @@ -331,16 +321,6 @@ Items that are intentionally undocumented are not included in this section.

- `/networks/get`
- `/networks/list`
- `/user_identities/update`
- `/webhooks/create`
- `/webhooks/delete`
- `/webhooks/get`
- `/webhooks/list`
- `/webhooks/update`
- `/workspaces/create`
- `/workspaces/get`
- `/workspaces/list`
- `/workspaces/update`

### Endpoint parameters

Expand Down Expand Up @@ -426,42 +406,6 @@ Items that are intentionally undocumented are not included in this section.
- `sync`
- `/noise_sensors/noise_thresholds/update`
- `sync`
- `/seam/bridge/v1/bridge_client_sessions/create`
- `bridge_client_machine_identifier_key`
- `bridge_client_name`
- `bridge_client_time_zone`
- `/seam/bridge/v1/bridge_client_sessions/report_status`
- `is_tailscale_connected`
- `tailscale_ip_v4`
- `/seam/mobile_sdk/v1/phone_sessions/get_or_create`
- `custom_sdk_installation_id`
- `phone_device_metadata`
- `phone_os`
- `/seam/partner/v1/building_blocks/spaces/auto_map`
- `collection_key`
- `/spaces/add_acs_entrances`
- `acs_entrance_ids`
- `space_id`
- `/spaces/add_devices`
- `device_ids`
- `space_id`
- `/spaces/create`
- `acs_entrance_ids`
- `device_ids`
- `name`
- `/spaces/delete`
- `space_id`
- `/spaces/get`
- `space_id`
- `/spaces/remove_acs_entrances`
- `acs_entrance_ids`
- `space_id`
- `/spaces/remove_devices`
- `device_ids`
- `space_id`
- `/spaces/update`
- `name`
- `space_id`
- `/thermostats/cool`
- `sync`
- `/thermostats/heat`
Expand All @@ -485,87 +429,23 @@ Items that are intentionally undocumented are not included in this section.
- `requested_access_methods`
- `/unstable_access_grants/list`
- `location_id`
- `/unstable_locations/add_acs_entrances`
- `acs_entrance_ids`
- `location_id`
- `/unstable_locations/add_devices`
- `device_ids`
- `location_id`
- `/unstable_locations/create`
- `acs_entrance_ids`
- `device_ids`
- `geolocation`
- `name`
- `time_zone`
- `/unstable_locations/delete`
- `location_id`
- `/unstable_locations/get`
- `location_id`
- `/unstable_locations/remove_acs_entrances`
- `acs_entrance_ids`
- `location_id`
- `/unstable_locations/remove_devices`
- `device_ids`
- `location_id`
- `/unstable_locations/update`
- `geolocation`
- `location_id`
- `name`
- `time_zone`
- `/unstable_partner/building_blocks/connect_accounts`
- `customer_key`
- `/unstable_partner/building_blocks/generate_magic_link`
- `building_block_type`
- `customer_key`
- `/unstable_partner/building_blocks/manage_devices`
- `customer_key`
- `/unstable_partner/building_blocks/organize_spaces`
- `customer_key`
- `partner_resources`
- `/unstable_partner/resources/push`
- `custom_metadata`
- `customer_key`
- `description`
- `email_address`
- `ends_at`
- `location_keys`
- `name`
- `partner_resource_key`
- `partner_resource_type`
- `phone_number`
- `starts_at`
- `user_identity_key`
- `/user_identities/get`
- `user_identity_key`
- `/user_identities/list`
- `credential_manager_acs_system_id`
- `/user_identities/update`
- `full_name`
- `/webhooks/create`
- `event_types`
- `url`
- `/webhooks/delete`
- `webhook_id`
- `/webhooks/get`
- `webhook_id`
- `/webhooks/update`
- `event_types`
- `webhook_id`
- `/workspaces/create`
- `company_name`
- `connect_partner_name`
- `connect_webview_customization`
- `is_sandbox`
- `name`
- `webview_logo_shape`
- `webview_primary_button_color`
- `webview_primary_button_text_color`
- `webview_success_message`
- `/workspaces/update`
- `connect_partner_name`
- `connect_webview_customization`
- `is_suspended`
- `name`

## Draft

Expand All @@ -575,6 +455,7 @@ These items have been marked as draft.

- `/access_grants`: No draft message provided
- `/access_methods`: No draft message provided
- `/spaces`: No draft message provided

### Endpoints

Expand All @@ -588,6 +469,8 @@ These items have been marked as draft.
- `/spaces/add_acs_entrances`: Early access.
- `/spaces/add_devices`: Early access.
- `/spaces/create`: Early access.
- `/spaces/delete`: Early access.
- `/spaces/get`: Early access.
- `/spaces/list`: Early access.
- `/spaces/remove_acs_entrances`: Early access.
- `/spaces/remove_devices`: Early access.
Expand All @@ -599,6 +482,7 @@ These items are deprecated.

### Resource properties

- `access_grant.location_ids`: Use `space_ids`.
- `acs_access_group.access_group_type`: Use `external_type`.
- `acs_access_group.access_group_type_display_name`: Use `external_type_display_name`.
- `acs_system.connected_account_ids`: Use `connected_account_id`.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/_summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
* [Update a Connected Account](api/connected_accounts/update.md)
* [Phones](api/phones/README.md)
* [Deactivate a Phone](api/phones/deactivate.md)
* [Get Phone](api/phones/get.md)
* [Get a Phone](api/phones/get.md)
* [List Phones](api/phones/list.md)
* [Phone Simulations](api/phones/simulate/README.md)
* [Create a Sandbox Phone](api/phones/simulate/create_sandbox_phone.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/api/phones/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,11 +163,11 @@ Deactivates a phone, which is useful, for example, if a user has lost their phon

[**`/phones/get`**](./get.md)

Returns a single phone entry matching the provided `device_id`.
Returns a specified [phone](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md).


[**`/phones/list`**](./list.md)

Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
Returns a list of all [phones](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.


2 changes: 1 addition & 1 deletion docs/api/phones/deactivate.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

**`device_id`** *String* (Required)

Device ID of the desired phone.
Device ID of the phone that you want to deactivate.

---

Expand Down
6 changes: 3 additions & 3 deletions docs/api/phones/get.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Get Phone
# Get a Phone

- [Request Parameters](./#request-parameters)
- [Response](./#response)
- [Examples](./#examples)

Returns a single phone entry matching the provided `device_id`.
Returns a specified [phone](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md).


<details>
Expand All @@ -22,7 +22,7 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

**`device_id`** *String* (Required)

Device ID of the desired phone.
Device ID of the phone that you want to get.

---

Expand Down
6 changes: 3 additions & 3 deletions docs/api/phones/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [Response](./#response)
- [Examples](./#examples)

Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
Returns a list of all [phones](../../capability-guides/mobile-access/managing-phones-for-a-user-identity.md). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.


<details>
Expand All @@ -22,13 +22,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

**`acs_credential_id`** *String*

ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which to filter the list of returned phones.
ID of the [credential](../../capability-guides/access-systems/managing-credentials.md) by which you want to filter the list of returned phones.

---

**`owner_user_identity_id`** *String*

ID of the user identity that represents the owner by which to filter the list of returned phones.
ID of the user identity that represents the owner by which you want to filter the list of returned phones.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/api/phones/simulate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@

[**`/phones/simulate/create_sandbox_phone`**](./create_sandbox_phone.md)

Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity).
Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity).


10 changes: 5 additions & 5 deletions docs/api/phones/simulate/create_sandbox_phone.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [Response](./#response)
- [Examples](./#examples)

Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity).
Creates a new simulated phone in a [sandbox workspace](../../../core-concepts/workspaces/README.md#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](../../../capability-guides/mobile-access/developing-in-a-sandbox-workspace.md#creating-a-simulated-phone-for-a-user-identity).


<details>
Expand All @@ -22,13 +22,13 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati

**`user_identity_id`** *String* (Required)

ID of the user identity to associate with the simulated phone.
ID of the user identity that you want to associate with the simulated phone.

---

**`assa_abloy_metadata`** *Object*

ASSA ABLOY metadata to associate with the simulated phone.
ASSA ABLOY metadata that you want to associate with the simulated phone.

<details>

Expand Down Expand Up @@ -103,13 +103,13 @@ ID of the SEOS trusted service manager (TSM) endpoint that you want to use for t

**`custom_sdk_installation_id`** *String*

ID of the custom SDK installation to use for the simulated phone.
ID of the custom SDK installation that you want to use for the simulated phone.

---

**`phone_metadata`** *Object*

Metadata to associate with the simulated phone.
Metadata that you want to associate with the simulated phone.

<details>

Expand Down
4 changes: 2 additions & 2 deletions docs/api/thermostats/cool.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,13 +210,13 @@ ID of the thermostat device that you want to set to cool mode.

**`cooling_set_point_celsius`** *Number*

Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `cooling_set_point` parameters.
[Cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.

---

**`cooling_set_point_fahrenheit`** *Number*

Desired [cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `cooling_set_point` parameters.
[Cooling set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.

---

Expand Down
4 changes: 2 additions & 2 deletions docs/api/thermostats/heat.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,13 +210,13 @@ ID of the thermostat device that you want to set to heat mode.

**`heating_set_point_celsius`** *Number*

Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C. You must set one of the `heating_set_point` parameters.
[Heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.

---

**`heating_set_point_fahrenheit`** *Number*

Desired [heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F. You must set one of the `heating_set_point` parameters.
[Heating set point](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.

---

Expand Down
Loading
Loading