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
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,65 +28,65 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
28
28
29
29
## Request Parameters
30
30
31
-
**`device_id`** (Required)
31
+
**`device_id`***String* (Required)
32
32
33
33
ID of the device for which you want to create the new access code.
34
34
35
35
---
36
36
37
-
**`allow_external_modification`**
37
+
**`allow_external_modification`***Boolean*
38
38
39
39
Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
40
40
41
41
---
42
42
43
-
**`attempt_for_offline_device`**
43
+
**`attempt_for_offline_device`***Boolean*
44
44
45
45
---
46
46
47
-
**`code`**
47
+
**`code`***String*
48
48
49
49
Code to be used for access.
50
50
51
51
---
52
52
53
-
**`common_code_key`**
53
+
**`common_code_key`***String*
54
54
55
55
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).
56
56
57
57
---
58
58
59
-
**`ends_at`**
59
+
**`ends_at`***String*
60
60
61
61
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`.
62
62
63
63
---
64
64
65
-
**`is_external_modification_allowed`**
65
+
**`is_external_modification_allowed`***Boolean*
66
66
67
67
Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
68
68
69
69
---
70
70
71
-
**`is_offline_access_code`**
71
+
**`is_offline_access_code`***Boolean*
72
72
73
73
Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
74
74
75
75
---
76
76
77
-
**`is_one_time_use`**
77
+
**`is_one_time_use`***Boolean*
78
78
79
79
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.
80
80
81
81
---
82
82
83
-
**`max_time_rounding`**
83
+
**`max_time_rounding`***String*
84
84
85
85
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`.
86
86
87
87
---
88
88
89
-
**`name`**
89
+
**`name`***String*
90
90
91
91
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
92
92
@@ -98,31 +98,31 @@ Name of the new access code. Enables administrators and users to identify the ac
98
98
99
99
---
100
100
101
-
**`prefer_native_scheduling`**
101
+
**`prefer_native_scheduling`***Boolean*
102
102
103
103
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`.
104
104
105
105
---
106
106
107
-
**`preferred_code_length`**
107
+
**`preferred_code_length`***Number*
108
108
109
109
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.
110
110
111
111
---
112
112
113
-
**`starts_at`**
113
+
**`starts_at`***String*
114
114
115
115
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.
116
116
117
117
---
118
118
119
-
**`use_backup_access_code_pool`**
119
+
**`use_backup_access_code_pool`***Boolean*
120
120
121
121
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`](../../api-clients/access_codes/pull_backup_access_code.md).
Copy file name to clipboardExpand all lines: docs/api/access_codes/create_multiple.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,65 +36,65 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
36
36
37
37
## Request Parameters
38
38
39
-
**`device_ids`***of UUIDs* (Required)
39
+
**`device_ids`***Array**of UUIDs* (Required)
40
40
41
41
IDs of the devices for which you want to create the new access codes.
42
42
43
43
---
44
44
45
-
**`allow_external_modification`**
45
+
**`allow_external_modification`***Boolean*
46
46
47
47
Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
48
48
49
49
---
50
50
51
-
**`attempt_for_offline_device`**
51
+
**`attempt_for_offline_device`***Boolean*
52
52
53
53
---
54
54
55
-
**`behavior_when_code_cannot_be_shared`**
55
+
**`behavior_when_code_cannot_be_shared`***String*
56
56
57
57
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.
58
58
59
59
---
60
60
61
-
**`code`**
61
+
**`code`***String*
62
62
63
63
Code to be used for access.
64
64
65
65
---
66
66
67
-
**`ends_at`**
67
+
**`ends_at`***String*
68
68
69
69
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`.
70
70
71
71
---
72
72
73
-
**`is_external_modification_allowed`**
73
+
**`is_external_modification_allowed`***Boolean*
74
74
75
75
Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.
76
76
77
77
---
78
78
79
-
**`is_offline_access_code`**
79
+
**`is_offline_access_code`***Boolean*
80
80
81
81
Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).
82
82
83
83
---
84
84
85
-
**`is_one_time_use`**
85
+
**`is_one_time_use`***Boolean*
86
86
87
87
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.
88
88
89
89
---
90
90
91
-
**`max_time_rounding`**
91
+
**`max_time_rounding`***String*
92
92
93
93
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`.
94
94
95
95
---
96
96
97
-
**`name`**
97
+
**`name`***String*
98
98
99
99
Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
100
100
@@ -106,31 +106,31 @@ Name of the new access code. Enables administrators and users to identify the ac
106
106
107
107
---
108
108
109
-
**`prefer_native_scheduling`**
109
+
**`prefer_native_scheduling`***Boolean*
110
110
111
111
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`.
112
112
113
113
---
114
114
115
-
**`preferred_code_length`**
115
+
**`preferred_code_length`***Number*
116
116
117
117
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.
118
118
119
119
---
120
120
121
-
**`starts_at`**
121
+
**`starts_at`***String*
122
122
123
123
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.
124
124
125
125
---
126
126
127
-
**`use_backup_access_code_pool`**
127
+
**`use_backup_access_code_pool`***Boolean*
128
128
129
129
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`](../../api-clients/access_codes/pull_backup_access_code.md).
Copy file name to clipboardExpand all lines: docs/api/access_codes/report_device_constraints.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,25 +30,25 @@ To learn more, see [Authentication](https://docs.seam.co/latest/api/authenticati
30
30
31
31
## Request Parameters
32
32
33
-
**`device_id`** (Required)
33
+
**`device_id`***String* (Required)
34
34
35
35
ID of the device for which you want to report constraints.
36
36
37
37
---
38
38
39
-
**`max_code_length`**
39
+
**`max_code_length`***Number*
40
40
41
41
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`.
42
42
43
43
---
44
44
45
-
**`min_code_length`**
45
+
**`min_code_length`***Number*
46
46
47
47
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`.
48
48
49
49
---
50
50
51
-
**`supported_code_lengths`***of Numbers*
51
+
**`supported_code_lengths`***Array**of Numbers*
52
52
53
53
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