Skip to content

Commit 8a6400f

Browse files
committed
ci: Generate docs
1 parent dd28bbc commit 8a6400f

File tree

187 files changed

+1456
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

187 files changed

+1456
-0
lines changed

docs/api/access_codes/create.md

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

284284
ID of the device for which you want to create the new access code.
285285

286+
287+
286288
---
287289

288290
**`allow_external_modification`** *Boolean*
289291

290292
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
291293

294+
295+
292296
---
293297

294298
**`attempt_for_offline_device`** *Boolean*
295299

300+
301+
296302
---
297303

298304
**`code`** *String*
299305

300306
Code to be used for access.
301307

308+
309+
302310
---
303311

304312
**`common_code_key`** *String*
305313

306314
Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](../../capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md).
307315

316+
317+
308318
---
309319

310320
**`ends_at`** *String*
311321

312322
Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
313323

324+
325+
314326
---
315327

316328
**`is_external_modification_allowed`** *Boolean*
317329

318330
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
319331

332+
333+
320334
---
321335

322336
**`is_offline_access_code`** *Boolean*
323337

324338
Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
325339

340+
341+
326342
---
327343

328344
**`is_one_time_use`** *Boolean*
329345

330346
Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.
331347

348+
349+
332350
---
333351

334352
**`max_time_rounding`** *String*
335353

336354
Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
337355

356+
357+
338358
---
339359

340360
**`name`** *String*
@@ -347,30 +367,40 @@ To provide a consistent experience, Seam identifies the code on Seam by its name
347367

348368
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
349369

370+
371+
350372
---
351373

352374
**`prefer_native_scheduling`** *Boolean*
353375

354376
Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
355377

378+
379+
356380
---
357381

358382
**`preferred_code_length`** *Number*
359383

360384
Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
361385

386+
387+
362388
---
363389

364390
**`starts_at`** *String*
365391

366392
Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
367393

394+
395+
368396
---
369397

370398
**`use_backup_access_code_pool`** *Boolean*
371399

372400
Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).
373401

402+
403+
374404
---
375405

376406
**`use_offline_access_code`** *Boolean*
@@ -379,6 +409,7 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
379409
**Deprecated**. Use `is_offline_access_code` instead.
380410
{% endhint %}
381411

412+
382413
---
383414

384415

docs/api/access_codes/create_multiple.md

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

343343
IDs of the devices for which you want to create the new access codes.
344344

345+
346+
345347
---
346348

347349
**`allow_external_modification`** *Boolean*
348350

349351
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
350352

353+
354+
351355
---
352356

353357
**`attempt_for_offline_device`** *Boolean*
354358

359+
360+
355361
---
356362

357363
**`behavior_when_code_cannot_be_shared`** *String*
358364

359365
Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.
360366

367+
368+
361369
---
362370

363371
**`code`** *String*
364372

365373
Code to be used for access.
366374

375+
376+
367377
---
368378

369379
**`ends_at`** *String*
370380

371381
Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
372382

383+
384+
373385
---
374386

375387
**`is_external_modification_allowed`** *Boolean*
376388

377389
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
378390

391+
392+
379393
---
380394

381395
**`is_offline_access_code`** *Boolean*
382396

383397
Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
384398

399+
400+
385401
---
386402

387403
**`is_one_time_use`** *Boolean*
388404

389405
Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.
390406

407+
408+
391409
---
392410

393411
**`max_time_rounding`** *String*
394412

395413
Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
396414

415+
416+
397417
---
398418

399419
**`name`** *String*
@@ -406,30 +426,40 @@ To provide a consistent experience, Seam identifies the code on Seam by its name
406426

407427
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).
408428

429+
430+
409431
---
410432

411433
**`prefer_native_scheduling`** *Boolean*
412434

413435
Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
414436

437+
438+
415439
---
416440

417441
**`preferred_code_length`** *Number*
418442

419443
Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.
420444

445+
446+
421447
---
422448

423449
**`starts_at`** *String*
424450

425451
Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
426452

453+
454+
427455
---
428456

429457
**`use_backup_access_code_pool`** *Boolean*
430458

431459
Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).
432460

461+
462+
433463
---
434464

435465
**`use_offline_access_code`** *Boolean*
@@ -438,6 +468,7 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
438468
**Deprecated**. Use `is_offline_access_code` instead.
439469
{% endhint %}
440470

471+
441472
---
442473

443474

docs/api/access_codes/delete.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,12 +149,16 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
149149

150150
ID of the access code that you want to delete.
151151

152+
153+
152154
---
153155

154156
**`device_id`** *String*
155157

156158
ID of the device for which you want to delete the access code.
157159

160+
161+
158162
---
159163

160164

docs/api/access_codes/generate_code.md

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

146146
ID of the device for which you want to generate a code.
147147

148+
149+
148150
---
149151

150152

docs/api/access_codes/get.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,18 +280,24 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
280280

281281
ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
282282

283+
284+
283285
---
284286

285287
**`code`** *String*
286288

287289
Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
288290

291+
292+
289293
---
290294

291295
**`device_id`** *String*
292296

293297
ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
294298

299+
300+
295301
---
296302

297303

docs/api/access_codes/list.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,36 +297,48 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
297297

298298
IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.
299299

300+
301+
300302
---
301303

302304
**`customer_key`** *String*
303305

304306
Customer key for which you want to list access codes.
305307

308+
309+
306310
---
307311

308312
**`device_id`** *String*
309313

310314
ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.
311315

316+
317+
312318
---
313319

314320
**`limit`** *Number*
315321

316322
Numerical limit on the number of access codes to return.
317323

324+
325+
318326
---
319327

320328
**`page_cursor`** *String*
321329

322330
Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
323331

332+
333+
324334
---
325335

326336
**`user_identifier_key`** *String*
327337

328338
Your user ID for the user by which to filter access codes.
329339

340+
341+
330342
---
331343

332344

docs/api/access_codes/pull_backup_access_code.md

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

291291
ID of the access code for which you want to pull a backup access code.
292292

293+
294+
293295
---
294296

295297

docs/api/access_codes/report_device_constraints.md

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

167167
ID of the device for which you want to report constraints.
168168

169+
170+
169171
---
170172

171173
**`max_code_length`** *Number*
172174

173175
Maximum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.
174176

177+
178+
175179
---
176180

177181
**`min_code_length`** *Number*
178182

179183
Minimum supported code length as an integer between 4 and 20, inclusive. You can specify either `min_code_length`/`max_code_length` or `supported_code_lengths`.
180184

185+
186+
181187
---
182188

183189
**`supported_code_lengths`** *Array* *of Numbers*
184190

185191
Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either `supported_code_lengths` or `min_code_length`/`max_code_length`.
186192

193+
194+
187195
---
188196

189197

0 commit comments

Comments
 (0)