@seamapi/types 1.375.2 → 1.377.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +1708 -529
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1588 -363
- package/lib/seam/connect/models/access-codes/managed-access-code.js +48 -23
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +13 -2
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +182 -150
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +2 -3
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/index.d.ts +1 -1
- package/lib/seam/connect/models/acs/acs-users/index.js +1 -1
- package/lib/seam/connect/models/acs/acs-users/index.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/{pending-modifications.d.ts → pending-mutations.d.ts} +191 -106
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js +90 -0
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +257 -58
- package/lib/seam/connect/openapi.js +1588 -436
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1155 -161
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +95 -60
- package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +15 -2
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +2 -3
- package/src/lib/seam/connect/models/acs/acs-users/index.ts +1 -1
- package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts +110 -0
- package/src/lib/seam/connect/openapi.ts +1928 -446
- package/src/lib/seam/connect/route-types.ts +1162 -161
- package/lib/seam/connect/models/acs/acs-users/pending-modifications.js +0 -85
- package/lib/seam/connect/models/acs/acs-users/pending-modifications.js.map +0 -1
- package/src/lib/seam/connect/models/acs/acs-users/pending-modifications.ts +0 -109
|
@@ -2,6 +2,7 @@ export default {
|
|
|
2
2
|
components: {
|
|
3
3
|
schemas: {
|
|
4
4
|
access_code: {
|
|
5
|
+
description: 'Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.',
|
|
5
6
|
properties: {
|
|
6
7
|
access_code_id: {
|
|
7
8
|
description: 'Unique identifier for the access code.',
|
|
@@ -35,21 +36,32 @@ export default {
|
|
|
35
36
|
type: 'string',
|
|
36
37
|
},
|
|
37
38
|
errors: {
|
|
38
|
-
description: '
|
|
39
|
+
description: 'Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
39
40
|
items: {
|
|
40
41
|
discriminator: { propertyName: 'error_code' },
|
|
41
42
|
oneOf: [
|
|
42
43
|
{
|
|
43
|
-
description: 'Failed to set code on
|
|
44
|
+
description: 'Failed to set code on SmartThings device.',
|
|
44
45
|
properties: {
|
|
45
|
-
created_at: {
|
|
46
|
+
created_at: {
|
|
47
|
+
description: 'Date and time at which Seam created the error.',
|
|
48
|
+
format: 'date-time',
|
|
49
|
+
type: 'string',
|
|
50
|
+
},
|
|
46
51
|
error_code: {
|
|
47
52
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
48
53
|
enum: ['smartthings_failed_to_set_access_code'],
|
|
49
54
|
type: 'string',
|
|
50
55
|
},
|
|
51
|
-
is_access_code_error: {
|
|
52
|
-
|
|
56
|
+
is_access_code_error: {
|
|
57
|
+
description: 'Indicates that this is an access code error.',
|
|
58
|
+
enum: [true],
|
|
59
|
+
type: 'boolean',
|
|
60
|
+
},
|
|
61
|
+
message: {
|
|
62
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
63
|
+
type: 'string',
|
|
64
|
+
},
|
|
53
65
|
},
|
|
54
66
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
55
67
|
type: 'object',
|
|
@@ -57,7 +69,11 @@ export default {
|
|
|
57
69
|
{
|
|
58
70
|
description: 'Failed to set code after multiple retries.',
|
|
59
71
|
properties: {
|
|
60
|
-
created_at: {
|
|
72
|
+
created_at: {
|
|
73
|
+
description: 'Date and time at which Seam created the error.',
|
|
74
|
+
format: 'date-time',
|
|
75
|
+
type: 'string',
|
|
76
|
+
},
|
|
61
77
|
error_code: {
|
|
62
78
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
63
79
|
enum: [
|
|
@@ -65,8 +81,15 @@ export default {
|
|
|
65
81
|
],
|
|
66
82
|
type: 'string',
|
|
67
83
|
},
|
|
68
|
-
is_access_code_error: {
|
|
69
|
-
|
|
84
|
+
is_access_code_error: {
|
|
85
|
+
description: 'Indicates that this is an access code error.',
|
|
86
|
+
enum: [true],
|
|
87
|
+
type: 'boolean',
|
|
88
|
+
},
|
|
89
|
+
message: {
|
|
90
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
91
|
+
type: 'string',
|
|
92
|
+
},
|
|
70
93
|
},
|
|
71
94
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
72
95
|
type: 'object',
|
|
@@ -74,14 +97,25 @@ export default {
|
|
|
74
97
|
{
|
|
75
98
|
description: 'No free slots available on the device.',
|
|
76
99
|
properties: {
|
|
77
|
-
created_at: {
|
|
100
|
+
created_at: {
|
|
101
|
+
description: 'Date and time at which Seam created the error.',
|
|
102
|
+
format: 'date-time',
|
|
103
|
+
type: 'string',
|
|
104
|
+
},
|
|
78
105
|
error_code: {
|
|
79
106
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
80
107
|
enum: ['smartthings_no_free_slots_available'],
|
|
81
108
|
type: 'string',
|
|
82
109
|
},
|
|
83
|
-
is_access_code_error: {
|
|
84
|
-
|
|
110
|
+
is_access_code_error: {
|
|
111
|
+
description: 'Indicates that this is an access code error.',
|
|
112
|
+
enum: [true],
|
|
113
|
+
type: 'boolean',
|
|
114
|
+
},
|
|
115
|
+
message: {
|
|
116
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
117
|
+
type: 'string',
|
|
118
|
+
},
|
|
85
119
|
},
|
|
86
120
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
87
121
|
type: 'object',
|
|
@@ -89,14 +123,25 @@ export default {
|
|
|
89
123
|
{
|
|
90
124
|
description: 'Failed to set code on device.',
|
|
91
125
|
properties: {
|
|
92
|
-
created_at: {
|
|
126
|
+
created_at: {
|
|
127
|
+
description: 'Date and time at which Seam created the error.',
|
|
128
|
+
format: 'date-time',
|
|
129
|
+
type: 'string',
|
|
130
|
+
},
|
|
93
131
|
error_code: {
|
|
94
132
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
95
133
|
enum: ['failed_to_set_on_device'],
|
|
96
134
|
type: 'string',
|
|
97
135
|
},
|
|
98
|
-
is_access_code_error: {
|
|
99
|
-
|
|
136
|
+
is_access_code_error: {
|
|
137
|
+
description: 'Indicates that this is an access code error.',
|
|
138
|
+
enum: [true],
|
|
139
|
+
type: 'boolean',
|
|
140
|
+
},
|
|
141
|
+
message: {
|
|
142
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
143
|
+
type: 'string',
|
|
144
|
+
},
|
|
100
145
|
},
|
|
101
146
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
102
147
|
type: 'object',
|
|
@@ -104,14 +149,25 @@ export default {
|
|
|
104
149
|
{
|
|
105
150
|
description: 'Failed to remove code from device.',
|
|
106
151
|
properties: {
|
|
107
|
-
created_at: {
|
|
152
|
+
created_at: {
|
|
153
|
+
description: 'Date and time at which Seam created the error.',
|
|
154
|
+
format: 'date-time',
|
|
155
|
+
type: 'string',
|
|
156
|
+
},
|
|
108
157
|
error_code: {
|
|
109
158
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
110
159
|
enum: ['failed_to_remove_from_device'],
|
|
111
160
|
type: 'string',
|
|
112
161
|
},
|
|
113
|
-
is_access_code_error: {
|
|
114
|
-
|
|
162
|
+
is_access_code_error: {
|
|
163
|
+
description: 'Indicates that this is an access code error.',
|
|
164
|
+
enum: [true],
|
|
165
|
+
type: 'boolean',
|
|
166
|
+
},
|
|
167
|
+
message: {
|
|
168
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
169
|
+
type: 'string',
|
|
170
|
+
},
|
|
115
171
|
},
|
|
116
172
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
117
173
|
type: 'object',
|
|
@@ -119,14 +175,25 @@ export default {
|
|
|
119
175
|
{
|
|
120
176
|
description: 'Duplicate access code detected on device.',
|
|
121
177
|
properties: {
|
|
122
|
-
created_at: {
|
|
178
|
+
created_at: {
|
|
179
|
+
description: 'Date and time at which Seam created the error.',
|
|
180
|
+
format: 'date-time',
|
|
181
|
+
type: 'string',
|
|
182
|
+
},
|
|
123
183
|
error_code: {
|
|
124
184
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
125
185
|
enum: ['duplicate_code_on_device'],
|
|
126
186
|
type: 'string',
|
|
127
187
|
},
|
|
128
|
-
is_access_code_error: {
|
|
129
|
-
|
|
188
|
+
is_access_code_error: {
|
|
189
|
+
description: 'Indicates that this is an access code error.',
|
|
190
|
+
enum: [true],
|
|
191
|
+
type: 'boolean',
|
|
192
|
+
},
|
|
193
|
+
message: {
|
|
194
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
195
|
+
type: 'string',
|
|
196
|
+
},
|
|
130
197
|
},
|
|
131
198
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
132
199
|
type: 'object',
|
|
@@ -134,14 +201,25 @@ export default {
|
|
|
134
201
|
{
|
|
135
202
|
description: 'An attempt to modify this access code was prevented.',
|
|
136
203
|
properties: {
|
|
137
|
-
created_at: {
|
|
204
|
+
created_at: {
|
|
205
|
+
description: 'Date and time at which Seam created the error.',
|
|
206
|
+
format: 'date-time',
|
|
207
|
+
type: 'string',
|
|
208
|
+
},
|
|
138
209
|
error_code: {
|
|
139
210
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
140
211
|
enum: ['duplicate_code_attempt_prevented'],
|
|
141
212
|
type: 'string',
|
|
142
213
|
},
|
|
143
|
-
is_access_code_error: {
|
|
144
|
-
|
|
214
|
+
is_access_code_error: {
|
|
215
|
+
description: 'Indicates that this is an access code error.',
|
|
216
|
+
enum: [true],
|
|
217
|
+
type: 'boolean',
|
|
218
|
+
},
|
|
219
|
+
message: {
|
|
220
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
221
|
+
type: 'string',
|
|
222
|
+
},
|
|
145
223
|
},
|
|
146
224
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
147
225
|
type: 'object',
|
|
@@ -149,14 +227,25 @@ export default {
|
|
|
149
227
|
{
|
|
150
228
|
description: 'Igloohome bridge has too many pending jobs in the queue.',
|
|
151
229
|
properties: {
|
|
152
|
-
created_at: {
|
|
230
|
+
created_at: {
|
|
231
|
+
description: 'Date and time at which Seam created the error.',
|
|
232
|
+
format: 'date-time',
|
|
233
|
+
type: 'string',
|
|
234
|
+
},
|
|
153
235
|
error_code: {
|
|
154
236
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
155
237
|
enum: ['igloohome_bridge_too_many_pending_jobs'],
|
|
156
238
|
type: 'string',
|
|
157
239
|
},
|
|
158
|
-
is_access_code_error: {
|
|
159
|
-
|
|
240
|
+
is_access_code_error: {
|
|
241
|
+
description: 'Indicates that this is an access code error.',
|
|
242
|
+
enum: [true],
|
|
243
|
+
type: 'boolean',
|
|
244
|
+
},
|
|
245
|
+
message: {
|
|
246
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
247
|
+
type: 'string',
|
|
248
|
+
},
|
|
160
249
|
},
|
|
161
250
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
162
251
|
type: 'object',
|
|
@@ -164,22 +253,37 @@ export default {
|
|
|
164
253
|
{
|
|
165
254
|
description: 'Igloohome bridge is offline.',
|
|
166
255
|
properties: {
|
|
167
|
-
created_at: {
|
|
256
|
+
created_at: {
|
|
257
|
+
description: 'Date and time at which Seam created the error.',
|
|
258
|
+
format: 'date-time',
|
|
259
|
+
type: 'string',
|
|
260
|
+
},
|
|
168
261
|
error_code: {
|
|
169
262
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
170
263
|
enum: ['igloohome_bridge_offline'],
|
|
171
264
|
type: 'string',
|
|
172
265
|
},
|
|
173
|
-
is_access_code_error: {
|
|
174
|
-
|
|
266
|
+
is_access_code_error: {
|
|
267
|
+
description: 'Indicates that this is an access code error.',
|
|
268
|
+
enum: [true],
|
|
269
|
+
type: 'boolean',
|
|
270
|
+
},
|
|
271
|
+
message: {
|
|
272
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
273
|
+
type: 'string',
|
|
274
|
+
},
|
|
175
275
|
},
|
|
176
276
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
177
277
|
type: 'object',
|
|
178
278
|
},
|
|
179
279
|
{
|
|
180
|
-
description: 'Lock
|
|
280
|
+
description: 'Lock has reached maximum amount of codes.',
|
|
181
281
|
properties: {
|
|
182
|
-
created_at: {
|
|
282
|
+
created_at: {
|
|
283
|
+
description: 'Date and time at which Seam created the error.',
|
|
284
|
+
format: 'date-time',
|
|
285
|
+
type: 'string',
|
|
286
|
+
},
|
|
183
287
|
error_code: {
|
|
184
288
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
185
289
|
enum: [
|
|
@@ -187,23 +291,41 @@ export default {
|
|
|
187
291
|
],
|
|
188
292
|
type: 'string',
|
|
189
293
|
},
|
|
190
|
-
is_access_code_error: {
|
|
191
|
-
|
|
294
|
+
is_access_code_error: {
|
|
295
|
+
description: 'Indicates that this is an access code error.',
|
|
296
|
+
enum: [true],
|
|
297
|
+
type: 'boolean',
|
|
298
|
+
},
|
|
299
|
+
message: {
|
|
300
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
301
|
+
type: 'string',
|
|
302
|
+
},
|
|
192
303
|
},
|
|
193
304
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
194
305
|
type: 'object',
|
|
195
306
|
},
|
|
196
307
|
{
|
|
197
|
-
description: 'Unable to confirm the access code is set on Kwikset device.',
|
|
308
|
+
description: 'Unable to confirm that the access code is set on Kwikset device.',
|
|
198
309
|
properties: {
|
|
199
|
-
created_at: {
|
|
310
|
+
created_at: {
|
|
311
|
+
description: 'Date and time at which Seam created the error.',
|
|
312
|
+
format: 'date-time',
|
|
313
|
+
type: 'string',
|
|
314
|
+
},
|
|
200
315
|
error_code: {
|
|
201
316
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
202
317
|
enum: ['kwikset_unable_to_confirm_code'],
|
|
203
318
|
type: 'string',
|
|
204
319
|
},
|
|
205
|
-
is_access_code_error: {
|
|
206
|
-
|
|
320
|
+
is_access_code_error: {
|
|
321
|
+
description: 'Indicates that this is an access code error.',
|
|
322
|
+
enum: [true],
|
|
323
|
+
type: 'boolean',
|
|
324
|
+
},
|
|
325
|
+
message: {
|
|
326
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
327
|
+
type: 'string',
|
|
328
|
+
},
|
|
207
329
|
},
|
|
208
330
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
209
331
|
type: 'object',
|
|
@@ -211,14 +333,25 @@ export default {
|
|
|
211
333
|
{
|
|
212
334
|
description: 'Unable to confirm the deletion of the access code on Kwikset device.',
|
|
213
335
|
properties: {
|
|
214
|
-
created_at: {
|
|
336
|
+
created_at: {
|
|
337
|
+
description: 'Date and time at which Seam created the error.',
|
|
338
|
+
format: 'date-time',
|
|
339
|
+
type: 'string',
|
|
340
|
+
},
|
|
215
341
|
error_code: {
|
|
216
342
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
217
343
|
enum: ['kwikset_unable_to_confirm_deletion'],
|
|
218
344
|
type: 'string',
|
|
219
345
|
},
|
|
220
|
-
is_access_code_error: {
|
|
221
|
-
|
|
346
|
+
is_access_code_error: {
|
|
347
|
+
description: 'Indicates that this is an access code error.',
|
|
348
|
+
enum: [true],
|
|
349
|
+
type: 'boolean',
|
|
350
|
+
},
|
|
351
|
+
message: {
|
|
352
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
353
|
+
type: 'string',
|
|
354
|
+
},
|
|
222
355
|
},
|
|
223
356
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
224
357
|
type: 'object',
|
|
@@ -226,14 +359,25 @@ export default {
|
|
|
226
359
|
{
|
|
227
360
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
228
361
|
properties: {
|
|
229
|
-
created_at: {
|
|
362
|
+
created_at: {
|
|
363
|
+
description: 'Date and time at which Seam created the error.',
|
|
364
|
+
format: 'date-time',
|
|
365
|
+
type: 'string',
|
|
366
|
+
},
|
|
230
367
|
error_code: {
|
|
231
368
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
232
369
|
enum: ['code_modified_external_to_seam'],
|
|
233
370
|
type: 'string',
|
|
234
371
|
},
|
|
235
|
-
is_access_code_error: {
|
|
236
|
-
|
|
372
|
+
is_access_code_error: {
|
|
373
|
+
description: 'Indicates that this is an access code error.',
|
|
374
|
+
enum: [true],
|
|
375
|
+
type: 'boolean',
|
|
376
|
+
},
|
|
377
|
+
message: {
|
|
378
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
379
|
+
type: 'string',
|
|
380
|
+
},
|
|
237
381
|
},
|
|
238
382
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
239
383
|
type: 'object',
|
|
@@ -241,14 +385,25 @@ export default {
|
|
|
241
385
|
{
|
|
242
386
|
description: 'Invalid code length for August lock.',
|
|
243
387
|
properties: {
|
|
244
|
-
created_at: {
|
|
388
|
+
created_at: {
|
|
389
|
+
description: 'Date and time at which Seam created the error.',
|
|
390
|
+
format: 'date-time',
|
|
391
|
+
type: 'string',
|
|
392
|
+
},
|
|
245
393
|
error_code: {
|
|
246
394
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
247
395
|
enum: ['august_lock_invalid_code_length'],
|
|
248
396
|
type: 'string',
|
|
249
397
|
},
|
|
250
|
-
is_access_code_error: {
|
|
251
|
-
|
|
398
|
+
is_access_code_error: {
|
|
399
|
+
description: 'Indicates that this is an access code error.',
|
|
400
|
+
enum: [true],
|
|
401
|
+
type: 'boolean',
|
|
402
|
+
},
|
|
403
|
+
message: {
|
|
404
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
405
|
+
type: 'string',
|
|
406
|
+
},
|
|
252
407
|
},
|
|
253
408
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
254
409
|
type: 'object',
|
|
@@ -256,14 +411,25 @@ export default {
|
|
|
256
411
|
{
|
|
257
412
|
description: 'Access code has not yet been fully moved to the device.',
|
|
258
413
|
properties: {
|
|
259
|
-
created_at: {
|
|
414
|
+
created_at: {
|
|
415
|
+
description: 'Date and time at which Seam created the error.',
|
|
416
|
+
format: 'date-time',
|
|
417
|
+
type: 'string',
|
|
418
|
+
},
|
|
260
419
|
error_code: {
|
|
261
420
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
262
421
|
enum: ['august_device_programming_delay'],
|
|
263
422
|
type: 'string',
|
|
264
423
|
},
|
|
265
|
-
is_access_code_error: {
|
|
266
|
-
|
|
424
|
+
is_access_code_error: {
|
|
425
|
+
description: 'Indicates that this is an access code error.',
|
|
426
|
+
enum: [true],
|
|
427
|
+
type: 'boolean',
|
|
428
|
+
},
|
|
429
|
+
message: {
|
|
430
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
431
|
+
type: 'string',
|
|
432
|
+
},
|
|
267
433
|
},
|
|
268
434
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
269
435
|
type: 'object',
|
|
@@ -271,14 +437,25 @@ export default {
|
|
|
271
437
|
{
|
|
272
438
|
description: 'All access code slots on the device are full.',
|
|
273
439
|
properties: {
|
|
274
|
-
created_at: {
|
|
440
|
+
created_at: {
|
|
441
|
+
description: 'Date and time at which Seam created the error.',
|
|
442
|
+
format: 'date-time',
|
|
443
|
+
type: 'string',
|
|
444
|
+
},
|
|
275
445
|
error_code: {
|
|
276
446
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
277
447
|
enum: ['august_device_slots_full'],
|
|
278
448
|
type: 'string',
|
|
279
449
|
},
|
|
280
|
-
is_access_code_error: {
|
|
281
|
-
|
|
450
|
+
is_access_code_error: {
|
|
451
|
+
description: 'Indicates that this is an access code error.',
|
|
452
|
+
enum: [true],
|
|
453
|
+
type: 'boolean',
|
|
454
|
+
},
|
|
455
|
+
message: {
|
|
456
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
457
|
+
type: 'string',
|
|
458
|
+
},
|
|
282
459
|
},
|
|
283
460
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
284
461
|
type: 'object',
|
|
@@ -286,14 +463,25 @@ export default {
|
|
|
286
463
|
{
|
|
287
464
|
description: 'August lock is missing a keypad.',
|
|
288
465
|
properties: {
|
|
289
|
-
created_at: {
|
|
466
|
+
created_at: {
|
|
467
|
+
description: 'Date and time at which Seam created the error.',
|
|
468
|
+
format: 'date-time',
|
|
469
|
+
type: 'string',
|
|
470
|
+
},
|
|
290
471
|
error_code: {
|
|
291
472
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
292
473
|
enum: ['august_lock_missing_keypad'],
|
|
293
474
|
type: 'string',
|
|
294
475
|
},
|
|
295
|
-
is_access_code_error: {
|
|
296
|
-
|
|
476
|
+
is_access_code_error: {
|
|
477
|
+
description: 'Indicates that this is an access code error.',
|
|
478
|
+
enum: [true],
|
|
479
|
+
type: 'boolean',
|
|
480
|
+
},
|
|
481
|
+
message: {
|
|
482
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
483
|
+
type: 'string',
|
|
484
|
+
},
|
|
297
485
|
},
|
|
298
486
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
299
487
|
type: 'object',
|
|
@@ -301,14 +489,25 @@ export default {
|
|
|
301
489
|
{
|
|
302
490
|
description: 'August lock is temporarily offline.',
|
|
303
491
|
properties: {
|
|
304
|
-
created_at: {
|
|
492
|
+
created_at: {
|
|
493
|
+
description: 'Date and time at which Seam created the error.',
|
|
494
|
+
format: 'date-time',
|
|
495
|
+
type: 'string',
|
|
496
|
+
},
|
|
305
497
|
error_code: {
|
|
306
498
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
307
499
|
enum: ['august_lock_temporarily_offline'],
|
|
308
500
|
type: 'string',
|
|
309
501
|
},
|
|
310
|
-
is_access_code_error: {
|
|
311
|
-
|
|
502
|
+
is_access_code_error: {
|
|
503
|
+
description: 'Indicates that this is an access code error.',
|
|
504
|
+
enum: [true],
|
|
505
|
+
type: 'boolean',
|
|
506
|
+
},
|
|
507
|
+
message: {
|
|
508
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
509
|
+
type: 'string',
|
|
510
|
+
},
|
|
312
511
|
},
|
|
313
512
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
314
513
|
type: 'object',
|
|
@@ -316,14 +515,25 @@ export default {
|
|
|
316
515
|
{
|
|
317
516
|
description: 'Salto site user is not subscribed.',
|
|
318
517
|
properties: {
|
|
319
|
-
created_at: {
|
|
518
|
+
created_at: {
|
|
519
|
+
description: 'Date and time at which Seam created the error.',
|
|
520
|
+
format: 'date-time',
|
|
521
|
+
type: 'string',
|
|
522
|
+
},
|
|
320
523
|
error_code: {
|
|
321
524
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
322
525
|
enum: ['salto_ks_user_not_subscribed'],
|
|
323
526
|
type: 'string',
|
|
324
527
|
},
|
|
325
|
-
is_access_code_error: {
|
|
326
|
-
|
|
528
|
+
is_access_code_error: {
|
|
529
|
+
description: 'Indicates that this is an access code error.',
|
|
530
|
+
enum: [true],
|
|
531
|
+
type: 'boolean',
|
|
532
|
+
},
|
|
533
|
+
message: {
|
|
534
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
535
|
+
type: 'string',
|
|
536
|
+
},
|
|
327
537
|
},
|
|
328
538
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
329
539
|
type: 'object',
|
|
@@ -331,14 +541,25 @@ export default {
|
|
|
331
541
|
{
|
|
332
542
|
description: 'Access code has not yet been fully moved to the device.',
|
|
333
543
|
properties: {
|
|
334
|
-
created_at: {
|
|
544
|
+
created_at: {
|
|
545
|
+
description: 'Date and time at which Seam created the error.',
|
|
546
|
+
format: 'date-time',
|
|
547
|
+
type: 'string',
|
|
548
|
+
},
|
|
335
549
|
error_code: {
|
|
336
550
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
337
551
|
enum: ['hubitat_device_programming_delay'],
|
|
338
552
|
type: 'string',
|
|
339
553
|
},
|
|
340
|
-
is_access_code_error: {
|
|
341
|
-
|
|
554
|
+
is_access_code_error: {
|
|
555
|
+
description: 'Indicates that this is an access code error.',
|
|
556
|
+
enum: [true],
|
|
557
|
+
type: 'boolean',
|
|
558
|
+
},
|
|
559
|
+
message: {
|
|
560
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
561
|
+
type: 'string',
|
|
562
|
+
},
|
|
342
563
|
},
|
|
343
564
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
344
565
|
type: 'object',
|
|
@@ -346,14 +567,25 @@ export default {
|
|
|
346
567
|
{
|
|
347
568
|
description: 'No free positions available on the device.',
|
|
348
569
|
properties: {
|
|
349
|
-
created_at: {
|
|
570
|
+
created_at: {
|
|
571
|
+
description: 'Date and time at which Seam created the error.',
|
|
572
|
+
format: 'date-time',
|
|
573
|
+
type: 'string',
|
|
574
|
+
},
|
|
350
575
|
error_code: {
|
|
351
576
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
352
577
|
enum: ['hubitat_no_free_positions_available'],
|
|
353
578
|
type: 'string',
|
|
354
579
|
},
|
|
355
|
-
is_access_code_error: {
|
|
356
|
-
|
|
580
|
+
is_access_code_error: {
|
|
581
|
+
description: 'Indicates that this is an access code error.',
|
|
582
|
+
enum: [true],
|
|
583
|
+
type: 'boolean',
|
|
584
|
+
},
|
|
585
|
+
message: {
|
|
586
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
587
|
+
type: 'string',
|
|
588
|
+
},
|
|
357
589
|
},
|
|
358
590
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
359
591
|
type: 'object',
|
|
@@ -361,14 +593,25 @@ export default {
|
|
|
361
593
|
{
|
|
362
594
|
description: 'Duplicate access code name detected.',
|
|
363
595
|
properties: {
|
|
364
|
-
created_at: {
|
|
596
|
+
created_at: {
|
|
597
|
+
description: 'Date and time at which Seam created the error.',
|
|
598
|
+
format: 'date-time',
|
|
599
|
+
type: 'string',
|
|
600
|
+
},
|
|
365
601
|
error_code: {
|
|
366
602
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
367
603
|
enum: ['wyze_duplicate_code_name'],
|
|
368
604
|
type: 'string',
|
|
369
605
|
},
|
|
370
|
-
is_access_code_error: {
|
|
371
|
-
|
|
606
|
+
is_access_code_error: {
|
|
607
|
+
description: 'Indicates that this is an access code error.',
|
|
608
|
+
enum: [true],
|
|
609
|
+
type: 'boolean',
|
|
610
|
+
},
|
|
611
|
+
message: {
|
|
612
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
613
|
+
type: 'string',
|
|
614
|
+
},
|
|
372
615
|
},
|
|
373
616
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
374
617
|
type: 'object',
|
|
@@ -376,14 +619,25 @@ export default {
|
|
|
376
619
|
{
|
|
377
620
|
description: 'Potential duplicate access code detected.',
|
|
378
621
|
properties: {
|
|
379
|
-
created_at: {
|
|
622
|
+
created_at: {
|
|
623
|
+
description: 'Date and time at which Seam created the error.',
|
|
624
|
+
format: 'date-time',
|
|
625
|
+
type: 'string',
|
|
626
|
+
},
|
|
380
627
|
error_code: {
|
|
381
628
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
382
629
|
enum: ['wyze_potential_duplicate_code'],
|
|
383
630
|
type: 'string',
|
|
384
631
|
},
|
|
385
|
-
is_access_code_error: {
|
|
386
|
-
|
|
632
|
+
is_access_code_error: {
|
|
633
|
+
description: 'Indicates that this is an access code error.',
|
|
634
|
+
enum: [true],
|
|
635
|
+
type: 'boolean',
|
|
636
|
+
},
|
|
637
|
+
message: {
|
|
638
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
639
|
+
type: 'string',
|
|
640
|
+
},
|
|
387
641
|
},
|
|
388
642
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
389
643
|
type: 'object',
|
|
@@ -391,14 +645,25 @@ export default {
|
|
|
391
645
|
{
|
|
392
646
|
description: 'No valid user level for Oracode.',
|
|
393
647
|
properties: {
|
|
394
|
-
created_at: {
|
|
648
|
+
created_at: {
|
|
649
|
+
description: 'Date and time at which Seam created the error.',
|
|
650
|
+
format: 'date-time',
|
|
651
|
+
type: 'string',
|
|
652
|
+
},
|
|
395
653
|
error_code: {
|
|
396
654
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
397
655
|
enum: ['dormakaba_oracode_no_valid_user_level'],
|
|
398
656
|
type: 'string',
|
|
399
657
|
},
|
|
400
|
-
is_access_code_error: {
|
|
401
|
-
|
|
658
|
+
is_access_code_error: {
|
|
659
|
+
description: 'Indicates that this is an access code error.',
|
|
660
|
+
enum: [true],
|
|
661
|
+
type: 'boolean',
|
|
662
|
+
},
|
|
663
|
+
message: {
|
|
664
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
665
|
+
type: 'string',
|
|
666
|
+
},
|
|
402
667
|
},
|
|
403
668
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
404
669
|
type: 'object',
|
|
@@ -735,11 +1000,11 @@ export default {
|
|
|
735
1000
|
type: 'boolean',
|
|
736
1001
|
},
|
|
737
1002
|
is_offline_access_code: {
|
|
738
|
-
description: 'Indicates whether the access code is intended for use in offline scenarios. If
|
|
1003
|
+
description: 'Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.',
|
|
739
1004
|
type: 'boolean',
|
|
740
1005
|
},
|
|
741
1006
|
is_one_time_use: {
|
|
742
|
-
description: 'Indicates whether the access code can only be used once. If
|
|
1007
|
+
description: 'Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.',
|
|
743
1008
|
type: 'boolean',
|
|
744
1009
|
},
|
|
745
1010
|
is_scheduled_on_device: {
|
|
@@ -768,25 +1033,33 @@ export default {
|
|
|
768
1033
|
type: 'string',
|
|
769
1034
|
},
|
|
770
1035
|
status: {
|
|
771
|
-
description: '
|
|
1036
|
+
description: 'Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.',
|
|
772
1037
|
enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
|
|
773
1038
|
type: 'string',
|
|
774
1039
|
},
|
|
775
1040
|
type: {
|
|
776
|
-
description: 'Nature of the access code. Values are
|
|
1041
|
+
description: 'Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.',
|
|
777
1042
|
enum: ['time_bound', 'ongoing'],
|
|
778
1043
|
type: 'string',
|
|
779
1044
|
},
|
|
780
1045
|
warnings: {
|
|
781
|
-
description: '
|
|
1046
|
+
description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
782
1047
|
items: {
|
|
1048
|
+
description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
783
1049
|
discriminator: { propertyName: 'warning_code' },
|
|
784
1050
|
oneOf: [
|
|
785
1051
|
{
|
|
786
|
-
description: 'Failed to set code on
|
|
1052
|
+
description: 'Failed to set code on SmartThings device.',
|
|
787
1053
|
properties: {
|
|
788
|
-
created_at: {
|
|
789
|
-
|
|
1054
|
+
created_at: {
|
|
1055
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1056
|
+
format: 'date-time',
|
|
1057
|
+
type: 'string',
|
|
1058
|
+
},
|
|
1059
|
+
message: {
|
|
1060
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1061
|
+
type: 'string',
|
|
1062
|
+
},
|
|
790
1063
|
warning_code: {
|
|
791
1064
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
792
1065
|
enum: ['smartthings_failed_to_set_access_code'],
|
|
@@ -799,8 +1072,15 @@ export default {
|
|
|
799
1072
|
{
|
|
800
1073
|
description: 'Duplicate access code detected.',
|
|
801
1074
|
properties: {
|
|
802
|
-
created_at: {
|
|
803
|
-
|
|
1075
|
+
created_at: {
|
|
1076
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1077
|
+
format: 'date-time',
|
|
1078
|
+
type: 'string',
|
|
1079
|
+
},
|
|
1080
|
+
message: {
|
|
1081
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1082
|
+
type: 'string',
|
|
1083
|
+
},
|
|
804
1084
|
warning_code: {
|
|
805
1085
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
806
1086
|
enum: ['schlage_detected_duplicate'],
|
|
@@ -813,8 +1093,15 @@ export default {
|
|
|
813
1093
|
{
|
|
814
1094
|
description: 'Received an error when attempting to create this code.',
|
|
815
1095
|
properties: {
|
|
816
|
-
created_at: {
|
|
817
|
-
|
|
1096
|
+
created_at: {
|
|
1097
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1098
|
+
format: 'date-time',
|
|
1099
|
+
type: 'string',
|
|
1100
|
+
},
|
|
1101
|
+
message: {
|
|
1102
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1103
|
+
type: 'string',
|
|
1104
|
+
},
|
|
818
1105
|
warning_code: {
|
|
819
1106
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
820
1107
|
enum: ['schlage_creation_outage'],
|
|
@@ -827,8 +1114,15 @@ export default {
|
|
|
827
1114
|
{
|
|
828
1115
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
829
1116
|
properties: {
|
|
830
|
-
created_at: {
|
|
831
|
-
|
|
1117
|
+
created_at: {
|
|
1118
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1119
|
+
format: 'date-time',
|
|
1120
|
+
type: 'string',
|
|
1121
|
+
},
|
|
1122
|
+
message: {
|
|
1123
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1124
|
+
type: 'string',
|
|
1125
|
+
},
|
|
832
1126
|
warning_code: {
|
|
833
1127
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
834
1128
|
enum: ['code_modified_external_to_seam'],
|
|
@@ -841,8 +1135,15 @@ export default {
|
|
|
841
1135
|
{
|
|
842
1136
|
description: 'Delay in setting code on device.',
|
|
843
1137
|
properties: {
|
|
844
|
-
created_at: {
|
|
845
|
-
|
|
1138
|
+
created_at: {
|
|
1139
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1140
|
+
format: 'date-time',
|
|
1141
|
+
type: 'string',
|
|
1142
|
+
},
|
|
1143
|
+
message: {
|
|
1144
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1145
|
+
type: 'string',
|
|
1146
|
+
},
|
|
846
1147
|
warning_code: {
|
|
847
1148
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
848
1149
|
enum: ['delay_in_setting_on_device'],
|
|
@@ -855,8 +1156,15 @@ export default {
|
|
|
855
1156
|
{
|
|
856
1157
|
description: 'Delay in removing code from device.',
|
|
857
1158
|
properties: {
|
|
858
|
-
created_at: {
|
|
859
|
-
|
|
1159
|
+
created_at: {
|
|
1160
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1161
|
+
format: 'date-time',
|
|
1162
|
+
type: 'string',
|
|
1163
|
+
},
|
|
1164
|
+
message: {
|
|
1165
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1166
|
+
type: 'string',
|
|
1167
|
+
},
|
|
860
1168
|
warning_code: {
|
|
861
1169
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
862
1170
|
enum: ['delay_in_removing_from_device'],
|
|
@@ -867,10 +1175,17 @@ export default {
|
|
|
867
1175
|
type: 'object',
|
|
868
1176
|
},
|
|
869
1177
|
{
|
|
870
|
-
description: 'Third
|
|
1178
|
+
description: 'Third-party integration detected that may cause access codes to fail.',
|
|
871
1179
|
properties: {
|
|
872
|
-
created_at: {
|
|
873
|
-
|
|
1180
|
+
created_at: {
|
|
1181
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1182
|
+
format: 'date-time',
|
|
1183
|
+
type: 'string',
|
|
1184
|
+
},
|
|
1185
|
+
message: {
|
|
1186
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1187
|
+
type: 'string',
|
|
1188
|
+
},
|
|
874
1189
|
warning_code: {
|
|
875
1190
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
876
1191
|
enum: ['third_party_integration_detected'],
|
|
@@ -883,8 +1198,15 @@ export default {
|
|
|
883
1198
|
{
|
|
884
1199
|
description: 'Access code has not yet been fully moved to the device.',
|
|
885
1200
|
properties: {
|
|
886
|
-
created_at: {
|
|
887
|
-
|
|
1201
|
+
created_at: {
|
|
1202
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1203
|
+
format: 'date-time',
|
|
1204
|
+
type: 'string',
|
|
1205
|
+
},
|
|
1206
|
+
message: {
|
|
1207
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1208
|
+
type: 'string',
|
|
1209
|
+
},
|
|
888
1210
|
warning_code: {
|
|
889
1211
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
890
1212
|
enum: ['august_device_programming_delay'],
|
|
@@ -897,8 +1219,15 @@ export default {
|
|
|
897
1219
|
{
|
|
898
1220
|
description: 'August lock is temporarily offline.',
|
|
899
1221
|
properties: {
|
|
900
|
-
created_at: {
|
|
901
|
-
|
|
1222
|
+
created_at: {
|
|
1223
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1224
|
+
format: 'date-time',
|
|
1225
|
+
type: 'string',
|
|
1226
|
+
},
|
|
1227
|
+
message: {
|
|
1228
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1229
|
+
type: 'string',
|
|
1230
|
+
},
|
|
902
1231
|
warning_code: {
|
|
903
1232
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
904
1233
|
enum: ['august_lock_temporarily_offline'],
|
|
@@ -911,8 +1240,15 @@ export default {
|
|
|
911
1240
|
{
|
|
912
1241
|
description: 'Algopins must be used within 24 hours.',
|
|
913
1242
|
properties: {
|
|
914
|
-
created_at: {
|
|
915
|
-
|
|
1243
|
+
created_at: {
|
|
1244
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1245
|
+
format: 'date-time',
|
|
1246
|
+
type: 'string',
|
|
1247
|
+
},
|
|
1248
|
+
message: {
|
|
1249
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1250
|
+
type: 'string',
|
|
1251
|
+
},
|
|
916
1252
|
warning_code: {
|
|
917
1253
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
918
1254
|
enum: ['igloo_algopin_must_be_used_within_24_hours'],
|
|
@@ -925,8 +1261,15 @@ export default {
|
|
|
925
1261
|
{
|
|
926
1262
|
description: 'Management was transferred to another workspace.',
|
|
927
1263
|
properties: {
|
|
928
|
-
created_at: {
|
|
929
|
-
|
|
1264
|
+
created_at: {
|
|
1265
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1266
|
+
format: 'date-time',
|
|
1267
|
+
type: 'string',
|
|
1268
|
+
},
|
|
1269
|
+
message: {
|
|
1270
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1271
|
+
type: 'string',
|
|
1272
|
+
},
|
|
930
1273
|
warning_code: {
|
|
931
1274
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
932
1275
|
enum: ['management_transferred'],
|
|
@@ -937,10 +1280,17 @@ export default {
|
|
|
937
1280
|
type: 'object',
|
|
938
1281
|
},
|
|
939
1282
|
{
|
|
940
|
-
description: 'Unable to confirm the access code is set on Kwikset device.',
|
|
1283
|
+
description: 'Unable to confirm that the access code is set on Kwikset device.',
|
|
941
1284
|
properties: {
|
|
942
|
-
created_at: {
|
|
943
|
-
|
|
1285
|
+
created_at: {
|
|
1286
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1287
|
+
format: 'date-time',
|
|
1288
|
+
type: 'string',
|
|
1289
|
+
},
|
|
1290
|
+
message: {
|
|
1291
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1292
|
+
type: 'string',
|
|
1293
|
+
},
|
|
944
1294
|
warning_code: {
|
|
945
1295
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
946
1296
|
enum: ['kwikset_unable_to_confirm_code'],
|
|
@@ -2229,23 +2579,30 @@ export default {
|
|
|
2229
2579
|
type: 'string',
|
|
2230
2580
|
'x-undocumented': 'Only used internally.',
|
|
2231
2581
|
},
|
|
2232
|
-
|
|
2582
|
+
pending_mutations: {
|
|
2233
2583
|
items: {
|
|
2234
|
-
discriminator: { propertyName: '
|
|
2584
|
+
discriminator: { propertyName: 'mutation_code' },
|
|
2235
2585
|
oneOf: [
|
|
2236
2586
|
{
|
|
2237
2587
|
properties: {
|
|
2238
2588
|
created_at: { format: 'date-time', type: 'string' },
|
|
2239
|
-
|
|
2589
|
+
mutation_code: { enum: ['creating'], type: 'string' },
|
|
2590
|
+
},
|
|
2591
|
+
required: ['created_at', 'mutation_code'],
|
|
2592
|
+
type: 'object',
|
|
2593
|
+
},
|
|
2594
|
+
{
|
|
2595
|
+
properties: {
|
|
2596
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
2597
|
+
mutation_code: { enum: ['deleting'], type: 'string' },
|
|
2240
2598
|
},
|
|
2241
|
-
required: ['created_at', '
|
|
2599
|
+
required: ['created_at', 'mutation_code'],
|
|
2242
2600
|
type: 'object',
|
|
2243
2601
|
},
|
|
2244
2602
|
{
|
|
2245
2603
|
properties: {
|
|
2246
2604
|
created_at: { format: 'date-time', type: 'string' },
|
|
2247
|
-
|
|
2248
|
-
modified_from: {
|
|
2605
|
+
from: {
|
|
2249
2606
|
properties: {
|
|
2250
2607
|
email_address: {
|
|
2251
2608
|
format: 'email',
|
|
@@ -2257,7 +2614,11 @@ export default {
|
|
|
2257
2614
|
},
|
|
2258
2615
|
type: 'object',
|
|
2259
2616
|
},
|
|
2260
|
-
|
|
2617
|
+
mutation_code: {
|
|
2618
|
+
enum: ['updating_user_information'],
|
|
2619
|
+
type: 'string',
|
|
2620
|
+
},
|
|
2621
|
+
to: {
|
|
2261
2622
|
properties: {
|
|
2262
2623
|
email_address: {
|
|
2263
2624
|
format: 'email',
|
|
@@ -2270,22 +2631,13 @@ export default {
|
|
|
2270
2631
|
type: 'object',
|
|
2271
2632
|
},
|
|
2272
2633
|
},
|
|
2273
|
-
required: [
|
|
2274
|
-
'created_at',
|
|
2275
|
-
'modification_code',
|
|
2276
|
-
'modified_from',
|
|
2277
|
-
'modified_to',
|
|
2278
|
-
],
|
|
2634
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
2279
2635
|
type: 'object',
|
|
2280
2636
|
},
|
|
2281
2637
|
{
|
|
2282
2638
|
properties: {
|
|
2283
2639
|
created_at: { format: 'date-time', type: 'string' },
|
|
2284
|
-
|
|
2285
|
-
enum: ['access_schedule'],
|
|
2286
|
-
type: 'string',
|
|
2287
|
-
},
|
|
2288
|
-
modified_from: {
|
|
2640
|
+
from: {
|
|
2289
2641
|
properties: {
|
|
2290
2642
|
ends_at: {
|
|
2291
2643
|
description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
@@ -2302,7 +2654,11 @@ export default {
|
|
|
2302
2654
|
required: ['starts_at', 'ends_at'],
|
|
2303
2655
|
type: 'object',
|
|
2304
2656
|
},
|
|
2305
|
-
|
|
2657
|
+
mutation_code: {
|
|
2658
|
+
enum: ['updating_access_schedule'],
|
|
2659
|
+
type: 'string',
|
|
2660
|
+
},
|
|
2661
|
+
to: {
|
|
2306
2662
|
properties: {
|
|
2307
2663
|
ends_at: {
|
|
2308
2664
|
description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
@@ -2320,48 +2676,34 @@ export default {
|
|
|
2320
2676
|
type: 'object',
|
|
2321
2677
|
},
|
|
2322
2678
|
},
|
|
2323
|
-
required: [
|
|
2324
|
-
'created_at',
|
|
2325
|
-
'modification_code',
|
|
2326
|
-
'modified_from',
|
|
2327
|
-
'modified_to',
|
|
2328
|
-
],
|
|
2679
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
2329
2680
|
type: 'object',
|
|
2330
2681
|
},
|
|
2331
2682
|
{
|
|
2332
2683
|
properties: {
|
|
2333
2684
|
created_at: { format: 'date-time', type: 'string' },
|
|
2334
|
-
|
|
2335
|
-
enum: ['suspension_state'],
|
|
2336
|
-
type: 'string',
|
|
2337
|
-
},
|
|
2338
|
-
modified_from: {
|
|
2685
|
+
from: {
|
|
2339
2686
|
properties: { is_suspended: { type: 'boolean' } },
|
|
2340
2687
|
required: ['is_suspended'],
|
|
2341
2688
|
type: 'object',
|
|
2342
2689
|
},
|
|
2343
|
-
|
|
2690
|
+
mutation_code: {
|
|
2691
|
+
enum: ['updating_suspension_state'],
|
|
2692
|
+
type: 'string',
|
|
2693
|
+
},
|
|
2694
|
+
to: {
|
|
2344
2695
|
properties: { is_suspended: { type: 'boolean' } },
|
|
2345
2696
|
required: ['is_suspended'],
|
|
2346
2697
|
type: 'object',
|
|
2347
2698
|
},
|
|
2348
2699
|
},
|
|
2349
|
-
required: [
|
|
2350
|
-
'created_at',
|
|
2351
|
-
'modification_code',
|
|
2352
|
-
'modified_from',
|
|
2353
|
-
'modified_to',
|
|
2354
|
-
],
|
|
2700
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
2355
2701
|
type: 'object',
|
|
2356
2702
|
},
|
|
2357
2703
|
{
|
|
2358
2704
|
properties: {
|
|
2359
2705
|
created_at: { format: 'date-time', type: 'string' },
|
|
2360
|
-
|
|
2361
|
-
enum: ['acs_access_group_membership'],
|
|
2362
|
-
type: 'string',
|
|
2363
|
-
},
|
|
2364
|
-
modified_from: {
|
|
2706
|
+
from: {
|
|
2365
2707
|
properties: {
|
|
2366
2708
|
acs_access_group_id: {
|
|
2367
2709
|
format: 'uuid',
|
|
@@ -2372,7 +2714,11 @@ export default {
|
|
|
2372
2714
|
required: ['acs_access_group_id'],
|
|
2373
2715
|
type: 'object',
|
|
2374
2716
|
},
|
|
2375
|
-
|
|
2717
|
+
mutation_code: {
|
|
2718
|
+
enum: ['updating_group_membership'],
|
|
2719
|
+
type: 'string',
|
|
2720
|
+
},
|
|
2721
|
+
to: {
|
|
2376
2722
|
properties: {
|
|
2377
2723
|
acs_access_group_id: {
|
|
2378
2724
|
format: 'uuid',
|
|
@@ -2384,12 +2730,7 @@ export default {
|
|
|
2384
2730
|
type: 'object',
|
|
2385
2731
|
},
|
|
2386
2732
|
},
|
|
2387
|
-
required: [
|
|
2388
|
-
'created_at',
|
|
2389
|
-
'modification_code',
|
|
2390
|
-
'modified_from',
|
|
2391
|
-
'modified_to',
|
|
2392
|
-
],
|
|
2733
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
2393
2734
|
type: 'object',
|
|
2394
2735
|
},
|
|
2395
2736
|
],
|
|
@@ -12350,6 +12691,7 @@ export default {
|
|
|
12350
12691
|
'x-route-path': '/thermostats/schedules',
|
|
12351
12692
|
},
|
|
12352
12693
|
unmanaged_access_code: {
|
|
12694
|
+
description: 'Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.',
|
|
12353
12695
|
properties: {
|
|
12354
12696
|
access_code_id: {
|
|
12355
12697
|
description: 'Unique identifier for the access code.',
|
|
@@ -12378,21 +12720,32 @@ export default {
|
|
|
12378
12720
|
type: 'string',
|
|
12379
12721
|
},
|
|
12380
12722
|
errors: {
|
|
12381
|
-
description: '
|
|
12723
|
+
description: 'Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
12382
12724
|
items: {
|
|
12383
12725
|
discriminator: { propertyName: 'error_code' },
|
|
12384
12726
|
oneOf: [
|
|
12385
12727
|
{
|
|
12386
|
-
description: 'Failed to set code on
|
|
12728
|
+
description: 'Failed to set code on SmartThings device.',
|
|
12387
12729
|
properties: {
|
|
12388
|
-
created_at: {
|
|
12730
|
+
created_at: {
|
|
12731
|
+
description: 'Date and time at which Seam created the error.',
|
|
12732
|
+
format: 'date-time',
|
|
12733
|
+
type: 'string',
|
|
12734
|
+
},
|
|
12389
12735
|
error_code: {
|
|
12390
12736
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12391
12737
|
enum: ['smartthings_failed_to_set_access_code'],
|
|
12392
12738
|
type: 'string',
|
|
12393
12739
|
},
|
|
12394
|
-
is_access_code_error: {
|
|
12395
|
-
|
|
12740
|
+
is_access_code_error: {
|
|
12741
|
+
description: 'Indicates that this is an access code error.',
|
|
12742
|
+
enum: [true],
|
|
12743
|
+
type: 'boolean',
|
|
12744
|
+
},
|
|
12745
|
+
message: {
|
|
12746
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12747
|
+
type: 'string',
|
|
12748
|
+
},
|
|
12396
12749
|
},
|
|
12397
12750
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12398
12751
|
type: 'object',
|
|
@@ -12400,7 +12753,11 @@ export default {
|
|
|
12400
12753
|
{
|
|
12401
12754
|
description: 'Failed to set code after multiple retries.',
|
|
12402
12755
|
properties: {
|
|
12403
|
-
created_at: {
|
|
12756
|
+
created_at: {
|
|
12757
|
+
description: 'Date and time at which Seam created the error.',
|
|
12758
|
+
format: 'date-time',
|
|
12759
|
+
type: 'string',
|
|
12760
|
+
},
|
|
12404
12761
|
error_code: {
|
|
12405
12762
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12406
12763
|
enum: [
|
|
@@ -12408,8 +12765,15 @@ export default {
|
|
|
12408
12765
|
],
|
|
12409
12766
|
type: 'string',
|
|
12410
12767
|
},
|
|
12411
|
-
is_access_code_error: {
|
|
12412
|
-
|
|
12768
|
+
is_access_code_error: {
|
|
12769
|
+
description: 'Indicates that this is an access code error.',
|
|
12770
|
+
enum: [true],
|
|
12771
|
+
type: 'boolean',
|
|
12772
|
+
},
|
|
12773
|
+
message: {
|
|
12774
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12775
|
+
type: 'string',
|
|
12776
|
+
},
|
|
12413
12777
|
},
|
|
12414
12778
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12415
12779
|
type: 'object',
|
|
@@ -12417,14 +12781,25 @@ export default {
|
|
|
12417
12781
|
{
|
|
12418
12782
|
description: 'No free slots available on the device.',
|
|
12419
12783
|
properties: {
|
|
12420
|
-
created_at: {
|
|
12784
|
+
created_at: {
|
|
12785
|
+
description: 'Date and time at which Seam created the error.',
|
|
12786
|
+
format: 'date-time',
|
|
12787
|
+
type: 'string',
|
|
12788
|
+
},
|
|
12421
12789
|
error_code: {
|
|
12422
12790
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12423
12791
|
enum: ['smartthings_no_free_slots_available'],
|
|
12424
12792
|
type: 'string',
|
|
12425
12793
|
},
|
|
12426
|
-
is_access_code_error: {
|
|
12427
|
-
|
|
12794
|
+
is_access_code_error: {
|
|
12795
|
+
description: 'Indicates that this is an access code error.',
|
|
12796
|
+
enum: [true],
|
|
12797
|
+
type: 'boolean',
|
|
12798
|
+
},
|
|
12799
|
+
message: {
|
|
12800
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12801
|
+
type: 'string',
|
|
12802
|
+
},
|
|
12428
12803
|
},
|
|
12429
12804
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12430
12805
|
type: 'object',
|
|
@@ -12432,14 +12807,25 @@ export default {
|
|
|
12432
12807
|
{
|
|
12433
12808
|
description: 'Failed to set code on device.',
|
|
12434
12809
|
properties: {
|
|
12435
|
-
created_at: {
|
|
12810
|
+
created_at: {
|
|
12811
|
+
description: 'Date and time at which Seam created the error.',
|
|
12812
|
+
format: 'date-time',
|
|
12813
|
+
type: 'string',
|
|
12814
|
+
},
|
|
12436
12815
|
error_code: {
|
|
12437
12816
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12438
12817
|
enum: ['failed_to_set_on_device'],
|
|
12439
12818
|
type: 'string',
|
|
12440
12819
|
},
|
|
12441
|
-
is_access_code_error: {
|
|
12442
|
-
|
|
12820
|
+
is_access_code_error: {
|
|
12821
|
+
description: 'Indicates that this is an access code error.',
|
|
12822
|
+
enum: [true],
|
|
12823
|
+
type: 'boolean',
|
|
12824
|
+
},
|
|
12825
|
+
message: {
|
|
12826
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12827
|
+
type: 'string',
|
|
12828
|
+
},
|
|
12443
12829
|
},
|
|
12444
12830
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12445
12831
|
type: 'object',
|
|
@@ -12447,14 +12833,25 @@ export default {
|
|
|
12447
12833
|
{
|
|
12448
12834
|
description: 'Failed to remove code from device.',
|
|
12449
12835
|
properties: {
|
|
12450
|
-
created_at: {
|
|
12836
|
+
created_at: {
|
|
12837
|
+
description: 'Date and time at which Seam created the error.',
|
|
12838
|
+
format: 'date-time',
|
|
12839
|
+
type: 'string',
|
|
12840
|
+
},
|
|
12451
12841
|
error_code: {
|
|
12452
12842
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12453
12843
|
enum: ['failed_to_remove_from_device'],
|
|
12454
12844
|
type: 'string',
|
|
12455
12845
|
},
|
|
12456
|
-
is_access_code_error: {
|
|
12457
|
-
|
|
12846
|
+
is_access_code_error: {
|
|
12847
|
+
description: 'Indicates that this is an access code error.',
|
|
12848
|
+
enum: [true],
|
|
12849
|
+
type: 'boolean',
|
|
12850
|
+
},
|
|
12851
|
+
message: {
|
|
12852
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12853
|
+
type: 'string',
|
|
12854
|
+
},
|
|
12458
12855
|
},
|
|
12459
12856
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12460
12857
|
type: 'object',
|
|
@@ -12462,14 +12859,25 @@ export default {
|
|
|
12462
12859
|
{
|
|
12463
12860
|
description: 'Duplicate access code detected on device.',
|
|
12464
12861
|
properties: {
|
|
12465
|
-
created_at: {
|
|
12862
|
+
created_at: {
|
|
12863
|
+
description: 'Date and time at which Seam created the error.',
|
|
12864
|
+
format: 'date-time',
|
|
12865
|
+
type: 'string',
|
|
12866
|
+
},
|
|
12466
12867
|
error_code: {
|
|
12467
12868
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12468
12869
|
enum: ['duplicate_code_on_device'],
|
|
12469
12870
|
type: 'string',
|
|
12470
12871
|
},
|
|
12471
|
-
is_access_code_error: {
|
|
12472
|
-
|
|
12872
|
+
is_access_code_error: {
|
|
12873
|
+
description: 'Indicates that this is an access code error.',
|
|
12874
|
+
enum: [true],
|
|
12875
|
+
type: 'boolean',
|
|
12876
|
+
},
|
|
12877
|
+
message: {
|
|
12878
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12879
|
+
type: 'string',
|
|
12880
|
+
},
|
|
12473
12881
|
},
|
|
12474
12882
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12475
12883
|
type: 'object',
|
|
@@ -12477,14 +12885,25 @@ export default {
|
|
|
12477
12885
|
{
|
|
12478
12886
|
description: 'An attempt to modify this access code was prevented.',
|
|
12479
12887
|
properties: {
|
|
12480
|
-
created_at: {
|
|
12888
|
+
created_at: {
|
|
12889
|
+
description: 'Date and time at which Seam created the error.',
|
|
12890
|
+
format: 'date-time',
|
|
12891
|
+
type: 'string',
|
|
12892
|
+
},
|
|
12481
12893
|
error_code: {
|
|
12482
12894
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12483
12895
|
enum: ['duplicate_code_attempt_prevented'],
|
|
12484
12896
|
type: 'string',
|
|
12485
12897
|
},
|
|
12486
|
-
is_access_code_error: {
|
|
12487
|
-
|
|
12898
|
+
is_access_code_error: {
|
|
12899
|
+
description: 'Indicates that this is an access code error.',
|
|
12900
|
+
enum: [true],
|
|
12901
|
+
type: 'boolean',
|
|
12902
|
+
},
|
|
12903
|
+
message: {
|
|
12904
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12905
|
+
type: 'string',
|
|
12906
|
+
},
|
|
12488
12907
|
},
|
|
12489
12908
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12490
12909
|
type: 'object',
|
|
@@ -12492,14 +12911,25 @@ export default {
|
|
|
12492
12911
|
{
|
|
12493
12912
|
description: 'Igloohome bridge has too many pending jobs in the queue.',
|
|
12494
12913
|
properties: {
|
|
12495
|
-
created_at: {
|
|
12914
|
+
created_at: {
|
|
12915
|
+
description: 'Date and time at which Seam created the error.',
|
|
12916
|
+
format: 'date-time',
|
|
12917
|
+
type: 'string',
|
|
12918
|
+
},
|
|
12496
12919
|
error_code: {
|
|
12497
12920
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12498
12921
|
enum: ['igloohome_bridge_too_many_pending_jobs'],
|
|
12499
12922
|
type: 'string',
|
|
12500
12923
|
},
|
|
12501
|
-
is_access_code_error: {
|
|
12502
|
-
|
|
12924
|
+
is_access_code_error: {
|
|
12925
|
+
description: 'Indicates that this is an access code error.',
|
|
12926
|
+
enum: [true],
|
|
12927
|
+
type: 'boolean',
|
|
12928
|
+
},
|
|
12929
|
+
message: {
|
|
12930
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12931
|
+
type: 'string',
|
|
12932
|
+
},
|
|
12503
12933
|
},
|
|
12504
12934
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12505
12935
|
type: 'object',
|
|
@@ -12507,22 +12937,37 @@ export default {
|
|
|
12507
12937
|
{
|
|
12508
12938
|
description: 'Igloohome bridge is offline.',
|
|
12509
12939
|
properties: {
|
|
12510
|
-
created_at: {
|
|
12940
|
+
created_at: {
|
|
12941
|
+
description: 'Date and time at which Seam created the error.',
|
|
12942
|
+
format: 'date-time',
|
|
12943
|
+
type: 'string',
|
|
12944
|
+
},
|
|
12511
12945
|
error_code: {
|
|
12512
12946
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12513
12947
|
enum: ['igloohome_bridge_offline'],
|
|
12514
12948
|
type: 'string',
|
|
12515
12949
|
},
|
|
12516
|
-
is_access_code_error: {
|
|
12517
|
-
|
|
12950
|
+
is_access_code_error: {
|
|
12951
|
+
description: 'Indicates that this is an access code error.',
|
|
12952
|
+
enum: [true],
|
|
12953
|
+
type: 'boolean',
|
|
12954
|
+
},
|
|
12955
|
+
message: {
|
|
12956
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12957
|
+
type: 'string',
|
|
12958
|
+
},
|
|
12518
12959
|
},
|
|
12519
12960
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12520
12961
|
type: 'object',
|
|
12521
12962
|
},
|
|
12522
12963
|
{
|
|
12523
|
-
description: 'Lock
|
|
12964
|
+
description: 'Lock has reached maximum amount of codes.',
|
|
12524
12965
|
properties: {
|
|
12525
|
-
created_at: {
|
|
12966
|
+
created_at: {
|
|
12967
|
+
description: 'Date and time at which Seam created the error.',
|
|
12968
|
+
format: 'date-time',
|
|
12969
|
+
type: 'string',
|
|
12970
|
+
},
|
|
12526
12971
|
error_code: {
|
|
12527
12972
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12528
12973
|
enum: [
|
|
@@ -12530,23 +12975,41 @@ export default {
|
|
|
12530
12975
|
],
|
|
12531
12976
|
type: 'string',
|
|
12532
12977
|
},
|
|
12533
|
-
is_access_code_error: {
|
|
12534
|
-
|
|
12978
|
+
is_access_code_error: {
|
|
12979
|
+
description: 'Indicates that this is an access code error.',
|
|
12980
|
+
enum: [true],
|
|
12981
|
+
type: 'boolean',
|
|
12982
|
+
},
|
|
12983
|
+
message: {
|
|
12984
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12985
|
+
type: 'string',
|
|
12986
|
+
},
|
|
12535
12987
|
},
|
|
12536
12988
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12537
12989
|
type: 'object',
|
|
12538
12990
|
},
|
|
12539
12991
|
{
|
|
12540
|
-
description: 'Unable to confirm the access code is set on Kwikset device.',
|
|
12992
|
+
description: 'Unable to confirm that the access code is set on Kwikset device.',
|
|
12541
12993
|
properties: {
|
|
12542
|
-
created_at: {
|
|
12994
|
+
created_at: {
|
|
12995
|
+
description: 'Date and time at which Seam created the error.',
|
|
12996
|
+
format: 'date-time',
|
|
12997
|
+
type: 'string',
|
|
12998
|
+
},
|
|
12543
12999
|
error_code: {
|
|
12544
13000
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12545
13001
|
enum: ['kwikset_unable_to_confirm_code'],
|
|
12546
13002
|
type: 'string',
|
|
12547
13003
|
},
|
|
12548
|
-
is_access_code_error: {
|
|
12549
|
-
|
|
13004
|
+
is_access_code_error: {
|
|
13005
|
+
description: 'Indicates that this is an access code error.',
|
|
13006
|
+
enum: [true],
|
|
13007
|
+
type: 'boolean',
|
|
13008
|
+
},
|
|
13009
|
+
message: {
|
|
13010
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13011
|
+
type: 'string',
|
|
13012
|
+
},
|
|
12550
13013
|
},
|
|
12551
13014
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12552
13015
|
type: 'object',
|
|
@@ -12554,14 +13017,25 @@ export default {
|
|
|
12554
13017
|
{
|
|
12555
13018
|
description: 'Unable to confirm the deletion of the access code on Kwikset device.',
|
|
12556
13019
|
properties: {
|
|
12557
|
-
created_at: {
|
|
13020
|
+
created_at: {
|
|
13021
|
+
description: 'Date and time at which Seam created the error.',
|
|
13022
|
+
format: 'date-time',
|
|
13023
|
+
type: 'string',
|
|
13024
|
+
},
|
|
12558
13025
|
error_code: {
|
|
12559
13026
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12560
13027
|
enum: ['kwikset_unable_to_confirm_deletion'],
|
|
12561
13028
|
type: 'string',
|
|
12562
13029
|
},
|
|
12563
|
-
is_access_code_error: {
|
|
12564
|
-
|
|
13030
|
+
is_access_code_error: {
|
|
13031
|
+
description: 'Indicates that this is an access code error.',
|
|
13032
|
+
enum: [true],
|
|
13033
|
+
type: 'boolean',
|
|
13034
|
+
},
|
|
13035
|
+
message: {
|
|
13036
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13037
|
+
type: 'string',
|
|
13038
|
+
},
|
|
12565
13039
|
},
|
|
12566
13040
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12567
13041
|
type: 'object',
|
|
@@ -12569,14 +13043,25 @@ export default {
|
|
|
12569
13043
|
{
|
|
12570
13044
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
12571
13045
|
properties: {
|
|
12572
|
-
created_at: {
|
|
13046
|
+
created_at: {
|
|
13047
|
+
description: 'Date and time at which Seam created the error.',
|
|
13048
|
+
format: 'date-time',
|
|
13049
|
+
type: 'string',
|
|
13050
|
+
},
|
|
12573
13051
|
error_code: {
|
|
12574
13052
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12575
13053
|
enum: ['code_modified_external_to_seam'],
|
|
12576
13054
|
type: 'string',
|
|
12577
13055
|
},
|
|
12578
|
-
is_access_code_error: {
|
|
12579
|
-
|
|
13056
|
+
is_access_code_error: {
|
|
13057
|
+
description: 'Indicates that this is an access code error.',
|
|
13058
|
+
enum: [true],
|
|
13059
|
+
type: 'boolean',
|
|
13060
|
+
},
|
|
13061
|
+
message: {
|
|
13062
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13063
|
+
type: 'string',
|
|
13064
|
+
},
|
|
12580
13065
|
},
|
|
12581
13066
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12582
13067
|
type: 'object',
|
|
@@ -12584,14 +13069,25 @@ export default {
|
|
|
12584
13069
|
{
|
|
12585
13070
|
description: 'Invalid code length for August lock.',
|
|
12586
13071
|
properties: {
|
|
12587
|
-
created_at: {
|
|
13072
|
+
created_at: {
|
|
13073
|
+
description: 'Date and time at which Seam created the error.',
|
|
13074
|
+
format: 'date-time',
|
|
13075
|
+
type: 'string',
|
|
13076
|
+
},
|
|
12588
13077
|
error_code: {
|
|
12589
13078
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12590
13079
|
enum: ['august_lock_invalid_code_length'],
|
|
12591
13080
|
type: 'string',
|
|
12592
13081
|
},
|
|
12593
|
-
is_access_code_error: {
|
|
12594
|
-
|
|
13082
|
+
is_access_code_error: {
|
|
13083
|
+
description: 'Indicates that this is an access code error.',
|
|
13084
|
+
enum: [true],
|
|
13085
|
+
type: 'boolean',
|
|
13086
|
+
},
|
|
13087
|
+
message: {
|
|
13088
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13089
|
+
type: 'string',
|
|
13090
|
+
},
|
|
12595
13091
|
},
|
|
12596
13092
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12597
13093
|
type: 'object',
|
|
@@ -12599,14 +13095,25 @@ export default {
|
|
|
12599
13095
|
{
|
|
12600
13096
|
description: 'Access code has not yet been fully moved to the device.',
|
|
12601
13097
|
properties: {
|
|
12602
|
-
created_at: {
|
|
13098
|
+
created_at: {
|
|
13099
|
+
description: 'Date and time at which Seam created the error.',
|
|
13100
|
+
format: 'date-time',
|
|
13101
|
+
type: 'string',
|
|
13102
|
+
},
|
|
12603
13103
|
error_code: {
|
|
12604
13104
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12605
13105
|
enum: ['august_device_programming_delay'],
|
|
12606
13106
|
type: 'string',
|
|
12607
13107
|
},
|
|
12608
|
-
is_access_code_error: {
|
|
12609
|
-
|
|
13108
|
+
is_access_code_error: {
|
|
13109
|
+
description: 'Indicates that this is an access code error.',
|
|
13110
|
+
enum: [true],
|
|
13111
|
+
type: 'boolean',
|
|
13112
|
+
},
|
|
13113
|
+
message: {
|
|
13114
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13115
|
+
type: 'string',
|
|
13116
|
+
},
|
|
12610
13117
|
},
|
|
12611
13118
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12612
13119
|
type: 'object',
|
|
@@ -12614,14 +13121,25 @@ export default {
|
|
|
12614
13121
|
{
|
|
12615
13122
|
description: 'All access code slots on the device are full.',
|
|
12616
13123
|
properties: {
|
|
12617
|
-
created_at: {
|
|
13124
|
+
created_at: {
|
|
13125
|
+
description: 'Date and time at which Seam created the error.',
|
|
13126
|
+
format: 'date-time',
|
|
13127
|
+
type: 'string',
|
|
13128
|
+
},
|
|
12618
13129
|
error_code: {
|
|
12619
13130
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12620
13131
|
enum: ['august_device_slots_full'],
|
|
12621
13132
|
type: 'string',
|
|
12622
13133
|
},
|
|
12623
|
-
is_access_code_error: {
|
|
12624
|
-
|
|
13134
|
+
is_access_code_error: {
|
|
13135
|
+
description: 'Indicates that this is an access code error.',
|
|
13136
|
+
enum: [true],
|
|
13137
|
+
type: 'boolean',
|
|
13138
|
+
},
|
|
13139
|
+
message: {
|
|
13140
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13141
|
+
type: 'string',
|
|
13142
|
+
},
|
|
12625
13143
|
},
|
|
12626
13144
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12627
13145
|
type: 'object',
|
|
@@ -12629,14 +13147,25 @@ export default {
|
|
|
12629
13147
|
{
|
|
12630
13148
|
description: 'August lock is missing a keypad.',
|
|
12631
13149
|
properties: {
|
|
12632
|
-
created_at: {
|
|
13150
|
+
created_at: {
|
|
13151
|
+
description: 'Date and time at which Seam created the error.',
|
|
13152
|
+
format: 'date-time',
|
|
13153
|
+
type: 'string',
|
|
13154
|
+
},
|
|
12633
13155
|
error_code: {
|
|
12634
13156
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12635
13157
|
enum: ['august_lock_missing_keypad'],
|
|
12636
13158
|
type: 'string',
|
|
12637
13159
|
},
|
|
12638
|
-
is_access_code_error: {
|
|
12639
|
-
|
|
13160
|
+
is_access_code_error: {
|
|
13161
|
+
description: 'Indicates that this is an access code error.',
|
|
13162
|
+
enum: [true],
|
|
13163
|
+
type: 'boolean',
|
|
13164
|
+
},
|
|
13165
|
+
message: {
|
|
13166
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13167
|
+
type: 'string',
|
|
13168
|
+
},
|
|
12640
13169
|
},
|
|
12641
13170
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12642
13171
|
type: 'object',
|
|
@@ -12644,14 +13173,25 @@ export default {
|
|
|
12644
13173
|
{
|
|
12645
13174
|
description: 'August lock is temporarily offline.',
|
|
12646
13175
|
properties: {
|
|
12647
|
-
created_at: {
|
|
13176
|
+
created_at: {
|
|
13177
|
+
description: 'Date and time at which Seam created the error.',
|
|
13178
|
+
format: 'date-time',
|
|
13179
|
+
type: 'string',
|
|
13180
|
+
},
|
|
12648
13181
|
error_code: {
|
|
12649
13182
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12650
13183
|
enum: ['august_lock_temporarily_offline'],
|
|
12651
13184
|
type: 'string',
|
|
12652
13185
|
},
|
|
12653
|
-
is_access_code_error: {
|
|
12654
|
-
|
|
13186
|
+
is_access_code_error: {
|
|
13187
|
+
description: 'Indicates that this is an access code error.',
|
|
13188
|
+
enum: [true],
|
|
13189
|
+
type: 'boolean',
|
|
13190
|
+
},
|
|
13191
|
+
message: {
|
|
13192
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13193
|
+
type: 'string',
|
|
13194
|
+
},
|
|
12655
13195
|
},
|
|
12656
13196
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12657
13197
|
type: 'object',
|
|
@@ -12659,14 +13199,25 @@ export default {
|
|
|
12659
13199
|
{
|
|
12660
13200
|
description: 'Salto site user is not subscribed.',
|
|
12661
13201
|
properties: {
|
|
12662
|
-
created_at: {
|
|
13202
|
+
created_at: {
|
|
13203
|
+
description: 'Date and time at which Seam created the error.',
|
|
13204
|
+
format: 'date-time',
|
|
13205
|
+
type: 'string',
|
|
13206
|
+
},
|
|
12663
13207
|
error_code: {
|
|
12664
13208
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12665
13209
|
enum: ['salto_ks_user_not_subscribed'],
|
|
12666
13210
|
type: 'string',
|
|
12667
13211
|
},
|
|
12668
|
-
is_access_code_error: {
|
|
12669
|
-
|
|
13212
|
+
is_access_code_error: {
|
|
13213
|
+
description: 'Indicates that this is an access code error.',
|
|
13214
|
+
enum: [true],
|
|
13215
|
+
type: 'boolean',
|
|
13216
|
+
},
|
|
13217
|
+
message: {
|
|
13218
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13219
|
+
type: 'string',
|
|
13220
|
+
},
|
|
12670
13221
|
},
|
|
12671
13222
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12672
13223
|
type: 'object',
|
|
@@ -12674,14 +13225,25 @@ export default {
|
|
|
12674
13225
|
{
|
|
12675
13226
|
description: 'Access code has not yet been fully moved to the device.',
|
|
12676
13227
|
properties: {
|
|
12677
|
-
created_at: {
|
|
13228
|
+
created_at: {
|
|
13229
|
+
description: 'Date and time at which Seam created the error.',
|
|
13230
|
+
format: 'date-time',
|
|
13231
|
+
type: 'string',
|
|
13232
|
+
},
|
|
12678
13233
|
error_code: {
|
|
12679
13234
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12680
13235
|
enum: ['hubitat_device_programming_delay'],
|
|
12681
13236
|
type: 'string',
|
|
12682
13237
|
},
|
|
12683
|
-
is_access_code_error: {
|
|
12684
|
-
|
|
13238
|
+
is_access_code_error: {
|
|
13239
|
+
description: 'Indicates that this is an access code error.',
|
|
13240
|
+
enum: [true],
|
|
13241
|
+
type: 'boolean',
|
|
13242
|
+
},
|
|
13243
|
+
message: {
|
|
13244
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13245
|
+
type: 'string',
|
|
13246
|
+
},
|
|
12685
13247
|
},
|
|
12686
13248
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12687
13249
|
type: 'object',
|
|
@@ -12689,14 +13251,25 @@ export default {
|
|
|
12689
13251
|
{
|
|
12690
13252
|
description: 'No free positions available on the device.',
|
|
12691
13253
|
properties: {
|
|
12692
|
-
created_at: {
|
|
13254
|
+
created_at: {
|
|
13255
|
+
description: 'Date and time at which Seam created the error.',
|
|
13256
|
+
format: 'date-time',
|
|
13257
|
+
type: 'string',
|
|
13258
|
+
},
|
|
12693
13259
|
error_code: {
|
|
12694
13260
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12695
13261
|
enum: ['hubitat_no_free_positions_available'],
|
|
12696
13262
|
type: 'string',
|
|
12697
13263
|
},
|
|
12698
|
-
is_access_code_error: {
|
|
12699
|
-
|
|
13264
|
+
is_access_code_error: {
|
|
13265
|
+
description: 'Indicates that this is an access code error.',
|
|
13266
|
+
enum: [true],
|
|
13267
|
+
type: 'boolean',
|
|
13268
|
+
},
|
|
13269
|
+
message: {
|
|
13270
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13271
|
+
type: 'string',
|
|
13272
|
+
},
|
|
12700
13273
|
},
|
|
12701
13274
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12702
13275
|
type: 'object',
|
|
@@ -12704,14 +13277,25 @@ export default {
|
|
|
12704
13277
|
{
|
|
12705
13278
|
description: 'Duplicate access code name detected.',
|
|
12706
13279
|
properties: {
|
|
12707
|
-
created_at: {
|
|
13280
|
+
created_at: {
|
|
13281
|
+
description: 'Date and time at which Seam created the error.',
|
|
13282
|
+
format: 'date-time',
|
|
13283
|
+
type: 'string',
|
|
13284
|
+
},
|
|
12708
13285
|
error_code: {
|
|
12709
13286
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12710
13287
|
enum: ['wyze_duplicate_code_name'],
|
|
12711
13288
|
type: 'string',
|
|
12712
13289
|
},
|
|
12713
|
-
is_access_code_error: {
|
|
12714
|
-
|
|
13290
|
+
is_access_code_error: {
|
|
13291
|
+
description: 'Indicates that this is an access code error.',
|
|
13292
|
+
enum: [true],
|
|
13293
|
+
type: 'boolean',
|
|
13294
|
+
},
|
|
13295
|
+
message: {
|
|
13296
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13297
|
+
type: 'string',
|
|
13298
|
+
},
|
|
12715
13299
|
},
|
|
12716
13300
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12717
13301
|
type: 'object',
|
|
@@ -12719,14 +13303,25 @@ export default {
|
|
|
12719
13303
|
{
|
|
12720
13304
|
description: 'Potential duplicate access code detected.',
|
|
12721
13305
|
properties: {
|
|
12722
|
-
created_at: {
|
|
13306
|
+
created_at: {
|
|
13307
|
+
description: 'Date and time at which Seam created the error.',
|
|
13308
|
+
format: 'date-time',
|
|
13309
|
+
type: 'string',
|
|
13310
|
+
},
|
|
12723
13311
|
error_code: {
|
|
12724
13312
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12725
13313
|
enum: ['wyze_potential_duplicate_code'],
|
|
12726
13314
|
type: 'string',
|
|
12727
13315
|
},
|
|
12728
|
-
is_access_code_error: {
|
|
12729
|
-
|
|
13316
|
+
is_access_code_error: {
|
|
13317
|
+
description: 'Indicates that this is an access code error.',
|
|
13318
|
+
enum: [true],
|
|
13319
|
+
type: 'boolean',
|
|
13320
|
+
},
|
|
13321
|
+
message: {
|
|
13322
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13323
|
+
type: 'string',
|
|
13324
|
+
},
|
|
12730
13325
|
},
|
|
12731
13326
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12732
13327
|
type: 'object',
|
|
@@ -12734,14 +13329,25 @@ export default {
|
|
|
12734
13329
|
{
|
|
12735
13330
|
description: 'No valid user level for Oracode.',
|
|
12736
13331
|
properties: {
|
|
12737
|
-
created_at: {
|
|
13332
|
+
created_at: {
|
|
13333
|
+
description: 'Date and time at which Seam created the error.',
|
|
13334
|
+
format: 'date-time',
|
|
13335
|
+
type: 'string',
|
|
13336
|
+
},
|
|
12738
13337
|
error_code: {
|
|
12739
13338
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
12740
13339
|
enum: ['dormakaba_oracode_no_valid_user_level'],
|
|
12741
13340
|
type: 'string',
|
|
12742
13341
|
},
|
|
12743
|
-
is_access_code_error: {
|
|
12744
|
-
|
|
13342
|
+
is_access_code_error: {
|
|
13343
|
+
description: 'Indicates that this is an access code error.',
|
|
13344
|
+
enum: [true],
|
|
13345
|
+
type: 'boolean',
|
|
13346
|
+
},
|
|
13347
|
+
message: {
|
|
13348
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13349
|
+
type: 'string',
|
|
13350
|
+
},
|
|
12745
13351
|
},
|
|
12746
13352
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
12747
13353
|
type: 'object',
|
|
@@ -13060,7 +13666,11 @@ export default {
|
|
|
13060
13666
|
},
|
|
13061
13667
|
type: 'array',
|
|
13062
13668
|
},
|
|
13063
|
-
is_managed: {
|
|
13669
|
+
is_managed: {
|
|
13670
|
+
description: 'Indicates that Seam does not manage the access code.',
|
|
13671
|
+
enum: [false],
|
|
13672
|
+
type: 'boolean',
|
|
13673
|
+
},
|
|
13064
13674
|
name: {
|
|
13065
13675
|
description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
|
|
13066
13676
|
nullable: true,
|
|
@@ -13072,22 +13682,34 @@ export default {
|
|
|
13072
13682
|
nullable: true,
|
|
13073
13683
|
type: 'string',
|
|
13074
13684
|
},
|
|
13075
|
-
status: {
|
|
13685
|
+
status: {
|
|
13686
|
+
description: 'Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.',
|
|
13687
|
+
enum: ['set'],
|
|
13688
|
+
type: 'string',
|
|
13689
|
+
},
|
|
13076
13690
|
type: {
|
|
13077
|
-
description: 'Nature of the access code. Values are
|
|
13691
|
+
description: 'Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.',
|
|
13078
13692
|
enum: ['time_bound', 'ongoing'],
|
|
13079
13693
|
type: 'string',
|
|
13080
13694
|
},
|
|
13081
13695
|
warnings: {
|
|
13082
|
-
description: '
|
|
13696
|
+
description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
13083
13697
|
items: {
|
|
13698
|
+
description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
13084
13699
|
discriminator: { propertyName: 'warning_code' },
|
|
13085
13700
|
oneOf: [
|
|
13086
13701
|
{
|
|
13087
|
-
description: 'Failed to set code on
|
|
13702
|
+
description: 'Failed to set code on SmartThings device.',
|
|
13088
13703
|
properties: {
|
|
13089
|
-
created_at: {
|
|
13090
|
-
|
|
13704
|
+
created_at: {
|
|
13705
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13706
|
+
format: 'date-time',
|
|
13707
|
+
type: 'string',
|
|
13708
|
+
},
|
|
13709
|
+
message: {
|
|
13710
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13711
|
+
type: 'string',
|
|
13712
|
+
},
|
|
13091
13713
|
warning_code: {
|
|
13092
13714
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
13093
13715
|
enum: ['smartthings_failed_to_set_access_code'],
|
|
@@ -13100,8 +13722,15 @@ export default {
|
|
|
13100
13722
|
{
|
|
13101
13723
|
description: 'Duplicate access code detected.',
|
|
13102
13724
|
properties: {
|
|
13103
|
-
created_at: {
|
|
13104
|
-
|
|
13725
|
+
created_at: {
|
|
13726
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13727
|
+
format: 'date-time',
|
|
13728
|
+
type: 'string',
|
|
13729
|
+
},
|
|
13730
|
+
message: {
|
|
13731
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13732
|
+
type: 'string',
|
|
13733
|
+
},
|
|
13105
13734
|
warning_code: {
|
|
13106
13735
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
13107
13736
|
enum: ['schlage_detected_duplicate'],
|
|
@@ -13114,8 +13743,15 @@ export default {
|
|
|
13114
13743
|
{
|
|
13115
13744
|
description: 'Received an error when attempting to create this code.',
|
|
13116
13745
|
properties: {
|
|
13117
|
-
created_at: {
|
|
13118
|
-
|
|
13746
|
+
created_at: {
|
|
13747
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13748
|
+
format: 'date-time',
|
|
13749
|
+
type: 'string',
|
|
13750
|
+
},
|
|
13751
|
+
message: {
|
|
13752
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13753
|
+
type: 'string',
|
|
13754
|
+
},
|
|
13119
13755
|
warning_code: {
|
|
13120
13756
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
13121
13757
|
enum: ['schlage_creation_outage'],
|
|
@@ -13128,8 +13764,15 @@ export default {
|
|
|
13128
13764
|
{
|
|
13129
13765
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
13130
13766
|
properties: {
|
|
13131
|
-
created_at: {
|
|
13132
|
-
|
|
13767
|
+
created_at: {
|
|
13768
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13769
|
+
format: 'date-time',
|
|
13770
|
+
type: 'string',
|
|
13771
|
+
},
|
|
13772
|
+
message: {
|
|
13773
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13774
|
+
type: 'string',
|
|
13775
|
+
},
|
|
13133
13776
|
warning_code: {
|
|
13134
13777
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
13135
13778
|
enum: ['code_modified_external_to_seam'],
|
|
@@ -13142,8 +13785,15 @@ export default {
|
|
|
13142
13785
|
{
|
|
13143
13786
|
description: 'Delay in setting code on device.',
|
|
13144
13787
|
properties: {
|
|
13145
|
-
created_at: {
|
|
13146
|
-
|
|
13788
|
+
created_at: {
|
|
13789
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13790
|
+
format: 'date-time',
|
|
13791
|
+
type: 'string',
|
|
13792
|
+
},
|
|
13793
|
+
message: {
|
|
13794
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13795
|
+
type: 'string',
|
|
13796
|
+
},
|
|
13147
13797
|
warning_code: {
|
|
13148
13798
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
13149
13799
|
enum: ['delay_in_setting_on_device'],
|
|
@@ -13156,8 +13806,15 @@ export default {
|
|
|
13156
13806
|
{
|
|
13157
13807
|
description: 'Delay in removing code from device.',
|
|
13158
13808
|
properties: {
|
|
13159
|
-
created_at: {
|
|
13160
|
-
|
|
13809
|
+
created_at: {
|
|
13810
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13811
|
+
format: 'date-time',
|
|
13812
|
+
type: 'string',
|
|
13813
|
+
},
|
|
13814
|
+
message: {
|
|
13815
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13816
|
+
type: 'string',
|
|
13817
|
+
},
|
|
13161
13818
|
warning_code: {
|
|
13162
13819
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
13163
13820
|
enum: ['delay_in_removing_from_device'],
|
|
@@ -13168,10 +13825,17 @@ export default {
|
|
|
13168
13825
|
type: 'object',
|
|
13169
13826
|
},
|
|
13170
13827
|
{
|
|
13171
|
-
description: 'Third
|
|
13828
|
+
description: 'Third-party integration detected that may cause access codes to fail.',
|
|
13172
13829
|
properties: {
|
|
13173
|
-
created_at: {
|
|
13174
|
-
|
|
13830
|
+
created_at: {
|
|
13831
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13832
|
+
format: 'date-time',
|
|
13833
|
+
type: 'string',
|
|
13834
|
+
},
|
|
13835
|
+
message: {
|
|
13836
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13837
|
+
type: 'string',
|
|
13838
|
+
},
|
|
13175
13839
|
warning_code: {
|
|
13176
13840
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
13177
13841
|
enum: ['third_party_integration_detected'],
|
|
@@ -13184,8 +13848,15 @@ export default {
|
|
|
13184
13848
|
{
|
|
13185
13849
|
description: 'Access code has not yet been fully moved to the device.',
|
|
13186
13850
|
properties: {
|
|
13187
|
-
created_at: {
|
|
13188
|
-
|
|
13851
|
+
created_at: {
|
|
13852
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13853
|
+
format: 'date-time',
|
|
13854
|
+
type: 'string',
|
|
13855
|
+
},
|
|
13856
|
+
message: {
|
|
13857
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13858
|
+
type: 'string',
|
|
13859
|
+
},
|
|
13189
13860
|
warning_code: {
|
|
13190
13861
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
13191
13862
|
enum: ['august_device_programming_delay'],
|
|
@@ -13198,8 +13869,15 @@ export default {
|
|
|
13198
13869
|
{
|
|
13199
13870
|
description: 'August lock is temporarily offline.',
|
|
13200
13871
|
properties: {
|
|
13201
|
-
created_at: {
|
|
13202
|
-
|
|
13872
|
+
created_at: {
|
|
13873
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13874
|
+
format: 'date-time',
|
|
13875
|
+
type: 'string',
|
|
13876
|
+
},
|
|
13877
|
+
message: {
|
|
13878
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13879
|
+
type: 'string',
|
|
13880
|
+
},
|
|
13203
13881
|
warning_code: {
|
|
13204
13882
|
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13205
13883
|
enum: ['august_lock_temporarily_offline'],
|
|
@@ -13212,8 +13890,15 @@ export default {
|
|
|
13212
13890
|
{
|
|
13213
13891
|
description: 'Algopins must be used within 24 hours.',
|
|
13214
13892
|
properties: {
|
|
13215
|
-
created_at: {
|
|
13216
|
-
|
|
13893
|
+
created_at: {
|
|
13894
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13895
|
+
format: 'date-time',
|
|
13896
|
+
type: 'string',
|
|
13897
|
+
},
|
|
13898
|
+
message: {
|
|
13899
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13900
|
+
type: 'string',
|
|
13901
|
+
},
|
|
13217
13902
|
warning_code: {
|
|
13218
13903
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
13219
13904
|
enum: ['igloo_algopin_must_be_used_within_24_hours'],
|
|
@@ -13226,8 +13911,15 @@ export default {
|
|
|
13226
13911
|
{
|
|
13227
13912
|
description: 'Management was transferred to another workspace.',
|
|
13228
13913
|
properties: {
|
|
13229
|
-
created_at: {
|
|
13230
|
-
|
|
13914
|
+
created_at: {
|
|
13915
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13916
|
+
format: 'date-time',
|
|
13917
|
+
type: 'string',
|
|
13918
|
+
},
|
|
13919
|
+
message: {
|
|
13920
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13921
|
+
type: 'string',
|
|
13922
|
+
},
|
|
13231
13923
|
warning_code: {
|
|
13232
13924
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
13233
13925
|
enum: ['management_transferred'],
|
|
@@ -13238,10 +13930,17 @@ export default {
|
|
|
13238
13930
|
type: 'object',
|
|
13239
13931
|
},
|
|
13240
13932
|
{
|
|
13241
|
-
description: 'Unable to confirm the access code is set on Kwikset device.',
|
|
13933
|
+
description: 'Unable to confirm that the access code is set on Kwikset device.',
|
|
13242
13934
|
properties: {
|
|
13243
|
-
created_at: {
|
|
13244
|
-
|
|
13935
|
+
created_at: {
|
|
13936
|
+
description: 'Date and time at which Seam created the warning.',
|
|
13937
|
+
format: 'date-time',
|
|
13938
|
+
type: 'string',
|
|
13939
|
+
},
|
|
13940
|
+
message: {
|
|
13941
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
13942
|
+
type: 'string',
|
|
13943
|
+
},
|
|
13245
13944
|
warning_code: {
|
|
13246
13945
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
13247
13946
|
enum: ['kwikset_unable_to_confirm_code'],
|
|
@@ -13883,23 +14582,30 @@ export default {
|
|
|
13883
14582
|
type: 'string',
|
|
13884
14583
|
'x-undocumented': 'Only used internally.',
|
|
13885
14584
|
},
|
|
13886
|
-
|
|
14585
|
+
pending_mutations: {
|
|
13887
14586
|
items: {
|
|
13888
|
-
discriminator: { propertyName: '
|
|
14587
|
+
discriminator: { propertyName: 'mutation_code' },
|
|
13889
14588
|
oneOf: [
|
|
13890
14589
|
{
|
|
13891
14590
|
properties: {
|
|
13892
14591
|
created_at: { format: 'date-time', type: 'string' },
|
|
13893
|
-
|
|
14592
|
+
mutation_code: { enum: ['creating'], type: 'string' },
|
|
14593
|
+
},
|
|
14594
|
+
required: ['created_at', 'mutation_code'],
|
|
14595
|
+
type: 'object',
|
|
14596
|
+
},
|
|
14597
|
+
{
|
|
14598
|
+
properties: {
|
|
14599
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
14600
|
+
mutation_code: { enum: ['deleting'], type: 'string' },
|
|
13894
14601
|
},
|
|
13895
|
-
required: ['created_at', '
|
|
14602
|
+
required: ['created_at', 'mutation_code'],
|
|
13896
14603
|
type: 'object',
|
|
13897
14604
|
},
|
|
13898
14605
|
{
|
|
13899
14606
|
properties: {
|
|
13900
14607
|
created_at: { format: 'date-time', type: 'string' },
|
|
13901
|
-
|
|
13902
|
-
modified_from: {
|
|
14608
|
+
from: {
|
|
13903
14609
|
properties: {
|
|
13904
14610
|
email_address: {
|
|
13905
14611
|
format: 'email',
|
|
@@ -13911,7 +14617,11 @@ export default {
|
|
|
13911
14617
|
},
|
|
13912
14618
|
type: 'object',
|
|
13913
14619
|
},
|
|
13914
|
-
|
|
14620
|
+
mutation_code: {
|
|
14621
|
+
enum: ['updating_user_information'],
|
|
14622
|
+
type: 'string',
|
|
14623
|
+
},
|
|
14624
|
+
to: {
|
|
13915
14625
|
properties: {
|
|
13916
14626
|
email_address: {
|
|
13917
14627
|
format: 'email',
|
|
@@ -13924,22 +14634,13 @@ export default {
|
|
|
13924
14634
|
type: 'object',
|
|
13925
14635
|
},
|
|
13926
14636
|
},
|
|
13927
|
-
required: [
|
|
13928
|
-
'created_at',
|
|
13929
|
-
'modification_code',
|
|
13930
|
-
'modified_from',
|
|
13931
|
-
'modified_to',
|
|
13932
|
-
],
|
|
14637
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
13933
14638
|
type: 'object',
|
|
13934
14639
|
},
|
|
13935
14640
|
{
|
|
13936
14641
|
properties: {
|
|
13937
14642
|
created_at: { format: 'date-time', type: 'string' },
|
|
13938
|
-
|
|
13939
|
-
enum: ['access_schedule'],
|
|
13940
|
-
type: 'string',
|
|
13941
|
-
},
|
|
13942
|
-
modified_from: {
|
|
14643
|
+
from: {
|
|
13943
14644
|
properties: {
|
|
13944
14645
|
ends_at: {
|
|
13945
14646
|
description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
@@ -13956,7 +14657,11 @@ export default {
|
|
|
13956
14657
|
required: ['starts_at', 'ends_at'],
|
|
13957
14658
|
type: 'object',
|
|
13958
14659
|
},
|
|
13959
|
-
|
|
14660
|
+
mutation_code: {
|
|
14661
|
+
enum: ['updating_access_schedule'],
|
|
14662
|
+
type: 'string',
|
|
14663
|
+
},
|
|
14664
|
+
to: {
|
|
13960
14665
|
properties: {
|
|
13961
14666
|
ends_at: {
|
|
13962
14667
|
description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
@@ -13974,48 +14679,34 @@ export default {
|
|
|
13974
14679
|
type: 'object',
|
|
13975
14680
|
},
|
|
13976
14681
|
},
|
|
13977
|
-
required: [
|
|
13978
|
-
'created_at',
|
|
13979
|
-
'modification_code',
|
|
13980
|
-
'modified_from',
|
|
13981
|
-
'modified_to',
|
|
13982
|
-
],
|
|
14682
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
13983
14683
|
type: 'object',
|
|
13984
14684
|
},
|
|
13985
14685
|
{
|
|
13986
14686
|
properties: {
|
|
13987
14687
|
created_at: { format: 'date-time', type: 'string' },
|
|
13988
|
-
|
|
13989
|
-
enum: ['suspension_state'],
|
|
13990
|
-
type: 'string',
|
|
13991
|
-
},
|
|
13992
|
-
modified_from: {
|
|
14688
|
+
from: {
|
|
13993
14689
|
properties: { is_suspended: { type: 'boolean' } },
|
|
13994
14690
|
required: ['is_suspended'],
|
|
13995
14691
|
type: 'object',
|
|
13996
14692
|
},
|
|
13997
|
-
|
|
14693
|
+
mutation_code: {
|
|
14694
|
+
enum: ['updating_suspension_state'],
|
|
14695
|
+
type: 'string',
|
|
14696
|
+
},
|
|
14697
|
+
to: {
|
|
13998
14698
|
properties: { is_suspended: { type: 'boolean' } },
|
|
13999
14699
|
required: ['is_suspended'],
|
|
14000
14700
|
type: 'object',
|
|
14001
14701
|
},
|
|
14002
14702
|
},
|
|
14003
|
-
required: [
|
|
14004
|
-
'created_at',
|
|
14005
|
-
'modification_code',
|
|
14006
|
-
'modified_from',
|
|
14007
|
-
'modified_to',
|
|
14008
|
-
],
|
|
14703
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
14009
14704
|
type: 'object',
|
|
14010
14705
|
},
|
|
14011
14706
|
{
|
|
14012
14707
|
properties: {
|
|
14013
14708
|
created_at: { format: 'date-time', type: 'string' },
|
|
14014
|
-
|
|
14015
|
-
enum: ['acs_access_group_membership'],
|
|
14016
|
-
type: 'string',
|
|
14017
|
-
},
|
|
14018
|
-
modified_from: {
|
|
14709
|
+
from: {
|
|
14019
14710
|
properties: {
|
|
14020
14711
|
acs_access_group_id: {
|
|
14021
14712
|
format: 'uuid',
|
|
@@ -14026,7 +14717,11 @@ export default {
|
|
|
14026
14717
|
required: ['acs_access_group_id'],
|
|
14027
14718
|
type: 'object',
|
|
14028
14719
|
},
|
|
14029
|
-
|
|
14720
|
+
mutation_code: {
|
|
14721
|
+
enum: ['updating_group_membership'],
|
|
14722
|
+
type: 'string',
|
|
14723
|
+
},
|
|
14724
|
+
to: {
|
|
14030
14725
|
properties: {
|
|
14031
14726
|
acs_access_group_id: {
|
|
14032
14727
|
format: 'uuid',
|
|
@@ -14038,12 +14733,7 @@ export default {
|
|
|
14038
14733
|
type: 'object',
|
|
14039
14734
|
},
|
|
14040
14735
|
},
|
|
14041
|
-
required: [
|
|
14042
|
-
'created_at',
|
|
14043
|
-
'modification_code',
|
|
14044
|
-
'modified_from',
|
|
14045
|
-
'modified_to',
|
|
14046
|
-
],
|
|
14736
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
14047
14737
|
type: 'object',
|
|
14048
14738
|
},
|
|
14049
14739
|
],
|
|
@@ -15125,40 +15815,85 @@ export default {
|
|
|
15125
15815
|
paths: {
|
|
15126
15816
|
'/access_codes/create': {
|
|
15127
15817
|
post: {
|
|
15818
|
+
description: 'Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
15128
15819
|
operationId: 'accessCodesCreatePost',
|
|
15129
15820
|
requestBody: {
|
|
15130
15821
|
content: {
|
|
15131
15822
|
'application/json': {
|
|
15132
15823
|
schema: {
|
|
15133
15824
|
properties: {
|
|
15134
|
-
allow_external_modification: {
|
|
15825
|
+
allow_external_modification: {
|
|
15826
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
15827
|
+
type: 'boolean',
|
|
15828
|
+
},
|
|
15135
15829
|
attempt_for_offline_device: {
|
|
15136
15830
|
default: true,
|
|
15137
15831
|
type: 'boolean',
|
|
15138
15832
|
},
|
|
15139
15833
|
code: {
|
|
15834
|
+
description: 'Code to be used for access.',
|
|
15140
15835
|
maxLength: 9,
|
|
15141
15836
|
minLength: 4,
|
|
15142
15837
|
pattern: '^\\d+$',
|
|
15143
15838
|
type: 'string',
|
|
15144
15839
|
},
|
|
15145
|
-
common_code_key: {
|
|
15146
|
-
|
|
15147
|
-
|
|
15148
|
-
|
|
15149
|
-
|
|
15150
|
-
|
|
15840
|
+
common_code_key: {
|
|
15841
|
+
description: '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](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).',
|
|
15842
|
+
type: 'string',
|
|
15843
|
+
},
|
|
15844
|
+
device_id: {
|
|
15845
|
+
description: 'ID of the device for which to create the new access code.',
|
|
15846
|
+
format: 'uuid',
|
|
15847
|
+
type: 'string',
|
|
15848
|
+
},
|
|
15849
|
+
ends_at: {
|
|
15850
|
+
description: '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`.',
|
|
15851
|
+
type: 'string',
|
|
15852
|
+
},
|
|
15853
|
+
is_external_modification_allowed: {
|
|
15854
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
15855
|
+
type: 'boolean',
|
|
15856
|
+
},
|
|
15857
|
+
is_offline_access_code: {
|
|
15858
|
+
description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
15859
|
+
type: 'boolean',
|
|
15860
|
+
},
|
|
15861
|
+
is_one_time_use: {
|
|
15862
|
+
description: '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.',
|
|
15863
|
+
type: 'boolean',
|
|
15864
|
+
},
|
|
15151
15865
|
max_time_rounding: {
|
|
15152
15866
|
default: '1hour',
|
|
15867
|
+
description: '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`.',
|
|
15153
15868
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
15154
15869
|
type: 'string',
|
|
15155
15870
|
},
|
|
15156
|
-
name: {
|
|
15157
|
-
|
|
15158
|
-
|
|
15159
|
-
|
|
15160
|
-
|
|
15161
|
-
|
|
15871
|
+
name: {
|
|
15872
|
+
description: 'Name of the new access code.',
|
|
15873
|
+
type: 'string',
|
|
15874
|
+
},
|
|
15875
|
+
prefer_native_scheduling: {
|
|
15876
|
+
description: '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`.',
|
|
15877
|
+
type: 'boolean',
|
|
15878
|
+
},
|
|
15879
|
+
preferred_code_length: {
|
|
15880
|
+
description: '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.',
|
|
15881
|
+
format: 'float',
|
|
15882
|
+
type: 'number',
|
|
15883
|
+
},
|
|
15884
|
+
starts_at: {
|
|
15885
|
+
description: '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.',
|
|
15886
|
+
type: 'string',
|
|
15887
|
+
},
|
|
15888
|
+
sync: {
|
|
15889
|
+
default: false,
|
|
15890
|
+
type: 'boolean',
|
|
15891
|
+
'x-undocumented': 'Only used internally.',
|
|
15892
|
+
},
|
|
15893
|
+
use_backup_access_code_pool: {
|
|
15894
|
+
description: '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-clients/access_codes/pull_backup_access_code).',
|
|
15895
|
+
type: 'boolean',
|
|
15896
|
+
},
|
|
15162
15897
|
use_offline_access_code: { type: 'boolean' },
|
|
15163
15898
|
},
|
|
15164
15899
|
required: ['device_id'],
|
|
@@ -15202,50 +15937,87 @@ export default {
|
|
|
15202
15937
|
'x-fern-sdk-method-name': 'create',
|
|
15203
15938
|
'x-fern-sdk-return-value': 'access_code',
|
|
15204
15939
|
'x-response-key': 'access_code',
|
|
15940
|
+
'x-title': 'Create an Access Code',
|
|
15205
15941
|
},
|
|
15206
15942
|
},
|
|
15207
15943
|
'/access_codes/create_multiple': {
|
|
15208
15944
|
post: {
|
|
15945
|
+
description: 'Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).',
|
|
15209
15946
|
operationId: 'accessCodesCreateMultiplePost',
|
|
15210
15947
|
requestBody: {
|
|
15211
15948
|
content: {
|
|
15212
15949
|
'application/json': {
|
|
15213
15950
|
schema: {
|
|
15214
15951
|
properties: {
|
|
15215
|
-
allow_external_modification: {
|
|
15952
|
+
allow_external_modification: {
|
|
15953
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
15954
|
+
type: 'boolean',
|
|
15955
|
+
},
|
|
15216
15956
|
attempt_for_offline_device: {
|
|
15217
15957
|
default: true,
|
|
15218
15958
|
type: 'boolean',
|
|
15219
15959
|
},
|
|
15220
15960
|
behavior_when_code_cannot_be_shared: {
|
|
15221
15961
|
default: 'throw',
|
|
15962
|
+
description: '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.',
|
|
15222
15963
|
enum: ['throw', 'create_random_code'],
|
|
15223
15964
|
type: 'string',
|
|
15224
15965
|
},
|
|
15225
15966
|
code: {
|
|
15967
|
+
description: 'Code to be used for access.',
|
|
15226
15968
|
maxLength: 9,
|
|
15227
15969
|
minLength: 4,
|
|
15228
15970
|
pattern: '^\\d+$',
|
|
15229
15971
|
type: 'string',
|
|
15230
15972
|
},
|
|
15231
15973
|
device_ids: {
|
|
15974
|
+
description: 'IDs of the devices for which to create the new access codes.',
|
|
15232
15975
|
items: { format: 'uuid', type: 'string' },
|
|
15233
15976
|
type: 'array',
|
|
15234
15977
|
},
|
|
15235
|
-
ends_at: {
|
|
15236
|
-
|
|
15237
|
-
|
|
15238
|
-
|
|
15978
|
+
ends_at: {
|
|
15979
|
+
description: '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`.',
|
|
15980
|
+
type: 'string',
|
|
15981
|
+
},
|
|
15982
|
+
is_external_modification_allowed: {
|
|
15983
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
15984
|
+
type: 'boolean',
|
|
15985
|
+
},
|
|
15986
|
+
is_offline_access_code: {
|
|
15987
|
+
description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
15988
|
+
type: 'boolean',
|
|
15989
|
+
},
|
|
15990
|
+
is_one_time_use: {
|
|
15991
|
+
description: '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.',
|
|
15992
|
+
type: 'boolean',
|
|
15993
|
+
},
|
|
15239
15994
|
max_time_rounding: {
|
|
15240
15995
|
default: '1hour',
|
|
15996
|
+
description: '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`.',
|
|
15241
15997
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
15242
15998
|
type: 'string',
|
|
15243
15999
|
},
|
|
15244
|
-
name: {
|
|
15245
|
-
|
|
15246
|
-
|
|
15247
|
-
|
|
15248
|
-
|
|
16000
|
+
name: {
|
|
16001
|
+
description: 'Name of the new access code.',
|
|
16002
|
+
type: 'string',
|
|
16003
|
+
},
|
|
16004
|
+
prefer_native_scheduling: {
|
|
16005
|
+
description: '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`.',
|
|
16006
|
+
type: 'boolean',
|
|
16007
|
+
},
|
|
16008
|
+
preferred_code_length: {
|
|
16009
|
+
description: '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.',
|
|
16010
|
+
format: 'float',
|
|
16011
|
+
type: 'number',
|
|
16012
|
+
},
|
|
16013
|
+
starts_at: {
|
|
16014
|
+
description: '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.',
|
|
16015
|
+
type: 'string',
|
|
16016
|
+
},
|
|
16017
|
+
use_backup_access_code_pool: {
|
|
16018
|
+
description: '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-clients/access_codes/pull_backup_access_code).',
|
|
16019
|
+
type: 'boolean',
|
|
16020
|
+
},
|
|
15249
16021
|
use_offline_access_code: { type: 'boolean' },
|
|
15250
16022
|
},
|
|
15251
16023
|
required: ['device_ids'],
|
|
@@ -15288,48 +16060,85 @@ export default {
|
|
|
15288
16060
|
'x-fern-sdk-method-name': 'create_multiple',
|
|
15289
16061
|
'x-fern-sdk-return-value': 'access_codes',
|
|
15290
16062
|
'x-response-key': 'access_codes',
|
|
16063
|
+
'x-title': 'Create Multiple Linked Access Codes',
|
|
15291
16064
|
},
|
|
15292
16065
|
put: {
|
|
16066
|
+
description: 'Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).',
|
|
15293
16067
|
operationId: 'accessCodesCreateMultiplePut',
|
|
15294
16068
|
requestBody: {
|
|
15295
16069
|
content: {
|
|
15296
16070
|
'application/json': {
|
|
15297
16071
|
schema: {
|
|
15298
16072
|
properties: {
|
|
15299
|
-
allow_external_modification: {
|
|
16073
|
+
allow_external_modification: {
|
|
16074
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
16075
|
+
type: 'boolean',
|
|
16076
|
+
},
|
|
15300
16077
|
attempt_for_offline_device: {
|
|
15301
16078
|
default: true,
|
|
15302
16079
|
type: 'boolean',
|
|
15303
16080
|
},
|
|
15304
16081
|
behavior_when_code_cannot_be_shared: {
|
|
15305
16082
|
default: 'throw',
|
|
16083
|
+
description: '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.',
|
|
15306
16084
|
enum: ['throw', 'create_random_code'],
|
|
15307
16085
|
type: 'string',
|
|
15308
16086
|
},
|
|
15309
16087
|
code: {
|
|
16088
|
+
description: 'Code to be used for access.',
|
|
15310
16089
|
maxLength: 9,
|
|
15311
16090
|
minLength: 4,
|
|
15312
16091
|
pattern: '^\\d+$',
|
|
15313
16092
|
type: 'string',
|
|
15314
16093
|
},
|
|
15315
16094
|
device_ids: {
|
|
16095
|
+
description: 'IDs of the devices for which to create the new access codes.',
|
|
15316
16096
|
items: { format: 'uuid', type: 'string' },
|
|
15317
16097
|
type: 'array',
|
|
15318
16098
|
},
|
|
15319
|
-
ends_at: {
|
|
15320
|
-
|
|
15321
|
-
|
|
15322
|
-
|
|
16099
|
+
ends_at: {
|
|
16100
|
+
description: '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`.',
|
|
16101
|
+
type: 'string',
|
|
16102
|
+
},
|
|
16103
|
+
is_external_modification_allowed: {
|
|
16104
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
16105
|
+
type: 'boolean',
|
|
16106
|
+
},
|
|
16107
|
+
is_offline_access_code: {
|
|
16108
|
+
description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
16109
|
+
type: 'boolean',
|
|
16110
|
+
},
|
|
16111
|
+
is_one_time_use: {
|
|
16112
|
+
description: '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.',
|
|
16113
|
+
type: 'boolean',
|
|
16114
|
+
},
|
|
15323
16115
|
max_time_rounding: {
|
|
15324
16116
|
default: '1hour',
|
|
16117
|
+
description: '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`.',
|
|
15325
16118
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
15326
16119
|
type: 'string',
|
|
15327
16120
|
},
|
|
15328
|
-
name: {
|
|
15329
|
-
|
|
15330
|
-
|
|
15331
|
-
|
|
15332
|
-
|
|
16121
|
+
name: {
|
|
16122
|
+
description: 'Name of the new access code.',
|
|
16123
|
+
type: 'string',
|
|
16124
|
+
},
|
|
16125
|
+
prefer_native_scheduling: {
|
|
16126
|
+
description: '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`.',
|
|
16127
|
+
type: 'boolean',
|
|
16128
|
+
},
|
|
16129
|
+
preferred_code_length: {
|
|
16130
|
+
description: '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.',
|
|
16131
|
+
format: 'float',
|
|
16132
|
+
type: 'number',
|
|
16133
|
+
},
|
|
16134
|
+
starts_at: {
|
|
16135
|
+
description: '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.',
|
|
16136
|
+
type: 'string',
|
|
16137
|
+
},
|
|
16138
|
+
use_backup_access_code_pool: {
|
|
16139
|
+
description: '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-clients/access_codes/pull_backup_access_code).',
|
|
16140
|
+
type: 'boolean',
|
|
16141
|
+
},
|
|
15333
16142
|
use_offline_access_code: { type: 'boolean' },
|
|
15334
16143
|
},
|
|
15335
16144
|
required: ['device_ids'],
|
|
@@ -15370,19 +16179,33 @@ export default {
|
|
|
15370
16179
|
tags: ['/access_codes'],
|
|
15371
16180
|
'x-fern-ignore': true,
|
|
15372
16181
|
'x-response-key': 'access_codes',
|
|
16182
|
+
'x-title': 'Create Multiple Linked Access Codes',
|
|
15373
16183
|
},
|
|
15374
16184
|
},
|
|
15375
16185
|
'/access_codes/delete': {
|
|
15376
16186
|
post: {
|
|
16187
|
+
description: 'Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
15377
16188
|
operationId: 'accessCodesDeletePost',
|
|
15378
16189
|
requestBody: {
|
|
15379
16190
|
content: {
|
|
15380
16191
|
'application/json': {
|
|
15381
16192
|
schema: {
|
|
15382
16193
|
properties: {
|
|
15383
|
-
access_code_id: {
|
|
15384
|
-
|
|
15385
|
-
|
|
16194
|
+
access_code_id: {
|
|
16195
|
+
description: 'ID of the access code to delete.',
|
|
16196
|
+
format: 'uuid',
|
|
16197
|
+
type: 'string',
|
|
16198
|
+
},
|
|
16199
|
+
device_id: {
|
|
16200
|
+
description: 'ID of the device for which to delete the access code.',
|
|
16201
|
+
format: 'uuid',
|
|
16202
|
+
type: 'string',
|
|
16203
|
+
},
|
|
16204
|
+
sync: {
|
|
16205
|
+
default: false,
|
|
16206
|
+
type: 'boolean',
|
|
16207
|
+
'x-undocumented': 'Only used internally.',
|
|
16208
|
+
},
|
|
15386
16209
|
},
|
|
15387
16210
|
required: ['access_code_id'],
|
|
15388
16211
|
type: 'object',
|
|
@@ -15423,6 +16246,7 @@ export default {
|
|
|
15423
16246
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
15424
16247
|
'x-fern-sdk-method-name': 'delete',
|
|
15425
16248
|
'x-response-key': null,
|
|
16249
|
+
'x-title': 'Delete an Access Code',
|
|
15426
16250
|
},
|
|
15427
16251
|
},
|
|
15428
16252
|
'/access_codes/generate_code': {
|
|
@@ -15476,15 +16300,27 @@ export default {
|
|
|
15476
16300
|
},
|
|
15477
16301
|
'/access_codes/get': {
|
|
15478
16302
|
post: {
|
|
16303
|
+
description: 'Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.',
|
|
15479
16304
|
operationId: 'accessCodesGetPost',
|
|
15480
16305
|
requestBody: {
|
|
15481
16306
|
content: {
|
|
15482
16307
|
'application/json': {
|
|
15483
16308
|
schema: {
|
|
15484
16309
|
properties: {
|
|
15485
|
-
access_code_id: {
|
|
15486
|
-
|
|
15487
|
-
|
|
16310
|
+
access_code_id: {
|
|
16311
|
+
description: 'ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
16312
|
+
format: 'uuid',
|
|
16313
|
+
type: 'string',
|
|
16314
|
+
},
|
|
16315
|
+
code: {
|
|
16316
|
+
description: 'Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
16317
|
+
type: 'string',
|
|
16318
|
+
},
|
|
16319
|
+
device_id: {
|
|
16320
|
+
description: '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`.',
|
|
16321
|
+
format: 'uuid',
|
|
16322
|
+
type: 'string',
|
|
16323
|
+
},
|
|
15488
16324
|
},
|
|
15489
16325
|
type: 'object',
|
|
15490
16326
|
},
|
|
@@ -15522,10 +16358,12 @@ export default {
|
|
|
15522
16358
|
'x-fern-sdk-method-name': 'get',
|
|
15523
16359
|
'x-fern-sdk-return-value': 'access_code',
|
|
15524
16360
|
'x-response-key': 'access_code',
|
|
16361
|
+
'x-title': 'Get an Access Code',
|
|
15525
16362
|
},
|
|
15526
16363
|
},
|
|
15527
16364
|
'/access_codes/list': {
|
|
15528
16365
|
post: {
|
|
16366
|
+
description: 'Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify either `device_id` or `access_code_ids`.',
|
|
15529
16367
|
operationId: 'accessCodesListPost',
|
|
15530
16368
|
requestBody: {
|
|
15531
16369
|
content: {
|
|
@@ -15533,11 +16371,19 @@ export default {
|
|
|
15533
16371
|
schema: {
|
|
15534
16372
|
properties: {
|
|
15535
16373
|
access_code_ids: {
|
|
16374
|
+
description: 'IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.',
|
|
15536
16375
|
items: { format: 'uuid', type: 'string' },
|
|
15537
16376
|
type: 'array',
|
|
15538
16377
|
},
|
|
15539
|
-
device_id: {
|
|
15540
|
-
|
|
16378
|
+
device_id: {
|
|
16379
|
+
description: 'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
|
|
16380
|
+
format: 'uuid',
|
|
16381
|
+
type: 'string',
|
|
16382
|
+
},
|
|
16383
|
+
user_identifier_key: {
|
|
16384
|
+
description: 'Your user ID for the user by which to filter access codes.',
|
|
16385
|
+
type: 'string',
|
|
16386
|
+
},
|
|
15541
16387
|
},
|
|
15542
16388
|
type: 'object',
|
|
15543
16389
|
},
|
|
@@ -15578,18 +16424,23 @@ export default {
|
|
|
15578
16424
|
'x-fern-sdk-method-name': 'list',
|
|
15579
16425
|
'x-fern-sdk-return-value': 'access_codes',
|
|
15580
16426
|
'x-response-key': 'access_codes',
|
|
16427
|
+
'x-title': 'List Access Codes',
|
|
15581
16428
|
},
|
|
15582
16429
|
},
|
|
15583
16430
|
'/access_codes/pull_backup_access_code': {
|
|
15584
16431
|
post: {
|
|
15585
|
-
description:
|
|
16432
|
+
description: "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes.\n\nIf there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.",
|
|
15586
16433
|
operationId: 'accessCodesPullBackupAccessCodePost',
|
|
15587
16434
|
requestBody: {
|
|
15588
16435
|
content: {
|
|
15589
16436
|
'application/json': {
|
|
15590
16437
|
schema: {
|
|
15591
16438
|
properties: {
|
|
15592
|
-
access_code_id: {
|
|
16439
|
+
access_code_id: {
|
|
16440
|
+
description: 'ID of the access code for which you want to pull a backup access code.',
|
|
16441
|
+
format: 'uuid',
|
|
16442
|
+
type: 'string',
|
|
16443
|
+
},
|
|
15593
16444
|
},
|
|
15594
16445
|
required: ['access_code_id'],
|
|
15595
16446
|
type: 'object',
|
|
@@ -15631,10 +16482,12 @@ export default {
|
|
|
15631
16482
|
'x-fern-sdk-method-name': 'pull_backup_access_code',
|
|
15632
16483
|
'x-fern-sdk-return-value': 'access_code',
|
|
15633
16484
|
'x-response-key': 'access_code',
|
|
16485
|
+
'x-title': 'Pull a Backup Access Code',
|
|
15634
16486
|
},
|
|
15635
16487
|
},
|
|
15636
16488
|
'/access_codes/simulate/create_unmanaged_access_code': {
|
|
15637
16489
|
post: {
|
|
16490
|
+
description: 'Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
|
|
15638
16491
|
operationId: 'accessCodesSimulateCreateUnmanagedAccessCodePost',
|
|
15639
16492
|
requestBody: {
|
|
15640
16493
|
content: {
|
|
@@ -15642,13 +16495,21 @@ export default {
|
|
|
15642
16495
|
schema: {
|
|
15643
16496
|
properties: {
|
|
15644
16497
|
code: {
|
|
16498
|
+
description: 'Code of the simulated unmanaged access code.',
|
|
15645
16499
|
maxLength: 8,
|
|
15646
16500
|
minLength: 4,
|
|
15647
16501
|
pattern: '^\\d+$',
|
|
15648
16502
|
type: 'string',
|
|
15649
16503
|
},
|
|
15650
|
-
device_id: {
|
|
15651
|
-
|
|
16504
|
+
device_id: {
|
|
16505
|
+
description: 'ID of the device for which you want to simulate the creation of an unmanaged access code.',
|
|
16506
|
+
format: 'uuid',
|
|
16507
|
+
type: 'string',
|
|
16508
|
+
},
|
|
16509
|
+
name: {
|
|
16510
|
+
description: 'Name of the simulated unmanaged access code.',
|
|
16511
|
+
type: 'string',
|
|
16512
|
+
},
|
|
15652
16513
|
},
|
|
15653
16514
|
required: ['device_id', 'name', 'code'],
|
|
15654
16515
|
type: 'object',
|
|
@@ -15689,21 +16550,40 @@ export default {
|
|
|
15689
16550
|
'x-fern-sdk-method-name': 'create_unmanaged_access_code',
|
|
15690
16551
|
'x-fern-sdk-return-value': 'access_code',
|
|
15691
16552
|
'x-response-key': 'access_code',
|
|
16553
|
+
'x-title': 'Simulate Creating an Unmanaged Access Code',
|
|
15692
16554
|
},
|
|
15693
16555
|
},
|
|
15694
16556
|
'/access_codes/unmanaged/convert_to_managed': {
|
|
15695
16557
|
patch: {
|
|
16558
|
+
description: 'Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.',
|
|
15696
16559
|
operationId: 'accessCodesUnmanagedConvertToManagedPatch',
|
|
15697
16560
|
requestBody: {
|
|
15698
16561
|
content: {
|
|
15699
16562
|
'application/json': {
|
|
15700
16563
|
schema: {
|
|
15701
16564
|
properties: {
|
|
15702
|
-
access_code_id: {
|
|
15703
|
-
|
|
15704
|
-
|
|
15705
|
-
|
|
15706
|
-
|
|
16565
|
+
access_code_id: {
|
|
16566
|
+
description: 'ID of the unmanaged access code that you want to convert to a managed access code.',
|
|
16567
|
+
format: 'uuid',
|
|
16568
|
+
type: 'string',
|
|
16569
|
+
},
|
|
16570
|
+
allow_external_modification: {
|
|
16571
|
+
description: 'Indicates whether external modification of the access code is allowed.',
|
|
16572
|
+
type: 'boolean',
|
|
16573
|
+
},
|
|
16574
|
+
force: {
|
|
16575
|
+
description: 'Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.',
|
|
16576
|
+
type: 'boolean',
|
|
16577
|
+
},
|
|
16578
|
+
is_external_modification_allowed: {
|
|
16579
|
+
description: 'Indicates whether external modification of the access code is allowed.',
|
|
16580
|
+
type: 'boolean',
|
|
16581
|
+
},
|
|
16582
|
+
sync: {
|
|
16583
|
+
default: false,
|
|
16584
|
+
type: 'boolean',
|
|
16585
|
+
'x-undocumented': 'Only used internally.',
|
|
16586
|
+
},
|
|
15707
16587
|
},
|
|
15708
16588
|
required: ['access_code_id'],
|
|
15709
16589
|
type: 'object',
|
|
@@ -15738,19 +16618,38 @@ export default {
|
|
|
15738
16618
|
'x-action-attempt-type': 'CONVERT_ACCESS_CODE_TO_MANAGED',
|
|
15739
16619
|
'x-fern-ignore': true,
|
|
15740
16620
|
'x-response-key': null,
|
|
16621
|
+
'x-title': 'Convert an Unmanaged Access Code',
|
|
15741
16622
|
},
|
|
15742
16623
|
post: {
|
|
16624
|
+
description: 'Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.',
|
|
15743
16625
|
operationId: 'accessCodesUnmanagedConvertToManagedPost',
|
|
15744
16626
|
requestBody: {
|
|
15745
16627
|
content: {
|
|
15746
16628
|
'application/json': {
|
|
15747
16629
|
schema: {
|
|
15748
16630
|
properties: {
|
|
15749
|
-
access_code_id: {
|
|
15750
|
-
|
|
15751
|
-
|
|
15752
|
-
|
|
15753
|
-
|
|
16631
|
+
access_code_id: {
|
|
16632
|
+
description: 'ID of the unmanaged access code that you want to convert to a managed access code.',
|
|
16633
|
+
format: 'uuid',
|
|
16634
|
+
type: 'string',
|
|
16635
|
+
},
|
|
16636
|
+
allow_external_modification: {
|
|
16637
|
+
description: 'Indicates whether external modification of the access code is allowed.',
|
|
16638
|
+
type: 'boolean',
|
|
16639
|
+
},
|
|
16640
|
+
force: {
|
|
16641
|
+
description: 'Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.',
|
|
16642
|
+
type: 'boolean',
|
|
16643
|
+
},
|
|
16644
|
+
is_external_modification_allowed: {
|
|
16645
|
+
description: 'Indicates whether external modification of the access code is allowed.',
|
|
16646
|
+
type: 'boolean',
|
|
16647
|
+
},
|
|
16648
|
+
sync: {
|
|
16649
|
+
default: false,
|
|
16650
|
+
type: 'boolean',
|
|
16651
|
+
'x-undocumented': 'Only used internally.',
|
|
16652
|
+
},
|
|
15754
16653
|
},
|
|
15755
16654
|
required: ['access_code_id'],
|
|
15756
16655
|
type: 'object',
|
|
@@ -15786,18 +16685,28 @@ export default {
|
|
|
15786
16685
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
15787
16686
|
'x-fern-sdk-method-name': 'convert_to_managed',
|
|
15788
16687
|
'x-response-key': null,
|
|
16688
|
+
'x-title': 'Convert an Unmanaged Access Code',
|
|
15789
16689
|
},
|
|
15790
16690
|
},
|
|
15791
16691
|
'/access_codes/unmanaged/delete': {
|
|
15792
16692
|
post: {
|
|
16693
|
+
description: 'Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
15793
16694
|
operationId: 'accessCodesUnmanagedDeletePost',
|
|
15794
16695
|
requestBody: {
|
|
15795
16696
|
content: {
|
|
15796
16697
|
'application/json': {
|
|
15797
16698
|
schema: {
|
|
15798
16699
|
properties: {
|
|
15799
|
-
access_code_id: {
|
|
15800
|
-
|
|
16700
|
+
access_code_id: {
|
|
16701
|
+
description: 'ID of the unmanaged access code to delete.',
|
|
16702
|
+
format: 'uuid',
|
|
16703
|
+
type: 'string',
|
|
16704
|
+
},
|
|
16705
|
+
sync: {
|
|
16706
|
+
default: false,
|
|
16707
|
+
type: 'boolean',
|
|
16708
|
+
'x-undocumented': 'Only used internally.',
|
|
16709
|
+
},
|
|
15801
16710
|
},
|
|
15802
16711
|
required: ['access_code_id'],
|
|
15803
16712
|
type: 'object',
|
|
@@ -15838,19 +16747,32 @@ export default {
|
|
|
15838
16747
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
15839
16748
|
'x-fern-sdk-method-name': 'delete',
|
|
15840
16749
|
'x-response-key': null,
|
|
16750
|
+
'x-title': 'Delete an Unmanaged Access Code',
|
|
15841
16751
|
},
|
|
15842
16752
|
},
|
|
15843
16753
|
'/access_codes/unmanaged/get': {
|
|
15844
16754
|
post: {
|
|
16755
|
+
description: 'Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.',
|
|
15845
16756
|
operationId: 'accessCodesUnmanagedGetPost',
|
|
15846
16757
|
requestBody: {
|
|
15847
16758
|
content: {
|
|
15848
16759
|
'application/json': {
|
|
15849
16760
|
schema: {
|
|
15850
16761
|
properties: {
|
|
15851
|
-
access_code_id: {
|
|
15852
|
-
|
|
15853
|
-
|
|
16762
|
+
access_code_id: {
|
|
16763
|
+
description: 'ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
16764
|
+
format: 'uuid',
|
|
16765
|
+
type: 'string',
|
|
16766
|
+
},
|
|
16767
|
+
code: {
|
|
16768
|
+
description: 'Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
16769
|
+
type: 'string',
|
|
16770
|
+
},
|
|
16771
|
+
device_id: {
|
|
16772
|
+
description: 'ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
16773
|
+
format: 'uuid',
|
|
16774
|
+
type: 'string',
|
|
16775
|
+
},
|
|
15854
16776
|
},
|
|
15855
16777
|
type: 'object',
|
|
15856
16778
|
},
|
|
@@ -15890,18 +16812,27 @@ export default {
|
|
|
15890
16812
|
'x-fern-sdk-method-name': 'get',
|
|
15891
16813
|
'x-fern-sdk-return-value': 'access_code',
|
|
15892
16814
|
'x-response-key': 'access_code',
|
|
16815
|
+
'x-title': 'Get an Unmanaged Access Code',
|
|
15893
16816
|
},
|
|
15894
16817
|
},
|
|
15895
16818
|
'/access_codes/unmanaged/list': {
|
|
15896
16819
|
post: {
|
|
16820
|
+
description: 'Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
15897
16821
|
operationId: 'accessCodesUnmanagedListPost',
|
|
15898
16822
|
requestBody: {
|
|
15899
16823
|
content: {
|
|
15900
16824
|
'application/json': {
|
|
15901
16825
|
schema: {
|
|
15902
16826
|
properties: {
|
|
15903
|
-
device_id: {
|
|
15904
|
-
|
|
16827
|
+
device_id: {
|
|
16828
|
+
description: 'ID of the device for which you want to list unmanaged access codes.',
|
|
16829
|
+
format: 'uuid',
|
|
16830
|
+
type: 'string',
|
|
16831
|
+
},
|
|
16832
|
+
user_identifier_key: {
|
|
16833
|
+
description: 'Your user ID for the user by which to filter unmanaged access codes.',
|
|
16834
|
+
type: 'string',
|
|
16835
|
+
},
|
|
15905
16836
|
},
|
|
15906
16837
|
required: ['device_id'],
|
|
15907
16838
|
type: 'object',
|
|
@@ -15945,20 +16876,35 @@ export default {
|
|
|
15945
16876
|
'x-fern-sdk-method-name': 'list',
|
|
15946
16877
|
'x-fern-sdk-return-value': 'access_codes',
|
|
15947
16878
|
'x-response-key': 'access_codes',
|
|
16879
|
+
'x-title': 'List Unmanaged Access Codes',
|
|
15948
16880
|
},
|
|
15949
16881
|
},
|
|
15950
16882
|
'/access_codes/unmanaged/update': {
|
|
15951
16883
|
patch: {
|
|
16884
|
+
description: 'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
15952
16885
|
operationId: 'accessCodesUnmanagedUpdatePatch',
|
|
15953
16886
|
requestBody: {
|
|
15954
16887
|
content: {
|
|
15955
16888
|
'application/json': {
|
|
15956
16889
|
schema: {
|
|
15957
16890
|
properties: {
|
|
15958
|
-
access_code_id: {
|
|
15959
|
-
|
|
15960
|
-
|
|
15961
|
-
|
|
16891
|
+
access_code_id: {
|
|
16892
|
+
description: 'ID of the unmanaged access code that you want to update.',
|
|
16893
|
+
format: 'uuid',
|
|
16894
|
+
type: 'string',
|
|
16895
|
+
},
|
|
16896
|
+
allow_external_modification: {
|
|
16897
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
16898
|
+
type: 'boolean',
|
|
16899
|
+
},
|
|
16900
|
+
force: {
|
|
16901
|
+
description: 'Indicates whether to force the unmanaged access code update.',
|
|
16902
|
+
type: 'boolean',
|
|
16903
|
+
},
|
|
16904
|
+
is_external_modification_allowed: {
|
|
16905
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
16906
|
+
type: 'boolean',
|
|
16907
|
+
},
|
|
15962
16908
|
is_managed: { type: 'boolean' },
|
|
15963
16909
|
},
|
|
15964
16910
|
required: ['access_code_id', 'is_managed'],
|
|
@@ -15993,18 +16939,33 @@ export default {
|
|
|
15993
16939
|
tags: ['/access_codes'],
|
|
15994
16940
|
'x-fern-ignore': true,
|
|
15995
16941
|
'x-response-key': null,
|
|
16942
|
+
'x-title': 'Update an Unmanaged Access Code',
|
|
15996
16943
|
},
|
|
15997
16944
|
post: {
|
|
16945
|
+
description: 'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
15998
16946
|
operationId: 'accessCodesUnmanagedUpdatePost',
|
|
15999
16947
|
requestBody: {
|
|
16000
16948
|
content: {
|
|
16001
16949
|
'application/json': {
|
|
16002
16950
|
schema: {
|
|
16003
16951
|
properties: {
|
|
16004
|
-
access_code_id: {
|
|
16005
|
-
|
|
16006
|
-
|
|
16007
|
-
|
|
16952
|
+
access_code_id: {
|
|
16953
|
+
description: 'ID of the unmanaged access code that you want to update.',
|
|
16954
|
+
format: 'uuid',
|
|
16955
|
+
type: 'string',
|
|
16956
|
+
},
|
|
16957
|
+
allow_external_modification: {
|
|
16958
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
16959
|
+
type: 'boolean',
|
|
16960
|
+
},
|
|
16961
|
+
force: {
|
|
16962
|
+
description: 'Indicates whether to force the unmanaged access code update.',
|
|
16963
|
+
type: 'boolean',
|
|
16964
|
+
},
|
|
16965
|
+
is_external_modification_allowed: {
|
|
16966
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
16967
|
+
type: 'boolean',
|
|
16968
|
+
},
|
|
16008
16969
|
is_managed: { type: 'boolean' },
|
|
16009
16970
|
},
|
|
16010
16971
|
required: ['access_code_id', 'is_managed'],
|
|
@@ -16040,46 +17001,100 @@ export default {
|
|
|
16040
17001
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
16041
17002
|
'x-fern-sdk-method-name': 'update',
|
|
16042
17003
|
'x-response-key': null,
|
|
17004
|
+
'x-title': 'Update an Unmanaged Access Code',
|
|
16043
17005
|
},
|
|
16044
17006
|
},
|
|
16045
17007
|
'/access_codes/update': {
|
|
16046
17008
|
patch: {
|
|
17009
|
+
description: 'Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).',
|
|
16047
17010
|
operationId: 'accessCodesUpdatePatch',
|
|
16048
17011
|
requestBody: {
|
|
16049
17012
|
content: {
|
|
16050
17013
|
'application/json': {
|
|
16051
17014
|
schema: {
|
|
16052
17015
|
properties: {
|
|
16053
|
-
access_code_id: {
|
|
16054
|
-
|
|
17016
|
+
access_code_id: {
|
|
17017
|
+
description: 'ID of the access code that you want to update.',
|
|
17018
|
+
format: 'uuid',
|
|
17019
|
+
type: 'string',
|
|
17020
|
+
},
|
|
17021
|
+
allow_external_modification: {
|
|
17022
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17023
|
+
type: 'boolean',
|
|
17024
|
+
},
|
|
16055
17025
|
attempt_for_offline_device: {
|
|
16056
17026
|
default: true,
|
|
16057
17027
|
type: 'boolean',
|
|
16058
17028
|
},
|
|
16059
17029
|
code: {
|
|
17030
|
+
description: 'Code to be used for access.',
|
|
16060
17031
|
maxLength: 9,
|
|
16061
17032
|
minLength: 4,
|
|
16062
17033
|
pattern: '^\\d+$',
|
|
16063
17034
|
type: 'string',
|
|
16064
17035
|
},
|
|
16065
|
-
device_id: {
|
|
16066
|
-
|
|
16067
|
-
|
|
16068
|
-
|
|
16069
|
-
|
|
16070
|
-
|
|
17036
|
+
device_id: {
|
|
17037
|
+
description: 'ID of the device containing the access code that you want to update.',
|
|
17038
|
+
format: 'uuid',
|
|
17039
|
+
type: 'string',
|
|
17040
|
+
},
|
|
17041
|
+
ends_at: {
|
|
17042
|
+
description: '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`.',
|
|
17043
|
+
type: 'string',
|
|
17044
|
+
},
|
|
17045
|
+
is_external_modification_allowed: {
|
|
17046
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17047
|
+
type: 'boolean',
|
|
17048
|
+
},
|
|
17049
|
+
is_managed: {
|
|
17050
|
+
description: 'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
|
|
17051
|
+
type: 'boolean',
|
|
17052
|
+
},
|
|
17053
|
+
is_offline_access_code: {
|
|
17054
|
+
description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17055
|
+
type: 'boolean',
|
|
17056
|
+
},
|
|
17057
|
+
is_one_time_use: {
|
|
17058
|
+
description: '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.',
|
|
17059
|
+
type: 'boolean',
|
|
17060
|
+
},
|
|
16071
17061
|
max_time_rounding: {
|
|
16072
17062
|
default: '1hour',
|
|
17063
|
+
description: '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`.',
|
|
16073
17064
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16074
17065
|
type: 'string',
|
|
16075
17066
|
},
|
|
16076
|
-
name: {
|
|
16077
|
-
|
|
16078
|
-
|
|
16079
|
-
|
|
16080
|
-
|
|
16081
|
-
|
|
16082
|
-
|
|
17067
|
+
name: {
|
|
17068
|
+
description: 'Name of the new access code.',
|
|
17069
|
+
type: 'string',
|
|
17070
|
+
},
|
|
17071
|
+
prefer_native_scheduling: {
|
|
17072
|
+
description: '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`.',
|
|
17073
|
+
type: 'boolean',
|
|
17074
|
+
},
|
|
17075
|
+
preferred_code_length: {
|
|
17076
|
+
description: '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.',
|
|
17077
|
+
format: 'float',
|
|
17078
|
+
type: 'number',
|
|
17079
|
+
},
|
|
17080
|
+
starts_at: {
|
|
17081
|
+
description: '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.',
|
|
17082
|
+
type: 'string',
|
|
17083
|
+
},
|
|
17084
|
+
sync: {
|
|
17085
|
+
default: false,
|
|
17086
|
+
type: 'boolean',
|
|
17087
|
+
'x-undocumented': 'Only used internally.',
|
|
17088
|
+
},
|
|
17089
|
+
type: {
|
|
17090
|
+
description: 'Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).',
|
|
17091
|
+
enum: ['ongoing', 'time_bound'],
|
|
17092
|
+
type: 'string',
|
|
17093
|
+
},
|
|
17094
|
+
use_backup_access_code_pool: {
|
|
17095
|
+
description: '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-clients/access_codes/pull_backup_access_code).',
|
|
17096
|
+
type: 'boolean',
|
|
17097
|
+
},
|
|
16083
17098
|
use_offline_access_code: { type: 'boolean' },
|
|
16084
17099
|
},
|
|
16085
17100
|
required: ['access_code_id'],
|
|
@@ -16120,44 +17135,98 @@ export default {
|
|
|
16120
17135
|
'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
|
|
16121
17136
|
'x-fern-ignore': true,
|
|
16122
17137
|
'x-response-key': null,
|
|
17138
|
+
'x-title': 'Update an Access Code',
|
|
16123
17139
|
},
|
|
16124
17140
|
post: {
|
|
17141
|
+
description: 'Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).',
|
|
16125
17142
|
operationId: 'accessCodesUpdatePost',
|
|
16126
17143
|
requestBody: {
|
|
16127
17144
|
content: {
|
|
16128
17145
|
'application/json': {
|
|
16129
17146
|
schema: {
|
|
16130
17147
|
properties: {
|
|
16131
|
-
access_code_id: {
|
|
16132
|
-
|
|
17148
|
+
access_code_id: {
|
|
17149
|
+
description: 'ID of the access code that you want to update.',
|
|
17150
|
+
format: 'uuid',
|
|
17151
|
+
type: 'string',
|
|
17152
|
+
},
|
|
17153
|
+
allow_external_modification: {
|
|
17154
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17155
|
+
type: 'boolean',
|
|
17156
|
+
},
|
|
16133
17157
|
attempt_for_offline_device: {
|
|
16134
17158
|
default: true,
|
|
16135
17159
|
type: 'boolean',
|
|
16136
17160
|
},
|
|
16137
17161
|
code: {
|
|
17162
|
+
description: 'Code to be used for access.',
|
|
16138
17163
|
maxLength: 9,
|
|
16139
17164
|
minLength: 4,
|
|
16140
17165
|
pattern: '^\\d+$',
|
|
16141
17166
|
type: 'string',
|
|
16142
17167
|
},
|
|
16143
|
-
device_id: {
|
|
16144
|
-
|
|
16145
|
-
|
|
16146
|
-
|
|
16147
|
-
|
|
16148
|
-
|
|
17168
|
+
device_id: {
|
|
17169
|
+
description: 'ID of the device containing the access code that you want to update.',
|
|
17170
|
+
format: 'uuid',
|
|
17171
|
+
type: 'string',
|
|
17172
|
+
},
|
|
17173
|
+
ends_at: {
|
|
17174
|
+
description: '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`.',
|
|
17175
|
+
type: 'string',
|
|
17176
|
+
},
|
|
17177
|
+
is_external_modification_allowed: {
|
|
17178
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17179
|
+
type: 'boolean',
|
|
17180
|
+
},
|
|
17181
|
+
is_managed: {
|
|
17182
|
+
description: 'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
|
|
17183
|
+
type: 'boolean',
|
|
17184
|
+
},
|
|
17185
|
+
is_offline_access_code: {
|
|
17186
|
+
description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17187
|
+
type: 'boolean',
|
|
17188
|
+
},
|
|
17189
|
+
is_one_time_use: {
|
|
17190
|
+
description: '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.',
|
|
17191
|
+
type: 'boolean',
|
|
17192
|
+
},
|
|
16149
17193
|
max_time_rounding: {
|
|
16150
17194
|
default: '1hour',
|
|
17195
|
+
description: '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`.',
|
|
16151
17196
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16152
17197
|
type: 'string',
|
|
16153
17198
|
},
|
|
16154
|
-
name: {
|
|
16155
|
-
|
|
16156
|
-
|
|
16157
|
-
|
|
16158
|
-
|
|
16159
|
-
|
|
16160
|
-
|
|
17199
|
+
name: {
|
|
17200
|
+
description: 'Name of the new access code.',
|
|
17201
|
+
type: 'string',
|
|
17202
|
+
},
|
|
17203
|
+
prefer_native_scheduling: {
|
|
17204
|
+
description: '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`.',
|
|
17205
|
+
type: 'boolean',
|
|
17206
|
+
},
|
|
17207
|
+
preferred_code_length: {
|
|
17208
|
+
description: '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.',
|
|
17209
|
+
format: 'float',
|
|
17210
|
+
type: 'number',
|
|
17211
|
+
},
|
|
17212
|
+
starts_at: {
|
|
17213
|
+
description: '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.',
|
|
17214
|
+
type: 'string',
|
|
17215
|
+
},
|
|
17216
|
+
sync: {
|
|
17217
|
+
default: false,
|
|
17218
|
+
type: 'boolean',
|
|
17219
|
+
'x-undocumented': 'Only used internally.',
|
|
17220
|
+
},
|
|
17221
|
+
type: {
|
|
17222
|
+
description: 'Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).',
|
|
17223
|
+
enum: ['ongoing', 'time_bound'],
|
|
17224
|
+
type: 'string',
|
|
17225
|
+
},
|
|
17226
|
+
use_backup_access_code_pool: {
|
|
17227
|
+
description: '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-clients/access_codes/pull_backup_access_code).',
|
|
17228
|
+
type: 'boolean',
|
|
17229
|
+
},
|
|
16161
17230
|
use_offline_access_code: { type: 'boolean' },
|
|
16162
17231
|
},
|
|
16163
17232
|
required: ['access_code_id'],
|
|
@@ -16199,44 +17268,98 @@ export default {
|
|
|
16199
17268
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
16200
17269
|
'x-fern-sdk-method-name': 'update',
|
|
16201
17270
|
'x-response-key': null,
|
|
17271
|
+
'x-title': 'Update an Access Code',
|
|
16202
17272
|
},
|
|
16203
17273
|
put: {
|
|
17274
|
+
description: 'Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).',
|
|
16204
17275
|
operationId: 'accessCodesUpdatePut',
|
|
16205
17276
|
requestBody: {
|
|
16206
17277
|
content: {
|
|
16207
17278
|
'application/json': {
|
|
16208
17279
|
schema: {
|
|
16209
17280
|
properties: {
|
|
16210
|
-
access_code_id: {
|
|
16211
|
-
|
|
17281
|
+
access_code_id: {
|
|
17282
|
+
description: 'ID of the access code that you want to update.',
|
|
17283
|
+
format: 'uuid',
|
|
17284
|
+
type: 'string',
|
|
17285
|
+
},
|
|
17286
|
+
allow_external_modification: {
|
|
17287
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17288
|
+
type: 'boolean',
|
|
17289
|
+
},
|
|
16212
17290
|
attempt_for_offline_device: {
|
|
16213
17291
|
default: true,
|
|
16214
17292
|
type: 'boolean',
|
|
16215
17293
|
},
|
|
16216
17294
|
code: {
|
|
17295
|
+
description: 'Code to be used for access.',
|
|
16217
17296
|
maxLength: 9,
|
|
16218
17297
|
minLength: 4,
|
|
16219
17298
|
pattern: '^\\d+$',
|
|
16220
17299
|
type: 'string',
|
|
16221
17300
|
},
|
|
16222
|
-
device_id: {
|
|
16223
|
-
|
|
16224
|
-
|
|
16225
|
-
|
|
16226
|
-
|
|
16227
|
-
|
|
17301
|
+
device_id: {
|
|
17302
|
+
description: 'ID of the device containing the access code that you want to update.',
|
|
17303
|
+
format: 'uuid',
|
|
17304
|
+
type: 'string',
|
|
17305
|
+
},
|
|
17306
|
+
ends_at: {
|
|
17307
|
+
description: '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`.',
|
|
17308
|
+
type: 'string',
|
|
17309
|
+
},
|
|
17310
|
+
is_external_modification_allowed: {
|
|
17311
|
+
description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17312
|
+
type: 'boolean',
|
|
17313
|
+
},
|
|
17314
|
+
is_managed: {
|
|
17315
|
+
description: 'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
|
|
17316
|
+
type: 'boolean',
|
|
17317
|
+
},
|
|
17318
|
+
is_offline_access_code: {
|
|
17319
|
+
description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17320
|
+
type: 'boolean',
|
|
17321
|
+
},
|
|
17322
|
+
is_one_time_use: {
|
|
17323
|
+
description: '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.',
|
|
17324
|
+
type: 'boolean',
|
|
17325
|
+
},
|
|
16228
17326
|
max_time_rounding: {
|
|
16229
17327
|
default: '1hour',
|
|
17328
|
+
description: '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`.',
|
|
16230
17329
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16231
17330
|
type: 'string',
|
|
16232
17331
|
},
|
|
16233
|
-
name: {
|
|
16234
|
-
|
|
16235
|
-
|
|
16236
|
-
|
|
16237
|
-
|
|
16238
|
-
|
|
16239
|
-
|
|
17332
|
+
name: {
|
|
17333
|
+
description: 'Name of the new access code.',
|
|
17334
|
+
type: 'string',
|
|
17335
|
+
},
|
|
17336
|
+
prefer_native_scheduling: {
|
|
17337
|
+
description: '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`.',
|
|
17338
|
+
type: 'boolean',
|
|
17339
|
+
},
|
|
17340
|
+
preferred_code_length: {
|
|
17341
|
+
description: '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.',
|
|
17342
|
+
format: 'float',
|
|
17343
|
+
type: 'number',
|
|
17344
|
+
},
|
|
17345
|
+
starts_at: {
|
|
17346
|
+
description: '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.',
|
|
17347
|
+
type: 'string',
|
|
17348
|
+
},
|
|
17349
|
+
sync: {
|
|
17350
|
+
default: false,
|
|
17351
|
+
type: 'boolean',
|
|
17352
|
+
'x-undocumented': 'Only used internally.',
|
|
17353
|
+
},
|
|
17354
|
+
type: {
|
|
17355
|
+
description: 'Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).',
|
|
17356
|
+
enum: ['ongoing', 'time_bound'],
|
|
17357
|
+
type: 'string',
|
|
17358
|
+
},
|
|
17359
|
+
use_backup_access_code_pool: {
|
|
17360
|
+
description: '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-clients/access_codes/pull_backup_access_code).',
|
|
17361
|
+
type: 'boolean',
|
|
17362
|
+
},
|
|
16240
17363
|
use_offline_access_code: { type: 'boolean' },
|
|
16241
17364
|
},
|
|
16242
17365
|
required: ['access_code_id'],
|
|
@@ -16277,20 +17400,34 @@ export default {
|
|
|
16277
17400
|
'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
|
|
16278
17401
|
'x-fern-ignore': true,
|
|
16279
17402
|
'x-response-key': null,
|
|
17403
|
+
'x-title': 'Update an Access Code',
|
|
16280
17404
|
},
|
|
16281
17405
|
},
|
|
16282
17406
|
'/access_codes/update_multiple': {
|
|
16283
17407
|
patch: {
|
|
17408
|
+
description: 'Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).',
|
|
16284
17409
|
operationId: 'accessCodesUpdateMultiplePatch',
|
|
16285
17410
|
requestBody: {
|
|
16286
17411
|
content: {
|
|
16287
17412
|
'application/json': {
|
|
16288
17413
|
schema: {
|
|
16289
17414
|
properties: {
|
|
16290
|
-
common_code_key: {
|
|
16291
|
-
|
|
16292
|
-
|
|
16293
|
-
|
|
17415
|
+
common_code_key: {
|
|
17416
|
+
description: 'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
|
|
17417
|
+
type: 'string',
|
|
17418
|
+
},
|
|
17419
|
+
ends_at: {
|
|
17420
|
+
description: '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`.',
|
|
17421
|
+
type: 'string',
|
|
17422
|
+
},
|
|
17423
|
+
name: {
|
|
17424
|
+
description: 'Name of the new access code.',
|
|
17425
|
+
type: 'string',
|
|
17426
|
+
},
|
|
17427
|
+
starts_at: {
|
|
17428
|
+
description: '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.',
|
|
17429
|
+
type: 'string',
|
|
17430
|
+
},
|
|
16294
17431
|
},
|
|
16295
17432
|
required: ['common_code_key'],
|
|
16296
17433
|
type: 'object',
|
|
@@ -16324,18 +17461,32 @@ export default {
|
|
|
16324
17461
|
tags: ['/access_codes'],
|
|
16325
17462
|
'x-fern-ignore': true,
|
|
16326
17463
|
'x-response-key': null,
|
|
17464
|
+
'x-title': 'Update Multiple Linked Access Codes',
|
|
16327
17465
|
},
|
|
16328
17466
|
post: {
|
|
17467
|
+
description: 'Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).',
|
|
16329
17468
|
operationId: 'accessCodesUpdateMultiplePost',
|
|
16330
17469
|
requestBody: {
|
|
16331
17470
|
content: {
|
|
16332
17471
|
'application/json': {
|
|
16333
17472
|
schema: {
|
|
16334
17473
|
properties: {
|
|
16335
|
-
common_code_key: {
|
|
16336
|
-
|
|
16337
|
-
|
|
16338
|
-
|
|
17474
|
+
common_code_key: {
|
|
17475
|
+
description: 'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
|
|
17476
|
+
type: 'string',
|
|
17477
|
+
},
|
|
17478
|
+
ends_at: {
|
|
17479
|
+
description: '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`.',
|
|
17480
|
+
type: 'string',
|
|
17481
|
+
},
|
|
17482
|
+
name: {
|
|
17483
|
+
description: 'Name of the new access code.',
|
|
17484
|
+
type: 'string',
|
|
17485
|
+
},
|
|
17486
|
+
starts_at: {
|
|
17487
|
+
description: '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.',
|
|
17488
|
+
type: 'string',
|
|
17489
|
+
},
|
|
16339
17490
|
},
|
|
16340
17491
|
required: ['common_code_key'],
|
|
16341
17492
|
type: 'object',
|
|
@@ -16370,6 +17521,7 @@ export default {
|
|
|
16370
17521
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
16371
17522
|
'x-fern-sdk-method-name': 'update_multiple',
|
|
16372
17523
|
'x-response-key': null,
|
|
17524
|
+
'x-title': 'Update Multiple Linked Access Codes',
|
|
16373
17525
|
},
|
|
16374
17526
|
},
|
|
16375
17527
|
'/acs/access_groups/add_user': {
|