Skip to content

Commit 7363e54

Browse files
mikewuuseambotrazor-x
authored
fix(Request Params): add back missing parameter object (#628)
* add back missing parameter object * fix double line break * ci: Generate docs * ci: Generate docs --------- Co-authored-by: Seam Bot <seambot@getseam.com> Co-authored-by: Evan Sosenko <evan@getseam.com>
1 parent 6abe75a commit 7363e54

5 files changed

Lines changed: 312 additions & 0 deletions

File tree

‎docs/api/acs/credentials/create.md‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,45 @@ Set of IDs of the [entrances](../../../capability-guides/access-systems/retrievi
5555

5656
Vostio-specific metadata for the new credential.
5757

58+
<details>
59+
60+
<summary><b><code>auto_join</code></b> <i>Boolean</i></summary>
61+
62+
</details>
63+
64+
---
65+
66+
67+
68+
<details>
69+
70+
<summary><b><code>join_all_guest_acs_entrances</code></b> <i>Boolean</i></summary>
71+
72+
</details>
73+
74+
---
75+
76+
77+
78+
<details>
79+
80+
<summary><b><code>override_all_guest_acs_entrances</code></b> <i>Boolean</i></summary>
81+
82+
</details>
83+
84+
---
85+
86+
87+
88+
<details>
89+
90+
<summary><b><code>override_guest_acs_entrance_ids</code></b> <i>List</i></summary>
91+
92+
</details>
93+
5894
---
5995

96+
6097
**`code`** *String*
6198

6299
Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](../../../device-and-system-integration-guides/overview.md).
@@ -85,8 +122,29 @@ Indicates whether the new credential is a [multi-phone sync credential](https://
85122

86123
Salto Space-specific metadata for the new credential.
87124

125+
<details>
126+
127+
<summary><b><code>assign_new_key</code></b> <i>Boolean</i></summary>
128+
129+
Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](../../../device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md).
130+
131+
</details>
132+
88133
---
89134

135+
136+
137+
<details>
138+
139+
<summary><b><code>update_current_key</code></b> <i>Boolean</i></summary>
140+
141+
Indicates whether to update the user's existing card. See also [Programming Salto Space Card-based Credentials](../../../device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials.md).
142+
143+
</details>
144+
145+
---
146+
147+
90148
**`starts_at`** *String*
91149

92150
Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
@@ -103,9 +161,94 @@ ID of the user identity to whom the new credential belongs. You must provide eit
103161

104162
Visionline-specific metadata for the new credential.
105163

164+
<details>
165+
166+
<summary><b><code>assa_abloy_credential_service_mobile_endpoint_id</code></b> <i>UUID</i></summary>
167+
168+
{% hint style="warning" %}
169+
**Deprecated**. Read-only endpoint references moved to `endpoint`.
170+
{% endhint %}
171+
172+
</details>
173+
174+
---
175+
176+
177+
178+
<details>
179+
180+
<summary><b><code>auto_join</code></b> <i>Boolean</i></summary>
181+
182+
</details>
183+
184+
---
185+
186+
187+
188+
<details>
189+
190+
<summary><b><code>card_format</code></b> <i>Enum</i></summary>
191+
192+
Enum values:
193+
194+
- <code>TLCode</code>
195+
- <code>rfid48</code>
196+
197+
</details>
198+
199+
---
200+
201+
202+
203+
<details>
204+
205+
<summary><b><code>card_function_type</code></b> <i>Enum</i></summary>
206+
207+
Enum values:
208+
209+
- <code>guest</code>
210+
- <code>staff</code>
211+
212+
</details>
213+
106214
---
107215

108216

217+
218+
<details>
219+
220+
<summary><b><code>is_override_key</code></b> <i>Boolean</i></summary>
221+
222+
{% hint style="warning" %}
223+
**Deprecated**. Use `override` instead.
224+
{% endhint %}
225+
226+
</details>
227+
228+
---
229+
230+
231+
232+
<details>
233+
234+
<summary><b><code>joiner_acs_credential_ids</code></b> <i>List</i></summary>
235+
236+
</details>
237+
238+
---
239+
240+
241+
242+
<details>
243+
244+
<summary><b><code>override</code></b> <i>Boolean</i></summary>
245+
246+
</details>
247+
248+
---
249+
250+
251+
109252
## Response
110253

111254
[acs\_credential](./)

‎docs/api/acs/users/create.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,29 @@ Full name of the new access system user.
4343

4444
`starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
4545

46+
<details>
47+
48+
<summary><b><code>ends_at</code></b> <i>Datetime</i></summary>
49+
50+
Ending timestamp for the new access system user's access.
51+
52+
</details>
53+
4654
---
4755

56+
57+
58+
<details>
59+
60+
<summary><b><code>starts_at</code></b> <i>Datetime</i></summary>
61+
62+
Starting timestamp for the new access system user's access.
63+
64+
</details>
65+
66+
---
67+
68+
4869
**`acs_access_group_ids`** *Array* *of UUIDs*
4970

5071
Array of access group IDs to indicate the access groups to which you want to add the new access system user.

‎docs/api/acs/users/update.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,29 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
3131

3232
`starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`.
3333

34+
<details>
35+
36+
<summary><b><code>ends_at</code></b> <i>Datetime</i></summary>
37+
38+
Ending timestamp for the access system user's access.
39+
40+
</details>
41+
3442
---
3543

44+
45+
46+
<details>
47+
48+
<summary><b><code>starts_at</code></b> <i>Datetime</i></summary>
49+
50+
Starting timestamp for the access system user's access.
51+
52+
</details>
53+
54+
---
55+
56+
3657
**`acs_system_id`** *String*
3758

3859
ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.

‎docs/api/phones/simulate/create_sandbox_phone.md‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,77 @@ ID of the user identity to associate with the simulated phone.
3737

3838
ASSA ABLOY metadata to associate with the simulated phone.
3939

40+
<details>
41+
42+
<summary><b><code>application_version</code></b> <i>String</i></summary>
43+
44+
Application version that you want to use for the simulated phone.
45+
46+
</details>
47+
48+
---
49+
50+
51+
52+
<details>
53+
54+
<summary><b><code>ble_capability</code></b> <i>Boolean</i></summary>
55+
56+
Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.
57+
58+
</details>
59+
60+
---
61+
62+
63+
64+
<details>
65+
66+
<summary><b><code>hce_capability</code></b> <i>Boolean</i></summary>
67+
68+
Indicates whether the simulated phone should have host card emulation (HCE) capability.
69+
70+
</details>
71+
72+
---
73+
74+
75+
76+
<details>
77+
78+
<summary><b><code>nfc_capability</code></b> <i>Boolean</i></summary>
79+
80+
Indicates whether the simulated phone should have near-field communication (NFC) capability.
81+
82+
</details>
83+
84+
---
85+
86+
87+
88+
<details>
89+
90+
<summary><b><code>seos_applet_version</code></b> <i>String</i></summary>
91+
92+
SEOS applet version that you want to use for the simulated phone.
93+
94+
</details>
95+
96+
---
97+
98+
99+
100+
<details>
101+
102+
<summary><b><code>seos_tsm_endpoint_id</code></b> <i>Number</i></summary>
103+
104+
ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.
105+
106+
</details>
107+
40108
---
41109

110+
42111
**`custom_sdk_installation_id`** *String*
43112

44113
ID of the custom SDK installation to use for the simulated phone.
@@ -49,9 +118,59 @@ ID of the custom SDK installation to use for the simulated phone.
49118

50119
Metadata to associate with the simulated phone.
51120

121+
<details>
122+
123+
<summary><b><code>device_manufacturer</code></b> <i>String</i></summary>
124+
125+
Manufacturer that you want to use for the simulated phone.
126+
127+
</details>
128+
129+
---
130+
131+
132+
133+
<details>
134+
135+
<summary><b><code>device_model</code></b> <i>String</i></summary>
136+
137+
Device model that you want to use for the simulated phone.
138+
139+
</details>
140+
141+
---
142+
143+
144+
145+
<details>
146+
147+
<summary><b><code>operating_system</code></b> <i>Enum</i></summary>
148+
149+
Mobile operating system that you want to use for the simulated phone.
150+
151+
Enum values:
152+
153+
- <code>android</code>
154+
- <code>ios</code>
155+
156+
</details>
157+
158+
---
159+
160+
161+
162+
<details>
163+
164+
<summary><b><code>os_version</code></b> <i>String</i></summary>
165+
166+
Mobile operating system version that you want to use for the simulated phone.
167+
168+
</details>
169+
52170
---
53171

54172

173+
55174
## Response
56175

57176
[phone](./)

‎src/layouts/api-endpoint.hbs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,17 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
4747
{{> enum-values enumValues=this.itemEnumValues}}
4848
</details>
4949
{{/if}}
50+
{{#if this.objectParameters}}
51+
{{#each this.objectParameters}}
52+
53+
{{> property-collapsible this}}
54+
55+
{{/each}}
56+
{{else}}
5057

5158
---
5259
60+
{{/if}}
5361
{{/each}}
5462
{{else}}
5563
None

0 commit comments

Comments
 (0)