@seamapi/types 1.376.0 → 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 +1579 -385
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1527 -355
- 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/openapi.d.ts +201 -2
- package/lib/seam/connect/openapi.js +1508 -338
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1036 -63
- 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/openapi.ts +1850 -350
- package/src/lib/seam/connect/route-types.ts +1036 -63
|
@@ -2,6 +2,8 @@ export default {
|
|
|
2
2
|
components: {
|
|
3
3
|
schemas: {
|
|
4
4
|
access_code: {
|
|
5
|
+
description:
|
|
6
|
+
'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
7
|
properties: {
|
|
6
8
|
access_code_id: {
|
|
7
9
|
description: 'Unique identifier for the access code.',
|
|
@@ -40,22 +42,36 @@ export default {
|
|
|
40
42
|
},
|
|
41
43
|
errors: {
|
|
42
44
|
description:
|
|
43
|
-
'
|
|
45
|
+
'Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
44
46
|
items: {
|
|
45
47
|
discriminator: { propertyName: 'error_code' },
|
|
46
48
|
oneOf: [
|
|
47
49
|
{
|
|
48
|
-
description: 'Failed to set code on
|
|
50
|
+
description: 'Failed to set code on SmartThings device.',
|
|
49
51
|
properties: {
|
|
50
|
-
created_at: {
|
|
52
|
+
created_at: {
|
|
53
|
+
description:
|
|
54
|
+
'Date and time at which Seam created the error.',
|
|
55
|
+
format: 'date-time',
|
|
56
|
+
type: 'string',
|
|
57
|
+
},
|
|
51
58
|
error_code: {
|
|
52
59
|
description:
|
|
53
60
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
54
61
|
enum: ['smartthings_failed_to_set_access_code'],
|
|
55
62
|
type: 'string',
|
|
56
63
|
},
|
|
57
|
-
is_access_code_error: {
|
|
58
|
-
|
|
64
|
+
is_access_code_error: {
|
|
65
|
+
description:
|
|
66
|
+
'Indicates that this is an access code error.',
|
|
67
|
+
enum: [true],
|
|
68
|
+
type: 'boolean',
|
|
69
|
+
},
|
|
70
|
+
message: {
|
|
71
|
+
description:
|
|
72
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
73
|
+
type: 'string',
|
|
74
|
+
},
|
|
59
75
|
},
|
|
60
76
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
61
77
|
type: 'object',
|
|
@@ -63,7 +79,12 @@ export default {
|
|
|
63
79
|
{
|
|
64
80
|
description: 'Failed to set code after multiple retries.',
|
|
65
81
|
properties: {
|
|
66
|
-
created_at: {
|
|
82
|
+
created_at: {
|
|
83
|
+
description:
|
|
84
|
+
'Date and time at which Seam created the error.',
|
|
85
|
+
format: 'date-time',
|
|
86
|
+
type: 'string',
|
|
87
|
+
},
|
|
67
88
|
error_code: {
|
|
68
89
|
description:
|
|
69
90
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -72,8 +93,17 @@ export default {
|
|
|
72
93
|
],
|
|
73
94
|
type: 'string',
|
|
74
95
|
},
|
|
75
|
-
is_access_code_error: {
|
|
76
|
-
|
|
96
|
+
is_access_code_error: {
|
|
97
|
+
description:
|
|
98
|
+
'Indicates that this is an access code error.',
|
|
99
|
+
enum: [true],
|
|
100
|
+
type: 'boolean',
|
|
101
|
+
},
|
|
102
|
+
message: {
|
|
103
|
+
description:
|
|
104
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
105
|
+
type: 'string',
|
|
106
|
+
},
|
|
77
107
|
},
|
|
78
108
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
79
109
|
type: 'object',
|
|
@@ -81,15 +111,29 @@ export default {
|
|
|
81
111
|
{
|
|
82
112
|
description: 'No free slots available on the device.',
|
|
83
113
|
properties: {
|
|
84
|
-
created_at: {
|
|
114
|
+
created_at: {
|
|
115
|
+
description:
|
|
116
|
+
'Date and time at which Seam created the error.',
|
|
117
|
+
format: 'date-time',
|
|
118
|
+
type: 'string',
|
|
119
|
+
},
|
|
85
120
|
error_code: {
|
|
86
121
|
description:
|
|
87
122
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
88
123
|
enum: ['smartthings_no_free_slots_available'],
|
|
89
124
|
type: 'string',
|
|
90
125
|
},
|
|
91
|
-
is_access_code_error: {
|
|
92
|
-
|
|
126
|
+
is_access_code_error: {
|
|
127
|
+
description:
|
|
128
|
+
'Indicates that this is an access code error.',
|
|
129
|
+
enum: [true],
|
|
130
|
+
type: 'boolean',
|
|
131
|
+
},
|
|
132
|
+
message: {
|
|
133
|
+
description:
|
|
134
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
135
|
+
type: 'string',
|
|
136
|
+
},
|
|
93
137
|
},
|
|
94
138
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
95
139
|
type: 'object',
|
|
@@ -97,15 +141,29 @@ export default {
|
|
|
97
141
|
{
|
|
98
142
|
description: 'Failed to set code on device.',
|
|
99
143
|
properties: {
|
|
100
|
-
created_at: {
|
|
144
|
+
created_at: {
|
|
145
|
+
description:
|
|
146
|
+
'Date and time at which Seam created the error.',
|
|
147
|
+
format: 'date-time',
|
|
148
|
+
type: 'string',
|
|
149
|
+
},
|
|
101
150
|
error_code: {
|
|
102
151
|
description:
|
|
103
152
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
104
153
|
enum: ['failed_to_set_on_device'],
|
|
105
154
|
type: 'string',
|
|
106
155
|
},
|
|
107
|
-
is_access_code_error: {
|
|
108
|
-
|
|
156
|
+
is_access_code_error: {
|
|
157
|
+
description:
|
|
158
|
+
'Indicates that this is an access code error.',
|
|
159
|
+
enum: [true],
|
|
160
|
+
type: 'boolean',
|
|
161
|
+
},
|
|
162
|
+
message: {
|
|
163
|
+
description:
|
|
164
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
165
|
+
type: 'string',
|
|
166
|
+
},
|
|
109
167
|
},
|
|
110
168
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
111
169
|
type: 'object',
|
|
@@ -113,15 +171,29 @@ export default {
|
|
|
113
171
|
{
|
|
114
172
|
description: 'Failed to remove code from device.',
|
|
115
173
|
properties: {
|
|
116
|
-
created_at: {
|
|
174
|
+
created_at: {
|
|
175
|
+
description:
|
|
176
|
+
'Date and time at which Seam created the error.',
|
|
177
|
+
format: 'date-time',
|
|
178
|
+
type: 'string',
|
|
179
|
+
},
|
|
117
180
|
error_code: {
|
|
118
181
|
description:
|
|
119
182
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
120
183
|
enum: ['failed_to_remove_from_device'],
|
|
121
184
|
type: 'string',
|
|
122
185
|
},
|
|
123
|
-
is_access_code_error: {
|
|
124
|
-
|
|
186
|
+
is_access_code_error: {
|
|
187
|
+
description:
|
|
188
|
+
'Indicates that this is an access code error.',
|
|
189
|
+
enum: [true],
|
|
190
|
+
type: 'boolean',
|
|
191
|
+
},
|
|
192
|
+
message: {
|
|
193
|
+
description:
|
|
194
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
195
|
+
type: 'string',
|
|
196
|
+
},
|
|
125
197
|
},
|
|
126
198
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
127
199
|
type: 'object',
|
|
@@ -129,15 +201,29 @@ export default {
|
|
|
129
201
|
{
|
|
130
202
|
description: 'Duplicate access code detected on device.',
|
|
131
203
|
properties: {
|
|
132
|
-
created_at: {
|
|
204
|
+
created_at: {
|
|
205
|
+
description:
|
|
206
|
+
'Date and time at which Seam created the error.',
|
|
207
|
+
format: 'date-time',
|
|
208
|
+
type: 'string',
|
|
209
|
+
},
|
|
133
210
|
error_code: {
|
|
134
211
|
description:
|
|
135
212
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
136
213
|
enum: ['duplicate_code_on_device'],
|
|
137
214
|
type: 'string',
|
|
138
215
|
},
|
|
139
|
-
is_access_code_error: {
|
|
140
|
-
|
|
216
|
+
is_access_code_error: {
|
|
217
|
+
description:
|
|
218
|
+
'Indicates that this is an access code error.',
|
|
219
|
+
enum: [true],
|
|
220
|
+
type: 'boolean',
|
|
221
|
+
},
|
|
222
|
+
message: {
|
|
223
|
+
description:
|
|
224
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
225
|
+
type: 'string',
|
|
226
|
+
},
|
|
141
227
|
},
|
|
142
228
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
143
229
|
type: 'object',
|
|
@@ -146,15 +232,29 @@ export default {
|
|
|
146
232
|
description:
|
|
147
233
|
'An attempt to modify this access code was prevented.',
|
|
148
234
|
properties: {
|
|
149
|
-
created_at: {
|
|
235
|
+
created_at: {
|
|
236
|
+
description:
|
|
237
|
+
'Date and time at which Seam created the error.',
|
|
238
|
+
format: 'date-time',
|
|
239
|
+
type: 'string',
|
|
240
|
+
},
|
|
150
241
|
error_code: {
|
|
151
242
|
description:
|
|
152
243
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
153
244
|
enum: ['duplicate_code_attempt_prevented'],
|
|
154
245
|
type: 'string',
|
|
155
246
|
},
|
|
156
|
-
is_access_code_error: {
|
|
157
|
-
|
|
247
|
+
is_access_code_error: {
|
|
248
|
+
description:
|
|
249
|
+
'Indicates that this is an access code error.',
|
|
250
|
+
enum: [true],
|
|
251
|
+
type: 'boolean',
|
|
252
|
+
},
|
|
253
|
+
message: {
|
|
254
|
+
description:
|
|
255
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
256
|
+
type: 'string',
|
|
257
|
+
},
|
|
158
258
|
},
|
|
159
259
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
160
260
|
type: 'object',
|
|
@@ -163,15 +263,29 @@ export default {
|
|
|
163
263
|
description:
|
|
164
264
|
'Igloohome bridge has too many pending jobs in the queue.',
|
|
165
265
|
properties: {
|
|
166
|
-
created_at: {
|
|
266
|
+
created_at: {
|
|
267
|
+
description:
|
|
268
|
+
'Date and time at which Seam created the error.',
|
|
269
|
+
format: 'date-time',
|
|
270
|
+
type: 'string',
|
|
271
|
+
},
|
|
167
272
|
error_code: {
|
|
168
273
|
description:
|
|
169
274
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
170
275
|
enum: ['igloohome_bridge_too_many_pending_jobs'],
|
|
171
276
|
type: 'string',
|
|
172
277
|
},
|
|
173
|
-
is_access_code_error: {
|
|
174
|
-
|
|
278
|
+
is_access_code_error: {
|
|
279
|
+
description:
|
|
280
|
+
'Indicates that this is an access code error.',
|
|
281
|
+
enum: [true],
|
|
282
|
+
type: 'boolean',
|
|
283
|
+
},
|
|
284
|
+
message: {
|
|
285
|
+
description:
|
|
286
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
287
|
+
type: 'string',
|
|
288
|
+
},
|
|
175
289
|
},
|
|
176
290
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
177
291
|
type: 'object',
|
|
@@ -179,23 +293,42 @@ export default {
|
|
|
179
293
|
{
|
|
180
294
|
description: 'Igloohome bridge is offline.',
|
|
181
295
|
properties: {
|
|
182
|
-
created_at: {
|
|
296
|
+
created_at: {
|
|
297
|
+
description:
|
|
298
|
+
'Date and time at which Seam created the error.',
|
|
299
|
+
format: 'date-time',
|
|
300
|
+
type: 'string',
|
|
301
|
+
},
|
|
183
302
|
error_code: {
|
|
184
303
|
description:
|
|
185
304
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
186
305
|
enum: ['igloohome_bridge_offline'],
|
|
187
306
|
type: 'string',
|
|
188
307
|
},
|
|
189
|
-
is_access_code_error: {
|
|
190
|
-
|
|
308
|
+
is_access_code_error: {
|
|
309
|
+
description:
|
|
310
|
+
'Indicates that this is an access code error.',
|
|
311
|
+
enum: [true],
|
|
312
|
+
type: 'boolean',
|
|
313
|
+
},
|
|
314
|
+
message: {
|
|
315
|
+
description:
|
|
316
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
317
|
+
type: 'string',
|
|
318
|
+
},
|
|
191
319
|
},
|
|
192
320
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
193
321
|
type: 'object',
|
|
194
322
|
},
|
|
195
323
|
{
|
|
196
|
-
description: 'Lock
|
|
324
|
+
description: 'Lock has reached maximum amount of codes.',
|
|
197
325
|
properties: {
|
|
198
|
-
created_at: {
|
|
326
|
+
created_at: {
|
|
327
|
+
description:
|
|
328
|
+
'Date and time at which Seam created the error.',
|
|
329
|
+
format: 'date-time',
|
|
330
|
+
type: 'string',
|
|
331
|
+
},
|
|
199
332
|
error_code: {
|
|
200
333
|
description:
|
|
201
334
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -204,25 +337,48 @@ export default {
|
|
|
204
337
|
],
|
|
205
338
|
type: 'string',
|
|
206
339
|
},
|
|
207
|
-
is_access_code_error: {
|
|
208
|
-
|
|
340
|
+
is_access_code_error: {
|
|
341
|
+
description:
|
|
342
|
+
'Indicates that this is an access code error.',
|
|
343
|
+
enum: [true],
|
|
344
|
+
type: 'boolean',
|
|
345
|
+
},
|
|
346
|
+
message: {
|
|
347
|
+
description:
|
|
348
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
349
|
+
type: 'string',
|
|
350
|
+
},
|
|
209
351
|
},
|
|
210
352
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
211
353
|
type: 'object',
|
|
212
354
|
},
|
|
213
355
|
{
|
|
214
356
|
description:
|
|
215
|
-
'Unable to confirm the access code is set on Kwikset device.',
|
|
357
|
+
'Unable to confirm that the access code is set on Kwikset device.',
|
|
216
358
|
properties: {
|
|
217
|
-
created_at: {
|
|
359
|
+
created_at: {
|
|
360
|
+
description:
|
|
361
|
+
'Date and time at which Seam created the error.',
|
|
362
|
+
format: 'date-time',
|
|
363
|
+
type: 'string',
|
|
364
|
+
},
|
|
218
365
|
error_code: {
|
|
219
366
|
description:
|
|
220
367
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
221
368
|
enum: ['kwikset_unable_to_confirm_code'],
|
|
222
369
|
type: 'string',
|
|
223
370
|
},
|
|
224
|
-
is_access_code_error: {
|
|
225
|
-
|
|
371
|
+
is_access_code_error: {
|
|
372
|
+
description:
|
|
373
|
+
'Indicates that this is an access code error.',
|
|
374
|
+
enum: [true],
|
|
375
|
+
type: 'boolean',
|
|
376
|
+
},
|
|
377
|
+
message: {
|
|
378
|
+
description:
|
|
379
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
380
|
+
type: 'string',
|
|
381
|
+
},
|
|
226
382
|
},
|
|
227
383
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
228
384
|
type: 'object',
|
|
@@ -231,15 +387,29 @@ export default {
|
|
|
231
387
|
description:
|
|
232
388
|
'Unable to confirm the deletion of the access code on Kwikset device.',
|
|
233
389
|
properties: {
|
|
234
|
-
created_at: {
|
|
390
|
+
created_at: {
|
|
391
|
+
description:
|
|
392
|
+
'Date and time at which Seam created the error.',
|
|
393
|
+
format: 'date-time',
|
|
394
|
+
type: 'string',
|
|
395
|
+
},
|
|
235
396
|
error_code: {
|
|
236
397
|
description:
|
|
237
398
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
238
399
|
enum: ['kwikset_unable_to_confirm_deletion'],
|
|
239
400
|
type: 'string',
|
|
240
401
|
},
|
|
241
|
-
is_access_code_error: {
|
|
242
|
-
|
|
402
|
+
is_access_code_error: {
|
|
403
|
+
description:
|
|
404
|
+
'Indicates that this is an access code error.',
|
|
405
|
+
enum: [true],
|
|
406
|
+
type: 'boolean',
|
|
407
|
+
},
|
|
408
|
+
message: {
|
|
409
|
+
description:
|
|
410
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
411
|
+
type: 'string',
|
|
412
|
+
},
|
|
243
413
|
},
|
|
244
414
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
245
415
|
type: 'object',
|
|
@@ -248,15 +418,29 @@ export default {
|
|
|
248
418
|
description:
|
|
249
419
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
250
420
|
properties: {
|
|
251
|
-
created_at: {
|
|
421
|
+
created_at: {
|
|
422
|
+
description:
|
|
423
|
+
'Date and time at which Seam created the error.',
|
|
424
|
+
format: 'date-time',
|
|
425
|
+
type: 'string',
|
|
426
|
+
},
|
|
252
427
|
error_code: {
|
|
253
428
|
description:
|
|
254
429
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
255
430
|
enum: ['code_modified_external_to_seam'],
|
|
256
431
|
type: 'string',
|
|
257
432
|
},
|
|
258
|
-
is_access_code_error: {
|
|
259
|
-
|
|
433
|
+
is_access_code_error: {
|
|
434
|
+
description:
|
|
435
|
+
'Indicates that this is an access code error.',
|
|
436
|
+
enum: [true],
|
|
437
|
+
type: 'boolean',
|
|
438
|
+
},
|
|
439
|
+
message: {
|
|
440
|
+
description:
|
|
441
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
442
|
+
type: 'string',
|
|
443
|
+
},
|
|
260
444
|
},
|
|
261
445
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
262
446
|
type: 'object',
|
|
@@ -264,15 +448,29 @@ export default {
|
|
|
264
448
|
{
|
|
265
449
|
description: 'Invalid code length for August lock.',
|
|
266
450
|
properties: {
|
|
267
|
-
created_at: {
|
|
451
|
+
created_at: {
|
|
452
|
+
description:
|
|
453
|
+
'Date and time at which Seam created the error.',
|
|
454
|
+
format: 'date-time',
|
|
455
|
+
type: 'string',
|
|
456
|
+
},
|
|
268
457
|
error_code: {
|
|
269
458
|
description:
|
|
270
459
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
271
460
|
enum: ['august_lock_invalid_code_length'],
|
|
272
461
|
type: 'string',
|
|
273
462
|
},
|
|
274
|
-
is_access_code_error: {
|
|
275
|
-
|
|
463
|
+
is_access_code_error: {
|
|
464
|
+
description:
|
|
465
|
+
'Indicates that this is an access code error.',
|
|
466
|
+
enum: [true],
|
|
467
|
+
type: 'boolean',
|
|
468
|
+
},
|
|
469
|
+
message: {
|
|
470
|
+
description:
|
|
471
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
472
|
+
type: 'string',
|
|
473
|
+
},
|
|
276
474
|
},
|
|
277
475
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
278
476
|
type: 'object',
|
|
@@ -281,15 +479,29 @@ export default {
|
|
|
281
479
|
description:
|
|
282
480
|
'Access code has not yet been fully moved to the device.',
|
|
283
481
|
properties: {
|
|
284
|
-
created_at: {
|
|
482
|
+
created_at: {
|
|
483
|
+
description:
|
|
484
|
+
'Date and time at which Seam created the error.',
|
|
485
|
+
format: 'date-time',
|
|
486
|
+
type: 'string',
|
|
487
|
+
},
|
|
285
488
|
error_code: {
|
|
286
489
|
description:
|
|
287
490
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
288
491
|
enum: ['august_device_programming_delay'],
|
|
289
492
|
type: 'string',
|
|
290
493
|
},
|
|
291
|
-
is_access_code_error: {
|
|
292
|
-
|
|
494
|
+
is_access_code_error: {
|
|
495
|
+
description:
|
|
496
|
+
'Indicates that this is an access code error.',
|
|
497
|
+
enum: [true],
|
|
498
|
+
type: 'boolean',
|
|
499
|
+
},
|
|
500
|
+
message: {
|
|
501
|
+
description:
|
|
502
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
503
|
+
type: 'string',
|
|
504
|
+
},
|
|
293
505
|
},
|
|
294
506
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
295
507
|
type: 'object',
|
|
@@ -297,15 +509,29 @@ export default {
|
|
|
297
509
|
{
|
|
298
510
|
description: 'All access code slots on the device are full.',
|
|
299
511
|
properties: {
|
|
300
|
-
created_at: {
|
|
512
|
+
created_at: {
|
|
513
|
+
description:
|
|
514
|
+
'Date and time at which Seam created the error.',
|
|
515
|
+
format: 'date-time',
|
|
516
|
+
type: 'string',
|
|
517
|
+
},
|
|
301
518
|
error_code: {
|
|
302
519
|
description:
|
|
303
520
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
304
521
|
enum: ['august_device_slots_full'],
|
|
305
522
|
type: 'string',
|
|
306
523
|
},
|
|
307
|
-
is_access_code_error: {
|
|
308
|
-
|
|
524
|
+
is_access_code_error: {
|
|
525
|
+
description:
|
|
526
|
+
'Indicates that this is an access code error.',
|
|
527
|
+
enum: [true],
|
|
528
|
+
type: 'boolean',
|
|
529
|
+
},
|
|
530
|
+
message: {
|
|
531
|
+
description:
|
|
532
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
533
|
+
type: 'string',
|
|
534
|
+
},
|
|
309
535
|
},
|
|
310
536
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
311
537
|
type: 'object',
|
|
@@ -313,15 +539,29 @@ export default {
|
|
|
313
539
|
{
|
|
314
540
|
description: 'August lock is missing a keypad.',
|
|
315
541
|
properties: {
|
|
316
|
-
created_at: {
|
|
542
|
+
created_at: {
|
|
543
|
+
description:
|
|
544
|
+
'Date and time at which Seam created the error.',
|
|
545
|
+
format: 'date-time',
|
|
546
|
+
type: 'string',
|
|
547
|
+
},
|
|
317
548
|
error_code: {
|
|
318
549
|
description:
|
|
319
550
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
320
551
|
enum: ['august_lock_missing_keypad'],
|
|
321
552
|
type: 'string',
|
|
322
553
|
},
|
|
323
|
-
is_access_code_error: {
|
|
324
|
-
|
|
554
|
+
is_access_code_error: {
|
|
555
|
+
description:
|
|
556
|
+
'Indicates that this is an access code error.',
|
|
557
|
+
enum: [true],
|
|
558
|
+
type: 'boolean',
|
|
559
|
+
},
|
|
560
|
+
message: {
|
|
561
|
+
description:
|
|
562
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
563
|
+
type: 'string',
|
|
564
|
+
},
|
|
325
565
|
},
|
|
326
566
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
327
567
|
type: 'object',
|
|
@@ -329,15 +569,29 @@ export default {
|
|
|
329
569
|
{
|
|
330
570
|
description: 'August lock is temporarily offline.',
|
|
331
571
|
properties: {
|
|
332
|
-
created_at: {
|
|
572
|
+
created_at: {
|
|
573
|
+
description:
|
|
574
|
+
'Date and time at which Seam created the error.',
|
|
575
|
+
format: 'date-time',
|
|
576
|
+
type: 'string',
|
|
577
|
+
},
|
|
333
578
|
error_code: {
|
|
334
579
|
description:
|
|
335
580
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
336
581
|
enum: ['august_lock_temporarily_offline'],
|
|
337
582
|
type: 'string',
|
|
338
583
|
},
|
|
339
|
-
is_access_code_error: {
|
|
340
|
-
|
|
584
|
+
is_access_code_error: {
|
|
585
|
+
description:
|
|
586
|
+
'Indicates that this is an access code error.',
|
|
587
|
+
enum: [true],
|
|
588
|
+
type: 'boolean',
|
|
589
|
+
},
|
|
590
|
+
message: {
|
|
591
|
+
description:
|
|
592
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
593
|
+
type: 'string',
|
|
594
|
+
},
|
|
341
595
|
},
|
|
342
596
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
343
597
|
type: 'object',
|
|
@@ -345,15 +599,29 @@ export default {
|
|
|
345
599
|
{
|
|
346
600
|
description: 'Salto site user is not subscribed.',
|
|
347
601
|
properties: {
|
|
348
|
-
created_at: {
|
|
602
|
+
created_at: {
|
|
603
|
+
description:
|
|
604
|
+
'Date and time at which Seam created the error.',
|
|
605
|
+
format: 'date-time',
|
|
606
|
+
type: 'string',
|
|
607
|
+
},
|
|
349
608
|
error_code: {
|
|
350
609
|
description:
|
|
351
610
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
352
611
|
enum: ['salto_ks_user_not_subscribed'],
|
|
353
612
|
type: 'string',
|
|
354
613
|
},
|
|
355
|
-
is_access_code_error: {
|
|
356
|
-
|
|
614
|
+
is_access_code_error: {
|
|
615
|
+
description:
|
|
616
|
+
'Indicates that this is an access code error.',
|
|
617
|
+
enum: [true],
|
|
618
|
+
type: 'boolean',
|
|
619
|
+
},
|
|
620
|
+
message: {
|
|
621
|
+
description:
|
|
622
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
623
|
+
type: 'string',
|
|
624
|
+
},
|
|
357
625
|
},
|
|
358
626
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
359
627
|
type: 'object',
|
|
@@ -362,15 +630,29 @@ export default {
|
|
|
362
630
|
description:
|
|
363
631
|
'Access code has not yet been fully moved to the device.',
|
|
364
632
|
properties: {
|
|
365
|
-
created_at: {
|
|
633
|
+
created_at: {
|
|
634
|
+
description:
|
|
635
|
+
'Date and time at which Seam created the error.',
|
|
636
|
+
format: 'date-time',
|
|
637
|
+
type: 'string',
|
|
638
|
+
},
|
|
366
639
|
error_code: {
|
|
367
640
|
description:
|
|
368
641
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
369
642
|
enum: ['hubitat_device_programming_delay'],
|
|
370
643
|
type: 'string',
|
|
371
644
|
},
|
|
372
|
-
is_access_code_error: {
|
|
373
|
-
|
|
645
|
+
is_access_code_error: {
|
|
646
|
+
description:
|
|
647
|
+
'Indicates that this is an access code error.',
|
|
648
|
+
enum: [true],
|
|
649
|
+
type: 'boolean',
|
|
650
|
+
},
|
|
651
|
+
message: {
|
|
652
|
+
description:
|
|
653
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
654
|
+
type: 'string',
|
|
655
|
+
},
|
|
374
656
|
},
|
|
375
657
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
376
658
|
type: 'object',
|
|
@@ -378,15 +660,29 @@ export default {
|
|
|
378
660
|
{
|
|
379
661
|
description: 'No free positions available on the device.',
|
|
380
662
|
properties: {
|
|
381
|
-
created_at: {
|
|
663
|
+
created_at: {
|
|
664
|
+
description:
|
|
665
|
+
'Date and time at which Seam created the error.',
|
|
666
|
+
format: 'date-time',
|
|
667
|
+
type: 'string',
|
|
668
|
+
},
|
|
382
669
|
error_code: {
|
|
383
670
|
description:
|
|
384
671
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
385
672
|
enum: ['hubitat_no_free_positions_available'],
|
|
386
673
|
type: 'string',
|
|
387
674
|
},
|
|
388
|
-
is_access_code_error: {
|
|
389
|
-
|
|
675
|
+
is_access_code_error: {
|
|
676
|
+
description:
|
|
677
|
+
'Indicates that this is an access code error.',
|
|
678
|
+
enum: [true],
|
|
679
|
+
type: 'boolean',
|
|
680
|
+
},
|
|
681
|
+
message: {
|
|
682
|
+
description:
|
|
683
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
684
|
+
type: 'string',
|
|
685
|
+
},
|
|
390
686
|
},
|
|
391
687
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
392
688
|
type: 'object',
|
|
@@ -394,15 +690,29 @@ export default {
|
|
|
394
690
|
{
|
|
395
691
|
description: 'Duplicate access code name detected.',
|
|
396
692
|
properties: {
|
|
397
|
-
created_at: {
|
|
693
|
+
created_at: {
|
|
694
|
+
description:
|
|
695
|
+
'Date and time at which Seam created the error.',
|
|
696
|
+
format: 'date-time',
|
|
697
|
+
type: 'string',
|
|
698
|
+
},
|
|
398
699
|
error_code: {
|
|
399
700
|
description:
|
|
400
701
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
401
702
|
enum: ['wyze_duplicate_code_name'],
|
|
402
703
|
type: 'string',
|
|
403
704
|
},
|
|
404
|
-
is_access_code_error: {
|
|
405
|
-
|
|
705
|
+
is_access_code_error: {
|
|
706
|
+
description:
|
|
707
|
+
'Indicates that this is an access code error.',
|
|
708
|
+
enum: [true],
|
|
709
|
+
type: 'boolean',
|
|
710
|
+
},
|
|
711
|
+
message: {
|
|
712
|
+
description:
|
|
713
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
714
|
+
type: 'string',
|
|
715
|
+
},
|
|
406
716
|
},
|
|
407
717
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
408
718
|
type: 'object',
|
|
@@ -410,15 +720,29 @@ export default {
|
|
|
410
720
|
{
|
|
411
721
|
description: 'Potential duplicate access code detected.',
|
|
412
722
|
properties: {
|
|
413
|
-
created_at: {
|
|
723
|
+
created_at: {
|
|
724
|
+
description:
|
|
725
|
+
'Date and time at which Seam created the error.',
|
|
726
|
+
format: 'date-time',
|
|
727
|
+
type: 'string',
|
|
728
|
+
},
|
|
414
729
|
error_code: {
|
|
415
730
|
description:
|
|
416
731
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
417
732
|
enum: ['wyze_potential_duplicate_code'],
|
|
418
733
|
type: 'string',
|
|
419
734
|
},
|
|
420
|
-
is_access_code_error: {
|
|
421
|
-
|
|
735
|
+
is_access_code_error: {
|
|
736
|
+
description:
|
|
737
|
+
'Indicates that this is an access code error.',
|
|
738
|
+
enum: [true],
|
|
739
|
+
type: 'boolean',
|
|
740
|
+
},
|
|
741
|
+
message: {
|
|
742
|
+
description:
|
|
743
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
744
|
+
type: 'string',
|
|
745
|
+
},
|
|
422
746
|
},
|
|
423
747
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
424
748
|
type: 'object',
|
|
@@ -426,15 +750,29 @@ export default {
|
|
|
426
750
|
{
|
|
427
751
|
description: 'No valid user level for Oracode.',
|
|
428
752
|
properties: {
|
|
429
|
-
created_at: {
|
|
753
|
+
created_at: {
|
|
754
|
+
description:
|
|
755
|
+
'Date and time at which Seam created the error.',
|
|
756
|
+
format: 'date-time',
|
|
757
|
+
type: 'string',
|
|
758
|
+
},
|
|
430
759
|
error_code: {
|
|
431
760
|
description:
|
|
432
761
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
433
762
|
enum: ['dormakaba_oracode_no_valid_user_level'],
|
|
434
763
|
type: 'string',
|
|
435
764
|
},
|
|
436
|
-
is_access_code_error: {
|
|
437
|
-
|
|
765
|
+
is_access_code_error: {
|
|
766
|
+
description:
|
|
767
|
+
'Indicates that this is an access code error.',
|
|
768
|
+
enum: [true],
|
|
769
|
+
type: 'boolean',
|
|
770
|
+
},
|
|
771
|
+
message: {
|
|
772
|
+
description:
|
|
773
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
774
|
+
type: 'string',
|
|
775
|
+
},
|
|
438
776
|
},
|
|
439
777
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
440
778
|
type: 'object',
|
|
@@ -792,12 +1130,12 @@ export default {
|
|
|
792
1130
|
},
|
|
793
1131
|
is_offline_access_code: {
|
|
794
1132
|
description:
|
|
795
|
-
'Indicates whether the access code is intended for use in offline scenarios. If
|
|
1133
|
+
'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.',
|
|
796
1134
|
type: 'boolean',
|
|
797
1135
|
},
|
|
798
1136
|
is_one_time_use: {
|
|
799
1137
|
description:
|
|
800
|
-
'Indicates whether the access code can only be used once. If
|
|
1138
|
+
'Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.',
|
|
801
1139
|
type: 'boolean',
|
|
802
1140
|
},
|
|
803
1141
|
is_scheduled_on_device: {
|
|
@@ -832,27 +1170,38 @@ export default {
|
|
|
832
1170
|
},
|
|
833
1171
|
status: {
|
|
834
1172
|
description:
|
|
835
|
-
'
|
|
1173
|
+
'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.',
|
|
836
1174
|
enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
|
|
837
1175
|
type: 'string',
|
|
838
1176
|
},
|
|
839
1177
|
type: {
|
|
840
1178
|
description:
|
|
841
|
-
'Nature of the access code. Values are
|
|
1179
|
+
'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.',
|
|
842
1180
|
enum: ['time_bound', 'ongoing'],
|
|
843
1181
|
type: 'string',
|
|
844
1182
|
},
|
|
845
1183
|
warnings: {
|
|
846
1184
|
description:
|
|
847
|
-
'
|
|
1185
|
+
'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
848
1186
|
items: {
|
|
1187
|
+
description:
|
|
1188
|
+
'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
849
1189
|
discriminator: { propertyName: 'warning_code' },
|
|
850
1190
|
oneOf: [
|
|
851
1191
|
{
|
|
852
|
-
description: 'Failed to set code on
|
|
1192
|
+
description: 'Failed to set code on SmartThings device.',
|
|
853
1193
|
properties: {
|
|
854
|
-
created_at: {
|
|
855
|
-
|
|
1194
|
+
created_at: {
|
|
1195
|
+
description:
|
|
1196
|
+
'Date and time at which Seam created the warning.',
|
|
1197
|
+
format: 'date-time',
|
|
1198
|
+
type: 'string',
|
|
1199
|
+
},
|
|
1200
|
+
message: {
|
|
1201
|
+
description:
|
|
1202
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1203
|
+
type: 'string',
|
|
1204
|
+
},
|
|
856
1205
|
warning_code: {
|
|
857
1206
|
description:
|
|
858
1207
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -866,8 +1215,17 @@ export default {
|
|
|
866
1215
|
{
|
|
867
1216
|
description: 'Duplicate access code detected.',
|
|
868
1217
|
properties: {
|
|
869
|
-
created_at: {
|
|
870
|
-
|
|
1218
|
+
created_at: {
|
|
1219
|
+
description:
|
|
1220
|
+
'Date and time at which Seam created the warning.',
|
|
1221
|
+
format: 'date-time',
|
|
1222
|
+
type: 'string',
|
|
1223
|
+
},
|
|
1224
|
+
message: {
|
|
1225
|
+
description:
|
|
1226
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1227
|
+
type: 'string',
|
|
1228
|
+
},
|
|
871
1229
|
warning_code: {
|
|
872
1230
|
description:
|
|
873
1231
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -882,8 +1240,17 @@ export default {
|
|
|
882
1240
|
description:
|
|
883
1241
|
'Received an error when attempting to create this code.',
|
|
884
1242
|
properties: {
|
|
885
|
-
created_at: {
|
|
886
|
-
|
|
1243
|
+
created_at: {
|
|
1244
|
+
description:
|
|
1245
|
+
'Date and time at which Seam created the warning.',
|
|
1246
|
+
format: 'date-time',
|
|
1247
|
+
type: 'string',
|
|
1248
|
+
},
|
|
1249
|
+
message: {
|
|
1250
|
+
description:
|
|
1251
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1252
|
+
type: 'string',
|
|
1253
|
+
},
|
|
887
1254
|
warning_code: {
|
|
888
1255
|
description:
|
|
889
1256
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -898,8 +1265,17 @@ export default {
|
|
|
898
1265
|
description:
|
|
899
1266
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
900
1267
|
properties: {
|
|
901
|
-
created_at: {
|
|
902
|
-
|
|
1268
|
+
created_at: {
|
|
1269
|
+
description:
|
|
1270
|
+
'Date and time at which Seam created the warning.',
|
|
1271
|
+
format: 'date-time',
|
|
1272
|
+
type: 'string',
|
|
1273
|
+
},
|
|
1274
|
+
message: {
|
|
1275
|
+
description:
|
|
1276
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1277
|
+
type: 'string',
|
|
1278
|
+
},
|
|
903
1279
|
warning_code: {
|
|
904
1280
|
description:
|
|
905
1281
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -913,8 +1289,17 @@ export default {
|
|
|
913
1289
|
{
|
|
914
1290
|
description: 'Delay in setting code on device.',
|
|
915
1291
|
properties: {
|
|
916
|
-
created_at: {
|
|
917
|
-
|
|
1292
|
+
created_at: {
|
|
1293
|
+
description:
|
|
1294
|
+
'Date and time at which Seam created the warning.',
|
|
1295
|
+
format: 'date-time',
|
|
1296
|
+
type: 'string',
|
|
1297
|
+
},
|
|
1298
|
+
message: {
|
|
1299
|
+
description:
|
|
1300
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1301
|
+
type: 'string',
|
|
1302
|
+
},
|
|
918
1303
|
warning_code: {
|
|
919
1304
|
description:
|
|
920
1305
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -928,8 +1313,17 @@ export default {
|
|
|
928
1313
|
{
|
|
929
1314
|
description: 'Delay in removing code from device.',
|
|
930
1315
|
properties: {
|
|
931
|
-
created_at: {
|
|
932
|
-
|
|
1316
|
+
created_at: {
|
|
1317
|
+
description:
|
|
1318
|
+
'Date and time at which Seam created the warning.',
|
|
1319
|
+
format: 'date-time',
|
|
1320
|
+
type: 'string',
|
|
1321
|
+
},
|
|
1322
|
+
message: {
|
|
1323
|
+
description:
|
|
1324
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1325
|
+
type: 'string',
|
|
1326
|
+
},
|
|
933
1327
|
warning_code: {
|
|
934
1328
|
description:
|
|
935
1329
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -942,10 +1336,19 @@ export default {
|
|
|
942
1336
|
},
|
|
943
1337
|
{
|
|
944
1338
|
description:
|
|
945
|
-
'Third
|
|
1339
|
+
'Third-party integration detected that may cause access codes to fail.',
|
|
946
1340
|
properties: {
|
|
947
|
-
created_at: {
|
|
948
|
-
|
|
1341
|
+
created_at: {
|
|
1342
|
+
description:
|
|
1343
|
+
'Date and time at which Seam created the warning.',
|
|
1344
|
+
format: 'date-time',
|
|
1345
|
+
type: 'string',
|
|
1346
|
+
},
|
|
1347
|
+
message: {
|
|
1348
|
+
description:
|
|
1349
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1350
|
+
type: 'string',
|
|
1351
|
+
},
|
|
949
1352
|
warning_code: {
|
|
950
1353
|
description:
|
|
951
1354
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -960,23 +1363,41 @@ export default {
|
|
|
960
1363
|
description:
|
|
961
1364
|
'Access code has not yet been fully moved to the device.',
|
|
962
1365
|
properties: {
|
|
963
|
-
created_at: {
|
|
964
|
-
message: { type: 'string' },
|
|
965
|
-
warning_code: {
|
|
1366
|
+
created_at: {
|
|
966
1367
|
description:
|
|
967
|
-
'
|
|
968
|
-
|
|
1368
|
+
'Date and time at which Seam created the warning.',
|
|
1369
|
+
format: 'date-time',
|
|
969
1370
|
type: 'string',
|
|
970
1371
|
},
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
1372
|
+
message: {
|
|
1373
|
+
description:
|
|
1374
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1375
|
+
type: 'string',
|
|
1376
|
+
},
|
|
1377
|
+
warning_code: {
|
|
1378
|
+
description:
|
|
1379
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1380
|
+
enum: ['august_device_programming_delay'],
|
|
1381
|
+
type: 'string',
|
|
1382
|
+
},
|
|
1383
|
+
},
|
|
1384
|
+
required: ['message', 'warning_code'],
|
|
1385
|
+
type: 'object',
|
|
974
1386
|
},
|
|
975
1387
|
{
|
|
976
1388
|
description: 'August lock is temporarily offline.',
|
|
977
1389
|
properties: {
|
|
978
|
-
created_at: {
|
|
979
|
-
|
|
1390
|
+
created_at: {
|
|
1391
|
+
description:
|
|
1392
|
+
'Date and time at which Seam created the warning.',
|
|
1393
|
+
format: 'date-time',
|
|
1394
|
+
type: 'string',
|
|
1395
|
+
},
|
|
1396
|
+
message: {
|
|
1397
|
+
description:
|
|
1398
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1399
|
+
type: 'string',
|
|
1400
|
+
},
|
|
980
1401
|
warning_code: {
|
|
981
1402
|
description:
|
|
982
1403
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -990,8 +1411,17 @@ export default {
|
|
|
990
1411
|
{
|
|
991
1412
|
description: 'Algopins must be used within 24 hours.',
|
|
992
1413
|
properties: {
|
|
993
|
-
created_at: {
|
|
994
|
-
|
|
1414
|
+
created_at: {
|
|
1415
|
+
description:
|
|
1416
|
+
'Date and time at which Seam created the warning.',
|
|
1417
|
+
format: 'date-time',
|
|
1418
|
+
type: 'string',
|
|
1419
|
+
},
|
|
1420
|
+
message: {
|
|
1421
|
+
description:
|
|
1422
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1423
|
+
type: 'string',
|
|
1424
|
+
},
|
|
995
1425
|
warning_code: {
|
|
996
1426
|
description:
|
|
997
1427
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -1006,8 +1436,17 @@ export default {
|
|
|
1006
1436
|
description:
|
|
1007
1437
|
'Management was transferred to another workspace.',
|
|
1008
1438
|
properties: {
|
|
1009
|
-
created_at: {
|
|
1010
|
-
|
|
1439
|
+
created_at: {
|
|
1440
|
+
description:
|
|
1441
|
+
'Date and time at which Seam created the warning.',
|
|
1442
|
+
format: 'date-time',
|
|
1443
|
+
type: 'string',
|
|
1444
|
+
},
|
|
1445
|
+
message: {
|
|
1446
|
+
description:
|
|
1447
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1448
|
+
type: 'string',
|
|
1449
|
+
},
|
|
1011
1450
|
warning_code: {
|
|
1012
1451
|
description:
|
|
1013
1452
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -1020,10 +1459,19 @@ export default {
|
|
|
1020
1459
|
},
|
|
1021
1460
|
{
|
|
1022
1461
|
description:
|
|
1023
|
-
'Unable to confirm the access code is set on Kwikset device.',
|
|
1462
|
+
'Unable to confirm that the access code is set on Kwikset device.',
|
|
1024
1463
|
properties: {
|
|
1025
|
-
created_at: {
|
|
1026
|
-
|
|
1464
|
+
created_at: {
|
|
1465
|
+
description:
|
|
1466
|
+
'Date and time at which Seam created the warning.',
|
|
1467
|
+
format: 'date-time',
|
|
1468
|
+
type: 'string',
|
|
1469
|
+
},
|
|
1470
|
+
message: {
|
|
1471
|
+
description:
|
|
1472
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1473
|
+
type: 'string',
|
|
1474
|
+
},
|
|
1027
1475
|
warning_code: {
|
|
1028
1476
|
description:
|
|
1029
1477
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -13424,6 +13872,8 @@ export default {
|
|
|
13424
13872
|
'x-route-path': '/thermostats/schedules',
|
|
13425
13873
|
},
|
|
13426
13874
|
unmanaged_access_code: {
|
|
13875
|
+
description:
|
|
13876
|
+
'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.',
|
|
13427
13877
|
properties: {
|
|
13428
13878
|
access_code_id: {
|
|
13429
13879
|
description: 'Unique identifier for the access code.',
|
|
@@ -13456,22 +13906,36 @@ export default {
|
|
|
13456
13906
|
},
|
|
13457
13907
|
errors: {
|
|
13458
13908
|
description:
|
|
13459
|
-
'
|
|
13909
|
+
'Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
13460
13910
|
items: {
|
|
13461
13911
|
discriminator: { propertyName: 'error_code' },
|
|
13462
13912
|
oneOf: [
|
|
13463
13913
|
{
|
|
13464
|
-
description: 'Failed to set code on
|
|
13914
|
+
description: 'Failed to set code on SmartThings device.',
|
|
13465
13915
|
properties: {
|
|
13466
|
-
created_at: {
|
|
13916
|
+
created_at: {
|
|
13917
|
+
description:
|
|
13918
|
+
'Date and time at which Seam created the error.',
|
|
13919
|
+
format: 'date-time',
|
|
13920
|
+
type: 'string',
|
|
13921
|
+
},
|
|
13467
13922
|
error_code: {
|
|
13468
13923
|
description:
|
|
13469
13924
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13470
13925
|
enum: ['smartthings_failed_to_set_access_code'],
|
|
13471
13926
|
type: 'string',
|
|
13472
13927
|
},
|
|
13473
|
-
is_access_code_error: {
|
|
13474
|
-
|
|
13928
|
+
is_access_code_error: {
|
|
13929
|
+
description:
|
|
13930
|
+
'Indicates that this is an access code error.',
|
|
13931
|
+
enum: [true],
|
|
13932
|
+
type: 'boolean',
|
|
13933
|
+
},
|
|
13934
|
+
message: {
|
|
13935
|
+
description:
|
|
13936
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13937
|
+
type: 'string',
|
|
13938
|
+
},
|
|
13475
13939
|
},
|
|
13476
13940
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13477
13941
|
type: 'object',
|
|
@@ -13479,7 +13943,12 @@ export default {
|
|
|
13479
13943
|
{
|
|
13480
13944
|
description: 'Failed to set code after multiple retries.',
|
|
13481
13945
|
properties: {
|
|
13482
|
-
created_at: {
|
|
13946
|
+
created_at: {
|
|
13947
|
+
description:
|
|
13948
|
+
'Date and time at which Seam created the error.',
|
|
13949
|
+
format: 'date-time',
|
|
13950
|
+
type: 'string',
|
|
13951
|
+
},
|
|
13483
13952
|
error_code: {
|
|
13484
13953
|
description:
|
|
13485
13954
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -13488,8 +13957,17 @@ export default {
|
|
|
13488
13957
|
],
|
|
13489
13958
|
type: 'string',
|
|
13490
13959
|
},
|
|
13491
|
-
is_access_code_error: {
|
|
13492
|
-
|
|
13960
|
+
is_access_code_error: {
|
|
13961
|
+
description:
|
|
13962
|
+
'Indicates that this is an access code error.',
|
|
13963
|
+
enum: [true],
|
|
13964
|
+
type: 'boolean',
|
|
13965
|
+
},
|
|
13966
|
+
message: {
|
|
13967
|
+
description:
|
|
13968
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13969
|
+
type: 'string',
|
|
13970
|
+
},
|
|
13493
13971
|
},
|
|
13494
13972
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13495
13973
|
type: 'object',
|
|
@@ -13497,15 +13975,29 @@ export default {
|
|
|
13497
13975
|
{
|
|
13498
13976
|
description: 'No free slots available on the device.',
|
|
13499
13977
|
properties: {
|
|
13500
|
-
created_at: {
|
|
13978
|
+
created_at: {
|
|
13979
|
+
description:
|
|
13980
|
+
'Date and time at which Seam created the error.',
|
|
13981
|
+
format: 'date-time',
|
|
13982
|
+
type: 'string',
|
|
13983
|
+
},
|
|
13501
13984
|
error_code: {
|
|
13502
13985
|
description:
|
|
13503
13986
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13504
13987
|
enum: ['smartthings_no_free_slots_available'],
|
|
13505
13988
|
type: 'string',
|
|
13506
13989
|
},
|
|
13507
|
-
is_access_code_error: {
|
|
13508
|
-
|
|
13990
|
+
is_access_code_error: {
|
|
13991
|
+
description:
|
|
13992
|
+
'Indicates that this is an access code error.',
|
|
13993
|
+
enum: [true],
|
|
13994
|
+
type: 'boolean',
|
|
13995
|
+
},
|
|
13996
|
+
message: {
|
|
13997
|
+
description:
|
|
13998
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13999
|
+
type: 'string',
|
|
14000
|
+
},
|
|
13509
14001
|
},
|
|
13510
14002
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13511
14003
|
type: 'object',
|
|
@@ -13513,15 +14005,29 @@ export default {
|
|
|
13513
14005
|
{
|
|
13514
14006
|
description: 'Failed to set code on device.',
|
|
13515
14007
|
properties: {
|
|
13516
|
-
created_at: {
|
|
14008
|
+
created_at: {
|
|
14009
|
+
description:
|
|
14010
|
+
'Date and time at which Seam created the error.',
|
|
14011
|
+
format: 'date-time',
|
|
14012
|
+
type: 'string',
|
|
14013
|
+
},
|
|
13517
14014
|
error_code: {
|
|
13518
14015
|
description:
|
|
13519
14016
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13520
14017
|
enum: ['failed_to_set_on_device'],
|
|
13521
14018
|
type: 'string',
|
|
13522
14019
|
},
|
|
13523
|
-
is_access_code_error: {
|
|
13524
|
-
|
|
14020
|
+
is_access_code_error: {
|
|
14021
|
+
description:
|
|
14022
|
+
'Indicates that this is an access code error.',
|
|
14023
|
+
enum: [true],
|
|
14024
|
+
type: 'boolean',
|
|
14025
|
+
},
|
|
14026
|
+
message: {
|
|
14027
|
+
description:
|
|
14028
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14029
|
+
type: 'string',
|
|
14030
|
+
},
|
|
13525
14031
|
},
|
|
13526
14032
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13527
14033
|
type: 'object',
|
|
@@ -13529,15 +14035,29 @@ export default {
|
|
|
13529
14035
|
{
|
|
13530
14036
|
description: 'Failed to remove code from device.',
|
|
13531
14037
|
properties: {
|
|
13532
|
-
created_at: {
|
|
14038
|
+
created_at: {
|
|
14039
|
+
description:
|
|
14040
|
+
'Date and time at which Seam created the error.',
|
|
14041
|
+
format: 'date-time',
|
|
14042
|
+
type: 'string',
|
|
14043
|
+
},
|
|
13533
14044
|
error_code: {
|
|
13534
14045
|
description:
|
|
13535
14046
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13536
14047
|
enum: ['failed_to_remove_from_device'],
|
|
13537
14048
|
type: 'string',
|
|
13538
14049
|
},
|
|
13539
|
-
is_access_code_error: {
|
|
13540
|
-
|
|
14050
|
+
is_access_code_error: {
|
|
14051
|
+
description:
|
|
14052
|
+
'Indicates that this is an access code error.',
|
|
14053
|
+
enum: [true],
|
|
14054
|
+
type: 'boolean',
|
|
14055
|
+
},
|
|
14056
|
+
message: {
|
|
14057
|
+
description:
|
|
14058
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14059
|
+
type: 'string',
|
|
14060
|
+
},
|
|
13541
14061
|
},
|
|
13542
14062
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13543
14063
|
type: 'object',
|
|
@@ -13545,15 +14065,29 @@ export default {
|
|
|
13545
14065
|
{
|
|
13546
14066
|
description: 'Duplicate access code detected on device.',
|
|
13547
14067
|
properties: {
|
|
13548
|
-
created_at: {
|
|
14068
|
+
created_at: {
|
|
14069
|
+
description:
|
|
14070
|
+
'Date and time at which Seam created the error.',
|
|
14071
|
+
format: 'date-time',
|
|
14072
|
+
type: 'string',
|
|
14073
|
+
},
|
|
13549
14074
|
error_code: {
|
|
13550
14075
|
description:
|
|
13551
14076
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13552
14077
|
enum: ['duplicate_code_on_device'],
|
|
13553
14078
|
type: 'string',
|
|
13554
14079
|
},
|
|
13555
|
-
is_access_code_error: {
|
|
13556
|
-
|
|
14080
|
+
is_access_code_error: {
|
|
14081
|
+
description:
|
|
14082
|
+
'Indicates that this is an access code error.',
|
|
14083
|
+
enum: [true],
|
|
14084
|
+
type: 'boolean',
|
|
14085
|
+
},
|
|
14086
|
+
message: {
|
|
14087
|
+
description:
|
|
14088
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14089
|
+
type: 'string',
|
|
14090
|
+
},
|
|
13557
14091
|
},
|
|
13558
14092
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13559
14093
|
type: 'object',
|
|
@@ -13562,15 +14096,29 @@ export default {
|
|
|
13562
14096
|
description:
|
|
13563
14097
|
'An attempt to modify this access code was prevented.',
|
|
13564
14098
|
properties: {
|
|
13565
|
-
created_at: {
|
|
14099
|
+
created_at: {
|
|
14100
|
+
description:
|
|
14101
|
+
'Date and time at which Seam created the error.',
|
|
14102
|
+
format: 'date-time',
|
|
14103
|
+
type: 'string',
|
|
14104
|
+
},
|
|
13566
14105
|
error_code: {
|
|
13567
14106
|
description:
|
|
13568
14107
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13569
14108
|
enum: ['duplicate_code_attempt_prevented'],
|
|
13570
14109
|
type: 'string',
|
|
13571
14110
|
},
|
|
13572
|
-
is_access_code_error: {
|
|
13573
|
-
|
|
14111
|
+
is_access_code_error: {
|
|
14112
|
+
description:
|
|
14113
|
+
'Indicates that this is an access code error.',
|
|
14114
|
+
enum: [true],
|
|
14115
|
+
type: 'boolean',
|
|
14116
|
+
},
|
|
14117
|
+
message: {
|
|
14118
|
+
description:
|
|
14119
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14120
|
+
type: 'string',
|
|
14121
|
+
},
|
|
13574
14122
|
},
|
|
13575
14123
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13576
14124
|
type: 'object',
|
|
@@ -13579,15 +14127,29 @@ export default {
|
|
|
13579
14127
|
description:
|
|
13580
14128
|
'Igloohome bridge has too many pending jobs in the queue.',
|
|
13581
14129
|
properties: {
|
|
13582
|
-
created_at: {
|
|
14130
|
+
created_at: {
|
|
14131
|
+
description:
|
|
14132
|
+
'Date and time at which Seam created the error.',
|
|
14133
|
+
format: 'date-time',
|
|
14134
|
+
type: 'string',
|
|
14135
|
+
},
|
|
13583
14136
|
error_code: {
|
|
13584
14137
|
description:
|
|
13585
14138
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13586
14139
|
enum: ['igloohome_bridge_too_many_pending_jobs'],
|
|
13587
14140
|
type: 'string',
|
|
13588
14141
|
},
|
|
13589
|
-
is_access_code_error: {
|
|
13590
|
-
|
|
14142
|
+
is_access_code_error: {
|
|
14143
|
+
description:
|
|
14144
|
+
'Indicates that this is an access code error.',
|
|
14145
|
+
enum: [true],
|
|
14146
|
+
type: 'boolean',
|
|
14147
|
+
},
|
|
14148
|
+
message: {
|
|
14149
|
+
description:
|
|
14150
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14151
|
+
type: 'string',
|
|
14152
|
+
},
|
|
13591
14153
|
},
|
|
13592
14154
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13593
14155
|
type: 'object',
|
|
@@ -13595,23 +14157,42 @@ export default {
|
|
|
13595
14157
|
{
|
|
13596
14158
|
description: 'Igloohome bridge is offline.',
|
|
13597
14159
|
properties: {
|
|
13598
|
-
created_at: {
|
|
14160
|
+
created_at: {
|
|
14161
|
+
description:
|
|
14162
|
+
'Date and time at which Seam created the error.',
|
|
14163
|
+
format: 'date-time',
|
|
14164
|
+
type: 'string',
|
|
14165
|
+
},
|
|
13599
14166
|
error_code: {
|
|
13600
14167
|
description:
|
|
13601
14168
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13602
14169
|
enum: ['igloohome_bridge_offline'],
|
|
13603
14170
|
type: 'string',
|
|
13604
14171
|
},
|
|
13605
|
-
is_access_code_error: {
|
|
13606
|
-
|
|
14172
|
+
is_access_code_error: {
|
|
14173
|
+
description:
|
|
14174
|
+
'Indicates that this is an access code error.',
|
|
14175
|
+
enum: [true],
|
|
14176
|
+
type: 'boolean',
|
|
14177
|
+
},
|
|
14178
|
+
message: {
|
|
14179
|
+
description:
|
|
14180
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14181
|
+
type: 'string',
|
|
14182
|
+
},
|
|
13607
14183
|
},
|
|
13608
14184
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13609
14185
|
type: 'object',
|
|
13610
14186
|
},
|
|
13611
14187
|
{
|
|
13612
|
-
description: 'Lock
|
|
14188
|
+
description: 'Lock has reached maximum amount of codes.',
|
|
13613
14189
|
properties: {
|
|
13614
|
-
created_at: {
|
|
14190
|
+
created_at: {
|
|
14191
|
+
description:
|
|
14192
|
+
'Date and time at which Seam created the error.',
|
|
14193
|
+
format: 'date-time',
|
|
14194
|
+
type: 'string',
|
|
14195
|
+
},
|
|
13615
14196
|
error_code: {
|
|
13616
14197
|
description:
|
|
13617
14198
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -13620,25 +14201,48 @@ export default {
|
|
|
13620
14201
|
],
|
|
13621
14202
|
type: 'string',
|
|
13622
14203
|
},
|
|
13623
|
-
is_access_code_error: {
|
|
13624
|
-
|
|
14204
|
+
is_access_code_error: {
|
|
14205
|
+
description:
|
|
14206
|
+
'Indicates that this is an access code error.',
|
|
14207
|
+
enum: [true],
|
|
14208
|
+
type: 'boolean',
|
|
14209
|
+
},
|
|
14210
|
+
message: {
|
|
14211
|
+
description:
|
|
14212
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14213
|
+
type: 'string',
|
|
14214
|
+
},
|
|
13625
14215
|
},
|
|
13626
14216
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13627
14217
|
type: 'object',
|
|
13628
14218
|
},
|
|
13629
14219
|
{
|
|
13630
14220
|
description:
|
|
13631
|
-
'Unable to confirm the access code is set on Kwikset device.',
|
|
14221
|
+
'Unable to confirm that the access code is set on Kwikset device.',
|
|
13632
14222
|
properties: {
|
|
13633
|
-
created_at: {
|
|
14223
|
+
created_at: {
|
|
14224
|
+
description:
|
|
14225
|
+
'Date and time at which Seam created the error.',
|
|
14226
|
+
format: 'date-time',
|
|
14227
|
+
type: 'string',
|
|
14228
|
+
},
|
|
13634
14229
|
error_code: {
|
|
13635
14230
|
description:
|
|
13636
14231
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13637
14232
|
enum: ['kwikset_unable_to_confirm_code'],
|
|
13638
14233
|
type: 'string',
|
|
13639
14234
|
},
|
|
13640
|
-
is_access_code_error: {
|
|
13641
|
-
|
|
14235
|
+
is_access_code_error: {
|
|
14236
|
+
description:
|
|
14237
|
+
'Indicates that this is an access code error.',
|
|
14238
|
+
enum: [true],
|
|
14239
|
+
type: 'boolean',
|
|
14240
|
+
},
|
|
14241
|
+
message: {
|
|
14242
|
+
description:
|
|
14243
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14244
|
+
type: 'string',
|
|
14245
|
+
},
|
|
13642
14246
|
},
|
|
13643
14247
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13644
14248
|
type: 'object',
|
|
@@ -13647,15 +14251,29 @@ export default {
|
|
|
13647
14251
|
description:
|
|
13648
14252
|
'Unable to confirm the deletion of the access code on Kwikset device.',
|
|
13649
14253
|
properties: {
|
|
13650
|
-
created_at: {
|
|
14254
|
+
created_at: {
|
|
14255
|
+
description:
|
|
14256
|
+
'Date and time at which Seam created the error.',
|
|
14257
|
+
format: 'date-time',
|
|
14258
|
+
type: 'string',
|
|
14259
|
+
},
|
|
13651
14260
|
error_code: {
|
|
13652
14261
|
description:
|
|
13653
14262
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13654
14263
|
enum: ['kwikset_unable_to_confirm_deletion'],
|
|
13655
14264
|
type: 'string',
|
|
13656
14265
|
},
|
|
13657
|
-
is_access_code_error: {
|
|
13658
|
-
|
|
14266
|
+
is_access_code_error: {
|
|
14267
|
+
description:
|
|
14268
|
+
'Indicates that this is an access code error.',
|
|
14269
|
+
enum: [true],
|
|
14270
|
+
type: 'boolean',
|
|
14271
|
+
},
|
|
14272
|
+
message: {
|
|
14273
|
+
description:
|
|
14274
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14275
|
+
type: 'string',
|
|
14276
|
+
},
|
|
13659
14277
|
},
|
|
13660
14278
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13661
14279
|
type: 'object',
|
|
@@ -13664,15 +14282,29 @@ export default {
|
|
|
13664
14282
|
description:
|
|
13665
14283
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
13666
14284
|
properties: {
|
|
13667
|
-
created_at: {
|
|
14285
|
+
created_at: {
|
|
14286
|
+
description:
|
|
14287
|
+
'Date and time at which Seam created the error.',
|
|
14288
|
+
format: 'date-time',
|
|
14289
|
+
type: 'string',
|
|
14290
|
+
},
|
|
13668
14291
|
error_code: {
|
|
13669
14292
|
description:
|
|
13670
14293
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13671
14294
|
enum: ['code_modified_external_to_seam'],
|
|
13672
14295
|
type: 'string',
|
|
13673
14296
|
},
|
|
13674
|
-
is_access_code_error: {
|
|
13675
|
-
|
|
14297
|
+
is_access_code_error: {
|
|
14298
|
+
description:
|
|
14299
|
+
'Indicates that this is an access code error.',
|
|
14300
|
+
enum: [true],
|
|
14301
|
+
type: 'boolean',
|
|
14302
|
+
},
|
|
14303
|
+
message: {
|
|
14304
|
+
description:
|
|
14305
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14306
|
+
type: 'string',
|
|
14307
|
+
},
|
|
13676
14308
|
},
|
|
13677
14309
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13678
14310
|
type: 'object',
|
|
@@ -13680,15 +14312,29 @@ export default {
|
|
|
13680
14312
|
{
|
|
13681
14313
|
description: 'Invalid code length for August lock.',
|
|
13682
14314
|
properties: {
|
|
13683
|
-
created_at: {
|
|
14315
|
+
created_at: {
|
|
14316
|
+
description:
|
|
14317
|
+
'Date and time at which Seam created the error.',
|
|
14318
|
+
format: 'date-time',
|
|
14319
|
+
type: 'string',
|
|
14320
|
+
},
|
|
13684
14321
|
error_code: {
|
|
13685
14322
|
description:
|
|
13686
14323
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13687
14324
|
enum: ['august_lock_invalid_code_length'],
|
|
13688
14325
|
type: 'string',
|
|
13689
14326
|
},
|
|
13690
|
-
is_access_code_error: {
|
|
13691
|
-
|
|
14327
|
+
is_access_code_error: {
|
|
14328
|
+
description:
|
|
14329
|
+
'Indicates that this is an access code error.',
|
|
14330
|
+
enum: [true],
|
|
14331
|
+
type: 'boolean',
|
|
14332
|
+
},
|
|
14333
|
+
message: {
|
|
14334
|
+
description:
|
|
14335
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14336
|
+
type: 'string',
|
|
14337
|
+
},
|
|
13692
14338
|
},
|
|
13693
14339
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13694
14340
|
type: 'object',
|
|
@@ -13697,15 +14343,29 @@ export default {
|
|
|
13697
14343
|
description:
|
|
13698
14344
|
'Access code has not yet been fully moved to the device.',
|
|
13699
14345
|
properties: {
|
|
13700
|
-
created_at: {
|
|
14346
|
+
created_at: {
|
|
14347
|
+
description:
|
|
14348
|
+
'Date and time at which Seam created the error.',
|
|
14349
|
+
format: 'date-time',
|
|
14350
|
+
type: 'string',
|
|
14351
|
+
},
|
|
13701
14352
|
error_code: {
|
|
13702
14353
|
description:
|
|
13703
14354
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13704
14355
|
enum: ['august_device_programming_delay'],
|
|
13705
14356
|
type: 'string',
|
|
13706
14357
|
},
|
|
13707
|
-
is_access_code_error: {
|
|
13708
|
-
|
|
14358
|
+
is_access_code_error: {
|
|
14359
|
+
description:
|
|
14360
|
+
'Indicates that this is an access code error.',
|
|
14361
|
+
enum: [true],
|
|
14362
|
+
type: 'boolean',
|
|
14363
|
+
},
|
|
14364
|
+
message: {
|
|
14365
|
+
description:
|
|
14366
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14367
|
+
type: 'string',
|
|
14368
|
+
},
|
|
13709
14369
|
},
|
|
13710
14370
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13711
14371
|
type: 'object',
|
|
@@ -13713,15 +14373,29 @@ export default {
|
|
|
13713
14373
|
{
|
|
13714
14374
|
description: 'All access code slots on the device are full.',
|
|
13715
14375
|
properties: {
|
|
13716
|
-
created_at: {
|
|
14376
|
+
created_at: {
|
|
14377
|
+
description:
|
|
14378
|
+
'Date and time at which Seam created the error.',
|
|
14379
|
+
format: 'date-time',
|
|
14380
|
+
type: 'string',
|
|
14381
|
+
},
|
|
13717
14382
|
error_code: {
|
|
13718
14383
|
description:
|
|
13719
14384
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13720
14385
|
enum: ['august_device_slots_full'],
|
|
13721
14386
|
type: 'string',
|
|
13722
14387
|
},
|
|
13723
|
-
is_access_code_error: {
|
|
13724
|
-
|
|
14388
|
+
is_access_code_error: {
|
|
14389
|
+
description:
|
|
14390
|
+
'Indicates that this is an access code error.',
|
|
14391
|
+
enum: [true],
|
|
14392
|
+
type: 'boolean',
|
|
14393
|
+
},
|
|
14394
|
+
message: {
|
|
14395
|
+
description:
|
|
14396
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14397
|
+
type: 'string',
|
|
14398
|
+
},
|
|
13725
14399
|
},
|
|
13726
14400
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13727
14401
|
type: 'object',
|
|
@@ -13729,15 +14403,29 @@ export default {
|
|
|
13729
14403
|
{
|
|
13730
14404
|
description: 'August lock is missing a keypad.',
|
|
13731
14405
|
properties: {
|
|
13732
|
-
created_at: {
|
|
14406
|
+
created_at: {
|
|
14407
|
+
description:
|
|
14408
|
+
'Date and time at which Seam created the error.',
|
|
14409
|
+
format: 'date-time',
|
|
14410
|
+
type: 'string',
|
|
14411
|
+
},
|
|
13733
14412
|
error_code: {
|
|
13734
14413
|
description:
|
|
13735
14414
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13736
14415
|
enum: ['august_lock_missing_keypad'],
|
|
13737
14416
|
type: 'string',
|
|
13738
14417
|
},
|
|
13739
|
-
is_access_code_error: {
|
|
13740
|
-
|
|
14418
|
+
is_access_code_error: {
|
|
14419
|
+
description:
|
|
14420
|
+
'Indicates that this is an access code error.',
|
|
14421
|
+
enum: [true],
|
|
14422
|
+
type: 'boolean',
|
|
14423
|
+
},
|
|
14424
|
+
message: {
|
|
14425
|
+
description:
|
|
14426
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14427
|
+
type: 'string',
|
|
14428
|
+
},
|
|
13741
14429
|
},
|
|
13742
14430
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13743
14431
|
type: 'object',
|
|
@@ -13745,15 +14433,29 @@ export default {
|
|
|
13745
14433
|
{
|
|
13746
14434
|
description: 'August lock is temporarily offline.',
|
|
13747
14435
|
properties: {
|
|
13748
|
-
created_at: {
|
|
14436
|
+
created_at: {
|
|
14437
|
+
description:
|
|
14438
|
+
'Date and time at which Seam created the error.',
|
|
14439
|
+
format: 'date-time',
|
|
14440
|
+
type: 'string',
|
|
14441
|
+
},
|
|
13749
14442
|
error_code: {
|
|
13750
14443
|
description:
|
|
13751
14444
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13752
14445
|
enum: ['august_lock_temporarily_offline'],
|
|
13753
14446
|
type: 'string',
|
|
13754
14447
|
},
|
|
13755
|
-
is_access_code_error: {
|
|
13756
|
-
|
|
14448
|
+
is_access_code_error: {
|
|
14449
|
+
description:
|
|
14450
|
+
'Indicates that this is an access code error.',
|
|
14451
|
+
enum: [true],
|
|
14452
|
+
type: 'boolean',
|
|
14453
|
+
},
|
|
14454
|
+
message: {
|
|
14455
|
+
description:
|
|
14456
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14457
|
+
type: 'string',
|
|
14458
|
+
},
|
|
13757
14459
|
},
|
|
13758
14460
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13759
14461
|
type: 'object',
|
|
@@ -13761,15 +14463,29 @@ export default {
|
|
|
13761
14463
|
{
|
|
13762
14464
|
description: 'Salto site user is not subscribed.',
|
|
13763
14465
|
properties: {
|
|
13764
|
-
created_at: {
|
|
14466
|
+
created_at: {
|
|
14467
|
+
description:
|
|
14468
|
+
'Date and time at which Seam created the error.',
|
|
14469
|
+
format: 'date-time',
|
|
14470
|
+
type: 'string',
|
|
14471
|
+
},
|
|
13765
14472
|
error_code: {
|
|
13766
14473
|
description:
|
|
13767
14474
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13768
14475
|
enum: ['salto_ks_user_not_subscribed'],
|
|
13769
14476
|
type: 'string',
|
|
13770
14477
|
},
|
|
13771
|
-
is_access_code_error: {
|
|
13772
|
-
|
|
14478
|
+
is_access_code_error: {
|
|
14479
|
+
description:
|
|
14480
|
+
'Indicates that this is an access code error.',
|
|
14481
|
+
enum: [true],
|
|
14482
|
+
type: 'boolean',
|
|
14483
|
+
},
|
|
14484
|
+
message: {
|
|
14485
|
+
description:
|
|
14486
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14487
|
+
type: 'string',
|
|
14488
|
+
},
|
|
13773
14489
|
},
|
|
13774
14490
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13775
14491
|
type: 'object',
|
|
@@ -13778,15 +14494,29 @@ export default {
|
|
|
13778
14494
|
description:
|
|
13779
14495
|
'Access code has not yet been fully moved to the device.',
|
|
13780
14496
|
properties: {
|
|
13781
|
-
created_at: {
|
|
14497
|
+
created_at: {
|
|
14498
|
+
description:
|
|
14499
|
+
'Date and time at which Seam created the error.',
|
|
14500
|
+
format: 'date-time',
|
|
14501
|
+
type: 'string',
|
|
14502
|
+
},
|
|
13782
14503
|
error_code: {
|
|
13783
14504
|
description:
|
|
13784
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13785
|
-
enum: ['hubitat_device_programming_delay'],
|
|
14505
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
14506
|
+
enum: ['hubitat_device_programming_delay'],
|
|
14507
|
+
type: 'string',
|
|
14508
|
+
},
|
|
14509
|
+
is_access_code_error: {
|
|
14510
|
+
description:
|
|
14511
|
+
'Indicates that this is an access code error.',
|
|
14512
|
+
enum: [true],
|
|
14513
|
+
type: 'boolean',
|
|
14514
|
+
},
|
|
14515
|
+
message: {
|
|
14516
|
+
description:
|
|
14517
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13786
14518
|
type: 'string',
|
|
13787
14519
|
},
|
|
13788
|
-
is_access_code_error: { enum: [true], type: 'boolean' },
|
|
13789
|
-
message: { type: 'string' },
|
|
13790
14520
|
},
|
|
13791
14521
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13792
14522
|
type: 'object',
|
|
@@ -13794,15 +14524,29 @@ export default {
|
|
|
13794
14524
|
{
|
|
13795
14525
|
description: 'No free positions available on the device.',
|
|
13796
14526
|
properties: {
|
|
13797
|
-
created_at: {
|
|
14527
|
+
created_at: {
|
|
14528
|
+
description:
|
|
14529
|
+
'Date and time at which Seam created the error.',
|
|
14530
|
+
format: 'date-time',
|
|
14531
|
+
type: 'string',
|
|
14532
|
+
},
|
|
13798
14533
|
error_code: {
|
|
13799
14534
|
description:
|
|
13800
14535
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13801
14536
|
enum: ['hubitat_no_free_positions_available'],
|
|
13802
14537
|
type: 'string',
|
|
13803
14538
|
},
|
|
13804
|
-
is_access_code_error: {
|
|
13805
|
-
|
|
14539
|
+
is_access_code_error: {
|
|
14540
|
+
description:
|
|
14541
|
+
'Indicates that this is an access code error.',
|
|
14542
|
+
enum: [true],
|
|
14543
|
+
type: 'boolean',
|
|
14544
|
+
},
|
|
14545
|
+
message: {
|
|
14546
|
+
description:
|
|
14547
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14548
|
+
type: 'string',
|
|
14549
|
+
},
|
|
13806
14550
|
},
|
|
13807
14551
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13808
14552
|
type: 'object',
|
|
@@ -13810,15 +14554,29 @@ export default {
|
|
|
13810
14554
|
{
|
|
13811
14555
|
description: 'Duplicate access code name detected.',
|
|
13812
14556
|
properties: {
|
|
13813
|
-
created_at: {
|
|
14557
|
+
created_at: {
|
|
14558
|
+
description:
|
|
14559
|
+
'Date and time at which Seam created the error.',
|
|
14560
|
+
format: 'date-time',
|
|
14561
|
+
type: 'string',
|
|
14562
|
+
},
|
|
13814
14563
|
error_code: {
|
|
13815
14564
|
description:
|
|
13816
14565
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13817
14566
|
enum: ['wyze_duplicate_code_name'],
|
|
13818
14567
|
type: 'string',
|
|
13819
14568
|
},
|
|
13820
|
-
is_access_code_error: {
|
|
13821
|
-
|
|
14569
|
+
is_access_code_error: {
|
|
14570
|
+
description:
|
|
14571
|
+
'Indicates that this is an access code error.',
|
|
14572
|
+
enum: [true],
|
|
14573
|
+
type: 'boolean',
|
|
14574
|
+
},
|
|
14575
|
+
message: {
|
|
14576
|
+
description:
|
|
14577
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14578
|
+
type: 'string',
|
|
14579
|
+
},
|
|
13822
14580
|
},
|
|
13823
14581
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13824
14582
|
type: 'object',
|
|
@@ -13826,15 +14584,29 @@ export default {
|
|
|
13826
14584
|
{
|
|
13827
14585
|
description: 'Potential duplicate access code detected.',
|
|
13828
14586
|
properties: {
|
|
13829
|
-
created_at: {
|
|
14587
|
+
created_at: {
|
|
14588
|
+
description:
|
|
14589
|
+
'Date and time at which Seam created the error.',
|
|
14590
|
+
format: 'date-time',
|
|
14591
|
+
type: 'string',
|
|
14592
|
+
},
|
|
13830
14593
|
error_code: {
|
|
13831
14594
|
description:
|
|
13832
14595
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13833
14596
|
enum: ['wyze_potential_duplicate_code'],
|
|
13834
14597
|
type: 'string',
|
|
13835
14598
|
},
|
|
13836
|
-
is_access_code_error: {
|
|
13837
|
-
|
|
14599
|
+
is_access_code_error: {
|
|
14600
|
+
description:
|
|
14601
|
+
'Indicates that this is an access code error.',
|
|
14602
|
+
enum: [true],
|
|
14603
|
+
type: 'boolean',
|
|
14604
|
+
},
|
|
14605
|
+
message: {
|
|
14606
|
+
description:
|
|
14607
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14608
|
+
type: 'string',
|
|
14609
|
+
},
|
|
13838
14610
|
},
|
|
13839
14611
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13840
14612
|
type: 'object',
|
|
@@ -13842,15 +14614,29 @@ export default {
|
|
|
13842
14614
|
{
|
|
13843
14615
|
description: 'No valid user level for Oracode.',
|
|
13844
14616
|
properties: {
|
|
13845
|
-
created_at: {
|
|
14617
|
+
created_at: {
|
|
14618
|
+
description:
|
|
14619
|
+
'Date and time at which Seam created the error.',
|
|
14620
|
+
format: 'date-time',
|
|
14621
|
+
type: 'string',
|
|
14622
|
+
},
|
|
13846
14623
|
error_code: {
|
|
13847
14624
|
description:
|
|
13848
14625
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13849
14626
|
enum: ['dormakaba_oracode_no_valid_user_level'],
|
|
13850
14627
|
type: 'string',
|
|
13851
14628
|
},
|
|
13852
|
-
is_access_code_error: {
|
|
13853
|
-
|
|
14629
|
+
is_access_code_error: {
|
|
14630
|
+
description:
|
|
14631
|
+
'Indicates that this is an access code error.',
|
|
14632
|
+
enum: [true],
|
|
14633
|
+
type: 'boolean',
|
|
14634
|
+
},
|
|
14635
|
+
message: {
|
|
14636
|
+
description:
|
|
14637
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14638
|
+
type: 'string',
|
|
14639
|
+
},
|
|
13854
14640
|
},
|
|
13855
14641
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13856
14642
|
type: 'object',
|
|
@@ -14187,7 +14973,11 @@ export default {
|
|
|
14187
14973
|
},
|
|
14188
14974
|
type: 'array',
|
|
14189
14975
|
},
|
|
14190
|
-
is_managed: {
|
|
14976
|
+
is_managed: {
|
|
14977
|
+
description: 'Indicates that Seam does not manage the access code.',
|
|
14978
|
+
enum: [false],
|
|
14979
|
+
type: 'boolean',
|
|
14980
|
+
},
|
|
14191
14981
|
name: {
|
|
14192
14982
|
description:
|
|
14193
14983
|
'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
|
|
@@ -14201,24 +14991,40 @@ export default {
|
|
|
14201
14991
|
nullable: true,
|
|
14202
14992
|
type: 'string',
|
|
14203
14993
|
},
|
|
14204
|
-
status: {
|
|
14994
|
+
status: {
|
|
14995
|
+
description:
|
|
14996
|
+
'Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.',
|
|
14997
|
+
enum: ['set'],
|
|
14998
|
+
type: 'string',
|
|
14999
|
+
},
|
|
14205
15000
|
type: {
|
|
14206
15001
|
description:
|
|
14207
|
-
'Nature of the access code. Values are
|
|
15002
|
+
'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.',
|
|
14208
15003
|
enum: ['time_bound', 'ongoing'],
|
|
14209
15004
|
type: 'string',
|
|
14210
15005
|
},
|
|
14211
15006
|
warnings: {
|
|
14212
15007
|
description:
|
|
14213
|
-
'
|
|
15008
|
+
'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
14214
15009
|
items: {
|
|
15010
|
+
description:
|
|
15011
|
+
'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
14215
15012
|
discriminator: { propertyName: 'warning_code' },
|
|
14216
15013
|
oneOf: [
|
|
14217
15014
|
{
|
|
14218
|
-
description: 'Failed to set code on
|
|
15015
|
+
description: 'Failed to set code on SmartThings device.',
|
|
14219
15016
|
properties: {
|
|
14220
|
-
created_at: {
|
|
14221
|
-
|
|
15017
|
+
created_at: {
|
|
15018
|
+
description:
|
|
15019
|
+
'Date and time at which Seam created the warning.',
|
|
15020
|
+
format: 'date-time',
|
|
15021
|
+
type: 'string',
|
|
15022
|
+
},
|
|
15023
|
+
message: {
|
|
15024
|
+
description:
|
|
15025
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15026
|
+
type: 'string',
|
|
15027
|
+
},
|
|
14222
15028
|
warning_code: {
|
|
14223
15029
|
description:
|
|
14224
15030
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14232,8 +15038,17 @@ export default {
|
|
|
14232
15038
|
{
|
|
14233
15039
|
description: 'Duplicate access code detected.',
|
|
14234
15040
|
properties: {
|
|
14235
|
-
created_at: {
|
|
14236
|
-
|
|
15041
|
+
created_at: {
|
|
15042
|
+
description:
|
|
15043
|
+
'Date and time at which Seam created the warning.',
|
|
15044
|
+
format: 'date-time',
|
|
15045
|
+
type: 'string',
|
|
15046
|
+
},
|
|
15047
|
+
message: {
|
|
15048
|
+
description:
|
|
15049
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15050
|
+
type: 'string',
|
|
15051
|
+
},
|
|
14237
15052
|
warning_code: {
|
|
14238
15053
|
description:
|
|
14239
15054
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14248,8 +15063,17 @@ export default {
|
|
|
14248
15063
|
description:
|
|
14249
15064
|
'Received an error when attempting to create this code.',
|
|
14250
15065
|
properties: {
|
|
14251
|
-
created_at: {
|
|
14252
|
-
|
|
15066
|
+
created_at: {
|
|
15067
|
+
description:
|
|
15068
|
+
'Date and time at which Seam created the warning.',
|
|
15069
|
+
format: 'date-time',
|
|
15070
|
+
type: 'string',
|
|
15071
|
+
},
|
|
15072
|
+
message: {
|
|
15073
|
+
description:
|
|
15074
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15075
|
+
type: 'string',
|
|
15076
|
+
},
|
|
14253
15077
|
warning_code: {
|
|
14254
15078
|
description:
|
|
14255
15079
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14264,8 +15088,17 @@ export default {
|
|
|
14264
15088
|
description:
|
|
14265
15089
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
14266
15090
|
properties: {
|
|
14267
|
-
created_at: {
|
|
14268
|
-
|
|
15091
|
+
created_at: {
|
|
15092
|
+
description:
|
|
15093
|
+
'Date and time at which Seam created the warning.',
|
|
15094
|
+
format: 'date-time',
|
|
15095
|
+
type: 'string',
|
|
15096
|
+
},
|
|
15097
|
+
message: {
|
|
15098
|
+
description:
|
|
15099
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15100
|
+
type: 'string',
|
|
15101
|
+
},
|
|
14269
15102
|
warning_code: {
|
|
14270
15103
|
description:
|
|
14271
15104
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14279,8 +15112,17 @@ export default {
|
|
|
14279
15112
|
{
|
|
14280
15113
|
description: 'Delay in setting code on device.',
|
|
14281
15114
|
properties: {
|
|
14282
|
-
created_at: {
|
|
14283
|
-
|
|
15115
|
+
created_at: {
|
|
15116
|
+
description:
|
|
15117
|
+
'Date and time at which Seam created the warning.',
|
|
15118
|
+
format: 'date-time',
|
|
15119
|
+
type: 'string',
|
|
15120
|
+
},
|
|
15121
|
+
message: {
|
|
15122
|
+
description:
|
|
15123
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15124
|
+
type: 'string',
|
|
15125
|
+
},
|
|
14284
15126
|
warning_code: {
|
|
14285
15127
|
description:
|
|
14286
15128
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14294,8 +15136,17 @@ export default {
|
|
|
14294
15136
|
{
|
|
14295
15137
|
description: 'Delay in removing code from device.',
|
|
14296
15138
|
properties: {
|
|
14297
|
-
created_at: {
|
|
14298
|
-
|
|
15139
|
+
created_at: {
|
|
15140
|
+
description:
|
|
15141
|
+
'Date and time at which Seam created the warning.',
|
|
15142
|
+
format: 'date-time',
|
|
15143
|
+
type: 'string',
|
|
15144
|
+
},
|
|
15145
|
+
message: {
|
|
15146
|
+
description:
|
|
15147
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15148
|
+
type: 'string',
|
|
15149
|
+
},
|
|
14299
15150
|
warning_code: {
|
|
14300
15151
|
description:
|
|
14301
15152
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14308,10 +15159,19 @@ export default {
|
|
|
14308
15159
|
},
|
|
14309
15160
|
{
|
|
14310
15161
|
description:
|
|
14311
|
-
'Third
|
|
15162
|
+
'Third-party integration detected that may cause access codes to fail.',
|
|
14312
15163
|
properties: {
|
|
14313
|
-
created_at: {
|
|
14314
|
-
|
|
15164
|
+
created_at: {
|
|
15165
|
+
description:
|
|
15166
|
+
'Date and time at which Seam created the warning.',
|
|
15167
|
+
format: 'date-time',
|
|
15168
|
+
type: 'string',
|
|
15169
|
+
},
|
|
15170
|
+
message: {
|
|
15171
|
+
description:
|
|
15172
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15173
|
+
type: 'string',
|
|
15174
|
+
},
|
|
14315
15175
|
warning_code: {
|
|
14316
15176
|
description:
|
|
14317
15177
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14326,8 +15186,17 @@ export default {
|
|
|
14326
15186
|
description:
|
|
14327
15187
|
'Access code has not yet been fully moved to the device.',
|
|
14328
15188
|
properties: {
|
|
14329
|
-
created_at: {
|
|
14330
|
-
|
|
15189
|
+
created_at: {
|
|
15190
|
+
description:
|
|
15191
|
+
'Date and time at which Seam created the warning.',
|
|
15192
|
+
format: 'date-time',
|
|
15193
|
+
type: 'string',
|
|
15194
|
+
},
|
|
15195
|
+
message: {
|
|
15196
|
+
description:
|
|
15197
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15198
|
+
type: 'string',
|
|
15199
|
+
},
|
|
14331
15200
|
warning_code: {
|
|
14332
15201
|
description:
|
|
14333
15202
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14341,8 +15210,17 @@ export default {
|
|
|
14341
15210
|
{
|
|
14342
15211
|
description: 'August lock is temporarily offline.',
|
|
14343
15212
|
properties: {
|
|
14344
|
-
created_at: {
|
|
14345
|
-
|
|
15213
|
+
created_at: {
|
|
15214
|
+
description:
|
|
15215
|
+
'Date and time at which Seam created the warning.',
|
|
15216
|
+
format: 'date-time',
|
|
15217
|
+
type: 'string',
|
|
15218
|
+
},
|
|
15219
|
+
message: {
|
|
15220
|
+
description:
|
|
15221
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15222
|
+
type: 'string',
|
|
15223
|
+
},
|
|
14346
15224
|
warning_code: {
|
|
14347
15225
|
description:
|
|
14348
15226
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -14356,8 +15234,17 @@ export default {
|
|
|
14356
15234
|
{
|
|
14357
15235
|
description: 'Algopins must be used within 24 hours.',
|
|
14358
15236
|
properties: {
|
|
14359
|
-
created_at: {
|
|
14360
|
-
|
|
15237
|
+
created_at: {
|
|
15238
|
+
description:
|
|
15239
|
+
'Date and time at which Seam created the warning.',
|
|
15240
|
+
format: 'date-time',
|
|
15241
|
+
type: 'string',
|
|
15242
|
+
},
|
|
15243
|
+
message: {
|
|
15244
|
+
description:
|
|
15245
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15246
|
+
type: 'string',
|
|
15247
|
+
},
|
|
14361
15248
|
warning_code: {
|
|
14362
15249
|
description:
|
|
14363
15250
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14372,8 +15259,17 @@ export default {
|
|
|
14372
15259
|
description:
|
|
14373
15260
|
'Management was transferred to another workspace.',
|
|
14374
15261
|
properties: {
|
|
14375
|
-
created_at: {
|
|
14376
|
-
|
|
15262
|
+
created_at: {
|
|
15263
|
+
description:
|
|
15264
|
+
'Date and time at which Seam created the warning.',
|
|
15265
|
+
format: 'date-time',
|
|
15266
|
+
type: 'string',
|
|
15267
|
+
},
|
|
15268
|
+
message: {
|
|
15269
|
+
description:
|
|
15270
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15271
|
+
type: 'string',
|
|
15272
|
+
},
|
|
14377
15273
|
warning_code: {
|
|
14378
15274
|
description:
|
|
14379
15275
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14386,10 +15282,19 @@ export default {
|
|
|
14386
15282
|
},
|
|
14387
15283
|
{
|
|
14388
15284
|
description:
|
|
14389
|
-
'Unable to confirm the access code is set on Kwikset device.',
|
|
15285
|
+
'Unable to confirm that the access code is set on Kwikset device.',
|
|
14390
15286
|
properties: {
|
|
14391
|
-
created_at: {
|
|
14392
|
-
|
|
15287
|
+
created_at: {
|
|
15288
|
+
description:
|
|
15289
|
+
'Date and time at which Seam created the warning.',
|
|
15290
|
+
format: 'date-time',
|
|
15291
|
+
type: 'string',
|
|
15292
|
+
},
|
|
15293
|
+
message: {
|
|
15294
|
+
description:
|
|
15295
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15296
|
+
type: 'string',
|
|
15297
|
+
},
|
|
14393
15298
|
warning_code: {
|
|
14394
15299
|
description:
|
|
14395
15300
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -16434,40 +17339,98 @@ export default {
|
|
|
16434
17339
|
paths: {
|
|
16435
17340
|
'/access_codes/create': {
|
|
16436
17341
|
post: {
|
|
17342
|
+
description:
|
|
17343
|
+
'Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
16437
17344
|
operationId: 'accessCodesCreatePost',
|
|
16438
17345
|
requestBody: {
|
|
16439
17346
|
content: {
|
|
16440
17347
|
'application/json': {
|
|
16441
17348
|
schema: {
|
|
16442
17349
|
properties: {
|
|
16443
|
-
allow_external_modification: {
|
|
17350
|
+
allow_external_modification: {
|
|
17351
|
+
description:
|
|
17352
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17353
|
+
type: 'boolean',
|
|
17354
|
+
},
|
|
16444
17355
|
attempt_for_offline_device: {
|
|
16445
17356
|
default: true,
|
|
16446
17357
|
type: 'boolean',
|
|
16447
17358
|
},
|
|
16448
|
-
code: {
|
|
16449
|
-
|
|
16450
|
-
|
|
16451
|
-
|
|
17359
|
+
code: {
|
|
17360
|
+
description: 'Code to be used for access.',
|
|
17361
|
+
maxLength: 9,
|
|
17362
|
+
minLength: 4,
|
|
17363
|
+
pattern: '^\\d+$',
|
|
17364
|
+
type: 'string',
|
|
17365
|
+
},
|
|
17366
|
+
common_code_key: {
|
|
17367
|
+
description:
|
|
17368
|
+
'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).',
|
|
17369
|
+
type: 'string',
|
|
17370
|
+
},
|
|
17371
|
+
device_id: {
|
|
17372
|
+
description:
|
|
17373
|
+
'ID of the device for which to create the new access code.',
|
|
17374
|
+
format: 'uuid',
|
|
17375
|
+
type: 'string',
|
|
17376
|
+
},
|
|
17377
|
+
ends_at: {
|
|
17378
|
+
description:
|
|
17379
|
+
'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`.',
|
|
16452
17380
|
type: 'string',
|
|
16453
17381
|
},
|
|
16454
|
-
|
|
16455
|
-
|
|
16456
|
-
|
|
16457
|
-
|
|
16458
|
-
|
|
16459
|
-
|
|
17382
|
+
is_external_modification_allowed: {
|
|
17383
|
+
description:
|
|
17384
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17385
|
+
type: 'boolean',
|
|
17386
|
+
},
|
|
17387
|
+
is_offline_access_code: {
|
|
17388
|
+
description:
|
|
17389
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17390
|
+
type: 'boolean',
|
|
17391
|
+
},
|
|
17392
|
+
is_one_time_use: {
|
|
17393
|
+
description:
|
|
17394
|
+
'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.',
|
|
17395
|
+
type: 'boolean',
|
|
17396
|
+
},
|
|
16460
17397
|
max_time_rounding: {
|
|
16461
17398
|
default: '1hour',
|
|
17399
|
+
description:
|
|
17400
|
+
'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`.',
|
|
16462
17401
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16463
17402
|
type: 'string',
|
|
16464
17403
|
},
|
|
16465
|
-
name: {
|
|
16466
|
-
|
|
16467
|
-
|
|
16468
|
-
|
|
16469
|
-
|
|
16470
|
-
|
|
17404
|
+
name: {
|
|
17405
|
+
description: 'Name of the new access code.',
|
|
17406
|
+
type: 'string',
|
|
17407
|
+
},
|
|
17408
|
+
prefer_native_scheduling: {
|
|
17409
|
+
description:
|
|
17410
|
+
'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`.',
|
|
17411
|
+
type: 'boolean',
|
|
17412
|
+
},
|
|
17413
|
+
preferred_code_length: {
|
|
17414
|
+
description:
|
|
17415
|
+
'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.',
|
|
17416
|
+
format: 'float',
|
|
17417
|
+
type: 'number',
|
|
17418
|
+
},
|
|
17419
|
+
starts_at: {
|
|
17420
|
+
description:
|
|
17421
|
+
'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.',
|
|
17422
|
+
type: 'string',
|
|
17423
|
+
},
|
|
17424
|
+
sync: {
|
|
17425
|
+
default: false,
|
|
17426
|
+
type: 'boolean',
|
|
17427
|
+
'x-undocumented': 'Only used internally.',
|
|
17428
|
+
},
|
|
17429
|
+
use_backup_access_code_pool: {
|
|
17430
|
+
description:
|
|
17431
|
+
'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).',
|
|
17432
|
+
type: 'boolean',
|
|
17433
|
+
},
|
|
16471
17434
|
use_offline_access_code: { type: 'boolean' },
|
|
16472
17435
|
},
|
|
16473
17436
|
required: ['device_id'],
|
|
@@ -16511,50 +17474,100 @@ export default {
|
|
|
16511
17474
|
'x-fern-sdk-method-name': 'create',
|
|
16512
17475
|
'x-fern-sdk-return-value': 'access_code',
|
|
16513
17476
|
'x-response-key': 'access_code',
|
|
17477
|
+
'x-title': 'Create an Access Code',
|
|
16514
17478
|
},
|
|
16515
17479
|
},
|
|
16516
17480
|
'/access_codes/create_multiple': {
|
|
16517
17481
|
post: {
|
|
17482
|
+
description:
|
|
17483
|
+
'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).',
|
|
16518
17484
|
operationId: 'accessCodesCreateMultiplePost',
|
|
16519
17485
|
requestBody: {
|
|
16520
17486
|
content: {
|
|
16521
17487
|
'application/json': {
|
|
16522
17488
|
schema: {
|
|
16523
17489
|
properties: {
|
|
16524
|
-
allow_external_modification: {
|
|
17490
|
+
allow_external_modification: {
|
|
17491
|
+
description:
|
|
17492
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17493
|
+
type: 'boolean',
|
|
17494
|
+
},
|
|
16525
17495
|
attempt_for_offline_device: {
|
|
16526
17496
|
default: true,
|
|
16527
17497
|
type: 'boolean',
|
|
16528
17498
|
},
|
|
16529
17499
|
behavior_when_code_cannot_be_shared: {
|
|
16530
17500
|
default: 'throw',
|
|
17501
|
+
description:
|
|
17502
|
+
'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.',
|
|
16531
17503
|
enum: ['throw', 'create_random_code'],
|
|
16532
17504
|
type: 'string',
|
|
16533
17505
|
},
|
|
16534
17506
|
code: {
|
|
17507
|
+
description: 'Code to be used for access.',
|
|
16535
17508
|
maxLength: 9,
|
|
16536
17509
|
minLength: 4,
|
|
16537
17510
|
pattern: '^\\d+$',
|
|
16538
17511
|
type: 'string',
|
|
16539
17512
|
},
|
|
16540
17513
|
device_ids: {
|
|
17514
|
+
description:
|
|
17515
|
+
'IDs of the devices for which to create the new access codes.',
|
|
16541
17516
|
items: { format: 'uuid', type: 'string' },
|
|
16542
17517
|
type: 'array',
|
|
16543
17518
|
},
|
|
16544
|
-
ends_at: {
|
|
16545
|
-
|
|
16546
|
-
|
|
16547
|
-
|
|
17519
|
+
ends_at: {
|
|
17520
|
+
description:
|
|
17521
|
+
'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`.',
|
|
17522
|
+
type: 'string',
|
|
17523
|
+
},
|
|
17524
|
+
is_external_modification_allowed: {
|
|
17525
|
+
description:
|
|
17526
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17527
|
+
type: 'boolean',
|
|
17528
|
+
},
|
|
17529
|
+
is_offline_access_code: {
|
|
17530
|
+
description:
|
|
17531
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17532
|
+
type: 'boolean',
|
|
17533
|
+
},
|
|
17534
|
+
is_one_time_use: {
|
|
17535
|
+
description:
|
|
17536
|
+
'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.',
|
|
17537
|
+
type: 'boolean',
|
|
17538
|
+
},
|
|
16548
17539
|
max_time_rounding: {
|
|
16549
17540
|
default: '1hour',
|
|
17541
|
+
description:
|
|
17542
|
+
'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`.',
|
|
16550
17543
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16551
17544
|
type: 'string',
|
|
16552
17545
|
},
|
|
16553
|
-
name: {
|
|
16554
|
-
|
|
16555
|
-
|
|
16556
|
-
|
|
16557
|
-
|
|
17546
|
+
name: {
|
|
17547
|
+
description: 'Name of the new access code.',
|
|
17548
|
+
type: 'string',
|
|
17549
|
+
},
|
|
17550
|
+
prefer_native_scheduling: {
|
|
17551
|
+
description:
|
|
17552
|
+
'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`.',
|
|
17553
|
+
type: 'boolean',
|
|
17554
|
+
},
|
|
17555
|
+
preferred_code_length: {
|
|
17556
|
+
description:
|
|
17557
|
+
'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.',
|
|
17558
|
+
format: 'float',
|
|
17559
|
+
type: 'number',
|
|
17560
|
+
},
|
|
17561
|
+
starts_at: {
|
|
17562
|
+
description:
|
|
17563
|
+
'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.',
|
|
17564
|
+
type: 'string',
|
|
17565
|
+
},
|
|
17566
|
+
use_backup_access_code_pool: {
|
|
17567
|
+
description:
|
|
17568
|
+
'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).',
|
|
17569
|
+
type: 'boolean',
|
|
17570
|
+
},
|
|
16558
17571
|
use_offline_access_code: { type: 'boolean' },
|
|
16559
17572
|
},
|
|
16560
17573
|
required: ['device_ids'],
|
|
@@ -16597,48 +17610,98 @@ export default {
|
|
|
16597
17610
|
'x-fern-sdk-method-name': 'create_multiple',
|
|
16598
17611
|
'x-fern-sdk-return-value': 'access_codes',
|
|
16599
17612
|
'x-response-key': 'access_codes',
|
|
17613
|
+
'x-title': 'Create Multiple Linked Access Codes',
|
|
16600
17614
|
},
|
|
16601
17615
|
put: {
|
|
17616
|
+
description:
|
|
17617
|
+
'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).',
|
|
16602
17618
|
operationId: 'accessCodesCreateMultiplePut',
|
|
16603
17619
|
requestBody: {
|
|
16604
17620
|
content: {
|
|
16605
17621
|
'application/json': {
|
|
16606
17622
|
schema: {
|
|
16607
17623
|
properties: {
|
|
16608
|
-
allow_external_modification: {
|
|
17624
|
+
allow_external_modification: {
|
|
17625
|
+
description:
|
|
17626
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17627
|
+
type: 'boolean',
|
|
17628
|
+
},
|
|
16609
17629
|
attempt_for_offline_device: {
|
|
16610
17630
|
default: true,
|
|
16611
17631
|
type: 'boolean',
|
|
16612
17632
|
},
|
|
16613
17633
|
behavior_when_code_cannot_be_shared: {
|
|
16614
17634
|
default: 'throw',
|
|
17635
|
+
description:
|
|
17636
|
+
'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.',
|
|
16615
17637
|
enum: ['throw', 'create_random_code'],
|
|
16616
17638
|
type: 'string',
|
|
16617
17639
|
},
|
|
16618
17640
|
code: {
|
|
17641
|
+
description: 'Code to be used for access.',
|
|
16619
17642
|
maxLength: 9,
|
|
16620
17643
|
minLength: 4,
|
|
16621
17644
|
pattern: '^\\d+$',
|
|
16622
17645
|
type: 'string',
|
|
16623
17646
|
},
|
|
16624
17647
|
device_ids: {
|
|
17648
|
+
description:
|
|
17649
|
+
'IDs of the devices for which to create the new access codes.',
|
|
16625
17650
|
items: { format: 'uuid', type: 'string' },
|
|
16626
17651
|
type: 'array',
|
|
16627
17652
|
},
|
|
16628
|
-
ends_at: {
|
|
16629
|
-
|
|
16630
|
-
|
|
16631
|
-
|
|
17653
|
+
ends_at: {
|
|
17654
|
+
description:
|
|
17655
|
+
'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`.',
|
|
17656
|
+
type: 'string',
|
|
17657
|
+
},
|
|
17658
|
+
is_external_modification_allowed: {
|
|
17659
|
+
description:
|
|
17660
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17661
|
+
type: 'boolean',
|
|
17662
|
+
},
|
|
17663
|
+
is_offline_access_code: {
|
|
17664
|
+
description:
|
|
17665
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17666
|
+
type: 'boolean',
|
|
17667
|
+
},
|
|
17668
|
+
is_one_time_use: {
|
|
17669
|
+
description:
|
|
17670
|
+
'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.',
|
|
17671
|
+
type: 'boolean',
|
|
17672
|
+
},
|
|
16632
17673
|
max_time_rounding: {
|
|
16633
17674
|
default: '1hour',
|
|
17675
|
+
description:
|
|
17676
|
+
'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`.',
|
|
16634
17677
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16635
17678
|
type: 'string',
|
|
16636
17679
|
},
|
|
16637
|
-
name: {
|
|
16638
|
-
|
|
16639
|
-
|
|
16640
|
-
|
|
16641
|
-
|
|
17680
|
+
name: {
|
|
17681
|
+
description: 'Name of the new access code.',
|
|
17682
|
+
type: 'string',
|
|
17683
|
+
},
|
|
17684
|
+
prefer_native_scheduling: {
|
|
17685
|
+
description:
|
|
17686
|
+
'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`.',
|
|
17687
|
+
type: 'boolean',
|
|
17688
|
+
},
|
|
17689
|
+
preferred_code_length: {
|
|
17690
|
+
description:
|
|
17691
|
+
'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.',
|
|
17692
|
+
format: 'float',
|
|
17693
|
+
type: 'number',
|
|
17694
|
+
},
|
|
17695
|
+
starts_at: {
|
|
17696
|
+
description:
|
|
17697
|
+
'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.',
|
|
17698
|
+
type: 'string',
|
|
17699
|
+
},
|
|
17700
|
+
use_backup_access_code_pool: {
|
|
17701
|
+
description:
|
|
17702
|
+
'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).',
|
|
17703
|
+
type: 'boolean',
|
|
17704
|
+
},
|
|
16642
17705
|
use_offline_access_code: { type: 'boolean' },
|
|
16643
17706
|
},
|
|
16644
17707
|
required: ['device_ids'],
|
|
@@ -16679,19 +17742,35 @@ export default {
|
|
|
16679
17742
|
tags: ['/access_codes'],
|
|
16680
17743
|
'x-fern-ignore': true,
|
|
16681
17744
|
'x-response-key': 'access_codes',
|
|
17745
|
+
'x-title': 'Create Multiple Linked Access Codes',
|
|
16682
17746
|
},
|
|
16683
17747
|
},
|
|
16684
17748
|
'/access_codes/delete': {
|
|
16685
17749
|
post: {
|
|
17750
|
+
description:
|
|
17751
|
+
'Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
16686
17752
|
operationId: 'accessCodesDeletePost',
|
|
16687
17753
|
requestBody: {
|
|
16688
17754
|
content: {
|
|
16689
17755
|
'application/json': {
|
|
16690
17756
|
schema: {
|
|
16691
17757
|
properties: {
|
|
16692
|
-
access_code_id: {
|
|
16693
|
-
|
|
16694
|
-
|
|
17758
|
+
access_code_id: {
|
|
17759
|
+
description: 'ID of the access code to delete.',
|
|
17760
|
+
format: 'uuid',
|
|
17761
|
+
type: 'string',
|
|
17762
|
+
},
|
|
17763
|
+
device_id: {
|
|
17764
|
+
description:
|
|
17765
|
+
'ID of the device for which to delete the access code.',
|
|
17766
|
+
format: 'uuid',
|
|
17767
|
+
type: 'string',
|
|
17768
|
+
},
|
|
17769
|
+
sync: {
|
|
17770
|
+
default: false,
|
|
17771
|
+
type: 'boolean',
|
|
17772
|
+
'x-undocumented': 'Only used internally.',
|
|
17773
|
+
},
|
|
16695
17774
|
},
|
|
16696
17775
|
required: ['access_code_id'],
|
|
16697
17776
|
type: 'object',
|
|
@@ -16732,6 +17811,7 @@ export default {
|
|
|
16732
17811
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
16733
17812
|
'x-fern-sdk-method-name': 'delete',
|
|
16734
17813
|
'x-response-key': null,
|
|
17814
|
+
'x-title': 'Delete an Access Code',
|
|
16735
17815
|
},
|
|
16736
17816
|
},
|
|
16737
17817
|
'/access_codes/generate_code': {
|
|
@@ -16785,15 +17865,31 @@ export default {
|
|
|
16785
17865
|
},
|
|
16786
17866
|
'/access_codes/get': {
|
|
16787
17867
|
post: {
|
|
17868
|
+
description:
|
|
17869
|
+
'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`.',
|
|
16788
17870
|
operationId: 'accessCodesGetPost',
|
|
16789
17871
|
requestBody: {
|
|
16790
17872
|
content: {
|
|
16791
17873
|
'application/json': {
|
|
16792
17874
|
schema: {
|
|
16793
17875
|
properties: {
|
|
16794
|
-
access_code_id: {
|
|
16795
|
-
|
|
16796
|
-
|
|
17876
|
+
access_code_id: {
|
|
17877
|
+
description:
|
|
17878
|
+
'ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
17879
|
+
format: 'uuid',
|
|
17880
|
+
type: 'string',
|
|
17881
|
+
},
|
|
17882
|
+
code: {
|
|
17883
|
+
description:
|
|
17884
|
+
'Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
17885
|
+
type: 'string',
|
|
17886
|
+
},
|
|
17887
|
+
device_id: {
|
|
17888
|
+
description:
|
|
17889
|
+
'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`.',
|
|
17890
|
+
format: 'uuid',
|
|
17891
|
+
type: 'string',
|
|
17892
|
+
},
|
|
16797
17893
|
},
|
|
16798
17894
|
type: 'object',
|
|
16799
17895
|
},
|
|
@@ -16831,10 +17927,13 @@ export default {
|
|
|
16831
17927
|
'x-fern-sdk-method-name': 'get',
|
|
16832
17928
|
'x-fern-sdk-return-value': 'access_code',
|
|
16833
17929
|
'x-response-key': 'access_code',
|
|
17930
|
+
'x-title': 'Get an Access Code',
|
|
16834
17931
|
},
|
|
16835
17932
|
},
|
|
16836
17933
|
'/access_codes/list': {
|
|
16837
17934
|
post: {
|
|
17935
|
+
description:
|
|
17936
|
+
'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`.',
|
|
16838
17937
|
operationId: 'accessCodesListPost',
|
|
16839
17938
|
requestBody: {
|
|
16840
17939
|
content: {
|
|
@@ -16842,11 +17941,22 @@ export default {
|
|
|
16842
17941
|
schema: {
|
|
16843
17942
|
properties: {
|
|
16844
17943
|
access_code_ids: {
|
|
17944
|
+
description:
|
|
17945
|
+
'IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.',
|
|
16845
17946
|
items: { format: 'uuid', type: 'string' },
|
|
16846
17947
|
type: 'array',
|
|
16847
17948
|
},
|
|
16848
|
-
device_id: {
|
|
16849
|
-
|
|
17949
|
+
device_id: {
|
|
17950
|
+
description:
|
|
17951
|
+
'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
|
|
17952
|
+
format: 'uuid',
|
|
17953
|
+
type: 'string',
|
|
17954
|
+
},
|
|
17955
|
+
user_identifier_key: {
|
|
17956
|
+
description:
|
|
17957
|
+
'Your user ID for the user by which to filter access codes.',
|
|
17958
|
+
type: 'string',
|
|
17959
|
+
},
|
|
16850
17960
|
},
|
|
16851
17961
|
type: 'object',
|
|
16852
17962
|
},
|
|
@@ -16887,19 +17997,25 @@ export default {
|
|
|
16887
17997
|
'x-fern-sdk-method-name': 'list',
|
|
16888
17998
|
'x-fern-sdk-return-value': 'access_codes',
|
|
16889
17999
|
'x-response-key': 'access_codes',
|
|
18000
|
+
'x-title': 'List Access Codes',
|
|
16890
18001
|
},
|
|
16891
18002
|
},
|
|
16892
18003
|
'/access_codes/pull_backup_access_code': {
|
|
16893
18004
|
post: {
|
|
16894
18005
|
description:
|
|
16895
|
-
|
|
18006
|
+
"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.",
|
|
16896
18007
|
operationId: 'accessCodesPullBackupAccessCodePost',
|
|
16897
18008
|
requestBody: {
|
|
16898
18009
|
content: {
|
|
16899
18010
|
'application/json': {
|
|
16900
18011
|
schema: {
|
|
16901
18012
|
properties: {
|
|
16902
|
-
access_code_id: {
|
|
18013
|
+
access_code_id: {
|
|
18014
|
+
description:
|
|
18015
|
+
'ID of the access code for which you want to pull a backup access code.',
|
|
18016
|
+
format: 'uuid',
|
|
18017
|
+
type: 'string',
|
|
18018
|
+
},
|
|
16903
18019
|
},
|
|
16904
18020
|
required: ['access_code_id'],
|
|
16905
18021
|
type: 'object',
|
|
@@ -16941,10 +18057,13 @@ export default {
|
|
|
16941
18057
|
'x-fern-sdk-method-name': 'pull_backup_access_code',
|
|
16942
18058
|
'x-fern-sdk-return-value': 'access_code',
|
|
16943
18059
|
'x-response-key': 'access_code',
|
|
18060
|
+
'x-title': 'Pull a Backup Access Code',
|
|
16944
18061
|
},
|
|
16945
18062
|
},
|
|
16946
18063
|
'/access_codes/simulate/create_unmanaged_access_code': {
|
|
16947
18064
|
post: {
|
|
18065
|
+
description:
|
|
18066
|
+
'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).',
|
|
16948
18067
|
operationId: 'accessCodesSimulateCreateUnmanagedAccessCodePost',
|
|
16949
18068
|
requestBody: {
|
|
16950
18069
|
content: {
|
|
@@ -16952,13 +18071,22 @@ export default {
|
|
|
16952
18071
|
schema: {
|
|
16953
18072
|
properties: {
|
|
16954
18073
|
code: {
|
|
18074
|
+
description: 'Code of the simulated unmanaged access code.',
|
|
16955
18075
|
maxLength: 8,
|
|
16956
18076
|
minLength: 4,
|
|
16957
18077
|
pattern: '^\\d+$',
|
|
16958
18078
|
type: 'string',
|
|
16959
18079
|
},
|
|
16960
|
-
device_id: {
|
|
16961
|
-
|
|
18080
|
+
device_id: {
|
|
18081
|
+
description:
|
|
18082
|
+
'ID of the device for which you want to simulate the creation of an unmanaged access code.',
|
|
18083
|
+
format: 'uuid',
|
|
18084
|
+
type: 'string',
|
|
18085
|
+
},
|
|
18086
|
+
name: {
|
|
18087
|
+
description: 'Name of the simulated unmanaged access code.',
|
|
18088
|
+
type: 'string',
|
|
18089
|
+
},
|
|
16962
18090
|
},
|
|
16963
18091
|
required: ['device_id', 'name', 'code'],
|
|
16964
18092
|
type: 'object',
|
|
@@ -16999,21 +18127,45 @@ export default {
|
|
|
16999
18127
|
'x-fern-sdk-method-name': 'create_unmanaged_access_code',
|
|
17000
18128
|
'x-fern-sdk-return-value': 'access_code',
|
|
17001
18129
|
'x-response-key': 'access_code',
|
|
18130
|
+
'x-title': 'Simulate Creating an Unmanaged Access Code',
|
|
17002
18131
|
},
|
|
17003
18132
|
},
|
|
17004
18133
|
'/access_codes/unmanaged/convert_to_managed': {
|
|
17005
18134
|
patch: {
|
|
18135
|
+
description:
|
|
18136
|
+
'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.',
|
|
17006
18137
|
operationId: 'accessCodesUnmanagedConvertToManagedPatch',
|
|
17007
18138
|
requestBody: {
|
|
17008
18139
|
content: {
|
|
17009
18140
|
'application/json': {
|
|
17010
18141
|
schema: {
|
|
17011
18142
|
properties: {
|
|
17012
|
-
access_code_id: {
|
|
17013
|
-
|
|
17014
|
-
|
|
17015
|
-
|
|
17016
|
-
|
|
18143
|
+
access_code_id: {
|
|
18144
|
+
description:
|
|
18145
|
+
'ID of the unmanaged access code that you want to convert to a managed access code.',
|
|
18146
|
+
format: 'uuid',
|
|
18147
|
+
type: 'string',
|
|
18148
|
+
},
|
|
18149
|
+
allow_external_modification: {
|
|
18150
|
+
description:
|
|
18151
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18152
|
+
type: 'boolean',
|
|
18153
|
+
},
|
|
18154
|
+
force: {
|
|
18155
|
+
description:
|
|
18156
|
+
'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`.',
|
|
18157
|
+
type: 'boolean',
|
|
18158
|
+
},
|
|
18159
|
+
is_external_modification_allowed: {
|
|
18160
|
+
description:
|
|
18161
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18162
|
+
type: 'boolean',
|
|
18163
|
+
},
|
|
18164
|
+
sync: {
|
|
18165
|
+
default: false,
|
|
18166
|
+
type: 'boolean',
|
|
18167
|
+
'x-undocumented': 'Only used internally.',
|
|
18168
|
+
},
|
|
17017
18169
|
},
|
|
17018
18170
|
required: ['access_code_id'],
|
|
17019
18171
|
type: 'object',
|
|
@@ -17048,19 +18200,43 @@ export default {
|
|
|
17048
18200
|
'x-action-attempt-type': 'CONVERT_ACCESS_CODE_TO_MANAGED',
|
|
17049
18201
|
'x-fern-ignore': true,
|
|
17050
18202
|
'x-response-key': null,
|
|
18203
|
+
'x-title': 'Convert an Unmanaged Access Code',
|
|
17051
18204
|
},
|
|
17052
18205
|
post: {
|
|
18206
|
+
description:
|
|
18207
|
+
'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.',
|
|
17053
18208
|
operationId: 'accessCodesUnmanagedConvertToManagedPost',
|
|
17054
18209
|
requestBody: {
|
|
17055
18210
|
content: {
|
|
17056
18211
|
'application/json': {
|
|
17057
18212
|
schema: {
|
|
17058
18213
|
properties: {
|
|
17059
|
-
access_code_id: {
|
|
17060
|
-
|
|
17061
|
-
|
|
17062
|
-
|
|
17063
|
-
|
|
18214
|
+
access_code_id: {
|
|
18215
|
+
description:
|
|
18216
|
+
'ID of the unmanaged access code that you want to convert to a managed access code.',
|
|
18217
|
+
format: 'uuid',
|
|
18218
|
+
type: 'string',
|
|
18219
|
+
},
|
|
18220
|
+
allow_external_modification: {
|
|
18221
|
+
description:
|
|
18222
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18223
|
+
type: 'boolean',
|
|
18224
|
+
},
|
|
18225
|
+
force: {
|
|
18226
|
+
description:
|
|
18227
|
+
'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`.',
|
|
18228
|
+
type: 'boolean',
|
|
18229
|
+
},
|
|
18230
|
+
is_external_modification_allowed: {
|
|
18231
|
+
description:
|
|
18232
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18233
|
+
type: 'boolean',
|
|
18234
|
+
},
|
|
18235
|
+
sync: {
|
|
18236
|
+
default: false,
|
|
18237
|
+
type: 'boolean',
|
|
18238
|
+
'x-undocumented': 'Only used internally.',
|
|
18239
|
+
},
|
|
17064
18240
|
},
|
|
17065
18241
|
required: ['access_code_id'],
|
|
17066
18242
|
type: 'object',
|
|
@@ -17096,18 +18272,29 @@ export default {
|
|
|
17096
18272
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
17097
18273
|
'x-fern-sdk-method-name': 'convert_to_managed',
|
|
17098
18274
|
'x-response-key': null,
|
|
18275
|
+
'x-title': 'Convert an Unmanaged Access Code',
|
|
17099
18276
|
},
|
|
17100
18277
|
},
|
|
17101
18278
|
'/access_codes/unmanaged/delete': {
|
|
17102
18279
|
post: {
|
|
18280
|
+
description:
|
|
18281
|
+
'Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17103
18282
|
operationId: 'accessCodesUnmanagedDeletePost',
|
|
17104
18283
|
requestBody: {
|
|
17105
18284
|
content: {
|
|
17106
18285
|
'application/json': {
|
|
17107
18286
|
schema: {
|
|
17108
18287
|
properties: {
|
|
17109
|
-
access_code_id: {
|
|
17110
|
-
|
|
18288
|
+
access_code_id: {
|
|
18289
|
+
description: 'ID of the unmanaged access code to delete.',
|
|
18290
|
+
format: 'uuid',
|
|
18291
|
+
type: 'string',
|
|
18292
|
+
},
|
|
18293
|
+
sync: {
|
|
18294
|
+
default: false,
|
|
18295
|
+
type: 'boolean',
|
|
18296
|
+
'x-undocumented': 'Only used internally.',
|
|
18297
|
+
},
|
|
17111
18298
|
},
|
|
17112
18299
|
required: ['access_code_id'],
|
|
17113
18300
|
type: 'object',
|
|
@@ -17148,19 +18335,36 @@ export default {
|
|
|
17148
18335
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
17149
18336
|
'x-fern-sdk-method-name': 'delete',
|
|
17150
18337
|
'x-response-key': null,
|
|
18338
|
+
'x-title': 'Delete an Unmanaged Access Code',
|
|
17151
18339
|
},
|
|
17152
18340
|
},
|
|
17153
18341
|
'/access_codes/unmanaged/get': {
|
|
17154
18342
|
post: {
|
|
18343
|
+
description:
|
|
18344
|
+
'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`.',
|
|
17155
18345
|
operationId: 'accessCodesUnmanagedGetPost',
|
|
17156
18346
|
requestBody: {
|
|
17157
18347
|
content: {
|
|
17158
18348
|
'application/json': {
|
|
17159
18349
|
schema: {
|
|
17160
18350
|
properties: {
|
|
17161
|
-
access_code_id: {
|
|
17162
|
-
|
|
17163
|
-
|
|
18351
|
+
access_code_id: {
|
|
18352
|
+
description:
|
|
18353
|
+
'ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
18354
|
+
format: 'uuid',
|
|
18355
|
+
type: 'string',
|
|
18356
|
+
},
|
|
18357
|
+
code: {
|
|
18358
|
+
description:
|
|
18359
|
+
'Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
18360
|
+
type: 'string',
|
|
18361
|
+
},
|
|
18362
|
+
device_id: {
|
|
18363
|
+
description:
|
|
18364
|
+
'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`.',
|
|
18365
|
+
format: 'uuid',
|
|
18366
|
+
type: 'string',
|
|
18367
|
+
},
|
|
17164
18368
|
},
|
|
17165
18369
|
type: 'object',
|
|
17166
18370
|
},
|
|
@@ -17200,18 +18404,30 @@ export default {
|
|
|
17200
18404
|
'x-fern-sdk-method-name': 'get',
|
|
17201
18405
|
'x-fern-sdk-return-value': 'access_code',
|
|
17202
18406
|
'x-response-key': 'access_code',
|
|
18407
|
+
'x-title': 'Get an Unmanaged Access Code',
|
|
17203
18408
|
},
|
|
17204
18409
|
},
|
|
17205
18410
|
'/access_codes/unmanaged/list': {
|
|
17206
18411
|
post: {
|
|
18412
|
+
description:
|
|
18413
|
+
'Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17207
18414
|
operationId: 'accessCodesUnmanagedListPost',
|
|
17208
18415
|
requestBody: {
|
|
17209
18416
|
content: {
|
|
17210
18417
|
'application/json': {
|
|
17211
18418
|
schema: {
|
|
17212
18419
|
properties: {
|
|
17213
|
-
device_id: {
|
|
17214
|
-
|
|
18420
|
+
device_id: {
|
|
18421
|
+
description:
|
|
18422
|
+
'ID of the device for which you want to list unmanaged access codes.',
|
|
18423
|
+
format: 'uuid',
|
|
18424
|
+
type: 'string',
|
|
18425
|
+
},
|
|
18426
|
+
user_identifier_key: {
|
|
18427
|
+
description:
|
|
18428
|
+
'Your user ID for the user by which to filter unmanaged access codes.',
|
|
18429
|
+
type: 'string',
|
|
18430
|
+
},
|
|
17215
18431
|
},
|
|
17216
18432
|
required: ['device_id'],
|
|
17217
18433
|
type: 'object',
|
|
@@ -17255,20 +18471,40 @@ export default {
|
|
|
17255
18471
|
'x-fern-sdk-method-name': 'list',
|
|
17256
18472
|
'x-fern-sdk-return-value': 'access_codes',
|
|
17257
18473
|
'x-response-key': 'access_codes',
|
|
18474
|
+
'x-title': 'List Unmanaged Access Codes',
|
|
17258
18475
|
},
|
|
17259
18476
|
},
|
|
17260
18477
|
'/access_codes/unmanaged/update': {
|
|
17261
18478
|
patch: {
|
|
18479
|
+
description:
|
|
18480
|
+
'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17262
18481
|
operationId: 'accessCodesUnmanagedUpdatePatch',
|
|
17263
18482
|
requestBody: {
|
|
17264
18483
|
content: {
|
|
17265
18484
|
'application/json': {
|
|
17266
18485
|
schema: {
|
|
17267
18486
|
properties: {
|
|
17268
|
-
access_code_id: {
|
|
17269
|
-
|
|
17270
|
-
|
|
17271
|
-
|
|
18487
|
+
access_code_id: {
|
|
18488
|
+
description:
|
|
18489
|
+
'ID of the unmanaged access code that you want to update.',
|
|
18490
|
+
format: 'uuid',
|
|
18491
|
+
type: 'string',
|
|
18492
|
+
},
|
|
18493
|
+
allow_external_modification: {
|
|
18494
|
+
description:
|
|
18495
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18496
|
+
type: 'boolean',
|
|
18497
|
+
},
|
|
18498
|
+
force: {
|
|
18499
|
+
description:
|
|
18500
|
+
'Indicates whether to force the unmanaged access code update.',
|
|
18501
|
+
type: 'boolean',
|
|
18502
|
+
},
|
|
18503
|
+
is_external_modification_allowed: {
|
|
18504
|
+
description:
|
|
18505
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18506
|
+
type: 'boolean',
|
|
18507
|
+
},
|
|
17272
18508
|
is_managed: { type: 'boolean' },
|
|
17273
18509
|
},
|
|
17274
18510
|
required: ['access_code_id', 'is_managed'],
|
|
@@ -17303,18 +18539,38 @@ export default {
|
|
|
17303
18539
|
tags: ['/access_codes'],
|
|
17304
18540
|
'x-fern-ignore': true,
|
|
17305
18541
|
'x-response-key': null,
|
|
18542
|
+
'x-title': 'Update an Unmanaged Access Code',
|
|
17306
18543
|
},
|
|
17307
18544
|
post: {
|
|
18545
|
+
description:
|
|
18546
|
+
'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17308
18547
|
operationId: 'accessCodesUnmanagedUpdatePost',
|
|
17309
18548
|
requestBody: {
|
|
17310
18549
|
content: {
|
|
17311
18550
|
'application/json': {
|
|
17312
18551
|
schema: {
|
|
17313
18552
|
properties: {
|
|
17314
|
-
access_code_id: {
|
|
17315
|
-
|
|
17316
|
-
|
|
17317
|
-
|
|
18553
|
+
access_code_id: {
|
|
18554
|
+
description:
|
|
18555
|
+
'ID of the unmanaged access code that you want to update.',
|
|
18556
|
+
format: 'uuid',
|
|
18557
|
+
type: 'string',
|
|
18558
|
+
},
|
|
18559
|
+
allow_external_modification: {
|
|
18560
|
+
description:
|
|
18561
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18562
|
+
type: 'boolean',
|
|
18563
|
+
},
|
|
18564
|
+
force: {
|
|
18565
|
+
description:
|
|
18566
|
+
'Indicates whether to force the unmanaged access code update.',
|
|
18567
|
+
type: 'boolean',
|
|
18568
|
+
},
|
|
18569
|
+
is_external_modification_allowed: {
|
|
18570
|
+
description:
|
|
18571
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18572
|
+
type: 'boolean',
|
|
18573
|
+
},
|
|
17318
18574
|
is_managed: { type: 'boolean' },
|
|
17319
18575
|
},
|
|
17320
18576
|
required: ['access_code_id', 'is_managed'],
|
|
@@ -17350,46 +18606,115 @@ export default {
|
|
|
17350
18606
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
17351
18607
|
'x-fern-sdk-method-name': 'update',
|
|
17352
18608
|
'x-response-key': null,
|
|
18609
|
+
'x-title': 'Update an Unmanaged Access Code',
|
|
17353
18610
|
},
|
|
17354
18611
|
},
|
|
17355
18612
|
'/access_codes/update': {
|
|
17356
18613
|
patch: {
|
|
18614
|
+
description:
|
|
18615
|
+
'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).',
|
|
17357
18616
|
operationId: 'accessCodesUpdatePatch',
|
|
17358
18617
|
requestBody: {
|
|
17359
18618
|
content: {
|
|
17360
18619
|
'application/json': {
|
|
17361
18620
|
schema: {
|
|
17362
18621
|
properties: {
|
|
17363
|
-
access_code_id: {
|
|
17364
|
-
|
|
18622
|
+
access_code_id: {
|
|
18623
|
+
description:
|
|
18624
|
+
'ID of the access code that you want to update.',
|
|
18625
|
+
format: 'uuid',
|
|
18626
|
+
type: 'string',
|
|
18627
|
+
},
|
|
18628
|
+
allow_external_modification: {
|
|
18629
|
+
description:
|
|
18630
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18631
|
+
type: 'boolean',
|
|
18632
|
+
},
|
|
17365
18633
|
attempt_for_offline_device: {
|
|
17366
18634
|
default: true,
|
|
17367
18635
|
type: 'boolean',
|
|
17368
18636
|
},
|
|
17369
18637
|
code: {
|
|
18638
|
+
description: 'Code to be used for access.',
|
|
17370
18639
|
maxLength: 9,
|
|
17371
18640
|
minLength: 4,
|
|
17372
18641
|
pattern: '^\\d+$',
|
|
17373
18642
|
type: 'string',
|
|
17374
18643
|
},
|
|
17375
|
-
device_id: {
|
|
17376
|
-
|
|
17377
|
-
|
|
17378
|
-
|
|
17379
|
-
|
|
17380
|
-
|
|
18644
|
+
device_id: {
|
|
18645
|
+
description:
|
|
18646
|
+
'ID of the device containing the access code that you want to update.',
|
|
18647
|
+
format: 'uuid',
|
|
18648
|
+
type: 'string',
|
|
18649
|
+
},
|
|
18650
|
+
ends_at: {
|
|
18651
|
+
description:
|
|
18652
|
+
'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`.',
|
|
18653
|
+
type: 'string',
|
|
18654
|
+
},
|
|
18655
|
+
is_external_modification_allowed: {
|
|
18656
|
+
description:
|
|
18657
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18658
|
+
type: 'boolean',
|
|
18659
|
+
},
|
|
18660
|
+
is_managed: {
|
|
18661
|
+
description:
|
|
18662
|
+
'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`.',
|
|
18663
|
+
type: 'boolean',
|
|
18664
|
+
},
|
|
18665
|
+
is_offline_access_code: {
|
|
18666
|
+
description:
|
|
18667
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
18668
|
+
type: 'boolean',
|
|
18669
|
+
},
|
|
18670
|
+
is_one_time_use: {
|
|
18671
|
+
description:
|
|
18672
|
+
'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.',
|
|
18673
|
+
type: 'boolean',
|
|
18674
|
+
},
|
|
17381
18675
|
max_time_rounding: {
|
|
17382
18676
|
default: '1hour',
|
|
18677
|
+
description:
|
|
18678
|
+
'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`.',
|
|
17383
18679
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
17384
18680
|
type: 'string',
|
|
17385
18681
|
},
|
|
17386
|
-
name: {
|
|
17387
|
-
|
|
17388
|
-
|
|
17389
|
-
|
|
17390
|
-
|
|
17391
|
-
|
|
17392
|
-
|
|
18682
|
+
name: {
|
|
18683
|
+
description: 'Name of the new access code.',
|
|
18684
|
+
type: 'string',
|
|
18685
|
+
},
|
|
18686
|
+
prefer_native_scheduling: {
|
|
18687
|
+
description:
|
|
18688
|
+
'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`.',
|
|
18689
|
+
type: 'boolean',
|
|
18690
|
+
},
|
|
18691
|
+
preferred_code_length: {
|
|
18692
|
+
description:
|
|
18693
|
+
'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.',
|
|
18694
|
+
format: 'float',
|
|
18695
|
+
type: 'number',
|
|
18696
|
+
},
|
|
18697
|
+
starts_at: {
|
|
18698
|
+
description:
|
|
18699
|
+
'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.',
|
|
18700
|
+
type: 'string',
|
|
18701
|
+
},
|
|
18702
|
+
sync: {
|
|
18703
|
+
default: false,
|
|
18704
|
+
type: 'boolean',
|
|
18705
|
+
'x-undocumented': 'Only used internally.',
|
|
18706
|
+
},
|
|
18707
|
+
type: {
|
|
18708
|
+
description:
|
|
18709
|
+
'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).',
|
|
18710
|
+
enum: ['ongoing', 'time_bound'],
|
|
18711
|
+
type: 'string',
|
|
18712
|
+
},
|
|
18713
|
+
use_backup_access_code_pool: {
|
|
18714
|
+
description:
|
|
18715
|
+
'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).',
|
|
18716
|
+
type: 'boolean',
|
|
18717
|
+
},
|
|
17393
18718
|
use_offline_access_code: { type: 'boolean' },
|
|
17394
18719
|
},
|
|
17395
18720
|
required: ['access_code_id'],
|
|
@@ -17430,44 +18755,113 @@ export default {
|
|
|
17430
18755
|
'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
|
|
17431
18756
|
'x-fern-ignore': true,
|
|
17432
18757
|
'x-response-key': null,
|
|
18758
|
+
'x-title': 'Update an Access Code',
|
|
17433
18759
|
},
|
|
17434
18760
|
post: {
|
|
18761
|
+
description:
|
|
18762
|
+
'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).',
|
|
17435
18763
|
operationId: 'accessCodesUpdatePost',
|
|
17436
18764
|
requestBody: {
|
|
17437
18765
|
content: {
|
|
17438
18766
|
'application/json': {
|
|
17439
18767
|
schema: {
|
|
17440
18768
|
properties: {
|
|
17441
|
-
access_code_id: {
|
|
17442
|
-
|
|
18769
|
+
access_code_id: {
|
|
18770
|
+
description:
|
|
18771
|
+
'ID of the access code that you want to update.',
|
|
18772
|
+
format: 'uuid',
|
|
18773
|
+
type: 'string',
|
|
18774
|
+
},
|
|
18775
|
+
allow_external_modification: {
|
|
18776
|
+
description:
|
|
18777
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18778
|
+
type: 'boolean',
|
|
18779
|
+
},
|
|
17443
18780
|
attempt_for_offline_device: {
|
|
17444
18781
|
default: true,
|
|
17445
18782
|
type: 'boolean',
|
|
17446
18783
|
},
|
|
17447
18784
|
code: {
|
|
18785
|
+
description: 'Code to be used for access.',
|
|
17448
18786
|
maxLength: 9,
|
|
17449
18787
|
minLength: 4,
|
|
17450
18788
|
pattern: '^\\d+$',
|
|
17451
18789
|
type: 'string',
|
|
17452
18790
|
},
|
|
17453
|
-
device_id: {
|
|
17454
|
-
|
|
17455
|
-
|
|
17456
|
-
|
|
17457
|
-
|
|
17458
|
-
|
|
18791
|
+
device_id: {
|
|
18792
|
+
description:
|
|
18793
|
+
'ID of the device containing the access code that you want to update.',
|
|
18794
|
+
format: 'uuid',
|
|
18795
|
+
type: 'string',
|
|
18796
|
+
},
|
|
18797
|
+
ends_at: {
|
|
18798
|
+
description:
|
|
18799
|
+
'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`.',
|
|
18800
|
+
type: 'string',
|
|
18801
|
+
},
|
|
18802
|
+
is_external_modification_allowed: {
|
|
18803
|
+
description:
|
|
18804
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18805
|
+
type: 'boolean',
|
|
18806
|
+
},
|
|
18807
|
+
is_managed: {
|
|
18808
|
+
description:
|
|
18809
|
+
'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`.',
|
|
18810
|
+
type: 'boolean',
|
|
18811
|
+
},
|
|
18812
|
+
is_offline_access_code: {
|
|
18813
|
+
description:
|
|
18814
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
18815
|
+
type: 'boolean',
|
|
18816
|
+
},
|
|
18817
|
+
is_one_time_use: {
|
|
18818
|
+
description:
|
|
18819
|
+
'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.',
|
|
18820
|
+
type: 'boolean',
|
|
18821
|
+
},
|
|
17459
18822
|
max_time_rounding: {
|
|
17460
18823
|
default: '1hour',
|
|
18824
|
+
description:
|
|
18825
|
+
'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`.',
|
|
17461
18826
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
17462
18827
|
type: 'string',
|
|
17463
18828
|
},
|
|
17464
|
-
name: {
|
|
17465
|
-
|
|
17466
|
-
|
|
17467
|
-
|
|
17468
|
-
|
|
17469
|
-
|
|
17470
|
-
|
|
18829
|
+
name: {
|
|
18830
|
+
description: 'Name of the new access code.',
|
|
18831
|
+
type: 'string',
|
|
18832
|
+
},
|
|
18833
|
+
prefer_native_scheduling: {
|
|
18834
|
+
description:
|
|
18835
|
+
'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`.',
|
|
18836
|
+
type: 'boolean',
|
|
18837
|
+
},
|
|
18838
|
+
preferred_code_length: {
|
|
18839
|
+
description:
|
|
18840
|
+
'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.',
|
|
18841
|
+
format: 'float',
|
|
18842
|
+
type: 'number',
|
|
18843
|
+
},
|
|
18844
|
+
starts_at: {
|
|
18845
|
+
description:
|
|
18846
|
+
'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.',
|
|
18847
|
+
type: 'string',
|
|
18848
|
+
},
|
|
18849
|
+
sync: {
|
|
18850
|
+
default: false,
|
|
18851
|
+
type: 'boolean',
|
|
18852
|
+
'x-undocumented': 'Only used internally.',
|
|
18853
|
+
},
|
|
18854
|
+
type: {
|
|
18855
|
+
description:
|
|
18856
|
+
'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).',
|
|
18857
|
+
enum: ['ongoing', 'time_bound'],
|
|
18858
|
+
type: 'string',
|
|
18859
|
+
},
|
|
18860
|
+
use_backup_access_code_pool: {
|
|
18861
|
+
description:
|
|
18862
|
+
'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).',
|
|
18863
|
+
type: 'boolean',
|
|
18864
|
+
},
|
|
17471
18865
|
use_offline_access_code: { type: 'boolean' },
|
|
17472
18866
|
},
|
|
17473
18867
|
required: ['access_code_id'],
|
|
@@ -17509,44 +18903,113 @@ export default {
|
|
|
17509
18903
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
17510
18904
|
'x-fern-sdk-method-name': 'update',
|
|
17511
18905
|
'x-response-key': null,
|
|
18906
|
+
'x-title': 'Update an Access Code',
|
|
17512
18907
|
},
|
|
17513
18908
|
put: {
|
|
18909
|
+
description:
|
|
18910
|
+
'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).',
|
|
17514
18911
|
operationId: 'accessCodesUpdatePut',
|
|
17515
18912
|
requestBody: {
|
|
17516
18913
|
content: {
|
|
17517
18914
|
'application/json': {
|
|
17518
18915
|
schema: {
|
|
17519
18916
|
properties: {
|
|
17520
|
-
access_code_id: {
|
|
17521
|
-
|
|
18917
|
+
access_code_id: {
|
|
18918
|
+
description:
|
|
18919
|
+
'ID of the access code that you want to update.',
|
|
18920
|
+
format: 'uuid',
|
|
18921
|
+
type: 'string',
|
|
18922
|
+
},
|
|
18923
|
+
allow_external_modification: {
|
|
18924
|
+
description:
|
|
18925
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18926
|
+
type: 'boolean',
|
|
18927
|
+
},
|
|
17522
18928
|
attempt_for_offline_device: {
|
|
17523
18929
|
default: true,
|
|
17524
18930
|
type: 'boolean',
|
|
17525
18931
|
},
|
|
17526
18932
|
code: {
|
|
18933
|
+
description: 'Code to be used for access.',
|
|
17527
18934
|
maxLength: 9,
|
|
17528
18935
|
minLength: 4,
|
|
17529
18936
|
pattern: '^\\d+$',
|
|
17530
18937
|
type: 'string',
|
|
17531
18938
|
},
|
|
17532
|
-
device_id: {
|
|
17533
|
-
|
|
17534
|
-
|
|
17535
|
-
|
|
17536
|
-
|
|
17537
|
-
|
|
18939
|
+
device_id: {
|
|
18940
|
+
description:
|
|
18941
|
+
'ID of the device containing the access code that you want to update.',
|
|
18942
|
+
format: 'uuid',
|
|
18943
|
+
type: 'string',
|
|
18944
|
+
},
|
|
18945
|
+
ends_at: {
|
|
18946
|
+
description:
|
|
18947
|
+
'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`.',
|
|
18948
|
+
type: 'string',
|
|
18949
|
+
},
|
|
18950
|
+
is_external_modification_allowed: {
|
|
18951
|
+
description:
|
|
18952
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18953
|
+
type: 'boolean',
|
|
18954
|
+
},
|
|
18955
|
+
is_managed: {
|
|
18956
|
+
description:
|
|
18957
|
+
'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`.',
|
|
18958
|
+
type: 'boolean',
|
|
18959
|
+
},
|
|
18960
|
+
is_offline_access_code: {
|
|
18961
|
+
description:
|
|
18962
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
18963
|
+
type: 'boolean',
|
|
18964
|
+
},
|
|
18965
|
+
is_one_time_use: {
|
|
18966
|
+
description:
|
|
18967
|
+
'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.',
|
|
18968
|
+
type: 'boolean',
|
|
18969
|
+
},
|
|
17538
18970
|
max_time_rounding: {
|
|
17539
18971
|
default: '1hour',
|
|
18972
|
+
description:
|
|
18973
|
+
'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`.',
|
|
17540
18974
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
17541
18975
|
type: 'string',
|
|
17542
18976
|
},
|
|
17543
|
-
name: {
|
|
17544
|
-
|
|
17545
|
-
|
|
17546
|
-
|
|
17547
|
-
|
|
17548
|
-
|
|
17549
|
-
|
|
18977
|
+
name: {
|
|
18978
|
+
description: 'Name of the new access code.',
|
|
18979
|
+
type: 'string',
|
|
18980
|
+
},
|
|
18981
|
+
prefer_native_scheduling: {
|
|
18982
|
+
description:
|
|
18983
|
+
'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`.',
|
|
18984
|
+
type: 'boolean',
|
|
18985
|
+
},
|
|
18986
|
+
preferred_code_length: {
|
|
18987
|
+
description:
|
|
18988
|
+
'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.',
|
|
18989
|
+
format: 'float',
|
|
18990
|
+
type: 'number',
|
|
18991
|
+
},
|
|
18992
|
+
starts_at: {
|
|
18993
|
+
description:
|
|
18994
|
+
'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.',
|
|
18995
|
+
type: 'string',
|
|
18996
|
+
},
|
|
18997
|
+
sync: {
|
|
18998
|
+
default: false,
|
|
18999
|
+
type: 'boolean',
|
|
19000
|
+
'x-undocumented': 'Only used internally.',
|
|
19001
|
+
},
|
|
19002
|
+
type: {
|
|
19003
|
+
description:
|
|
19004
|
+
'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).',
|
|
19005
|
+
enum: ['ongoing', 'time_bound'],
|
|
19006
|
+
type: 'string',
|
|
19007
|
+
},
|
|
19008
|
+
use_backup_access_code_pool: {
|
|
19009
|
+
description:
|
|
19010
|
+
'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).',
|
|
19011
|
+
type: 'boolean',
|
|
19012
|
+
},
|
|
17550
19013
|
use_offline_access_code: { type: 'boolean' },
|
|
17551
19014
|
},
|
|
17552
19015
|
required: ['access_code_id'],
|
|
@@ -17587,20 +19050,38 @@ export default {
|
|
|
17587
19050
|
'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
|
|
17588
19051
|
'x-fern-ignore': true,
|
|
17589
19052
|
'x-response-key': null,
|
|
19053
|
+
'x-title': 'Update an Access Code',
|
|
17590
19054
|
},
|
|
17591
19055
|
},
|
|
17592
19056
|
'/access_codes/update_multiple': {
|
|
17593
19057
|
patch: {
|
|
19058
|
+
description:
|
|
19059
|
+
'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).',
|
|
17594
19060
|
operationId: 'accessCodesUpdateMultiplePatch',
|
|
17595
19061
|
requestBody: {
|
|
17596
19062
|
content: {
|
|
17597
19063
|
'application/json': {
|
|
17598
19064
|
schema: {
|
|
17599
19065
|
properties: {
|
|
17600
|
-
common_code_key: {
|
|
17601
|
-
|
|
17602
|
-
|
|
17603
|
-
|
|
19066
|
+
common_code_key: {
|
|
19067
|
+
description:
|
|
19068
|
+
'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
|
|
19069
|
+
type: 'string',
|
|
19070
|
+
},
|
|
19071
|
+
ends_at: {
|
|
19072
|
+
description:
|
|
19073
|
+
'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`.',
|
|
19074
|
+
type: 'string',
|
|
19075
|
+
},
|
|
19076
|
+
name: {
|
|
19077
|
+
description: 'Name of the new access code.',
|
|
19078
|
+
type: 'string',
|
|
19079
|
+
},
|
|
19080
|
+
starts_at: {
|
|
19081
|
+
description:
|
|
19082
|
+
'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.',
|
|
19083
|
+
type: 'string',
|
|
19084
|
+
},
|
|
17604
19085
|
},
|
|
17605
19086
|
required: ['common_code_key'],
|
|
17606
19087
|
type: 'object',
|
|
@@ -17634,18 +19115,36 @@ export default {
|
|
|
17634
19115
|
tags: ['/access_codes'],
|
|
17635
19116
|
'x-fern-ignore': true,
|
|
17636
19117
|
'x-response-key': null,
|
|
19118
|
+
'x-title': 'Update Multiple Linked Access Codes',
|
|
17637
19119
|
},
|
|
17638
19120
|
post: {
|
|
19121
|
+
description:
|
|
19122
|
+
'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).',
|
|
17639
19123
|
operationId: 'accessCodesUpdateMultiplePost',
|
|
17640
19124
|
requestBody: {
|
|
17641
19125
|
content: {
|
|
17642
19126
|
'application/json': {
|
|
17643
19127
|
schema: {
|
|
17644
19128
|
properties: {
|
|
17645
|
-
common_code_key: {
|
|
17646
|
-
|
|
17647
|
-
|
|
17648
|
-
|
|
19129
|
+
common_code_key: {
|
|
19130
|
+
description:
|
|
19131
|
+
'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
|
|
19132
|
+
type: 'string',
|
|
19133
|
+
},
|
|
19134
|
+
ends_at: {
|
|
19135
|
+
description:
|
|
19136
|
+
'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`.',
|
|
19137
|
+
type: 'string',
|
|
19138
|
+
},
|
|
19139
|
+
name: {
|
|
19140
|
+
description: 'Name of the new access code.',
|
|
19141
|
+
type: 'string',
|
|
19142
|
+
},
|
|
19143
|
+
starts_at: {
|
|
19144
|
+
description:
|
|
19145
|
+
'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.',
|
|
19146
|
+
type: 'string',
|
|
19147
|
+
},
|
|
17649
19148
|
},
|
|
17650
19149
|
required: ['common_code_key'],
|
|
17651
19150
|
type: 'object',
|
|
@@ -17680,6 +19179,7 @@ export default {
|
|
|
17680
19179
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
17681
19180
|
'x-fern-sdk-method-name': 'update_multiple',
|
|
17682
19181
|
'x-response-key': null,
|
|
19182
|
+
'x-title': 'Update Multiple Linked Access Codes',
|
|
17683
19183
|
},
|
|
17684
19184
|
},
|
|
17685
19185
|
'/acs/access_groups/add_user': {
|