Skip to content
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
174 changes: 169 additions & 5 deletions docs/api/_blueprint.json
Original file line number Diff line number Diff line change
Expand Up @@ -25230,6 +25230,21 @@
}
]
},
{
"name": "is_embedded",
"description": "Whether the portal is embedded in another application.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": true,
"default": false,
"format": "boolean",
"jsonType": "boolean"
},
{
"name": "customer_data",
"description": "",
Expand Down Expand Up @@ -26082,6 +26097,51 @@
}
]
},
{
"name": "property_listings",
"description": "List of property listings.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "list",
"jsonType": "array",
"itemFormat": "object",
"itemParameters": [
{
"name": "name",
"description": "Your display name for this location resource.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "string",
"jsonType": "string"
},
{
"name": "property_listing_key",
"description": "Your unique identifier for the property listing.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "string",
"jsonType": "string"
}
]
},
{
"name": "reservations",
"description": "List of reservations.",
Expand Down Expand Up @@ -27645,6 +27705,51 @@
}
]
},
{
"name": "property_listings",
"description": "List of property listings.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "list",
"jsonType": "array",
"itemFormat": "object",
"itemParameters": [
{
"name": "name",
"description": "Your display name for this location resource.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "string",
"jsonType": "string"
},
{
"name": "property_listing_key",
"description": "Your unique identifier for the property listing.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"hasDefault": false,
"format": "string",
"jsonType": "string"
}
]
},
{
"name": "reservations",
"description": "List of reservations.",
Expand Down Expand Up @@ -37115,7 +37220,7 @@
},
{
"name": "connect_webview_id",
"description": "IDs of the connected accounts for which you want to list events.",
"description": "ID of the Connect Webview for which you want to list events.",
"isRequired": false,
"isDeprecated": false,
"deprecationMessage": "",
Expand Down Expand Up @@ -72356,8 +72461,8 @@
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": true,
"undocumentedMessage": "Not implemented.",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
Expand Down Expand Up @@ -72566,6 +72671,62 @@
{
"resourceType": "connected_account",
"properties": [
{
"name": "accepted_capabilities",
"description": "List of capabilities that were accepted during the account connection process.",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": "",
"propertyGroupKey": null,
"format": "list",
"jsonType": "array",
"itemFormat": "enum",
"itemEnumValues": [
{
"name": "lock",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "thermostat",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "noise_sensor",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
},
{
"name": "access_control",
"description": "",
"isDeprecated": false,
"deprecationMessage": "",
"isUndocumented": false,
"undocumentedMessage": "",
"isDraft": false,
"draftMessage": ""
}
]
},
{
"name": "account_type",
"description": "Type of connected account.",
Expand Down Expand Up @@ -73477,12 +73638,15 @@
"phone": "+1555551004",
"username": "jane_doe"
},
"warnings": []
"warnings": [],
"accepted_capabilities": [
"lock"
]
},
"resource": {
"seam_cli": {
"title": "Seam CLI",
"resource_data": "{\n \"account_type\": \"salto_space\",\n \"account_type_display_name\": \"Salto Space\",\n \"automatically_manage_new_devices\": true,\n \"connected_account_id\": \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\": \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\": { \"id\": \"internalId1\" },\n \"errors\": [],\n \"user_identifier\": {\n \"api_url\": \"https://example.com/api\",\n \"email\": \"jane_doe@example.com\",\n \"exclusive\": true,\n \"phone\": \"+1555551004\",\n \"username\": \"jane_doe\"\n },\n \"warnings\": []\n}",
"resource_data": "{\n \"account_type\": \"salto_space\",\n \"account_type_display_name\": \"Salto Space\",\n \"automatically_manage_new_devices\": true,\n \"connected_account_id\": \"a289aa54-5488-4707-9a4b-eeea4edf311d\",\n \"created_at\": \"2025-06-15T16:54:17.946329Z\",\n \"custom_metadata\": { \"id\": \"internalId1\" },\n \"errors\": [],\n \"user_identifier\": {\n \"api_url\": \"https://example.com/api\",\n \"email\": \"jane_doe@example.com\",\n \"exclusive\": true,\n \"phone\": \"+1555551004\",\n \"username\": \"jane_doe\"\n },\n \"warnings\": [],\n \"accepted_capabilities\": [\"lock\"]\n}",
"resource_data_syntax": "json"
}
}
Expand Down
1 change: 0 additions & 1 deletion docs/api/_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ These items are intentionally undocumented.
- `acs_user.last_successful_sync_at`: Only used internally.
- `connect_webview.accepted_devices`: Unused. Will be removed.
- `connect_webview.any_device_allowed`: Unused. Will be removed.
- `connect_webview.device_selection_mode`: Not implemented.
- `unmanaged_acs_user.last_successful_sync_at`: Only used internally.

### Namespaces
Expand Down
12 changes: 11 additions & 1 deletion docs/api/connected_accounts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ A connected account resource.
"phone": "+1555551004",
"username": "jane_doe"
},
"warnings": []
"warnings": [],
"accepted_capabilities": ["lock"]
}
```
{% endtab %}
Expand All @@ -41,6 +42,15 @@ A connected account resource.
---
## Properties

**`accepted_capabilities`** *List* *of Enums*

List of capabilities that were accepted during the account connection process.




---

**`account_type`** *String*

Type of connected account.
Expand Down
3 changes: 2 additions & 1 deletion docs/api/connected_accounts/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,8 @@ Email address associated with the connected account that you want to get.
"phone": "+1555551004",
"username": "jane_doe"
},
"warnings": []
"warnings": [],
"accepted_capabilities": ["lock"]
}
```
{% endtab %}
Expand Down
3 changes: 2 additions & 1 deletion docs/api/connected_accounts/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -310,7 +310,8 @@ Array of [connected\_accounts](./)
"phone": "+1555551004",
"username": "jane_doe"
},
"warnings": []
"warnings": [],
"accepted_capabilities": ["lock"]
}
```
{% endtab %}
Expand Down
Loading
Loading