Skip to content

Commit 9393171

Browse files
razor-xseambot
razor-x
and
seambot
authored
Add code sample for /acs/systems/report_devices (#930)
* Add code sample for /acs/systems/report_devices * ci: Generate docs --------- Co-authored-by: Seam Bot <[email protected]>
1 parent d2a9b9f commit 9393171

File tree

4 files changed

+337
-2
lines changed

4 files changed

+337
-2
lines changed

‎codegen/data/code-sample-definitions/acs.yaml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -977,6 +977,29 @@
977977
name: My Credential Manager
978978
warnings: []
979979
workspace_id: 172920be-1f4d-45d4-8519-ecc3bdee638f
980+
- title: Report status of ACS entrances and encoders
981+
description: Inform Seam that devices are connected to the ACS system or were removed.
982+
request:
983+
path: /acs/systems/report_devices
984+
parameters:
985+
acs_system_id: 182ea706-8e14-4921-8e57-ee18d5a7de31
986+
acs_encoders:
987+
- hotek_metadata:
988+
encoder_number: '1'
989+
- is_removed: true
990+
hotek_metadata:
991+
encoder_number: '2'
992+
acs_entrances:
993+
- hotek_metadata:
994+
room_number: '203'
995+
- is_removed: true
996+
hotek_metadata:
997+
room_number: '500'
998+
- hotek_metadata:
999+
common_area_name: Gym
1000+
common_area_number: '2'
1001+
response:
1002+
body: null
9801003
- title: Add a access system user to an access group
9811004
description: Adds a specified access system user to a specified access group.
9821005
request:

‎docs/api/_blueprint.json‎

Lines changed: 121 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16376,7 +16376,127 @@
1637616376
"api_key"
1637716377
],
1637816378
"workspaceScope": "required",
16379-
"codeSamples": []
16379+
"codeSamples": [
16380+
{
16381+
"title": "Report status of ACS entrances and encoders",
16382+
"description": "Inform Seam that devices are connected to the ACS system or were removed.",
16383+
"request": {
16384+
"path": "/acs/systems/report_devices",
16385+
"parameters": {
16386+
"acs_system_id": "182ea706-8e14-4921-8e57-ee18d5a7de31",
16387+
"acs_encoders": [
16388+
{
16389+
"hotek_metadata": {
16390+
"encoder_number": "1"
16391+
}
16392+
},
16393+
{
16394+
"is_removed": true,
16395+
"hotek_metadata": {
16396+
"encoder_number": "2"
16397+
}
16398+
}
16399+
],
16400+
"acs_entrances": [
16401+
{
16402+
"hotek_metadata": {
16403+
"room_number": "203"
16404+
}
16405+
},
16406+
{
16407+
"is_removed": true,
16408+
"hotek_metadata": {
16409+
"room_number": "500"
16410+
}
16411+
},
16412+
{
16413+
"hotek_metadata": {
16414+
"common_area_name": "Gym",
16415+
"common_area_number": "2"
16416+
}
16417+
}
16418+
]
16419+
}
16420+
},
16421+
"response": {
16422+
"body": null
16423+
},
16424+
"code": {
16425+
"javascript": {
16426+
"title": "JavaScript",
16427+
"sdkName": "javascript",
16428+
"request": "await seam.acs.systems.reportDevices({\n acs_system_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n acs_encoders: [\n { hotek_metadata: { encoder_number: \"1\" } },\n { is_removed: true, hotek_metadata: { encoder_number: \"2\" } },\n ],\n acs_entrances: [\n { hotek_metadata: { room_number: \"203\" } },\n { is_removed: true, hotek_metadata: { room_number: \"500\" } },\n { hotek_metadata: { common_area_name: \"Gym\", common_area_number: \"2\" } },\n ],\n});",
16429+
"response": "// void",
16430+
"request_syntax": "javascript",
16431+
"response_syntax": "javascript"
16432+
},
16433+
"python": {
16434+
"title": "Python",
16435+
"sdkName": "python",
16436+
"request": "seam.acs.systems.report_devices(\n acs_system_id=\"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n acs_encoders=[\n {\"hotek_metadata\": {\"encoder_number\": \"1\"}},\n {\"is_removed\": true, \"hotek_metadata\": {\"encoder_number\": \"2\"}},\n ],\n acs_entrances=[\n {\"hotek_metadata\": {\"room_number\": \"203\"}},\n {\"is_removed\": true, \"hotek_metadata\": {\"room_number\": \"500\"}},\n {\"hotek_metadata\": {\"common_area_name\": \"Gym\", \"common_area_number\": \"2\"}},\n ],\n)",
16437+
"response": "None",
16438+
"request_syntax": "python",
16439+
"response_syntax": "python"
16440+
},
16441+
"ruby": {
16442+
"title": "Ruby",
16443+
"sdkName": "ruby",
16444+
"request": "seam.acs.systems.report_devices(\n acs_system_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n acs_encoders: [\n { hotek_metadata: { encoder_number: \"1\" } },\n { is_removed: true, hotek_metadata: { encoder_number: \"2\" } },\n ],\n acs_entrances: [\n { hotek_metadata: { room_number: \"203\" } },\n { is_removed: true, hotek_metadata: { room_number: \"500\" } },\n { hotek_metadata: { common_area_name: \"Gym\", common_area_number: \"2\" } },\n ],\n)",
16445+
"response": "nil",
16446+
"request_syntax": "ruby",
16447+
"response_syntax": "ruby"
16448+
},
16449+
"php": {
16450+
"title": "PHP",
16451+
"sdkName": "php",
16452+
"request": "$seam->acs->systems->report_devices(\n acs_system_id: \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n acs_encoders: [\n [\"hotek_metadata\" => [\"encoder_number\" => \"1\"]],\n [\"is_removed\" => true, \"hotek_metadata\" => [\"encoder_number\" => \"2\"]],\n ],\n acs_entrances: [\n [\"hotek_metadata\" => [\"room_number\" => \"203\"]],\n [\"is_removed\" => true, \"hotek_metadata\" => [\"room_number\" => \"500\"]],\n [\n \"hotek_metadata\" => [\n \"common_area_name\" => \"Gym\",\n \"common_area_number\" => \"2\",\n ],\n ],\n ]\n);",
16453+
"response": "",
16454+
"request_syntax": "php",
16455+
"response_syntax": "php"
16456+
},
16457+
"seam_cli": {
16458+
"title": "Seam CLI",
16459+
"sdkName": "seam_cli",
16460+
"request": "seam acs systems report-devices --acs_system_id \"182ea706-8e14-4921-8e57-ee18d5a7de31\" --acs_encoders [{\"hotek_metadata\":{\"encoder_number\":\"1\"}},{\"is_removed\":true,\"hotek_metadata\":{\"encoder_number\":\"2\"}}] --acs_entrances [{\"hotek_metadata\":{\"room_number\":\"203\"}},{\"is_removed\":true,\"hotek_metadata\":{\"room_number\":\"500\"}},{\"hotek_metadata\":{\"common_area_name\":\"Gym\",\"common_area_number\":\"2\"}}]",
16461+
"response": "{}",
16462+
"request_syntax": "bash",
16463+
"response_syntax": "json"
16464+
},
16465+
"go": {
16466+
"title": "Go",
16467+
"sdkName": "go",
16468+
"request": "package main\n\nimport api \"github.com/seamapi/go\"\nimport systems \"github.com/seamapi/go/systems\"\n\nfunc main() {\n\tclient.Acs.Systems.ReportDevices(\n\t\tcontext.Background(),\n\t\tsystems.SystemsReportDevicesRequest{\n\t\t\tAcsSystemId: api.String(\"182ea706-8e14-4921-8e57-ee18d5a7de31\"),\n\t\t\tAcsEncoders: [2]systems.SystemsReportDevicesRequestAcsEncodersItem{systems.SystemsReportDevicesRequestAcsEncoders{HotekMetadata: systems.SystemsReportDevicesRequestHotekMetadata{EncoderNumber: api.String(\"1\")}}, systems.SystemsReportDevicesRequestAcsEncoders{IsRemoved: api.Bool(true), HotekMetadata: systems.SystemsReportDevicesRequestHotekMetadata{EncoderNumber: api.String(\"2\")}}},\n\t\t\tAcsEntrances: [3]systems.SystemsReportDevicesRequestAcsEntrancesItem{systems.SystemsReportDevicesRequestAcsEntrances{HotekMetadata: systems.SystemsReportDevicesRequestHotekMetadata{RoomNumber: api.String(\"203\")}}, systems.SystemsReportDevicesRequestAcsEntrances{IsRemoved: api.Bool(true), HotekMetadata: systems.SystemsReportDevicesRequestHotekMetadata{RoomNumber: api.String(\"500\")}}, systems.SystemsReportDevicesRequestAcsEntrances{HotekMetadata: systems.SystemsReportDevicesRequestHotekMetadata{CommonAreaName: api.String(\"Gym\"), CommonAreaNumber: api.String(\"2\")}}},\n\t\t},\n\t)\n}",
16469+
"response": "nil",
16470+
"request_syntax": "go",
16471+
"response_syntax": "go"
16472+
},
16473+
"java": {
16474+
"title": "Java",
16475+
"sdkName": "java",
16476+
"request": "seam.acs().systems().reportDevices(SystemsReportDevicesRequest.builder().acsSystemId(\"182ea706-8e14-4921-8e57-ee18d5a7de31\")\n.acsEncoders(List.of(Map.of(\"hotek_metadata\", Map.of(\"encoder_number\", \"1\")), Map.of(\"is_removed\", true, \"hotek_metadata\", Map.of(\"encoder_number\", \"2\"))))\n.acsEntrances(List.of(Map.of(\"hotek_metadata\", Map.of(\"room_number\", \"203\")), Map.of(\"is_removed\", true, \"hotek_metadata\", Map.of(\"room_number\", \"500\")), Map.of(\"hotek_metadata\", Map.of(\"common_area_name\", \"Gym\", \"common_area_number\", \"2\")))).build());",
16477+
"response": "{}",
16478+
"request_syntax": "java",
16479+
"response_syntax": "json"
16480+
},
16481+
"csharp": {
16482+
"title": "C#",
16483+
"sdkName": "csharp",
16484+
"request": "seam.Acs.Systems.ReportDevices(acsSystemId: \"182ea706-8e14-4921-8e57-ee18d5a7de31\", acsEncoders: new object[] { new { hotekMetadata = new { encoderNumber = \"1\" } }, new { isRemoved = true, hotekMetadata = new { encoderNumber = \"2\" } }} , acsEntrances: new object[] { new { hotekMetadata = new { roomNumber = \"203\" } }, new { isRemoved = true, hotekMetadata = new { roomNumber = \"500\" } }, new { hotekMetadata = new { commonAreaName = \"Gym\", commonAreaNumber = \"2\" } }} )",
16485+
"response": "{}",
16486+
"request_syntax": "csharp",
16487+
"response_syntax": "json"
16488+
},
16489+
"curl": {
16490+
"title": "cURL",
16491+
"sdkName": "curl",
16492+
"request": "curl --include --request POST \"https://connect.getseam.com/acs/systems/report_devices\" \\\n --header \"Authorization: Bearer $SEAM_API_KEY\" \\\n --json @- <<EOF\n{\n \"acs_system_id\": \"182ea706-8e14-4921-8e57-ee18d5a7de31\",\n \"acs_encoders\": [\n {\n \"hotek_metadata\": {\n \"encoder_number\": \"1\"\n }\n },\n {\n \"is_removed\": true,\n \"hotek_metadata\": {\n \"encoder_number\": \"2\"\n }\n }\n ],\n \"acs_entrances\": [\n {\n \"hotek_metadata\": {\n \"room_number\": \"203\"\n }\n },\n {\n \"is_removed\": true,\n \"hotek_metadata\": {\n \"room_number\": \"500\"\n }\n },\n {\n \"hotek_metadata\": {\n \"common_area_name\": \"Gym\",\n \"common_area_number\": \"2\"\n }\n }\n ]\n}\nEOF",
16493+
"response": "{}",
16494+
"request_syntax": "bash",
16495+
"response_syntax": "json"
16496+
}
16497+
}
16498+
}
16499+
]
1638016500
}
1638116501
],
1638216502
"parentPath": "/acs",

‎docs/api/_report.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -624,7 +624,6 @@ These items are deprecated.
624624
- `/access_methods/get_related`
625625
- `/access_methods/unmanaged/get`
626626
- `/access_methods/unmanaged/list`
627-
- `/acs/systems/report_devices`
628627
- `/customers/create_portal`
629628
- `/customers/delete_data`
630629
- `/customers/push_data`

‎docs/api/acs/systems/report_devices.md‎

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,199 @@ This endpoint allows reporting of:
1010
- ACS entrances with room number metadata
1111

1212

13+
{% tabs %}
14+
{% tab title="JavaScript" %}
15+
16+
Inform Seam that devices are connected to the ACS system or were removed.
17+
18+
#### Code:
19+
20+
```javascript
21+
await seam.acs.systems.reportDevices({
22+
acs_system_id: "182ea706-8e14-4921-8e57-ee18d5a7de31",
23+
acs_encoders: [
24+
{ hotek_metadata: { encoder_number: "1" } },
25+
{ is_removed: true, hotek_metadata: { encoder_number: "2" } },
26+
],
27+
acs_entrances: [
28+
{ hotek_metadata: { room_number: "203" } },
29+
{ is_removed: true, hotek_metadata: { room_number: "500" } },
30+
{ hotek_metadata: { common_area_name: "Gym", common_area_number: "2" } },
31+
],
32+
});
33+
```
34+
35+
#### Output:
36+
37+
```javascript
38+
// void
39+
```
40+
{% endtab %}
41+
42+
{% tab title="cURL" %}
43+
44+
Inform Seam that devices are connected to the ACS system or were removed.
45+
46+
#### Code:
47+
48+
```curl
49+
curl --include --request POST "https://connect.getseam.com/acs/systems/report_devices" \
50+
--header "Authorization: Bearer $SEAM_API_KEY" \
51+
--json @- <<EOF
52+
{
53+
"acs_system_id": "182ea706-8e14-4921-8e57-ee18d5a7de31",
54+
"acs_encoders": [
55+
{
56+
"hotek_metadata": {
57+
"encoder_number": "1"
58+
}
59+
},
60+
{
61+
"is_removed": true,
62+
"hotek_metadata": {
63+
"encoder_number": "2"
64+
}
65+
}
66+
],
67+
"acs_entrances": [
68+
{
69+
"hotek_metadata": {
70+
"room_number": "203"
71+
}
72+
},
73+
{
74+
"is_removed": true,
75+
"hotek_metadata": {
76+
"room_number": "500"
77+
}
78+
},
79+
{
80+
"hotek_metadata": {
81+
"common_area_name": "Gym",
82+
"common_area_number": "2"
83+
}
84+
}
85+
]
86+
}
87+
EOF
88+
```
89+
90+
#### Output:
91+
92+
```curl
93+
{}
94+
```
95+
{% endtab %}
96+
97+
{% tab title="Python" %}
98+
99+
Inform Seam that devices are connected to the ACS system or were removed.
100+
101+
#### Code:
102+
103+
```python
104+
seam.acs.systems.report_devices(
105+
acs_system_id="182ea706-8e14-4921-8e57-ee18d5a7de31",
106+
acs_encoders=[
107+
{"hotek_metadata": {"encoder_number": "1"}},
108+
{"is_removed": true, "hotek_metadata": {"encoder_number": "2"}},
109+
],
110+
acs_entrances=[
111+
{"hotek_metadata": {"room_number": "203"}},
112+
{"is_removed": true, "hotek_metadata": {"room_number": "500"}},
113+
{"hotek_metadata": {"common_area_name": "Gym", "common_area_number": "2"}},
114+
],
115+
)
116+
```
117+
118+
#### Output:
119+
120+
```python
121+
None
122+
```
123+
{% endtab %}
124+
125+
{% tab title="Ruby" %}
126+
127+
Inform Seam that devices are connected to the ACS system or were removed.
128+
129+
#### Code:
130+
131+
```ruby
132+
seam.acs.systems.report_devices(
133+
acs_system_id: "182ea706-8e14-4921-8e57-ee18d5a7de31",
134+
acs_encoders: [
135+
{ hotek_metadata: { encoder_number: "1" } },
136+
{ is_removed: true, hotek_metadata: { encoder_number: "2" } },
137+
],
138+
acs_entrances: [
139+
{ hotek_metadata: { room_number: "203" } },
140+
{ is_removed: true, hotek_metadata: { room_number: "500" } },
141+
{ hotek_metadata: { common_area_name: "Gym", common_area_number: "2" } },
142+
],
143+
)
144+
```
145+
146+
#### Output:
147+
148+
```ruby
149+
nil
150+
```
151+
{% endtab %}
152+
153+
{% tab title="PHP" %}
154+
155+
Inform Seam that devices are connected to the ACS system or were removed.
156+
157+
#### Code:
158+
159+
```php
160+
$seam->acs->systems->report_devices(
161+
acs_system_id: "182ea706-8e14-4921-8e57-ee18d5a7de31",
162+
acs_encoders: [
163+
["hotek_metadata" => ["encoder_number" => "1"]],
164+
["is_removed" => true, "hotek_metadata" => ["encoder_number" => "2"]],
165+
],
166+
acs_entrances: [
167+
["hotek_metadata" => ["room_number" => "203"]],
168+
["is_removed" => true, "hotek_metadata" => ["room_number" => "500"]],
169+
[
170+
"hotek_metadata" => [
171+
"common_area_name" => "Gym",
172+
"common_area_number" => "2",
173+
],
174+
],
175+
]
176+
);
177+
```
178+
179+
#### Output:
180+
181+
```php
182+
183+
```
184+
{% endtab %}
185+
186+
{% tab title="Seam CLI" %}
187+
188+
Inform Seam that devices are connected to the ACS system or were removed.
189+
190+
#### Code:
191+
192+
```seam_cli
193+
seam acs systems report-devices --acs_system_id "182ea706-8e14-4921-8e57-ee18d5a7de31" --acs_encoders [{"hotek_metadata":{"encoder_number":"1"}},{"is_removed":true,"hotek_metadata":{"encoder_number":"2"}}] --acs_entrances [{"hotek_metadata":{"room_number":"203"}},{"is_removed":true,"hotek_metadata":{"room_number":"500"}},{"hotek_metadata":{"common_area_name":"Gym","common_area_number":"2"}}]
194+
```
195+
196+
#### Output:
197+
198+
```seam_cli
199+
{}
200+
```
201+
{% endtab %}
202+
203+
{% endtabs %}
204+
205+
13206
<details>
14207

15208
<summary>Authentication Methods</summary>

0 commit comments

Comments
 (0)