Skip to content

Commit dc0adaf

Browse files
louis-preclaude
andcommitted
fix: Correct syntax errors and typos in hand-written code samples across guides
Fixes 19 issues found during a code sample audit: - Wrong capability flag in quickstart cURL (can_remotely_lock → can_remotely_unlock) - Wrong cURL endpoints (access_methods/get → access_grants/create, devices/list → events/list) - Extra '>' in cURL URL (customer-portals) - Python syntax using Ruby-style ':' instead of '=' for kwargs (mobile-key-quick-start) - Wrong PHP class name (SeamSeamClient → Seam\SeamClient in nuki-locks) - Wrong C# method name (SystemsAcs.List → Acs.Systems.List) - Malformed JSON using '=' instead of ':' (filtering-connect-webviews) - JS object literal using '=' instead of ':' (hospitality guides) - JS variable name mismatch (connectedAccounts vs connected_accounts) - Missing JSON commas in output examples (multiple files) - Stray spaces before array index [0] (nest-thermostats) - Ruby placeholder using JS comment syntax (// → #) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent b43a58b commit dc0adaf

15 files changed

Lines changed: 33 additions & 33 deletions

docs/brand-guides/august-locks/get-started-with-august-locks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -626,7 +626,7 @@ true
626626
{
627627
"device_id": "11111111-1111-1111-1111-444444444444",
628628
"display_name": "Lock 1",
629-
"workspace_id": "00000000-0000-0000-0000-000000000000"
629+
"workspace_id": "00000000-0000-0000-0000-000000000000",
630630
"connected_account_id": "11111111-1111-1111-1111-222222222222",
631631
"created_at": "2024-05-29T20:08:48.878Z",
632632
"properties": {

docs/brand-guides/google-nest-thermostats/get-started-with-nest-thermostats.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ Fan running: false
538538
const allGoogleNestThermostats = await seam.devices.list({manufacturer: "nest"});
539539

540540
// Select the first device as an example.
541-
const livingRoomThermostat = allGoogleNestThermostats [0];
541+
const livingRoomThermostat = allGoogleNestThermostats[0];
542542

543543
// Inspect specific properties.
544544
console.log("Current temperature: " + livingRoomThermostat.properties.temperature_fahrenheit);
@@ -595,7 +595,7 @@ Fan running: false
595595
all_google_nest_thermostats = seam.devices.list(manufacturer: "nest")
596596

597597
# Select the first device as an example.
598-
living_room_thermostat = all_google_nest_thermostats [0]
598+
living_room_thermostat = all_google_nest_thermostats[0]
599599

600600
# Inspect specific properties.
601601
puts "Current temperature: " + living_room_thermostat.properties.temperature_fahrenheit.to_s
@@ -652,7 +652,7 @@ Fan running: false
652652
$all_google_nest_thermostats = $seam->devices->list(manufacturer: "nest");
653653

654654
// Select the first device as an example.
655-
$living_room_thermostat = $all_google_nest_thermostats [0];
655+
$living_room_thermostat = $all_google_nest_thermostats[0];
656656

657657
// Inspect specific properties.
658658
echo "Current temperature: ", $living_room_thermostat->properties->temperature_fahrenheit, "\n";

docs/brand-guides/nuki-locks/get-started-with-nuki-locks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ puts created_webview.url
110110
```php
111111
<?php
112112
// initiate the SDK client, you should replace this with your SDK client init portion
113-
$seam = new SeamSeamClient("YOUR_API_KEY");
113+
$seam = new Seam\SeamClient("YOUR_API_KEY");
114114

115115
// create a connect webview with provider nuki
116116
$connect_webview = $seam->connect_webviews->create([

docs/guides/capability-guides/access-grants/access-grant-quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ access_grant=$(curl --include --request POST "https://connect.getseam.com/access
195195
"access_grant_id":"6d74aefc-5712-4a8b-82c1-73a51ae60b87",
196196
"user_identity_id":"8cc2633a-54ca-455a-8a2b-77e6a1fc4fee",
197197
"starts_at":"2025-08-01T15:00:00.000Z",
198-
"ends_at":"2025-08-04T11:00:00.000Z"
198+
"ends_at":"2025-08-04T11:00:00.000Z",
199199
"instant_key_url":"https://ik.seam.co/ABCXYZ",
200200
"requested_access_methods":[
201201
{
@@ -399,7 +399,7 @@ $access_grant = $seam->access_grants->create(
399399
"access_grant_id":"6d74aefc-5712-4a8b-82c1-73a51ae60b87",
400400
"user_identity_id":"8cc2633a-54ca-455a-8a2b-77e6a1fc4fee",
401401
"starts_at":"2025-08-01T15:00:00.000Z",
402-
"ends_at":"2025-08-04T11:00:00.000Z"
402+
"ends_at":"2025-08-04T11:00:00.000Z",
403403
"instant_key_url":"https://ik.seam.co/ABCXYZ",
404404
"requested_access_methods":[
405405
{

docs/guides/capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,10 +134,10 @@ from seam import Seam
134134
seam = Seam() # Seam automatically uses your exported SEAM_API_KEY.
135135
136136
jen_doe_user = seam.user_identities.create(
137-
full_name: "Jen Doe",
138-
email_address = "jen.doe@example.com",
137+
full_name="Jen Doe",
138+
email_address="jen.doe@example.com",
139139
# Use the ACS system ID that you copied earlier from Seam Console.
140-
acs_system_ids = [acs_system_id]
140+
acs_system_ids=[acs_system_id]
141141
)
142142
```
143143

docs/guides/capability-guides/customer-portals/integrate-customer-portal-into-your-application.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Use the `create_portal` endpoint to generate Customer Portals programmatically.
1515

1616
```bash
1717
curl -X POST \
18-
https://connect.getseam.com/customers/create_portal> \
18+
https://connect.getseam.com/customers/create_portal \
1919
-H "Authorization: Bearer $SEAM_API_KEY" \
2020
-H "Content-Type: application/json" \
2121
-d '{

docs/guides/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -151,11 +151,11 @@ echo json_encode($webviews);
151151
```json
152152
[
153153
{
154-
"connect_webview_id":"3c3f4c15-e7db-47c6-bc5a-1bf206ff269c",
155-
"url="https://connect.getseam.com/connect_webviews/view?connect_webview_id=xxxx&auth_token=yyyy",
156-
"status"="pending",
157-
"workspace_id"="398d80b7-3f96-47c2-b85a-6f8ba21d07be",
158-
"custom_metadata"={"internal_account_id"=>"user-1"},
154+
"connect_webview_id": "3c3f4c15-e7db-47c6-bc5a-1bf206ff269c",
155+
"url": "https://connect.getseam.com/connect_webviews/view?connect_webview_id=xxxx&auth_token=yyyy",
156+
"status": "pending",
157+
"workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
158+
"custom_metadata": {"internal_account_id": "user-1"},
159159
...
160160
},
161161
...

docs/guides/core-concepts/connect-webviews/retrieving-devices-or-access-control-systems-connected-through-a-connect-webview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -294,13 +294,13 @@ connected_acs_systems=$(
294294
**Code:**
295295

296296
```ruby
297-
// Coming soon!
297+
# Coming soon!
298298
```
299299

300300
**Output:**
301301

302-
```json
303-
// Coming soon!
302+
```
303+
# Coming soon!
304304
```
305305
{% endtab %}
306306

@@ -336,7 +336,7 @@ $connected_acs_systems = $seam->acs->systems->list(
336336

337337
```csharp
338338
// Retrieve all acs_systems for the connectedAccountId.
339-
var connectedAcsSystems = seam.SystemsAcs.List(
339+
var connectedAcsSystems = seam.Acs.Systems.List(
340340
connectedAccountId: "11111111-1111-1111-2222-111111111111"
341341
);
342342
```

docs/guides/core-concepts/devices/displaying-device-health.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ pprint(device_connected_events)
180180
```bash
181181
# Use GET or POST.
182182
curl -X 'GET' \
183-
'https://connect.getseam.com/devices/list' \
183+
'https://connect.getseam.com/events/list' \
184184
-H 'accept: application/json' \
185185
-H 'Authorization: Bearer ${API_KEY}' \
186186
-H 'Content-Type: application/json' \

docs/guides/core-concepts/mapping-your-resources-to-seam-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ const connected_accounts = await seam.connected_accounts.list({
272272

273273
let customerSystems = []
274274

275-
for (const account of connectedAccounts) {
275+
for (const account of connected_accounts) {
276276
const systems = await seam.acs.systems.list({
277277
connected_account_id: account.connected_account_id
278278
});

0 commit comments

Comments
 (0)