Skip to content

Commit 558ef63

Browse files
razor-xrazor-x
authored
Merge branch 'main' into evan/acs-1302-generate-docs-and-sdk-for-customers
2 parents c1a7c17 + dcf8eee commit 558ef63

File tree

8 files changed

+191
-14
lines changed

8 files changed

+191
-14
lines changed

‎docs/api/_blueprint.json‎

Lines changed: 169 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25230,6 +25230,21 @@
2523025230
}
2523125231
]
2523225232
},
25233+
{
25234+
"name": "is_embedded",
25235+
"description": "Whether the portal is embedded in another application.",
25236+
"isRequired": false,
25237+
"isDeprecated": false,
25238+
"deprecationMessage": "",
25239+
"isUndocumented": false,
25240+
"undocumentedMessage": "",
25241+
"isDraft": false,
25242+
"draftMessage": "",
25243+
"hasDefault": true,
25244+
"default": false,
25245+
"format": "boolean",
25246+
"jsonType": "boolean"
25247+
},
2523325248
{
2523425249
"name": "customer_data",
2523525250
"description": "",
@@ -26082,6 +26097,51 @@
2608226097
}
2608326098
]
2608426099
},
26100+
{
26101+
"name": "property_listings",
26102+
"description": "List of property listings.",
26103+
"isRequired": false,
26104+
"isDeprecated": false,
26105+
"deprecationMessage": "",
26106+
"isUndocumented": false,
26107+
"undocumentedMessage": "",
26108+
"isDraft": false,
26109+
"draftMessage": "",
26110+
"hasDefault": false,
26111+
"format": "list",
26112+
"jsonType": "array",
26113+
"itemFormat": "object",
26114+
"itemParameters": [
26115+
{
26116+
"name": "name",
26117+
"description": "Your display name for this location resource.",
26118+
"isRequired": false,
26119+
"isDeprecated": false,
26120+
"deprecationMessage": "",
26121+
"isUndocumented": false,
26122+
"undocumentedMessage": "",
26123+
"isDraft": false,
26124+
"draftMessage": "",
26125+
"hasDefault": false,
26126+
"format": "string",
26127+
"jsonType": "string"
26128+
},
26129+
{
26130+
"name": "property_listing_key",
26131+
"description": "Your unique identifier for the property listing.",
26132+
"isRequired": false,
26133+
"isDeprecated": false,
26134+
"deprecationMessage": "",
26135+
"isUndocumented": false,
26136+
"undocumentedMessage": "",
26137+
"isDraft": false,
26138+
"draftMessage": "",
26139+
"hasDefault": false,
26140+
"format": "string",
26141+
"jsonType": "string"
26142+
}
26143+
]
26144+
},
2608526145
{
2608626146
"name": "reservations",
2608726147
"description": "List of reservations.",
@@ -27645,6 +27705,51 @@
2764527705
}
2764627706
]
2764727707
},
27708+
{
27709+
"name": "property_listings",
27710+
"description": "List of property listings.",
27711+
"isRequired": false,
27712+
"isDeprecated": false,
27713+
"deprecationMessage": "",
27714+
"isUndocumented": false,
27715+
"undocumentedMessage": "",
27716+
"isDraft": false,
27717+
"draftMessage": "",
27718+
"hasDefault": false,
27719+
"format": "list",
27720+
"jsonType": "array",
27721+
"itemFormat": "object",
27722+
"itemParameters": [
27723+
{
27724+
"name": "name",
27725+
"description": "Your display name for this location resource.",
27726+
"isRequired": false,
27727+
"isDeprecated": false,
27728+
"deprecationMessage": "",
27729+
"isUndocumented": false,
27730+
"undocumentedMessage": "",
27731+
"isDraft": false,
27732+
"draftMessage": "",
27733+
"hasDefault": false,
27734+
"format": "string",
27735+
"jsonType": "string"
27736+
},
27737+
{
27738+
"name": "property_listing_key",
27739+
"description": "Your unique identifier for the property listing.",
27740+
"isRequired": false,
27741+
"isDeprecated": false,
27742+
"deprecationMessage": "",
27743+
"isUndocumented": false,
27744+
"undocumentedMessage": "",
27745+
"isDraft": false,
27746+
"draftMessage": "",
27747+
"hasDefault": false,
27748+
"format": "string",
27749+
"jsonType": "string"
27750+
}
27751+
]
27752+
},
2764827753
{
2764927754
"name": "reservations",
2765027755
"description": "List of reservations.",
@@ -37115,7 +37220,7 @@
3711537220
},
3711637221
{
3711737222
"name": "connect_webview_id",
37118-
"description": "IDs of the connected accounts for which you want to list events.",
37223+
"description": "ID of the Connect Webview for which you want to list events.",
3711937224
"isRequired": false,
3712037225
"isDeprecated": false,
3712137226
"deprecationMessage": "",
@@ -72356,8 +72461,8 @@
7235672461
"description": "",
7235772462
"isDeprecated": false,
7235872463
"deprecationMessage": "",
72359-
"isUndocumented": true,
72360-
"undocumentedMessage": "Not implemented.",
72464+
"isUndocumented": false,
72465+
"undocumentedMessage": "",
7236172466
"isDraft": false,
7236272467
"draftMessage": "",
7236372468
"propertyGroupKey": null,
@@ -72566,6 +72671,62 @@
7256672671
{
7256772672
"resourceType": "connected_account",
7256872673
"properties": [
72674+
{
72675+
"name": "accepted_capabilities",
72676+
"description": "List of capabilities that were accepted during the account connection process.",
72677+
"isDeprecated": false,
72678+
"deprecationMessage": "",
72679+
"isUndocumented": false,
72680+
"undocumentedMessage": "",
72681+
"isDraft": false,
72682+
"draftMessage": "",
72683+
"propertyGroupKey": null,
72684+
"format": "list",
72685+
"jsonType": "array",
72686+
"itemFormat": "enum",
72687+
"itemEnumValues": [
72688+
{
72689+
"name": "lock",
72690+
"description": "",
72691+
"isDeprecated": false,
72692+
"deprecationMessage": "",
72693+
"isUndocumented": false,
72694+
"undocumentedMessage": "",
72695+
"isDraft": false,
72696+
"draftMessage": ""
72697+
},
72698+
{
72699+
"name": "thermostat",
72700+
"description": "",
72701+
"isDeprecated": false,
72702+
"deprecationMessage": "",
72703+
"isUndocumented": false,
72704+
"undocumentedMessage": "",
72705+
"isDraft": false,
72706+
"draftMessage": ""
72707+
},
72708+
{
72709+
"name": "noise_sensor",
72710+
"description": "",
72711+
"isDeprecated": false,
72712+
"deprecationMessage": "",
72713+
"isUndocumented": false,
72714+
"undocumentedMessage": "",
72715+
"isDraft": false,
72716+
"draftMessage": ""
72717+
},
72718+
{
72719+
"name": "access_control",
72720+
"description": "",
72721+
"isDeprecated": false,
72722+
"deprecationMessage": "",
72723+
"isUndocumented": false,
72724+
"undocumentedMessage": "",
72725+
"isDraft": false,
72726+
"draftMessage": ""
72727+
}
72728+
]
72729+
},
7256972730
{
7257072731
"name": "account_type",
7257172732
"description": "Type of connected account.",
@@ -73477,12 +73638,15 @@
7347773638
"phone": "+1555551004",
7347873639
"username": "jane_doe"
7347973640
},
73480-
"warnings": []
73641+
"warnings": [],
73642+
"accepted_capabilities": [
73643+
"lock"
73644+
]
7348173645
},
7348273646
"resource": {
7348373647
"seam_cli": {
7348473648
"title": "Seam CLI",
73485-
"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\": \"[email protected]\",\n \"exclusive\": true,\n \"phone\": \"+1555551004\",\n \"username\": \"jane_doe\"\n },\n \"warnings\": []\n}",
73649+
"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\": \"[email protected]\",\n \"exclusive\": true,\n \"phone\": \"+1555551004\",\n \"username\": \"jane_doe\"\n },\n \"warnings\": [],\n \"accepted_capabilities\": [\"lock\"]\n}",
7348673650
"resource_data_syntax": "json"
7348773651
}
7348873652
}

‎docs/api/_report.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ These items are intentionally undocumented.
6464
- `acs_user.last_successful_sync_at`: Only used internally.
6565
- `connect_webview.accepted_devices`: Unused. Will be removed.
6666
- `connect_webview.any_device_allowed`: Unused. Will be removed.
67-
- `connect_webview.device_selection_mode`: Not implemented.
6867
- `unmanaged_acs_user.last_successful_sync_at`: Only used internally.
6968

7069
### Namespaces

‎docs/api/connected_accounts/README.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ A connected account resource.
3232
"phone": "+1555551004",
3333
"username": "jane_doe"
3434
},
35-
"warnings": []
35+
"warnings": [],
36+
"accepted_capabilities": ["lock"]
3637
}
3738
```
3839
{% endtab %}
@@ -41,6 +42,15 @@ A connected account resource.
4142
---
4243
## Properties
4344

45+
**`accepted_capabilities`** *List* *of Enums*
46+
47+
List of capabilities that were accepted during the account connection process.
48+
49+
50+
51+
52+
---
53+
4454
**`account_type`** *String*
4555

4656
Type of connected account.

‎docs/api/connected_accounts/get.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,8 @@ Email address associated with the connected account that you want to get.
278278
"phone": "+1555551004",
279279
"username": "jane_doe"
280280
},
281-
"warnings": []
281+
"warnings": [],
282+
"accepted_capabilities": ["lock"]
282283
}
283284
```
284285
{% endtab %}

‎docs/api/connected_accounts/list.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,8 @@ Array of [connected\_accounts](./)
310310
"phone": "+1555551004",
311311
"username": "jane_doe"
312312
},
313-
"warnings": []
313+
"warnings": [],
314+
"accepted_capabilities": ["lock"]
314315
}
315316
```
316317
{% endtab %}

‎package-lock.json‎

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
"@prettier/plugin-ruby": "^4.0.4",
3535
"@seamapi/blueprint": "^0.50.4",
3636
"@seamapi/smith": "^0.4.4",
37-
"@seamapi/types": "1.423.2",
37+
"@seamapi/types": "1.424.0",
3838
"change-case": "^5.4.4",
3939
"command-exists": "^1.2.9",
4040
"execa": "^9.3.1",

‎src/data/resource-sample-definitions/all-resources.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,8 @@
487487
phone: '+1555551004'
488488
username: jane_doe
489489
warnings: []
490+
accepted_capabilities:
491+
- lock
490492
- title: Device Provider
491493
description: A device provider resource.
492494
resource_type: device_provider

0 commit comments

Comments
 (0)