You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/access_codes/create.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -283,58 +283,78 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
283
283
284
284
ID of the device for which you want to create the new access code.
285
285
286
+
287
+
286
288
---
287
289
288
290
**`allow_external_modification`***Boolean*
289
291
290
292
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
291
293
294
+
295
+
292
296
---
293
297
294
298
**`attempt_for_offline_device`***Boolean*
295
299
300
+
301
+
296
302
---
297
303
298
304
**`code`***String*
299
305
300
306
Code to be used for access.
301
307
308
+
309
+
302
310
---
303
311
304
312
**`common_code_key`***String*
305
313
306
314
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).
307
315
316
+
317
+
308
318
---
309
319
310
320
**`ends_at`***String*
311
321
312
322
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`.
313
323
324
+
325
+
314
326
---
315
327
316
328
**`is_external_modification_allowed`***Boolean*
317
329
318
330
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
319
331
332
+
333
+
320
334
---
321
335
322
336
**`is_offline_access_code`***Boolean*
323
337
324
338
Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
325
339
340
+
341
+
326
342
---
327
343
328
344
**`is_one_time_use`***Boolean*
329
345
330
346
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.
331
347
348
+
349
+
332
350
---
333
351
334
352
**`max_time_rounding`***String*
335
353
336
354
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`.
337
355
356
+
357
+
338
358
---
339
359
340
360
**`name`***String*
@@ -347,30 +367,40 @@ To provide a consistent experience, Seam identifies the code on Seam by its name
347
367
348
368
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).
349
369
370
+
371
+
350
372
---
351
373
352
374
**`prefer_native_scheduling`***Boolean*
353
375
354
376
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`.
355
377
378
+
379
+
356
380
---
357
381
358
382
**`preferred_code_length`***Number*
359
383
360
384
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.
361
385
386
+
387
+
362
388
---
363
389
364
390
**`starts_at`***String*
365
391
366
392
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.
367
393
394
+
395
+
368
396
---
369
397
370
398
**`use_backup_access_code_pool`***Boolean*
371
399
372
400
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).
373
401
402
+
403
+
374
404
---
375
405
376
406
**`use_offline_access_code`***Boolean*
@@ -379,6 +409,7 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
379
409
**Deprecated**. Use `is_offline_access_code` instead.
Copy file name to clipboardExpand all lines: docs/api/access_codes/create_multiple.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -342,58 +342,78 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
342
342
343
343
IDs of the devices for which you want to create the new access codes.
344
344
345
+
346
+
345
347
---
346
348
347
349
**`allow_external_modification`***Boolean*
348
350
349
351
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
350
352
353
+
354
+
351
355
---
352
356
353
357
**`attempt_for_offline_device`***Boolean*
354
358
359
+
360
+
355
361
---
356
362
357
363
**`behavior_when_code_cannot_be_shared`***String*
358
364
359
365
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.
360
366
367
+
368
+
361
369
---
362
370
363
371
**`code`***String*
364
372
365
373
Code to be used for access.
366
374
375
+
376
+
367
377
---
368
378
369
379
**`ends_at`***String*
370
380
371
381
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`.
372
382
383
+
384
+
373
385
---
374
386
375
387
**`is_external_modification_allowed`***Boolean*
376
388
377
389
Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
378
390
391
+
392
+
379
393
---
380
394
381
395
**`is_offline_access_code`***Boolean*
382
396
383
397
Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
384
398
399
+
400
+
385
401
---
386
402
387
403
**`is_one_time_use`***Boolean*
388
404
389
405
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.
390
406
407
+
408
+
391
409
---
392
410
393
411
**`max_time_rounding`***String*
394
412
395
413
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`.
396
414
415
+
416
+
397
417
---
398
418
399
419
**`name`***String*
@@ -406,30 +426,40 @@ To provide a consistent experience, Seam identifies the code on Seam by its name
406
426
407
427
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).
408
428
429
+
430
+
409
431
---
410
432
411
433
**`prefer_native_scheduling`***Boolean*
412
434
413
435
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`.
414
436
437
+
438
+
415
439
---
416
440
417
441
**`preferred_code_length`***Number*
418
442
419
443
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.
420
444
445
+
446
+
421
447
---
422
448
423
449
**`starts_at`***String*
424
450
425
451
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.
426
452
453
+
454
+
427
455
---
428
456
429
457
**`use_backup_access_code_pool`***Boolean*
430
458
431
459
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).
432
460
461
+
462
+
433
463
---
434
464
435
465
**`use_offline_access_code`***Boolean*
@@ -438,6 +468,7 @@ Indicates whether to use a [backup access code pool](https://docs.seam.co/latest
438
468
**Deprecated**. Use `is_offline_access_code` instead.
Copy file name to clipboardExpand all lines: docs/api/access_codes/report_device_constraints.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -166,24 +166,32 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
166
166
167
167
ID of the device for which you want to report constraints.
168
168
169
+
170
+
169
171
---
170
172
171
173
**`max_code_length`***Number*
172
174
173
175
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`.
174
176
177
+
178
+
175
179
---
176
180
177
181
**`min_code_length`***Number*
178
182
179
183
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`.
180
184
185
+
186
+
181
187
---
182
188
183
189
**`supported_code_lengths`***Array**of Numbers*
184
190
185
191
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`.
0 commit comments