@seamapi/types 1.376.0 → 1.378.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 +1669 -398
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1461 -183
- package/lib/seam/connect/models/access-codes/managed-access-code.js +48 -23
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +13 -2
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +28 -28
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.d.ts +195 -10
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js +16 -3
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js.map +1 -1
- package/lib/seam/connect/models/bridges/bridge-client-session.d.ts +80 -80
- package/lib/seam/connect/models/bridges/bridge-client-session.js +5 -0
- package/lib/seam/connect/models/bridges/bridge-client-session.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +295 -10
- package/lib/seam/connect/openapi.js +1587 -347
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1113 -120
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +95 -60
- package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +15 -2
- package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts +17 -3
- package/src/lib/seam/connect/models/bridges/bridge-client-session.ts +5 -0
- package/src/lib/seam/connect/openapi.ts +1923 -360
- package/src/lib/seam/connect/route-types.ts +1113 -120
|
@@ -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.',
|
|
@@ -2547,16 +2995,13 @@ export default {
|
|
|
2547
2995
|
from: {
|
|
2548
2996
|
properties: {
|
|
2549
2997
|
ends_at: {
|
|
2550
|
-
description:
|
|
2551
|
-
"Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
2552
2998
|
format: 'date-time',
|
|
2553
2999
|
nullable: true,
|
|
2554
3000
|
type: 'string',
|
|
2555
3001
|
},
|
|
2556
3002
|
starts_at: {
|
|
2557
|
-
description:
|
|
2558
|
-
"Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
2559
3003
|
format: 'date-time',
|
|
3004
|
+
nullable: true,
|
|
2560
3005
|
type: 'string',
|
|
2561
3006
|
},
|
|
2562
3007
|
},
|
|
@@ -2570,16 +3015,13 @@ export default {
|
|
|
2570
3015
|
to: {
|
|
2571
3016
|
properties: {
|
|
2572
3017
|
ends_at: {
|
|
2573
|
-
description:
|
|
2574
|
-
"Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
2575
3018
|
format: 'date-time',
|
|
2576
3019
|
nullable: true,
|
|
2577
3020
|
type: 'string',
|
|
2578
3021
|
},
|
|
2579
3022
|
starts_at: {
|
|
2580
|
-
description:
|
|
2581
|
-
"Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
2582
3023
|
format: 'date-time',
|
|
3024
|
+
nullable: true,
|
|
2583
3025
|
type: 'string',
|
|
2584
3026
|
},
|
|
2585
3027
|
},
|
|
@@ -13424,6 +13866,8 @@ export default {
|
|
|
13424
13866
|
'x-route-path': '/thermostats/schedules',
|
|
13425
13867
|
},
|
|
13426
13868
|
unmanaged_access_code: {
|
|
13869
|
+
description:
|
|
13870
|
+
'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
13871
|
properties: {
|
|
13428
13872
|
access_code_id: {
|
|
13429
13873
|
description: 'Unique identifier for the access code.',
|
|
@@ -13456,22 +13900,36 @@ export default {
|
|
|
13456
13900
|
},
|
|
13457
13901
|
errors: {
|
|
13458
13902
|
description:
|
|
13459
|
-
'
|
|
13903
|
+
'Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
13460
13904
|
items: {
|
|
13461
13905
|
discriminator: { propertyName: 'error_code' },
|
|
13462
13906
|
oneOf: [
|
|
13463
13907
|
{
|
|
13464
|
-
description: 'Failed to set code on
|
|
13908
|
+
description: 'Failed to set code on SmartThings device.',
|
|
13465
13909
|
properties: {
|
|
13466
|
-
created_at: {
|
|
13910
|
+
created_at: {
|
|
13911
|
+
description:
|
|
13912
|
+
'Date and time at which Seam created the error.',
|
|
13913
|
+
format: 'date-time',
|
|
13914
|
+
type: 'string',
|
|
13915
|
+
},
|
|
13467
13916
|
error_code: {
|
|
13468
13917
|
description:
|
|
13469
13918
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13470
13919
|
enum: ['smartthings_failed_to_set_access_code'],
|
|
13471
13920
|
type: 'string',
|
|
13472
13921
|
},
|
|
13473
|
-
is_access_code_error: {
|
|
13474
|
-
|
|
13922
|
+
is_access_code_error: {
|
|
13923
|
+
description:
|
|
13924
|
+
'Indicates that this is an access code error.',
|
|
13925
|
+
enum: [true],
|
|
13926
|
+
type: 'boolean',
|
|
13927
|
+
},
|
|
13928
|
+
message: {
|
|
13929
|
+
description:
|
|
13930
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13931
|
+
type: 'string',
|
|
13932
|
+
},
|
|
13475
13933
|
},
|
|
13476
13934
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13477
13935
|
type: 'object',
|
|
@@ -13479,7 +13937,12 @@ export default {
|
|
|
13479
13937
|
{
|
|
13480
13938
|
description: 'Failed to set code after multiple retries.',
|
|
13481
13939
|
properties: {
|
|
13482
|
-
created_at: {
|
|
13940
|
+
created_at: {
|
|
13941
|
+
description:
|
|
13942
|
+
'Date and time at which Seam created the error.',
|
|
13943
|
+
format: 'date-time',
|
|
13944
|
+
type: 'string',
|
|
13945
|
+
},
|
|
13483
13946
|
error_code: {
|
|
13484
13947
|
description:
|
|
13485
13948
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -13488,8 +13951,17 @@ export default {
|
|
|
13488
13951
|
],
|
|
13489
13952
|
type: 'string',
|
|
13490
13953
|
},
|
|
13491
|
-
is_access_code_error: {
|
|
13492
|
-
|
|
13954
|
+
is_access_code_error: {
|
|
13955
|
+
description:
|
|
13956
|
+
'Indicates that this is an access code error.',
|
|
13957
|
+
enum: [true],
|
|
13958
|
+
type: 'boolean',
|
|
13959
|
+
},
|
|
13960
|
+
message: {
|
|
13961
|
+
description:
|
|
13962
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13963
|
+
type: 'string',
|
|
13964
|
+
},
|
|
13493
13965
|
},
|
|
13494
13966
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13495
13967
|
type: 'object',
|
|
@@ -13497,15 +13969,29 @@ export default {
|
|
|
13497
13969
|
{
|
|
13498
13970
|
description: 'No free slots available on the device.',
|
|
13499
13971
|
properties: {
|
|
13500
|
-
created_at: {
|
|
13972
|
+
created_at: {
|
|
13973
|
+
description:
|
|
13974
|
+
'Date and time at which Seam created the error.',
|
|
13975
|
+
format: 'date-time',
|
|
13976
|
+
type: 'string',
|
|
13977
|
+
},
|
|
13501
13978
|
error_code: {
|
|
13502
13979
|
description:
|
|
13503
13980
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13504
13981
|
enum: ['smartthings_no_free_slots_available'],
|
|
13505
13982
|
type: 'string',
|
|
13506
13983
|
},
|
|
13507
|
-
is_access_code_error: {
|
|
13508
|
-
|
|
13984
|
+
is_access_code_error: {
|
|
13985
|
+
description:
|
|
13986
|
+
'Indicates that this is an access code error.',
|
|
13987
|
+
enum: [true],
|
|
13988
|
+
type: 'boolean',
|
|
13989
|
+
},
|
|
13990
|
+
message: {
|
|
13991
|
+
description:
|
|
13992
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13993
|
+
type: 'string',
|
|
13994
|
+
},
|
|
13509
13995
|
},
|
|
13510
13996
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13511
13997
|
type: 'object',
|
|
@@ -13513,15 +13999,29 @@ export default {
|
|
|
13513
13999
|
{
|
|
13514
14000
|
description: 'Failed to set code on device.',
|
|
13515
14001
|
properties: {
|
|
13516
|
-
created_at: {
|
|
14002
|
+
created_at: {
|
|
14003
|
+
description:
|
|
14004
|
+
'Date and time at which Seam created the error.',
|
|
14005
|
+
format: 'date-time',
|
|
14006
|
+
type: 'string',
|
|
14007
|
+
},
|
|
13517
14008
|
error_code: {
|
|
13518
14009
|
description:
|
|
13519
14010
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13520
14011
|
enum: ['failed_to_set_on_device'],
|
|
13521
14012
|
type: 'string',
|
|
13522
14013
|
},
|
|
13523
|
-
is_access_code_error: {
|
|
13524
|
-
|
|
14014
|
+
is_access_code_error: {
|
|
14015
|
+
description:
|
|
14016
|
+
'Indicates that this is an access code error.',
|
|
14017
|
+
enum: [true],
|
|
14018
|
+
type: 'boolean',
|
|
14019
|
+
},
|
|
14020
|
+
message: {
|
|
14021
|
+
description:
|
|
14022
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14023
|
+
type: 'string',
|
|
14024
|
+
},
|
|
13525
14025
|
},
|
|
13526
14026
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13527
14027
|
type: 'object',
|
|
@@ -13529,15 +14029,29 @@ export default {
|
|
|
13529
14029
|
{
|
|
13530
14030
|
description: 'Failed to remove code from device.',
|
|
13531
14031
|
properties: {
|
|
13532
|
-
created_at: {
|
|
14032
|
+
created_at: {
|
|
14033
|
+
description:
|
|
14034
|
+
'Date and time at which Seam created the error.',
|
|
14035
|
+
format: 'date-time',
|
|
14036
|
+
type: 'string',
|
|
14037
|
+
},
|
|
13533
14038
|
error_code: {
|
|
13534
14039
|
description:
|
|
13535
14040
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13536
14041
|
enum: ['failed_to_remove_from_device'],
|
|
13537
14042
|
type: 'string',
|
|
13538
14043
|
},
|
|
13539
|
-
is_access_code_error: {
|
|
13540
|
-
|
|
14044
|
+
is_access_code_error: {
|
|
14045
|
+
description:
|
|
14046
|
+
'Indicates that this is an access code error.',
|
|
14047
|
+
enum: [true],
|
|
14048
|
+
type: 'boolean',
|
|
14049
|
+
},
|
|
14050
|
+
message: {
|
|
14051
|
+
description:
|
|
14052
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14053
|
+
type: 'string',
|
|
14054
|
+
},
|
|
13541
14055
|
},
|
|
13542
14056
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13543
14057
|
type: 'object',
|
|
@@ -13545,15 +14059,29 @@ export default {
|
|
|
13545
14059
|
{
|
|
13546
14060
|
description: 'Duplicate access code detected on device.',
|
|
13547
14061
|
properties: {
|
|
13548
|
-
created_at: {
|
|
14062
|
+
created_at: {
|
|
14063
|
+
description:
|
|
14064
|
+
'Date and time at which Seam created the error.',
|
|
14065
|
+
format: 'date-time',
|
|
14066
|
+
type: 'string',
|
|
14067
|
+
},
|
|
13549
14068
|
error_code: {
|
|
13550
14069
|
description:
|
|
13551
14070
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13552
14071
|
enum: ['duplicate_code_on_device'],
|
|
13553
14072
|
type: 'string',
|
|
13554
14073
|
},
|
|
13555
|
-
is_access_code_error: {
|
|
13556
|
-
|
|
14074
|
+
is_access_code_error: {
|
|
14075
|
+
description:
|
|
14076
|
+
'Indicates that this is an access code error.',
|
|
14077
|
+
enum: [true],
|
|
14078
|
+
type: 'boolean',
|
|
14079
|
+
},
|
|
14080
|
+
message: {
|
|
14081
|
+
description:
|
|
14082
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14083
|
+
type: 'string',
|
|
14084
|
+
},
|
|
13557
14085
|
},
|
|
13558
14086
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13559
14087
|
type: 'object',
|
|
@@ -13562,15 +14090,29 @@ export default {
|
|
|
13562
14090
|
description:
|
|
13563
14091
|
'An attempt to modify this access code was prevented.',
|
|
13564
14092
|
properties: {
|
|
13565
|
-
created_at: {
|
|
14093
|
+
created_at: {
|
|
14094
|
+
description:
|
|
14095
|
+
'Date and time at which Seam created the error.',
|
|
14096
|
+
format: 'date-time',
|
|
14097
|
+
type: 'string',
|
|
14098
|
+
},
|
|
13566
14099
|
error_code: {
|
|
13567
14100
|
description:
|
|
13568
14101
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13569
14102
|
enum: ['duplicate_code_attempt_prevented'],
|
|
13570
14103
|
type: 'string',
|
|
13571
14104
|
},
|
|
13572
|
-
is_access_code_error: {
|
|
13573
|
-
|
|
14105
|
+
is_access_code_error: {
|
|
14106
|
+
description:
|
|
14107
|
+
'Indicates that this is an access code error.',
|
|
14108
|
+
enum: [true],
|
|
14109
|
+
type: 'boolean',
|
|
14110
|
+
},
|
|
14111
|
+
message: {
|
|
14112
|
+
description:
|
|
14113
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14114
|
+
type: 'string',
|
|
14115
|
+
},
|
|
13574
14116
|
},
|
|
13575
14117
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13576
14118
|
type: 'object',
|
|
@@ -13579,15 +14121,29 @@ export default {
|
|
|
13579
14121
|
description:
|
|
13580
14122
|
'Igloohome bridge has too many pending jobs in the queue.',
|
|
13581
14123
|
properties: {
|
|
13582
|
-
created_at: {
|
|
14124
|
+
created_at: {
|
|
14125
|
+
description:
|
|
14126
|
+
'Date and time at which Seam created the error.',
|
|
14127
|
+
format: 'date-time',
|
|
14128
|
+
type: 'string',
|
|
14129
|
+
},
|
|
13583
14130
|
error_code: {
|
|
13584
14131
|
description:
|
|
13585
14132
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13586
14133
|
enum: ['igloohome_bridge_too_many_pending_jobs'],
|
|
13587
14134
|
type: 'string',
|
|
13588
14135
|
},
|
|
13589
|
-
is_access_code_error: {
|
|
13590
|
-
|
|
14136
|
+
is_access_code_error: {
|
|
14137
|
+
description:
|
|
14138
|
+
'Indicates that this is an access code error.',
|
|
14139
|
+
enum: [true],
|
|
14140
|
+
type: 'boolean',
|
|
14141
|
+
},
|
|
14142
|
+
message: {
|
|
14143
|
+
description:
|
|
14144
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14145
|
+
type: 'string',
|
|
14146
|
+
},
|
|
13591
14147
|
},
|
|
13592
14148
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13593
14149
|
type: 'object',
|
|
@@ -13595,23 +14151,42 @@ export default {
|
|
|
13595
14151
|
{
|
|
13596
14152
|
description: 'Igloohome bridge is offline.',
|
|
13597
14153
|
properties: {
|
|
13598
|
-
created_at: {
|
|
14154
|
+
created_at: {
|
|
14155
|
+
description:
|
|
14156
|
+
'Date and time at which Seam created the error.',
|
|
14157
|
+
format: 'date-time',
|
|
14158
|
+
type: 'string',
|
|
14159
|
+
},
|
|
13599
14160
|
error_code: {
|
|
13600
14161
|
description:
|
|
13601
14162
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13602
14163
|
enum: ['igloohome_bridge_offline'],
|
|
13603
14164
|
type: 'string',
|
|
13604
14165
|
},
|
|
13605
|
-
is_access_code_error: {
|
|
13606
|
-
|
|
14166
|
+
is_access_code_error: {
|
|
14167
|
+
description:
|
|
14168
|
+
'Indicates that this is an access code error.',
|
|
14169
|
+
enum: [true],
|
|
14170
|
+
type: 'boolean',
|
|
14171
|
+
},
|
|
14172
|
+
message: {
|
|
14173
|
+
description:
|
|
14174
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14175
|
+
type: 'string',
|
|
14176
|
+
},
|
|
13607
14177
|
},
|
|
13608
14178
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13609
14179
|
type: 'object',
|
|
13610
14180
|
},
|
|
13611
14181
|
{
|
|
13612
|
-
description: 'Lock
|
|
14182
|
+
description: 'Lock has reached maximum amount of codes.',
|
|
13613
14183
|
properties: {
|
|
13614
|
-
created_at: {
|
|
14184
|
+
created_at: {
|
|
14185
|
+
description:
|
|
14186
|
+
'Date and time at which Seam created the error.',
|
|
14187
|
+
format: 'date-time',
|
|
14188
|
+
type: 'string',
|
|
14189
|
+
},
|
|
13615
14190
|
error_code: {
|
|
13616
14191
|
description:
|
|
13617
14192
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -13620,25 +14195,48 @@ export default {
|
|
|
13620
14195
|
],
|
|
13621
14196
|
type: 'string',
|
|
13622
14197
|
},
|
|
13623
|
-
is_access_code_error: {
|
|
13624
|
-
|
|
14198
|
+
is_access_code_error: {
|
|
14199
|
+
description:
|
|
14200
|
+
'Indicates that this is an access code error.',
|
|
14201
|
+
enum: [true],
|
|
14202
|
+
type: 'boolean',
|
|
14203
|
+
},
|
|
14204
|
+
message: {
|
|
14205
|
+
description:
|
|
14206
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14207
|
+
type: 'string',
|
|
14208
|
+
},
|
|
13625
14209
|
},
|
|
13626
14210
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13627
14211
|
type: 'object',
|
|
13628
14212
|
},
|
|
13629
14213
|
{
|
|
13630
14214
|
description:
|
|
13631
|
-
'Unable to confirm the access code is set on Kwikset device.',
|
|
14215
|
+
'Unable to confirm that the access code is set on Kwikset device.',
|
|
13632
14216
|
properties: {
|
|
13633
|
-
created_at: {
|
|
14217
|
+
created_at: {
|
|
14218
|
+
description:
|
|
14219
|
+
'Date and time at which Seam created the error.',
|
|
14220
|
+
format: 'date-time',
|
|
14221
|
+
type: 'string',
|
|
14222
|
+
},
|
|
13634
14223
|
error_code: {
|
|
13635
14224
|
description:
|
|
13636
14225
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13637
14226
|
enum: ['kwikset_unable_to_confirm_code'],
|
|
13638
14227
|
type: 'string',
|
|
13639
14228
|
},
|
|
13640
|
-
is_access_code_error: {
|
|
13641
|
-
|
|
14229
|
+
is_access_code_error: {
|
|
14230
|
+
description:
|
|
14231
|
+
'Indicates that this is an access code error.',
|
|
14232
|
+
enum: [true],
|
|
14233
|
+
type: 'boolean',
|
|
14234
|
+
},
|
|
14235
|
+
message: {
|
|
14236
|
+
description:
|
|
14237
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14238
|
+
type: 'string',
|
|
14239
|
+
},
|
|
13642
14240
|
},
|
|
13643
14241
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13644
14242
|
type: 'object',
|
|
@@ -13647,15 +14245,29 @@ export default {
|
|
|
13647
14245
|
description:
|
|
13648
14246
|
'Unable to confirm the deletion of the access code on Kwikset device.',
|
|
13649
14247
|
properties: {
|
|
13650
|
-
created_at: {
|
|
14248
|
+
created_at: {
|
|
14249
|
+
description:
|
|
14250
|
+
'Date and time at which Seam created the error.',
|
|
14251
|
+
format: 'date-time',
|
|
14252
|
+
type: 'string',
|
|
14253
|
+
},
|
|
13651
14254
|
error_code: {
|
|
13652
14255
|
description:
|
|
13653
14256
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13654
14257
|
enum: ['kwikset_unable_to_confirm_deletion'],
|
|
13655
14258
|
type: 'string',
|
|
13656
14259
|
},
|
|
13657
|
-
is_access_code_error: {
|
|
13658
|
-
|
|
14260
|
+
is_access_code_error: {
|
|
14261
|
+
description:
|
|
14262
|
+
'Indicates that this is an access code error.',
|
|
14263
|
+
enum: [true],
|
|
14264
|
+
type: 'boolean',
|
|
14265
|
+
},
|
|
14266
|
+
message: {
|
|
14267
|
+
description:
|
|
14268
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14269
|
+
type: 'string',
|
|
14270
|
+
},
|
|
13659
14271
|
},
|
|
13660
14272
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13661
14273
|
type: 'object',
|
|
@@ -13664,15 +14276,29 @@ export default {
|
|
|
13664
14276
|
description:
|
|
13665
14277
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
13666
14278
|
properties: {
|
|
13667
|
-
created_at: {
|
|
14279
|
+
created_at: {
|
|
14280
|
+
description:
|
|
14281
|
+
'Date and time at which Seam created the error.',
|
|
14282
|
+
format: 'date-time',
|
|
14283
|
+
type: 'string',
|
|
14284
|
+
},
|
|
13668
14285
|
error_code: {
|
|
13669
14286
|
description:
|
|
13670
14287
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13671
14288
|
enum: ['code_modified_external_to_seam'],
|
|
13672
14289
|
type: 'string',
|
|
13673
14290
|
},
|
|
13674
|
-
is_access_code_error: {
|
|
13675
|
-
|
|
14291
|
+
is_access_code_error: {
|
|
14292
|
+
description:
|
|
14293
|
+
'Indicates that this is an access code error.',
|
|
14294
|
+
enum: [true],
|
|
14295
|
+
type: 'boolean',
|
|
14296
|
+
},
|
|
14297
|
+
message: {
|
|
14298
|
+
description:
|
|
14299
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14300
|
+
type: 'string',
|
|
14301
|
+
},
|
|
13676
14302
|
},
|
|
13677
14303
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13678
14304
|
type: 'object',
|
|
@@ -13680,15 +14306,29 @@ export default {
|
|
|
13680
14306
|
{
|
|
13681
14307
|
description: 'Invalid code length for August lock.',
|
|
13682
14308
|
properties: {
|
|
13683
|
-
created_at: {
|
|
14309
|
+
created_at: {
|
|
14310
|
+
description:
|
|
14311
|
+
'Date and time at which Seam created the error.',
|
|
14312
|
+
format: 'date-time',
|
|
14313
|
+
type: 'string',
|
|
14314
|
+
},
|
|
13684
14315
|
error_code: {
|
|
13685
14316
|
description:
|
|
13686
14317
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13687
14318
|
enum: ['august_lock_invalid_code_length'],
|
|
13688
14319
|
type: 'string',
|
|
13689
14320
|
},
|
|
13690
|
-
is_access_code_error: {
|
|
13691
|
-
|
|
14321
|
+
is_access_code_error: {
|
|
14322
|
+
description:
|
|
14323
|
+
'Indicates that this is an access code error.',
|
|
14324
|
+
enum: [true],
|
|
14325
|
+
type: 'boolean',
|
|
14326
|
+
},
|
|
14327
|
+
message: {
|
|
14328
|
+
description:
|
|
14329
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14330
|
+
type: 'string',
|
|
14331
|
+
},
|
|
13692
14332
|
},
|
|
13693
14333
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13694
14334
|
type: 'object',
|
|
@@ -13697,15 +14337,29 @@ export default {
|
|
|
13697
14337
|
description:
|
|
13698
14338
|
'Access code has not yet been fully moved to the device.',
|
|
13699
14339
|
properties: {
|
|
13700
|
-
created_at: {
|
|
14340
|
+
created_at: {
|
|
14341
|
+
description:
|
|
14342
|
+
'Date and time at which Seam created the error.',
|
|
14343
|
+
format: 'date-time',
|
|
14344
|
+
type: 'string',
|
|
14345
|
+
},
|
|
13701
14346
|
error_code: {
|
|
13702
14347
|
description:
|
|
13703
14348
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13704
14349
|
enum: ['august_device_programming_delay'],
|
|
13705
14350
|
type: 'string',
|
|
13706
14351
|
},
|
|
13707
|
-
is_access_code_error: {
|
|
13708
|
-
|
|
14352
|
+
is_access_code_error: {
|
|
14353
|
+
description:
|
|
14354
|
+
'Indicates that this is an access code error.',
|
|
14355
|
+
enum: [true],
|
|
14356
|
+
type: 'boolean',
|
|
14357
|
+
},
|
|
14358
|
+
message: {
|
|
14359
|
+
description:
|
|
14360
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14361
|
+
type: 'string',
|
|
14362
|
+
},
|
|
13709
14363
|
},
|
|
13710
14364
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13711
14365
|
type: 'object',
|
|
@@ -13713,15 +14367,29 @@ export default {
|
|
|
13713
14367
|
{
|
|
13714
14368
|
description: 'All access code slots on the device are full.',
|
|
13715
14369
|
properties: {
|
|
13716
|
-
created_at: {
|
|
14370
|
+
created_at: {
|
|
14371
|
+
description:
|
|
14372
|
+
'Date and time at which Seam created the error.',
|
|
14373
|
+
format: 'date-time',
|
|
14374
|
+
type: 'string',
|
|
14375
|
+
},
|
|
13717
14376
|
error_code: {
|
|
13718
14377
|
description:
|
|
13719
14378
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13720
14379
|
enum: ['august_device_slots_full'],
|
|
13721
14380
|
type: 'string',
|
|
13722
14381
|
},
|
|
13723
|
-
is_access_code_error: {
|
|
13724
|
-
|
|
14382
|
+
is_access_code_error: {
|
|
14383
|
+
description:
|
|
14384
|
+
'Indicates that this is an access code error.',
|
|
14385
|
+
enum: [true],
|
|
14386
|
+
type: 'boolean',
|
|
14387
|
+
},
|
|
14388
|
+
message: {
|
|
14389
|
+
description:
|
|
14390
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14391
|
+
type: 'string',
|
|
14392
|
+
},
|
|
13725
14393
|
},
|
|
13726
14394
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13727
14395
|
type: 'object',
|
|
@@ -13729,15 +14397,29 @@ export default {
|
|
|
13729
14397
|
{
|
|
13730
14398
|
description: 'August lock is missing a keypad.',
|
|
13731
14399
|
properties: {
|
|
13732
|
-
created_at: {
|
|
14400
|
+
created_at: {
|
|
14401
|
+
description:
|
|
14402
|
+
'Date and time at which Seam created the error.',
|
|
14403
|
+
format: 'date-time',
|
|
14404
|
+
type: 'string',
|
|
14405
|
+
},
|
|
13733
14406
|
error_code: {
|
|
13734
14407
|
description:
|
|
13735
14408
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13736
14409
|
enum: ['august_lock_missing_keypad'],
|
|
13737
14410
|
type: 'string',
|
|
13738
14411
|
},
|
|
13739
|
-
is_access_code_error: {
|
|
13740
|
-
|
|
14412
|
+
is_access_code_error: {
|
|
14413
|
+
description:
|
|
14414
|
+
'Indicates that this is an access code error.',
|
|
14415
|
+
enum: [true],
|
|
14416
|
+
type: 'boolean',
|
|
14417
|
+
},
|
|
14418
|
+
message: {
|
|
14419
|
+
description:
|
|
14420
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14421
|
+
type: 'string',
|
|
14422
|
+
},
|
|
13741
14423
|
},
|
|
13742
14424
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13743
14425
|
type: 'object',
|
|
@@ -13745,15 +14427,29 @@ export default {
|
|
|
13745
14427
|
{
|
|
13746
14428
|
description: 'August lock is temporarily offline.',
|
|
13747
14429
|
properties: {
|
|
13748
|
-
created_at: {
|
|
14430
|
+
created_at: {
|
|
14431
|
+
description:
|
|
14432
|
+
'Date and time at which Seam created the error.',
|
|
14433
|
+
format: 'date-time',
|
|
14434
|
+
type: 'string',
|
|
14435
|
+
},
|
|
13749
14436
|
error_code: {
|
|
13750
14437
|
description:
|
|
13751
14438
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13752
14439
|
enum: ['august_lock_temporarily_offline'],
|
|
13753
14440
|
type: 'string',
|
|
13754
14441
|
},
|
|
13755
|
-
is_access_code_error: {
|
|
13756
|
-
|
|
14442
|
+
is_access_code_error: {
|
|
14443
|
+
description:
|
|
14444
|
+
'Indicates that this is an access code error.',
|
|
14445
|
+
enum: [true],
|
|
14446
|
+
type: 'boolean',
|
|
14447
|
+
},
|
|
14448
|
+
message: {
|
|
14449
|
+
description:
|
|
14450
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14451
|
+
type: 'string',
|
|
14452
|
+
},
|
|
13757
14453
|
},
|
|
13758
14454
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13759
14455
|
type: 'object',
|
|
@@ -13761,15 +14457,29 @@ export default {
|
|
|
13761
14457
|
{
|
|
13762
14458
|
description: 'Salto site user is not subscribed.',
|
|
13763
14459
|
properties: {
|
|
13764
|
-
created_at: {
|
|
14460
|
+
created_at: {
|
|
14461
|
+
description:
|
|
14462
|
+
'Date and time at which Seam created the error.',
|
|
14463
|
+
format: 'date-time',
|
|
14464
|
+
type: 'string',
|
|
14465
|
+
},
|
|
13765
14466
|
error_code: {
|
|
13766
14467
|
description:
|
|
13767
14468
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13768
14469
|
enum: ['salto_ks_user_not_subscribed'],
|
|
13769
14470
|
type: 'string',
|
|
13770
14471
|
},
|
|
13771
|
-
is_access_code_error: {
|
|
13772
|
-
|
|
14472
|
+
is_access_code_error: {
|
|
14473
|
+
description:
|
|
14474
|
+
'Indicates that this is an access code error.',
|
|
14475
|
+
enum: [true],
|
|
14476
|
+
type: 'boolean',
|
|
14477
|
+
},
|
|
14478
|
+
message: {
|
|
14479
|
+
description:
|
|
14480
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14481
|
+
type: 'string',
|
|
14482
|
+
},
|
|
13773
14483
|
},
|
|
13774
14484
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13775
14485
|
type: 'object',
|
|
@@ -13778,15 +14488,29 @@ export default {
|
|
|
13778
14488
|
description:
|
|
13779
14489
|
'Access code has not yet been fully moved to the device.',
|
|
13780
14490
|
properties: {
|
|
13781
|
-
created_at: {
|
|
14491
|
+
created_at: {
|
|
14492
|
+
description:
|
|
14493
|
+
'Date and time at which Seam created the error.',
|
|
14494
|
+
format: 'date-time',
|
|
14495
|
+
type: 'string',
|
|
14496
|
+
},
|
|
13782
14497
|
error_code: {
|
|
13783
14498
|
description:
|
|
13784
14499
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13785
14500
|
enum: ['hubitat_device_programming_delay'],
|
|
13786
14501
|
type: 'string',
|
|
13787
14502
|
},
|
|
13788
|
-
is_access_code_error: {
|
|
13789
|
-
|
|
14503
|
+
is_access_code_error: {
|
|
14504
|
+
description:
|
|
14505
|
+
'Indicates that this is an access code error.',
|
|
14506
|
+
enum: [true],
|
|
14507
|
+
type: 'boolean',
|
|
14508
|
+
},
|
|
14509
|
+
message: {
|
|
14510
|
+
description:
|
|
14511
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14512
|
+
type: 'string',
|
|
14513
|
+
},
|
|
13790
14514
|
},
|
|
13791
14515
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13792
14516
|
type: 'object',
|
|
@@ -13794,15 +14518,29 @@ export default {
|
|
|
13794
14518
|
{
|
|
13795
14519
|
description: 'No free positions available on the device.',
|
|
13796
14520
|
properties: {
|
|
13797
|
-
created_at: {
|
|
14521
|
+
created_at: {
|
|
14522
|
+
description:
|
|
14523
|
+
'Date and time at which Seam created the error.',
|
|
14524
|
+
format: 'date-time',
|
|
14525
|
+
type: 'string',
|
|
14526
|
+
},
|
|
13798
14527
|
error_code: {
|
|
13799
14528
|
description:
|
|
13800
14529
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13801
14530
|
enum: ['hubitat_no_free_positions_available'],
|
|
13802
14531
|
type: 'string',
|
|
13803
14532
|
},
|
|
13804
|
-
is_access_code_error: {
|
|
13805
|
-
|
|
14533
|
+
is_access_code_error: {
|
|
14534
|
+
description:
|
|
14535
|
+
'Indicates that this is an access code error.',
|
|
14536
|
+
enum: [true],
|
|
14537
|
+
type: 'boolean',
|
|
14538
|
+
},
|
|
14539
|
+
message: {
|
|
14540
|
+
description:
|
|
14541
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14542
|
+
type: 'string',
|
|
14543
|
+
},
|
|
13806
14544
|
},
|
|
13807
14545
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13808
14546
|
type: 'object',
|
|
@@ -13810,15 +14548,29 @@ export default {
|
|
|
13810
14548
|
{
|
|
13811
14549
|
description: 'Duplicate access code name detected.',
|
|
13812
14550
|
properties: {
|
|
13813
|
-
created_at: {
|
|
14551
|
+
created_at: {
|
|
14552
|
+
description:
|
|
14553
|
+
'Date and time at which Seam created the error.',
|
|
14554
|
+
format: 'date-time',
|
|
14555
|
+
type: 'string',
|
|
14556
|
+
},
|
|
13814
14557
|
error_code: {
|
|
13815
14558
|
description:
|
|
13816
14559
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13817
14560
|
enum: ['wyze_duplicate_code_name'],
|
|
13818
14561
|
type: 'string',
|
|
13819
14562
|
},
|
|
13820
|
-
is_access_code_error: {
|
|
13821
|
-
|
|
14563
|
+
is_access_code_error: {
|
|
14564
|
+
description:
|
|
14565
|
+
'Indicates that this is an access code error.',
|
|
14566
|
+
enum: [true],
|
|
14567
|
+
type: 'boolean',
|
|
14568
|
+
},
|
|
14569
|
+
message: {
|
|
14570
|
+
description:
|
|
14571
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14572
|
+
type: 'string',
|
|
14573
|
+
},
|
|
13822
14574
|
},
|
|
13823
14575
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13824
14576
|
type: 'object',
|
|
@@ -13826,15 +14578,29 @@ export default {
|
|
|
13826
14578
|
{
|
|
13827
14579
|
description: 'Potential duplicate access code detected.',
|
|
13828
14580
|
properties: {
|
|
13829
|
-
created_at: {
|
|
14581
|
+
created_at: {
|
|
14582
|
+
description:
|
|
14583
|
+
'Date and time at which Seam created the error.',
|
|
14584
|
+
format: 'date-time',
|
|
14585
|
+
type: 'string',
|
|
14586
|
+
},
|
|
13830
14587
|
error_code: {
|
|
13831
14588
|
description:
|
|
13832
14589
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13833
14590
|
enum: ['wyze_potential_duplicate_code'],
|
|
13834
14591
|
type: 'string',
|
|
13835
14592
|
},
|
|
13836
|
-
is_access_code_error: {
|
|
13837
|
-
|
|
14593
|
+
is_access_code_error: {
|
|
14594
|
+
description:
|
|
14595
|
+
'Indicates that this is an access code error.',
|
|
14596
|
+
enum: [true],
|
|
14597
|
+
type: 'boolean',
|
|
14598
|
+
},
|
|
14599
|
+
message: {
|
|
14600
|
+
description:
|
|
14601
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14602
|
+
type: 'string',
|
|
14603
|
+
},
|
|
13838
14604
|
},
|
|
13839
14605
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13840
14606
|
type: 'object',
|
|
@@ -13842,15 +14608,29 @@ export default {
|
|
|
13842
14608
|
{
|
|
13843
14609
|
description: 'No valid user level for Oracode.',
|
|
13844
14610
|
properties: {
|
|
13845
|
-
created_at: {
|
|
14611
|
+
created_at: {
|
|
14612
|
+
description:
|
|
14613
|
+
'Date and time at which Seam created the error.',
|
|
14614
|
+
format: 'date-time',
|
|
14615
|
+
type: 'string',
|
|
14616
|
+
},
|
|
13846
14617
|
error_code: {
|
|
13847
14618
|
description:
|
|
13848
14619
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13849
14620
|
enum: ['dormakaba_oracode_no_valid_user_level'],
|
|
13850
14621
|
type: 'string',
|
|
13851
14622
|
},
|
|
13852
|
-
is_access_code_error: {
|
|
13853
|
-
|
|
14623
|
+
is_access_code_error: {
|
|
14624
|
+
description:
|
|
14625
|
+
'Indicates that this is an access code error.',
|
|
14626
|
+
enum: [true],
|
|
14627
|
+
type: 'boolean',
|
|
14628
|
+
},
|
|
14629
|
+
message: {
|
|
14630
|
+
description:
|
|
14631
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14632
|
+
type: 'string',
|
|
14633
|
+
},
|
|
13854
14634
|
},
|
|
13855
14635
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13856
14636
|
type: 'object',
|
|
@@ -14187,7 +14967,11 @@ export default {
|
|
|
14187
14967
|
},
|
|
14188
14968
|
type: 'array',
|
|
14189
14969
|
},
|
|
14190
|
-
is_managed: {
|
|
14970
|
+
is_managed: {
|
|
14971
|
+
description: 'Indicates that Seam does not manage the access code.',
|
|
14972
|
+
enum: [false],
|
|
14973
|
+
type: 'boolean',
|
|
14974
|
+
},
|
|
14191
14975
|
name: {
|
|
14192
14976
|
description:
|
|
14193
14977
|
'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
|
|
@@ -14201,24 +14985,40 @@ export default {
|
|
|
14201
14985
|
nullable: true,
|
|
14202
14986
|
type: 'string',
|
|
14203
14987
|
},
|
|
14204
|
-
status: {
|
|
14988
|
+
status: {
|
|
14989
|
+
description:
|
|
14990
|
+
'Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.',
|
|
14991
|
+
enum: ['set'],
|
|
14992
|
+
type: 'string',
|
|
14993
|
+
},
|
|
14205
14994
|
type: {
|
|
14206
14995
|
description:
|
|
14207
|
-
'Nature of the access code. Values are
|
|
14996
|
+
'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
14997
|
enum: ['time_bound', 'ongoing'],
|
|
14209
14998
|
type: 'string',
|
|
14210
14999
|
},
|
|
14211
15000
|
warnings: {
|
|
14212
15001
|
description:
|
|
14213
|
-
'
|
|
15002
|
+
'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
14214
15003
|
items: {
|
|
15004
|
+
description:
|
|
15005
|
+
'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
14215
15006
|
discriminator: { propertyName: 'warning_code' },
|
|
14216
15007
|
oneOf: [
|
|
14217
15008
|
{
|
|
14218
|
-
description: 'Failed to set code on
|
|
15009
|
+
description: 'Failed to set code on SmartThings device.',
|
|
14219
15010
|
properties: {
|
|
14220
|
-
created_at: {
|
|
14221
|
-
|
|
15011
|
+
created_at: {
|
|
15012
|
+
description:
|
|
15013
|
+
'Date and time at which Seam created the warning.',
|
|
15014
|
+
format: 'date-time',
|
|
15015
|
+
type: 'string',
|
|
15016
|
+
},
|
|
15017
|
+
message: {
|
|
15018
|
+
description:
|
|
15019
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15020
|
+
type: 'string',
|
|
15021
|
+
},
|
|
14222
15022
|
warning_code: {
|
|
14223
15023
|
description:
|
|
14224
15024
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14232,8 +15032,17 @@ export default {
|
|
|
14232
15032
|
{
|
|
14233
15033
|
description: 'Duplicate access code detected.',
|
|
14234
15034
|
properties: {
|
|
14235
|
-
created_at: {
|
|
14236
|
-
|
|
15035
|
+
created_at: {
|
|
15036
|
+
description:
|
|
15037
|
+
'Date and time at which Seam created the warning.',
|
|
15038
|
+
format: 'date-time',
|
|
15039
|
+
type: 'string',
|
|
15040
|
+
},
|
|
15041
|
+
message: {
|
|
15042
|
+
description:
|
|
15043
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15044
|
+
type: 'string',
|
|
15045
|
+
},
|
|
14237
15046
|
warning_code: {
|
|
14238
15047
|
description:
|
|
14239
15048
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14248,8 +15057,17 @@ export default {
|
|
|
14248
15057
|
description:
|
|
14249
15058
|
'Received an error when attempting to create this code.',
|
|
14250
15059
|
properties: {
|
|
14251
|
-
created_at: {
|
|
14252
|
-
|
|
15060
|
+
created_at: {
|
|
15061
|
+
description:
|
|
15062
|
+
'Date and time at which Seam created the warning.',
|
|
15063
|
+
format: 'date-time',
|
|
15064
|
+
type: 'string',
|
|
15065
|
+
},
|
|
15066
|
+
message: {
|
|
15067
|
+
description:
|
|
15068
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15069
|
+
type: 'string',
|
|
15070
|
+
},
|
|
14253
15071
|
warning_code: {
|
|
14254
15072
|
description:
|
|
14255
15073
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14264,8 +15082,17 @@ export default {
|
|
|
14264
15082
|
description:
|
|
14265
15083
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
14266
15084
|
properties: {
|
|
14267
|
-
created_at: {
|
|
14268
|
-
|
|
15085
|
+
created_at: {
|
|
15086
|
+
description:
|
|
15087
|
+
'Date and time at which Seam created the warning.',
|
|
15088
|
+
format: 'date-time',
|
|
15089
|
+
type: 'string',
|
|
15090
|
+
},
|
|
15091
|
+
message: {
|
|
15092
|
+
description:
|
|
15093
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15094
|
+
type: 'string',
|
|
15095
|
+
},
|
|
14269
15096
|
warning_code: {
|
|
14270
15097
|
description:
|
|
14271
15098
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14279,8 +15106,17 @@ export default {
|
|
|
14279
15106
|
{
|
|
14280
15107
|
description: 'Delay in setting code on device.',
|
|
14281
15108
|
properties: {
|
|
14282
|
-
created_at: {
|
|
14283
|
-
|
|
15109
|
+
created_at: {
|
|
15110
|
+
description:
|
|
15111
|
+
'Date and time at which Seam created the warning.',
|
|
15112
|
+
format: 'date-time',
|
|
15113
|
+
type: 'string',
|
|
15114
|
+
},
|
|
15115
|
+
message: {
|
|
15116
|
+
description:
|
|
15117
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15118
|
+
type: 'string',
|
|
15119
|
+
},
|
|
14284
15120
|
warning_code: {
|
|
14285
15121
|
description:
|
|
14286
15122
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14294,8 +15130,17 @@ export default {
|
|
|
14294
15130
|
{
|
|
14295
15131
|
description: 'Delay in removing code from device.',
|
|
14296
15132
|
properties: {
|
|
14297
|
-
created_at: {
|
|
14298
|
-
|
|
15133
|
+
created_at: {
|
|
15134
|
+
description:
|
|
15135
|
+
'Date and time at which Seam created the warning.',
|
|
15136
|
+
format: 'date-time',
|
|
15137
|
+
type: 'string',
|
|
15138
|
+
},
|
|
15139
|
+
message: {
|
|
15140
|
+
description:
|
|
15141
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15142
|
+
type: 'string',
|
|
15143
|
+
},
|
|
14299
15144
|
warning_code: {
|
|
14300
15145
|
description:
|
|
14301
15146
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14308,10 +15153,19 @@ export default {
|
|
|
14308
15153
|
},
|
|
14309
15154
|
{
|
|
14310
15155
|
description:
|
|
14311
|
-
'Third
|
|
15156
|
+
'Third-party integration detected that may cause access codes to fail.',
|
|
14312
15157
|
properties: {
|
|
14313
|
-
created_at: {
|
|
14314
|
-
|
|
15158
|
+
created_at: {
|
|
15159
|
+
description:
|
|
15160
|
+
'Date and time at which Seam created the warning.',
|
|
15161
|
+
format: 'date-time',
|
|
15162
|
+
type: 'string',
|
|
15163
|
+
},
|
|
15164
|
+
message: {
|
|
15165
|
+
description:
|
|
15166
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15167
|
+
type: 'string',
|
|
15168
|
+
},
|
|
14315
15169
|
warning_code: {
|
|
14316
15170
|
description:
|
|
14317
15171
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14326,8 +15180,17 @@ export default {
|
|
|
14326
15180
|
description:
|
|
14327
15181
|
'Access code has not yet been fully moved to the device.',
|
|
14328
15182
|
properties: {
|
|
14329
|
-
created_at: {
|
|
14330
|
-
|
|
15183
|
+
created_at: {
|
|
15184
|
+
description:
|
|
15185
|
+
'Date and time at which Seam created the warning.',
|
|
15186
|
+
format: 'date-time',
|
|
15187
|
+
type: 'string',
|
|
15188
|
+
},
|
|
15189
|
+
message: {
|
|
15190
|
+
description:
|
|
15191
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15192
|
+
type: 'string',
|
|
15193
|
+
},
|
|
14331
15194
|
warning_code: {
|
|
14332
15195
|
description:
|
|
14333
15196
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14341,8 +15204,17 @@ export default {
|
|
|
14341
15204
|
{
|
|
14342
15205
|
description: 'August lock is temporarily offline.',
|
|
14343
15206
|
properties: {
|
|
14344
|
-
created_at: {
|
|
14345
|
-
|
|
15207
|
+
created_at: {
|
|
15208
|
+
description:
|
|
15209
|
+
'Date and time at which Seam created the warning.',
|
|
15210
|
+
format: 'date-time',
|
|
15211
|
+
type: 'string',
|
|
15212
|
+
},
|
|
15213
|
+
message: {
|
|
15214
|
+
description:
|
|
15215
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15216
|
+
type: 'string',
|
|
15217
|
+
},
|
|
14346
15218
|
warning_code: {
|
|
14347
15219
|
description:
|
|
14348
15220
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -14356,8 +15228,17 @@ export default {
|
|
|
14356
15228
|
{
|
|
14357
15229
|
description: 'Algopins must be used within 24 hours.',
|
|
14358
15230
|
properties: {
|
|
14359
|
-
created_at: {
|
|
14360
|
-
|
|
15231
|
+
created_at: {
|
|
15232
|
+
description:
|
|
15233
|
+
'Date and time at which Seam created the warning.',
|
|
15234
|
+
format: 'date-time',
|
|
15235
|
+
type: 'string',
|
|
15236
|
+
},
|
|
15237
|
+
message: {
|
|
15238
|
+
description:
|
|
15239
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15240
|
+
type: 'string',
|
|
15241
|
+
},
|
|
14361
15242
|
warning_code: {
|
|
14362
15243
|
description:
|
|
14363
15244
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14372,8 +15253,17 @@ export default {
|
|
|
14372
15253
|
description:
|
|
14373
15254
|
'Management was transferred to another workspace.',
|
|
14374
15255
|
properties: {
|
|
14375
|
-
created_at: {
|
|
14376
|
-
|
|
15256
|
+
created_at: {
|
|
15257
|
+
description:
|
|
15258
|
+
'Date and time at which Seam created the warning.',
|
|
15259
|
+
format: 'date-time',
|
|
15260
|
+
type: 'string',
|
|
15261
|
+
},
|
|
15262
|
+
message: {
|
|
15263
|
+
description:
|
|
15264
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15265
|
+
type: 'string',
|
|
15266
|
+
},
|
|
14377
15267
|
warning_code: {
|
|
14378
15268
|
description:
|
|
14379
15269
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14386,10 +15276,19 @@ export default {
|
|
|
14386
15276
|
},
|
|
14387
15277
|
{
|
|
14388
15278
|
description:
|
|
14389
|
-
'Unable to confirm the access code is set on Kwikset device.',
|
|
15279
|
+
'Unable to confirm that the access code is set on Kwikset device.',
|
|
14390
15280
|
properties: {
|
|
14391
|
-
created_at: {
|
|
14392
|
-
|
|
15281
|
+
created_at: {
|
|
15282
|
+
description:
|
|
15283
|
+
'Date and time at which Seam created the warning.',
|
|
15284
|
+
format: 'date-time',
|
|
15285
|
+
type: 'string',
|
|
15286
|
+
},
|
|
15287
|
+
message: {
|
|
15288
|
+
description:
|
|
15289
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15290
|
+
type: 'string',
|
|
15291
|
+
},
|
|
14393
15292
|
warning_code: {
|
|
14394
15293
|
description:
|
|
14395
15294
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -15180,16 +16079,13 @@ export default {
|
|
|
15180
16079
|
from: {
|
|
15181
16080
|
properties: {
|
|
15182
16081
|
ends_at: {
|
|
15183
|
-
description:
|
|
15184
|
-
"Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
15185
16082
|
format: 'date-time',
|
|
15186
16083
|
nullable: true,
|
|
15187
16084
|
type: 'string',
|
|
15188
16085
|
},
|
|
15189
16086
|
starts_at: {
|
|
15190
|
-
description:
|
|
15191
|
-
"Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
15192
16087
|
format: 'date-time',
|
|
16088
|
+
nullable: true,
|
|
15193
16089
|
type: 'string',
|
|
15194
16090
|
},
|
|
15195
16091
|
},
|
|
@@ -15203,16 +16099,13 @@ export default {
|
|
|
15203
16099
|
to: {
|
|
15204
16100
|
properties: {
|
|
15205
16101
|
ends_at: {
|
|
15206
|
-
description:
|
|
15207
|
-
"Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
15208
16102
|
format: 'date-time',
|
|
15209
16103
|
nullable: true,
|
|
15210
16104
|
type: 'string',
|
|
15211
16105
|
},
|
|
15212
16106
|
starts_at: {
|
|
15213
|
-
description:
|
|
15214
|
-
"Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
15215
16107
|
format: 'date-time',
|
|
16108
|
+
nullable: true,
|
|
15216
16109
|
type: 'string',
|
|
15217
16110
|
},
|
|
15218
16111
|
},
|
|
@@ -16434,40 +17327,98 @@ export default {
|
|
|
16434
17327
|
paths: {
|
|
16435
17328
|
'/access_codes/create': {
|
|
16436
17329
|
post: {
|
|
17330
|
+
description:
|
|
17331
|
+
'Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
16437
17332
|
operationId: 'accessCodesCreatePost',
|
|
16438
17333
|
requestBody: {
|
|
16439
17334
|
content: {
|
|
16440
17335
|
'application/json': {
|
|
16441
17336
|
schema: {
|
|
16442
17337
|
properties: {
|
|
16443
|
-
allow_external_modification: {
|
|
17338
|
+
allow_external_modification: {
|
|
17339
|
+
description:
|
|
17340
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17341
|
+
type: 'boolean',
|
|
17342
|
+
},
|
|
16444
17343
|
attempt_for_offline_device: {
|
|
16445
17344
|
default: true,
|
|
16446
17345
|
type: 'boolean',
|
|
16447
17346
|
},
|
|
16448
17347
|
code: {
|
|
17348
|
+
description: 'Code to be used for access.',
|
|
16449
17349
|
maxLength: 9,
|
|
16450
17350
|
minLength: 4,
|
|
16451
17351
|
pattern: '^\\d+$',
|
|
16452
17352
|
type: 'string',
|
|
16453
17353
|
},
|
|
16454
|
-
common_code_key: {
|
|
16455
|
-
|
|
16456
|
-
|
|
16457
|
-
|
|
16458
|
-
|
|
16459
|
-
|
|
17354
|
+
common_code_key: {
|
|
17355
|
+
description:
|
|
17356
|
+
'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).',
|
|
17357
|
+
type: 'string',
|
|
17358
|
+
},
|
|
17359
|
+
device_id: {
|
|
17360
|
+
description:
|
|
17361
|
+
'ID of the device for which to create the new access code.',
|
|
17362
|
+
format: 'uuid',
|
|
17363
|
+
type: 'string',
|
|
17364
|
+
},
|
|
17365
|
+
ends_at: {
|
|
17366
|
+
description:
|
|
17367
|
+
'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`.',
|
|
17368
|
+
type: 'string',
|
|
17369
|
+
},
|
|
17370
|
+
is_external_modification_allowed: {
|
|
17371
|
+
description:
|
|
17372
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17373
|
+
type: 'boolean',
|
|
17374
|
+
},
|
|
17375
|
+
is_offline_access_code: {
|
|
17376
|
+
description:
|
|
17377
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17378
|
+
type: 'boolean',
|
|
17379
|
+
},
|
|
17380
|
+
is_one_time_use: {
|
|
17381
|
+
description:
|
|
17382
|
+
'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.',
|
|
17383
|
+
type: 'boolean',
|
|
17384
|
+
},
|
|
16460
17385
|
max_time_rounding: {
|
|
16461
17386
|
default: '1hour',
|
|
17387
|
+
description:
|
|
17388
|
+
'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
17389
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16463
17390
|
type: 'string',
|
|
16464
17391
|
},
|
|
16465
|
-
name: {
|
|
16466
|
-
|
|
16467
|
-
|
|
16468
|
-
|
|
16469
|
-
|
|
16470
|
-
|
|
17392
|
+
name: {
|
|
17393
|
+
description: 'Name of the new access code.',
|
|
17394
|
+
type: 'string',
|
|
17395
|
+
},
|
|
17396
|
+
prefer_native_scheduling: {
|
|
17397
|
+
description:
|
|
17398
|
+
'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`.',
|
|
17399
|
+
type: 'boolean',
|
|
17400
|
+
},
|
|
17401
|
+
preferred_code_length: {
|
|
17402
|
+
description:
|
|
17403
|
+
'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.',
|
|
17404
|
+
format: 'float',
|
|
17405
|
+
type: 'number',
|
|
17406
|
+
},
|
|
17407
|
+
starts_at: {
|
|
17408
|
+
description:
|
|
17409
|
+
'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.',
|
|
17410
|
+
type: 'string',
|
|
17411
|
+
},
|
|
17412
|
+
sync: {
|
|
17413
|
+
default: false,
|
|
17414
|
+
type: 'boolean',
|
|
17415
|
+
'x-undocumented': 'Only used internally.',
|
|
17416
|
+
},
|
|
17417
|
+
use_backup_access_code_pool: {
|
|
17418
|
+
description:
|
|
17419
|
+
'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).',
|
|
17420
|
+
type: 'boolean',
|
|
17421
|
+
},
|
|
16471
17422
|
use_offline_access_code: { type: 'boolean' },
|
|
16472
17423
|
},
|
|
16473
17424
|
required: ['device_id'],
|
|
@@ -16511,50 +17462,100 @@ export default {
|
|
|
16511
17462
|
'x-fern-sdk-method-name': 'create',
|
|
16512
17463
|
'x-fern-sdk-return-value': 'access_code',
|
|
16513
17464
|
'x-response-key': 'access_code',
|
|
17465
|
+
'x-title': 'Create an Access Code',
|
|
16514
17466
|
},
|
|
16515
17467
|
},
|
|
16516
17468
|
'/access_codes/create_multiple': {
|
|
16517
17469
|
post: {
|
|
17470
|
+
description:
|
|
17471
|
+
'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
17472
|
operationId: 'accessCodesCreateMultiplePost',
|
|
16519
17473
|
requestBody: {
|
|
16520
17474
|
content: {
|
|
16521
17475
|
'application/json': {
|
|
16522
17476
|
schema: {
|
|
16523
17477
|
properties: {
|
|
16524
|
-
allow_external_modification: {
|
|
17478
|
+
allow_external_modification: {
|
|
17479
|
+
description:
|
|
17480
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17481
|
+
type: 'boolean',
|
|
17482
|
+
},
|
|
16525
17483
|
attempt_for_offline_device: {
|
|
16526
17484
|
default: true,
|
|
16527
17485
|
type: 'boolean',
|
|
16528
17486
|
},
|
|
16529
17487
|
behavior_when_code_cannot_be_shared: {
|
|
16530
17488
|
default: 'throw',
|
|
17489
|
+
description:
|
|
17490
|
+
'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
17491
|
enum: ['throw', 'create_random_code'],
|
|
16532
17492
|
type: 'string',
|
|
16533
17493
|
},
|
|
16534
17494
|
code: {
|
|
17495
|
+
description: 'Code to be used for access.',
|
|
16535
17496
|
maxLength: 9,
|
|
16536
17497
|
minLength: 4,
|
|
16537
17498
|
pattern: '^\\d+$',
|
|
16538
17499
|
type: 'string',
|
|
16539
17500
|
},
|
|
16540
17501
|
device_ids: {
|
|
17502
|
+
description:
|
|
17503
|
+
'IDs of the devices for which to create the new access codes.',
|
|
16541
17504
|
items: { format: 'uuid', type: 'string' },
|
|
16542
17505
|
type: 'array',
|
|
16543
17506
|
},
|
|
16544
|
-
ends_at: {
|
|
16545
|
-
|
|
16546
|
-
|
|
16547
|
-
|
|
17507
|
+
ends_at: {
|
|
17508
|
+
description:
|
|
17509
|
+
'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`.',
|
|
17510
|
+
type: 'string',
|
|
17511
|
+
},
|
|
17512
|
+
is_external_modification_allowed: {
|
|
17513
|
+
description:
|
|
17514
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17515
|
+
type: 'boolean',
|
|
17516
|
+
},
|
|
17517
|
+
is_offline_access_code: {
|
|
17518
|
+
description:
|
|
17519
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17520
|
+
type: 'boolean',
|
|
17521
|
+
},
|
|
17522
|
+
is_one_time_use: {
|
|
17523
|
+
description:
|
|
17524
|
+
'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.',
|
|
17525
|
+
type: 'boolean',
|
|
17526
|
+
},
|
|
16548
17527
|
max_time_rounding: {
|
|
16549
17528
|
default: '1hour',
|
|
17529
|
+
description:
|
|
17530
|
+
'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
17531
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16551
17532
|
type: 'string',
|
|
16552
17533
|
},
|
|
16553
|
-
name: {
|
|
16554
|
-
|
|
16555
|
-
|
|
16556
|
-
|
|
16557
|
-
|
|
17534
|
+
name: {
|
|
17535
|
+
description: 'Name of the new access code.',
|
|
17536
|
+
type: 'string',
|
|
17537
|
+
},
|
|
17538
|
+
prefer_native_scheduling: {
|
|
17539
|
+
description:
|
|
17540
|
+
'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`.',
|
|
17541
|
+
type: 'boolean',
|
|
17542
|
+
},
|
|
17543
|
+
preferred_code_length: {
|
|
17544
|
+
description:
|
|
17545
|
+
'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.',
|
|
17546
|
+
format: 'float',
|
|
17547
|
+
type: 'number',
|
|
17548
|
+
},
|
|
17549
|
+
starts_at: {
|
|
17550
|
+
description:
|
|
17551
|
+
'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.',
|
|
17552
|
+
type: 'string',
|
|
17553
|
+
},
|
|
17554
|
+
use_backup_access_code_pool: {
|
|
17555
|
+
description:
|
|
17556
|
+
'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).',
|
|
17557
|
+
type: 'boolean',
|
|
17558
|
+
},
|
|
16558
17559
|
use_offline_access_code: { type: 'boolean' },
|
|
16559
17560
|
},
|
|
16560
17561
|
required: ['device_ids'],
|
|
@@ -16597,48 +17598,98 @@ export default {
|
|
|
16597
17598
|
'x-fern-sdk-method-name': 'create_multiple',
|
|
16598
17599
|
'x-fern-sdk-return-value': 'access_codes',
|
|
16599
17600
|
'x-response-key': 'access_codes',
|
|
17601
|
+
'x-title': 'Create Multiple Linked Access Codes',
|
|
16600
17602
|
},
|
|
16601
17603
|
put: {
|
|
17604
|
+
description:
|
|
17605
|
+
'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
17606
|
operationId: 'accessCodesCreateMultiplePut',
|
|
16603
17607
|
requestBody: {
|
|
16604
17608
|
content: {
|
|
16605
17609
|
'application/json': {
|
|
16606
17610
|
schema: {
|
|
16607
17611
|
properties: {
|
|
16608
|
-
allow_external_modification: {
|
|
17612
|
+
allow_external_modification: {
|
|
17613
|
+
description:
|
|
17614
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17615
|
+
type: 'boolean',
|
|
17616
|
+
},
|
|
16609
17617
|
attempt_for_offline_device: {
|
|
16610
17618
|
default: true,
|
|
16611
17619
|
type: 'boolean',
|
|
16612
17620
|
},
|
|
16613
17621
|
behavior_when_code_cannot_be_shared: {
|
|
16614
17622
|
default: 'throw',
|
|
17623
|
+
description:
|
|
17624
|
+
'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
17625
|
enum: ['throw', 'create_random_code'],
|
|
16616
17626
|
type: 'string',
|
|
16617
17627
|
},
|
|
16618
17628
|
code: {
|
|
17629
|
+
description: 'Code to be used for access.',
|
|
16619
17630
|
maxLength: 9,
|
|
16620
17631
|
minLength: 4,
|
|
16621
17632
|
pattern: '^\\d+$',
|
|
16622
17633
|
type: 'string',
|
|
16623
17634
|
},
|
|
16624
17635
|
device_ids: {
|
|
17636
|
+
description:
|
|
17637
|
+
'IDs of the devices for which to create the new access codes.',
|
|
16625
17638
|
items: { format: 'uuid', type: 'string' },
|
|
16626
17639
|
type: 'array',
|
|
16627
17640
|
},
|
|
16628
|
-
ends_at: {
|
|
16629
|
-
|
|
16630
|
-
|
|
16631
|
-
|
|
17641
|
+
ends_at: {
|
|
17642
|
+
description:
|
|
17643
|
+
'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`.',
|
|
17644
|
+
type: 'string',
|
|
17645
|
+
},
|
|
17646
|
+
is_external_modification_allowed: {
|
|
17647
|
+
description:
|
|
17648
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17649
|
+
type: 'boolean',
|
|
17650
|
+
},
|
|
17651
|
+
is_offline_access_code: {
|
|
17652
|
+
description:
|
|
17653
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17654
|
+
type: 'boolean',
|
|
17655
|
+
},
|
|
17656
|
+
is_one_time_use: {
|
|
17657
|
+
description:
|
|
17658
|
+
'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.',
|
|
17659
|
+
type: 'boolean',
|
|
17660
|
+
},
|
|
16632
17661
|
max_time_rounding: {
|
|
16633
17662
|
default: '1hour',
|
|
17663
|
+
description:
|
|
17664
|
+
'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
17665
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16635
17666
|
type: 'string',
|
|
16636
17667
|
},
|
|
16637
|
-
name: {
|
|
16638
|
-
|
|
16639
|
-
|
|
16640
|
-
|
|
16641
|
-
|
|
17668
|
+
name: {
|
|
17669
|
+
description: 'Name of the new access code.',
|
|
17670
|
+
type: 'string',
|
|
17671
|
+
},
|
|
17672
|
+
prefer_native_scheduling: {
|
|
17673
|
+
description:
|
|
17674
|
+
'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`.',
|
|
17675
|
+
type: 'boolean',
|
|
17676
|
+
},
|
|
17677
|
+
preferred_code_length: {
|
|
17678
|
+
description:
|
|
17679
|
+
'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.',
|
|
17680
|
+
format: 'float',
|
|
17681
|
+
type: 'number',
|
|
17682
|
+
},
|
|
17683
|
+
starts_at: {
|
|
17684
|
+
description:
|
|
17685
|
+
'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.',
|
|
17686
|
+
type: 'string',
|
|
17687
|
+
},
|
|
17688
|
+
use_backup_access_code_pool: {
|
|
17689
|
+
description:
|
|
17690
|
+
'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).',
|
|
17691
|
+
type: 'boolean',
|
|
17692
|
+
},
|
|
16642
17693
|
use_offline_access_code: { type: 'boolean' },
|
|
16643
17694
|
},
|
|
16644
17695
|
required: ['device_ids'],
|
|
@@ -16679,19 +17730,35 @@ export default {
|
|
|
16679
17730
|
tags: ['/access_codes'],
|
|
16680
17731
|
'x-fern-ignore': true,
|
|
16681
17732
|
'x-response-key': 'access_codes',
|
|
17733
|
+
'x-title': 'Create Multiple Linked Access Codes',
|
|
16682
17734
|
},
|
|
16683
17735
|
},
|
|
16684
17736
|
'/access_codes/delete': {
|
|
16685
17737
|
post: {
|
|
17738
|
+
description:
|
|
17739
|
+
'Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
16686
17740
|
operationId: 'accessCodesDeletePost',
|
|
16687
17741
|
requestBody: {
|
|
16688
17742
|
content: {
|
|
16689
17743
|
'application/json': {
|
|
16690
17744
|
schema: {
|
|
16691
17745
|
properties: {
|
|
16692
|
-
access_code_id: {
|
|
16693
|
-
|
|
16694
|
-
|
|
17746
|
+
access_code_id: {
|
|
17747
|
+
description: 'ID of the access code to delete.',
|
|
17748
|
+
format: 'uuid',
|
|
17749
|
+
type: 'string',
|
|
17750
|
+
},
|
|
17751
|
+
device_id: {
|
|
17752
|
+
description:
|
|
17753
|
+
'ID of the device for which to delete the access code.',
|
|
17754
|
+
format: 'uuid',
|
|
17755
|
+
type: 'string',
|
|
17756
|
+
},
|
|
17757
|
+
sync: {
|
|
17758
|
+
default: false,
|
|
17759
|
+
type: 'boolean',
|
|
17760
|
+
'x-undocumented': 'Only used internally.',
|
|
17761
|
+
},
|
|
16695
17762
|
},
|
|
16696
17763
|
required: ['access_code_id'],
|
|
16697
17764
|
type: 'object',
|
|
@@ -16732,6 +17799,7 @@ export default {
|
|
|
16732
17799
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
16733
17800
|
'x-fern-sdk-method-name': 'delete',
|
|
16734
17801
|
'x-response-key': null,
|
|
17802
|
+
'x-title': 'Delete an Access Code',
|
|
16735
17803
|
},
|
|
16736
17804
|
},
|
|
16737
17805
|
'/access_codes/generate_code': {
|
|
@@ -16785,15 +17853,31 @@ export default {
|
|
|
16785
17853
|
},
|
|
16786
17854
|
'/access_codes/get': {
|
|
16787
17855
|
post: {
|
|
17856
|
+
description:
|
|
17857
|
+
'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
17858
|
operationId: 'accessCodesGetPost',
|
|
16789
17859
|
requestBody: {
|
|
16790
17860
|
content: {
|
|
16791
17861
|
'application/json': {
|
|
16792
17862
|
schema: {
|
|
16793
17863
|
properties: {
|
|
16794
|
-
access_code_id: {
|
|
16795
|
-
|
|
16796
|
-
|
|
17864
|
+
access_code_id: {
|
|
17865
|
+
description:
|
|
17866
|
+
'ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
17867
|
+
format: 'uuid',
|
|
17868
|
+
type: 'string',
|
|
17869
|
+
},
|
|
17870
|
+
code: {
|
|
17871
|
+
description:
|
|
17872
|
+
'Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
17873
|
+
type: 'string',
|
|
17874
|
+
},
|
|
17875
|
+
device_id: {
|
|
17876
|
+
description:
|
|
17877
|
+
'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`.',
|
|
17878
|
+
format: 'uuid',
|
|
17879
|
+
type: 'string',
|
|
17880
|
+
},
|
|
16797
17881
|
},
|
|
16798
17882
|
type: 'object',
|
|
16799
17883
|
},
|
|
@@ -16831,10 +17915,13 @@ export default {
|
|
|
16831
17915
|
'x-fern-sdk-method-name': 'get',
|
|
16832
17916
|
'x-fern-sdk-return-value': 'access_code',
|
|
16833
17917
|
'x-response-key': 'access_code',
|
|
17918
|
+
'x-title': 'Get an Access Code',
|
|
16834
17919
|
},
|
|
16835
17920
|
},
|
|
16836
17921
|
'/access_codes/list': {
|
|
16837
17922
|
post: {
|
|
17923
|
+
description:
|
|
17924
|
+
'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
17925
|
operationId: 'accessCodesListPost',
|
|
16839
17926
|
requestBody: {
|
|
16840
17927
|
content: {
|
|
@@ -16842,11 +17929,22 @@ export default {
|
|
|
16842
17929
|
schema: {
|
|
16843
17930
|
properties: {
|
|
16844
17931
|
access_code_ids: {
|
|
17932
|
+
description:
|
|
17933
|
+
'IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.',
|
|
16845
17934
|
items: { format: 'uuid', type: 'string' },
|
|
16846
17935
|
type: 'array',
|
|
16847
17936
|
},
|
|
16848
|
-
device_id: {
|
|
16849
|
-
|
|
17937
|
+
device_id: {
|
|
17938
|
+
description:
|
|
17939
|
+
'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
|
|
17940
|
+
format: 'uuid',
|
|
17941
|
+
type: 'string',
|
|
17942
|
+
},
|
|
17943
|
+
user_identifier_key: {
|
|
17944
|
+
description:
|
|
17945
|
+
'Your user ID for the user by which to filter access codes.',
|
|
17946
|
+
type: 'string',
|
|
17947
|
+
},
|
|
16850
17948
|
},
|
|
16851
17949
|
type: 'object',
|
|
16852
17950
|
},
|
|
@@ -16887,19 +17985,25 @@ export default {
|
|
|
16887
17985
|
'x-fern-sdk-method-name': 'list',
|
|
16888
17986
|
'x-fern-sdk-return-value': 'access_codes',
|
|
16889
17987
|
'x-response-key': 'access_codes',
|
|
17988
|
+
'x-title': 'List Access Codes',
|
|
16890
17989
|
},
|
|
16891
17990
|
},
|
|
16892
17991
|
'/access_codes/pull_backup_access_code': {
|
|
16893
17992
|
post: {
|
|
16894
17993
|
description:
|
|
16895
|
-
|
|
17994
|
+
"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
17995
|
operationId: 'accessCodesPullBackupAccessCodePost',
|
|
16897
17996
|
requestBody: {
|
|
16898
17997
|
content: {
|
|
16899
17998
|
'application/json': {
|
|
16900
17999
|
schema: {
|
|
16901
18000
|
properties: {
|
|
16902
|
-
access_code_id: {
|
|
18001
|
+
access_code_id: {
|
|
18002
|
+
description:
|
|
18003
|
+
'ID of the access code for which you want to pull a backup access code.',
|
|
18004
|
+
format: 'uuid',
|
|
18005
|
+
type: 'string',
|
|
18006
|
+
},
|
|
16903
18007
|
},
|
|
16904
18008
|
required: ['access_code_id'],
|
|
16905
18009
|
type: 'object',
|
|
@@ -16941,10 +18045,13 @@ export default {
|
|
|
16941
18045
|
'x-fern-sdk-method-name': 'pull_backup_access_code',
|
|
16942
18046
|
'x-fern-sdk-return-value': 'access_code',
|
|
16943
18047
|
'x-response-key': 'access_code',
|
|
18048
|
+
'x-title': 'Pull a Backup Access Code',
|
|
16944
18049
|
},
|
|
16945
18050
|
},
|
|
16946
18051
|
'/access_codes/simulate/create_unmanaged_access_code': {
|
|
16947
18052
|
post: {
|
|
18053
|
+
description:
|
|
18054
|
+
'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
18055
|
operationId: 'accessCodesSimulateCreateUnmanagedAccessCodePost',
|
|
16949
18056
|
requestBody: {
|
|
16950
18057
|
content: {
|
|
@@ -16952,13 +18059,22 @@ export default {
|
|
|
16952
18059
|
schema: {
|
|
16953
18060
|
properties: {
|
|
16954
18061
|
code: {
|
|
18062
|
+
description: 'Code of the simulated unmanaged access code.',
|
|
16955
18063
|
maxLength: 8,
|
|
16956
18064
|
minLength: 4,
|
|
16957
18065
|
pattern: '^\\d+$',
|
|
16958
18066
|
type: 'string',
|
|
16959
18067
|
},
|
|
16960
|
-
device_id: {
|
|
16961
|
-
|
|
18068
|
+
device_id: {
|
|
18069
|
+
description:
|
|
18070
|
+
'ID of the device for which you want to simulate the creation of an unmanaged access code.',
|
|
18071
|
+
format: 'uuid',
|
|
18072
|
+
type: 'string',
|
|
18073
|
+
},
|
|
18074
|
+
name: {
|
|
18075
|
+
description: 'Name of the simulated unmanaged access code.',
|
|
18076
|
+
type: 'string',
|
|
18077
|
+
},
|
|
16962
18078
|
},
|
|
16963
18079
|
required: ['device_id', 'name', 'code'],
|
|
16964
18080
|
type: 'object',
|
|
@@ -16999,21 +18115,45 @@ export default {
|
|
|
16999
18115
|
'x-fern-sdk-method-name': 'create_unmanaged_access_code',
|
|
17000
18116
|
'x-fern-sdk-return-value': 'access_code',
|
|
17001
18117
|
'x-response-key': 'access_code',
|
|
18118
|
+
'x-title': 'Simulate Creating an Unmanaged Access Code',
|
|
17002
18119
|
},
|
|
17003
18120
|
},
|
|
17004
18121
|
'/access_codes/unmanaged/convert_to_managed': {
|
|
17005
18122
|
patch: {
|
|
18123
|
+
description:
|
|
18124
|
+
'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
18125
|
operationId: 'accessCodesUnmanagedConvertToManagedPatch',
|
|
17007
18126
|
requestBody: {
|
|
17008
18127
|
content: {
|
|
17009
18128
|
'application/json': {
|
|
17010
18129
|
schema: {
|
|
17011
18130
|
properties: {
|
|
17012
|
-
access_code_id: {
|
|
17013
|
-
|
|
17014
|
-
|
|
17015
|
-
|
|
17016
|
-
|
|
18131
|
+
access_code_id: {
|
|
18132
|
+
description:
|
|
18133
|
+
'ID of the unmanaged access code that you want to convert to a managed access code.',
|
|
18134
|
+
format: 'uuid',
|
|
18135
|
+
type: 'string',
|
|
18136
|
+
},
|
|
18137
|
+
allow_external_modification: {
|
|
18138
|
+
description:
|
|
18139
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18140
|
+
type: 'boolean',
|
|
18141
|
+
},
|
|
18142
|
+
force: {
|
|
18143
|
+
description:
|
|
18144
|
+
'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`.',
|
|
18145
|
+
type: 'boolean',
|
|
18146
|
+
},
|
|
18147
|
+
is_external_modification_allowed: {
|
|
18148
|
+
description:
|
|
18149
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18150
|
+
type: 'boolean',
|
|
18151
|
+
},
|
|
18152
|
+
sync: {
|
|
18153
|
+
default: false,
|
|
18154
|
+
type: 'boolean',
|
|
18155
|
+
'x-undocumented': 'Only used internally.',
|
|
18156
|
+
},
|
|
17017
18157
|
},
|
|
17018
18158
|
required: ['access_code_id'],
|
|
17019
18159
|
type: 'object',
|
|
@@ -17048,19 +18188,43 @@ export default {
|
|
|
17048
18188
|
'x-action-attempt-type': 'CONVERT_ACCESS_CODE_TO_MANAGED',
|
|
17049
18189
|
'x-fern-ignore': true,
|
|
17050
18190
|
'x-response-key': null,
|
|
18191
|
+
'x-title': 'Convert an Unmanaged Access Code',
|
|
17051
18192
|
},
|
|
17052
18193
|
post: {
|
|
18194
|
+
description:
|
|
18195
|
+
'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
18196
|
operationId: 'accessCodesUnmanagedConvertToManagedPost',
|
|
17054
18197
|
requestBody: {
|
|
17055
18198
|
content: {
|
|
17056
18199
|
'application/json': {
|
|
17057
18200
|
schema: {
|
|
17058
18201
|
properties: {
|
|
17059
|
-
access_code_id: {
|
|
17060
|
-
|
|
17061
|
-
|
|
17062
|
-
|
|
17063
|
-
|
|
18202
|
+
access_code_id: {
|
|
18203
|
+
description:
|
|
18204
|
+
'ID of the unmanaged access code that you want to convert to a managed access code.',
|
|
18205
|
+
format: 'uuid',
|
|
18206
|
+
type: 'string',
|
|
18207
|
+
},
|
|
18208
|
+
allow_external_modification: {
|
|
18209
|
+
description:
|
|
18210
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18211
|
+
type: 'boolean',
|
|
18212
|
+
},
|
|
18213
|
+
force: {
|
|
18214
|
+
description:
|
|
18215
|
+
'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`.',
|
|
18216
|
+
type: 'boolean',
|
|
18217
|
+
},
|
|
18218
|
+
is_external_modification_allowed: {
|
|
18219
|
+
description:
|
|
18220
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18221
|
+
type: 'boolean',
|
|
18222
|
+
},
|
|
18223
|
+
sync: {
|
|
18224
|
+
default: false,
|
|
18225
|
+
type: 'boolean',
|
|
18226
|
+
'x-undocumented': 'Only used internally.',
|
|
18227
|
+
},
|
|
17064
18228
|
},
|
|
17065
18229
|
required: ['access_code_id'],
|
|
17066
18230
|
type: 'object',
|
|
@@ -17096,18 +18260,29 @@ export default {
|
|
|
17096
18260
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
17097
18261
|
'x-fern-sdk-method-name': 'convert_to_managed',
|
|
17098
18262
|
'x-response-key': null,
|
|
18263
|
+
'x-title': 'Convert an Unmanaged Access Code',
|
|
17099
18264
|
},
|
|
17100
18265
|
},
|
|
17101
18266
|
'/access_codes/unmanaged/delete': {
|
|
17102
18267
|
post: {
|
|
18268
|
+
description:
|
|
18269
|
+
'Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17103
18270
|
operationId: 'accessCodesUnmanagedDeletePost',
|
|
17104
18271
|
requestBody: {
|
|
17105
18272
|
content: {
|
|
17106
18273
|
'application/json': {
|
|
17107
18274
|
schema: {
|
|
17108
18275
|
properties: {
|
|
17109
|
-
access_code_id: {
|
|
17110
|
-
|
|
18276
|
+
access_code_id: {
|
|
18277
|
+
description: 'ID of the unmanaged access code to delete.',
|
|
18278
|
+
format: 'uuid',
|
|
18279
|
+
type: 'string',
|
|
18280
|
+
},
|
|
18281
|
+
sync: {
|
|
18282
|
+
default: false,
|
|
18283
|
+
type: 'boolean',
|
|
18284
|
+
'x-undocumented': 'Only used internally.',
|
|
18285
|
+
},
|
|
17111
18286
|
},
|
|
17112
18287
|
required: ['access_code_id'],
|
|
17113
18288
|
type: 'object',
|
|
@@ -17148,19 +18323,36 @@ export default {
|
|
|
17148
18323
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
17149
18324
|
'x-fern-sdk-method-name': 'delete',
|
|
17150
18325
|
'x-response-key': null,
|
|
18326
|
+
'x-title': 'Delete an Unmanaged Access Code',
|
|
17151
18327
|
},
|
|
17152
18328
|
},
|
|
17153
18329
|
'/access_codes/unmanaged/get': {
|
|
17154
18330
|
post: {
|
|
18331
|
+
description:
|
|
18332
|
+
'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
18333
|
operationId: 'accessCodesUnmanagedGetPost',
|
|
17156
18334
|
requestBody: {
|
|
17157
18335
|
content: {
|
|
17158
18336
|
'application/json': {
|
|
17159
18337
|
schema: {
|
|
17160
18338
|
properties: {
|
|
17161
|
-
access_code_id: {
|
|
17162
|
-
|
|
17163
|
-
|
|
18339
|
+
access_code_id: {
|
|
18340
|
+
description:
|
|
18341
|
+
'ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
18342
|
+
format: 'uuid',
|
|
18343
|
+
type: 'string',
|
|
18344
|
+
},
|
|
18345
|
+
code: {
|
|
18346
|
+
description:
|
|
18347
|
+
'Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
18348
|
+
type: 'string',
|
|
18349
|
+
},
|
|
18350
|
+
device_id: {
|
|
18351
|
+
description:
|
|
18352
|
+
'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`.',
|
|
18353
|
+
format: 'uuid',
|
|
18354
|
+
type: 'string',
|
|
18355
|
+
},
|
|
17164
18356
|
},
|
|
17165
18357
|
type: 'object',
|
|
17166
18358
|
},
|
|
@@ -17200,18 +18392,30 @@ export default {
|
|
|
17200
18392
|
'x-fern-sdk-method-name': 'get',
|
|
17201
18393
|
'x-fern-sdk-return-value': 'access_code',
|
|
17202
18394
|
'x-response-key': 'access_code',
|
|
18395
|
+
'x-title': 'Get an Unmanaged Access Code',
|
|
17203
18396
|
},
|
|
17204
18397
|
},
|
|
17205
18398
|
'/access_codes/unmanaged/list': {
|
|
17206
18399
|
post: {
|
|
18400
|
+
description:
|
|
18401
|
+
'Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17207
18402
|
operationId: 'accessCodesUnmanagedListPost',
|
|
17208
18403
|
requestBody: {
|
|
17209
18404
|
content: {
|
|
17210
18405
|
'application/json': {
|
|
17211
18406
|
schema: {
|
|
17212
18407
|
properties: {
|
|
17213
|
-
device_id: {
|
|
17214
|
-
|
|
18408
|
+
device_id: {
|
|
18409
|
+
description:
|
|
18410
|
+
'ID of the device for which you want to list unmanaged access codes.',
|
|
18411
|
+
format: 'uuid',
|
|
18412
|
+
type: 'string',
|
|
18413
|
+
},
|
|
18414
|
+
user_identifier_key: {
|
|
18415
|
+
description:
|
|
18416
|
+
'Your user ID for the user by which to filter unmanaged access codes.',
|
|
18417
|
+
type: 'string',
|
|
18418
|
+
},
|
|
17215
18419
|
},
|
|
17216
18420
|
required: ['device_id'],
|
|
17217
18421
|
type: 'object',
|
|
@@ -17255,20 +18459,40 @@ export default {
|
|
|
17255
18459
|
'x-fern-sdk-method-name': 'list',
|
|
17256
18460
|
'x-fern-sdk-return-value': 'access_codes',
|
|
17257
18461
|
'x-response-key': 'access_codes',
|
|
18462
|
+
'x-title': 'List Unmanaged Access Codes',
|
|
17258
18463
|
},
|
|
17259
18464
|
},
|
|
17260
18465
|
'/access_codes/unmanaged/update': {
|
|
17261
18466
|
patch: {
|
|
18467
|
+
description:
|
|
18468
|
+
'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17262
18469
|
operationId: 'accessCodesUnmanagedUpdatePatch',
|
|
17263
18470
|
requestBody: {
|
|
17264
18471
|
content: {
|
|
17265
18472
|
'application/json': {
|
|
17266
18473
|
schema: {
|
|
17267
18474
|
properties: {
|
|
17268
|
-
access_code_id: {
|
|
17269
|
-
|
|
17270
|
-
|
|
17271
|
-
|
|
18475
|
+
access_code_id: {
|
|
18476
|
+
description:
|
|
18477
|
+
'ID of the unmanaged access code that you want to update.',
|
|
18478
|
+
format: 'uuid',
|
|
18479
|
+
type: 'string',
|
|
18480
|
+
},
|
|
18481
|
+
allow_external_modification: {
|
|
18482
|
+
description:
|
|
18483
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18484
|
+
type: 'boolean',
|
|
18485
|
+
},
|
|
18486
|
+
force: {
|
|
18487
|
+
description:
|
|
18488
|
+
'Indicates whether to force the unmanaged access code update.',
|
|
18489
|
+
type: 'boolean',
|
|
18490
|
+
},
|
|
18491
|
+
is_external_modification_allowed: {
|
|
18492
|
+
description:
|
|
18493
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18494
|
+
type: 'boolean',
|
|
18495
|
+
},
|
|
17272
18496
|
is_managed: { type: 'boolean' },
|
|
17273
18497
|
},
|
|
17274
18498
|
required: ['access_code_id', 'is_managed'],
|
|
@@ -17303,18 +18527,38 @@ export default {
|
|
|
17303
18527
|
tags: ['/access_codes'],
|
|
17304
18528
|
'x-fern-ignore': true,
|
|
17305
18529
|
'x-response-key': null,
|
|
18530
|
+
'x-title': 'Update an Unmanaged Access Code',
|
|
17306
18531
|
},
|
|
17307
18532
|
post: {
|
|
18533
|
+
description:
|
|
18534
|
+
'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17308
18535
|
operationId: 'accessCodesUnmanagedUpdatePost',
|
|
17309
18536
|
requestBody: {
|
|
17310
18537
|
content: {
|
|
17311
18538
|
'application/json': {
|
|
17312
18539
|
schema: {
|
|
17313
18540
|
properties: {
|
|
17314
|
-
access_code_id: {
|
|
17315
|
-
|
|
17316
|
-
|
|
17317
|
-
|
|
18541
|
+
access_code_id: {
|
|
18542
|
+
description:
|
|
18543
|
+
'ID of the unmanaged access code that you want to update.',
|
|
18544
|
+
format: 'uuid',
|
|
18545
|
+
type: 'string',
|
|
18546
|
+
},
|
|
18547
|
+
allow_external_modification: {
|
|
18548
|
+
description:
|
|
18549
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18550
|
+
type: 'boolean',
|
|
18551
|
+
},
|
|
18552
|
+
force: {
|
|
18553
|
+
description:
|
|
18554
|
+
'Indicates whether to force the unmanaged access code update.',
|
|
18555
|
+
type: 'boolean',
|
|
18556
|
+
},
|
|
18557
|
+
is_external_modification_allowed: {
|
|
18558
|
+
description:
|
|
18559
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18560
|
+
type: 'boolean',
|
|
18561
|
+
},
|
|
17318
18562
|
is_managed: { type: 'boolean' },
|
|
17319
18563
|
},
|
|
17320
18564
|
required: ['access_code_id', 'is_managed'],
|
|
@@ -17350,46 +18594,115 @@ export default {
|
|
|
17350
18594
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
17351
18595
|
'x-fern-sdk-method-name': 'update',
|
|
17352
18596
|
'x-response-key': null,
|
|
18597
|
+
'x-title': 'Update an Unmanaged Access Code',
|
|
17353
18598
|
},
|
|
17354
18599
|
},
|
|
17355
18600
|
'/access_codes/update': {
|
|
17356
18601
|
patch: {
|
|
18602
|
+
description:
|
|
18603
|
+
'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
18604
|
operationId: 'accessCodesUpdatePatch',
|
|
17358
18605
|
requestBody: {
|
|
17359
18606
|
content: {
|
|
17360
18607
|
'application/json': {
|
|
17361
18608
|
schema: {
|
|
17362
18609
|
properties: {
|
|
17363
|
-
access_code_id: {
|
|
17364
|
-
|
|
18610
|
+
access_code_id: {
|
|
18611
|
+
description:
|
|
18612
|
+
'ID of the access code that you want to update.',
|
|
18613
|
+
format: 'uuid',
|
|
18614
|
+
type: 'string',
|
|
18615
|
+
},
|
|
18616
|
+
allow_external_modification: {
|
|
18617
|
+
description:
|
|
18618
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18619
|
+
type: 'boolean',
|
|
18620
|
+
},
|
|
17365
18621
|
attempt_for_offline_device: {
|
|
17366
18622
|
default: true,
|
|
17367
18623
|
type: 'boolean',
|
|
17368
18624
|
},
|
|
17369
18625
|
code: {
|
|
18626
|
+
description: 'Code to be used for access.',
|
|
17370
18627
|
maxLength: 9,
|
|
17371
18628
|
minLength: 4,
|
|
17372
18629
|
pattern: '^\\d+$',
|
|
17373
18630
|
type: 'string',
|
|
17374
18631
|
},
|
|
17375
|
-
device_id: {
|
|
17376
|
-
|
|
17377
|
-
|
|
17378
|
-
|
|
17379
|
-
|
|
17380
|
-
|
|
18632
|
+
device_id: {
|
|
18633
|
+
description:
|
|
18634
|
+
'ID of the device containing the access code that you want to update.',
|
|
18635
|
+
format: 'uuid',
|
|
18636
|
+
type: 'string',
|
|
18637
|
+
},
|
|
18638
|
+
ends_at: {
|
|
18639
|
+
description:
|
|
18640
|
+
'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`.',
|
|
18641
|
+
type: 'string',
|
|
18642
|
+
},
|
|
18643
|
+
is_external_modification_allowed: {
|
|
18644
|
+
description:
|
|
18645
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18646
|
+
type: 'boolean',
|
|
18647
|
+
},
|
|
18648
|
+
is_managed: {
|
|
18649
|
+
description:
|
|
18650
|
+
'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`.',
|
|
18651
|
+
type: 'boolean',
|
|
18652
|
+
},
|
|
18653
|
+
is_offline_access_code: {
|
|
18654
|
+
description:
|
|
18655
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
18656
|
+
type: 'boolean',
|
|
18657
|
+
},
|
|
18658
|
+
is_one_time_use: {
|
|
18659
|
+
description:
|
|
18660
|
+
'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.',
|
|
18661
|
+
type: 'boolean',
|
|
18662
|
+
},
|
|
17381
18663
|
max_time_rounding: {
|
|
17382
18664
|
default: '1hour',
|
|
18665
|
+
description:
|
|
18666
|
+
'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
18667
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
17384
18668
|
type: 'string',
|
|
17385
18669
|
},
|
|
17386
|
-
name: {
|
|
17387
|
-
|
|
17388
|
-
|
|
17389
|
-
|
|
17390
|
-
|
|
17391
|
-
|
|
17392
|
-
|
|
18670
|
+
name: {
|
|
18671
|
+
description: 'Name of the new access code.',
|
|
18672
|
+
type: 'string',
|
|
18673
|
+
},
|
|
18674
|
+
prefer_native_scheduling: {
|
|
18675
|
+
description:
|
|
18676
|
+
'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`.',
|
|
18677
|
+
type: 'boolean',
|
|
18678
|
+
},
|
|
18679
|
+
preferred_code_length: {
|
|
18680
|
+
description:
|
|
18681
|
+
'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.',
|
|
18682
|
+
format: 'float',
|
|
18683
|
+
type: 'number',
|
|
18684
|
+
},
|
|
18685
|
+
starts_at: {
|
|
18686
|
+
description:
|
|
18687
|
+
'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.',
|
|
18688
|
+
type: 'string',
|
|
18689
|
+
},
|
|
18690
|
+
sync: {
|
|
18691
|
+
default: false,
|
|
18692
|
+
type: 'boolean',
|
|
18693
|
+
'x-undocumented': 'Only used internally.',
|
|
18694
|
+
},
|
|
18695
|
+
type: {
|
|
18696
|
+
description:
|
|
18697
|
+
'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).',
|
|
18698
|
+
enum: ['ongoing', 'time_bound'],
|
|
18699
|
+
type: 'string',
|
|
18700
|
+
},
|
|
18701
|
+
use_backup_access_code_pool: {
|
|
18702
|
+
description:
|
|
18703
|
+
'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).',
|
|
18704
|
+
type: 'boolean',
|
|
18705
|
+
},
|
|
17393
18706
|
use_offline_access_code: { type: 'boolean' },
|
|
17394
18707
|
},
|
|
17395
18708
|
required: ['access_code_id'],
|
|
@@ -17430,44 +18743,113 @@ export default {
|
|
|
17430
18743
|
'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
|
|
17431
18744
|
'x-fern-ignore': true,
|
|
17432
18745
|
'x-response-key': null,
|
|
18746
|
+
'x-title': 'Update an Access Code',
|
|
17433
18747
|
},
|
|
17434
18748
|
post: {
|
|
18749
|
+
description:
|
|
18750
|
+
'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
18751
|
operationId: 'accessCodesUpdatePost',
|
|
17436
18752
|
requestBody: {
|
|
17437
18753
|
content: {
|
|
17438
18754
|
'application/json': {
|
|
17439
18755
|
schema: {
|
|
17440
18756
|
properties: {
|
|
17441
|
-
access_code_id: {
|
|
17442
|
-
|
|
18757
|
+
access_code_id: {
|
|
18758
|
+
description:
|
|
18759
|
+
'ID of the access code that you want to update.',
|
|
18760
|
+
format: 'uuid',
|
|
18761
|
+
type: 'string',
|
|
18762
|
+
},
|
|
18763
|
+
allow_external_modification: {
|
|
18764
|
+
description:
|
|
18765
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18766
|
+
type: 'boolean',
|
|
18767
|
+
},
|
|
17443
18768
|
attempt_for_offline_device: {
|
|
17444
18769
|
default: true,
|
|
17445
18770
|
type: 'boolean',
|
|
17446
18771
|
},
|
|
17447
18772
|
code: {
|
|
18773
|
+
description: 'Code to be used for access.',
|
|
17448
18774
|
maxLength: 9,
|
|
17449
18775
|
minLength: 4,
|
|
17450
18776
|
pattern: '^\\d+$',
|
|
17451
18777
|
type: 'string',
|
|
17452
18778
|
},
|
|
17453
|
-
device_id: {
|
|
17454
|
-
|
|
17455
|
-
|
|
17456
|
-
|
|
17457
|
-
|
|
17458
|
-
|
|
18779
|
+
device_id: {
|
|
18780
|
+
description:
|
|
18781
|
+
'ID of the device containing the access code that you want to update.',
|
|
18782
|
+
format: 'uuid',
|
|
18783
|
+
type: 'string',
|
|
18784
|
+
},
|
|
18785
|
+
ends_at: {
|
|
18786
|
+
description:
|
|
18787
|
+
'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`.',
|
|
18788
|
+
type: 'string',
|
|
18789
|
+
},
|
|
18790
|
+
is_external_modification_allowed: {
|
|
18791
|
+
description:
|
|
18792
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18793
|
+
type: 'boolean',
|
|
18794
|
+
},
|
|
18795
|
+
is_managed: {
|
|
18796
|
+
description:
|
|
18797
|
+
'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`.',
|
|
18798
|
+
type: 'boolean',
|
|
18799
|
+
},
|
|
18800
|
+
is_offline_access_code: {
|
|
18801
|
+
description:
|
|
18802
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
18803
|
+
type: 'boolean',
|
|
18804
|
+
},
|
|
18805
|
+
is_one_time_use: {
|
|
18806
|
+
description:
|
|
18807
|
+
'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.',
|
|
18808
|
+
type: 'boolean',
|
|
18809
|
+
},
|
|
17459
18810
|
max_time_rounding: {
|
|
17460
18811
|
default: '1hour',
|
|
18812
|
+
description:
|
|
18813
|
+
'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
18814
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
17462
18815
|
type: 'string',
|
|
17463
18816
|
},
|
|
17464
|
-
name: {
|
|
17465
|
-
|
|
17466
|
-
|
|
17467
|
-
|
|
17468
|
-
|
|
17469
|
-
|
|
17470
|
-
|
|
18817
|
+
name: {
|
|
18818
|
+
description: 'Name of the new access code.',
|
|
18819
|
+
type: 'string',
|
|
18820
|
+
},
|
|
18821
|
+
prefer_native_scheduling: {
|
|
18822
|
+
description:
|
|
18823
|
+
'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`.',
|
|
18824
|
+
type: 'boolean',
|
|
18825
|
+
},
|
|
18826
|
+
preferred_code_length: {
|
|
18827
|
+
description:
|
|
18828
|
+
'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.',
|
|
18829
|
+
format: 'float',
|
|
18830
|
+
type: 'number',
|
|
18831
|
+
},
|
|
18832
|
+
starts_at: {
|
|
18833
|
+
description:
|
|
18834
|
+
'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.',
|
|
18835
|
+
type: 'string',
|
|
18836
|
+
},
|
|
18837
|
+
sync: {
|
|
18838
|
+
default: false,
|
|
18839
|
+
type: 'boolean',
|
|
18840
|
+
'x-undocumented': 'Only used internally.',
|
|
18841
|
+
},
|
|
18842
|
+
type: {
|
|
18843
|
+
description:
|
|
18844
|
+
'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).',
|
|
18845
|
+
enum: ['ongoing', 'time_bound'],
|
|
18846
|
+
type: 'string',
|
|
18847
|
+
},
|
|
18848
|
+
use_backup_access_code_pool: {
|
|
18849
|
+
description:
|
|
18850
|
+
'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).',
|
|
18851
|
+
type: 'boolean',
|
|
18852
|
+
},
|
|
17471
18853
|
use_offline_access_code: { type: 'boolean' },
|
|
17472
18854
|
},
|
|
17473
18855
|
required: ['access_code_id'],
|
|
@@ -17509,44 +18891,113 @@ export default {
|
|
|
17509
18891
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
17510
18892
|
'x-fern-sdk-method-name': 'update',
|
|
17511
18893
|
'x-response-key': null,
|
|
18894
|
+
'x-title': 'Update an Access Code',
|
|
17512
18895
|
},
|
|
17513
18896
|
put: {
|
|
18897
|
+
description:
|
|
18898
|
+
'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
18899
|
operationId: 'accessCodesUpdatePut',
|
|
17515
18900
|
requestBody: {
|
|
17516
18901
|
content: {
|
|
17517
18902
|
'application/json': {
|
|
17518
18903
|
schema: {
|
|
17519
18904
|
properties: {
|
|
17520
|
-
access_code_id: {
|
|
17521
|
-
|
|
18905
|
+
access_code_id: {
|
|
18906
|
+
description:
|
|
18907
|
+
'ID of the access code that you want to update.',
|
|
18908
|
+
format: 'uuid',
|
|
18909
|
+
type: 'string',
|
|
18910
|
+
},
|
|
18911
|
+
allow_external_modification: {
|
|
18912
|
+
description:
|
|
18913
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18914
|
+
type: 'boolean',
|
|
18915
|
+
},
|
|
17522
18916
|
attempt_for_offline_device: {
|
|
17523
18917
|
default: true,
|
|
17524
18918
|
type: 'boolean',
|
|
17525
18919
|
},
|
|
17526
18920
|
code: {
|
|
18921
|
+
description: 'Code to be used for access.',
|
|
17527
18922
|
maxLength: 9,
|
|
17528
18923
|
minLength: 4,
|
|
17529
18924
|
pattern: '^\\d+$',
|
|
17530
18925
|
type: 'string',
|
|
17531
18926
|
},
|
|
17532
|
-
device_id: {
|
|
17533
|
-
|
|
17534
|
-
|
|
17535
|
-
|
|
17536
|
-
|
|
17537
|
-
|
|
18927
|
+
device_id: {
|
|
18928
|
+
description:
|
|
18929
|
+
'ID of the device containing the access code that you want to update.',
|
|
18930
|
+
format: 'uuid',
|
|
18931
|
+
type: 'string',
|
|
18932
|
+
},
|
|
18933
|
+
ends_at: {
|
|
18934
|
+
description:
|
|
18935
|
+
'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`.',
|
|
18936
|
+
type: 'string',
|
|
18937
|
+
},
|
|
18938
|
+
is_external_modification_allowed: {
|
|
18939
|
+
description:
|
|
18940
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18941
|
+
type: 'boolean',
|
|
18942
|
+
},
|
|
18943
|
+
is_managed: {
|
|
18944
|
+
description:
|
|
18945
|
+
'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`.',
|
|
18946
|
+
type: 'boolean',
|
|
18947
|
+
},
|
|
18948
|
+
is_offline_access_code: {
|
|
18949
|
+
description:
|
|
18950
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
18951
|
+
type: 'boolean',
|
|
18952
|
+
},
|
|
18953
|
+
is_one_time_use: {
|
|
18954
|
+
description:
|
|
18955
|
+
'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.',
|
|
18956
|
+
type: 'boolean',
|
|
18957
|
+
},
|
|
17538
18958
|
max_time_rounding: {
|
|
17539
18959
|
default: '1hour',
|
|
18960
|
+
description:
|
|
18961
|
+
'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
18962
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
17541
18963
|
type: 'string',
|
|
17542
18964
|
},
|
|
17543
|
-
name: {
|
|
17544
|
-
|
|
17545
|
-
|
|
17546
|
-
|
|
17547
|
-
|
|
17548
|
-
|
|
17549
|
-
|
|
18965
|
+
name: {
|
|
18966
|
+
description: 'Name of the new access code.',
|
|
18967
|
+
type: 'string',
|
|
18968
|
+
},
|
|
18969
|
+
prefer_native_scheduling: {
|
|
18970
|
+
description:
|
|
18971
|
+
'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`.',
|
|
18972
|
+
type: 'boolean',
|
|
18973
|
+
},
|
|
18974
|
+
preferred_code_length: {
|
|
18975
|
+
description:
|
|
18976
|
+
'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.',
|
|
18977
|
+
format: 'float',
|
|
18978
|
+
type: 'number',
|
|
18979
|
+
},
|
|
18980
|
+
starts_at: {
|
|
18981
|
+
description:
|
|
18982
|
+
'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.',
|
|
18983
|
+
type: 'string',
|
|
18984
|
+
},
|
|
18985
|
+
sync: {
|
|
18986
|
+
default: false,
|
|
18987
|
+
type: 'boolean',
|
|
18988
|
+
'x-undocumented': 'Only used internally.',
|
|
18989
|
+
},
|
|
18990
|
+
type: {
|
|
18991
|
+
description:
|
|
18992
|
+
'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).',
|
|
18993
|
+
enum: ['ongoing', 'time_bound'],
|
|
18994
|
+
type: 'string',
|
|
18995
|
+
},
|
|
18996
|
+
use_backup_access_code_pool: {
|
|
18997
|
+
description:
|
|
18998
|
+
'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).',
|
|
18999
|
+
type: 'boolean',
|
|
19000
|
+
},
|
|
17550
19001
|
use_offline_access_code: { type: 'boolean' },
|
|
17551
19002
|
},
|
|
17552
19003
|
required: ['access_code_id'],
|
|
@@ -17587,20 +19038,38 @@ export default {
|
|
|
17587
19038
|
'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
|
|
17588
19039
|
'x-fern-ignore': true,
|
|
17589
19040
|
'x-response-key': null,
|
|
19041
|
+
'x-title': 'Update an Access Code',
|
|
17590
19042
|
},
|
|
17591
19043
|
},
|
|
17592
19044
|
'/access_codes/update_multiple': {
|
|
17593
19045
|
patch: {
|
|
19046
|
+
description:
|
|
19047
|
+
'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
19048
|
operationId: 'accessCodesUpdateMultiplePatch',
|
|
17595
19049
|
requestBody: {
|
|
17596
19050
|
content: {
|
|
17597
19051
|
'application/json': {
|
|
17598
19052
|
schema: {
|
|
17599
19053
|
properties: {
|
|
17600
|
-
common_code_key: {
|
|
17601
|
-
|
|
17602
|
-
|
|
17603
|
-
|
|
19054
|
+
common_code_key: {
|
|
19055
|
+
description:
|
|
19056
|
+
'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
|
|
19057
|
+
type: 'string',
|
|
19058
|
+
},
|
|
19059
|
+
ends_at: {
|
|
19060
|
+
description:
|
|
19061
|
+
'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`.',
|
|
19062
|
+
type: 'string',
|
|
19063
|
+
},
|
|
19064
|
+
name: {
|
|
19065
|
+
description: 'Name of the new access code.',
|
|
19066
|
+
type: 'string',
|
|
19067
|
+
},
|
|
19068
|
+
starts_at: {
|
|
19069
|
+
description:
|
|
19070
|
+
'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.',
|
|
19071
|
+
type: 'string',
|
|
19072
|
+
},
|
|
17604
19073
|
},
|
|
17605
19074
|
required: ['common_code_key'],
|
|
17606
19075
|
type: 'object',
|
|
@@ -17634,18 +19103,36 @@ export default {
|
|
|
17634
19103
|
tags: ['/access_codes'],
|
|
17635
19104
|
'x-fern-ignore': true,
|
|
17636
19105
|
'x-response-key': null,
|
|
19106
|
+
'x-title': 'Update Multiple Linked Access Codes',
|
|
17637
19107
|
},
|
|
17638
19108
|
post: {
|
|
19109
|
+
description:
|
|
19110
|
+
'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
19111
|
operationId: 'accessCodesUpdateMultiplePost',
|
|
17640
19112
|
requestBody: {
|
|
17641
19113
|
content: {
|
|
17642
19114
|
'application/json': {
|
|
17643
19115
|
schema: {
|
|
17644
19116
|
properties: {
|
|
17645
|
-
common_code_key: {
|
|
17646
|
-
|
|
17647
|
-
|
|
17648
|
-
|
|
19117
|
+
common_code_key: {
|
|
19118
|
+
description:
|
|
19119
|
+
'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
|
|
19120
|
+
type: 'string',
|
|
19121
|
+
},
|
|
19122
|
+
ends_at: {
|
|
19123
|
+
description:
|
|
19124
|
+
'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`.',
|
|
19125
|
+
type: 'string',
|
|
19126
|
+
},
|
|
19127
|
+
name: {
|
|
19128
|
+
description: 'Name of the new access code.',
|
|
19129
|
+
type: 'string',
|
|
19130
|
+
},
|
|
19131
|
+
starts_at: {
|
|
19132
|
+
description:
|
|
19133
|
+
'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.',
|
|
19134
|
+
type: 'string',
|
|
19135
|
+
},
|
|
17649
19136
|
},
|
|
17650
19137
|
required: ['common_code_key'],
|
|
17651
19138
|
type: 'object',
|
|
@@ -17680,6 +19167,7 @@ export default {
|
|
|
17680
19167
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
17681
19168
|
'x-fern-sdk-method-name': 'update_multiple',
|
|
17682
19169
|
'x-response-key': null,
|
|
19170
|
+
'x-title': 'Update Multiple Linked Access Codes',
|
|
17683
19171
|
},
|
|
17684
19172
|
},
|
|
17685
19173
|
'/acs/access_groups/add_user': {
|
|
@@ -19475,6 +20963,61 @@ export default {
|
|
|
19475
20963
|
'x-title': 'Encode a Credential',
|
|
19476
20964
|
},
|
|
19477
20965
|
},
|
|
20966
|
+
'/acs/encoders/get': {
|
|
20967
|
+
post: {
|
|
20968
|
+
description:
|
|
20969
|
+
'Returns a specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
|
|
20970
|
+
operationId: 'acsEncodersGetPost',
|
|
20971
|
+
requestBody: {
|
|
20972
|
+
content: {
|
|
20973
|
+
'application/json': {
|
|
20974
|
+
schema: {
|
|
20975
|
+
properties: {
|
|
20976
|
+
acs_encoder_id: {
|
|
20977
|
+
description: 'ID of the desired encoder.',
|
|
20978
|
+
format: 'uuid',
|
|
20979
|
+
type: 'string',
|
|
20980
|
+
},
|
|
20981
|
+
},
|
|
20982
|
+
required: ['acs_encoder_id'],
|
|
20983
|
+
type: 'object',
|
|
20984
|
+
},
|
|
20985
|
+
},
|
|
20986
|
+
},
|
|
20987
|
+
},
|
|
20988
|
+
responses: {
|
|
20989
|
+
200: {
|
|
20990
|
+
content: {
|
|
20991
|
+
'application/json': {
|
|
20992
|
+
schema: {
|
|
20993
|
+
properties: {
|
|
20994
|
+
acs_encoder: { $ref: '#/components/schemas/acs_encoder' },
|
|
20995
|
+
ok: { type: 'boolean' },
|
|
20996
|
+
},
|
|
20997
|
+
required: ['acs_encoder', 'ok'],
|
|
20998
|
+
type: 'object',
|
|
20999
|
+
},
|
|
21000
|
+
},
|
|
21001
|
+
},
|
|
21002
|
+
description: 'OK',
|
|
21003
|
+
},
|
|
21004
|
+
400: { description: 'Bad Request' },
|
|
21005
|
+
401: { description: 'Unauthorized' },
|
|
21006
|
+
},
|
|
21007
|
+
security: [
|
|
21008
|
+
{ pat_with_workspace: [] },
|
|
21009
|
+
{ console_session_with_workspace: [] },
|
|
21010
|
+
{ api_key: [] },
|
|
21011
|
+
],
|
|
21012
|
+
summary: '/acs/encoders/get',
|
|
21013
|
+
tags: ['/acs'],
|
|
21014
|
+
'x-fern-sdk-group-name': ['acs', 'encoders'],
|
|
21015
|
+
'x-fern-sdk-method-name': 'get',
|
|
21016
|
+
'x-fern-sdk-return-value': 'acs_encoder',
|
|
21017
|
+
'x-response-key': 'acs_encoder',
|
|
21018
|
+
'x-title': 'Get an Encoder',
|
|
21019
|
+
},
|
|
21020
|
+
},
|
|
19478
21021
|
'/acs/encoders/list': {
|
|
19479
21022
|
post: {
|
|
19480
21023
|
description:
|
|
@@ -25575,11 +27118,13 @@ export default {
|
|
|
25575
27118
|
can_tailscale_proxy_reach_bridge: {
|
|
25576
27119
|
description:
|
|
25577
27120
|
'Tailscale proxy cannot reach the bridge',
|
|
27121
|
+
nullable: true,
|
|
25578
27122
|
type: 'boolean',
|
|
25579
27123
|
},
|
|
25580
27124
|
can_tailscale_proxy_reach_tailscale_network: {
|
|
25581
27125
|
description:
|
|
25582
27126
|
'Tailscale proxy cannot reach the Tailscale network',
|
|
27127
|
+
nullable: true,
|
|
25583
27128
|
type: 'boolean',
|
|
25584
27129
|
},
|
|
25585
27130
|
created_at: {
|
|
@@ -25595,16 +27140,19 @@ export default {
|
|
|
25595
27140
|
is_bridge_socks_server_healthy: {
|
|
25596
27141
|
description:
|
|
25597
27142
|
"Bridge's SOCKS server is unhealthy",
|
|
27143
|
+
nullable: true,
|
|
25598
27144
|
type: 'boolean',
|
|
25599
27145
|
},
|
|
25600
27146
|
is_tailscale_proxy_reachable: {
|
|
25601
27147
|
description:
|
|
25602
27148
|
'Seam cannot reach the tailscale proxy',
|
|
27149
|
+
nullable: true,
|
|
25603
27150
|
type: 'boolean',
|
|
25604
27151
|
},
|
|
25605
27152
|
is_tailscale_proxy_socks_server_healthy: {
|
|
25606
27153
|
description:
|
|
25607
27154
|
"Tailscale proxy's SOCKS server is unhealthy",
|
|
27155
|
+
nullable: true,
|
|
25608
27156
|
type: 'boolean',
|
|
25609
27157
|
},
|
|
25610
27158
|
message: { type: 'string' },
|
|
@@ -25742,11 +27290,13 @@ export default {
|
|
|
25742
27290
|
can_tailscale_proxy_reach_bridge: {
|
|
25743
27291
|
description:
|
|
25744
27292
|
'Tailscale proxy cannot reach the bridge',
|
|
27293
|
+
nullable: true,
|
|
25745
27294
|
type: 'boolean',
|
|
25746
27295
|
},
|
|
25747
27296
|
can_tailscale_proxy_reach_tailscale_network: {
|
|
25748
27297
|
description:
|
|
25749
27298
|
'Tailscale proxy cannot reach the Tailscale network',
|
|
27299
|
+
nullable: true,
|
|
25750
27300
|
type: 'boolean',
|
|
25751
27301
|
},
|
|
25752
27302
|
created_at: {
|
|
@@ -25762,16 +27312,19 @@ export default {
|
|
|
25762
27312
|
is_bridge_socks_server_healthy: {
|
|
25763
27313
|
description:
|
|
25764
27314
|
"Bridge's SOCKS server is unhealthy",
|
|
27315
|
+
nullable: true,
|
|
25765
27316
|
type: 'boolean',
|
|
25766
27317
|
},
|
|
25767
27318
|
is_tailscale_proxy_reachable: {
|
|
25768
27319
|
description:
|
|
25769
27320
|
'Seam cannot reach the tailscale proxy',
|
|
27321
|
+
nullable: true,
|
|
25770
27322
|
type: 'boolean',
|
|
25771
27323
|
},
|
|
25772
27324
|
is_tailscale_proxy_socks_server_healthy: {
|
|
25773
27325
|
description:
|
|
25774
27326
|
"Tailscale proxy's SOCKS server is unhealthy",
|
|
27327
|
+
nullable: true,
|
|
25775
27328
|
type: 'boolean',
|
|
25776
27329
|
},
|
|
25777
27330
|
message: { type: 'string' },
|
|
@@ -25900,11 +27453,13 @@ export default {
|
|
|
25900
27453
|
can_tailscale_proxy_reach_bridge: {
|
|
25901
27454
|
description:
|
|
25902
27455
|
'Tailscale proxy cannot reach the bridge',
|
|
27456
|
+
nullable: true,
|
|
25903
27457
|
type: 'boolean',
|
|
25904
27458
|
},
|
|
25905
27459
|
can_tailscale_proxy_reach_tailscale_network: {
|
|
25906
27460
|
description:
|
|
25907
27461
|
'Tailscale proxy cannot reach the Tailscale network',
|
|
27462
|
+
nullable: true,
|
|
25908
27463
|
type: 'boolean',
|
|
25909
27464
|
},
|
|
25910
27465
|
created_at: {
|
|
@@ -25920,16 +27475,19 @@ export default {
|
|
|
25920
27475
|
is_bridge_socks_server_healthy: {
|
|
25921
27476
|
description:
|
|
25922
27477
|
"Bridge's SOCKS server is unhealthy",
|
|
27478
|
+
nullable: true,
|
|
25923
27479
|
type: 'boolean',
|
|
25924
27480
|
},
|
|
25925
27481
|
is_tailscale_proxy_reachable: {
|
|
25926
27482
|
description:
|
|
25927
27483
|
'Seam cannot reach the tailscale proxy',
|
|
27484
|
+
nullable: true,
|
|
25928
27485
|
type: 'boolean',
|
|
25929
27486
|
},
|
|
25930
27487
|
is_tailscale_proxy_socks_server_healthy: {
|
|
25931
27488
|
description:
|
|
25932
27489
|
"Tailscale proxy's SOCKS server is unhealthy",
|
|
27490
|
+
nullable: true,
|
|
25933
27491
|
type: 'boolean',
|
|
25934
27492
|
},
|
|
25935
27493
|
message: { type: 'string' },
|
|
@@ -26068,11 +27626,13 @@ export default {
|
|
|
26068
27626
|
can_tailscale_proxy_reach_bridge: {
|
|
26069
27627
|
description:
|
|
26070
27628
|
'Tailscale proxy cannot reach the bridge',
|
|
27629
|
+
nullable: true,
|
|
26071
27630
|
type: 'boolean',
|
|
26072
27631
|
},
|
|
26073
27632
|
can_tailscale_proxy_reach_tailscale_network: {
|
|
26074
27633
|
description:
|
|
26075
27634
|
'Tailscale proxy cannot reach the Tailscale network',
|
|
27635
|
+
nullable: true,
|
|
26076
27636
|
type: 'boolean',
|
|
26077
27637
|
},
|
|
26078
27638
|
created_at: {
|
|
@@ -26088,16 +27648,19 @@ export default {
|
|
|
26088
27648
|
is_bridge_socks_server_healthy: {
|
|
26089
27649
|
description:
|
|
26090
27650
|
"Bridge's SOCKS server is unhealthy",
|
|
27651
|
+
nullable: true,
|
|
26091
27652
|
type: 'boolean',
|
|
26092
27653
|
},
|
|
26093
27654
|
is_tailscale_proxy_reachable: {
|
|
26094
27655
|
description:
|
|
26095
27656
|
'Seam cannot reach the tailscale proxy',
|
|
27657
|
+
nullable: true,
|
|
26096
27658
|
type: 'boolean',
|
|
26097
27659
|
},
|
|
26098
27660
|
is_tailscale_proxy_socks_server_healthy: {
|
|
26099
27661
|
description:
|
|
26100
27662
|
"Tailscale proxy's SOCKS server is unhealthy",
|
|
27663
|
+
nullable: true,
|
|
26101
27664
|
type: 'boolean',
|
|
26102
27665
|
},
|
|
26103
27666
|
message: { type: 'string' },
|